simplify bus function & var names

Author: kevin-pololu

README.md

@@ -77,10 +77,10 @@ This library is intended to provide a quicker and easier way to get started usin
 * `VL53L0X()`<br>
  Constructor.
 
-* `void setI2cBus(TwoWire * bus)`<br>
- Configures this object to use the specified I&sup2;C bus. `bus` should be a pointer to a `TwoWire` object; the default bus is `Wire`, which is typically the first or only I&sup2;C bus on an Arduino. If your Arduino has more than one I&sup2;C bus and you have the VL53L0X connected to the second bus, which is typically called `Wire1`, you can call `sensor.setI2cBus(&Wire1);`.
+* `void setBus(TwoWire * bus)`<br>
+ Configures this object to use the specified I&sup2;C bus. `bus` should be a pointer to a `TwoWire` object; the default bus is `Wire`, which is typically the first or only I&sup2;C bus on an Arduino. If your Arduino has more than one I&sup2;C bus and you have the VL53L0X connected to the second bus, which is typically called `Wire1`, you can call `sensor.setBus(&Wire1);`.
 
-* `TwoWire * getI2cBus()`<br>
+* `TwoWire * getBus()`<br>
  Returns a pointer to the I&sup2;C bus this object is using.
 
 * `void setAddress(uint8_t new_addr)`<br>

VL53L0X.cpp

@@ -35,7 +35,7 @@
 // Constructors ////////////////////////////////////////////////////////////////
 
 VL53L0X::VL53L0X()
- : i2c_bus(&Wire)
+ : bus(&Wire)
  , address(ADDRESS_DEFAULT)
  , io_timeout(0) // no timeout
  , did_timeout(false)
@@ -285,45 +285,45 @@ bool VL53L0X::init(bool io_2v8)
 // Write an 8-bit register
 void VL53L0X::writeReg(uint8_t reg, uint8_t value)
 {
- i2c_bus->beginTransmission(address);
- i2c_bus->write(reg);
- i2c_bus->write(value);
- last_status = i2c_bus->endTransmission();
+ bus->beginTransmission(address);
+ bus->write(reg);
+ bus->write(value);
+ last_status = bus->endTransmission();
 }
 
 // Write a 16-bit register
 void VL53L0X::writeReg16Bit(uint8_t reg, uint16_t value)
 {
- i2c_bus->beginTransmission(address);
- i2c_bus->write(reg);
- i2c_bus->write((value >> 8) & 0xFF); // value high byte
- i2c_bus->write( value & 0xFF); // value low byte
- last_status = i2c_bus->endTransmission();
+ bus->beginTransmission(address);
+ bus->write(reg);
+ bus->write((value >> 8) & 0xFF); // value high byte
+ bus->write( value & 0xFF); // value low byte
+ last_status = bus->endTransmission();
 }
 
 // Write a 32-bit register
 void VL53L0X::writeReg32Bit(uint8_t reg, uint32_t value)
 {
- i2c_bus->beginTransmission(address);
- i2c_bus->write(reg);
- i2c_bus->write((value >> 24) & 0xFF); // value highest byte
- i2c_bus->write((value >> 16) & 0xFF);
- i2c_bus->write((value >> 8) & 0xFF);
- i2c_bus->write( value & 0xFF); // value lowest byte
- last_status = i2c_bus->endTransmission();
+ bus->beginTransmission(address);
+ bus->write(reg);
+ bus->write((value >> 24) & 0xFF); // value highest byte
+ bus->write((value >> 16) & 0xFF);
+ bus->write((value >> 8) & 0xFF);
+ bus->write( value & 0xFF); // value lowest byte
+ last_status = bus->endTransmission();
 }
 
 // Read an 8-bit register
 uint8_t VL53L0X::readReg(uint8_t reg)
 {
  uint8_t value;
 
- i2c_bus->beginTransmission(address);
- i2c_bus->write(reg);
- last_status = i2c_bus->endTransmission();
+ bus->beginTransmission(address);
+ bus->write(reg);
+ last_status = bus->endTransmission();
 
- i2c_bus->requestFrom(address, (uint8_t)1);
- value = i2c_bus->read();
+ bus->requestFrom(address, (uint8_t)1);
+ value = bus->read();
 
  return value;
 }
@@ -333,13 +333,13 @@ uint16_t VL53L0X::readReg16Bit(uint8_t reg)
 {
  uint16_t value;
 
- i2c_bus->beginTransmission(address);
- i2c_bus->write(reg);
- last_status = i2c_bus->endTransmission();
+ bus->beginTransmission(address);
+ bus->write(reg);
+ last_status = bus->endTransmission();
 
- i2c_bus->requestFrom(address, (uint8_t)2);
- value = (uint16_t)i2c_bus->read() << 8; // value high byte
- value |= i2c_bus->read(); // value low byte
+ bus->requestFrom(address, (uint8_t)2);
+ value = (uint16_t)bus->read() << 8; // value high byte
+ value |= bus->read(); // value low byte
 
  return value;
 }
@@ -349,15 +349,15 @@ uint32_t VL53L0X::readReg32Bit(uint8_t reg)
 {
  uint32_t value;
 
- i2c_bus->beginTransmission(address);
- i2c_bus->write(reg);
- last_status = i2c_bus->endTransmission();
+ bus->beginTransmission(address);
+ bus->write(reg);
+ last_status = bus->endTransmission();
 
- i2c_bus->requestFrom(address, (uint8_t)4);
- value = (uint32_t)i2c_bus->read() << 24; // value highest byte
- value |= (uint32_t)i2c_bus->read() << 16;
- value |= (uint16_t)i2c_bus->read() << 8;
- value |= i2c_bus->read(); // value lowest byte
+ bus->requestFrom(address, (uint8_t)4);
+ value = (uint32_t)bus->read() << 24; // value highest byte
+ value |= (uint32_t)bus->read() << 16;
+ value |= (uint16_t)bus->read() << 8;
+ value |= bus->read(); // value lowest byte
 
  return value;
 }
@@ -366,30 +366,30 @@ uint32_t VL53L0X::readReg32Bit(uint8_t reg)
 // starting at the given register
 void VL53L0X::writeMulti(uint8_t reg, uint8_t const * src, uint8_t count)
 {
- i2c_bus->beginTransmission(address);
- i2c_bus->write(reg);
+ bus->beginTransmission(address);
+ bus->write(reg);
 
  while (count-- > 0)
  {
- i2c_bus->write(*(src++));
+ bus->write(*(src++));
  }
 
- last_status = i2c_bus->endTransmission();
+ last_status = bus->endTransmission();
 }
 
 // Read an arbitrary number of bytes from the sensor, starting at the given
 // register, into the given array
 void VL53L0X::readMulti(uint8_t reg, uint8_t * dst, uint8_t count)
 {
- i2c_bus->beginTransmission(address);
- i2c_bus->write(reg);
- last_status = i2c_bus->endTransmission();
+ bus->beginTransmission(address);
+ bus->write(reg);
+ last_status = bus->endTransmission();
 
- i2c_bus->requestFrom(address, count);
+ bus->requestFrom(address, count);
 
  while (count-- > 0)
  {
- *(dst++) = i2c_bus->read();
+ *(dst++) = bus->read();
  }
 }
 

VL53L0X.h

@@ -99,8 +99,8 @@ class VL53L0X
 
  VL53L0X();
 
- void setI2cBus(TwoWire * bus) { i2c_bus = bus; }
- TwoWire * getI2cBus() { return i2c_bus; }
+ void setBus(TwoWire * bus) { this->bus = bus; }
+ TwoWire * getBus() { return bus; }
 
  void setAddress(uint8_t new_addr);
  inline uint8_t getAddress() { return address; }
@@ -153,7 +153,7 @@ class VL53L0X
  uint32_t msrc_dss_tcc_us, pre_range_us, final_range_us;
  };
 
- TwoWire * i2c_bus;
+ TwoWire * bus;
  uint8_t address;
  uint16_t io_timeout;
  bool did_timeout;