This class implements support for the Sensirion sgp4x i2c GAS (VOC) sensors. More...

#include <sgp4x.h>

Inheritance diagram for esphome::sgp4x::SGP4xComponent:

Public Member Functions
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)

Public Member Functions inherited from esphome::PollingComponent
	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 ()

Public Member Functions inherited from esphome::Component
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.

bool	is_idle () const
	Check if this component is idle.

void	mark_failed ()
	Mark this component as failed.

	ESPDEPRECATED ("Use mark_failed(LOG_STR(\"static string literal\")) instead. Do NOT use .c_str() from temporary " "strings. Will stop working in 2026.6.0", "2025.12.0") void mark_failed(const char *message)

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 (const char *message=nullptr)

void	status_set_warning (const LogString *message)

void	status_set_error ()

	ESPDEPRECATED ("Use status_set_error(LOG_STR(\"static string literal\")) instead. Do NOT use .c_str() from temporary " "strings. Will stop working in 2026.6.0", "2025.12.0") void status_set_error(const char *message)

void	status_set_error (const LogString *message)

void	status_clear_warning ()

void	status_clear_error ()

void	status_momentary_warning (const char *name, uint32_t length=5000)
	Set warning status flag and automatically clear it after a timeout.

void	status_momentary_error (const char *name, uint32_t length=5000)
	Set error status flag and automatically clear it after a timeout.

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)

Public Member Functions inherited from esphome::sensor::Sensor
	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.

bool	has_accuracy_decimals () const
	Check if the accuracy in decimals has been manually set.

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 (std::initializer_list< Filter * > filters)
	Add a list of vectors to the back of the filter chain.

void	set_filters (std::initializer_list< 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)

Public Member Functions inherited from esphome::EntityBase
const StringRef &	get_name () const

void	set_name (const char *name)

void	set_name (const char *name, uint32_t object_id_hash)
	Set name with pre-computed object_id hash (avoids runtime hash calculation) Use hash=0 for dynamic names that need runtime calculation.

bool	has_own_name () const

ESPDEPRECATED("object_id mangles names and all object_id methods are planned for removal " "(see https://github.com/esphome/backlog/issues/76). " "Now is the time to stop using object_id. If still needed, use get_object_id_to() " "which will remain available longer. get_object_id() will be removed in 2026.7.0", "2025.12.0") std uint32_t	get_object_id_hash ()

StringRef	get_object_id_to (std::span< char, OBJECT_ID_MAX_LEN > buf) const
	Get object_id with zero heap allocation For static case: returns StringRef to internal storage (buffer unused) For dynamic case: formats into buffer and returns StringRef to buffer.

size_t	write_object_id_to (char *buf, size_t buf_size) const
	Write object_id directly to buffer, returns length written (excluding null) Useful for building compound strings without intermediate buffer.

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)

ESPDEPRECATED("Use get_icon_ref() instead for better performance (avoids string copy). Will be removed in ESPHome 2026.5.0", "2025.11.0") std void	set_icon (const char *icon)

StringRef	get_icon_ref () const

uint32_t	get_device_id () const

void	set_device (Device *device)

Device *	get_device () const

bool	has_state () const

void	set_has_state (bool state)

	ESPDEPRECATED ("Use make_entity_preference<T>() instead, or preferences won't be migrated. " "See https://github.com/esphome/backlog/issues/85. Will be removed in 2027.1.0.", "2026.7.0") uint32_t get_preference_hash()
	Get a unique hash for storing preferences/settings for this entity.

template<typename T >
ESPPreferenceObject	make_entity_preference (uint32_t version=0)
	Create a preference object for storing this entity's state/settings.

Public Member Functions inherited from esphome::EntityBase_DeviceClass
ESPDEPRECATED("Use get_device_class_ref() instead for better performance (avoids string copy). Will be removed in " "ESPHome 2026.5.0", "2025.11.0") std void	set_device_class (const char *device_class)
	Get the device class, using the manual override if set.

StringRef	get_device_class_ref () const
	Get the device class as StringRef.

Public Member Functions inherited from esphome::EntityBase_UnitOfMeasurement
ESPDEPRECATED("Use get_unit_of_measurement_ref() instead for better performance (avoids string copy). Will be " "removed in ESPHome 2026.5.0", "2025.11.0") std void	set_unit_of_measurement (const char *unit_of_measurement)
	Get the unit of measurement, using the manual override if set.

StringRef	get_unit_of_measurement_ref () const
	Get the unit of measurement as StringRef.

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

Protected Member Functions
void	self_test_ ()

int16_t	sensirion_init_sensors_ ()

void	update_gas_indices_ ()

void	measure_raw_ ()

Protected Member Functions inherited from esphome::Component
void	call_loop_ ()

