|
ESPHome 2026.11.0b6
|
Data Structures | |
| class | CalibrateLinearFilter |
| Piecewise linear calibration; the segments are a PROGMEM table shared by filters with the same data. More... | |
| class | CalibratePolynomialFilter |
| Polynomial calibration; the coefficients are a PROGMEM table shared by filters with the same data. More... | |
| class | ClampFilter |
| class | DebounceFilter |
| class | DeltaFilter |
| class | ExponentialMovingAverageFilter |
| Simple exponential moving average filter. More... | |
| class | Filter |
| Apply a filter to sensor values such as moving average. More... | |
| class | FilterOutValueFilter |
A simple filter that only forwards the filter chain if it doesn't receive value_to_filter_out. More... | |
| class | HeartbeatFilter |
| class | LambdaFilter |
| This class allows for creation of simple template filters. More... | |
| class | MaxFilter |
| Simple max filter. More... | |
| class | MedianFilter |
| Simple median filter. More... | |
| class | MinFilter |
| Simple min filter. More... | |
| class | MinMaxFilter |
| Base class for Min/Max filters. More... | |
| class | MultiplyFilter |
A simple filter that multiplies to each value it receives by multiplier. More... | |
| class | OffsetFilter |
A simple filter that adds offset to each value it receives. More... | |
| class | OrFilter |
| N is set by code generation to match the exact number of filters configured in YAML. More... | |
| class | QuantileFilter |
| Simple quantile filter. More... | |
| class | RHCorrectionFilter |
| RH Temperature correction filter. More... | |
| class | RoundFilter |
| class | RoundMultipleFilter |
| class | RoundSignificantDigitsFilter |
| class | Sensor |
| Base-class for all sensors. More... | |
| class | SensorWithDedup |
| A sensor pointer that may be null plus the last value it published, stored inline. More... | |
| class | SkipInitialFilter |
| Simple skip filter. More... | |
| class | SlidingWindowFilter |
| Base class for filters that use a sliding window of values. More... | |
| class | SlidingWindowMovingAverageFilter |
| Simple sliding window moving average filter. More... | |
| class | SortedWindowFilter |
| Base class for filters that need a sorted window (Median, Quantile). More... | |
| class | StatelessLambdaFilter |
| Optimized lambda filter for stateless lambdas (no capture). More... | |
| class | StreamingFilter |
| Base class for streaming filters (batch windows where window_size == send_every). More... | |
| class | StreamingMaxFilter |
| Streaming max filter for batch windows (window_size == send_every). More... | |
| class | StreamingMinFilter |
| Streaming min filter for batch windows (window_size == send_every). More... | |
| class | StreamingMovingAverageFilter |
| Streaming moving average filter for batch windows (window_size == send_every). More... | |
| class | ThrottleAverageFilter |
| Simple throttle average filter. More... | |
| class | ThrottleFilter |
| class | ThrottleWithPriorityFilter |
Same as 'throttle' but will immediately publish values contained in value_to_prioritize. More... | |
| class | ThrottleWithPriorityNanFilter |
| Specialization of ThrottleWithPriorityFilter for the common "prioritize NaN" case: skips the TemplatableFn<float> array + lambda and inlines the check. More... | |
| class | TimeoutFilterBase |
| class | TimeoutFilterConfigured |
| class | TimeoutFilterLast |
| class | TimeoutThrottleFilter |
Codegen use only: timeout (value last) followed by throttle_with_priority (NaN only) with the same period, as one object. More... | |
| class | ToNTCResistanceFilter |
| class | ToNTCTemperatureFilter |
| class | ValueListFilter |
| Base class for filters that compare sensor values against a fixed list of configured values. More... | |
| class | ValueRangeTrigger |
Typedefs | |
| using | lambda_filter_t = std::function<optional<float>(float)> |
Enumerations | |
| enum | StateClass : uint8_t { STATE_CLASS_NONE = 0 , STATE_CLASS_MEASUREMENT = 1 , STATE_CLASS_TOTAL_INCREASING = 2 , STATE_CLASS_TOTAL = 3 , STATE_CLASS_MEASUREMENT_ANGLE = 4 } |
| Sensor state classes. More... | |
Functions | |
| ESPHOME_LOG_TAG (TAG, "sensor.filter") | |
| void | or_filter_initialize (Filter **filters, size_t count, Sensor *parent, Filter *phi) |
| Non-template helpers for OrFilter (implementation in filter.cpp) | |
| optional< float > | or_filter_new_value (Filter **filters, size_t count, float value, bool &has_value) |
| ESPHOME_LOG_TAG (TAG, "sensor") | |
| void | log_sensor (const char *tag, const char *prefix, const char *type, Sensor *obj) |
| PROGMEM_STRING_TABLE (StateClassStrings, "", "measurement", "total_increasing", "total", "measurement_angle") | |
| const LogString * | state_class_to_string (StateClass state_class) |
| float | source_value (const Sensor *sensor, float min, float max) |
| Read another sensor as an input, such as the temperature a gas sensor compensates for. | |
Variables | |
| constexpr uint8_t | STATE_CLASS_LAST = static_cast<uint8_t>(STATE_CLASS_MEASUREMENT_ANGLE) |
| using esphome::sensor::lambda_filter_t = std::function<optional<float>(float)> |
| enum esphome::sensor::StateClass : uint8_t |
| esphome::sensor::ESPHOME_LOG_TAG | ( | TAG | , |
| "sensor" | ) |
| esphome::sensor::ESPHOME_LOG_TAG | ( | TAG | , |
| "sensor.filter" | ) |
| void esphome::sensor::log_sensor | ( | const char * | tag, |
| const char * | prefix, | ||
| const char * | type, | ||
| Sensor * | obj ) |
Definition at line 12 of file sensor.cpp.
| void esphome::sensor::or_filter_initialize | ( | Filter ** | filters, |
| size_t | count, | ||
| Sensor * | parent, | ||
| Filter * | phi ) |
Non-template helpers for OrFilter (implementation in filter.cpp)
Definition at line 313 of file filter.cpp.
| optional< float > esphome::sensor::or_filter_new_value | ( | Filter ** | filters, |
| size_t | count, | ||
| float | value, | ||
| bool & | has_value ) |
Definition at line 320 of file filter.cpp.
| esphome::sensor::PROGMEM_STRING_TABLE | ( | StateClassStrings | , |
| "" | , | ||
| "measurement" | , | ||
| "total_increasing" | , | ||
| "total" | , | ||
| "measurement_angle" | ) |
|
inline |
Read another sensor as an input, such as the temperature a gas sensor compensates for.
sensor when it lies in [min, max] (both included); NAN when sensor is null, its state is NAN (as it is before the first publish) or its state is out of range. The caller decides whether to skip or fall back, and what to log. | const LogString * esphome::sensor::state_class_to_string | ( | StateClass | state_class | ) |
Definition at line 38 of file sensor.cpp.
|
constexpr |