modm API documentation
modm::Tmp102< I2cMaster > Class Template Reference

#include <modm/driver/temperature/tmp102.hpp>

Inheritance diagram for modm::Tmp102< I2cMaster >:
modm::Lm75< I2cMaster > modm::Lm75< I2cMaster > modm::I2cDevice< I2cMaster > modm::I2cDevice< I2cMaster >

Classes

struct  Data
 

Public Member Functions

 Tmp102 (Data &data, uint8_t address=0x48)
 
bool update ()
 
bool setUpdateRate (uint8_t rate)
 
bool enableExtendedMode (bool enable=true)
 Enables extended mode with 13 bit data format.
 
bool readComparatorMode (bool &result)
 param[out] result contains comparator mode alert in the configured polarity
 
bool setUpperLimit (float temperature)
 Writes the upper limit of the alarm.
 
bool setLowerLimit (float temperature)
 Writes the lower limit of the alarm.
 
bool startConversion ()
 starts a temperature conversion right now
 
DatagetData ()
 
void attachConfigurationHandler (I2c::ConfigurationHandler handler)
 
bool configureAlertMode (ThermostatMode mode, AlertPolarity polarity, FaultQueue faults)
 
bool ping ()
 
bool read (uint8_t *buffer, std::size_t size)
 Starts a write transaction and waits until finished.
 
bool readTemperature ()
 reads the Temperature registers and buffers the results
 
void setAddress (uint8_t address)
 
bool write (const uint8_t *buffer, std::size_t size)
 Starts a write transaction and waits until finished.
 
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

I2cWriteReadTransaction transaction
 

Detailed Description

template<class I2cMaster>
class modm::Tmp102< I2cMaster >

Author
Niklas Hauser

Constructor & Destructor Documentation

template<class I2cMaster >
modm::Tmp102< I2cMaster >::Tmp102 ( Data data,
uint8_t  address = 0x48 
)

Constructor, requires a tmp102::Data object, sets address to default of 0x48 (alternatives are 0x49, 0x4A and 0x4B).

Member Function Documentation

void modm::I2cDevice< I2cMaster, 10 , I2cWriteReadTransaction >::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 , I2cWriteReadTransaction >::isTransactionRunning ( )
inheritedinlineprotected
Returns
true when transaction is busy.
bool modm::I2cDevice< I2cMaster, 10 , I2cWriteReadTransaction >::ping ( )
inheritedinline
Return Values
truedevice responds to address
falseno device with address found
void modm::I2cDevice< I2cMaster, 10 , I2cWriteReadTransaction >::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 , I2cWriteReadTransaction >::wasTransactionSuccessful ( )
inheritedinlineprotected
Returns
true when transaction did not return an error.

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