ESPHome  2024.11.3
Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes
esphome::sgp30::SGP30Component Class Reference

This class implements support for the Sensirion SGP30 i2c GAS (VOC and CO2eq) sensors. More...

#include <sgp30.h>

Inheritance diagram for esphome::sgp30::SGP30Component:
esphome::PollingComponent esphome::sensirion_common::SensirionI2CDevice esphome::Component esphome::i2c::I2CDevice

Public Member Functions

void set_eco2_sensor (sensor::Sensor *eco2)
 
void set_tvoc_sensor (sensor::Sensor *tvoc)
 
void set_eco2_baseline_sensor (sensor::Sensor *eco2_baseline)
 
void set_tvoc_baseline_sensor (sensor::Sensor *tvoc_baseline)
 
void set_store_baseline (bool store_baseline)
 
void set_eco2_baseline (uint16_t eco2_baseline)
 
void set_tvoc_baseline (uint16_t tvoc_baseline)
 
void set_humidity_sensor (sensor::Sensor *humidity)
 
void set_temperature_sensor (sensor::Sensor *temperature)
 
void setup () override
 
void update () override
 
void dump_config () override
 
float get_setup_priority () const override
 
- Public Member Functions inherited from esphome::PollingComponent
 PollingComponent ()
 
 PollingComponent (uint32_t update_interval)
 Initialize this polling component with the given update interval in ms. More...
 
virtual void set_update_interval (uint32_t update_interval)
 Manually set the update interval in ms for this polling object. More...
 
void call_setup () override
 
virtual uint32_t get_update_interval () const
 Get the update interval in ms of this sensor. More...
 
void start_poller ()
 
void stop_poller ()
 
- Public Member Functions inherited from esphome::Component
virtual void loop ()
 This method will be called repeatedly. More...
 
float get_actual_setup_priority () const
 
void set_setup_priority (float priority)
 
virtual float get_loop_priority () const
 priority of loop(). More...
 
void call ()
 
virtual void on_shutdown ()
 
virtual void on_safe_shutdown ()
 
uint32_t get_component_state () const
 
virtual void mark_failed ()
 Mark this component as failed. More...
 
bool is_failed () const
 
bool is_ready () const
 
virtual bool can_proceed ()
 
bool status_has_warning () const
 
bool status_has_error () const
 
void status_set_warning (const char *message="unspecified")
 
void status_set_error (const char *message="unspecified")
 
void status_clear_warning ()
 
void status_clear_error ()
 
void status_momentary_warning (const std::string &name, uint32_t length=5000)
 
void status_momentary_error (const std::string &name, uint32_t length=5000)
 
bool has_overridden_loop () const
 
void set_component_source (const char *source)
 Set where this component was loaded from for some debug messages. More...
 
const char * get_component_source () const
 Get the integration where this component was declared as a string. More...
 
- Public Member Functions inherited from esphome::sensirion_common::SensirionI2CDevice
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
 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 Types

enum  ErrorCode {
  COMMUNICATION_FAILED, MEASUREMENT_INIT_FAILED, INVALID_ID, UNSUPPORTED_ID,
  UNKNOWN
}
 

Protected Member Functions

void send_env_data_ ()
 
void read_iaq_baseline_ ()
 
bool is_sensor_baseline_reliable_ ()
 
void write_iaq_baseline_ (uint16_t eco2_baseline, uint16_t tvoc_baseline)
 
- Protected Member Functions inherited from esphome::Component
virtual void call_loop ()
 
virtual void call_dump_config ()
 
void set_interval (const std::string &name, uint32_t interval, std::function< void()> &&f)
 Set an interval function with a unique name. More...
 
void set_interval (uint32_t interval, std::function< void()> &&f)
 
bool cancel_interval (const std::string &name)
 Cancel an interval function. More...
 
void set_retry (const std::string &name, uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f)
 Set an retry function with a unique name. More...
 
void set_retry (uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f)
 
bool cancel_retry (const std::string &name)
 Cancel a retry function. More...
 
void set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f)
 Set a timeout function with a unique name. More...
 
void set_timeout (uint32_t timeout, std::function< void()> &&f)
 
bool cancel_timeout (const std::string &name)
 Cancel a timeout function. More...
 
