ESPHome 2026.11.0-dev
Loading...
Searching...
No Matches
esphome::stcc4::STCC4Component Class Referencefinal

#include <stcc4.h>

Inheritance diagram for esphome::stcc4::STCC4Component:
esphome::PollingComponent esphome::sensirion_common::SensirionI2CDevice esphome::Component esphome::i2c::I2CDevice

Protected Member Functions

void poll_until_ready_for_setup_or_timeout_ (uint32_t start_time)
 
void finish_setup_ ()
 
void schedule_continuous_update_ (bool retry_for_clock_drift)
 
bool read_measurement_ (uint8_t sensirion_options)
 
void update_rht_compensation_from_source_ ()
 
void update_ambient_pressure_compensation_from_source_ ()
 
bool write_rht_compensation_ (uint16_t temperature_in_ticks, uint16_t humidity_in_ticks)
 
bool write_ambient_pressure_compensation_ (uint16_t pressure_in_pa_2)
 
- Protected Member Functions inherited from esphome::Component
friend void::setup ()
 
friend void::original_setup ()
 
void set_component_source_ (uint8_t index)
 Set where this component was loaded from for some debug messages.
 
void call_dump_config_ ()
 
void enable_loop_slow_path_ ()
 
void set_component_state_ (uint8_t state)
 Helper to set component state (clears state bits and sets new state)
 
bool set_status_flag_ (uint8_t flag)
 Helper to set a status LED flag on both this component and the app.
 
bool set_error_flag_ (const LogString *message)
 Set the error flag and log it; true when it was not set before.
 
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 id, uint32_t interval, std::function< void()> &&f)
 Set an interval function with a numeric ID (zero heap allocation).
 
void set_interval (InternalSchedulerID id, uint32_t interval, std::function< void()> &&f)
 
void set_interval (uint32_t interval, std::function< void()> &&f)
 
bool cancel_interval (const char *name)
 Cancel an interval function.
 
bool cancel_interval (uint32_t id)
 
bool cancel_interval (InternalSchedulerID id)
 
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 id, uint32_t timeout, std::function< void()> &&f)
 Set a timeout function with a numeric ID (zero heap allocation).
 
void set_timeout (InternalSchedulerID id, uint32_t timeout, std::function< void()> &&f)
 
void set_timeout (uint32_t timeout, std::function< void()> &&f)
 
bool cancel_timeout (const char *name)
 Cancel a timeout function.
 
bool cancel_timeout (uint32_t id)
 
bool cancel_timeout (InternalSchedulerID id)
 
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.
 
void defer (uint32_t id, std::function< void()> &&f)
 Defer a callback with a numeric ID (zero heap allocation)
 
bool cancel_defer (const char *name)
 Cancel a defer callback using the specified name, name must not be empty.
 
bool cancel_defer (uint32_t id)
 
void status_clear_warning_slow_path_ ()
 
void status_clear_error_slow_path_ ()
 
- 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.
 
bool get_register_ (uint16_t reg, CommandLen command_len, uint16_t *data, uint8_t len, uint8_t delay, uint8_t sensirion_options=0)
 get data words from I2C register.
 

Protected Attributes

sensor::Sensor * temperature_source_ {nullptr}
 
sensor::Sensor * humidity_source_ {nullptr}
 
sensor::Sensor * ambient_pressure_source_ {nullptr}
 
MeasurementMode measurement_mode_ {MeasurementMode::CONTINUOUS}
 
uint16_t temperature_in_ticks_ {0}
 
uint16_t humidity_in_ticks_ {0}
 
uint16_t ambient_pressure_in_pa_2_ {0}
 
bool ambient_pressure_unit_warning_logged_ {false}
 
bool ready_ {false}
 
- Protected Attributes inherited from esphome::PollingComponent
uint32_t update_interval_
 
- Protected Attributes inherited from esphome::Component
uint8_t component_source_index_ {0}
 Index into component source PROGMEM lookup table (0 = not set)
 
uint8_t warn_if_blocking_over_ {WARN_IF_BLOCKING_OVER_CS}
 Warn threshold in centiseconds (max 2550ms)
 
uint8_t component_state_ {0x00}
 State of this component - each bit has a purpose: Bits 0-2: Component state (0x00=CONSTRUCTION, 0x01=SETUP, 0x02=LOOP, 0x03=FAILED, 0x04=LOOP_DONE) Bit 3: STATUS_LED_WARNING Bit 4: STATUS_LED_ERROR Bit 5: Has overridden loop() (set at registration time) Bits 6-7: Unused - reserved for future expansion.
 
volatile bool pending_enable_loop_ {false}
 ISR-safe flag for enable_loop_soon_any_context.
 
ComponentRuntimeStats runtime_stats_
 
- Protected Attributes inherited from esphome::sensirion_common::SensirionI2CDevice
i2c::ErrorCode last_error_
 last error code from I2C operation
 
- Protected Attributes inherited from esphome::i2c::I2CDevice
uint8_t address_ {0x00}
 store the address of the device on the bus
 
I2CBus * bus_ {nullptr}
 pointer to I2CBus instance
 

Additional Inherited Members

- Public Types inherited from esphome::sensirion_common::SensirionI2CDevice
enum  CommandLen : uint8_t { ADDR_8_BIT = 1 , ADDR_16_BIT = 2 }
 
- Public Member Functions inherited from esphome::PollingComponent
 PollingComponent ()
 
 PollingComponent (uint32_t update_interval)
 Initialize this polling component with the given update interval in ms.
 
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 ()
 
