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

Inheritance diagram for modm::mcp990x< I2cMaster >:

Classes
struct	Data

Public Types
enum	ExternalDiode : uint8_t { Diode1 = 0, Diode2 = 1, Diode3 = 2 }

Public Member Functions
	Mcp990x (Data &data, uint8_t address=0x4d)

modm::ResumableResult< bool >	initialize ()
	Initialize sensor.

modm::ResumableResult< bool >	ping ()
	Detect sensor.

modm::ResumableResult< bool >	readInternalTemperature ()

modm::ResumableResult< bool >	readExternalDiodeTemperature (ExternalDiode diode)

modm::ResumableResult< bool >	setExternalDiodeIdealityFactor (ExternalDiode diode, uint8_t idealitySetting)

Data &	getData ()

void	attachConfigurationHandler (I2c::ConfigurationHandler handler)

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

Detailed Description

template<class I2cMaster>
class modm::mcp990x< I2cMaster >

Simple driver for MCP9902/3/4 I2C temperature sensor.

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.

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.

template<class I2cMaster >

modm::mcp990x< I2cMaster >::Mcp990x	(	Data &	data,
		uint8_t	address = `0x4d`
	)

Parameters

address I2C address, MCP990xT-1: 0x4c, -2: 0x4d, -A: adjustable, see datasheet

template<class I2cMaster >

modm::ResumableResult<bool> modm::mcp990x< I2cMaster >::readExternalDiodeTemperature ( ExternalDiode diode )

Read external diode temperature sensor

Precondition: sensor is succesfully initialized

template<class I2cMaster >

modm::ResumableResult<bool> modm::mcp990x< I2cMaster >::readInternalTemperature ( )

Read internal temperature sensor

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

address the slave address not yet shifted left (address < 128).

template<class I2cMaster >

modm::ResumableResult<bool> modm::mcp990x< I2cMaster >::setExternalDiodeIdealityFactor	(	ExternalDiode	diode,
		uint8_t	idealitySetting
	)

Set external diode ideality factor See datasheet for values

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:

mcp990x.hpp

Classes

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

template<class I2cMaster> class modm::mcp990x< I2cMaster >

Member Function Documentation

template<class I2cMaster>
class modm::mcp990x< I2cMaster >