modm API documentation
Classes | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
modm::stts22h< I2cMaster > Class Template Reference
External Device Drivers » STTS22H temperature sensor

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

Inheritance diagram for modm::stts22h< I2cMaster >:
modm::I2cDevice< I2cMaster >

Classes

struct  Data
 

Public Member Functions

 Stts22h (Data &data, uint8_t address=0x3f)
 
bool initialize ()
 Initialize sensor.
 
bool ping ()
 Detect sensor.
 
bool readTemperature ()
 
Data & getData ()
 
void attachConfigurationHandler (I2c::ConfigurationHandler handler)
 
bool read (uint8_t *buffer, std::size_t size)
 Starts a write transaction and waits until finished.
 
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::stts22h< I2cMaster >

Simple driver for STTS22H I2C temperature sensor.

Only 'free-run' mode is supported.

Author
Christopher Durand

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.
template<class I2cMaster >
bool modm::stts22h< I2cMaster >::readTemperature ( )

Read temperature from device

Precondition
sensor is succesfully initialized
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).
template<class I2cMaster >
modm::stts22h< I2cMaster >::Stts22h ( Data &  data,
uint8_t  address = 0x3f 
)
Parameters
addressI2C address, selectable on device between 0x38 and 0x3f
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 file: