ESPHome  2022.11.4
Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes
esphome::scd30::SCD30Component Class Reference

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

#include <scd30.h>

Inheritance diagram for esphome::scd30::SCD30Component:
esphome::Component esphome::sensirion_common::SensirionI2CDevice esphome::i2c::I2CDevice

Public Member Functions

void set_co2_sensor (sensor::Sensor *co2)
 
void set_humidity_sensor (sensor::Sensor *humidity)
 
void set_temperature_sensor (sensor::Sensor *temperature)
 
void set_automatic_self_calibration (bool asc)
 
void set_altitude_compensation (uint16_t altitude)
 
void set_ambient_pressure_compensation (float pressure)
 
void set_temperature_offset (float offset)
 
void set_update_interval (uint16_t interval)
 
void setup () override
 
void update ()
 
void dump_config () override
 
float get_setup_priority () const override
 
- 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 ()
 
virtual bool can_proceed ()
 
bool status_has_warning ()
 
bool status_has_error ()
 
void status_set_warning ()
 
void status_set_error ()
 
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
 
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 Types

enum  ErrorCode { COMMUNICATION_FAILED, FIRMWARE_IDENTIFICATION_FAILED, MEASUREMENT_INIT_FAILED, UNKNOWN }
 

Protected Member Functions

bool is_data_ready_ ()
 
- Protected Member Functions inherited from esphome::Component
virtual void call_loop ()
 
virtual void call_setup ()
 
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()> &&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()> &&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

enum esphome::scd30::SCD30Component::ErrorCode UNKNOWN
 
bool enable_asc_ {true}
 
uint16_t altitude_compensation_ {0xFFFF}
 
uint16_t ambient_pressure_compensation_ {0x0000}
 
float temperature_offset_ {0.0}
 
uint16_t update_interval_ {0xFFFF}
 
sensor::Sensorco2_sensor_ {nullptr}
 
sensor::Sensorhumidity_sensor_ {nullptr}
 
sensor::Sensortemperature_sensor_ {nullptr}
 
- 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}
 
I2CBusbus_ {nullptr}
 

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 scd30 i2c GAS (VOC and CO2eq) sensors.

Definition at line 11 of file scd30.h.

Member Enumeration Documentation

◆ ErrorCode

Enumerator
COMMUNICATION_FAILED 
FIRMWARE_IDENTIFICATION_FAILED 
MEASUREMENT_INIT_FAILED 
UNKNOWN 

Definition at line 32 of file scd30.h.

Member Function Documentation

◆ dump_config()

void esphome::scd30::SCD30Component::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 114 of file scd30.cpp.

◆ get_setup_priority()

float esphome::scd30::SCD30Component::get_setup_priority ( ) const
inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 27 of file scd30.h.

◆ is_data_ready_()

bool esphome::scd30::SCD30Component::is_data_ready_ ( )
protected

Definition at line 193 of file scd30.cpp.

◆ set_altitude_compensation()

void esphome::scd30::SCD30Component::set_altitude_compensation ( uint16_t  altitude)
inline

Definition at line 17 of file scd30.h.

◆ set_ambient_pressure_compensation()

void esphome::scd30::SCD30Component::set_ambient_pressure_compensation ( float  pressure)
inline

Definition at line 18 of file scd30.h.

◆ set_automatic_self_calibration()

void esphome::scd30::SCD30Component::set_automatic_self_calibration ( bool  asc)
inline

Definition at line 16 of file scd30.h.

◆ set_co2_sensor()

void esphome::scd30::SCD30Component::set_co2_sensor ( sensor::Sensor co2)
inline

Definition at line 13 of file scd30.h.

◆ set_humidity_sensor()

void esphome::scd30::SCD30Component::set_humidity_sensor ( sensor::Sensor humidity)
inline

Definition at line 14 of file scd30.h.

◆ set_temperature_offset()

void esphome::scd30::SCD30Component::set_temperature_offset ( float  offset)
inline

Definition at line 21 of file scd30.h.

◆ set_temperature_sensor()

void esphome::scd30::SCD30Component::set_temperature_sensor ( sensor::Sensor temperature)
inline

Definition at line 15 of file scd30.h.

◆ set_update_interval()

void esphome::scd30::SCD30Component::set_update_interval ( uint16_t  interval)
inline

Definition at line 22 of file scd30.h.

◆ setup()

void esphome::scd30::SCD30Component::setup ( )
overridevirtual

Firmware version identification

Sensor initialization

Reimplemented from esphome::Component.

Definition at line 28 of file scd30.cpp.

◆ update()

void esphome::scd30::SCD30Component::update ( )

Definition at line 147 of file scd30.cpp.

Field Documentation

◆ altitude_compensation_

uint16_t esphome::scd30::SCD30Component::altitude_compensation_ {0xFFFF}
protected

Definition at line 39 of file scd30.h.

◆ ambient_pressure_compensation_

uint16_t esphome::scd30::SCD30Component::ambient_pressure_compensation_ {0x0000}
protected

Definition at line 40 of file scd30.h.

◆ co2_sensor_

sensor::Sensor* esphome::scd30::SCD30Component::co2_sensor_ {nullptr}
protected

Definition at line 44 of file scd30.h.

◆ enable_asc_

bool esphome::scd30::SCD30Component::enable_asc_ {true}
protected

Definition at line 38 of file scd30.h.

◆ humidity_sensor_

sensor::Sensor* esphome::scd30::SCD30Component::humidity_sensor_ {nullptr}
protected

Definition at line 45 of file scd30.h.

◆ temperature_offset_

float esphome::scd30::SCD30Component::temperature_offset_ {0.0}
protected

Definition at line 41 of file scd30.h.

◆ temperature_sensor_

sensor::Sensor* esphome::scd30::SCD30Component::temperature_sensor_ {nullptr}
protected

Definition at line 46 of file scd30.h.

◆ UNKNOWN

enum esphome::scd30::SCD30Component::ErrorCode esphome::scd30::SCD30Component::UNKNOWN
protected

◆ update_interval_

uint16_t esphome::scd30::SCD30Component::update_interval_ {0xFFFF}
protected

Definition at line 42 of file scd30.h.


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