Add Rflink component documentation. (#1715)

* Add Rflink component documentation.

* Add sensor docs.

* Add lights and switch documentation.

* Add logo.

* Update to latest changes.

* Use relative hyperlinks for internal links.

* Fix links, some text changes.

source/_components/light.rflink.markdown

@@ -0,0 +1,104 @@
+---
+layout: page
+title: "Rflink Light"
+description: "Instructions how to integrate Rflink lights into Home Assistant."
+date: 2016-01-04
+sidebar: true
+comments: false
+sharing: true
+footer: true
+logo: rflink.png
+ha_category: Light
+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 communication with 433Mhz devices using cheap hardware (Arduino + 433Mhz tranceiver).
+
+First you have to set up your [rflink hub](/components/rflink/).
+
+After configuring the Rflink hub lights will be automatically discovered and added.
+
+New/unknown lights can be assigned to a default group automatically by specifying the `new_devices_group` option with a group name. If the group doesn't exist it will be created.
+
+For example:
+
+```yaml
+# Example configuration.yaml entry
+sensor:
+  platform: rflink
+  new_devices_group: "New Rflink Lights"
+```
+
+Rflink switch/light ID's are composed of: protocol, id, switch. 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.
+
+Configuring a device as light with a nice name:
+
+```yaml
+# Example configuration.yaml entry
+light:
+  platform: rflink
+  devices:
+    newkaku_0000c6c2_1:
+      name: Living room
+```
+
+Configuration variables:
+
+- **devices**  (*Optional*): A list of devices with their name to use in the frontend.
+- **new_devices_group** (*Optional*): Create group to add new/unknown devices to.
+- **device_defaults**: (*Optional*)
+  - **fire_event_** (*Optional*): Set default `fire_event` for Rflink switch devices (see below).
+  - **signal_repetitions** (*Optional*): Set default `signal_repetitions` for Rflink switch devices (see below).
+
+Device configuration variables:
+
+- **name** (*Optional*): Name for the device, defaults to Rflink ID.
+- **type** (*Optional*): Override automatically detected type of the light device, can be: switchable, dimmable or hybrid. See 'Light Types' below.
+- **aliasses** (*Optional*): Alternative Rflink ID's this device is known by.
+- **fire_event_** (*Optional*): Fire an `button_pressed` event if this device is turned on or off (default: False).
+- **signal_repetitions** (*Optional*): Repeat every Rflink command this number of times (default: 1)
+
+# Light state
+
+Initially the state of a light is unknown. When the light is turned on or off (via frontend or 433Mhz remote) the state is known and will be shown in the frontend.
+
+Sometimes a light is controlled by multiple 433Mhz remotes, each remote has its own code programmed in the light. To allow tracking of the state when switched via other remotes add the corresponding remote codes as aliasses:
+
+```yaml
+# Example configuration.yaml entry
+light:
+  platform: rflink
+  devices:
+    newkaku_0000c6c2_1:
+      name: Living room
+      aliasses:
+        - newkaku_000000001_2
+        - kaku_000001_a
+```
+
+Any on/off command from any allias ID updates the current state of the light. However when sending a command through the frontend only the primary ID is used.
+
+# Light types
+
+Light devices can come in different forms. Some only switch on and off, other support dimming. Dimmable devices might not always respond nicely to repeated `on` command as they turn into a pulsating state until `on` is pressed again (for example KlikAanKlikUit). The Rflink component support three types of lights to make things work in every situation:
+
+*Hybrid*: This type sends a `dim` followed by an a `on` command; and `off` commands. This will make dimmable devices turn on at the requested dim level and on/off devices on. One caveat is this type is not compatible with signal repetition as multiple `on` signals will cause dimmers to go into disco mode.
+
+*Switchable*: Device type that sends only `on` and `off` commands. It work for both on/off and dimmable type switches. However dimmables might have issues with signal repetition (see above).
+
+*Dimmable*: Sends only `dim` and `off` commands. This does not work on on/off type devices as they don't understand the `dim` command. For dimmers this does not cause issues with signal repetitions.
+
+By default new lights are assigned the `switchable` type. Protocol supporting dimming are assigned the `hybrid` type. Currently only `newkaku` protocol is detected as dimmable. Please refer to Device Support to get your dimmers supported.
+
+# Hiding/ignoring lights
+Lights are added automatically when the Rflink gateway intercepts a 433Mhz command in the ether. To prevent cluttering the frontend use any of these methods:
+
+- Configure a `new_devices_group` for lights and optionally add it to a different `view`.
+- Hide unwanted devices using [customizations](/getting-started/customizing-devices/)
+- [Ignore devices on a platform level](/components/rflink/#ignoring-devices)
+
+# Device support
+See [device support](/components/rflink/#device-support)
+

source/_components/rflink.markdown

@@ -0,0 +1,91 @@
+---
+layout: page
+title: "Rflink"
+description: "Instructions how to integrate Rflink gateway into Home Assistant."
+date: 2016-01-04
+sidebar: true
+comments: false
+sharing: true
+footer: true
+logo: rflink.png
+ha_category: Hub
+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 communication with 433Mhz devices using cheap hardware (Arduino + 433Mhz tranceiver).
+
+The 433Mhz spectrum is used by many manufacturers mostly using their own protocol/standard and includes devices like: light switches, blinds, weather stations, alarms and various other sensors.
+
+A complete list of devices supported by Rflink can be found [here](http://www.nemcon.nl/blog2/devlist)
+
+This component is tested with the following hardware/software:
+
+- Nodo Rflink Gateway V1.4/Rflink R44
+
+To enable Rflink in your installation, add the following to your `configuration.yaml` file:
+
+```yaml
+# Example configuration.yaml entry
+rflink:
+  port: /dev/serial/by-id/usb-id01234
+```
+
+Configuration variables:
+
+- **port** (*Required*): The path to Rflink usb/serial device or TCP port in TCP mode.
+- **host** (*Optional*): Switches to TCP mode, connects to host instead of to usb/serial.
+- **wait_for_ack** (*Optional*): Wait for Rflink to ackowledge commands sent before sending new command (slower but more reliable). Default: True
+- **ignore_devices** (*Optional*): List of devices id's to ignore. Supports wildcards (*) at the end.
+- **reconnect_interval** (*Optional*): Time in seconds between reconnect attempts.
+
+Complete example:
+
+```yaml
+# Example configuration.yaml entry
+rflink:
+  port: /dev/serial/by-id/usb-id01234
+  wait_for_ack: False
+  ignore_devices:
+    - newkaku_000001_01
+    - digitech_*
+```
+
+# TCP mode
+
+TCP mode allows connect to a Rflink device over TCP/IP network. This is for example useful if placing the Rflink device next to the HA server is not optimal or desired (eg: bad reception).
+
+To expose the usb/serial interface over TCP on a different host (Linux) the following command can be used:
+
+    socat /dev/ttyACM0,b57600 TCP-LISTEN:1234,reuseaddr
+
+Other methods of exposing the serial interface over TCP are possible (eg: ESP8266 or using Arduino Wifi shield). Basically the serial stream should be directly mapped to the TCP stream.
+
+```yaml
+# Example configuration.yaml entry
+rflink:
+  host: 192.168.0.10
+  port: 1234
+```
+# Ignoring devices
+Rflink platform can be configured to completely ignore a device on a platform level. This is useful when you have neighbors which also use 433Mhz technology.
+
+For example:
+
+```yaml
+# Example configuration.yaml entry
+rflink:
+  port: /dev/serial/by-id/usb-id01234
+  wait_for_ack: False
+  ignore_devices:
+    - newkaku_000001_01
+    - digitech_*
+    - kaku_1_*
+```
+
+This configuration will ignore the button `1` of the `newkaku` device with ID `000001`, all devices of the `digitech` protocol and all switches of the `kaku` protocol device with codewheel ID `1`.
+
+Wildcards only work at the end of the ID, not in the middle of front!
+
+# Device support
+Even though a lot of devices are supported by Rflink, not all have been tested/implemented. If you have a device supported by Rflink but not by this component please consider testing and adding support yourself or [create an issue](https://github.com/home-assistant/home-assistant/issues/new) and mention `@aequitas` in the description.
+

source/_components/sensor.rflink.markdown

@@ -0,0 +1,69 @@
+---
+layout: page
+title: "Rflink Sensor"
+description: "Instructions how to integrate Rflink sensors into Home Assistant."
+date: 2016-01-04
+sidebar: true
+comments: false
+sharing: true
+footer: true
+logo: rflink.png
+ha_category: Sensor
+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 communication with 433Mhz devices using cheap hardware (Arduino + 433Mhz tranceiver).
+
+First you have to set up your [rflink hub](/components/rflink/).
+
+After configuring the Rflink hub sensors will be automatically discovered and added.
+
+New/unknown sensors can be assigned to a default group automatically by specifying the `new_devices_group` option with a group name. If the group doesn't exist it will be created.
+
+For example:
+
+```yaml
+# Example configuration.yaml entry
+sensor:
+  platform: rflink
+  new_devices_group: "New Rflink Sensors"
+```
+
+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.
+
+Assigning name to a sensor:
+
+```yaml
+# Example configuration.yaml entry
+sensor:
+  platform: rflink
+  devices:
+    # assign name to a sensor
+    alectov1_0334_temp:
+      name: Temperature Outside
+```
+
+Configuration variables:
+
+- **devices**  (*Optional*): A list of devices with their name to use in the frontend.
+- **new_devices_group** (*Optional*): Create group to add new/unknown devices to.
+
+Device configuration variables:
+
+- **name** (*Optional*): Name for the device, defaults to Rflink ID.
+- **sensor_type_** (*Optional*): Override automatically detected type of sensor.
+- **unit_of_measurement** (*Optional*): Override automatically detected unit of sensor.
+- **aliasses** (*Optional*): Alternative Rflink ID's this device is known by.
+
+# Hiding/ignoring sensors
+Sensors are added automatically when the Rflink gateway intercepts a 433Mhz command in the ether. To prevent cluttering the frontend use any of these methods:
+
+- Configure a `new_devices_group` for sensors and optionally add it to a different `view`.
+- Hide unwanted devices using [customizations](/getting-started/customizing-devices/)
+- [Ignore devices on a platform level](/components/rflink/#ignoring-devices)
+
+# Device support
+See [device support](/components/rflink/#device-support)
+

source/_components/switch.rflink.markdown

@@ -0,0 +1,81 @@
+---
+layout: page
+title: "Rflink Switch"
+description: "Instructions how to integrate Rflink switches into Home Assistant."
+date: 2016-01-04
+sidebar: true
+comments: false
+sharing: true
+footer: true
+logo: rflink.png
+ha_category: Switch
+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 communication with 433Mhz devices using cheap hardware (Arduino + 433Mhz tranceiver).
+
+First you have to set up your [rflink hub](/components/rflink/).
+
+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 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, for example to add it to a different group, hide it or configure a nice name.
+
+Configuring a device as switch with a nice name:
+
+```yaml
+# Example configuration.yaml entry
+switch:
+  platform: rflink
+  device_defaults:
+    fire_event: true
+    signal_repetitions: 2
+  devices:
+    newkaku_0000c6c2_1:
+      name: Ceiling fan
+      icon: mdi:fan
+    conrad_00785c_0a:
+      name: Motion sensor kitchen
+      icon: mdi:run
+
+```
+
+Configuration variables:
+
+- **devices** (*Optional*): A list of devices with their name to use in the frontend.
+- **device_defaults**: (*Optional*)
+  - **fire_event_** (*Optional*): Set default `fire_event` for Rflink switch devices (see below).
+  - **signal_repetitions** (*Optional*): Set default `signal_repetitions` for Rflink switch devices (see below).
+
+Device configuration variables:
+
+- **name** (*Optional*): Name for the device, defaults to Rflink ID.
+- **aliasses** (*Optional*): Alternative Rflink ID's this device is known by.
+- **fire_event_** (*Optional*): Fire an `button_pressed` event if this device is turned on or off (default: False).
+- **signal_repetitions** (*Optional*): Repeat every Rflink command this number of times (default: 1)
+
+# Switch state
+
+Initially the state of a switch is unknown. When the switch is turned on or off (via frontend or 433Mhz remote) the state is known and will be shown in the frontend.
+
+Sometimes a switch is controlled by multiple 433Mhz remotes, each remote has its own code programmed in the switch. To allow tracking of the state when switched via other remotes add the corresponding remote codes as aliasses:
+
+```yaml
+# Example configuration.yaml entry
+switch:
+  platform: rflink
+  devices:
+    newkaku_0000c6c2_1:
+      name: Ceiling fan
+      icon: mdi:fan
+      aliasses:
+        - newkaku_000000001_2
+        - 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.
+
+# Device support
+See [device support](/components/rflink/#device-support)
+