esphome::sensor::ThrottleAverageFilter Class Reference

Simple throttle average filter. More...

#include <filter.h>

Inheritance diagram for esphome::sensor::ThrottleAverageFilter:

Public Member Functions
	ThrottleAverageFilter (uint32_t time_period)
void	initialize (Sensor *parent, Filter *next) override
optional< float >	new_value (float value) override
Public Member Functions inherited from esphome::sensor::Filter
void	input (float value)
void	output (float value)

Protected Attributes
float	sum_ {0.0f}
uint32_t	time_period_
uint32_t	n_: 31 {0}
uint32_t	have_nan_: 1 {0}
Protected Attributes inherited from esphome::sensor::Filter
friend	Sensor
Filter *	next_ {nullptr}
Sensor *	parent_ {nullptr}

Detailed Description

Simple throttle average filter.

It takes the average of all the values received in a period of time.

Definition at line 257 of file filter.h.

Constructor & Destructor Documentation

ThrottleAverageFilter()

esphome::sensor::ThrottleAverageFilter::ThrottleAverageFilter ( uint32_t time_period )

explicit

Definition at line 171 of file filter.cpp.

Member Function Documentation

initialize()

void esphome::sensor::ThrottleAverageFilter::initialize ( Sensor * parent, Filter * next )

overridevirtual

Reimplemented from esphome::sensor::Filter.

Definition at line 183 of file filter.cpp.

new_value()

optional< float > esphome::sensor::ThrottleAverageFilter::new_value ( float value )

overridevirtual

Implements esphome::sensor::Filter.

Definition at line 173 of file filter.cpp.

Field Documentation

have_nan_

uint32_t esphome::sensor::ThrottleAverageFilter::have_nan_

protected

Definition at line 272 of file filter.h.

n_

uint32_t esphome::sensor::ThrottleAverageFilter::n_

protected

Definition at line 271 of file filter.h.

sum_

float esphome::sensor::ThrottleAverageFilter::sum_ {0.0f}

protected

Definition at line 266 of file filter.h.

time_period_

uint32_t esphome::sensor::ThrottleAverageFilter::time_period_

protected

Definition at line 267 of file filter.h.

---

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

• esphome/components/sensor/filter.h
• esphome/components/sensor/filter.cpp