Base class for operations that do not require an extra parameter to compute the combination. More...

#include <combination.h>

Inheritance diagram for esphome::combination::CombinationNoParameterComponent:

Public Member Functions
void	setup () override
	Adds a callback to each source sensor.

void	add_source (Sensor *sensor)

virtual void	handle_new_value (float value)=0
	Computes the combination.

void	log_source_sensors () override
	Logs all source sensor's names in sensors_.

Public Member Functions inherited from esphome::combination::CombinationComponent
float	get_setup_priority () const override

Public Member Functions inherited from esphome::Component
virtual void	loop ()
	This method will be called repeatedly.

virtual void	dump_config ()

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)

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.

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)

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

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

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

Protected Attributes
std::vector< Sensor * >	sensors_

Protected Attributes inherited from esphome::Component
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 Bits 5-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
std::unique_ptr< CallbackManager< void(float)> >	raw_callback_
	Storage for raw state callbacks (lazy allocated).

CallbackManager< 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 *	object_id_c_str_ {nullptr}

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.

Additional Inherited Members
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.

Protected Member Functions inherited from esphome::combination::CombinationComponent
void	log_config_ (const LogString *combo_type)
	Logs the sensor for use in dump_config.

Protected Member Functions inherited from esphome::Component
virtual void	call_loop ()

virtual void	call_setup ()

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.

Protected Member Functions inherited from esphome::EntityBase
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)

Detailed Description

Base class for operations that do not require an extra parameter to compute the combination.

Definition at line 25 of file combination.h.

Member Function Documentation

◆ add_source()

void esphome::combination::CombinationNoParameterComponent::add_source ( Sensor * sensor )

Definition at line 21 of file combination.cpp.

◆ handle_new_value()

virtual void esphome::combination::CombinationNoParameterComponent::handle_new_value ( float value )

pure virtual

Computes the combination.

Parameters

value Newest sensor measurement

Implemented in esphome::combination::MaximumCombinationComponent, esphome::combination::MeanCombinationComponent, esphome::combination::MedianCombinationComponent, esphome::combination::MinimumCombinationComponent, esphome::combination::MostRecentCombinationComponent, esphome::combination::RangeCombinationComponent, and esphome::combination::SumCombinationComponent.

◆ log_source_sensors()

void esphome::combination::CombinationNoParameterComponent::log_source_sensors ( )

overridevirtual

Logs all source sensor's names in sensors_.

Implements esphome::combination::CombinationComponent.

Definition at line 31 of file combination.cpp.

◆ setup()

void esphome::combination::CombinationNoParameterComponent::setup ( )

overridevirtual

Adds a callback to each source sensor.

Reimplemented from esphome::Component.

Definition at line 46 of file combination.cpp.

Field Documentation

◆ sensors_

std::vector<Sensor *> esphome::combination::CombinationNoParameterComponent::sensors_

protected

Definition at line 40 of file combination.h.

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

esphome/components/combination/combination.h
esphome/components/combination/combination.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members