Update Enocean component configuration variable (#6728)

* Update Enocean component configuration variable

* Minor update
This commit is contained in:
Klaas Schoute 2018-10-13 00:05:58 +02:00 committed by Fabian Affolter
parent f9c3aa9b1d
commit 18a734a04d
5 changed files with 65 additions and 25 deletions

View File

@ -30,11 +30,21 @@ binary_sensor:
id: [0x01,0x90,0x84,0x3C]
```
Configuration variables:
- **id** (*Required*): The ID of the device. This is the 4 bytes long number written on the dimmer.
- **name** (*Optional*): An identifier for the switch in the frontend.
- **device_class** (*Optional*): The [type/class](/components/binary_sensor/) of the sensor to set the icon in the frontend.
{% 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
default: EnOcean binary sensor
type: string
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:

View File

@ -41,6 +41,9 @@ enocean:
device: /dev/ttyUSB0
```
Configuration variables:
- **device** (*Required*): The port where your device is connected to your Home Assistant host.
{% configuration %}
device:
description: The port where your device is connected to your Home Assistant host.
required: true
type: string
{% endconfiguration %}

View File

@ -26,8 +26,18 @@ light:
sender_id: [0xFF,0xC6,0xEA,0x04]
```
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.
- **name** (*Optional*): An identifier for the Ligh in the frontend.
{% configuration %}
id:
description: The ID of the device. This is the 4 bytes long number written on the dimmer.
required: true
type: list
sender_id:
description: The Sender ID of the device. This is a 4 bytes long number.
required: true
type: list
name:
description: An identifier for the Ligh in the frontend.
required: false
default: EnOcean Light
type: string
{% endconfiguration %}

View File

@ -21,13 +21,19 @@ To use your EnOcean device, you first have to set up your [EnOcean hub](../enoce
```yaml
# Example configuration.yaml entry
sensor:
- name: Television
platform: enocean
- platform: enocean
name: Television
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
{% configuration %}
id:
description: The ID of the device. This is a 4 bytes long number.
required: true
type: list
name:
description: An identifier for the switch
required: true
default: EnOcean sensor
type: string
{% endconfiguration %}

View File

@ -24,11 +24,22 @@ switch:
id: [0x01,0x90,0x84,0x3C]
```
Configuration variables:
- **id** (*Required*): The ID of the device. This is a 4 bytes long number.
- **name** (*Optional*): An identifier for the switch. Default to `EnOcean Switch`.
- **channel** (*Optional*): The number of the channel (typically 0 or 1) for the output channel to switch. Default to `0`.
{% configuration %}
id:
description: The ID of the device. This is a 4 bytes long number.
required: true
type: list
name:
description: An identifier for the switch.
required: false
default: EnOcean Switch
type: string
channel:
description: The number of the channel (typically 0 or 1) for the output channel to switch.
required: false
default: 0
type: integer
{% endconfiguration %}
```yaml
# Example entries for a switch with 2 outputs (channels), e.g., the Nod On SIN-2-1-01