ESPHome 2025.10.5
Loading...
Searching...
No Matches
esphome::sensor::ThrottleWithPriorityFilter Class Reference

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

#include <filter.h>

Inheritance diagram for esphome::sensor::ThrottleWithPriorityFilter:
esphome::sensor::Filter

Public Member Functions

 ThrottleWithPriorityFilter (uint32_t min_time_between_inputs, std::vector< TemplatableValue< 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_
 
std::vector< TemplatableValue< float > > prioritized_values_
 
- Protected Attributes inherited from esphome::sensor::Filter
friend Sensor
 
Filternext_ {nullptr}
 
Sensorparent_ {nullptr}
 

Detailed Description

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

Definition at line 318 of file filter.h.

Constructor & Destructor Documentation

◆ ThrottleWithPriorityFilter()

esphome::sensor::ThrottleWithPriorityFilter::ThrottleWithPriorityFilter ( uint32_t min_time_between_inputs,
std::vector< TemplatableValue< float > > prioritized_values )
explicit

Definition at line 337 of file filter.cpp.

Member Function Documentation

◆ new_value()

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

Implements esphome::sensor::Filter.

Definition at line 341 of file filter.cpp.

Field Documentation

◆ last_input_

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

Definition at line 326 of file filter.h.

◆ min_time_between_inputs_

uint32_t esphome::sensor::ThrottleWithPriorityFilter::min_time_between_inputs_
protected

Definition at line 327 of file filter.h.

◆ prioritized_values_

std::vector<TemplatableValue<float> > esphome::sensor::ThrottleWithPriorityFilter::prioritized_values_
protected

Definition at line 328 of file filter.h.


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