mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-05-03 01:28:58 +00:00
77 lines
2.5 KiB
Markdown
77 lines
2.5 KiB
Markdown
---
|
|
layout: page
|
|
title: "EnOcean Binary Sensor"
|
|
description: "Instructions on how to set up EnOcean binary sensors within Home Assistant."
|
|
date: 2016-05-25 23:49
|
|
sidebar: true
|
|
comments: false
|
|
sharing: true
|
|
footer: true
|
|
logo: enocean.png
|
|
ha_category: Binary Sensor
|
|
ha_release: 0.21
|
|
ha_iot_class: "Local Push"
|
|
---
|
|
|
|
This can typically be one of those batteryless wall switches.
|
|
Tested with:
|
|
|
|
- Eltako FT55 which uses the EnOcean PTM 215 module
|
|
- [TRIO2SYS Wall switches](http://www.trio2sys.fr/index.php/fr/produits-enocean-sans-fil-sans-pile-interoperable/emetteur-sans-fils-sans-pile-interoperable-enocean) which uses the EnOcean PTM210 DB module
|
|
|
|
All switches using theses modules are expected to work. Other devices will most likely not work without changing the Home Assistant code.
|
|
|
|
## {% linkable_title Configuration %}
|
|
|
|
To use your EnOcean device, you first have to set up your [EnOcean hub](/components/enocean/) and then add the following to your `configuration.yaml` file:
|
|
|
|
```yaml
|
|
# Example configuration.yaml entry
|
|
binary_sensor:
|
|
- platform: enocean
|
|
id: [0x01,0x90,0x84,0x3C]
|
|
```
|
|
|
|
{% configuration %}
|
|
id:
|
|
description: The ID of the device. This is the 4 bytes long number written on the dimmer.
|
|
required: true
|
|
type: list
|
|
name:
|
|
description: An identifier for the switch in the frontend.
|
|
required: false
|
|
type: string
|
|
default: EnOcean binary sensor
|
|
device_class:
|
|
description: The [type/class](/components/binary_sensor/) of the sensor to set the icon in the frontend.
|
|
required: false
|
|
type: device_class
|
|
{% endconfiguration %}
|
|
|
|
EnOcean binary sensors only generate 'button_pressed' events. The event data has following four fields:
|
|
|
|
- **id**: The ID of the device (see configuration).
|
|
- **pushed**: `1` for a button press, `0` for a button release.
|
|
- **which**: Always `0` when using the single rocket. `0` or `1` when using the dual rocket switch.
|
|
- **onoff**: `0` or `1` for either side of the rocket.
|
|
|
|
## {% linkable_title Automation example %}
|
|
|
|
Sample automation to switch lights on and off:
|
|
|
|
```yaml
|
|
# Example automation to turn lights on/off on button release
|
|
automation:
|
|
- alias: hall light switches
|
|
trigger:
|
|
platform: event
|
|
event_type: button_pressed
|
|
event_data:
|
|
id: [0xYY, 0xYY, 0xYY, 0xYY]
|
|
pushed: 0
|
|
action:
|
|
service_template: "{% raw %}{% if trigger.event.data.onoff %} light.turn_on {% else %} light.turn_off {%endif %}{% endraw %}"
|
|
data_template:
|
|
entity_id: "{% raw %}{% if trigger.event.data.which == 1 %} light.hall_left {% else %} light.hall_right {%endif %}{% endraw %}"
|
|
```
|