modm API documentation
modm::Vl53I2cTransport< I2cMaster, Lpn > Class Template Reference
Inheritance diagram for modm::Vl53I2cTransport< I2cMaster, Lpn >:
modm::I2cEeprom< I2cMaster, 2 > modm::Vl53TransportBase modm::I2cDevice< I2cMaster, 1, i2c_eeprom::detail::DataTransmissionAdapter< 2 > >

Public Member Functions

 Vl53I2cTransport (const uint8_t address)
 
 Vl53I2cTransport (const Vl53I2cTransport &) = delete
 
Vl53I2cTransport & operator= (const Vl53I2cTransport &) = delete
 
uint8_t writeMulti (uint16_t register_address, const uint8_t *p_values, uint32_t size) override
 
uint8_t readMulti (uint16_t register_address, uint8_t *p_values, uint32_t size) override
 
uint8_t readByte (uint16_t register_address, uint8_t *p_value) override
 
uint8_t writeByte (uint16_t register_address, uint8_t value) override
 
uint8_t resetSensor () override
 
void attachConfigurationHandler (I2c::ConfigurationHandler handler)
 
bool ping ()
 
bool read (uint32_t address, uint8_t *data, std::size_t length)
 Read block.
 
bool read (uint16_t address, T &data)
 
bool read (uint8_t *buffer, std::size_t size)
 Starts a write transaction and waits until finished.
 
bool readByte (uint32_t address, uint8_t &data)
 Read byte.
 
void setAddress (uint8_t address)
 
bool write (uint32_t address, const uint8_t *data, std::size_t length)
 
bool write (uint32_t address, const T &data)
 
bool write (const uint8_t *buffer, std::size_t size)
 Starts a write transaction and waits until finished.
 
bool writeByte (uint32_t address, uint8_t data)
 
bool writeRead (const uint8_t *writeBuffer, std::size_t writeSize, uint8_t *readBuffer, std::size_t readSize)
 Starts a write-read transaction and waits until finished.
 

Protected Member Functions

bool isTransactionRunning ()
 
bool runTransaction ()
 Starts our own transaction and waits until finished.
 
bool startTransaction ()
 Starts the transaction with our own transaction object.
 
bool startTransaction (modm::I2cTransaction *transaction)
 Starts the transaction with a separate transaction object.
 
bool wasTransactionSuccessful ()
 

Protected Attributes

i2c_eeprom::detail::DataTransmissionAdapter< 2 > transaction
 

Member Function Documentation

void modm::I2cDevice< I2cMaster, 10 , i2c_eeprom::detail::DataTransmissionAdapter< 2 > >::attachConfigurationHandler ( I2c::ConfigurationHandler  handler)
inheritedinline

Attaches a configuration handler, which is called before a transaction, whenever the configuration has to be changed.

bool modm::I2cDevice< I2cMaster, 10 , i2c_eeprom::detail::DataTransmissionAdapter< 2 > >::isTransactionRunning ( )
inheritedinlineprotected
Returns
true when transaction is busy.
bool modm::I2cDevice< I2cMaster, 10 , i2c_eeprom::detail::DataTransmissionAdapter< 2 > >::ping ( )
inheritedinline
Return Values
truedevice responds to address
falseno device with address found
bool modm::I2cEeprom< I2cMaster, 2 >::read ( uint16_t  address,
T &  data 
)
inheritedinline

Convenience function

Shortcut for:

return read(address, static_cast<uint8_t *>(&data), sizeof(T));
void modm::I2cDevice< I2cMaster, 10 , i2c_eeprom::detail::DataTransmissionAdapter< 2 > >::setAddress ( uint8_t  address)
inheritedinline

Sets a new address of the slave device.

Parameters
addressthe slave address not yet shifted left (address < 128).
bool modm::I2cDevice< I2cMaster, 10 , i2c_eeprom::detail::DataTransmissionAdapter< 2 > >::wasTransactionSuccessful ( )
inheritedinlineprotected
Returns
true when transaction did not return an error.
bool modm::I2cEeprom< I2cMaster, 2 >::write ( uint32_t  address,
const T &  data 
)
inheritedinline

Convenience function

Shortcut for:

return write(address, static_cast<const uint8_t *>(&data), sizeof(T));
bool modm::I2cEeprom< I2cMaster, 2 >::write ( uint32_t  address,
const uint8_t *  data,
std::size_t  length 
)
inherited

Write block

Parameters
addressAddress
dataData block
lengthNumber of bytes to be written
Returns
true if the data could be written, false otherwise
bool modm::I2cEeprom< I2cMaster, 2 >::writeByte ( uint32_t  address,
uint8_t  data 
)
inheritedinline

Write byte

Parameters
addressAddress
dataData byte
Returns
true if the data could be written, false otherwise

The documentation for this class was generated from the following file: