|
| void | set_humidity_sensor (sensor::Sensor *humidity) |
| |
| void | set_temperature_sensor (sensor::Sensor *temperature) |
| |
| void | setup () override |
| |
| void | update () override |
| |
| void | take_sample () |
| |
| void | dump_config () override |
| |
| void | set_store_baseline (bool store_baseline) |
| |
| void | set_voc_sensor (sensor::Sensor *voc_sensor) |
| |
| void | set_nox_sensor (sensor::Sensor *nox_sensor) |
| |
| 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) |
| |
| | PollingComponent () |
| |
| | PollingComponent (uint32_t update_interval) |
| | Initialize this polling component with the given update interval in ms.
|
| |
| virtual void | set_update_interval (uint32_t update_interval) |
| | Manually set the update interval in ms for this polling object.
|
| |
| void | call_setup () override |
| |
| virtual uint32_t | get_update_interval () const |
| | Get the update interval in ms of this sensor.
|
| |
| void | start_poller () |
| |
| void | stop_poller () |
| |
| virtual void | loop () |
| | This method will be called repeatedly.
|
| |
| virtual float | get_setup_priority () const |
| | priority of setup().
|
| |
| float | get_actual_setup_priority () const |
| |
| void | set_setup_priority (float priority) |
| |
| virtual float | get_loop_priority () const |
| | priority of loop().
|
| |
| void | call () |
| |
| virtual void | on_shutdown () |
| |
| virtual void | on_safe_shutdown () |
| |
| virtual bool | teardown () |
| | Called during teardown to allow component to gracefully finish operations.
|
| |
| virtual void | on_powerdown () |
| | Called after teardown is complete to power down hardware.
|
| |
| uint8_t | get_component_state () const |
| |
| void | reset_to_construction_state () |
| | Reset this component back to the construction state to allow setup to run again.
|
| |
| bool | is_in_loop_state () const |
| | Check if this component has completed setup and is in the loop state.
|
| |
| virtual void | mark_failed () |
| | Mark this component as failed.
|
| |
| void | mark_failed (const char *message) |
| |
| void | disable_loop () |
| | Disable this component's loop.
|
| |
| void | enable_loop () |
| | Enable this component's loop.
|
| |
| void | enable_loop_soon_any_context () |
| | Thread and ISR-safe version of enable_loop() that can be called from any context.
|
| |
| 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=nullptr) |
| |
| void | status_set_warning (const LogString *message) |
| |
| void | status_set_error (const char *message=nullptr) |
| |
| 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 LogString *source) |
| | Set where this component was loaded from for some debug messages.
|
| |
| const LogString * | get_component_log_str () const |
| | Get the integration where this component was declared as a LogString for logging.
|
| |
| bool | should_warn_of_blocking (uint32_t blocking_time) |
| |
| | Sensor () |
| |
| int8_t | get_accuracy_decimals () |
| | Get the accuracy in decimals, using the manual override if set.
|
| |
| void | set_accuracy_decimals (int8_t accuracy_decimals) |
| | Manually set the accuracy in decimals.
|
| |
| StateClass | get_state_class () |
| | Get the state class, using the manual override if set.
|
| |
| void | set_state_class (StateClass state_class) |
| | Manually set the state class.
|
| |
| bool | get_force_update () const |
| | Get whether force update mode is enabled.
|
| |
| void | set_force_update (bool force_update) |
| | Set force update mode.
|
| |
| void | add_filter (Filter *filter) |
| | Add a filter to the filter chain. Will be appended to the back.
|
| |
| void | add_filters (const std::vector< Filter * > &filters) |
| | Add a list of vectors to the back of the filter chain.
|
| |
| void | set_filters (const std::vector< Filter * > &filters) |
| | Clear the filters and replace them by filters.
|
| |
| void | clear_filters () |
| | Clear the entire filter chain.
|
| |
| float | get_state () const |
| | Getter-syntax for .state.
|
| |
| float | get_raw_state () const |
| | Getter-syntax for .raw_state.
|
| |
| void | publish_state (float state) |
| | Publish a new state to the front-end.
|
| |
| void | add_on_state_callback (std::function< void(float)> &&callback) |
| | Add a callback that will be called every time a filtered value arrives.
|
| |
| void | add_on_raw_state_callback (std::function< void(float)> &&callback) |
| | Add a callback that will be called every time the sensor sends a raw value.
|
| |
| void | internal_send_state_to_frontend (float state) |
| |
| const StringRef & | get_name () const |
| |
| void | set_name (const char *name) |
| |
| bool | has_own_name () const |
| |
| std::string | get_object_id () const |
| |
| void | set_object_id (const char *object_id) |
| |
| uint32_t | get_object_id_hash () |
| |
| bool | is_internal () const |
| |
| void | set_internal (bool internal) |
| |
| bool | is_disabled_by_default () const |
| |
| void | set_disabled_by_default (bool disabled_by_default) |
| |
| EntityCategory | get_entity_category () const |
| |
| void | set_entity_category (EntityCategory entity_category) |
| |
| std::string | get_icon () const |
| |
| void | set_icon (const char *icon) |
| |
| StringRef | get_icon_ref () const |
| |
| uint32_t | get_device_id () const |
| |
| void | set_device (Device *device) |
| |
| bool | has_state () const |
| |
| void | set_has_state (bool state) |
| |
| uint32_t | get_preference_hash () |
| | Get a unique hash for storing preferences/settings for this entity.
|
| |
| std::string | get_device_class () |
| | Get the device class, using the manual override if set.
|
| |
| void | set_device_class (const char *device_class) |
| | Manually set the device class.
|
| |
| StringRef | get_device_class_ref () const |
| | Get the device class as StringRef.
|
| |
| std::string | get_unit_of_measurement () |
| | Get the unit of measurement, using the manual override if set.
|
| |
| void | set_unit_of_measurement (const char *unit_of_measurement) |
| | Manually set the unit of measurement.
|
| |
| StringRef | get_unit_of_measurement_ref () const |
| | Get the unit of measurement as StringRef.
|
| |
| bool | read_data (uint16_t *data, uint8_t len) |
| | Read data words from I2C device.
|
| |
| bool | read_data (uint16_t &data) |
| | Read 1 data word from I2C device.
|
| |
| bool | get_register (uint16_t command, uint16_t *data, uint8_t len, uint8_t delay=0) |
| | get data words from I2C register.
|
| |
| bool | get_register (uint16_t i2c_register, uint16_t &data, uint8_t delay=0) |
| | Read 1 data word from 16 bit I2C register.
|
| |
| bool | get_8bit_register (uint8_t i2c_register, uint16_t *data, uint8_t len, uint8_t delay=0) |
| | get data words from I2C register.
|
| |
| bool | get_8bit_register (uint8_t i2c_register, uint16_t &data, uint8_t delay=0) |
| | Read 1 data word from 8 bit I2C register.
|
| |
| template<class T > |
| bool | write_command (T i2c_register) |
| | Write a command to the I2C device.
|
| |
| template<class T > |
| bool | write_command (T i2c_register, uint16_t data) |
| | Write a command and one data word to the I2C device .
|
| |
| template<class T > |
| bool | write_command (T i2c_register, const std::vector< uint16_t > &data) |
| | Write a command with arguments as words.
|
| |
| template<class T > |
| bool | write_command (T i2c_register, const uint16_t *data, uint8_t len) |
| | Write a command with arguments as words.
|
| |
| | I2CDevice ()=default |
| | we use the C++ default constructor
|
| |
| void | set_i2c_address (uint8_t address) |
| | We store the address of the device on the bus.
|
| |
| uint8_t | get_i2c_address () const |
| | Returns the I2C address of the object.
|
| |
| void | set_i2c_bus (I2CBus *bus) |
| | we store the pointer to the I2CBus to use
|
| |
| I2CRegister | reg (uint8_t a_register) |
| | calls the I2CRegister constructor
|
| |
| I2CRegister16 | reg16 (uint16_t a_register) |
| | calls the I2CRegister16 constructor
|
| |
| ErrorCode | read (uint8_t *data, size_t len) const |
| | reads an array of bytes from the device using an I2CBus
|
| |
| ErrorCode | read_register (uint8_t a_register, uint8_t *data, size_t len) |
| | reads an array of bytes from a specific register in the I²C device
|
| |
| ErrorCode | read_register16 (uint16_t a_register, uint8_t *data, size_t len) |
| | reads an array of bytes from a specific register in the I²C device
|
| |
| ErrorCode | write (const uint8_t *data, size_t len) const |
| | writes an array of bytes to a device using an I2CBus
|
| |
| ErrorCode | write_read (const uint8_t *write_data, size_t write_len, uint8_t *read_data, size_t read_len) const |
| | writes an array of bytes to a device, then reads an array, as a single transaction
|
| |
| ErrorCode | write_register (uint8_t a_register, const uint8_t *data, size_t len) const |
| | writes an array of bytes to a specific register in the I²C device
|
| |
| ErrorCode | write_register16 (uint16_t a_register, const uint8_t *data, size_t len) const |
| | write an array of bytes to a specific register in the I²C device
|
| |
| bool | read_bytes (uint8_t a_register, uint8_t *data, uint8_t len) |
| | Compat APIs All methods below have been added for compatibility reasons.
|
| |
| bool | read_bytes_raw (uint8_t *data, uint8_t len) const |
| |
| 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) const |
| |
| bool | write_bytes (uint8_t a_register, const std::vector< uint8_t > &data) const |
| |
| 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) const |
| |
| bool | write_byte (uint8_t a_register, uint8_t data) const |
| |
| bool | write_byte_16 (uint8_t a_register, uint16_t data) const |
| |
| | ESPDEPRECATED ("The stop argument is no longer used. This will be removed from ESPHome 2026.3.0", "2025.9.0") ErrorCode read_register(uint8_t a_register |
| |
| | ESPDEPRECATED ("The stop argument is no longer used. This will be removed from ESPHome 2026.3.0", "2025.9.0") ErrorCode read_register16(uint16_t a_register |
| |
| | ESPDEPRECATED ("The stop argument is no longer used; use write_read() for consecutive write and read. This will be " "removed from ESPHome 2026.3.0", "2025.9.0") ErrorCode write(const uint8_t *data |
| |
| | ESPDEPRECATED ("The stop argument is no longer used; use write_read() for consecutive write and read. This will be " "removed from ESPHome 2026.3.0", "2025.9.0") ErrorCode write_register(uint8_t a_register |
| |
| | ESPDEPRECATED ("The stop argument is no longer used; use write_read() for consecutive write and read. This will be " "removed from ESPHome 2026.3.0", "2025.9.0") ErrorCode write_register16(uint16_t a_register |
| |
|
| void | self_test_ () |
| |
| int16_t | sensirion_init_sensors_ () |
| |
| void | update_gas_indices_ () |
| |
| void | measure_raw_ () |
| |
| virtual void | call_loop () |
| |
| virtual void | call_dump_config () |
| |
| void | set_component_state_ (uint8_t state) |
| | Helper to set component state (clears state bits and sets new state)
|
| |
| void | set_interval (const std::string &name, uint32_t interval, std::function< void()> &&f) |
| | Set an interval function with a unique name.
|
| |
| void | set_interval (const char *name, uint32_t interval, std::function< void()> &&f) |
| | Set an interval function with a const char* name.
|
| |
| void | set_interval (uint32_t interval, std::function< void()> &&f) |
| |
| bool | cancel_interval (const std::string &name) |
| | Cancel an interval function.
|
| |
| bool | cancel_interval (const char *name) |
| |
| 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.
|
| |
| 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.
|
| |
| void | set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f) |
| | Set a timeout function with a unique name.
|
| |
| void | set_timeout (const char *name, uint32_t timeout, std::function< void()> &&f) |
| | Set a timeout function with a const char* name.
|
| |
| void | set_timeout (uint32_t timeout, std::function< void()> &&f) |
| |
| bool | cancel_timeout (const std::string &name) |
| | Cancel a timeout function.
|
| |
| bool | cancel_timeout (const char *name) |
| |
| void | defer (const std::string &name, std::function< void()> &&f) |
| | Defer a callback to the next loop() call.
|
| |
| void | defer (const char *name, std::function< void()> &&f) |
| | Defer a callback to the next loop() call with a const char* name.
|
| |
| void | defer (std::function< void()> &&f) |
| | Defer a callback to the next loop() call.
|
| |
| bool | cancel_defer (const std::string &name) |
| | Cancel a defer callback using the specified name, name must not be empty.
|
| |
| StringRef | get_object_id_ref_for_api_ () const |
| |
| virtual uint32_t | hash_base () |
| | The hash_base() function has been deprecated.
|
| |
| void | calc_object_id_ () |
| |
| bool | is_object_id_dynamic_ () const |
| | Check if the object_id is dynamic (changes with MAC suffix)
|
| |
| bool | write_command_ (uint16_t command, CommandLen command_len, const uint16_t *data, uint8_t data_len) |
| | Write a command with arguments as words.
|
| |
| bool | get_register_ (uint16_t reg, CommandLen command_len, uint16_t *data, uint8_t len, uint8_t delay) |
| | get data words from I2C register.
|
| |
Public Member Functions inherited from esphome::PollingComponent
1.12.0