ESPHome  2024.10.2
Public Member Functions | Protected Attributes
esphome::sensor::ThrottleAverageFilter Class Reference

Simple throttle average filter. More...

#include <filter.h>

Inheritance diagram for esphome::sensor::ThrottleAverageFilter:
esphome::sensor::Filter esphome::Component

Public Member Functions

 ThrottleAverageFilter (uint32_t time_period)
 
void setup () override
 
optional< float > new_value (float value) override
 
float get_setup_priority () const 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)
 
- Public Member Functions inherited from esphome::Component
virtual void loop ()
 This method will be called repeatedly. More...
 
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(). More...
 
void call ()
 
virtual void on_shutdown ()
 
virtual void on_safe_shutdown ()
 
uint32_t get_component_state () const
 
virtual void mark_failed ()
 Mark this component as failed. More...
 
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="unspecified")
 
void status_set_error (const char *message="unspecified")
 
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 char *source)
 Set where this component was loaded from for some debug messages. More...
 
const char * get_component_source () const
 Get the integration where this component was declared as a string. More...
 

Protected Attributes

uint32_t time_period_
 
float sum_ {0.0f}
 
unsigned int n_ {0}
 
bool have_nan_ {false}
 
- Protected Attributes inherited from esphome::sensor::Filter
friend Sensor
 
Filternext_ {nullptr}
 
Sensorparent_ {nullptr}
 
- Protected Attributes inherited from esphome::Component
uint32_t component_state_ {0x0000}
 State of this component. More...
 
float setup_priority_override_ {NAN}
 
const char * component_source_ {nullptr}
 

Additional Inherited Members

- Protected Member Functions inherited from esphome::Component
virtual void call_loop ()
 
virtual void call_setup ()
 
virtual void call_dump_config ()
 
void set_interval (const std::string &name, uint32_t interval, std::function< void()> &&f)
 Set an interval function with a unique name. More...
 
void set_interval (uint32_t interval, std::function< void()> &&f)
 
bool cancel_interval (const std::string &name)
 Cancel an interval function. More...
 
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. More...
 
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. More...
 
void set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f)
 Set a timeout function with a unique name. More...
 
void set_timeout (uint32_t timeout, std::function< void()> &&f)
 
bool cancel_timeout (const std::string &name)
 Cancel a timeout function. More...
 
void defer (const std::string &name, std::function< void()> &&f)
 Defer a callback to the next loop() call. More...
 
void defer (std::function< void()> &&f)
 Defer a callback to the next loop() call. More...
 
bool cancel_defer (const std::string &name)
 Cancel a defer callback using the specified name, name must not be empty. More...
 

Detailed Description

Simple throttle average filter.

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

Definition at line 234 of file filter.h.

Constructor & Destructor Documentation

◆ ThrottleAverageFilter()

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

Definition at line 251 of file filter.cpp.

Member Function Documentation

◆ get_setup_priority()

float esphome::sensor::ThrottleAverageFilter::get_setup_priority ( ) const
overridevirtual

Reimplemented from esphome::Component.

Definition at line 277 of file filter.cpp.

◆ new_value()

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

Implements esphome::sensor::Filter.

Definition at line 253 of file filter.cpp.

◆ setup()

void esphome::sensor::ThrottleAverageFilter::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 263 of file filter.cpp.

Field Documentation

◆ have_nan_

bool esphome::sensor::ThrottleAverageFilter::have_nan_ {false}
protected

Definition at line 248 of file filter.h.

◆ n_

unsigned int esphome::sensor::ThrottleAverageFilter::n_ {0}
protected

Definition at line 247 of file filter.h.

◆ sum_

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

Definition at line 246 of file filter.h.

◆ time_period_

uint32_t esphome::sensor::ThrottleAverageFilter::time_period_
protected

Definition at line 245 of file filter.h.


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