ESPHome  2022.11.5
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes
esphome::sen5x::SEN5XComponent Class Reference

#include <sen5x.h>

Inheritance diagram for esphome::sen5x::SEN5XComponent:
esphome::PollingComponent esphome::sensirion_common::SensirionI2CDevice esphome::Component esphome::i2c::I2CDevice

Public Types

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

Public Member Functions

float get_setup_priority () const override
 
void setup () override
 
void dump_config () override
 
void update () override
 
void set_pm_1_0_sensor (sensor::Sensor *pm_1_0)
 
void set_pm_2_5_sensor (sensor::Sensor *pm_2_5)
 
void set_pm_4_0_sensor (sensor::Sensor *pm_4_0)
 
void set_pm_10_0_sensor (sensor::Sensor *pm_10_0)
 
void set_voc_sensor (sensor::Sensor *voc_sensor)
 
void set_nox_sensor (sensor::Sensor *nox_sensor)
 
void set_humidity_sensor (sensor::Sensor *humidity_sensor)
 
void set_temperature_sensor (sensor::Sensor *temperature_sensor)
 
void set_store_baseline (bool store_baseline)
 
void set_acceleration_mode (RhtAccelerationMode mode)
 
void set_auto_cleaning_interval (uint32_t auto_cleaning_interval)
 
void set_voc_algorithm_tuning (uint16_t index_offset, uint16_t learning_time_offset_hours, uint16_t learning_time_gain_hours, uint16_t gating_max_duration_minutes, uint16_t std_initial, uint16_t gain_factor)
 
void set_nox_algorithm_tuning (uint16_t index_offset, uint16_t learning_time_offset_hours, uint16_t learning_time_gain_hours, uint16_t gating_max_duration_minutes, uint16_t gain_factor)
 
void set_temperature_compensation (float offset, float normalized_offset_slope, uint16_t time_constant)
 
bool start_fan_cleaning ()
 
- 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::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 Member Functions

bool write_tuning_parameters_ (uint16_t i2c_command, const GasTuning &tuning)
 
bool write_temperature_compensation_ (const TemperatureCompensation &compensation)
 
- 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 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

ERRORCODE error_code_
 
bool initialized_ {false}
 
sensor::Sensorpm_1_0_sensor_ {nullptr}
 
sensor::Sensorpm_2_5_sensor_ {nullptr}
 
sensor::Sensorpm_4_0_sensor_ {nullptr}
 
sensor::Sensorpm_10_0_sensor_ {nullptr}
 
sensor::Sensortemperature_sensor_ {nullptr}
 
sensor::Sensorhumidity_sensor_ {nullptr}
 
sensor::Sensorvoc_sensor_ {nullptr}
 
sensor::Sensornox_sensor_ {nullptr}
 
std::string product_name_
 
uint8_t serial_number_ [4]
 
uint16_t firmware_version_
 
Sen5xBaselines voc_baselines_storage_
 
bool store_baseline_
 
uint32_t seconds_since_last_store_
 
ESPPreferenceObject pref_
 
optional< RhtAccelerationModeacceleration_mode_
 
optional< uint32_t > auto_cleaning_interval_
 
optional< GasTuningvoc_tuning_params_
 
optional< GasTuningnox_tuning_params_
 
optional< TemperatureCompensationtemperature_compensation_
 
- 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}
 
I2CBusbus_ {nullptr}
 

Detailed Description

Definition at line 49 of file sen5x.h.

Member Enumeration Documentation

◆ Sen5xType

Enumerator
SEN50 
SEN54 
SEN55 
UNKNOWN 

Definition at line 56 of file sen5x.h.

Member Function Documentation

◆ dump_config()

void esphome::sen5x::SEN5XComponent::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 226 of file sen5x.cpp.

◆ get_setup_priority()

float esphome::sen5x::SEN5XComponent::get_setup_priority ( ) const
inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 51 of file sen5x.h.

◆ set_acceleration_mode()

void esphome::sen5x::SEN5XComponent::set_acceleration_mode ( RhtAccelerationMode  mode)
inline

