mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-05-30 23:06:49 +00:00
52 lines
1.6 KiB
Markdown
52 lines
1.6 KiB
Markdown
---
|
|
layout: page
|
|
title: "Template Binary Sensor"
|
|
description: "Instructions how to integrate Template binary sensors into Home Assistant."
|
|
date: 2016-02-25 15:00
|
|
sidebar: true
|
|
comments: false
|
|
sharing: true
|
|
footer: true
|
|
ha_category: Binary Sensor
|
|
---
|
|
|
|
The `template` platform supports sensors which breaks out the state and `state_attributes` from other entities.
|
|
|
|
To enable Template sensors in your installation, add the following to your `configuration.yaml` file:
|
|
|
|
```yaml
|
|
# Example configuration.yaml entry
|
|
binary_sensor:
|
|
platform: template
|
|
sensors:
|
|
sun_up:
|
|
value_template: {% raw %}'{{ states.sun.sun.attributes.elevation > 0}}'{% endraw %}
|
|
friendly_name: 'Sun is up'
|
|
```
|
|
|
|
Configuration variables:
|
|
|
|
- **sensors** array (*Required*): List of your sensors.
|
|
- **friendly_name** (*Optional*): Name to use in the Frontend.
|
|
- **sensor_class** (*Optional*): Defines the class of the sensor (motion, heat, moisture, etc)
|
|
- **value_template** (*Optional*): Defines a [template](/topics/templating/) to extract a value from the payload.
|
|
|
|
|
|
## {% linkable_title Examples %}
|
|
|
|
In this section you find some real life examples of how to use this sensor.
|
|
|
|
### {% linkable_title Sensor threshold %}
|
|
|
|
This example indicates true if a sensor is above a given threshold. Assuming a sensor of `furnace` that provides a current reading for the fan motor, we can determine if the furnace is running by checking that it is over some threshold:
|
|
|
|
```yaml
|
|
sensor:
|
|
platform: template
|
|
sensors:
|
|
furnace_on:
|
|
value_template: {{ states.sensor.furnace.state > 2.5 }}
|
|
friendly_name: 'Furnace Running
|
|
sensor_class: heat
|
|
```
|