void defer (const std::string &name, std::function< void()> &&f)
 Defer a callback to the next loop() call. More...
 
void defer (std::function< void()> &&f)
 Defer a callback to the next loop() call. More...
 
bool cancel_defer (const std::string &name)
 Cancel a defer callback using the specified name, name must not be empty. More...
 
- Protected Member Functions inherited from esphome::sensirion_common::SensirionI2CDevice
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

uint64_t serial_number_
 
uint16_t featureset_
 
uint32_t required_warm_up_time_
 
uint32_t seconds_since_last_store_
 
SGP30Baselines baselines_storage_
 
ESPPreferenceObject pref_
 
enum esphome::sgp30::SGP30Component::ErrorCode UNKNOWN
 
sensor::Sensoreco2_sensor_ {nullptr}
 
sensor::Sensortvoc_sensor_ {nullptr}
 
sensor::Sensoreco2_sensor_baseline_ {nullptr}
 
sensor::Sensortvoc_sensor_baseline_ {nullptr}
 
uint16_t eco2_baseline_ {0x0000}
 
uint16_t tvoc_baseline_ {0x0000}
 
bool store_baseline_
 
sensor::Sensorhumidity_sensor_ {nullptr}
 Input sensor for humidity and temperature compensation. More...
 
sensor::Sensortemperature_sensor_ {nullptr}
 
- Protected Attributes inherited from esphome::PollingComponent
uint32_t update_interval_
 
- Protected Attributes inherited from esphome::Component
uint32_t component_state_ {0x0000}
 State of this component. More...
 
float setup_priority_override_ {NAN}
 
const char * component_source_ {nullptr}
 
- Protected Attributes inherited from esphome::sensirion_common::SensirionI2CDevice
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}
 store the address of the device on the bus More...
 
I2CBusbus_ {nullptr}
 pointer to I2CBus instance More...
 

Additional Inherited Members

- Public Types inherited from esphome::sensirion_common::SensirionI2CDevice
enum  CommandLen : uint8_t { ADDR_8_BIT = 1, ADDR_16_BIT = 2 }
 

Detailed Description

This class implements support for the Sensirion SGP30 i2c GAS (VOC and CO2eq) sensors.

Definition at line 20 of file sgp30.h.

Member Enumeration Documentation

◆ ErrorCode

Enumerator
COMMUNICATION_FAILED 
MEASUREMENT_INIT_FAILED 
INVALID_ID 
UNSUPPORTED_ID 
UNKNOWN 

Definition at line 49 of file sgp30.h.

Member Function Documentation

◆ dump_config()

void esphome::sgp30::SGP30Component::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 229 of file sgp30.cpp.

◆ get_setup_priority()

float esphome::sgp30::SGP30Component::get_setup_priority ( ) const
inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 35 of file sgp30.h.

◆ is_sensor_baseline_reliable_()

bool esphome::sgp30::SGP30Component::is_sensor_baseline_reliable_ ( )
protected

Definition at line 101 of file sgp30.cpp.

◆ read_iaq_baseline_()

void esphome::sgp30::SGP30Component::read_iaq_baseline_ ( )
protected

Definition at line 111 of file sgp30.cpp.

◆ send_env_data_()

void esphome::sgp30::SGP30Component::send_env_data_ ( )
protected

Definition at line 162 of file sgp30.cpp.

◆ set_eco2_baseline()

void esphome::sgp30::SGP30Component::set_eco2_baseline ( uint16_t  eco2_baseline)
inline

Definition at line 27 of file sgp30.h.

◆ set_eco2_baseline_sensor()

void esphome::sgp30::SGP30Component::set_eco2_baseline_sensor ( sensor::Sensor eco2_baseline)
inline

Definition at line 24 of file sgp30.h.

◆ set_eco2_sensor()

void esphome::sgp30::SGP30Component::set_eco2_sensor ( sensor::Sensor eco2)
inline

Definition at line 22 of file sgp30.h.

◆ set_humidity_sensor()

void esphome::sgp30::SGP30Component::set_humidity_sensor ( sensor::Sensor humidity)
inline

Definition at line 29 of file sgp30.h.

◆ set_store_baseline()

void esphome::sgp30::SGP30Component::set_store_baseline ( bool  store_baseline)
inline