void	call_dump_config_ ()

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.

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 (uint32_t id)

bool	cancel_interval (InternalSchedulerID id)

ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std	ESPDEPRECATED ("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const char *name

	ESPDEPRECATED ("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(uint32_t id

	ESPDEPRECATED ("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(uint32_t initial_wait_time

ESPDEPRECATED("cancel_retry is deprecated and will be removed in 2026.8.0.", "2026.2.0") bool cancel_retry(const std	ESPDEPRECATED ("cancel_retry is deprecated and will be removed in 2026.8.0.", "2026.2.0") bool cancel_retry(const char *name)

	ESPDEPRECATED ("cancel_retry is deprecated and will be removed in 2026.8.0.", "2026.2.0") bool cancel_retry(uint32_t id)

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 (uint32_t id)

bool	cancel_timeout (InternalSchedulerID id)

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 (uint32_t id)

Protected Member Functions inherited from esphome::EntityBase
ESPPreferenceObject	make_entity_preference_ (size_t size, uint32_t version)
	Non-template helper for make_entity_preference() to avoid code bloat.

void	calc_object_id_ ()

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)
	get data words from I2C register.

Protected Attributes
sensor::Sensor *	humidity_sensor_ {nullptr}
	Input sensor for humidity and temperature compensation.

sensor::Sensor *	temperature_sensor_ {nullptr}

uint16_t	voc_sraw_

uint16_t	nox_sraw_

SgpType	sgp_type_ {SGP40}

uint64_t	serial_number_

bool	self_test_complete_

uint16_t	self_test_time_

sensor::Sensor *	voc_sensor_ {nullptr}

VOCGasIndexAlgorithm	voc_algorithm_

optional< GasTuning >	voc_tuning_params_

float	voc_state0_

float	voc_state1_

int32_t	voc_index_ = 0

sensor::Sensor *	nox_sensor_ {nullptr}

int32_t	nox_index_ = 0

NOxGasIndexAlgorithm	nox_algorithm_

optional< GasTuning >	nox_tuning_params_

uint16_t	measure_time_

uint8_t	samples_read_ = 0

uint8_t	samples_to_stabilize_ = static_cast<int8_t>(GasIndexAlgorithm_INITIAL_BLACKOUT) * 2

bool	store_baseline_

ESPPreferenceObject	pref_

uint32_t	seconds_since_last_store_

SGP4xBaselines	voc_baselines_storage_

Protected Attributes inherited from esphome::PollingComponent
uint32_t	update_interval_

Protected Attributes inherited from esphome::Component
ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") void set_interval(const std voi	set_interval )(const char *name, uint32_t interval, std::function< void()> &&f)
	Set an interval function with a unique name.

ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") bool cancel_interval(const std boo	cancel_interval )(const char *name)
	Cancel an interval function.

ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std uint32_t	initial_wait_time

ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std uint32_t uint8_t	max_attempts

ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std uint32_t uint8_t std::function< RetryResult(uint8_t)> &&	f

ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std uint32_t uint8_t std::function< RetryResult(uint8_t)> float	backoff_increase_factor = 1.0f)

uint32_t	initial_wait_time

uint32_t uint8_t	max_attempts

uint32_t uint8_t std::function< RetryResult(uint8_t)> &&	f

uint32_t uint8_t std::function< RetryResult(uint8_t)> float	backoff_increase_factor = 1.0f)

uint8_t	max_attempts

uint8_t std::function< RetryResult(uint8_t)> &&	f

uint8_t std::function< RetryResult(uint8_t)> float	backoff_increase_factor = 1.0f)

ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") void set_timeout(const std voi	set_timeout )(const char *name, uint32_t timeout, std::function< void()> &&f)
	Set a timeout function with a unique name.

ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") bool cancel_timeout(const std boo	cancel_timeout )(const char *name)
	Cancel a timeout function.

ESPDEPRECATED("Use const char* overload instead. Removed in 2026.7.0", "2026.1.0") void defer(const std voi	defer )(const char *name, std::function< void()> &&f)
	Defer a callback to the next loop() call.

ESPDEPRECATED("Use const char* overload instead. Removed in 2026.7.0", "2026.1.0") bool cancel_defer(const std boo	cancel_defer )(const char *name)
	Cancel a defer callback using the specified name, name must not be empty.

const LogString *	component_source_ {nullptr}

uint16_t	warn_if_blocking_over_ {WARN_IF_BLOCKING_OVER_MS}
	Warn if blocked for this many ms (max 65.5s)

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.

Protected Attributes inherited from esphome::sensor::Sensor
LazyCallbackManager< void(float)>	raw_callback_
	Storage for raw state callbacks.

LazyCallbackManager< void(float)>	callback_
	Storage for filtered state callbacks.

