This Class provides the methods to read/write bytes from/to an i2c device. More...

#include <i2c.h>

Inheritance diagram for esphome::i2c::I2CDevice:

Public Member Functions
	I2CDevice ()=default
	we use the C++ default constructor More...

void	set_i2c_address (uint8_t address)
	We store the address of the device on the bus. More...

void	set_i2c_bus (I2CBus *bus)
	we store the pointer to the I2CBus to use More...

I2CRegister	reg (uint8_t a_register)
	calls the I2CRegister constructor More...

I2CRegister16	reg16 (uint16_t a_register)
	calls the I2CRegister16 constructor More...

ErrorCode	read (uint8_t *data, size_t len)
	reads an array of bytes from the device using an I2CBus More...

ErrorCode	read_register (uint8_t a_register, uint8_t *data, size_t len, bool stop=true)
	reads an array of bytes from a specific register in the I²C device More...

ErrorCode	read_register16 (uint16_t a_register, uint8_t *data, size_t len, bool stop=true)
	reads an array of bytes from a specific register in the I²C device More...

ErrorCode	write (const uint8_t *data, size_t len, bool stop=true)
	writes an array of bytes to a device using an I2CBus More...

ErrorCode	write_register (uint8_t a_register, const uint8_t *data, size_t len, bool stop=true)
	writes an array of bytes to a specific register in the I²C device More...

ErrorCode	write_register16 (uint16_t a_register, const uint8_t *data, size_t len, bool stop=true)
	write an array of bytes to a specific register in the I²C device More...

bool	read_bytes (uint8_t a_register, uint8_t *data, uint8_t len)
	Compat APIs All methods below have been added for compatibility reasons. More...

bool	read_bytes_raw (uint8_t *data, uint8_t len)

template<size_t N>
optional< std::array< uint8_t, N > >	read_bytes (uint8_t a_register)

template<size_t N>
optional< std::array< uint8_t, N > >	read_bytes_raw ()

bool	read_bytes_16 (uint8_t a_register, uint16_t *data, uint8_t len)

bool	read_byte (uint8_t a_register, uint8_t *data, bool stop=true)

optional< uint8_t >	read_byte (uint8_t a_register)

bool	read_byte_16 (uint8_t a_register, uint16_t *data)

bool	write_bytes (uint8_t a_register, const uint8_t *data, uint8_t len, bool stop=true)

bool	write_bytes (uint8_t a_register, const std::vector< uint8_t > &data)

template<size_t N>
bool	write_bytes (uint8_t a_register, const std::array< uint8_t, N > &data)

bool	write_bytes_16 (uint8_t a_register, const uint16_t *data, uint8_t len)

bool	write_byte (uint8_t a_register, uint8_t data, bool stop=true)

bool	write_byte_16 (uint8_t a_register, uint16_t data)

Protected Attributes
uint8_t	address_ {0x00}
	store the address of the device on the bus More...

I2CBus *	bus_ {nullptr}
	pointer to I2CBus instance More...

Detailed Description

This Class provides the methods to read/write bytes from/to an i2c device.

Objects keep a list of devices found on bus as well as a pointer to the I2CBus in use.

Definition at line 133 of file i2c.h.

Constructor & Destructor Documentation

◆ I2CDevice()

esphome::i2c::I2CDevice::I2CDevice ( )

default

we use the C++ default constructor

Member Function Documentation

◆ read()

ErrorCode esphome::i2c::I2CDevice::read	(	uint8_t *	data,
		size_t	len
	)

inline

reads an array of bytes from the device using an I2CBus

Parameters

data	pointer to an array to store the bytes
len	length of the buffer = number of bytes to read

Returns: an i2c::ErrorCode

Definition at line 160 of file i2c.h.

◆ read_byte() [1/2]

bool esphome::i2c::I2CDevice::read_byte	(	uint8_t	a_register,
		uint8_t *	data,
		bool	stop = `true`
	)

inline

Definition at line 235 of file i2c.h.

◆ read_byte() [2/2]

optional<uint8_t> esphome::i2c::I2CDevice::read_byte ( uint8_t a_register )

