From 02cf7ff6b7d797204d281ea51201056db91e277a Mon Sep 17 00:00:00 2001 From: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> Date: Wed, 9 Oct 2024 16:54:08 +0200 Subject: [PATCH] RFLink: merge sensor into main docs (#35157) --- source/_integrations/rflink.markdown | 132 +++++++++++++++++- source/_integrations/sensor.rflink.markdown | 143 -------------------- source/_redirects | 1 + 3 files changed, 132 insertions(+), 144 deletions(-) delete mode 100644 source/_integrations/sensor.rflink.markdown diff --git a/source/_integrations/rflink.markdown b/source/_integrations/rflink.markdown index 18c90de5bd8..a3804995efe 100644 --- a/source/_integrations/rflink.markdown +++ b/source/_integrations/rflink.markdown @@ -220,6 +220,136 @@ This will give you output looking like this: 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'} ``` +## Sensors + +After configuring the RFLink hub, sensors will be automatically discovered and added. + +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 Home Assistant, for example to add it to a different group or configure a nice name. + +Configuring a device as a sensor: + +```yaml +# Example configuration.yaml entry +sensor: + - platform: rflink + devices: + alectov1_0334_temp: {} +``` + +{% configuration %} +automatic_add: + description: Automatically add new/unconfigured devices to Home Assistant if detected. + required: false + default: true + type: boolean +devices: + description: A list of 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 + sensor_type: + description: Override automatically detected type of sensor. For list of [values](/integrations/sensor.rflink/#sensors-types) see below. + required: true + type: string + unit_of_measurement: + description: Override automatically detected unit of sensor. + required: false + type: string + aliases: + description: "Alternative RFLink ID's this device is known by." + required: false + type: [list, string] +{% endconfiguration %} + +### Sensor types + +Sensor type values: + +- average_windspeed +- barometric_pressure +- battery +- co2_air_quality +- command +- current_phase_1 +- current_phase_2 +- current_phase_3 +- distance +- doorbell_melody +- firmware +- hardware +- humidity +- humidity_status +- kilowatt +- light_intensity +- meter_value +- noise_level +- rain_rate +- revision +- temperature +- timestamp +- total_rain +- uv_intensity +- version +- voltage +- watt +- weather_forecast +- windchill +- winddirection +- windgusts +- windspeed +- windtemp + +### Hiding/ignoring sensors + +Sensors are added automatically when the RFLink gateway intercepts a wireless command in the ether. To prevent cluttering the frontend use any of these methods: + +- Disable automatically adding of unconfigured new sensors (set `automatic_add` to `false`). +- [Ignore devices on a platform level](/integrations/rflink/#ignoring-devices) + +### Device support + +See [device support](/integrations/rflink/#device-support) + +### Additional configuration examples + +Multiple sensors with `automatic_add` disabled and `aliases` + +```yaml +# Example configuration.yaml entry +sensor: + - platform: rflink + automatic_add: false + devices: + oregontemp_0d93_temp: + sensor_type: temperature + oregontemp_0d93_bat: + sensor_type: battery + tunex_c001_temp: + sensor_type: temperature + aliases: + - xiron_4001_temp + tunex_c001_hum: + sensor_type: humidity + aliases: + - xiron_4001_hum + tunex_c001_bat: + sensor_type: battery + aliases: + - xiron_4001_bat +``` + ## Switch The RFLink integration does not know the difference between a `switch`, a `binary_sensor`, and a `light`. Therefore all switchable devices are automatically added as `light` by default. @@ -351,4 +481,4 @@ switch: name: Ceiling fan conrad_00785c_0a: name: Motion sensor kitchen -``` +``` \ No newline at end of file diff --git a/source/_integrations/sensor.rflink.markdown b/source/_integrations/sensor.rflink.markdown deleted file mode 100644 index f35003e244d..00000000000 --- a/source/_integrations/sensor.rflink.markdown +++ /dev/null @@ -1,143 +0,0 @@ ---- -title: "RFLink Sensor" -description: "Instructions on how to integrate RFLink sensors into Home Assistant." -ha_category: - - Sensor -ha_iot_class: Local Push -ha_release: 0.38 -ha_domain: rflink ---- - -The `rflink` integration supports devices that use [RFLink gateway firmware](https://www.rflink.nl/download.php), for example the [Nodo RFLink Gateway](https://www.nodo-shop.nl/21-rflink-). RFLink gateway is an Arduino firmware that allows two-way communication with a multitude of RF wireless devices using cheap hardware (Arduino + transceiver). - -## Configuration - -First, you have to set up your [RFLink hub](/integrations/rflink/). - -After configuring the RFLink hub, sensors will be automatically discovered and added. - -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 Home Assistant, for example to add it to a different group or configure a nice name. - -Configuring a device as a sensor: - -```yaml -# Example configuration.yaml entry -sensor: - - platform: rflink - devices: - alectov1_0334_temp: {} -``` - -{% configuration %} -automatic_add: - description: Automatically add new/unconfigured devices to Home Assistant if detected. - required: false - default: true - type: boolean -devices: - description: A list of 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 - sensor_type: - description: Override automatically detected type of sensor. For list of [values](/integrations/sensor.rflink/#sensors-types) see below. - required: true - type: string - unit_of_measurement: - description: Override automatically detected unit of sensor. - required: false - type: string - aliases: - description: "Alternative RFLink ID's this device is known by." - required: false - type: [list, string] -{% endconfiguration %} - -## Sensor types - -Sensor type values: - -- average_windspeed -- barometric_pressure -- battery -- co2_air_quality -- command -- current_phase_1 -- current_phase_2 -- current_phase_3 -- distance -- doorbell_melody -- firmware -- hardware -- humidity -- humidity_status -- kilowatt -- light_intensity -- meter_value -- noise_level -- rain_rate -- revision -- temperature -- timestamp -- total_rain -- uv_intensity -- version -- voltage -- watt -- weather_forecast -- windchill -- winddirection -- windgusts -- windspeed -- windtemp - -## Hiding/ignoring sensors - -Sensors are added automatically when the RFLink gateway intercepts a wireless command in the ether. To prevent cluttering the frontend use any of these methods: - -- Disable automatically adding of unconfigured new sensors (set `automatic_add` to `false`). -- [Ignore devices on a platform level](/integrations/rflink/#ignoring-devices) - -## Device support - -See [device support](/integrations/rflink/#device-support) - -## Additional configuration examples - -Multiple sensors with `automatic_add` disabled and `aliases` - -```yaml -# Example configuration.yaml entry -sensor: - - platform: rflink - automatic_add: false - devices: - oregontemp_0d93_temp: - sensor_type: temperature - oregontemp_0d93_bat: - sensor_type: battery - tunex_c001_temp: - sensor_type: temperature - aliases: - - xiron_4001_temp - tunex_c001_hum: - sensor_type: humidity - aliases: - - xiron_4001_hum - tunex_c001_bat: - sensor_type: battery - aliases: - - xiron_4001_bat -``` diff --git a/source/_redirects b/source/_redirects index 1853f53d68c..9875c38b75e 100644 --- a/source/_redirects +++ b/source/_redirects @@ -189,6 +189,7 @@ layout: null /integrations/sensor.knx /integrations/knx#sensor /integrations/sensor.modbus /integrations/modbus/#configuring-sensor-entities /integrations/sensor.mysensors /integrations/mysensors#sensor +/integrations/sensor.rflink /integrations/rflink/#sensor /integrations/sensor.websocket_api /integrations/websocket_api/#track-current-connections /integrations/sensor.xiaomi_miio /integrations/xiaomi_miio /integrations/sensor.xiaomi_aqara/ /integrations/xiaomi_aqara/#sensors