Definition at line 68 of file sen5x.h.

◆ set_auto_cleaning_interval()

void esphome::sen5x::SEN5XComponent::set_auto_cleaning_interval ( uint32_t  auto_cleaning_interval)
inline

Definition at line 69 of file sen5x.h.

◆ set_humidity_sensor()

void esphome::sen5x::SEN5XComponent::set_humidity_sensor ( sensor::Sensor humidity_sensor)
inline

Definition at line 65 of file sen5x.h.

◆ set_nox_algorithm_tuning()

void esphome::sen5x::SEN5XComponent::set_nox_algorithm_tuning ( uint16_t  index_offset,
uint16_t  learning_time_offset_hours,
uint16_t  learning_time_gain_hours,
uint16_t  gating_max_duration_minutes,
uint16_t  gain_factor 
)
inline

Definition at line 80 of file sen5x.h.

◆ set_nox_sensor()

void esphome::sen5x::SEN5XComponent::set_nox_sensor ( sensor::Sensor nox_sensor)
inline

Definition at line 64 of file sen5x.h.

◆ set_pm_10_0_sensor()

void esphome::sen5x::SEN5XComponent::set_pm_10_0_sensor ( sensor::Sensor pm_10_0)
inline

Definition at line 61 of file sen5x.h.

◆ set_pm_1_0_sensor()

void esphome::sen5x::SEN5XComponent::set_pm_1_0_sensor ( sensor::Sensor pm_1_0)
inline

Definition at line 58 of file sen5x.h.

◆ set_pm_2_5_sensor()

void esphome::sen5x::SEN5XComponent::set_pm_2_5_sensor ( sensor::Sensor pm_2_5)
inline

Definition at line 59 of file sen5x.h.

◆ set_pm_4_0_sensor()

void esphome::sen5x::SEN5XComponent::set_pm_4_0_sensor ( sensor::Sensor pm_4_0)
inline

Definition at line 60 of file sen5x.h.

◆ set_store_baseline()

void esphome::sen5x::SEN5XComponent::set_store_baseline ( bool  store_baseline)
inline

Definition at line 67 of file sen5x.h.

◆ set_temperature_compensation()

void esphome::sen5x::SEN5XComponent::set_temperature_compensation ( float  offset,
float  normalized_offset_slope,
uint16_t  time_constant 
)
inline

Definition at line 90 of file sen5x.h.

◆ set_temperature_sensor()

void esphome::sen5x::SEN5XComponent::set_temperature_sensor ( sensor::Sensor temperature_sensor)
inline

Definition at line 66 of file sen5x.h.

◆ set_voc_algorithm_tuning()

void esphome::sen5x::SEN5XComponent::set_voc_algorithm_tuning ( uint16_t  index_offset,
uint16_t  learning_time_offset_hours,
uint16_t  learning_time_gain_hours,
uint16_t  gating_max_duration_minutes,
uint16_t  std_initial,
uint16_t  gain_factor 
)
inline

Definition at line 70 of file sen5x.h.

◆ set_voc_sensor()

void esphome::sen5x::SEN5XComponent::set_voc_sensor ( sensor::Sensor voc_sensor)
inline

Definition at line 63 of file sen5x.h.

◆ setup()

void esphome::sen5x::SEN5XComponent::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 26 of file sen5x.cpp.

◆ start_fan_cleaning()

bool esphome::sen5x::SEN5XComponent::start_fan_cleaning ( )

Definition at line 401 of file sen5x.cpp.

◆ update()

void esphome::sen5x::SEN5XComponent::update ( )
overridevirtual

Implements esphome::PollingComponent.

Definition at line 281 of file sen5x.cpp.

◆ write_temperature_compensation_()

bool esphome::sen5x::SEN5XComponent::write_temperature_compensation_ ( const TemperatureCompensation compensation)
protected

Definition at line 389 of file sen5x.cpp.

◆ write_tuning_parameters_()

bool esphome::sen5x::SEN5XComponent::write_tuning_parameters_ ( uint16_t  i2c_command,
const GasTuning tuning 
)
protected

