ESPHome  2024.6.6
Public Member Functions | Protected Attributes
esphome::sensor::MedianFilter Class Reference

Simple median filter. More...

#include <filter.h>

Inheritance diagram for esphome::sensor::MedianFilter:

Public Member Functions

 MedianFilter (size_t window_size, size_t send_every, size_t send_first_at)
 Construct a MedianFilter. 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 median filter.

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

Definition at line 81 of file filter.h.

Constructor & Destructor Documentation

◆ MedianFilter()

esphome::sensor::MedianFilter::MedianFilter ( size_t  window_size,
size_t  send_every,
size_t  send_first_at 

Construct a MedianFilter.

window_sizeThe number of values that should be used in median calculation.
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 35 of file filter.cpp.

Member Function Documentation

◆ new_value()

optional< float > esphome::sensor::MedianFilter::new_value ( float  value)

Implements esphome::sensor::Filter.

Definition at line 39 of file filter.cpp.

◆ set_send_every()

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

Definition at line 37 of file filter.cpp.

◆ set_window_size()

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

Definition at line 38 of file filter.cpp.

Field Documentation

◆ queue_

std::deque<float> esphome::sensor::MedianFilter::queue_

Definition at line 99 of file filter.h.

◆ send_at_

size_t esphome::sensor::MedianFilter::send_at_

Definition at line 101 of file filter.h.

◆ send_every_

size_t esphome::sensor::MedianFilter::send_every_

Definition at line 100 of file filter.h.

◆ window_size_

size_t esphome::sensor::MedianFilter::window_size_

Definition at line 102 of file filter.h.

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