m5::unit::AdapterI2C Class Reference

I2C access adapter. More...

#include <adapter_i2c.hpp>

Inheritance diagram for m5::unit::AdapterI2C:

Classes
class	BusImpl
class	I2CClassImpl
class	I2CImpl

Public Types
enum class	ImplType : uint8_t { Unknown , TwoWire , Bus , I2CClass }
	I2C implementation type. More...
Public Types inherited from m5::unit::Adapter
enum class	Type : uint8_t {   Unknown , I2C , GPIO , UART ,   SPI }

Public Member Functions
	AdapterI2C (m5::hal::bus::Bus *bus, const uint8_t addr, const uint32_t clock)
	AdapterI2C (m5::I2C_Class &i2c, const uint8_t addr, const uint32_t clock)
	AdapterI2C (m5::hal::bus::Bus &bus, const uint8_t addr, const uint32_t clock)
I2CImpl *	impl ()
const I2CImpl *	impl () const
uint8_t	address () const
void	setAddress (const uint8_t addr)
uint32_t	clock () const
void	setClock (const uint32_t clock)
ImplType	implType () const
	Gets the I2C implementation type.
int16_t	scl () const
int16_t	sda () const
virtual Adapter *	duplicate (const uint8_t addr) override
Temporary API
Warning Functionality required for a specific unit Will be improved when integrated with M5HAL
bool	begin ()
bool	end ()
bool	pushPin ()
bool	popPin ()
Public Member Functions inherited from m5::unit::Adapter
	Adapter (const Adapter &)=delete
	Adapter (Adapter &&) noexcept=default
Adapter &	operator= (const Adapter &)=delete
Adapter &	operator= (Adapter &&) noexcept=default
Type	type () const
virtual void	beginTransaction ()
virtual void	endTransaction ()
m5::hal::error::error_t	readWithTransaction (uint8_t *data, const size_t len)
m5::hal::error::error_t	writeWithTransaction (const uint8_t *data, const size_t len, const uint32_t exparam=1)
m5::hal::error::error_t	writeWithTransaction (const uint8_t reg, const uint8_t *data, const size_t len, const uint32_t exparam=1)
m5::hal::error::error_t	writeWithTransaction (const uint16_t reg, const uint8_t *data, const size_t len, const uint32_t exparam=1)
m5::hal::error::error_t	generalCall (const uint8_t *data, const size_t len)
m5::hal::error::error_t	pinModeRX (const gpio::Mode m)
m5::hal::error::error_t	writeDigitalRX (const bool high)
m5::hal::error::error_t	readDigitalRX (bool &high)
m5::hal::error::error_t	writeAnalogRX (const uint16_t v)
m5::hal::error::error_t	readAnalogRX (uint16_t &v)
m5::hal::error::error_t	readAnalogMilliVoltsRX (uint32_t &mv)
m5::hal::error::error_t	pulseInRX (uint32_t &duration, const int state, const uint32_t timeout_us)
m5::hal::error::error_t	pinModeTX (const gpio::Mode m)
m5::hal::error::error_t	writeDigitalTX (const bool high)
m5::hal::error::error_t	readDigitalTX (bool &high)
m5::hal::error::error_t	writeAnalogTX (const uint16_t v)
m5::hal::error::error_t	readAnalogTX (uint16_t &v)
m5::hal::error::error_t	readAnalogMilliVoltsTX (uint32_t &mv)
m5::hal::error::error_t	pulseInTX (uint32_t &duration, const int state, const uint32_t timeout_us)

Protected Attributes
gpio::pin_backup_t	_backupSCL {-1}
gpio::pin_backup_t	_backupSDA {-1}
Protected Attributes inherited from m5::unit::Adapter
std::unique_ptr< Impl >	_impl {}

Additional Inherited Members
Protected Member Functions inherited from m5::unit::Adapter
	Adapter (const Type t, Impl *impl)

Detailed Description

I2C access adapter.

Member Enumeration Documentation

ImplType

enum class m5::unit::AdapterI2C::ImplType : uint8_t

strong

I2C implementation type.

Enumerator
Unknown	Unknown.
TwoWire	Arduino TwoWire.
Bus	M5HAL Bus (including SoftwareI2C)
I2CClass	m5::I2C_Class (m5gfx::i2c)

Member Function Documentation

duplicate()

Adapter * AdapterI2C::duplicate ( const uint8_t addr )

overridevirtual

Reimplemented from m5::unit::Adapter.