i2c::ReadRegisterFuture< MANAGER, T, FUNCTOR > Class Template Reference

General Future that can be used to read an I2C device register. More...

#include <fastarduino/i2c_device_utilities.h>

Inheritance diagram for i2c::ReadRegisterFuture< MANAGER, T, FUNCTOR >:

Collaboration diagram for i2c::ReadRegisterFuture< MANAGER, T, FUNCTOR >:

Public Member Functions
	ReadRegisterFuture (uint8_t reg, future::FutureNotification notification=future::FutureNotification::NONE)
	Create a ReadRegisterFuture future for a given device register reg. More...

Detailed Description

template<typename MANAGER, typename T, typename FUNCTOR = functor::Identity<T>>
class i2c::ReadRegisterFuture< MANAGER, T, FUNCTOR >

General Future that can be used to read an I2C device register.

Most I2C devices have registers, accessible by a byte address; register values may be one or more bytes long; these may be integral types or not. ReadRegisterFuture can be used in any I2C device supporting class (subclass of i2c::I2CDevice) in almost all situations where you need to read a register, whatever its type. ReadRegisterFuture supports conversion of register value to a transformed result, thanks to its use of functors. Standard functors are provided for e.g. endianness conversion, if the I2C device uses big endian (while ATmel MCU are little-endian).

Template Parameters

MANAGER	the type of I2C Manager used to handle I2C communication
T	the type of the register to read from
FUNCTOR	the type of an adequate functor to transform the register value to a more suitable result; defaults to functor::Identity<T> which does nothing.

See also

TReadRegisterFuture

WriteRegisterFuture

i2c::I2CSyncManager

i2c::I2CAsyncManager

functor

Definition at line 82 of file i2c_device_utilities.h.

Constructor & Destructor Documentation

ReadRegisterFuture()

template<typename MANAGER , typename T , typename FUNCTOR = functor::Identity<T>>

i2c::ReadRegisterFuture< MANAGER, T, FUNCTOR >::ReadRegisterFuture ( uint8_t  reg, future::FutureNotification  notification = future::FutureNotification::NONE  )

inlineexplicit

Create a ReadRegisterFuture future for a given device register reg.

This future can then be used to read the register value.

Parameters

reg	the address of the register to read from the I2C device
notification	determines if and which notifications should be dispatched by this ReadRegisterFuture; default is none.

Definition at line 105 of file i2c_device_utilities.h.

---

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

• fastarduino/i2c_device_utilities.h