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

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

Inheritance diagram for modm::Lm75< I2cMaster >:
modm::I2cDevice< I2cMaster, 2 > modm::NestedResumable< 10+1 > modm::Tmp102< I2cMaster > modm::Tmp102< I2cMaster > modm::Tmp175< I2cMaster > modm::Tmp175< I2cMaster >

Classes

struct  Data
 

Public Member Functions

 Lm75 (Data &data, uint8_t address=0x48)
 
modm::ResumableResult< bool > configureAlertMode (ThermostatMode mode, AlertPolarity polarity, FaultQueue faults)
 
modm::ResumableResult< bool > setUpperLimit (float temperature)
 Writes the upper limit of the alarm.
 
modm::ResumableResult< bool > setLowerLimit (float temperature)
 Writes the lower limit of the alarm.
 
modm::ResumableResult< bool > readTemperature ()
 reads the Temperature registers and buffers the results
 
DatagetData ()
 
void attachConfigurationHandler (I2c::ConfigurationHandler handler)
 
modm::ResumableResult< bool > ping ()
 
void setAddress (uint8_t address)
 

Protected Member Functions

modm::ResumableResult< ReturnType > resumable function (...)
 
int8_t getResumableDepth () const
 
bool isResumableRunning () const
 
bool isTransactionRunning ()
 
modm::ResumableResult< bool > runTransaction ()
 Starts our own transaction and waits until finished.
 
bool startRead (uint8_t *buffer, std::size_t size)
 Configures the transaction with a read operation and starts it.
 
bool startTransaction ()
 Starts the transaction with our own transaction object.
 
bool startTransaction (modm::I2cTransaction *transaction)
 Starts the transaction with a seperate transaction object.
 
bool startWrite (const uint8_t *buffer, std::size_t size)
 Configures the transaction with a write operation and starts it.
 
bool startWriteRead (const uint8_t *writeBuffer, std::size_t writeSize, uint8_t *readBuffer, std::size_t readSize)
 Configures the transaction with a write/read operation and starts it.
 
void stopResumable ()
 Force all resumable functions to stop running at the current nesting level.
 
bool wasTransactionSuccessful ()
 

Protected Attributes

I2cWriteReadTransaction transaction
 

Friends

template<class OtherI2cMaster >
class Tmp102
 
template<class OtherI2cMaster >
class Tmp175
 

Detailed Description

template<class I2cMaster>
class modm::Lm75< I2cMaster >

Author
Fabian Greif
Niklas Hauser

Constructor & Destructor Documentation

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

Constructor, requires a lm75::Data object, sets address to default of 0x48 (7 alternative addresses up to 0x4F possible).

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.

modm::ResumableResult< ReturnType > resumable modm::NestedResumable< 1 >::function (   ...)
inherited

Run the resumable function.

You need to implement this method in you subclass yourself.

Returns
>NestingError if still running, <=NestingError if it has finished.
int8_t modm::NestedResumable< 1 >::getResumableDepth ( ) const
inheritedinline
Returns
the nesting depth in the current resumable function, or -1 if called outside any resumable function
bool modm::NestedResumable< 1 >::isResumableRunning ( ) const
inheritedinline
Returns
true if a resumable function is running at the current nesting level, else false
bool modm::I2cDevice< I2cMaster, 10 , I2cWriteReadTransaction >::isTransactionRunning ( )
inheritedinlineprotected
Returns
true when transaction is busy.
modm::ResumableResult<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 file: