ESPHome  2022.11.3
Public Member Functions | Protected Attributes
esphome::sensor::MinFilter Class Reference

Simple min filter. More...

#include <filter.h>

Inheritance diagram for esphome::sensor::MinFilter:
esphome::sensor::Filter

Public Member Functions

 MinFilter (size_t window_size, size_t send_every, size_t send_first_at)
 Construct a MinFilter. More...
 
optional< float > new_value (float value) override
 
void set_send_every (size_t send_every)
 
void set_window_size (size_t window_size)
 
- 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

std::deque< float > queue_
 
size_t send_every_
 
size_t send_at_
 
size_t window_size_
 
- Protected Attributes inherited from esphome::sensor::Filter
friend Sensor
 
Filternext_ {nullptr}
 
Sensorparent_ {nullptr}
 

Detailed Description

Simple min filter.

Takes the min of the last <send_every> values and pushes it out every <send_every>.

Definition at line 108 of file filter.h.

Constructor & Destructor Documentation

◆ MinFilter()

esphome::sensor::MinFilter::MinFilter ( size_t  window_size,
size_t  send_every,
size_t  send_first_at 
)
explicit

Construct a MinFilter.

Parameters
window_sizeThe number of values that the min should be returned from.
send_everyAfter how many sensor values should a new one be pushed out.
send_first_atAfter how many values to forward the very first value. Defaults to the first value on startup being published on the first raw value, so with no filter applied. Must be less than or equal to send_every.

Definition at line 120 of file filter.cpp.

Member Function Documentation

◆ new_value()

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

Implements esphome::sensor::Filter.

Definition at line 124 of file filter.cpp.

◆ set_send_every()

void esphome::sensor::MinFilter::set_send_every ( size_t  send_every)

Definition at line 122 of file filter.cpp.

◆ set_window_size()

void esphome::sensor::MinFilter::set_window_size ( size_t  window_size)

Definition at line 123 of file filter.cpp.

Field Documentation

◆ queue_

std::deque<float> esphome::sensor::MinFilter::queue_
protected

Definition at line 126 of file filter.h.

◆ send_at_

size_t esphome::sensor::MinFilter::send_at_
protected

Definition at line 128 of file filter.h.

◆ send_every_

size_t esphome::sensor::MinFilter::send_every_
protected

Definition at line 127 of file filter.h.

◆ window_size_

size_t esphome::sensor::MinFilter::window_size_
protected

Definition at line 129 of file filter.h.


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