mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-22 08:46:51 +00:00
Update threshold sensor docs for new hysteresis attribute (#3449)
* Update threshold sensor docs for new hysteresis attribute * Added default and changed wording * Keep configuration sample minimal * Add comment from code
This commit is contained in:
parent
52757f7366
commit
5297271d3a
@ -14,7 +14,9 @@ ha_release: 0.34
|
||||
---
|
||||
|
||||
|
||||
The `threshold` binary sensor platform is consuming the state from another sensor. If the value is below (`lower`) or higher (`upper`) than the given threshold then state of this sensor change..
|
||||
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.
|
||||
|
||||
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.
|
||||
|
||||
It's an alternative to the template binary sensor's `value_template:` to get the abnormal/too high/too low states.
|
||||
|
||||
@ -36,7 +38,7 @@ binary_sensor:
|
||||
Configuration variables:
|
||||
|
||||
- **entity_id** (*Required*): The entity to monitor. Only [sensors](/components/sensor/) are supported.
|
||||
- **threshold** (*Required*): The value which is the threshold.
|
||||
- **threshold** (*Required*): The threshold which the observed value is compared against.
|
||||
- **type** (*Required*): `lower` if the value needs to be below the threshold or `upper` if higher.
|
||||
- **hysteresis** (*Optional*): The distance the observed value must be from the threshold before the state is changed. Defaults to `0.0`
|
||||
- **name** (*Optional*): Name of the sensor to use in the frontend. Defaults to `Stats`.
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user