mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-27 03:07:14 +00:00
Merge pull request #7200 from javicalle/current
RFLink devices documentation
This commit is contained in:
DubhAd
GitHub
commit
f492bfdd5a
@ -13,7 +13,7 @@ ha_iot_class: "Local Push"
|
|||||||
ha_release: "0.81"
|
ha_release: "0.81"
|
||||||
---
|
---
|
||||||
|
|
||||||
The `rflink` component supports devices that use [RFLink gateway firmware](http://www.nemcon.nl/blog2/), for example, the [Nodo RFLink Gateway](https://www.nodo-shop.nl/nl/21-rflink-gateway). RFLink gateway is an Arduino firmware that allows two-way communication with a multitude of RF wireless devices using cheap hardware (Arduino + transceiver).
|
The `rflink` component supports devices that use [RFLink gateway firmware](http://www.nemcon.nl/blog2/), for example the [Nodo RFLink Gateway](https://www.nodo-shop.nl/nl/21-rflink-gateway). RFLink gateway is an Arduino firmware that allows two-way communication with a multitude of RF wireless devices using cheap hardware (Arduino + transceiver).
|
||||||
|
|
||||||
First, you have to set up your [RFLink hub](/components/rflink/).
|
First, you have to set up your [RFLink hub](/components/rflink/).
|
||||||
|
|
||||||
@ -37,7 +37,7 @@ binary_sensor:
|
|||||||
devices:
|
devices:
|
||||||
description: A list of binary sensors.
|
description: A list of binary sensors.
|
||||||
required: false
|
required: false
|
||||||
type: map
|
type: list
|
||||||
keys:
|
keys:
|
||||||
rflink_ids:
|
rflink_ids:
|
||||||
description: RFLink ID of the device
|
description: RFLink ID of the device
|
||||||
@ -45,15 +45,16 @@ devices:
|
|||||||
type: map
|
type: map
|
||||||
keys:
|
keys:
|
||||||
name:
|
name:
|
||||||
description: Name of the device, defaults to RFLink ID.
|
description: Name for the device.
|
||||||
required: false
|
required: false
|
||||||
|
default: RFLink ID
|
||||||
type: string
|
type: string
|
||||||
aliases:
|
aliases:
|
||||||
description: Alternative RFLink ID's this device is known by.
|
description: Alternative RFLink ID's this device is known by.
|
||||||
required: false
|
required: false
|
||||||
type: list
|
type: list
|
||||||
device_class:
|
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
|
required: false
|
||||||
type: string
|
type: string
|
||||||
off_delay:
|
off_delay:
|
||||||
|
|||||||
@ -13,11 +13,11 @@ ha_release: 0.55
|
|||||||
---
|
---
|
||||||
|
|
||||||
|
|
||||||
The `rflink` cover platform supports devices that use [RFLink gateway firmware](http://www.nemcon.nl/blog2/), for example, the [Nodo RFLink Gateway](https://www.nodo-shop.nl/nl/21-rflink-gateway). RFLink gateway is an Arduino firmware that allows two-way communication with a multitude of RF wireless devices using cheap hardware (Arduino + transceiver).
|
The `rflink` component supports devices that use [RFLink gateway firmware](http://www.nemcon.nl/blog2/), for example the [Nodo RFLink Gateway](https://www.nodo-shop.nl/nl/21-rflink-gateway). RFLink gateway is an Arduino firmware that allows two-way communication with a multitude of RF wireless devices using cheap hardware (Arduino + transceiver).
|
||||||
|
|
||||||
First, you have to set up your [rflink hub](/components/rflink/).
|
First, you have to set up your [RFLink hub](/components/rflink/).
|
||||||
|
|
||||||
After configuring the RFLink hub covers will be automatically discovered and added. Except the Somfy RTS devices.
|
After configuring the RFLink hub, covers will be automatically discovered and added. Except the Somfy RTS devices.
|
||||||
|
|
||||||
### {% linkable_title Setting up a Somfy RTS device %}
|
### {% linkable_title Setting up a Somfy RTS device %}
|
||||||
|
|
||||||
@ -29,7 +29,7 @@ Press the Learn button on the original Somfy remote enter the following code wit
|
|||||||
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
|
```text
|
||||||
@ -61,72 +61,105 @@ RFLink cover ID's are composed of: protocol, id, and gateway. For example: `RTS_
|
|||||||
|
|
||||||
Once the ID of a cover is known, it can be used to configure the cover in Home Assistant, for example, to add it to a different group, hide it or set a nice name.
|
Once the ID of a cover is known, it can be used to configure the cover in Home Assistant, for example, to add it to a different group, hide it or set a nice name.
|
||||||
|
|
||||||
Assigning a name to a cover:
|
Configuring devices as a cover:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
cover:
|
cover:
|
||||||
- platform: rflink
|
- platform: rflink
|
||||||
devices:
|
devices:
|
||||||
RTS_0100F2_0:
|
RTS_0100F2_0: {}
|
||||||
name: SunShade
|
bofumotor_455201_0f: {}
|
||||||
bofumotor_455201_0f:
|
|
||||||
name: Sovrumsgardin
|
|
||||||
```
|
```
|
||||||
|
|
||||||
{% configuration %}
|
{% 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:
|
device_defaults:
|
||||||
description: The default values for a device.
|
description: The defaults for the devices.
|
||||||
required: false
|
required: false
|
||||||
type: list
|
type: map
|
||||||
keys:
|
keys:
|
||||||
fire_event:
|
fire_event:
|
||||||
description: The default `fire_event` for Rflink cover devices.
|
description: Set default `fire_event` for RFLink cover devices.
|
||||||
required: false
|
required: false
|
||||||
default: false
|
default: false
|
||||||
type: boolean
|
type: boolean
|
||||||
signal_repetitions:
|
signal_repetitions:
|
||||||
description: The default `signal_repetitions` for Rflink cover devices.
|
description: Set default `signal_repetitions` for RFLink cover devices.
|
||||||
required: false
|
required: false
|
||||||
default: 1
|
default: 1
|
||||||
type: integer
|
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 %}
|
{% endconfiguration %}
|
||||||
|
|
||||||
### {% linkable_title Device support %}
|
### {% linkable_title Device support %}
|
||||||
|
|
||||||
See [device support](/components/rflink/#device-support).
|
See [device support](/components/rflink/#device-support).
|
||||||
|
|
||||||
|
### {% linkable_title Additional configuration examples %}
|
||||||
|
|
||||||
|
Multiple covers with custom names and aliases
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
# Example configuration.yaml entry
|
||||||
|
cover:
|
||||||
|
- platform: rflink
|
||||||
|
devices:
|
||||||
|
RTS_0A8720_0:
|
||||||
|
name: enanos
|
||||||
|
aliases:
|
||||||
|
- rts_31e53f_01
|
||||||
|
- rts_32e53f_01
|
||||||
|
RTS_30E542_0:
|
||||||
|
name: comedor
|
||||||
|
aliases:
|
||||||
|
- rts_33e53f_01
|
||||||
|
- rts_fa872e_01
|
||||||
|
RTS_33E542_0:
|
||||||
|
name: dormitorio
|
||||||
|
aliases:
|
||||||
|
- rts_30e53f_01
|
||||||
|
- rts_32e53f_01
|
||||||
|
RTS_32E542_0:
|
||||||
|
name: habitaciones
|
||||||
|
fire_event: true
|
||||||
|
```
|
||||||
@ -13,91 +13,109 @@ ha_release: 0.38
|
|||||||
ha_iot_class: "Assumed state"
|
ha_iot_class: "Assumed state"
|
||||||
---
|
---
|
||||||
|
|
||||||
The `rflink` component support devices that use [RFLink gateway firmware](http://www.nemcon.nl/blog2/), for example the [Nodo RFLink Gateway](https://www.nodo-shop.nl/nl/21-rflink-gateway). RFLink gateway is an Arduino firmware that allows two-way communication with a multitude of RF wireless devices using cheap hardware (Arduino + transceiver).
|
The `rflink` component supports devices that use [RFLink gateway firmware](http://www.nemcon.nl/blog2/), for example the [Nodo RFLink Gateway](https://www.nodo-shop.nl/nl/21-rflink-gateway). RFLink gateway is an Arduino firmware that allows two-way communication with a multitude of RF wireless devices using cheap hardware (Arduino + transceiver).
|
||||||
|
|
||||||
First you have to set up your [rflink hub](/components/rflink/).
|
First, you have to set up your [RFLink hub](/components/rflink/).
|
||||||
|
|
||||||
After configuring the RFLink hub lights will be automatically discovered and added.
|
After configuring the RFLink hub, lights will be automatically discovered and added.
|
||||||
|
|
||||||
RFLink switch/light ID's are composed of: protocol, id, switch. For example: `newkaku_0000c6c2_1`.
|
RFLink binary_sensor/switch/light ID's are composed of: protocol, id, switch/channel. For example: `newkaku_0000c6c2_1`.
|
||||||
|
|
||||||
Once the ID of a light is known it can be used to configure the light in HA, for example to add it to a different group, hide it or configure a nice name.
|
Once the ID of a light is known, it can be used to configure the light in HA, for example to add it to a different group, hide it or configure a nice name.
|
||||||
|
|
||||||
Configuring a device as light with a nice name:
|
Configuring devices as a light:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
light:
|
light:
|
||||||
- platform: rflink
|
- platform: rflink
|
||||||
device_defaults:
|
|
||||||
fire_event: true
|
|
||||||
signal_repetitions: 2
|
|
||||||
devices:
|
devices:
|
||||||
newkaku_0000c6c2_1:
|
NewKaku_02a48800_0: {}
|
||||||
name: Living room
|
newkaku_0000c6c2_1: {}
|
||||||
|
Ansluta_ce30_0: {}
|
||||||
|
Maclean_0d82_01: {}
|
||||||
```
|
```
|
||||||
|
|
||||||
{% configuration %}
|
{% configuration %}
|
||||||
device_defaults:
|
device_defaults:
|
||||||
description: The defaults for the devices.
|
description: The defaults for the devices.
|
||||||
required: false
|
required: false
|
||||||
type: list
|
type: map
|
||||||
keys:
|
keys:
|
||||||
fire_event:
|
fire_event:
|
||||||
description: Set default `fire_event` for Rflink switch devices (see below).
|
description: Set default `fire_event` for RFLink switch devices (see below).
|
||||||
required: false
|
required: false
|
||||||
|
default: False
|
||||||
type: boolean
|
type: boolean
|
||||||
signal_repetitions:
|
signal_repetitions:
|
||||||
description: Set default `signal_repetitions` for Rflink switch devices (see below).
|
description: Set default `signal_repetitions` for RFLink switch devices (see below).
|
||||||
required: false
|
required: false
|
||||||
|
default: 1
|
||||||
type: integer
|
type: integer
|
||||||
automatic_add:
|
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
|
required: false
|
||||||
default: true
|
default: true
|
||||||
type: boolean
|
type: boolean
|
||||||
devices:
|
devices:
|
||||||
description: A list of devices with their name to use in the frontend.
|
description: A list of lights.
|
||||||
required: false
|
required: false
|
||||||
type: list
|
type: list
|
||||||
keys:
|
keys:
|
||||||
name:
|
rflink_ids:
|
||||||
description: Name for the device.
|
description: RFLink ID of the device
|
||||||
required: false
|
required: true
|
||||||
default: Rflink ID
|
type: map
|
||||||
type: string
|
keys:
|
||||||
type:
|
name:
|
||||||
description: "Override automatically detected type of the light device, can be: switchable, dimmable, hybrid or toggle. See 'Light Types' below."
|
description: Name for the device.
|
||||||
required: false
|
required: false
|
||||||
default: switchable
|
default: RFLink ID
|
||||||
type: string
|
type: string
|
||||||
aliases:
|
type:
|
||||||
description: (deprecated) Alternative Rflink ID's this device is known by.
|
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
|
required: false
|
||||||
type: [list, string]
|
default: switchable
|
||||||
group_aliases:
|
type: string
|
||||||
description: "(deprecated) `aliases` which only respond to group commands."
|
aliases:
|
||||||
required: false
|
description: Alternative RFLink ID's this device is known by.
|
||||||
type: [list, string]
|
required: false
|
||||||
no_group_aliases:
|
type: [list, string]
|
||||||
description: "(deprecated) `aliases` which do not respond to group commands."
|
group_aliases:
|
||||||
required: false
|
description: "`aliases` which only respond to group commands."
|
||||||
type: [list, string]
|
required: false
|
||||||
fire_event:
|
type: [list, string]
|
||||||
description: Fire a `button_pressed` event if this device is turned on or off.
|
no_group_aliases:
|
||||||
required: false
|
description: "`aliases` which do not respond to group commands."
|
||||||
default: false
|
required: false
|
||||||
type: boolean
|
type: [list, string]
|
||||||
signal_repetitions:
|
fire_event:
|
||||||
description: Repeat every Rflink command this number of times.
|
description: Fire a `button_pressed` event if this device is turned on or off.
|
||||||
required: false
|
required: false
|
||||||
default: 1
|
default: false
|
||||||
type: integer
|
type: boolean
|
||||||
group:
|
signal_repetitions:
|
||||||
description: Allow light to respond to group commands (ALLON/ALLOFF).
|
description: Repeat every RFLink command this number of times.
|
||||||
required: false
|
required: false
|
||||||
default: true
|
default: 1
|
||||||
type: boolean
|
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 %}
|
{% endconfiguration %}
|
||||||
|
|
||||||
### {% linkable_title Light state %}
|
### {% linkable_title Light state %}
|
||||||
@ -112,14 +130,9 @@ light:
|
|||||||
- platform: rflink
|
- platform: rflink
|
||||||
devices:
|
devices:
|
||||||
newkaku_0000c6c2_1:
|
newkaku_0000c6c2_1:
|
||||||
name: Living room
|
|
||||||
aliases:
|
aliases:
|
||||||
- newkaku_000000001_2
|
- newkaku_000000001_2
|
||||||
- kaku_000001_a
|
- kaku_000001_a
|
||||||
Ansluta_ce30_0:
|
|
||||||
name: Kitchen Under Counter Lights
|
|
||||||
Maclean_0d82_01:
|
|
||||||
name: Bedroom Lamp
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Any on/off command from any alias ID updates the current state of the light. However when sending a command through the frontend only the primary ID is used.
|
Any on/off command from any alias ID updates the current state of the light. However when sending a command through the frontend only the primary ID is used.
|
||||||
@ -146,3 +159,30 @@ Lights are added automatically when the RFLink gateway intercepts a wireless com
|
|||||||
### {% linkable_title Device support %}
|
### {% linkable_title Device support %}
|
||||||
|
|
||||||
See [device support](/components/rflink/#device-support)
|
See [device support](/components/rflink/#device-support)
|
||||||
|
|
||||||
|
### {% linkable_title Additional configuration examples %}
|
||||||
|
|
||||||
|
Multiple lights with `signal_repetitions` and custom names
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
# Example configuration.yaml entry
|
||||||
|
light:
|
||||||
|
- platform: rflink
|
||||||
|
device_defaults:
|
||||||
|
fire_event: true
|
||||||
|
signal_repetitions: 2
|
||||||
|
automatic_add: true
|
||||||
|
devices:
|
||||||
|
NewKaku_02a48800_0:
|
||||||
|
name: Kitchen
|
||||||
|
type: hybrid
|
||||||
|
newkaku_0000c6c2_1:
|
||||||
|
name: Living room
|
||||||
|
aliases:
|
||||||
|
- newkaku_000000001_2
|
||||||
|
- kaku_000001_a
|
||||||
|
Ansluta_ce30_0:
|
||||||
|
name: Kitchen Under Counter Lights
|
||||||
|
Maclean_0d82_01:
|
||||||
|
name: Bedroom Lamp
|
||||||
|
```
|
||||||
@ -13,25 +13,24 @@ ha_release: 0.38
|
|||||||
ha_iot_class: "Local Polling"
|
ha_iot_class: "Local Polling"
|
||||||
---
|
---
|
||||||
|
|
||||||
The `rflink` component support devices that use [RFLink gateway firmware](http://www.nemcon.nl/blog2/), for example the [Nodo RFLink Gateway](https://www.nodo-shop.nl/nl/21-rflink-gateway). RFLink gateway is an Arduino firmware that allows two-way communication with a multitude of RF wireless devices using cheap hardware (Arduino + transceiver).
|
The `rflink` component supports devices that use [RFLink gateway firmware](http://www.nemcon.nl/blog2/), for example the [Nodo RFLink Gateway](https://www.nodo-shop.nl/nl/21-rflink-gateway). RFLink gateway is an Arduino firmware that allows two-way communication with a multitude of RF wireless devices using cheap hardware (Arduino + transceiver).
|
||||||
|
|
||||||
First you have to set up your [rflink hub](/components/rflink/).
|
First, you have to set up your [RFLink hub](/components/rflink/).
|
||||||
|
|
||||||
After configuring the RFLink hub sensors will be automatically discovered and added.
|
After configuring the RFLink hub, sensors will be automatically discovered and added.
|
||||||
|
|
||||||
RFLink sensor ID's are composed of: protocol, id and type (optional). For example: `alectov1_0334_temp`. Some sensors emit multiple types of data. Each will be created as its own
|
RFLink sensor ID's are composed of: protocol, id and type (optional). For example: `alectov1_0334_temp`. Some sensors emit multiple types of data. Each will be created as its own.
|
||||||
|
|
||||||
Once the ID of a sensor is known it can be used to configure the sensor in HA, for example to add it to a different group, hide it or configure a nice name.
|
Once the ID of a sensor is known, it can be used to configure the sensor in Home Assistant, for example to add it to a different group, hide it or configure a nice name.
|
||||||
|
|
||||||
Assigning name to a sensor:
|
Configuring a device as a sensor:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
sensor:
|
sensor:
|
||||||
- platform: rflink
|
- platform: rflink
|
||||||
devices:
|
devices:
|
||||||
alectov1_0334_temp:
|
alectov1_0334_temp: {}
|
||||||
sensor_type: temperature
|
|
||||||
```
|
```
|
||||||
|
|
||||||
{% configuration %}
|
{% configuration %}
|
||||||
@ -41,29 +40,40 @@ automatic_add:
|
|||||||
default: true
|
default: true
|
||||||
type: boolean
|
type: boolean
|
||||||
devices:
|
devices:
|
||||||
description: A list of devices with their name to use in the frontend.
|
description: A list of sensors.
|
||||||
required: false
|
required: false
|
||||||
type: list
|
type: list
|
||||||
keys:
|
keys:
|
||||||
name:
|
rflink_ids:
|
||||||
description: Name for the device.
|
description: RFLink ID of the device
|
||||||
required: false
|
|
||||||
default: RFLink ID
|
|
||||||
type: string
|
|
||||||
sensor_type:
|
|
||||||
description: Override automatically detected type of sensor. For list of values see below.
|
|
||||||
required: true
|
required: true
|
||||||
type: string
|
type: map
|
||||||
unit_of_measurement:
|
keys:
|
||||||
description: Override automatically detected unit of sensor.
|
name:
|
||||||
required: false
|
description: Name for the device.
|
||||||
type: string
|
required: false
|
||||||
aliases:
|
default: RFLink ID
|
||||||
description: "(deprecated) Alternative RFLink ID's this device is known by."
|
type: string
|
||||||
required: false
|
sensor_type:
|
||||||
type: [list, string]
|
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 %}
|
{% endconfiguration %}
|
||||||
|
|
||||||
|
### {% linkable_title Sensors types%}
|
||||||
|
|
||||||
Sensor type values:
|
Sensor type values:
|
||||||
|
|
||||||
- average_windspeed
|
- average_windspeed
|
||||||
@ -110,3 +120,32 @@ Sensors are added automatically when the RFLink gateway intercepts a wireless co
|
|||||||
### {% linkable_title Device support %}
|
### {% linkable_title Device support %}
|
||||||
|
|
||||||
See [device support](/components/rflink/#device-support)
|
See [device support](/components/rflink/#device-support)
|
||||||
|
|
||||||
|
### {% linkable_title Additional configuration examples %}
|
||||||
|
|
||||||
|
Multiple sensors with `automatic_add` disabled and `aliases`
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
# Example configuration.yaml entry
|
||||||
|
sensor:
|
||||||
|
- platform: rflink
|
||||||
|
automatic_add: false
|
||||||
|
devices:
|
||||||
|
oregontemp_0d93_temp:
|
||||||
|
sensor_type: temperature
|
||||||
|
oregontemp_0d93_bat:
|
||||||
|
sensor_type: battery
|
||||||
|
tunex_c001_temp:
|
||||||
|
sensor_type: temperature
|
||||||
|
aliases:
|
||||||
|
- xiron_4001_temp
|
||||||
|
tunex_c001_hum:
|
||||||
|
sensor_type: humidity
|
||||||
|
aliases:
|
||||||
|
- xiron_4001_hum
|
||||||
|
tunex_c001_bat:
|
||||||
|
sensor_type: battery
|
||||||
|
aliases:
|
||||||
|
- xiron_4001_bat
|
||||||
|
```
|
||||||
|
|
||||||
|
|||||||
@ -12,85 +12,97 @@ ha_category: Switch
|
|||||||
ha_release: 0.38
|
ha_release: 0.38
|
||||||
---
|
---
|
||||||
|
|
||||||
The `rflink` component support devices that use [RFLink gateway firmware](http://www.nemcon.nl/blog2/), for example, the [Nodo RFLink Gateway](https://www.nodo-shop.nl/nl/21-rflink-gateway). RFLink gateway is an Arduino firmware that allows two-way communication with a multitude of RF wireless devices using cheap hardware (Arduino + transceiver).
|
The `rflink` component supports devices that use [RFLink gateway firmware](http://www.nemcon.nl/blog2/), for example, the [Nodo RFLink Gateway](https://www.nodo-shop.nl/nl/21-rflink-gateway). RFLink gateway is an Arduino firmware that allows two-way communication with a multitude of RF wireless devices using cheap hardware (Arduino + transceiver).
|
||||||
|
|
||||||
## {% linkable_title Configuration %}
|
First, you have to set up your [RFLink hub](/components/rflink/).
|
||||||
|
|
||||||
First, you have to set up your [rflink hub](/components/rflink/).
|
The RFLink component does not know the difference between a `switch`, a `binary_sensor` and a `light`. Therefore all switchable devices are automatically added as `light` by default.
|
||||||
|
|
||||||
The RFLink component does not know the difference between a `switch` and a `light`. Therefore all switchable devices are automatically added as `light` by default.
|
RFLink binary_sensor/switch/light ID's are composed of: protocol, id, switch/channel. For example: `newkaku_0000c6c2_1`.
|
||||||
|
|
||||||
RFLink switch/light ID's are composed of: protocol, id, switch. For example: `newkaku_0000c6c2_1`.
|
Once the ID of a switch is known, it can be used to configure it as a switch type in HA and, for example, to add it to a different group, hide it or configure a nice name.
|
||||||
|
|
||||||
Once the ID of a switch is known it can be used to configure it as a switch type in HA, for example, to add it to a different group, hide it or configure a nice name.
|
Configuring devices as switch :
|
||||||
|
|
||||||
Configuring a device as switch with a nice name:
|
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
switch:
|
switch:
|
||||||
platform: rflink
|
- platform: rflink
|
||||||
device_defaults:
|
devices:
|
||||||
fire_event: true
|
newkaku_0000c6c2_1: {}
|
||||||
signal_repetitions: 2
|
conrad_00785c_0a: {}
|
||||||
devices:
|
|
||||||
newkaku_0000c6c2_1:
|
|
||||||
name: Ceiling fan
|
|
||||||
conrad_00785c_0a:
|
|
||||||
name: Motion sensor kitchen
|
|
||||||
```
|
```
|
||||||
|
|
||||||
{% configuration %}
|
{% configuration %}
|
||||||
device_defaults:
|
device_defaults:
|
||||||
description: The defaults for all listed devices.
|
description: The defaults for the devices.
|
||||||
required: false
|
required: false
|
||||||
type: list
|
type: map
|
||||||
keys:
|
keys:
|
||||||
fire_event:
|
fire_event:
|
||||||
description: Set default `fire_event` for Rflink switch devices (see below).
|
description: Set default `fire_event` for RFLink switch devices (see below).
|
||||||
required: false
|
required: false
|
||||||
type: boolean
|
default: False
|
||||||
signal_repetitions:
|
|
||||||
description: Set default `signal_repetitions` for Rflink switch devices (see below).
|
|
||||||
required: false
|
|
||||||
type: integer
|
|
||||||
devices:
|
|
||||||
description: A list of devices with their name to use in the frontend.
|
|
||||||
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
|
type: boolean
|
||||||
signal_repetitions:
|
signal_repetitions:
|
||||||
description: Set default `signal_repetitions` for RFLink switch devices (see below).
|
description: Set default `signal_repetitions` for RFLink switch devices (see below).
|
||||||
required: false
|
required: false
|
||||||
default: 1
|
default: 1
|
||||||
type: integer
|
type: integer
|
||||||
group:
|
devices:
|
||||||
description: Allow light to respond to group commands (ALLON/ALLOFF).
|
description: A list of switches.
|
||||||
required: false
|
required: false
|
||||||
default: true
|
type: list
|
||||||
type: boolean
|
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]
|
||||||
|
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 %}
|
{% endconfiguration %}
|
||||||
|
|
||||||
## {% linkable_title Switch state %}
|
## {% linkable_title Switch state %}
|
||||||
@ -102,14 +114,13 @@ Sometimes a switch is controlled by multiple wireless remotes, each remote has i
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
switch:
|
switch:
|
||||||
platform: rflink
|
- platform: rflink
|
||||||
devices:
|
devices:
|
||||||
newkaku_0000c6c2_1:
|
newkaku_0000c6c2_1:
|
||||||
name: Ceiling fan
|
name: Ceiling fan
|
||||||
icon: mdi:fan
|
aliases:
|
||||||
aliases:
|
- newkaku_000000001_2
|
||||||
- newkaku_000000001_2
|
- kaku_000001_a
|
||||||
- kaku_000001_a
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Any on/off command from any alias ID updates the current state of the switch. However, when sending a command through the frontend only the primary ID is used.
|
Any on/off command from any alias ID updates the current state of the switch. However, when sending a command through the frontend only the primary ID is used.
|
||||||
@ -117,3 +128,21 @@ Any on/off command from any alias ID updates the current state of the switch. Ho
|
|||||||
## {% linkable_title Device support %}
|
## {% linkable_title Device support %}
|
||||||
|
|
||||||
See [device support](/components/rflink/#device-support)
|
See [device support](/components/rflink/#device-support)
|
||||||
|
|
||||||
|
### {% linkable_title Additional configuration examples %}
|
||||||
|
|
||||||
|
Multiple switches with signal repetitions and custom names
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
# Example configuration.yaml entry
|
||||||
|
switch:
|
||||||
|
- platform: rflink
|
||||||
|
device_defaults:
|
||||||
|
fire_event: true
|
||||||
|
signal_repetitions: 2
|
||||||
|
devices:
|
||||||
|
newkaku_0000c6c2_1:
|
||||||
|
name: Ceiling fan
|
||||||
|
conrad_00785c_0a:
|
||||||
|
name: Motion sensor kitchen
|
||||||
|
```
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user