Data Structures
class	CalibrateLinearFilter
	N is set by code generation to match the exact number of calibration segments. More...

class	CalibratePolynomialFilter
	N is set by code generation to match the exact number of polynomial coefficients. More...

class	ClampFilter

class	DebounceFilter

class	DeltaFilter

class	ExponentialMovingAverageFilter
	Simple exponential moving average filter. More...

class	Filter
	Apply a filter to sensor values such as moving average. More...

class	FilterOutValueFilter
	A simple filter that only forwards the filter chain if it doesn't receive `value_to_filter_out`. More...

class	HeartbeatFilter

class	LambdaFilter
	This class allows for creation of simple template filters. More...

class	MaxFilter
	Simple max filter. More...

class	MedianFilter
	Simple median filter. More...

class	MinFilter
	Simple min filter. More...

class	MinMaxFilter
	Base class for Min/Max filters. More...

class	MultiplyFilter
	A simple filter that multiplies to each value it receives by `multiplier`. More...

class	OffsetFilter
	A simple filter that adds `offset` to each value it receives. More...

class	OrFilter
	N is set by code generation to match the exact number of filters configured in YAML. More...

class	QuantileFilter
	Simple quantile filter. More...

class	RoundFilter

class	RoundMultipleFilter

class	Sensor
	Base-class for all sensors. More...

class	SensorInRangeCondition

class	SensorPublishAction

class	SensorRawStateTrigger

class	SensorStateTrigger

class	SkipInitialFilter
	Simple skip filter. More...

class	SlidingWindowFilter
	Base class for filters that use a sliding window of values. More...

class	SlidingWindowMovingAverageFilter
	Simple sliding window moving average filter. More...

class	SortedWindowFilter
	Base class for filters that need a sorted window (Median, Quantile). More...

class	StatelessLambdaFilter
	Optimized lambda filter for stateless lambdas (no capture). More...

class	StreamingFilter
	Base class for streaming filters (batch windows where window_size == send_every). More...

class	StreamingMaxFilter
	Streaming max filter for batch windows (window_size == send_every). More...

class	StreamingMinFilter
	Streaming min filter for batch windows (window_size == send_every). More...

class	StreamingMovingAverageFilter
	Streaming moving average filter for batch windows (window_size == send_every). More...

class	ThrottleAverageFilter
	Simple throttle average filter. More...

class	ThrottleFilter

class	ThrottleWithPriorityFilter
	Same as 'throttle' but will immediately publish values contained in `value_to_prioritize`. More...

class	TimeoutFilterBase

class	TimeoutFilterConfigured

class	TimeoutFilterLast

class	ToNTCResistanceFilter

class	ToNTCTemperatureFilter

class	ValueListFilter
	Base class for filters that compare sensor values against a fixed list of configured values. More...

class	ValueRangeTrigger

Typedefs
using	lambda_filter_t = std::function<optional<float>(float)>

Enumerations
enum	StateClass : uint8_t { STATE_CLASS_NONE = 0 , STATE_CLASS_MEASUREMENT = 1 , STATE_CLASS_TOTAL_INCREASING = 2 , STATE_CLASS_TOTAL = 3 , STATE_CLASS_MEASUREMENT_ANGLE = 4 }
	Sensor state classes. More...

Functions
bool	value_list_matches_any (Sensor parent, float sensor_value, const TemplatableFn< float > values, size_t count)
	Non-template helper for value matching (implementation in filter.cpp)

optional< float >	throttle_with_priority_new_value (Sensor parent, float value, const TemplatableFn< float > values, size_t count, uint32_t &last_input, uint32_t min_time_between_inputs)
	Non-template helper for ThrottleWithPriorityFilter (implementation in filter.cpp)

void	or_filter_initialize (Filter *filters, size_t count, Sensor parent, Filter *phi)
	Non-template helpers for OrFilter (implementation in filter.cpp)

optional< float >	or_filter_new_value (Filter **filters, size_t count, float value, bool &has_value)

optional< float >	calibrate_linear_compute (const std::array< float, 3 > *functions, size_t count, float value)
	Non-template helper for linear calibration (implementation in filter.cpp)

