ESP32_I2CCore Class Reference

Inheritance diagram for ESP32_I2CCore:

Collaboration diagram for ESP32_I2CCore:

Public Member Functions
	ESP32_I2CCore (uint8_t i2c_num)
bool	reset () override
	Reset the hardware resource to a known default state.
bool	begin () override
void	beginTransmission (uint8_t address) override
uint8_t	endTransmission () override
size_t	write (uint8_t data) override
size_t	write (const uint8_t *data, size_t quantity) override
size_t	requestFrom (uint8_t address, size_t len, bool stopBit) override
int	available () override
int	read () override
int	peek () override
void	flush () override
TwoWire &	getWireInstance ()
Public Member Functions inherited from I2CCore
virtual HardwareResource::Type	getType () override
	Get the hardware resource type.
virtual void	setPins (int8_t sdaPin, int8_t sclPin)
virtual void	setBufferSize (uint32_t bufferSize)
virtual void	setI2CNum (int8_t i2c_num)
virtual void	setFrequency (uint32_t frequency)
virtual uint32_t	setMaxFrequency (uint32_t frequency)
virtual uint8_t	getMaxUsages () override
	Get the maximum simultaneous usages allowed for this resource.
virtual I2CStatus	getI2CStatus () const
Public Member Functions inherited from HardwareResource
bool	requestUsage ()
	Request a usage slot for this resource.
uint8_t	getUsages ()
	Get the current number of usages of this resource.
bool	isUsed ()
	Check if the resource is currently used.
virtual uint8_t	getRemainingUsages ()
	Get remaining usage capacity for this resource.

Static Public Attributes
static constexpr uint8_t	ESP_I2C_NUM_0 = 0
static constexpr uint8_t	ESP_I2C_NUM_1 = 1
Static Public Attributes inherited from I2CCore
static constexpr uint32_t	I2C_DEFAULT_FREQUENCY = 1700000

Additional Inherited Members
Public Types inherited from I2CCore
enum	I2CStatus { I2C_NOT_STARTED =0 , I2C_STARTED =1 }
Public Types inherited from HardwareResource
enum	Type {   UART , SPI , I2C , PWM ,   CAN }
	Enumeration of hardware resource types. More...
Protected Member Functions inherited from HardwareResource
	HardwareResource ()=default
	Default constructor.
Protected Attributes inherited from I2CCore
int8_t	_sdaPin =-1
int8_t	_sclPin =-1
uint32_t	_frequency = I2C_DEFAULT_FREQUENCY
int8_t	_i2c_num =-1
uint32_t	_bufferSize = I2C_DEFAULT_BUFFER_LENGTH
I2CStatus	_i2cStatus = I2C_NOT_STARTED
Protected Attributes inherited from HardwareResource
uint8_t	usages =0
	Current usage counter.
Static Protected Attributes inherited from I2CCore
static constexpr uint16_t	I2C_DEFAULT_BUFFER_LENGTH = 32

Member Function Documentation

available()

int ESP32_I2CCore::available ( )

inlineoverridevirtual

Implements I2CCore.

begin()

bool ESP32_I2CCore::begin ( )

overridevirtual

Implements I2CCore.

beginTransmission()

void ESP32_I2CCore::beginTransmission ( uint8_t address )

inlineoverridevirtual

Implements I2CCore.

endTransmission()

uint8_t ESP32_I2CCore::endTransmission ( )

inlineoverridevirtual

Implements I2CCore.

flush()

void ESP32_I2CCore::flush ( )

inlineoverridevirtual

Implements I2CCore.

peek()

int ESP32_I2CCore::peek ( )

inlineoverridevirtual

Reimplemented from I2CCore.

read()

int ESP32_I2CCore::read ( )

inlineoverridevirtual

Implements I2CCore.

requestFrom()

size_t ESP32_I2CCore::requestFrom ( uint8_t address, size_t len, bool stopBit )

inlineoverridevirtual

Implements I2CCore.

reset()

bool ESP32_I2CCore::reset ( )

overridevirtual

Reset the hardware resource to a known default state.

Default implementation clears the usage counter and logs the reset. Derived classes should call the base implementation and perform any additional hardware-specific reset steps.

Returns

true if the reset succeeded, false otherwise.

Reimplemented from I2CCore.

Here is the call graph for this function:

write() [1/2]

size_t ESP32_I2CCore::write ( const uint8_t * data, size_t quantity )

inlineoverridevirtual

Implements I2CCore.

write() [2/2]

size_t ESP32_I2CCore::write ( uint8_t data )

inlineoverridevirtual

Implements I2CCore.

---

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

• C:/Users/leowa/Documents/PlatformIO/Projects/CANTramFrameworkUsage/lib/CANTramFramework/include/ESP32_I2CCore.h
• C:/Users/leowa/Documents/PlatformIO/Projects/CANTramFrameworkUsage/lib/CANTramFramework/src/hardware/ESP32_I2CCore.cpp