This class defines a non-platform specific interface for an I2C master device driver. More...

Detailed Description

This class defines a non-platform specific interface for an I2C master device driver.

The intended usage is to create ONE driver per physical I2C bus, i.e. the driver instance can shared with multiple clients.

The driver is NOT thread safe. It is the responsibility of the Application to ensure thread safety when driver is used and/or shared with multiple clients.

#include <Master.h>

Inheritance diagram for Driver::I2C::Master:

[legend]

Public Types
enum	Result_T { eSUCCESS = 0 , eNO_ACK , eTIMEOUT , eNOT_STARTED , eERROR }
	Result codes. More...

Public Member Functions
virtual bool	start () noexcept=0
	This method is used initialize/start the driver.

virtual void	stop () noexcept=0
	This method is used to stop/shutdown the driver.

virtual Result_T	writeToDevice (uint8_t device7BitAddress, size_t numBytesToTransmit, const void *srcData, bool noStop=false) noexcept=0
	This method writes 'numBytesToTransmit' from 'srcData' to the I2C peripheral device.

virtual Result_T	readFromDevice (uint8_t device7BitAddress, size_t numBytesToRead, void *dstData, bool noStop=false)=0
	This method reads 'numBytesToRead' bytes from the I2C peripheral device into 'dstData'.

Result_T	registerWriteByte (uint8_t device7BitAddress, uint8_t reg, uint8_t value, bool noStop=false)
	Convenience method for common I2C operation.

template<class READ_TYPE >
Result_T	registerRead (uint8_t device7BitAddress, uint8_t reg, READ_TYPE &dstReadResult)
	Convenience method for common I2C operation.

virtual size_t	setBaudRate (size_t newBaudRateHz) noexcept=0
	This method changes the default/current I2C baud-rate.

virtual size_t	setTransactionTimeout (size_t maxTimeMs) noexcept=0
	This method changes the default/current timeout duration.

virtual	~Master ()
	Virtual destructor.

Member Enumeration Documentation

◆ Result_T

enum Driver::I2C::Master::Result_T

Result codes.

Enumerator
eSUCCESS	Operation was successful.
eNO_ACK	No acknowledgment received for the device address or the device is not present.
eTIMEOUT	The operation was aborted due to a timeout error.
eNOT_STARTED	The driver was not properly started.
eERROR	Generic/non-classified error.

Constructor & Destructor Documentation

◆ ~Master()

virtual Driver::I2C::Master::~Master ( )

inlinevirtual

Virtual destructor.

Member Function Documentation

◆ readFromDevice()

virtual Result_T Driver::I2C::Master::readFromDevice	(	uint8_t	device7BitAddress,
		size_t	numBytesToRead,
		void *	dstData,
		bool	noStop = `false`
	)

pure virtual

This method reads 'numBytesToRead' bytes from the I2C peripheral device into 'dstData'.

The application is RESPONSIBLE for ensure that 'dstData' is AT LEAST 'numBytesToRead' in size.

If 'noStop' is true, the driver retains control of the bus at the end of the transfer (no Stop is issued), and the next transfer will begin with a Restart rather than a Start.

Implemented in Driver::I2C::Arduino::Master, and Driver::I2C::STM32::Master.

◆ registerRead()

template<class READ_TYPE >

Result_T Driver::I2C::Master::registerRead	(	uint8_t	device7BitAddress,
		uint8_t	reg,
		READ_TYPE &	dstReadResult
	)

inline

Convenience method for common I2C operation.

◆ registerWriteByte()

Result_T Driver::I2C::Master::registerWriteByte	(	uint8_t	device7BitAddress,
		uint8_t	reg,
		uint8_t	value,
		bool	noStop = `false`
	)

inline

Convenience method for common I2C operation.

◆ setBaudRate()

virtual size_t Driver::I2C::Master::setBaudRate ( size_t newBaudRateHz )

pure virtualnoexcept

This method changes the default/current I2C baud-rate.

The application is responsible for setting values that are supported by the actual platform hardware. The method returns the previous baud rate setting.

Baud rate is Hz, e.g. 100kHz is 100000.

The default baud rate is specific to the concrete driver.

NOTE: This method can ONLY be called when there is no I2C transaction in progress. The Application is RESPONSIBLE for enforcing this constraint.

This method can be called before start() is called.

Implemented in Driver::I2C::Arduino::Master, and Driver::I2C::STM32::Master.

◆ setTransactionTimeout()

virtual size_t Driver::I2C::Master::setTransactionTimeout ( size_t maxTimeMs )

pure virtualnoexcept

This method changes the default/current timeout duration.

The timeout duration is the maximum amount of time, in milliseconds, the driver will wait for a I2C transaction to complete. The method returns the previous timeout setting.

The default timeout is specific to the concrete driver.

NOTE: This method can ONLY be called when there is no I2C transaction in progress. The Application is RESPONSIBLE for enforcing this constraint.

This method can be called before start() is called.

Implemented in Driver::I2C::Arduino::Master, and Driver::I2C::STM32::Master.

◆ start()

virtual bool Driver::I2C::Master::start ( )

pure virtualnoexcept

This method is used initialize/start the driver.

To 'restart' the driver, the application must call stop(), then start().

The method returns true if successful; else false is returned when an error occurred. If false is returned, future read/write calls will always return a failure.

Implemented in Driver::I2C::Arduino::Master, and Driver::I2C::STM32::Master.

◆ stop()

virtual void Driver::I2C::Master::stop ( )

pure virtualnoexcept

This method is used to stop/shutdown the driver.

Implemented in Driver::I2C::Arduino::Master, and Driver::I2C::STM32::Master.

◆ writeToDevice()

virtual Result_T Driver::I2C::Master::writeToDevice	(	uint8_t	device7BitAddress,
		size_t	numBytesToTransmit,
		const void *	srcData,
		bool	noStop = `false`
	)

pure virtualnoexcept

This method writes 'numBytesToTransmit' from 'srcData' to the I2C peripheral device.

If 'noStop' is true, the driver retains control of the bus at the end of the transfer (no Stop is issued), and the next I2C transaction will begin with a Restart rather than a Start.

Implemented in Driver::I2C::Arduino::Master, and Driver::I2C::STM32::Master.

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

Driver/I2C/Master.h

Detailed Description

Public Types

Public Member Functions

Member Enumeration Documentation

◆ Result_T

Constructor & Destructor Documentation

◆ ~Master()

Member Function Documentation

◆ readFromDevice()

◆ registerRead()

◆ registerWriteByte()

◆ setBaudRate()

◆ setTransactionTimeout()

◆ start()

◆ stop()

◆ writeToDevice()