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

#include <filter.h>

Inheritance diagram for esphome::sensor::MinMaxFilter:

Public Member Functions
	SlidingWindowFilter (size_t window_size, size_t send_every, size_t send_first_at)

Public Member Functions inherited from esphome::sensor::SlidingWindowFilter
	SlidingWindowFilter (size_t window_size, size_t send_every, size_t send_first_at)

optional< float >	new_value (float value) final

Public Member Functions inherited from esphome::sensor::Filter
virtual void	initialize (Sensor parent, Filter next)
	Initialize this filter, please note this can be called more than once.

void	input (float value)

void	output (float value)

Protected Member Functions
template<typename Compare >
float	find_extremum_ ()
	Helper to find min or max value in window, skipping NaN values Usage: find_extremum_<std::less<float>>() for min, find_extremum_<std::greater<float>>() for max.

Protected Member Functions inherited from esphome::sensor::SlidingWindowFilter
virtual float	compute_result ()=0
	Called by new_value() to compute the filtered result from the current window.

Additional Inherited Members
Protected Attributes inherited from esphome::sensor::SlidingWindowFilter
FixedVector< float >	window_
	Access the sliding window values (ring buffer implementation) Use: for (size_t i = 0; i < window_count_; i++) { float val = window_[i]; }.

size_t	window_head_ {0}
	Index where next value will be written.

size_t	window_count_ {0}
	Number of valid values in window (0 to window_size_)

size_t	window_size_
	Maximum window size.

size_t	send_every_
	Send result every N values.

size_t	send_at_
	Counter for send_every.

Protected Attributes inherited from esphome::sensor::Filter
friend	Sensor

Filter *	next_ {nullptr}

Sensor *	parent_ {nullptr}

Detailed Description

Base class for Min/Max filters.

Provides a templated helper to find extremum values efficiently.

Definition at line 77 of file filter.h.

Member Function Documentation

template<typename Compare >

float esphome::sensor::MinMaxFilter::find_extremum_ ( )

inlineprotected

Helper to find min or max value in window, skipping NaN values Usage: find_extremum_<std::less<float>>() for min, find_extremum_<std::greater<float>>() for max.

Definition at line 84 of file filter.h.

esphome::sensor::SlidingWindowFilter::SlidingWindowFilter	(	size_t	window_size,
		size_t	send_every,
		size_t	send_first_at )

Definition at line 55 of file filter.cpp.

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