jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-23 17:27:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

Homogeneous description for RFLINK platform devices

Browse Source 
Correction of deprecated attributes
This commit is contained in:
javicalle 2018-10-28 16:33:18 +01:00
parent 7df3074f66
commit bc29dfae1d
5 changed files with 190 additions and 135 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
source/_components/binary_sensor.rflink.markdown
View File

@ -37,7 +37,7 @@ binary_sensor:
devices:
description: A list of binary sensors.
required: false
type: map
type: list
keys:
rflink_ids:
description: RFLink ID of the device
@ -45,15 +45,16 @@ devices:
type: map
keys:
name:
description: Name of the device, defaults to RFLink ID.
description: Name for the device.
required: false
default: Rflink ID
type: string
aliases:
description: Alternative RFLink ID's this device is known by.
required: false
type: list
device_class:
description: The [type or class of the sensor](/components/binary_sensor/) to set the icon in the frontend.
description: The [type or class of the sensor](/components/binary_sensor/#device-class) to set the icon in the frontend.
required: false
type: string
off_delay:

84
source/_components/cover.rflink.markdown
View File

@ -75,56 +75,62 @@ cover:
```
{% configuration %}
devices:
description: A list of devices with their name to use in the frontend.
required: false
type: list
keys:
name:
description: The name for the device. Defaults to value for Rflink ID.
required: false
type: string
aliases:
description: The alternative Rflink ID's this device is known by.
required: false
type: list
fire_event:
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.
description: The defaults for the devices.
required: false
type: list
type: map
keys:
fire_event:
description: The default `fire_event` for Rflink cover devices.
description: Set default `fire_event` for Rflink cover devices.
required: false
default: False
type: boolean
signal_repetitions:
description: The default `signal_repetitions` for Rflink cover devices.
description: Set default `signal_repetitions` for Rflink cover devices.
required: false
default: 1
type: integer
devices:
description: A list of covers.
required: false
type: list
keys:
rflink_ids:
description: RFLink ID of the device
required: true
type: map
keys:
name:
description: Name for the device.
required: false
default: Rflink ID
type: string
aliases:
description: Alternative Rflink ID's this device is known by.
required: false
type: [list, string]
fire_event:
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, string]
no_group_aliases:
description: The `aliases` which do not respond to group commands.
required: false
type: [list, string]
{% endconfiguration %}
### {% linkable_title Device support %}

99
source/_components/light.rflink.markdown
View File

@ -41,63 +41,82 @@ light:
device_defaults:
description: The defaults for the devices.
required: false
type: list
type: map
keys:
fire_event:
description: Set default `fire_event` for Rflink switch devices (see below).
required: false
default: False
type: boolean
signal_repetitions:
description: Set default `signal_repetitions` for Rflink switch devices (see below).
required: false
default: 1
type: integer
automatic_add:
description: Automatically add new/unconfigured devices to HA if detected.
description: Automatically add new/unconfigured devices to Home Assistant if detected.
required: false
default: true
type: boolean
devices:
description: A list of devices with their name to use in the frontend.
description: A list of lights.
required: false
type: list
keys:
name:
description: Name for the device.
required: false
default: Rflink ID
type: string
type:
description: "Override automatically detected type of the light device, can be: switchable, dimmable, hybrid or toggle. See 'Light Types' below."
required: false
default: switchable
type: string
aliases:
description: (deprecated) Alternative Rflink ID's this device is known by.
required: false
type: [list, string]
group_aliases:
description: "(deprecated) `aliases` which only respond to group commands."
required: false
type: [list, string]
no_group_aliases:
description: "(deprecated) `aliases` which do not respond to group commands."
required: false
type: [list, string]
fire_event:
description: Fire a `button_pressed` event if this device is turned on or off.
required: false
default: false
type: boolean
signal_repetitions:
description: Repeat every Rflink command this number of times.
required: false
default: 1
type: integer
group:
description: Allow light to respond to group commands (ALLON/ALLOFF).
required: false
default: true
type: boolean
rflink_ids:
description: RFLink ID of the device
required: true
type: map
keys:
name:
description: Name for the device.
required: false
default: Rflink ID
type: string
type:
description: Override automatically detected type of the light device, can be: switchable, dimmable, hybrid or toggle. See [Light Types](components/light.rflink/#light-types) below.
required: false
default: switchable
type: string
aliases:
description: Alternative Rflink ID's this device is known by.
required: false
type: [list, string]
group_aliases:
description: "`aliases` which only respond to group commands."
required: false
type: [list, string]
no_group_aliases:
description: "`aliases` which do not respond to group commands."
required: false
type: [list, string]
fire_event:
description: Fire a `button_pressed` event if this device is turned on or off.
required: false
default: false
type: boolean
signal_repetitions:
description: Repeat every Rflink command this number of times.
required: false
default: 1
type: integer
group:
description: Allow light to respond to group commands (ALLON/ALLOFF).
required: false
default: true
type: boolean
aliasses:
description: (**deprecated**) Alternative Rflink ID's this device is known by.
required: false
type: [list, string]
group_aliasses:
description: "(**deprecated**) `aliases` which only respond to group commands."
required: false
type: [list, string]
no_group_aliasses:
description: "(**deprecated**) `aliases` which do not respond to group commands."
required: false
type: [list, string]
{% endconfiguration %}
### {% linkable_title Light state %}

45
source/_components/sensor.rflink.markdown
View File

@ -41,29 +41,40 @@ automatic_add:
default: true
type: boolean
devices:
description: A list of devices with their name to use in the frontend.
description: A list of sensors.
required: false
type: list
keys:
name:
description: Name for the device.
required: false
default: RFLink ID
type: string
sensor_type:
description: Override automatically detected type of sensor. For list of values see below.
rflink_ids:
description: RFLink ID of the device
required: true
type: string
unit_of_measurement:
description: Override automatically detected unit of sensor.
required: false
type: string
aliases:
description: "(deprecated) Alternative RFLink ID's this device is known by."
required: false
type: [list, string]
type: map
keys:
name:
description: Name for the device.
required: false
default: RFLink ID
type: string
sensor_type:
description: Override automatically detected type of sensor. For list of [values](components/sensor.rflink/#sensors-types) see below.
required: true
type: string
unit_of_measurement:
description: Override automatically detected unit of sensor.
required: false
type: string
aliases:
description: "Alternative RFLink ID's this device is known by."
required: false
type: [list, string]
aliasses:
description: "(**deprecated**) Alternative RFLink ID's this device is known by."
required: false
type: [list, string]
{% endconfiguration %}
### {% linkable_title Sensors types%}
Sensor type values:
- average_windspeed

90
source/_components/switch.rflink.markdown
View File

@ -41,55 +41,74 @@ switch:
{% configuration %}
device_defaults:
description: The defaults for all listed devices.
description: The defaults for the devices.
required: false
type: list
type: map
keys:
fire_event:
description: Set default `fire_event` for Rflink switch devices (see below).
required: false
default: False
type: boolean
signal_repetitions:
description: Set default `signal_repetitions` for Rflink switch devices (see below).
required: false
default: 1
type: integer
devices:
description: A list of devices with their name to use in the frontend.
description: A list of switches.
required: false
type: list
keys:
name:
description: Name for the device.
required: false
default: Rflink ID
type: string
aliases:
description: (deprecated) Alternative Rflink ID's this device is known by.
required: false
type: [list, string]
group_aliases:
description: "(deprecated) `aliases` which only respond to group commands."
required: false
type: [list, string]
no_group_aliases:
description: "(deprecated) `aliases` which do not respond to group commands."
required: false
type: [list, string]
fire_event:
description: Fire a `button_pressed` event if this device is turned on or off.
required: false
default: false
type: boolean
signal_repetitions:
description: Set default `signal_repetitions` for RFLink switch devices (see below).
required: false
default: 1
type: integer
group:
description: Allow light to respond to group commands (ALLON/ALLOFF).
required: false
default: true
type: boolean
rflink_ids:
description: RFLink ID of the device
required: true
type: map
keys:
name:
description: Name for the device.
required: false
default: Rflink ID
type: string
aliases:
description: Alternative Rflink ID's this device is known by.
required: false
type: [list, string]
group_aliases:
description: "`aliases` which only respond to group commands."
required: false
type: [list, string]
no_group_aliases:
description: "`aliases` which do not respond to group commands."
required: false
type: [list, string]
fire_event:
description: Fire a `button_pressed` event if this device is turned on or off.
required: false
default: false
type: boolean
signal_repetitions:
description: Set default `signal_repetitions` for RFLink switch devices (see below).
required: false
default: 1
type: integer
group:
description: Allow light to respond to group commands (ALLON/ALLOFF).
required: false
default: true
type: boolean
aliases:
description: "(**deprecated**) Alternative Rflink ID's this device is known by."
required: false
type: [list, string]
group_aliases:
description: "(**deprecated**) `aliases` which only respond to group commands."
required: false
type: [list, string]
no_group_aliases:
description: "(**deprecated**) `aliases` which do not respond to group commands."
required: false
type: [list, string]
{% endconfiguration %}
### {% linkable_title Switch state %}
@ -105,7 +124,6 @@ switch:
devices:
newkaku_0000c6c2_1:
name: Ceiling fan
icon: mdi:fan
aliases:
- newkaku_000000001_2
- kaku_000001_a