Skip to content

Commit f014c86

Browse files
authored
Merge pull request home-assistant#3550 from home-assistant/cover-rflink
Add RFlink cover docs
2 parents 7a6a8e9 + 5d32260 commit f014c86

File tree

1 file changed

+58
-0
lines changed

1 file changed

+58
-0
lines changed
Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
---
2+
layout: page
3+
title: "RFLink Cover"
4+
description: "Instructions how to integrate RFXtrx covers into Home Assistant."
5+
date: 2016-08-24 14:30
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: rflink.png
11+
ha_category: Cover
12+
ha_release: 0.55
13+
---
14+
15+
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).
16+
17+
First you have to set up your [rflink hub](/components/rflink/).
18+
19+
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.
20+
21+
RFLink switch/light/cover ID's are composed of: protocol, id, switch. For example: `newkaku_0000c6c2_1`.
22+
23+
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.
24+
25+
To add RFLink to your installation, add the following to your Home Assistant `configuration.yaml` file:
26+
27+
```yaml
28+
# Example configuration.yaml entry
29+
cover:
30+
platform: rflink
31+
device_defaults:
32+
fire_event: true
33+
signal_repetitions: 2
34+
devices:
35+
newkaku_0000c6c2_1:
36+
name: Ceiling fan
37+
conrad_00785c_0a:
38+
name: Motion sensor kitchen
39+
40+
```
41+
42+
Configuration variables:
43+
44+
- **devices** (*Optional*): A list of devices with their name to use in the frontend.
45+
- **device_defaults**: (*Optional*)
46+
- **fire_event** (*Optional*): Set default `fire_event` for RFLink switch devices (see below).
47+
- **signal_repetitions** (*Optional*): Set default `signal_repetitions` for RFLink switch devices (see below).
48+
49+
Device configuration variables:
50+
51+
- **name** (*Optional*): Name for the device, defaults to RFLink ID.
52+
- **aliases** (*Optional*): Alternative RFLink ID's this device is known by.
53+
- **fire_event** (*Optional*): Fire an `button_pressed` event if this device is turned on or off (default: False).
54+
- **signal_repetitions** (*Optional*): Repeat every RFLink command this number of times (default: 1)
55+
- **group** (*Optional*): Allow switch to respond to group commands (ALLON/ALLOFF). (default: yes)
56+
- **group_aliases** (*Optional*): `aliases` which only respond to group commands.
57+
- **no_group_aliases** (*Optional*): `aliases` which do not respond to group commands.
58+

0 commit comments

Comments
 (0)