Filter *	filter_list_ {nullptr}
	Store all active filters.

int8_t	accuracy_decimals_ {-1}
	Accuracy in decimals (-1 = not set)

StateClass	state_class_ {STATE_CLASS_NONE}
	State class (STATE_CLASS_NONE = not set)

struct esphome::sensor::Sensor::SensorFlags	sensor_flags_

Protected Attributes inherited from esphome::EntityBase
StringRef	name_

const char *	icon_c_str_ {nullptr}

uint32_t	object_id_hash_ {}

Device *	device_ {}

struct esphome::EntityBase::EntityFlags	flags_

Protected Attributes inherited from esphome::EntityBase_DeviceClass
const char *	device_class_ {nullptr}
	Device class override.

Protected Attributes inherited from esphome::EntityBase_UnitOfMeasurement
const char *	unit_of_measurement_ {nullptr}
	Unit of measurement override.

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 }

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::sensor::Sensor
float	state
	This member variable stores the last state that has passed through all filters.

float	raw_state
	This member variable stores the current raw state of the sensor, without any filters applied.

Detailed Description

This class implements support for the Sensirion sgp4x i2c GAS (VOC) sensors.

Definition at line 58 of file sgp4x.h.

Member Function Documentation

◆ dump_config()

void esphome::sgp4x::SGP4xComponent::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 256 of file sgp4x.cpp.

◆ measure_raw_()

void esphome::sgp4x::SGP4xComponent::measure_raw_ ( )

protected

Definition at line 166 of file sgp4x.cpp.

◆ self_test_()

void esphome::sgp4x::SGP4xComponent::self_test_ ( )

protected

Definition at line 113 of file sgp4x.cpp.

◆ sensirion_init_sensors_()

int16_t esphome::sgp4x::SGP4xComponent::sensirion_init_sensors_ ( )

protected

◆ set_humidity_sensor()

void esphome::sgp4x::SGP4xComponent::set_humidity_sensor ( sensor::Sensor * humidity )

inline

Definition at line 71 of file sgp4x.h.

◆ set_nox_algorithm_tuning()

void esphome::sgp4x::SGP4xComponent::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 91 of file sgp4x.h.

◆ set_nox_sensor()

void esphome::sgp4x::SGP4xComponent::set_nox_sensor ( sensor::Sensor * nox_sensor )

inline

Definition at line 80 of file sgp4x.h.

◆ set_store_baseline()

void esphome::sgp4x::SGP4xComponent::set_store_baseline ( bool store_baseline )

inline

Definition at line 78 of file sgp4x.h.

◆ set_temperature_sensor()

void esphome::sgp4x::SGP4xComponent::set_temperature_sensor ( sensor::Sensor * temperature )

inline

Definition at line 72 of file sgp4x.h.

◆ set_voc_algorithm_tuning()

void esphome::sgp4x::SGP4xComponent::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 81 of file sgp4x.h.

◆ set_voc_sensor()

void esphome::sgp4x::SGP4xComponent::set_voc_sensor ( sensor::Sensor * voc_sensor )

inline

Definition at line 79 of file sgp4x.h.

◆ setup()

void esphome::sgp4x::SGP4xComponent::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 12 of file sgp4x.cpp.

◆ take_sample()

void esphome::sgp4x::SGP4xComponent::take_sample ( )

Definition at line 235 of file sgp4x.cpp.

◆ update()

void esphome::sgp4x::SGP4xComponent::update ( )

overridevirtual

Implements esphome::PollingComponent.

Definition at line 242 of file sgp4x.cpp.

◆ update_gas_indices_()

void esphome::sgp4x::SGP4xComponent::update_gas_indices_ ( )

protected

Definition at line 135 of file sgp4x.cpp.

Field Documentation

◆ humidity_sensor_

sensor::Sensor* esphome::sgp4x::SGP4xComponent::humidity_sensor_ {nullptr}

protected

Input sensor for humidity and temperature compensation.

Definition at line 106 of file sgp4x.h.

◆ measure_time_

uint16_t esphome::sgp4x::SGP4xComponent::measure_time_

protected

Definition at line 133 of file sgp4x.h.

◆ nox_algorithm_

NOxGasIndexAlgorithm esphome::sgp4x::SGP4xComponent::nox_algorithm_

protected

Definition at line 130 of file sgp4x.h.

◆ nox_index_

int32_t esphome::sgp4x::SGP4xComponent::nox_index_ = 0

protected

Definition at line 129 of file sgp4x.h.

◆ nox_sensor_

sensor::Sensor* esphome::sgp4x::SGP4xComponent::nox_sensor_ {nullptr}

protected

Definition at line 128 of file sgp4x.h.

◆ nox_sraw_

