ESPHome  2022.8.0
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes
esphome::sensirion_common::SensirionI2CDevice Class Reference

Implementation of a i2c functions for Sensirion sensors Sensirion data requires crc checking. More...

#include <i2c_sensirion.h>

Inheritance diagram for esphome::sensirion_common::SensirionI2CDevice:
esphome::i2c::I2CDevice esphome::scd30::SCD30Component esphome::scd4x::SCD4XComponent esphome::sdp3x::SDP3XComponent esphome::sen5x::SEN5XComponent esphome::sgp30::SGP30Component esphome::sgp4x::SGP4xComponent esphome::sht3xd::SHT3XDComponent esphome::sht4x::SHT4XComponent esphome::shtcx::SHTCXComponent esphome::sps30::SPS30Component esphome::sts3x::STS3XComponent

Public Types

enum  CommandLen : uint8_t { ADDR_8_BIT = 1, ADDR_16_BIT = 2 }
 

Public Member Functions

bool read_data (uint16_t *data, uint8_t len)
 Read data words from i2c device. More...
 
bool read_data (uint16_t &data)
 Read 1 data word from i2c device. More...
 
bool get_register (uint16_t command, uint16_t *data, uint8_t len, uint8_t delay=0)
 get data words from i2c register. More...
 
bool get_register (uint16_t i2c_register, uint16_t &data, uint8_t delay=0)
 Read 1 data word from 16 bit i2c register. More...
 
bool get_8bit_register (uint8_t i2c_register, uint16_t *data, uint8_t len, uint8_t delay=0)
 get data words from i2c register. More...
 
bool get_8bit_register (uint8_t i2c_register, uint16_t &data, uint8_t delay=0)
 Read 1 data word from 8 bit i2c register. More...
 
template<class T >
bool write_command (T i2c_register)
 Write a command to the i2c device. More...
 
template<class T >
bool write_command (T i2c_register, uint16_t data)
 Write a command and one data word to the i2c device . More...
 
template<class T >
bool write_command (T i2c_register, const std::vector< uint16_t > &data)
 Write a command with arguments as words. More...
 
template<class T >
bool write_command (T i2c_register, const uint16_t *data, uint8_t len)
 Write a command with arguments as words. More...
 
- Public Member Functions inherited from esphome::i2c::I2CDevice
 I2CDevice ()=default
 
void set_i2c_address (uint8_t address)
 
void set_i2c_bus (I2CBus *bus)
 
I2CRegister reg (uint8_t a_register)
 
ErrorCode read (uint8_t *data, size_t len)
 
ErrorCode read_register (uint8_t a_register, uint8_t *data, size_t len, bool stop=true)
 
ErrorCode write (const uint8_t *data, uint8_t len, bool stop=true)
 
ErrorCode write_register (uint8_t a_register, const uint8_t *data, size_t len, bool stop=true)
 
bool read_bytes (uint8_t a_register, uint8_t *data, uint8_t len)
 
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 Member Functions

bool write_command_ (uint16_t command, CommandLen command_len, const uint16_t *data, uint8_t data_len)
 Write a command with arguments as words. More...
 
bool get_register_ (uint16_t reg, CommandLen command_len, uint16_t *data, uint8_t len, uint8_t delay)
 get data words from i2c register. More...
 
uint8_t sht_crc_ (uint16_t data)
 8-bit CRC checksum that is transmitted after each data word for read and write operation More...
 
uint8_t sht_crc_ (uint8_t data1, uint8_t data2)
 8-bit CRC checksum that is transmitted after each data word for read and write operation More...
 

Protected Attributes

uint8_t crc_polynomial_ {0x31u}
 
i2c::ErrorCode last_error_
 last error code from i2c operation More...
 
- Protected Attributes inherited from esphome::i2c::I2CDevice
uint8_t address_ {0x00}
 
I2CBusbus_ {nullptr}
 

Detailed Description

Implementation of a i2c functions for Sensirion sensors Sensirion data requires crc checking.

