Documentation for RFLink Binary Sensor (#6519)

* Create binary_sensor.rflink.markdown * ✏️ Tweaks * Update binary_sensor.rflink.markdown * Update binary_sensor.rflink.markdown * Update binary_sensor.rflink.markdown * Update binary_sensor.rflink.markdown * Update binary_sensor.rflink.markdown * Update binary_sensor.rflink.markdown * Update binary_sensor.rflink.markdown * Update binary_sensor.rflink.markdown * Update binary_sensor.rflink.markdown * Update binary_sensor.rflink.markdown * Update binary_sensor.rflink.markdown
2025-07-19 07:17:14 +00:00 · 2018-10-21 11:30:08 +02:00 · 2018-10-21 11:30:08 +02:00 · b650d1b97d
commit b650d1b97d
parent 706c5e2c36
1 changed files with 95 additions and 0 deletions
--- a/source/_components/binary_sensor.rflink.markdown
+++ b/source/_components/binary_sensor.rflink.markdown
@ -0,0 +1,95 @@
+---
+layout: page
+title: "RFLink Binary Sensor"
+description: "Instructions on how to integrate RFLink binary sensors into Home Assistant."
+date: 2018-10-04
+sidebar: true
+comments: false
+sharing: true
+footer: true
+logo: rflink.png
+ha_category: Binary Sensor
+ha_iot_class: "Local Push"
+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).
+
+First, you have to set up your [RFLink hub](/components/rflink/).
+
+The RFLink component does not know the difference between a `binary_sensor`, 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`.
+
+Once the ID of a binary sensor is known, it can be used to configure it as a binary sensor type in Home Assistant, for example, to hide it or configure a nice name.
+
+Configuring a device as a binary sensor:
+
+```yaml
+# Example configuration.yaml entry
+binary_sensor:
+   - platform: rflink
+     devices:
+       pt2262_00174754_0: {}
+```
+
+{% configuration %}
+devices:
+  description: A list of binary sensors.
+  required: false
+  type: map
+  keys:
+    rflink_ids:
+      description: RFLink ID of the device
+      required: true
+      type: map
+      keys:
+        name:
+          description: Name of the device, defaults to RFLink ID.
+          required: false
+          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.
+          required: false
+          type: string
+        off_delay:
+          description: For sensors that only sends 'On' state updates, this variable sets a delay after which the sensor state will be updated back to 'Off'.
+          required: false
+          type: int
+        force_update:
+          description: Sends update events even if the value has not changed. Useful for sensors that only sends `On`.
+          required: false
+          type: boolean
+          default: false
+{% endconfiguration %}
+
+### {% linkable_title Sensor state %}
+
+Initially, the state of a binary sensor is unknown. When a sensor update is received, the state is known and will be shown in the frontend.
+
+### {% linkable_title Device support %}
+
+See [device support](/components/rflink/#device-support)
+
+### {% linkable_title Additional configuration examples %}
+
+Multiple sensors with custom name and device class and set off_delay
+
+```yaml
+# Example configuration.yaml entry
+binary_sensor:
+   - platform: rflink
+     devices:
+       pt2262_00174754_0:
+         name: PIR Entrance
+         device_class: motion
+         off_delay: 5
+       pt2262_00174758_0:
+         name: PIR Living Room
+         device_class: motion
+         off_delay: 5
+```