#include <modm/driver/storage/cat24aa.hpp>

Inheritance diagram for modm::Cat24Aa< I2cMaster >:

Public Member Functions
bool	writeByte (uint32_t address, uint8_t data)

bool	write (uint32_t address, const uint8_t *data, std::size_t length)

template<typename T >
bool	write (uint32_t address, const T &data)

bool	readByte (uint32_t address, uint8_t &data)
	Read byte.

bool	read (uint32_t address, uint8_t *data, std::size_t length)
	Read block.

template<typename T >
bool	read (uint16_t address, T &data)

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
cat24Aa::DataTransmissionAdapter	transaction

Detailed Description

template<typename I2cMaster>
class modm::Cat24Aa< I2cMaster >

I2C Eeprom CAT24AA

Driver for OnSemi CAT24AA Eeprom. I2C eeprom with an 11-bit address pointer, encoded in 3 bits of the device slave address plus the address byte. Base address is fixed to 0x50.

Author: Mike Wolfram

Member Function Documentation

void modm::I2cDevice< I2cMaster, 10 , cat24Aa::DataTransmissionAdapter >::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 , cat24Aa::DataTransmissionAdapter >::isTransactionRunning ( )

inheritedinlineprotected

Returns: true when transaction is busy.

bool modm::I2cDevice< I2cMaster, 10 , cat24Aa::DataTransmissionAdapter >::ping ( )

inheritedinline

Return Values

true	device responds to address
false	no device with address found

template<typename I2cMaster >

template<typename T >

bool modm::Cat24Aa< I2cMaster >::read	(	uint16_t	address,
		T &	data
	)

inline

Convenience function

Shortcut for:

return read(address, static_cast<uint8_t *>(&data), sizeof(T));

void modm::I2cDevice< I2cMaster, 10 , cat24Aa::DataTransmissionAdapter >::setAddress ( uint8_t address )

inheritedinline

Sets a new address of the slave device.

Parameters

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

bool modm::I2cDevice< I2cMaster, 10 , cat24Aa::DataTransmissionAdapter >::wasTransactionSuccessful ( )

inheritedinlineprotected

Returns: true when transaction did not return an error.

template<typename I2cMaster >

template<typename T >

bool modm::Cat24Aa< I2cMaster >::write	(	uint32_t	address,
		const T &	data
	)

inline

Convenience function

Shortcut for:

return write(address, static_cast<const uint8_t *>(&data), sizeof(T));

template<typename I2cMaster >

bool modm::Cat24Aa< I2cMaster >::write	(	uint32_t	address,
		const uint8_t *	data,
		std::size_t	length
	)

Write block

Parameters

address	Address
data	Data block
length	Number of bytes to be written

Returns: true if the data could be written, false otherwise

template<typename I2cMaster >

bool modm::Cat24Aa< I2cMaster >::writeByte	(	uint32_t	address,
		uint8_t	data
	)

inline

Write byte

Parameters

address	Address
data	Data byte

Returns: true if the data could be written, false otherwise

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

cat24aa.hpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

template<typename I2cMaster> class modm::Cat24Aa< I2cMaster >

Member Function Documentation

template<typename I2cMaster>
class modm::Cat24Aa< I2cMaster >