Add 'map_linear' and 'clamp' sensor filters (#3039)

This commit is contained in:
Mat931 2023-07-30 21:09:15 +00:00 committed by GitHub
parent b6b4cb5c30
commit 2134e5fdf3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 30 additions and 6 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 19 KiB

View File

@ -184,6 +184,12 @@ Multiplies each value by a constant value.
Calibrate your sensor values by using values you measured with an accurate "truth" source.
Configuration variables:
- **method** (*Optional*, string): The method for calculating the linear function(s).
One of ``least_squares`` or ``exact``. Defaults to ``least_squares``.
- **datapoints** (**Required**): The list of datapoints.
First, collect a bunch of values of what the sensor shows and what the real value should be.
For temperature, this can for example be achieved by using an accurate thermometer. For other
sensors like power sensor this can be done by connecting a known load and then writing down
@ -198,14 +204,21 @@ the value the sensor shows.
name: "DHT22 Temperature"
filters:
- calibrate_linear:
# Map 0.0 (from sensor) to 0.0 (true value)
- 0.0 -> 0.0
method: least_squares
datapoints:
# Map 0.0 (from sensor) to 1.0 (true value)
- 0.0 -> 1.0
- 10.0 -> 12.1
The arguments are a list of data points, each in the form ``MEASURED -> TRUTH``. ESPHome will
then fit a linear equation to the values (using least squares). So you need to supply at least
two values. If more than two values are given a linear solution will be calculated and may not
represent each value exactly.
The arguments are a list of data points, each in the form ``MEASURED -> TRUTH``. Depending on
the ``method`` ESPHome will then either fit a linear equation to the values (using least squares)
or connect the values exactly using multiple linear equations. You need to supply at least two
values. When using ``least_squares`` and more than two values are given a linear solution will be
calculated and may not represent each value exactly.
.. figure:: images/sensor_filter_calibrate_linear.png
:align: center
:width: 50.0%
.. _sensor-calibrate_polynomial:
@ -246,6 +259,17 @@ degree with a least squares solver.
filters:
- filter_out: 85.0
``clamp``
*********
Limits the value to the range between ``min_value`` and ``max_value``. If ``min_value`` is not set, there is
no lower bound, if ``max_value`` is not set there is no upper bound.
Configuration variables:
- **min_value** (*Optional*, float): The lower bound of the range.
- **max_value** (*Optional*, float): The upper bound of the range.
``quantile``
************