Each 16 bit word is/must be followed 8 bit CRC code (Applies to read and write - note the i2c command code doesn't need a CRC) Format: | 16 Bit Command Code | 16 bit Data word 1 | CRC of DW 1 | 16 bit Data word 1 | CRC of DW 2 | ..

Definition at line 15 of file i2c_sensirion.h.

Member Enumeration Documentation

◆ CommandLen

Enumerator
ADDR_8_BIT 
ADDR_16_BIT 

Definition at line 17 of file i2c_sensirion.h.

Member Function Documentation

◆ get_8bit_register() [1/2]

bool esphome::sensirion_common::SensirionI2CDevice::get_8bit_register ( uint8_t  i2c_register,
uint16_t *  data,
uint8_t  len,
uint8_t  delay = 0 
)
inline

get data words from i2c register.

handles crc check used by Sensirion sensors

Parameters
i2cregister
datapointer to raw result
lennumber of words to read
delaymilliseconds to to wait between sending the i2c command and reading the result
Returns
true if reading succeeded

Definition at line 62 of file i2c_sensirion.h.

◆ get_8bit_register() [2/2]

bool esphome::sensirion_common::SensirionI2CDevice::get_8bit_register ( uint8_t  i2c_register,
uint16_t &  data,
uint8_t  delay = 0 
)
inline

Read 1 data word from 8 bit i2c register.

Parameters
i2cregister
datareference to raw result
delaymilliseconds to to wait between sending the i2c command and reading the result
Returns
true if reading succeeded

Definition at line 72 of file i2c_sensirion.h.

◆ get_register() [1/2]

bool esphome::sensirion_common::SensirionI2CDevice::get_register ( uint16_t  command,
uint16_t *  data,
uint8_t  len,
uint8_t  delay = 0 
)
inline

get data words from i2c register.

handles crc check used by Sensirion sensors

Parameters
i2cregister
datapointer to raw result
lennumber of words to read
delaymilliseconds to to wait between sending the i2c command and reading the result
Returns
true if reading succeeded

Definition at line 41 of file i2c_sensirion.h.

◆ get_register() [2/2]

bool esphome::sensirion_common::SensirionI2CDevice::get_register ( uint16_t  i2c_register,
uint16_t &  data,
uint8_t  delay = 0 
)
inline

Read 1 data word from 16 bit i2c register.

Parameters
i2cregister
datareference to raw result
delaymilliseconds to to wait between sending the i2c command and reading the result
Returns
true if reading succeeded

Definition at line 50 of file i2c_sensirion.h.

◆ get_register_()

bool esphome::sensirion_common::SensirionI2CDevice::get_register_ ( uint16_t  reg,
CommandLen  command_len,
uint16_t *  data,
uint8_t  len,
uint8_t  delay 
)
protected

get data words from i2c register.

handles crc check used by Sensirion sensors

Parameters
i2cregister
command_leneither 1 for short 8 bit command or 2 for 16 bit command codes
datapointer to raw result
lennumber of words to read
delaymilliseconds to to wait between sending the i2c command and reading the result
Returns
true if reading succeeded

Definition at line 82 of file i2c_sensirion.cpp.

◆ read_data() [1/2]

bool esphome::sensirion_common::SensirionI2CDevice::read_data ( uint16_t *  data,
uint8_t  len 
)

Read data words from i2c device.

handles crc check used by Sensirion sensors

Parameters
datapointer to raw result
lennumber of words to read
Returns
true if reading succeeded

Definition at line 13 of file i2c_sensirion.cpp.

◆ read_data() [2/2]

bool esphome::sensirion_common::SensirionI2CDevice::read_data ( uint16_t &  data)
inline

Read 1 data word from i2c device.

Parameters
datareference to raw result
Returns
true if reading succeeded

Definition at line 31 of file i2c_sensirion.h.

◆ sht_crc_() [1/2]

uint8_t esphome::sensirion_common::SensirionI2CDevice::sht_crc_ ( uint16_t  data)
protected

8-bit CRC checksum that is transmitted after each data word for read and write operation

Parameters
commandi2c command to send
datadata word for which the crc8 checksum is calculated
lennumber of arguments (words)
Returns
8 Bit CRC

Definition at line 97 of file i2c_sensirion.cpp.

◆ sht_crc_() [2/2]

uint8_t esphome::sensirion_common::SensirionI2CDevice::sht_crc_ ( uint8_t  data1,
uint8_t  data2 
)
inlineprotected

8-bit CRC checksum that is transmitted after each data word for read and write operation

Parameters
commandi2c command to send
data1high byte of data word
data2low byte of data word
Returns
8 Bit CRC

Definition at line 147 of file i2c_sensirion.h.

◆ write_command() [1/4]

template<class T >
bool esphome::sensirion_common::SensirionI2CDevice::write_command ( i2c_register)
inline

Write a command to the i2c device.

Parameters
commandi2c command to send
Returns
true if reading succeeded

Definition at line 80 of file i2c_sensirion.h.

◆ write_command() [2/4]

template<class T >
bool esphome::sensirion_common::SensirionI2CDevice::write_command ( i2c_register,
uint16_t  data 
)
inline

Write a command and one data word to the i2c device .

Parameters
commandi2c command to send
dataargument for the i2c command
Returns
true if reading succeeded

Definition at line 87 of file i2c_sensirion.h.

◆ write_command() [3/4]

template<class T >
bool esphome::sensirion_common::SensirionI2CDevice::write_command ( i2c_register,
const std::vector< uint16_t > &  data 
)
inline

Write a command with arguments as words.

Parameters
i2c_registeri2c command to send - an be uint8_t or uint16_t
datavector<uint16> arguments for the i2c command
Returns
true if reading succeeded

Definition at line 94 of file i2c_sensirion.h.

◆ write_command() [4/4]

template<class T >
bool esphome::sensirion_common::SensirionI2CDevice::write_command ( i2c_register,
const uint16_t *  data,
uint8_t  len 
)
inline

Write a command with arguments as words.

Parameters
i2c_registeri2c command to send - an be uint8_t or uint16_t
dataarguments for the i2c command
lennumber of arguments (words)
Returns
true if reading succeeded

Definition at line 104 of file i2c_sensirion.h.

◆ write_command_()

bool esphome::sensirion_common::SensirionI2CDevice::write_command_ ( uint16_t  command,
CommandLen  command_len,
const uint16_t *  data,
uint8_t  data_len 
)
protected

Write a command with arguments as words.

Parameters
commandi2c command to send can be uint8_t or uint16_t
command_leneither 1 for short 8 bit command or 2 for 16 bit command codes
dataarguments for the i2c command
data_lennumber of arguments (words)
Returns
true if reading succeeded

Definition at line 38 of file i2c_sensirion.cpp.

Field Documentation

◆ crc_polynomial_

uint8_t esphome::sensirion_common::SensirionI2CDevice::crc_polynomial_ {0x31u}
protected

Definition at line 112 of file i2c_sensirion.h.

◆ last_error_

i2c::ErrorCode esphome::sensirion_common::SensirionI2CDevice::last_error_
protected

last error code from i2c operation

Definition at line 151 of file i2c_sensirion.h.


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