mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-05-05 10:38:58 +00:00
5297271d3a
* Update threshold sensor docs for new hysteresis attribute * Added default and changed wording * Keep configuration sample minimal * Add comment from code
1.6 KiB
1.6 KiB
layout, title, description, date, sidebar, comments, sharing, footer, logo, ha_category, ha_iot_class, ha_release
| layout | title | description | date | sidebar | comments | sharing | footer | logo | ha_category | ha_iot_class | ha_release |
|---|---|---|---|---|---|---|---|---|---|---|---|
| page | Threshold Binary Sensor | Instructions how to integrate threshold binary sensors into Home Assistant. | 2016-11-26 12:10 | true | false | true | true | home-assistant.png | Binary Sensor | Local Polling | 0.34 |
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.
{% raw %}{{ states.sensor.furnace.state > 2.5 }}{% endraw %}
To enable the threshold sensor, add the following lines to your configuration.yaml:
# Example configuration.yaml entry
binary_sensor:
- platform: threshold
threshold: 15
type: lower
entity_id: sensor.random
Configuration variables:
- entity_id (Required): The entity to monitor. Only sensors are supported.
- threshold (Required): The threshold which the observed value is compared against.
- type (Required):
lowerif the value needs to be below the threshold orupperif 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.