I2CDeviceWithHal Class Reference

#include <I2CDeviceWithHal.hpp>

Inheritance diagram for I2CDeviceWithHal:

Public Member Functions
bool	begin (SensorCommCustom::CustomCallback cb, SensorCommCustomHal::CustomHalCallback hal_cb, uint8_t addr)
	Initialize the sensor using custom callback interface.
Public Member Functions inherited from DeviceBeginCommon
virtual	~DeviceBeginCommon ()
uint8_t	getAddress () const
uint8_t	getInterface () const
Public Member Functions inherited from SensorCommWrapper
	SensorCommWrapper ()=default
int	readReg (uint8_t reg) const
int	readRegBuff (uint8_t reg, uint8_t *buf, size_t len) const
int	readBuff (uint8_t *buf, size_t len) const
int	writeReg (uint8_t reg, uint8_t val)
int	writeRegBuff (uint8_t reg, uint8_t *buf, size_t len)
int	writeBuff (uint8_t *buf, size_t len)
int	writeThenRead (const uint8_t *write_buffer, size_t write_len, uint8_t *read_buffer, size_t read_len)
bool	setRegBit (uint8_t reg, uint8_t bit)
bool	clrRegBit (uint8_t reg, uint8_t bit)
bool	getRegBit (uint8_t reg, uint8_t bit)
int	updateBits (uint8_t reg, uint8_t mask, uint8_t value_shifted)
void	setAddress (uint8_t address)
void	setAck (bool enable)
Public Member Functions inherited from SensorCommInterface
virtual	~SensorCommInterface ()=default

Protected Member Functions
bool	ensureValid () const override
	Ensure the communication interface is valid.
Protected Member Functions inherited from DeviceBeginCommon
	DeviceBeginCommon ()=default
virtual bool	initImpl (uint8_t param)=0
virtual SensorCommBase *	getComm () const override
virtual void	beforeBegin ()
virtual void	afterCommReady ()
virtual void	afterInitSuccess (uint8_t param)
virtual void	onBeginFail ()
bool	fail ()
void	clearCommState ()
template<typename CreateComm >
bool	beginLifecycle (uint8_t addr, uint8_t iface, uint8_t initParam, CreateComm createComm)

Additional Inherited Members
Protected Attributes inherited from DeviceBeginCommon
std::unique_ptr< SensorCommBase >	comm
std::unique_ptr< SensorHal >	hal
std::unique_ptr< SensorCommStatic >	staticComm
uint8_t	_addr = 0
uint8_t	_iface = COMM_CUSTOM

Detailed Description

Definition at line 33 of file I2CDeviceWithHal.hpp.

Member Function Documentation

begin()

bool I2CDeviceWithHal::begin ( SensorCommCustom::CustomCallback  cb, SensorCommCustomHal::CustomHalCallback  hal_cb, uint8_t  addr  )

inline

Initialize the sensor using custom callback interface.

Note

Suitable for other platforms not covered by standard implementations.

Parameters

interface	Communication interface type (COMM_SPI or COMM_I2C).
callback	Register read/write callback function.
hal_callback	Platform digital IO and delay callback function.
addr	Device address

Returns

True if initialization is successful, false otherwise.

Definition at line 93 of file I2CDeviceWithHal.hpp.

References DeviceBeginCommon::beginLifecycle(), DeviceBeginCommon::comm, COMM_CUSTOM, and DeviceBeginCommon::hal.

Referenced by GaugeBQ27220::begin(), GaugeAXP2602::begin(), TouchDrvInterface::begin(), PmicSY6970::begin(), PmicBQ25896::begin(), PmicAXP192::begin(), PmicAXP202::begin(), PmicAXP2101::begin(), PmicAXP517::begin(), PmicAXP517::begin(), beginPower(), setup(), testInit(), GaugeAXP2602::~GaugeAXP2602(), GaugeBQ27220::~GaugeBQ27220(), and TouchDrvInterface::~TouchDrvInterface().

ensureValid()

bool I2CDeviceWithHal::ensureValid ( ) const

inlineoverrideprotectedvirtual

Ensure the communication interface is valid.

Returns

True if valid, false otherwise.

Reimplemented from DeviceBeginCommon.

Definition at line 107 of file I2CDeviceWithHal.hpp.

References DeviceBeginCommon::comm, and DeviceBeginCommon::hal.

---

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

• I2CDeviceWithHal.hpp