Update Documentation for 'rflink' Cover Component Configuration (#7036)

* Update Documentation for 'rflink' Cover Component Configuration

* Minor changes

* According to the code it's a list
This commit is contained in:
vaidyasm 2018-10-24 04:21:36 +05:45 committed by Fabian Affolter
parent ebaa4012f7
commit 6be57834a5

View File

@ -25,17 +25,18 @@ You have to add the Somfy RTS manually with the supplied RFlinkLoader (Windows o
Press the Learn button on the original Somfy remote enter the following code within 3 seconds. Your blinds will go up and down shortly: Press the Learn button on the original Somfy remote enter the following code within 3 seconds. Your blinds will go up and down shortly:
```` ```text
10;RTS;02FFFF;0412;3;PAIR; 10;RTS;02FFFF;0412;3;PAIR;
```` ```
Your blinds will go up and down again. This means your Rflink is now paired with your RTS motor. Your blinds will go up and down again. This means your Rflink is now paired with your RTS motor.
To check this enter the following code again and see if there is a record. To check this enter the following code again and see if there is a record.
```` ```text
10;RTSSHOW; 10;RTSSHOW;
```` ```
````
```text
RTS Record: 0 Address: FFFFFF RC: FFFF RTS Record: 0 Address: FFFFFF RC: FFFF
RTS Record: 1 Address: FFFFFF RC: FFFF RTS Record: 1 Address: FFFFFF RC: FFFF
RTS Record: 2 Address: FFFFFF RC: FFFF RTS Record: 2 Address: FFFFFF RC: FFFF
@ -52,7 +53,7 @@ RTS Record: 12 Address: FFFFFF RC: FFFF
RTS Record: 13 Address: FFFFFF RC: FFFF RTS Record: 13 Address: FFFFFF RC: FFFF
RTS Record: 14 Address: FFFFFF RC: FFFF RTS Record: 14 Address: FFFFFF RC: FFFF
RTS Record: 15 Address: FFFFFF RC: FFFF RTS Record: 15 Address: FFFFFF RC: FFFF
```` ```
After configuring the RFLink Somfy RTS you have to add the cover to the `configuration.yaml` file like any other RFlink device. After configuring the RFLink Somfy RTS you have to add the cover to the `configuration.yaml` file like any other RFlink device.
@ -73,25 +74,59 @@ cover:
name: Sovrumsgardin name: Sovrumsgardin
``` ```
Configuration variables: {% configuration %}
devices:
- **devices** (*Optional*): A list of devices with their name to use in the frontend. description: A list of devices with their name to use in the frontend.
- **device_defaults**: (*Optional*) required: false
- **fire_event** (*Optional*): Set default `fire_event` for Rflink switch devices (see below). type: list
- **signal_repetitions** (*Optional*): Set default `signal_repetitions` for Rflink switch devices (see below). keys:
name:
Device configuration variables: description: The name for the device. Defaults to value for Rflink ID.
required: false
- **name** (*Optional*): Name for the device, defaults to Rflink ID. type: string
- **aliases** (*Optional*): Alternative Rflink ID's this device is known by. aliases:
- **fire_event** (*Optional*): Fire a `button_pressed` event if this device is turned on or off (default: False). description: The alternative Rflink ID's this device is known by.
- **signal_repetitions** (*Optional*): Repeat every Rflink command this number of times (default: 1). required: false
- **group** (*Optional*): Allow light to respond to group commands (ALLON/ALLOFF). (default: yes) type: list
- **group_aliases** (*Optional*): `aliases` which only respond to group commands. fire_event:
- **no_group_aliases** (*Optional*): `aliases` which do not respond to group commands. description: Fire a `button_pressed` event if this device is turned on or off.
required: false
default: False
type: boolean
signal_repetitions:
description: The number of times every Rflink command should repeat.
required: false
type: integer
group:
description: Allow light to respond to group commands (ALLON/ALLOFF).
required: false
default: True
type: boolean
group_aliases:
description: The `aliases` which only respond to group commands.
required: false
type: list
no_group_aliases:
description: The `aliases` which do not respond to group commands.
required: false
type: list
device_defaults:
description: The default values for a device.
required: false
type: list
keys:
fire_event:
description: The default `fire_event` for Rflink cover devices.
required: false
default: False
type: boolean
signal_repetitions:
description: The default `signal_repetitions` for Rflink cover devices.
required: false
default: 1
type: integer
{% endconfiguration %}
### {% linkable_title Device support %} ### {% linkable_title Device support %}
See [device support](/components/rflink/#device-support) See [device support](/components/rflink/#device-support).