inline

Definition at line 239 of file i2c.h.

◆ read_byte_16()

bool esphome::i2c::I2CDevice::read_byte_16	(	uint8_t	a_register,
		uint16_t *	data
	)

inline

Definition at line 246 of file i2c.h.

◆ read_bytes() [1/2]

bool esphome::i2c::I2CDevice::read_bytes	(	uint8_t	a_register,
		uint8_t *	data,
		uint8_t	len
	)

inline

Compat APIs All methods below have been added for compatibility reasons.

They do not bring any functionality and therefore on new code it is not recommend to use them.

Definition at line 212 of file i2c.h.

◆ read_bytes() [2/2]

template<size_t N>

optional<std::array<uint8_t, N> > esphome::i2c::I2CDevice::read_bytes ( uint8_t a_register )

inline

Definition at line 218 of file i2c.h.

◆ read_bytes_16()

bool esphome::i2c::I2CDevice::read_bytes_16	(	uint8_t	a_register,
		uint16_t *	data,
		uint8_t	len
	)

Definition at line 44 of file i2c.cpp.

◆ read_bytes_raw() [1/2]

bool esphome::i2c::I2CDevice::read_bytes_raw	(	uint8_t *	data,
		uint8_t	len
	)

inline

Definition at line 216 of file i2c.h.

◆ read_bytes_raw() [2/2]

template<size_t N>

optional<std::array<uint8_t, N> > esphome::i2c::I2CDevice::read_bytes_raw ( )

inline

Definition at line 225 of file i2c.h.

◆ read_register()

ErrorCode esphome::i2c::I2CDevice::read_register	(	uint8_t	a_register,
		uint8_t *	data,
		size_t	len,
		bool	stop = `true`
	)

reads an array of bytes from a specific register in the I²C device

Parameters

a_register	an 8 bits internal address of the I²C register to read from
data	pointer to an array to store the bytes
len	length of the buffer = number of bytes to read
stop	(true/false): True will send a stop message, releasing the bus after transmission. False will send a restart, keeping the connection active.

Returns: an i2c::ErrorCode

Definition at line 10 of file i2c.cpp.

◆ read_register16()

ErrorCode esphome::i2c::I2CDevice::read_register16	(	uint16_t	a_register,
		uint8_t *	data,
		size_t	len,
		bool	stop = `true`
	)

reads an array of bytes from a specific register in the I²C device

Parameters

a_register	the 16 bits internal address of the I²C register to read from
data	pointer to an array of bytes to store the information
len	length of the buffer = number of bytes to read
stop	(true/false): True will send a stop message, releasing the bus after transmission. False will send a restart, keeping the connection active.

Returns: an i2c::ErrorCode

Definition at line 17 of file i2c.cpp.

◆ reg()

I2CRegister esphome::i2c::I2CDevice::reg ( uint8_t a_register )

inline

calls the I2CRegister constructor

Parameters

a_register address of the I²C register

Returns: an I2CRegister proxy object

Definition at line 149 of file i2c.h.

◆ reg16()

I2CRegister16 esphome::i2c::I2CDevice::reg16 ( uint16_t a_register )

inline

calls the I2CRegister16 constructor

Parameters

a_register 16 bits address of the I²C register

Returns: an I2CRegister16 proxy object

Definition at line 154 of file i2c.h.

◆ set_i2c_address()

void esphome::i2c::I2CDevice::set_i2c_address ( uint8_t address )

inline

We store the address of the device on the bus.

Parameters

address of the device

Definition at line 140 of file i2c.h.

◆ set_i2c_bus()

void esphome::i2c::I2CDevice::set_i2c_bus ( I2CBus * bus )

inline

we store the pointer to the I2CBus to use

Parameters

bus	pointer to the I2CBus object

Definition at line 144 of file i2c.h.

◆ write()

ErrorCode esphome::i2c::I2CDevice::write	(	const uint8_t *	data,
		size_t	len,
		bool	stop = `true`
	)

inline

writes an array of bytes to a device using an I2CBus

Parameters

