ESPHome  2022.1.1
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::scd4x::SCD4XComponent Class Reference

#include <scd4x.h>

Inheritance diagram for esphome::scd4x::SCD4XComponent:
esphome::PollingComponent esphome::i2c::I2CDevice esphome::Component

Public Member Functions

float get_setup_priority () const override
void setup () override
void dump_config () override
void update () override
void set_automatic_self_calibration (bool asc)
void set_altitude_compensation (uint16_t altitude)
void set_ambient_pressure_compensation (float pressure_in_bar)
void set_ambient_pressure_source (sensor::Sensor *pressure)
void set_temperature_offset (float offset)
void set_co2_sensor (sensor::Sensor *co2)
void set_temperature_sensor (sensor::Sensor *temperature)
void set_humidity_sensor (sensor::Sensor *humidity)
- 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...
- 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::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)
ErrorCode write (const uint8_t *data, uint8_t len)
ErrorCode write_register (uint8_t a_register, const uint8_t *data, size_t len)
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)
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 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 write_byte_16 (uint8_t a_register, uint16_t data)

Protected Member Functions

uint8_t sht_crc_ (uint8_t data1, uint8_t data2)
bool read_data_ (uint16_t *data, uint8_t len)
bool write_command_ (uint16_t command)
bool write_command_ (uint16_t command, uint16_t data)
bool update_ambient_pressure_compensation_ (uint16_t pressure_in_hpa)
- 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()> &&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 Attributes

ERRORCODE error_code_
bool initialized_ {false}
float temperature_offset_
uint16_t altitude_compensation_
bool ambient_pressure_compensation_
uint16_t ambient_pressure_
bool enable_asc_
sensor::Sensorco2_sensor_ {nullptr}
sensor::Sensortemperature_sensor_ {nullptr}
sensor::Sensorhumidity_sensor_ {nullptr}
sensor::Sensorambient_pressure_source_ {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::i2c::I2CDevice
uint8_t address_ {0x00}
I2CBusbus_ {nullptr}

Detailed Description

Definition at line 12 of file scd4x.h.

Member Function Documentation

◆ dump_config()

void esphome::scd4x::SCD4XComponent::dump_config ( )

Reimplemented from esphome::Component.

Definition at line 120 of file scd4x.cpp.

◆ get_setup_priority()

float esphome::scd4x::SCD4XComponent::get_setup_priority ( ) const

Reimplemented from esphome::Component.

Definition at line 14 of file scd4x.h.

◆ read_data_()

bool esphome::scd4x::SCD4XComponent::read_data_ ( uint16_t *  data,
uint8_t  len 

Definition at line 253 of file scd4x.cpp.

◆ set_altitude_compensation()

void esphome::scd4x::SCD4XComponent::set_altitude_compensation ( uint16_t  altitude)

Definition at line 20 of file scd4x.h.

◆ set_ambient_pressure_compensation()

void esphome::scd4x::SCD4XComponent::set_ambient_pressure_compensation ( float  pressure_in_bar)

Definition at line 208 of file scd4x.cpp.

◆ set_ambient_pressure_source()

void esphome::scd4x::SCD4XComponent::set_ambient_pressure_source ( sensor::Sensor pressure)

Definition at line 22 of file scd4x.h.

◆ set_automatic_self_calibration()

void esphome::scd4x::SCD4XComponent::set_automatic_self_calibration ( bool  asc)

Definition at line 19 of file scd4x.h.

◆ set_co2_sensor()

void esphome::scd4x::SCD4XComponent::set_co2_sensor ( sensor::Sensor co2)

Definition at line 25 of file scd4x.h.

◆ set_humidity_sensor()

void esphome::scd4x::SCD4XComponent::set_humidity_sensor ( sensor::Sensor humidity)

Definition at line 27 of file scd4x.h.

◆ set_temperature_offset()

void esphome::scd4x::SCD4XComponent::set_temperature_offset ( float  offset)

Definition at line 23 of file scd4x.h.

◆ set_temperature_sensor()

void esphome::scd4x::SCD4XComponent::set_temperature_sensor ( sensor::Sensor temperature)

Definition at line 26 of file scd4x.h.

◆ setup()

void esphome::scd4x::SCD4XComponent::setup ( )

Reimplemented from esphome::Component.

Definition at line 23 of file scd4x.cpp.

◆ sht_crc_()

uint8_t esphome::scd4x::SCD4XComponent::sht_crc_ ( uint8_t  data1,
uint8_t  data2 

Definition at line 230 of file scd4x.cpp.

◆ update()

void esphome::scd4x::SCD4XComponent::update ( )

Implements esphome::PollingComponent.

Definition at line 154 of file scd4x.cpp.

◆ update_ambient_pressure_compensation_()

bool esphome::scd4x::SCD4XComponent::update_ambient_pressure_compensation_ ( uint16_t  pressure_in_hpa)

Definition at line 220 of file scd4x.cpp.

◆ write_command_() [1/2]

bool esphome::scd4x::SCD4XComponent::write_command_ ( uint16_t  command)

Definition at line 273 of file scd4x.cpp.

◆ write_command_() [2/2]

bool esphome::scd4x::SCD4XComponent::write_command_ ( uint16_t  command,
uint16_t  data 

Definition at line 283 of file scd4x.cpp.

Field Documentation

◆ altitude_compensation_

uint16_t esphome::scd4x::SCD4XComponent::altitude_compensation_

Definition at line 41 of file scd4x.h.

◆ ambient_pressure_

uint16_t esphome::scd4x::SCD4XComponent::ambient_pressure_

Definition at line 43 of file scd4x.h.

◆ ambient_pressure_compensation_

bool esphome::scd4x::SCD4XComponent::ambient_pressure_compensation_

Definition at line 42 of file scd4x.h.

◆ ambient_pressure_source_

sensor::Sensor* esphome::scd4x::SCD4XComponent::ambient_pressure_source_ {nullptr}

Definition at line 50 of file scd4x.h.

◆ co2_sensor_

sensor::Sensor* esphome::scd4x::SCD4XComponent::co2_sensor_ {nullptr}

Definition at line 46 of file scd4x.h.

◆ enable_asc_

bool esphome::scd4x::SCD4XComponent::enable_asc_

Definition at line 44 of file scd4x.h.

◆ error_code_

ERRORCODE esphome::scd4x::SCD4XComponent::error_code_

Definition at line 36 of file scd4x.h.

◆ humidity_sensor_

sensor::Sensor* esphome::scd4x::SCD4XComponent::humidity_sensor_ {nullptr}

Definition at line 48 of file scd4x.h.

◆ initialized_

bool esphome::scd4x::SCD4XComponent::initialized_ {false}

Definition at line 38 of file scd4x.h.

◆ temperature_offset_

float esphome::scd4x::SCD4XComponent::temperature_offset_

Definition at line 40 of file scd4x.h.

◆ temperature_sensor_

sensor::Sensor* esphome::scd4x::SCD4XComponent::temperature_sensor_ {nullptr}

Definition at line 47 of file scd4x.h.

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