uint16_t esphome::sgp4x::SGP4xComponent::nox_sraw_

protected

Definition at line 113 of file sgp4x.h.

◆ nox_tuning_params_

optional<GasTuning> esphome::sgp4x::SGP4xComponent::nox_tuning_params_

protected

Definition at line 131 of file sgp4x.h.

◆ pref_

ESPPreferenceObject esphome::sgp4x::SGP4xComponent::pref_

protected

Definition at line 138 of file sgp4x.h.

◆ samples_read_

uint8_t esphome::sgp4x::SGP4xComponent::samples_read_ = 0

protected

Definition at line 134 of file sgp4x.h.

◆ samples_to_stabilize_

uint8_t esphome::sgp4x::SGP4xComponent::samples_to_stabilize_ = static_cast<int8_t>(GasIndexAlgorithm_INITIAL_BLACKOUT) * 2

protected

Definition at line 135 of file sgp4x.h.

◆ seconds_since_last_store_

uint32_t esphome::sgp4x::SGP4xComponent::seconds_since_last_store_

protected

Definition at line 139 of file sgp4x.h.

◆ self_test_complete_

bool esphome::sgp4x::SGP4xComponent::self_test_complete_

protected

Definition at line 118 of file sgp4x.h.

◆ self_test_time_

uint16_t esphome::sgp4x::SGP4xComponent::self_test_time_

protected

Definition at line 119 of file sgp4x.h.

◆ serial_number_

uint64_t esphome::sgp4x::SGP4xComponent::serial_number_

protected

Definition at line 116 of file sgp4x.h.

◆ sgp_type_

SgpType esphome::sgp4x::SGP4xComponent::sgp_type_ {SGP40}

protected

Definition at line 115 of file sgp4x.h.

◆ store_baseline_

bool esphome::sgp4x::SGP4xComponent::store_baseline_

protected

Definition at line 137 of file sgp4x.h.

◆ temperature_sensor_

sensor::Sensor* esphome::sgp4x::SGP4xComponent::temperature_sensor_ {nullptr}

protected

Definition at line 107 of file sgp4x.h.

◆ voc_algorithm_

VOCGasIndexAlgorithm esphome::sgp4x::SGP4xComponent::voc_algorithm_

protected

Definition at line 122 of file sgp4x.h.

◆ voc_baselines_storage_

SGP4xBaselines esphome::sgp4x::SGP4xComponent::voc_baselines_storage_

protected

Definition at line 140 of file sgp4x.h.

◆ voc_index_

int32_t esphome::sgp4x::SGP4xComponent::voc_index_ = 0

protected

Definition at line 126 of file sgp4x.h.

◆ voc_sensor_

sensor::Sensor* esphome::sgp4x::SGP4xComponent::voc_sensor_ {nullptr}

protected

Definition at line 121 of file sgp4x.h.

◆ voc_sraw_

uint16_t esphome::sgp4x::SGP4xComponent::voc_sraw_

protected

Definition at line 112 of file sgp4x.h.

◆ voc_state0_

float esphome::sgp4x::SGP4xComponent::voc_state0_

protected

Definition at line 124 of file sgp4x.h.

◆ voc_state1_

float esphome::sgp4x::SGP4xComponent::voc_state1_

protected

Definition at line 125 of file sgp4x.h.

◆ voc_tuning_params_

optional<GasTuning> esphome::sgp4x::SGP4xComponent::voc_tuning_params_

protected

Definition at line 123 of file sgp4x.h.

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

esphome/components/sgp4x/sgp4x.h
esphome/components/sgp4x/sgp4x.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ dump_config()

◆ measure_raw_()

◆ self_test_()

◆ sensirion_init_sensors_()

◆ set_humidity_sensor()

◆ set_nox_algorithm_tuning()

◆ set_nox_sensor()

◆ set_store_baseline()

◆ set_temperature_sensor()

◆ set_voc_algorithm_tuning()

◆ set_voc_sensor()

◆ setup()

◆ take_sample()

◆ update()

◆ update_gas_indices_()

Field Documentation

◆ humidity_sensor_

◆ measure_time_

◆ nox_algorithm_

◆ nox_index_

◆ nox_sensor_

◆ nox_sraw_

◆ nox_tuning_params_

◆ pref_

◆ samples_read_

◆ samples_to_stabilize_

◆ seconds_since_last_store_

◆ self_test_complete_

◆ self_test_time_

◆ serial_number_

◆ sgp_type_

◆ store_baseline_

◆ temperature_sensor_

◆ voc_algorithm_

◆ voc_baselines_storage_

◆ voc_index_

◆ voc_sensor_

◆ voc_sraw_

◆ voc_state0_

◆ voc_state1_

◆ voc_tuning_params_