Update EnOcean docs

This commit is contained in:
Fabian Affolter 2016-08-24 13:12:51 +02:00
parent 1dff23cae3
commit 7fae02eaad
No known key found for this signature in database
GPG Key ID: DDF3D6F44AAB1336
4 changed files with 21 additions and 18 deletions

View File

@ -23,9 +23,12 @@ To use your EnOcean device, you first have to set up your [EnOcean hub](/compone
binary_sensor:
- platform: enocean
id: [0x01,0x90,0x84,0x3C]
name: Door
sensor_class: opening
```
Configuration variables:
- **id** (*Required*): The ID of the device. This is the 4 bytes long number written on the dimmer.
- **platform** (*Required*): Set to `enocean`.
- **name** (*Optional*): An identifier for the Ligh in the frontend.
- **sensor_class** (*Optional*): The [type/class](/components/binary_sensor/) of the sensor to set the icon in the frontend.

View File

@ -18,10 +18,10 @@ The `enocean` component adds support for some of these devices. You will need a
There is currently support for the following device types within Home Assistant:
- [Binary Sensor](../binary_sensor.enocean) (wall switches)
- [Sensor](../sensor.enocean) (power meters)
- [Light](../light.enocean) (dimmers)
- [Switch](../switch.enocean)
- [Binary Sensor](/components/binary_sensor.enocean/) (wall switches)
- [Sensor](/components/sensor.enocean/) (power meters)
- [Light](/components/light.enocean/) (dimmers)
- [Switch](/components/switch.enocean/)
However, only a few devices have been confirmed to work. These are:
@ -29,9 +29,9 @@ However, only a few devices have been confirmed to work. These are:
- Eltako FT55 battery-less wall switch
- Permundo PSC234 (switch and power monitor)
Other devices will most likely need some changes in the Home-Assistant code in order to work. Support for teaching of devices is also missing at this time.
Other devices will most likely need some changes in the Home Assistant code in order to work. Support for teaching of devices is also missing at this time.
# Configuration
To integrate an EnOcean controller with Home Assistant, add the following section to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
@ -39,5 +39,7 @@ enocean:
device: /dev/ttyUSB0
```
If no device is specified, the default will be **/dev/ttyUSB0**
Configuration variables:
- **device** (*Required*): The port where your device is connected to your Home Assistant host.

View File

@ -15,13 +15,13 @@ ha_release: 0.21
An EnOcean light can take many formes. Currently only one type has been tested: Eltako FUD61 dimmer.
To use your EnOcean device, you first have to set up your [EnOcean hub](../enocean) and then add the following to your `configuration.yaml` file:
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
light:
- name: Living_room
platform: enocean
- platform: enocean
name: Living_room
id: [0x01,0x90,0x84,0x3C]
sender_id: [0xFF,0xC6,0xEA,0x04]
```
@ -30,5 +30,4 @@ Configuration variables:
- **id** (*Required*): The ID of the device. This is the 4 bytes long number written on the dimmer.
- **sender_id** (*Required*): The Sender ID of the device. This is a 4 bytes long number.
- **platform** (*Required*): Set to `enocean`.
- **name** (*Required*): An identifier for the switch
- **name** (*Optional*): An identifier for the Ligh in the frontend.

View File

@ -15,18 +15,17 @@ ha_release: 0.21
An EnOcean switch can take many forms. Currently only one type has been tested: Permundo PSC234
To use your EnOcean device, you first have to set up your [EnOcean hub](../enocean) and then add the following to your `configuration.yaml` file:
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
switch:
- name: Television
platform: enocean
- platform: enocean
name: Front door
id: [0x01,0x90,0x84,0x3C]
```
Configuration variables:
- **id** (*Required*): The ID of the device. This is a 4 bytes long number.
- **platform** (*Required*): Set to `enocean`.
- **name** (*Required*): An identifier for the switch
- **name** (*Optional*): An identifier for the switch. Default to `EnOcean Switch`.