Add config flow for Threshold (#22071)

This commit is contained in:
Franck Nijhof 2022-03-22 12:05:40 +01:00 committed by GitHub
parent e8020aec5c
commit 22a3c87dd6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -10,27 +10,34 @@ ha_quality_scale: internal
ha_codeowners:
- '@fabaff'
ha_domain: threshold
ha_config_flow: true
ha_platforms:
- binary_sensor
---
The `threshold` binary sensor platform observes the state of another sensor. If the value is below (`lower`) or higher (`upper`) than the given threshold then state of the threshold sensor is changed. It support also a range if `lower` and `upper` are given.
The threshold integration observes the state of another sensor. If the value is below or higher than the given threshold then state of the threshold sensor is changed. It support also a range both the upper and lower limits are given.
If the sensor is configured with no hysteresis and the sensor value is equal to the threshold, the sensor is turned off since it is not `lower` or `upper` with respect to the threshold.
If the sensor is configured with no hysteresis and the sensor value is equal to the threshold, the sensor is turned off since it is not upper or lower with respect to the threshold.
It's an alternative to the template binary sensor's `value_template:` to get the abnormal/too high/too low states.
{% include integrations/config_flow.md %}
{% configuration_basic %}
Name:
description: The name the sensor should have. You can change it again later.
Input sensor:
description: The entity providing numeric readings to apply the threshold on.
Hysteresis:
description: The distance the observed value must be from the threshold before the state is changed.
Lower limit:
description: The lower threshold which the observed value is compared against.
Upper limit:
description: The upper threshold which the observed value is compared against.
{% endconfiguration_basic %}
{% raw %}
## YAML Configuration
```yaml
{{ states('sensor.furnace') > 2.5 }}
```
{% endraw %}
## Configuration
To enable the threshold sensor, add the following lines to your `configuration.yaml`:
Alternatively, this integration can be configured and set up manually via YAML
instead. To enable the Integration sensor in your installation, add the
following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry