ESPHome 2026.7.0
Loading...
Searching...
No Matches
esphome::sensor::ThrottleWithPriorityFilter< N > Class Template Reference

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

#include <filter.h>

Inheritance diagram for esphome::sensor::ThrottleWithPriorityFilter< N >:
esphome::sensor::ValueListFilter< N > esphome::sensor::Filter

Public Member Functions

 ThrottleWithPriorityFilter (uint32_t min_time_between_inputs, std::initializer_list< TemplatableFn< float > > prioritized_values)
 
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.
 
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::ValueListFilter< N >
std::array< TemplatableFn< float >, N > values_ {}
 
- Protected Attributes inherited from esphome::sensor::Filter
friend Sensor
 
Filternext_ {nullptr}
 
Sensorparent_ {nullptr}
 

Additional Inherited Members

- Protected Member Functions inherited from esphome::sensor::ValueListFilter< N >
 ValueListFilter (std::initializer_list< TemplatableFn< float > > values)
 
bool value_matches_any_ (float sensor_value)
 Check if sensor value matches any configured value (with accuracy rounding)
 

Detailed Description

template<size_t N>
class esphome::sensor::ThrottleWithPriorityFilter< N >

Same as 'throttle' but will immediately publish values contained in value_to_prioritize.

Definition at line 387 of file filter.h.

Constructor & Destructor Documentation

◆ ThrottleWithPriorityFilter()

template<size_t N>
esphome::sensor::ThrottleWithPriorityFilter< N >::ThrottleWithPriorityFilter ( uint32_t min_time_between_inputs,
std::initializer_list< TemplatableFn< float > > prioritized_values )
inlineexplicit

Definition at line 389 of file filter.h.

Member Function Documentation

◆ new_value()

template<size_t N>
optional< float > esphome::sensor::ThrottleWithPriorityFilter< N >::new_value ( float value)
inlineoverridevirtual

Implements esphome::sensor::Filter.

Definition at line 393 of file filter.h.

Field Documentation

◆ last_input_

template<size_t N>
uint32_t esphome::sensor::ThrottleWithPriorityFilter< N >::last_input_ {0}
protected

Definition at line 399 of file filter.h.

◆ min_time_between_inputs_

template<size_t N>
uint32_t esphome::sensor::ThrottleWithPriorityFilter< N >::min_time_between_inputs_
protected

Definition at line 400 of file filter.h.


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