diff --git a/source/_components/light.rflink.markdown b/source/_components/light.rflink.markdown index 37381ba395e..babb149f5a6 100644 --- a/source/_components/light.rflink.markdown +++ b/source/_components/light.rflink.markdown @@ -60,7 +60,7 @@ Device configuration variables: - **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 +### {% linkable_title 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. @@ -80,25 +80,25 @@ light: 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 +### {% linkable_title 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. +- *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 +### {% linkable_title 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 +### {% linkable_title Device support %} + See [device support](/components/rflink/#device-support) diff --git a/source/_components/rflink.markdown b/source/_components/rflink.markdown index b2d931d5e62..91462a0f026 100644 --- a/source/_components/rflink.markdown +++ b/source/_components/rflink.markdown @@ -12,9 +12,9 @@ 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 `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 433 Mhz devices using cheap hardware (Arduino + 433 Mhz 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. +The 433 Mhz 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) @@ -33,8 +33,8 @@ rflink: 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 +- **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). Defaults to `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. @@ -50,13 +50,15 @@ rflink: - digitech_* ``` -# TCP mode +### {% linkable_title 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 +```bash +$ 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. @@ -66,8 +68,10 @@ 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. + +### {% linkable_title 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 433 Mhz technology. For example: @@ -86,6 +90,7 @@ This configuration will ignore the button `1` of the `newkaku` device with ID `0 Wildcards only work at the end of the ID, not in the middle of front! -# Device support +### {% linkable_title 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. diff --git a/source/_components/sensor.rflink.markdown b/source/_components/sensor.rflink.markdown index 11c26f26527..9a07fc001d3 100644 --- a/source/_components/sensor.rflink.markdown +++ b/source/_components/sensor.rflink.markdown @@ -57,13 +57,15 @@ Device configuration variables: - **unit_of_measurement** (*Optional*): Override automatically detected unit of sensor. - **aliasses** (*Optional*): Alternative Rflink ID's this device is known by. -# Hiding/ignoring sensors +### {% linkable_title 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 +### {% linkable_title Device support %} + See [device support](/components/rflink/#device-support) diff --git a/source/_components/switch.rflink.markdown b/source/_components/switch.rflink.markdown index bae099388d9..9fb8ecb9cd0 100644 --- a/source/_components/switch.rflink.markdown +++ b/source/_components/switch.rflink.markdown @@ -55,7 +55,7 @@ Device configuration variables: - **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 +### {% linkable_title 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. @@ -76,6 +76,7 @@ switch: 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 +### {% linkable_title Device support %} + See [device support](/components/rflink/#device-support)