Definition at line 374 of file sen5x.cpp.

Field Documentation

◆ acceleration_mode_

optional<RhtAccelerationMode> esphome::sen5x::SEN5XComponent::acceleration_mode_
protected

Definition at line 120 of file sen5x.h.

◆ auto_cleaning_interval_

optional<uint32_t> esphome::sen5x::SEN5XComponent::auto_cleaning_interval_
protected

Definition at line 121 of file sen5x.h.

◆ error_code_

ERRORCODE esphome::sen5x::SEN5XComponent::error_code_
protected

Definition at line 100 of file sen5x.h.

◆ firmware_version_

uint16_t esphome::sen5x::SEN5XComponent::firmware_version_
protected

Definition at line 115 of file sen5x.h.

◆ humidity_sensor_

sensor::Sensor* esphome::sen5x::SEN5XComponent::humidity_sensor_ {nullptr}
protected

Definition at line 108 of file sen5x.h.

◆ initialized_

bool esphome::sen5x::SEN5XComponent::initialized_ {false}
protected

Definition at line 101 of file sen5x.h.

◆ nox_sensor_

sensor::Sensor* esphome::sen5x::SEN5XComponent::nox_sensor_ {nullptr}
protected

Definition at line 111 of file sen5x.h.

◆ nox_tuning_params_

optional<GasTuning> esphome::sen5x::SEN5XComponent::nox_tuning_params_
protected

Definition at line 123 of file sen5x.h.

◆ pm_10_0_sensor_

sensor::Sensor* esphome::sen5x::SEN5XComponent::pm_10_0_sensor_ {nullptr}
protected

Definition at line 105 of file sen5x.h.

◆ pm_1_0_sensor_

sensor::Sensor* esphome::sen5x::SEN5XComponent::pm_1_0_sensor_ {nullptr}
protected

Definition at line 102 of file sen5x.h.

◆ pm_2_5_sensor_

sensor::Sensor* esphome::sen5x::SEN5XComponent::pm_2_5_sensor_ {nullptr}
protected

Definition at line 103 of file sen5x.h.

◆ pm_4_0_sensor_

sensor::Sensor* esphome::sen5x::SEN5XComponent::pm_4_0_sensor_ {nullptr}
protected

Definition at line 104 of file sen5x.h.

◆ pref_

ESPPreferenceObject esphome::sen5x::SEN5XComponent::pref_
protected

Definition at line 119 of file sen5x.h.

◆ product_name_

std::string esphome::sen5x::SEN5XComponent::product_name_
protected

Definition at line 113 of file sen5x.h.

◆ seconds_since_last_store_

uint32_t esphome::sen5x::SEN5XComponent::seconds_since_last_store_
protected

Definition at line 118 of file sen5x.h.

◆ serial_number_

uint8_t esphome::sen5x::SEN5XComponent::serial_number_[4]
protected

Definition at line 114 of file sen5x.h.

◆ store_baseline_

bool esphome::sen5x::SEN5XComponent::store_baseline_
protected

Definition at line 117 of file sen5x.h.

◆ temperature_compensation_

optional<TemperatureCompensation> esphome::sen5x::SEN5XComponent::temperature_compensation_
protected

Definition at line 124 of file sen5x.h.

◆ temperature_sensor_

sensor::Sensor* esphome::sen5x::SEN5XComponent::temperature_sensor_ {nullptr}
protected

Definition at line 107 of file sen5x.h.

◆ voc_baselines_storage_

Sen5xBaselines esphome::sen5x::SEN5XComponent::voc_baselines_storage_
protected

Definition at line 116 of file sen5x.h.

◆ voc_sensor_

sensor::Sensor* esphome::sen5x::SEN5XComponent::voc_sensor_ {nullptr}
protected

Definition at line 109 of file sen5x.h.

◆ voc_tuning_params_

optional<GasTuning> esphome::sen5x::SEN5XComponent::voc_tuning_params_
protected

Definition at line 122 of file sen5x.h.


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