ESPHome  2022.11.4
Public Member Functions | Protected Attributes
esphome::sensor::ThrottleFilter Class Reference

#include <filter.h>

Inheritance diagram for esphome::sensor::ThrottleFilter:
esphome::sensor::Filter

Public Member Functions

 ThrottleFilter (uint32_t min_time_between_inputs)
 
optional< float > new_value (float value) override
 
- 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. More...
 
void input (float value)
 
void output (float value)
 

Protected Attributes

uint32_t last_input_ {0}
 
uint32_t min_time_between_inputs_
 
- Protected Attributes inherited from esphome::sensor::Filter
friend Sensor
 
Filternext_ {nullptr}
 
Sensorparent_ {nullptr}
 

Detailed Description

Definition at line 286 of file filter.h.

Constructor & Destructor Documentation

◆ ThrottleFilter()

esphome::sensor::ThrottleFilter::ThrottleFilter ( uint32_t  min_time_between_inputs)
explicit

Definition at line 307 of file filter.cpp.

Member Function Documentation

◆ new_value()

optional< float > esphome::sensor::ThrottleFilter::new_value ( float  value)
overridevirtual

Implements esphome::sensor::Filter.

Definition at line 308 of file filter.cpp.

Field Documentation

◆ last_input_

uint32_t esphome::sensor::ThrottleFilter::last_input_ {0}
protected

Definition at line 293 of file filter.h.

◆ min_time_between_inputs_

uint32_t esphome::sensor::ThrottleFilter::min_time_between_inputs_
protected

Definition at line 294 of file filter.h.


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