- Public Member Functions inherited from esphome::Component
virtual void setup ()
 Where the component's initialization should happen.
 
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)
 
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.
 
bool is_idle () const
 Check if this component is idle.
 
void mark_failed ()
 Mark this component as failed.
 
void mark_failed (const LogString *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 ()
 
void status_set_warning (const char *message)
 
void status_set_warning (const LogString *message)
 
void status_set_error ()
 
void status_set_error (const LogString *message)
 
void status_clear_warning ()
 
void status_clear_error ()
 
 ESPDEPRECATED ("Use status_momentary_warning() without a name. Removed in 2027.5.0", "2026.11.0") void status_momentary_warning(const char *name
 
void status_momentary_warning (uint32_t length=5000)
 Set warning status flag and clear it after length ms.
 
void status_momentary_warning (const LogString *message, uint32_t length=5000)
 
 ESPDEPRECATED ("Use status_momentary_error() without a name. Removed in 2027.5.0", "2026.11.0") void status_momentary_error(const char *name
 
void status_momentary_error (uint32_t length=5000)
 Set error status flag and clear it after length ms.
 
void status_momentary_error (const LogString *message, uint32_t length=5000)
 
bool has_overridden_loop () const
 
const LogString * get_component_log_str () const ESPHOME_ALWAYS_INLINE
 Get the integration where this component was declared as a LogString for logging.
 
bool should_warn_of_blocking (uint32_t blocking_time, uint32_t &threshold_ms_out)
 
- Public Member Functions inherited from esphome::sensirion_common::SensirionI2CDevice
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.
 
- Public Member Functions inherited from esphome::i2c::I2CDevice
 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
 
- Static Public Member Functions inherited from esphome::sensirion_common::SensirionI2CDevice
static const char * sensirion_convert_to_string_in_place (uint16_t *array, size_t length)
 This function performs an in-place conversion of the provided buffer from uint16_t values to big endianness.
 
- Data Fields inherited from esphome::Component
uint32_t length = 5000)
 

Detailed Description

Definition at line 14 of file stcc4.h.

Member Function Documentation

◆ finish_setup_()

void esphome::stcc4::STCC4Component::finish_setup_ ( )
protected

Definition at line 130 of file stcc4.cpp.

◆ poll_until_ready_for_setup_or_timeout_()

void esphome::stcc4::STCC4Component::poll_until_ready_for_setup_or_timeout_ ( uint32_t start_time)
protected

Definition at line 67 of file stcc4.cpp.

◆ read_measurement_()

bool esphome::stcc4::STCC4Component::read_measurement_ ( uint8_t sensirion_options)
protected

Definition at line 208 of file stcc4.cpp.

◆ schedule_continuous_update_()

void esphome::stcc4::STCC4Component::schedule_continuous_update_ ( bool retry_for_clock_drift)
protected

Definition at line 191 of file stcc4.cpp.

◆ update_ambient_pressure_compensation_from_source_()

void esphome::stcc4::STCC4Component::update_ambient_pressure_compensation_from_source_ ( )
protected

Definition at line 250 of file stcc4.cpp.

◆ update_rht_compensation_from_source_()

void esphome::stcc4::STCC4Component::update_rht_compensation_from_source_ ( )
protected

Definition at line 231 of file stcc4.cpp.

◆ write_ambient_pressure_compensation_()

bool esphome::stcc4::STCC4Component::write_ambient_pressure_compensation_ ( uint16_t pressure_in_pa_2)
protected

Definition at line 285 of file stcc4.cpp.

◆ write_rht_compensation_()

bool esphome::stcc4::STCC4Component::write_rht_compensation_ ( uint16_t temperature_in_ticks,
uint16_t humidity_in_ticks )
protected

Definition at line 274 of file stcc4.cpp.

Field Documentation

◆ ambient_pressure_in_pa_2_

uint16_t esphome::stcc4::STCC4Component::ambient_pressure_in_pa_2_ {0}
protected

Definition at line 48 of file stcc4.h.

◆ ambient_pressure_source_

sensor::Sensor* esphome::stcc4::STCC4Component::ambient_pressure_source_ {nullptr}
protected

Definition at line 42 of file stcc4.h.

◆ ambient_pressure_unit_warning_logged_

bool esphome::stcc4::STCC4Component::ambient_pressure_unit_warning_logged_ {false}
protected

Definition at line 49 of file stcc4.h.

◆ humidity_in_ticks_

uint16_t esphome::stcc4::STCC4Component::humidity_in_ticks_ {0}
protected

Definition at line 47 of file stcc4.h.

◆ humidity_source_

sensor::Sensor* esphome::stcc4::STCC4Component::humidity_source_ {nullptr}
protected

Definition at line 41 of file stcc4.h.

◆ measurement_mode_

MeasurementMode esphome::stcc4::STCC4Component::measurement_mode_ {MeasurementMode::CONTINUOUS}
protected

Definition at line 44 of file stcc4.h.

◆ ready_

bool esphome::stcc4::STCC4Component::ready_ {false}
protected

Definition at line 50 of file stcc4.h.

◆ temperature_in_ticks_

uint16_t esphome::stcc4::STCC4Component::temperature_in_ticks_ {0}
protected

Definition at line 46 of file stcc4.h.

◆ temperature_source_

sensor::Sensor* esphome::stcc4::STCC4Component::temperature_source_ {nullptr}
protected

Definition at line 40 of file stcc4.h.


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