data	pointer to an array that contains the bytes to send
len	length of the buffer = number of bytes to write
stop	(true/false): True will send a stop message, releasing the bus after transmission. False will send a restart, keeping the connection active.

Returns: an i2c::ErrorCode

Definition at line 186 of file i2c.h.

◆ write_byte()

bool esphome::i2c::I2CDevice::write_byte	(	uint8_t	a_register,
		uint8_t	data,
		bool	stop = `true`
	)

inline

Definition at line 262 of file i2c.h.

◆ write_byte_16()

bool esphome::i2c::I2CDevice::write_byte_16	(	uint8_t	a_register,
		uint16_t	data
	)

inline

Definition at line 266 of file i2c.h.

◆ write_bytes() [1/3]

bool esphome::i2c::I2CDevice::write_bytes	(	uint8_t	a_register,
		const uint8_t *	data,
		uint8_t	len,
		bool	stop = `true`
	)

inline

Definition at line 248 of file i2c.h.

◆ write_bytes() [2/3]

bool esphome::i2c::I2CDevice::write_bytes	(	uint8_t	a_register,
		const std::vector< uint8_t > &	data
	)

inline

Definition at line 252 of file i2c.h.

◆ write_bytes() [3/3]

template<size_t N>

bool esphome::i2c::I2CDevice::write_bytes	(	uint8_t	a_register,
		const std::array< uint8_t, N > &	data
	)

inline

Definition at line 256 of file i2c.h.

◆ write_bytes_16()

bool esphome::i2c::I2CDevice::write_bytes_16	(	uint8_t	a_register,
		const uint16_t *	data,
		uint8_t	len
	)

Definition at line 52 of file i2c.cpp.

◆ write_register()

ErrorCode esphome::i2c::I2CDevice::write_register	(	uint8_t	a_register,
		const uint8_t *	data,
		size_t	len,
		bool	stop = `true`
	)

writes an array of bytes to a specific register in the I²C device

Parameters

a_register	the internal address of the register to read from
data	pointer to an array to store the bytes
len	length of the buffer = number of bytes to read
stop	(true/false): True will send a stop message, releasing the bus after transmission. False will send a restart, keeping the connection active.

Returns: an i2c::ErrorCode

Definition at line 25 of file i2c.cpp.

◆ write_register16()

ErrorCode esphome::i2c::I2CDevice::write_register16	(	uint16_t	a_register,
		const uint8_t *	data,
		size_t	len,
		bool	stop = `true`
	)

write an array of bytes to a specific register in the I²C device

Parameters

a_register	the 16 bits internal address of the register to read from
data	pointer to an array to store the bytes
len	length of the buffer = number of bytes to read
stop	(true/false): True will send a stop message, releasing the bus after transmission. False will send a restart, keeping the connection active.

Returns: an i2c::ErrorCode

Definition at line 34 of file i2c.cpp.

Field Documentation

◆ address_

uint8_t esphome::i2c::I2CDevice::address_ {0x00}

protected

store the address of the device on the bus

Definition at line 269 of file i2c.h.

◆ bus_

I2CBus* esphome::i2c::I2CDevice::bus_ {nullptr}

protected

pointer to I2CBus instance

Definition at line 270 of file i2c.h.

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

/opt/build/esphome/esphome/components/i2c/i2c.h
/opt/build/esphome/esphome/components/i2c/i2c.cpp

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ I2CDevice()

Member Function Documentation

◆ read()

◆ read_byte() [1/2]

◆ read_byte() [2/2]

◆ read_byte_16()

◆ read_bytes() [1/2]

◆ read_bytes() [2/2]

◆ read_bytes_16()

◆ read_bytes_raw() [1/2]

◆ read_bytes_raw() [2/2]

◆ read_register()

◆ read_register16()

◆ reg()

◆ reg16()

◆ set_i2c_address()

◆ set_i2c_bus()

◆ write()

◆ write_byte()

◆ write_byte_16()

◆ write_bytes() [1/3]

◆ write_bytes() [2/3]

◆ write_bytes() [3/3]

◆ write_bytes_16()

◆ write_register()

◆ write_register16()

Field Documentation

◆ address_

◆ bus_