Definition at line 26 of file sgp30.h.

◆ set_temperature_sensor()

void esphome::sgp30::SGP30Component::set_temperature_sensor ( sensor::Sensor temperature)
inline

Definition at line 30 of file sgp30.h.

◆ set_tvoc_baseline()

void esphome::sgp30::SGP30Component::set_tvoc_baseline ( uint16_t  tvoc_baseline)
inline

Definition at line 28 of file sgp30.h.

◆ set_tvoc_baseline_sensor()

void esphome::sgp30::SGP30Component::set_tvoc_baseline_sensor ( sensor::Sensor tvoc_baseline)
inline

Definition at line 25 of file sgp30.h.

◆ set_tvoc_sensor()

void esphome::sgp30::SGP30Component::set_tvoc_sensor ( sensor::Sensor tvoc)
inline

Definition at line 23 of file sgp30.h.

◆ setup()

void esphome::sgp30::SGP30Component::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 35 of file sgp30.cpp.

◆ update()

void esphome::sgp30::SGP30Component::update ( )
overridevirtual

Implements esphome::PollingComponent.

Definition at line 276 of file sgp30.cpp.

◆ write_iaq_baseline_()

void esphome::sgp30::SGP30Component::write_iaq_baseline_ ( uint16_t  eco2_baseline,
uint16_t  tvoc_baseline 
)
protected

Definition at line 212 of file sgp30.cpp.

Field Documentation

◆ baselines_storage_

SGP30Baselines esphome::sgp30::SGP30Component::baselines_storage_
protected

Definition at line 46 of file sgp30.h.

◆ eco2_baseline_

uint16_t esphome::sgp30::SGP30Component::eco2_baseline_ {0x0000}
protected

Definition at line 61 of file sgp30.h.

◆ eco2_sensor_

sensor::Sensor* esphome::sgp30::SGP30Component::eco2_sensor_ {nullptr}
protected

Definition at line 57 of file sgp30.h.

◆ eco2_sensor_baseline_

sensor::Sensor* esphome::sgp30::SGP30Component::eco2_sensor_baseline_ {nullptr}
protected

Definition at line 59 of file sgp30.h.

◆ featureset_

uint16_t esphome::sgp30::SGP30Component::featureset_
protected

Definition at line 43 of file sgp30.h.

◆ humidity_sensor_

sensor::Sensor* esphome::sgp30::SGP30Component::humidity_sensor_ {nullptr}
protected

Input sensor for humidity and temperature compensation.

Definition at line 66 of file sgp30.h.

◆ pref_

ESPPreferenceObject esphome::sgp30::SGP30Component::pref_
protected

Definition at line 47 of file sgp30.h.

◆ required_warm_up_time_

uint32_t esphome::sgp30::SGP30Component::required_warm_up_time_
protected

Definition at line 44 of file sgp30.h.

◆ seconds_since_last_store_

uint32_t esphome::sgp30::SGP30Component::seconds_since_last_store_
protected

Definition at line 45 of file sgp30.h.

◆ serial_number_

uint64_t esphome::sgp30::SGP30Component::serial_number_
protected

Definition at line 42 of file sgp30.h.

◆ store_baseline_

bool esphome::sgp30::SGP30Component::store_baseline_
protected

Definition at line 63 of file sgp30.h.

◆ temperature_sensor_

sensor::Sensor* esphome::sgp30::SGP30Component::temperature_sensor_ {nullptr}
protected

Definition at line 67 of file sgp30.h.

◆ tvoc_baseline_

uint16_t esphome::sgp30::SGP30Component::tvoc_baseline_ {0x0000}
protected

Definition at line 62 of file sgp30.h.

◆ tvoc_sensor_

sensor::Sensor* esphome::sgp30::SGP30Component::tvoc_sensor_ {nullptr}
protected

Definition at line 58 of file sgp30.h.

◆ tvoc_sensor_baseline_

sensor::Sensor* esphome::sgp30::SGP30Component::tvoc_sensor_baseline_ {nullptr}
protected

Definition at line 60 of file sgp30.h.

◆ UNKNOWN

enum esphome::sgp30::SGP30Component::ErrorCode esphome::sgp30::SGP30Component::UNKNOWN
protected

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