optional< float >	calibrate_polynomial_compute (const float *coefficients, size_t count, float value)
	Non-template helper for polynomial calibration (implementation in filter.cpp)

void	log_sensor (const char tag, const char prefix, const char type, Sensor obj)

	PROGMEM_STRING_TABLE (StateClassStrings, "", "measurement", "total_increasing", "total", "measurement_angle")

const LogString *	state_class_to_string (StateClass state_class)

Variables
constexpr uint32_t	FILTER_ID = 0

constexpr uint8_t	STATE_CLASS_LAST = static_cast<uint8_t>(STATE_CLASS_MEASUREMENT_ANGLE)

Typedef Documentation

◆ lambda_filter_t

using esphome::sensor::lambda_filter_t = std::function<optional<float>(float)>

Definition at line 274 of file filter.h.

Enumeration Type Documentation

◆ StateClass

enum esphome::sensor::StateClass : uint8_t

Sensor state classes.

Enumerator
STATE_CLASS_NONE
STATE_CLASS_MEASUREMENT
STATE_CLASS_TOTAL_INCREASING
STATE_CLASS_TOTAL
STATE_CLASS_MEASUREMENT_ANGLE

Definition at line 32 of file sensor.h.

Function Documentation

◆ calibrate_linear_compute()

optional< float > esphome::sensor::calibrate_linear_compute	(	const std::array< float, 3 > *	functions,
		size_t	count,
		float	value )

Non-template helper for linear calibration (implementation in filter.cpp)

Definition at line 388 of file filter.cpp.

◆ calibrate_polynomial_compute()

optional< float > esphome::sensor::calibrate_polynomial_compute	(	const float *	coefficients,
		size_t	count,
		float	value )

Non-template helper for polynomial calibration (implementation in filter.cpp)

Definition at line 396 of file filter.cpp.

◆ log_sensor()

void esphome::sensor::log_sensor	(	const char *	tag,
		const char *	prefix,
		const char *	type,
		Sensor *	obj )

Definition at line 12 of file sensor.cpp.

◆ or_filter_initialize()

void esphome::sensor::or_filter_initialize	(	Filter **	filters,
		size_t	count,
		Sensor *	parent,
		Filter *	phi )

Non-template helpers for OrFilter (implementation in filter.cpp)

Definition at line 299 of file filter.cpp.

◆ or_filter_new_value()

optional< float > esphome::sensor::or_filter_new_value	(	Filter **	filters,
		size_t	count,
		float	value,
		bool &	has_value )

Definition at line 306 of file filter.cpp.

◆ PROGMEM_STRING_TABLE()

esphome::sensor::PROGMEM_STRING_TABLE	(	StateClassStrings	,
		""	,
		"measurement"	,
		"total_increasing"	,
		"total"	,
		"measurement_angle"	)

◆ state_class_to_string()

const LogString * esphome::sensor::state_class_to_string ( StateClass state_class )

Definition at line 38 of file sensor.cpp.

◆ throttle_with_priority_new_value()

optional< float > esphome::sensor::throttle_with_priority_new_value	(	Sensor *	parent,
		float	value,
		const TemplatableFn< float > *	values,
		size_t	count,
		uint32_t &	last_input,
		uint32_t	min_time_between_inputs )

Non-template helper for ThrottleWithPriorityFilter (implementation in filter.cpp)

Definition at line 261 of file filter.cpp.

◆ value_list_matches_any()

bool esphome::sensor::value_list_matches_any	(	Sensor *	parent,
		float	sensor_value,
		const TemplatableFn< float > *	values,
		size_t	count )

Non-template helper for value matching (implementation in filter.cpp)

Definition at line 226 of file filter.cpp.

Variable Documentation

◆ FILTER_ID

uint32_t esphome::sensor::FILTER_ID = 0

constexpr

Definition at line 19 of file filter.cpp.

◆ STATE_CLASS_LAST

uint8_t esphome::sensor::STATE_CLASS_LAST = static_cast<uint8_t>(STATE_CLASS_MEASUREMENT_ANGLE)