modm API documentation
Public Typedefs | Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
modm::ds1631< I2cMaster > Class Template Reference
External Device Drivers » DS1x31 Temperature Sensor

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

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

Public Typedefs

typedef lm75::Data Data
 

Public Types

enum  ConversionMode : uint8_t { Continous = 0, OneShot = int(Config::OneShot) }
 
enum  AlertPolarity : uint8_t { ActiveLow = 0, ActiveHigh = int(Config::Polarity) }
 
enum  Resolution : uint8_t { Resolution::Bits9 = 0, Resolution::Bits10 = Bit0, Resolution::Bits11 = Bit1, Resolution::Bits12 = Bit1 | Bit0 }
 

Public Member Functions

 Ds1631 (Data &data, uint8_t address=0x90)
 
bool update ()
 
bool initialize ()
 
bool setUpdateRate (uint8_t rate)
 
bool setResolution (Resolution resolution)
 
bool setAlertPolarity (AlertPolarity polarity)
 
bool setConversionMode (ConversionMode mode)
 
bool setUpperLimit (float temperature)
 Writes the upper limit of the alarm.
 
bool setLowerLimit (float temperature)
 Writes the lower limit of the alarm.
 
bool readTemperature ()
 reads the Temperature registers and buffers the results
 
bool startConversion ()
 
bool stopConversion ()
 
bool reset ()
 
Data & getData ()
 
void attachConfigurationHandler (I2c::ConfigurationHandler handler)
 
bool ping ()
 
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<typename I2cMaster>
class modm::ds1631< I2cMaster >

DS1631, DS1631A and DS1731 temperature sensor driver.

See also
ds1631
Author
Fabian Greif
Niklas Hauser

Member Enumeration Documentation

template<typename I2cMaster >
enum modm::ds1631::Resolution : uint8_t
strong
Enum ValuesDocumentation
Bits9 

Conversion Time: 94ms.

Bits10 

Conversion Time: 188ms.

Bits11 

Conversion Time: 375ms.

Bits12 

Conversion Time: 750ms.

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 file: