Skip to content

Commit

Permalink
RFlink: move binary sensor into main docs
Browse files Browse the repository at this point in the history
  • Loading branch information
c0ffeeca7 committed Oct 9, 2024
1 parent b36b1f0 commit ba7b68d
Show file tree
Hide file tree
Showing 3 changed files with 81 additions and 92 deletions.
91 changes: 0 additions & 91 deletions source/_integrations/binary_sensor.rflink.markdown

This file was deleted.

81 changes: 80 additions & 1 deletion source/_integrations/rflink.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,6 @@ cover:

This configuration uses `0a0a0a` to control the inverted shutter (send UP to close and Down to open) and listen commands sent by `0f1f2f` remote control.


### 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 integration please consider testing and adding support yourself.
Expand Down Expand Up @@ -219,3 +218,83 @@ This will give you output looking like this:
17-03-07 20:12:05 DEBUG (MainThread) [rflink.protocol] got event: {'version': '1.1', 'firmware': 'RFLink Gateway', 'revision': '45', 'hardware': 'Nodo RadioFrequencyLink', 'id': 'rflink'}
17-03-07 20:12:05 DEBUG (MainThread) [homeassistant.components.rflink] event of type unknown: {'version': '1.1', 'firmware': 'RFLink Gateway', 'revision': '45', 'hardware': 'Nodo RadioFrequencyLink', 'id': 'rflink'}
```

## Binary sensor

The RFLink integration 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: 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
device_class:
description: Sets the [class of the device](/integrations/binary_sensor/), changing the device state and icon that is displayed on 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: integer
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 %}

### 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.

### Device support

See [device support](/integrations/rflink/#device-support)

### 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
```
1 change: 1 addition & 0 deletions source/_redirects
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,7 @@ layout: null
/integrations/binary_sensor.knx /integrations/knx#binary-sensor
/integrations/binary_sensor.modbus /integrations/modbus/#configuring-binary-sensor-entities
/integrations/binary_sensor.mysensors /integrations/mysensors#binary-sensor
/integrations/binary_sensor.rflink /integrations/rflink/#binary-sensor
/integrations/binary_sensor.template /integrations/template/#binary_sensor
/integrations/binary_sensor.xiaomi_aqara/ /integrations/xiaomi_aqara/#binary-sensor
/integrations/climate.knx /integrations/knx#climate
Expand Down

0 comments on commit ba7b68d

Please sign in to comment.