jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-21 08:16:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

Rxftrx drop platform config (#13976)

Browse Source 
Co-authored-by: Klaas Schoute <klaas_schoute@hotmail.com>
Co-authored-by: Franck Nijhof <git@frenck.dev>
This commit is contained in:
Joakim Plate 2020-07-14 00:28:24 +02:00 committed by GitHub
parent e9cebe5c38
commit 9f6ba0b5a2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 351 additions and 605 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

210
source/_integrations/binary_sensor.rfxtrx.markdown
View File

@ -1,210 +0,0 @@
---
title: "RFXtrx Binary Sensor"
description: "Instructions on how to integrate RFXtrx binary sensors into Home Assistant."
ha_category:
- Binary Sensor
ha_release: 0.48
ha_domain: rfxtrx
---
The `rfxtrx` platform support binary sensors that
communicate in the frequency range of 433.92 MHz.
The RFXtrx binary sensor integration provides support for them.
Many cheap sensors available on the web today are based on a particular RF chip
called *PT-2262*. Depending on the running firmware on the RFXcom box, some of
them may be recognized under the X10 protocol but most of them are recognized
under the *Lighting4* protocol. The RFXtrx binary sensor integration provides
some special options for them, while other RFXtrx protocols should work too.
## Setting up your devices
Once you have set up your [RFXtrx hub](/integrations/rfxtrx/), the easiest way
to find your binary sensors is to add this to your `configuration.yaml`:
```yaml
# Example configuration.yaml entry
binary_sensor:
platform: rfxtrx
automatic_add: true
```
Open your Home Assistant frontend and go to the "states" page.
Then make sure to trigger your sensor. You should see a new entity
appear in the *Current entities* list, starting with "binary_sensor."
and some hexadecimal digits. Those hexadecimal digits are your device id.
For example: "binary_sensor.0913000022670e013b70". Here your device id
is `0913000022670e013b70`. Then you should update your configuration to:
```yaml
# Example configuration.yaml entry
binary_sensor:
platform: rfxtrx
devices:
0913000022670e013b70:
name: device_name
```
{% configuration %}
devices:
description: A list of devices.
required: false
type: list
keys:
name:
description: Override the name to use in the frontend.
required: false
type: string
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: device_class
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
data_bits:
description: Defines how many bits are used for commands inside the data packets sent by the device.
required: false
type: integer
command_on:
description: Defines the data bits value that is sent by the device upon an 'On' command.
required: false
type: string
command_off:
description: Defines the data bits value that is sent by the device upon an 'Off' command.
required: false
type: string
automatic_add:
description: To enable the automatic addition of new binary sensors.
required: false
type: boolean
default: false
{% endconfiguration %}
<div class='note warning'>
This integration and the [RFXtrx switch](/integrations/switch.rfxtrx/) can steal each other's devices when setting the `automatic_add` configuration parameter to `true`.
Set `automatic_add` only when you have some devices to add to your installation, otherwise leave it to `false`.
</div>
<div class='note warning'>
If a device ID consists of only numbers, please make sure to surround it with quotes.
This is a known limitation in YAML, because the device ID will be interpreted as a number otherwise.
</div>
Binary sensors have only two states - "on" and "off". Many door or window
opening sensors will send a signal each time the door/window is open or closed.
However, depending on their hardware or on their purpose,
some sensors are only able to signal their "on" state:
- Most motion sensors send a signal each time they detect motion. They stay "on" for a few seconds and go back to sleep, ready to signal other motion events. Usually, they do not send a signal when they go back to sleep.
- Some doorbells may also only send "on" signals when their toggle switch is pressed, but no "off" signal when the switch is released.
For those devices, use the *off_delay* parameter.
It defines a delay after which a device will go back to an "Off" state.
That "Off" state will be fired internally by Home Assistant, just as if
the device fired it by itself. If a motion sensor can only send signals
once every 5 seconds, sets the *off_delay* parameter to *seconds: 5*.
Example configuration:
```yaml
# Example configuration.yaml entry
binary_sensor:
platform: rfxtrx
automatic_add: true
devices:
091300006ca2c6001080:
name: motion_hall
device_class: motion
off_delay:
seconds: 5
```
### Options for PT-2262 devices under the Lighting4 protocol
When a data packet is transmitted by a PT-2262 device using the Lighting4
protocol, there is no way to automatically extract the device identifier and the
command from the packet. Each device has its own id/command length combination
and the fields lengths are not included in the data. One device that sends 2
different commands will be seen as 2 devices on Home Assistant. For such cases,
the following options are available in order to circumvent the problem:
- **data_bits** (*Optional*)
- **command_on** (*Optional*)
- **command_off** (*Optional*)
Let's try to add a new PT-2262 sensor using the "automatic_add"
option and have a look at Home Assistant system log.
Have your sensor trigger the "On" state for the first time.
Some messages will appear:
```text
INFO (Thread-6) [homeassistant.components.binary_sensor.rfxtrx] Added binary sensor 0913000022670e013970 (Device_id: 22670e Class: LightingDevice Sub: 0)
```
Here the sensor has the id *22670e*.
Now have your sensor trigger the "Off" state and look for the following
message in the Home Assistant log. You should see that your device
has been detected as a *new* device when triggering its "Off" state:
```text
INFO (Thread-6) [homeassistant.components.binary_sensor.rfxtrx] Added binary sensor 09130000226707013d70 (Device_id: 226707 Class: LightingDevice Sub: 0)
```
Here the device id is *226707*, which is almost similar to
the *22670e* we had on the "On" event a few seconds ago.
From those two values, you can guess that the actual id of your device is
*22670*, and that *e* and *7* are commands for "On" and "Off" states
respectively. As one hexadecimal digit uses 4 bits,
we can conclude that the device is using 4 data bits.
So here is the actual configuration section for the binary sensor:
```yaml
platform: rfxtrx
automatic_add: true
devices:
0913000022670e013b70:
name: window_room2
device_class: opening
data_bits: 4
command_on: 0xe
command_off: 0x7
```
The *automatic_add* option makes the RFXtrx binary sensor integration calculate
and display the configuration options for you in the Home Assistant logs:
```text
INFO (Thread-6) [homeassistant.components.rfxtrx] rfxtrx: found possible device 226707 for 22670e with the following configuration:
data_bits=4
command_on=0xe
command_off=0x7
INFO (Thread-6) [homeassistant.components.binary_sensor.rfxtrx] Found possible matching deviceid 22670e.
```
This automatic guess should work most of the time but there is
no guarantee on that. You should activate it only when you
want to configure your new devices and leave it off otherwise.
### Known working devices
The following devices are known to work with the RFXtrx binary sensor component.
There are too many other to list.
- Motion detectors:
- Kerui P817 and P829.
- Chuango PIR-700.
- Door / window sensors:
- Kerui D026 door / window sensor: can trigger on "open" and "close". Has a tamper switch.
- Nexa LMST-606.

83
source/_integrations/cover.rfxtrx.markdown
View File

@ -1,83 +0,0 @@
---
title: "RFXtrx Cover"
description: "Instructions on how to integrate RFXtrx covers into Home Assistant."
ha_category:
- Cover
ha_release: 0.27
ha_domain: rfxtrx
---
The `rfxtrx` platform supports Siemens/LightwaveRF and RFY roller shutters that communicate in the frequency range of 433.92 MHz.
First you have to set up your [RFXtrx hub](/integrations/rfxtrx/).
### Configuration
##### Siemens/LightwaveRF
The easiest way to find your roller shutters is to add this to your `configuration.yaml`:
```yaml
cover:
- platform: rfxtrx
automatic_add: true
```
Launch your Home Assistant and go the website (e.g., `http://localhost:8123`). Push your remote and your device should be added.
Once added it will show an ID (e.g `0b11000102ef9f210010f70`) and you can verify that it works from the frontend. Then you should update your configuration to:
```yaml
cover:
- platform: rfxtrx
devices:
0b11000102ef9f210010f70:
name: device_name
```
##### RFY
The [RFXtrx433e](http://www.rfxcom.com/RFXtrx433E-USB-43392MHz-Transceiver/en) is required for RFY support, however it does not support receive for the RFY protocol - as such devices cannot be automatically added. Instead, configure the device in the [rfxmngr](http://www.rfxcom.com/downloads.htm) tool. Make a note of the assigned ID and Unit Code and then add a device to the configuration with the following id `071a0000[id][unit_code]`. E.g., if the id was `0a` `00` `01`, and the unit code was `01` then the fully qualified id would be `071a00000a000101`, if you set your id/code to single digit in the rfxmngr, e.g., id: `1` `02` `04` and unit code: `1` you will need to add `0` before, so `102031` becomes `071a000001020301`.
##### Common
Example configuration:
```yaml
# Example configuration.yaml entry
cover:
- platform: rfxtrx
automatic_add: false
signal_repetitions: 2 # signal_repetitions: 1 for the Somfy covers (avoid to stop the motion after start)
devices:
0b1100ce3213c7f210010f70: # Siemens/LightwaveRF
name: Bedroom Shutter
071a00000a000101: # RFY
name: Bathroom Shutter
```
{% configuration %}
devices:
description: A list of devices.
required: false
type: list
keys:
name:
description: Override the name to use in the frontend.
required: true
type: string
automatic_add:
description: To enable the automatic addition of new covers (Siemens/LightwaveRF only).
required: false
default: false
type: boolean
signal_repetitions:
description: Because the rxftrx device sends its actions via radio and from most receivers it's impossible to know if the signal was received or not. Therefore you can configure the roller shutter to try to send each signal repeatedly.
required: false
type: integer
{% endconfiguration %}
<div class='note warning'>
If a device ID consists of only numbers, please make sure to surround it with quotes.
This is a known limitation in YAML, because the device ID will be interpreted as a number otherwise.
</div>

76
source/_integrations/light.rfxtrx.markdown
View File

@ -1,76 +0,0 @@
---
title: "RFXtrx Light"
description: "Instructions on how to integrate RFXtrx lights into Home Assistant."
ha_category:
- Light
ha_release: 0.7.5
ha_iot_class: Assumed State
ha_domain: rfxtrx
---
The `rfxtrx` platform support lights that communicate in the frequency range of 433.92 MHz.
First you have to set up your [RFXtrx hub](/integrations/rfxtrx/).
The easiest way to find your lights is to add this to your `configuration.yaml`:
```yaml
light:
- platform: rfxtrx
automatic_add: true
```
Launch your Home Assistant and go the website. Push your remote and your device should be added:
<p class='img'>
<img src='/images/integrations/rfxtrx/switch.png' />
</p>
Here the name is `0b11000102ef9f210010f70` and you can verify that it works from the frontend. Then you should update your configuration to:
```yaml
light:
platform: rfxtrx
devices:
0b11000102ef9f210010f70:
name: device_name
```
Example configuration:
```yaml
# Example configuration.yaml entry
light:
platform: rfxtrx
devices:
0b11000f10e9e5660b010f70:
name: Light1
0b1100100f29e5660c010f70:
name: Light_TV
```
{% configuration %}
devices:
description: A list of devices.
required: false
type: list
keys:
name:
description: Override the name to use in the frontend.
required: true
type: string
automatic_add:
description: To enable the automatic addition of new lights.
required: false
default: false
type: boolean
signal_repetitions:
description: Because the RFXtrx device sends its actions via radio and from most receivers it's impossible to know if the signal was received or not. Therefore you can configure the switch to try to send each signal repeatedly.
required: false
type: integer
{% endconfiguration %}
<div class='note warning'>
If a device ID consists of only numbers, please make sure to surround it with quotes.
This is a known limitation in YAML, because the device ID will be interpreted as a number otherwise.
</div>

355
source/_integrations/rfxtrx.markdown
View File

@ -3,6 +3,11 @@ title: RFXCOM RFXtrx
description: Instructions on how to integrate RFXtrx into Home Assistant. description: Instructions on how to integrate RFXtrx into Home Assistant.
ha_category: ha_category:
- Hub - Hub
- Cover
- Light
- Switch
- Binary Sensor
- Sensor
ha_release: pre 0.7 ha_release: pre 0.7
ha_codeowners: ha_codeowners:
- '@danielhiversen' - '@danielhiversen'
@ -11,7 +16,17 @@ ha_domain: rfxtrx
The `rfxtrx` integration supports RFXtrx devices by [RFXCOM](http://www.rfxcom.com), which communicate in the frequency range of 433.92 MHz. The `rfxtrx` integration supports RFXtrx devices by [RFXCOM](http://www.rfxcom.com), which communicate in the frequency range of 433.92 MHz.
To enable RFXtrx in your installation, add the following to your `configuration.yaml` file: There is currently support for the following device types within Home Assistant:
- [Cover](#covers)
- [Light](#lights)
- [Sensor](#sensors)
- [Binary Sensor](#binary-sensors)
- [Switch](#switch)
To enable RFXtrx in your installation, something like the following to your `configuration.yaml` file.
*Direct serial connection*
```yaml ```yaml
# Example configuration.yaml entry for local serial device # Example configuration.yaml entry for local serial device
@ -19,7 +34,7 @@ rfxtrx:
device: /dev/ttyUSB0 device: /dev/ttyUSB0
``` ```
OR *Network connection*
```yaml ```yaml
# Example configuration.yaml entry for TCP connected device using ser2net # Example configuration.yaml entry for TCP connected device using ser2net
@ -28,6 +43,77 @@ rfxtrx:
port: 50000 port: 50000
``` ```
*Network connection with multiple devices*
```yaml
# Example configuration with several devices
rfxtrx:
host: 192.168.0.2
port: 50000
devices:
# Siemens/LightwaveRF Shutter
0b1100ce3213c7f210010f70:
# RFY Shutter
071a00000a000101:
# Light 1
0b11000f10e9e5660b010f70:
# Light TV
0b1100100f29e5660c010f70:
# Binary Sensor
0913000022670e013b70:
# Binary Sensor with data bits setup
0913000022670e013b70:
device_class: opening
data_bits: 4
command_on: 0xe
command_off: 0x7
# Switch 1
0b1100ce3213c7f210010f70:
# Switch 2
0b11000a02ef2gf210010f50:
# Switch 3
0b1111e003af16aa10000060:
fire_event: true
# Sensor
0a52080000301004d240259:
```
*Use remote to enable scene (using event_data)*
```yaml
rfxtrx:
host: 192.168.0.2
port: 50000
devices:
# Light 1
0b1100ce3213c7f210010f70:
# LIght 2
0b11000a02ef2gf210010f50:
# Keychain remote
0b1111e003af16aa10000060:
fire_event: true
scene:
name: Livingroom
entities:
switch.light1: on
switch.light2: on
automation:
- alias: Use remote to enable scene
trigger:
platform: event
event_type: button_pressed
event_data: {"state": "on", "entity_id": "switch.keychain_remote"}
action:
service: scene.turn_on
entity_id: scene.livingroom
```
{% configuration %} {% configuration %}
device: device:
description: "The path to your device, e.g., `/dev/serial/by-id/usb-RFXCOM_RFXtrx433_A1Y0NJGR-if00-port0` or `/dev/ttyUSB0`. Required if you are using a locally connected USB device." description: "The path to your device, e.g., `/dev/serial/by-id/usb-RFXCOM_RFXtrx433_A1Y0NJGR-if00-port0` or `/dev/ttyUSB0`. Required if you are using a locally connected USB device."
@ -46,13 +132,57 @@ debug:
required: false required: false
default: false default: false
type: boolean type: boolean
dummy: devices:
description: "Then you need a connected drive to test your settings. Can be useful for debugging and testing." description: A list of devices.
required: false
type: map
keys:
EVENT_CODE:
description: An code string describing the device. It may include state, but state will be ignored.
required: true
type: map
keys:
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: device_class
fire_event:
description: Fires an event even if the state is the same as before. Can be used for automations.
required: false required: false
default: false
type: boolean type: boolean
default: false
off_delay:
description: For binary sensors that only sends 'On' state updates, this variable sets a delay after which the binary sensor state will be updated back to 'Off'.
required: false
type: integer
data_bits:
description: Defines how many bits are used for commands inside the data packets sent by the device.
required: false
type: integer
command_on:
description: Defines the data bits value that is sent by the device upon an 'On' command.
required: false
type: string
command_off:
description: Defines the data bits value that is sent by the device upon an 'Off' command.
required: false
type: string
signal_repetitions:
description: Because the RFXtrx device sends its actions via radio and from most receivers it's impossible to know if the signal was received or not. Therefore you can configure the RFXtrx device to try to send each signal repeatedly.
required: false
type: integer
automatic_add:
description: To enable the automatic addition of new binary sensors.
required: false
type: boolean
default: false
{% endconfiguration %} {% endconfiguration %}
<div class='note warning'>
If a device ID consists of only numbers, please make sure to surround it with quotes.
This is a known limitation in YAML, because the device ID will be interpreted as a number otherwise.
</div>
## Supported protocols ## Supported protocols
Not all protocols as advertised are enabled on the initial setup of your transceiver. Enabling all protocols is not recommended either. Your 433.92 product not showing in the logs? Visit the RFXtrx website to [download RFXmgmr](http://www.rfxcom.com/epages/78165469.sf/en_GB/?ViewObjectPath=%2FShops%2F78165469%2FCategories%2FDownloads) and enable the required protocol. Not all protocols as advertised are enabled on the initial setup of your transceiver. Enabling all protocols is not recommended either. Your 433.92 product not showing in the logs? Visit the RFXtrx website to [download RFXmgmr](http://www.rfxcom.com/epages/78165469.sf/en_GB/?ViewObjectPath=%2FShops%2F78165469%2FCategories%2FDownloads) and enable the required protocol.
@ -65,9 +195,204 @@ You can host your device on another computer by setting up ser2net and example c
50000:raw:0:/dev/ttyUSB0:38400 8DATABITS NONE 1STOPBIT 50000:raw:0:/dev/ttyUSB0:38400 8DATABITS NONE 1STOPBIT
``` ```
## Setting up your devices
Once you have set up your [RFXtrx hub](/integrations/rfxtrx/), the easiest way
to find your binary sensors is to enable automatic add in `configuration.yaml`:
```yaml
rfxtrx:
automatic_add: true
host: 192.168.0.2
port: 50000
```
Open your Home Assistant frontend and go to the "states" page.
Then make sure to trigger your sensor. You should see several new entities
appear in the *Current entities* list, by looking at the entities attribute, you can look at the last received event, which can be added to the configuration.
For example: "0913000022670e013b70". Then you should update your configuration to:
```yaml
rfxtrx:
automatic_add: false
host: 192.168.0.2
port: 50000
devices:
0913000022670e013b70:
```
### Covers
The `rfxtrx` platform supports Siemens/LightwaveRF and RFY roller shutters that communicate in the frequency range of 433.92 MHz.
##### RFY
The [RFXtrx433e](http://www.rfxcom.com/RFXtrx433E-USB-43392MHz-Transceiver/en) is required for RFY support, however, it does not support receive for the RFY protocol - as such devices cannot be automatically added. Instead, configure the device in the [rfxmngr](http://www.rfxcom.com/downloads.htm) tool. Make a note of the assigned ID and Unit Code and then add a device to the configuration with the following id `071a0000[id][unit_code]`. E.g., if the id was `0a` `00` `01`, and the unit code was `01` then the fully qualified id would be `071a00000a000101`, if you set your id/code to single digit in the rfxmngr, e.g., id: `1` `02` `04` and unit code: `1` you will need to add `0` before, so `102031` becomes `071a000001020301`.
### Lights
The `rfxtrx` platform support lights that communicate in the frequency range of 433.92 MHz.
### Switches
The `rfxtrx` platform support switches that communicate in the frequency range of 433.92 MHz.
#### Generate codes
If you need to generate codes for switches, you can use a template (useful for example COCO switches).
- Go to home-assistant-IP:8123/dev-template
- Use this code to generate a code:
{% raw %}
```yaml
0b11000{{ range(100,700) | random | int }}bc0cfe0{{ range(0,10) | random | int }}010f70
```
{% endraw %}
- Use this code to add a new switch in your `configuration.yaml`.
- Launch your Home Assistant and go to the website.
- Enable learning mode on your switch (i.e., push learn button or plug it in a wall socket)
- Toggle your new switch in the Home Assistant interface
### Sensors
The `rfxtrx` platform support sensors that communicate in the frequency range of 433.92 MHz.
Also, several switches and other devices will also expose sensor entities with battery status as well as the signal level.
### Binary Sensors
The `rfxtrx` platform support binary sensors that
communicate in the frequency range of 433.92 MHz.
The RFXtrx binary sensor integration provides support for them.
Many cheap sensors available on the web today are based on a particular RF chip
called *PT-2262*. Depending on the running firmware on the RFXcom box, some of
them may be recognized under the X10 protocol, but most of them are recognized
under the *Lighting4* protocol. The RFXtrx binary sensor integration provides
some special options for them, while other RFXtrx protocols should work too.
#### Off Delay
Binary sensors have only two states - "on" and "off". Many door or window
opening sensors will send a signal each time the door/window is open or closed.
However, depending on their hardware or on their purpose,
some sensors are only able to signal their "on" state:
- Most motion sensors send a signal each time they detect motion. They stay "on" for a few seconds and go back to sleep, ready to signal other motion events. Usually, they do not send a signal when they go back to sleep.
- Some doorbells may also only send "on" signals when their toggle switch is pressed, but no "off" signal when the switch is released.
For those devices, use the *off_delay* parameter.
It defines a delay after, which a device will go back to an "Off" state.
That "Off" state will be fired internally by Home Assistant, just as if
the device fired it by itself. If a motion sensor can only send signals
once every 5 seconds, sets the *off_delay* parameter to *seconds: 5*.
Example configuration:
```yaml
rfxtrx:
automatic_add: false
host: 192.168.0.2
port: 50000
devices:
091300006ca2c6001080:
device_class: motion
off_delay:
seconds: 5
```
#### Options for PT-2262 devices under the Lighting4 protocol
When a data packet is transmitted by a PT-2262 device using the Lighting4
protocol, there is no way to automatically extract the device identifier and the
command from the packet. Each device has its own id/command length combination
and the field lengths are not included in the data. One device that sends 2
different commands will be seen as 2 devices on Home Assistant. For such cases,
the following options are available in order to circumvent the problem:
- **data_bits** (*Optional*)
- **command_on** (*Optional*)
- **command_off** (*Optional*)
Let's try to add a new PT-2262 sensor using the "automatic_add"
option and have a look at Home Assistant system log.
Have your sensor trigger the "On" state for the first time.
Some messages will appear:
```text
INFO (Thread-6) [homeassistant.components.binary_sensor.rfxtrx] Added binary sensor 0913000022670e013970 (Device_id: 22670e Class: LightingDevice Sub: 0)
```
Here the sensor has the id *22670e*.
Now have your sensor trigger the "Off" state and look for the following
message in the Home Assistant log. You should see that your device
has been detected as a *new* device when triggering its "Off" state:
```text
INFO (Thread-6) [homeassistant.components.binary_sensor.rfxtrx] Added binary sensor 09130000226707013d70 (Device_id: 226707 Class: LightingDevice Sub: 0)
```
Here the device id is *226707*, which is almost similar to
the *22670e* we had on the "On" event a few seconds ago.
From those two values, you can guess that the actual id of your device is
*22670*, and that *e* and *7* are commands for "On" and "Off" states
respectively. As one hexadecimal digit uses 4 bits,
we can conclude that the device is using 4 data bits.
So, here is the actual configuration section for the binary sensor:
```yaml
rfxtrx:
automatic_add: false
host: 192.168.0.2
port: 50000
devices:
0913000022670e013b70:
device_class: opening
data_bits: 4
command_on: 0xe
command_off: 0x7
```
The *automatic_add* option makes the RFXtrx binary sensor integration calculate
and display the configuration options for you in the Home Assistant logs:
```text
INFO (Thread-6) [homeassistant.components.rfxtrx] rfxtrx: found possible device 226707 for 22670e with the following configuration:
data_bits=4
command_on=0xe
command_off=0x7
INFO (Thread-6) [homeassistant.components.binary_sensor.rfxtrx] Found possible matching deviceid 22670e.
```
This automatic guess should work most of the time, but there is
no guarantee on that. You should activate it only when you
want to configure your new devices and leave it off otherwise.
#### Known working devices
The following devices are known to work with the RFXtrx binary sensor component.
There are too many other to list.
- Motion detectors:
- Kerui P817 and P829.
- Chuango PIR-700.
- Door / window sensors:
- Kerui D026 door / window sensor: can trigger on "open" and "close". Has a tamper switch.
- Nexa LMST-606.
## Events ## Events
The rftrx integration will signal an event on reception of messages from the RFXtrx device on the following form. The RFXtrx integration will signal an event on the reception of messages from and RFXtrx device on the following form. For the signal to be available, the `fire_event` parameter must be set on the device in configuration.
*Signal from a byron doorbell button:* *Signal from a byron doorbell button:*
@ -98,7 +423,7 @@ values':
You can setup automations to react to these events. When you do don't include more fields than needed. Always include the device identifying fields, `packet_type`, `sub_type` and `id_string`. You can setup automations to react to these events. When you do don't include more fields than needed. Always include the device identifying fields, `packet_type`, `sub_type` and `id_string`.
So for example to trigger a action when somebody presses the doorbell, you would set up a automation with the following trigger: So, for example, to trigger an action when somebody presses the doorbell, you would set up an automation with the following trigger:
*Automation trigger:* *Automation trigger:*
@ -141,6 +466,18 @@ automation:
entity_id: scene.welcomescene entity_id: scene.welcomescene
``` ```
### Discovering events for your devices ## Services
To figure out what your devices send, you can listen on the `rfxtrx_event` in the development tool/event page. - `rftrx.send`: Send a custom event using the RFXtrx device.
#### Service: Send
Simulate a button being pressed:
```yaml
...
action:
service: rftrx.send
data:
event: 0b1111e003af16aa10000060
```

119
source/_integrations/sensor.rfxtrx.markdown
View File

@ -1,119 +0,0 @@
---
title: "RFXtrx Sensor"
description: "Instructions on how to integrate RFXtrx sensors into Home Assistant."
ha_category:
- Sensor
ha_iot_class: Local Polling
ha_release: 0.7
ha_domain: rfxtrx
---
The `rfxtrx` platform support sensors that communicate in the frequency range of 433.92 MHz.
First you have to set up your [RFXtrx hub](/integrations/rfxtrx/).
The easiest way to find your sensors is to add this to your `configuration.yaml`:
```yaml
# Example configuration.yaml entry
sensor:
platform: rfxtrx
automatic_add: true
```
Then when the sensor emits a signal it will be automatically added:
<p class='img'>
<img src='/images/integrations/rfxtrx/sensor.png' />
</p>
Here the name is `0a52080000301004d240259` or `0a52080000301004d240259_temperature` and you can verify that it works from the frontend.
Then you should update your configuration to (_temperature is not needed):
```yaml
# Example configuration.yaml entry
sensor:
platform: rfxtrx
devices:
0a52080000301004d240259:
name: device_name
```
If you want to display several data types from one sensor:
```yaml
# Example configuration.yaml entry
sensor:
platform: rfxtrx
devices:
0a520802060100ff0e0269:
name: Bath
data_type:
- Humidity
- Temperature
```
Only these data_type are valid:
- *Temperature*, *Temperature2*
- *Humidity*
- *Humidity status*
- *Barometer*
- *Wind direction*
- *Wind average speed*
- *Wind gust*
- *Rain rate*
- *Rain total*
- *Sound*
- *Sensor Status*
- *Counter value*
- *UV*
- *Forecast*
- *Forecast numeric*
- *Chill*
- *Energy usage*
- *Total usage*
- *Voltage*
- *Current*
- *Battery numeric*
- *Rssi numeric*
Example configuration:
```yaml
# Example configuration.yaml entry
sensor:
platform: rfxtrx
automatic_add: true
devices:
0a520802060100ff0e0269:
name: Bath
data_type:
- Humidity
- Temperature
```
{% configuration %}
devices:
description: A list of devices.
required: false
type: list
keys:
name:
description: Override the name to use in the frontend.
required: false
type: string
data_type:
description: Which data type the sensor should show.
required: false
type: list
automatic_add:
description: To enable the automatic addition of new lights.
required: false
default: false
type: boolean
{% endconfiguration %}
<div class='note warning'>
If a device ID consists of only numbers, please make sure to surround it with quotes.
This is a known limitation in YAML, because the device ID will be interpreted as a number otherwise.
</div>

108
source/_integrations/switch.rfxtrx.markdown
View File

@ -1,108 +0,0 @@
---
title: "RFXtrx Switch"
description: "Instructions on how to integrate RFXtrx switches into Home Assistant."
ha_category:
- Switch
ha_release: 0.7.5
ha_domain: rfxtrx
---
The `rfxtrx` platform support switches that communicate in the frequency range of 433.92 MHz.
## Configuration
First you have to set up your [RFXtrx hub](/integrations/rfxtrx/).
The easiest way to find your switches is to add this to your `configuration.yaml`:
```yaml
# Example configuration.yaml entry
switch:
platform: rfxtrx
automatic_add: true
```
Launch your Home Assistant and go to the website.
Push your remote and your device should be added:
<p class='img'>
<img src='/images/integrations/rfxtrx/switch.png' />
</p>
Here the name is `0b11000102ef9f210010f70` and you can verify that it works from the frontend.
Then you should update your configuration to:
```yaml
# Example configuration.yaml entry
switch:
platform: rfxtrx
devices:
0b11000102ef9f210010f70:
name: device_name
```
{% configuration %}
devices:
description: A list of devices.
required: false
type: list
keys:
name:
description: Override the name to use in the frontend.
required: true
type: string
automatic_add:
description: To enable the automatic addition of new switches.
required: false
default: false
type: boolean
signal_repetitions:
description: Because the RFXtrx device sends its actions via radio and from most receivers, it's impossible to know if the signal was received or not. Therefore you can configure the switch to try to send each signal repeatedly.
required: false
type: integer
{% endconfiguration %}
<div class='note warning'>
This integration and the [RFXtrx binary sensor](/integrations/binary_sensor.rfxtrx/) can steal each other's devices when setting the `automatic_add` configuration parameter to `true`. Set `automatic_add` only when you have some devices to add to your installation, otherwise leave it to `false`.
</div>
<div class='note warning'>
If a device ID consists of only numbers, please make sure to surround it with quotes.
This is a known limitation in YAML, because the device ID will be interpreted as a number otherwise.
</div>
Generate codes:
If you need to generate codes for switches you can use a template (useful for example COCO switches).
- Go to home-assistant-IP:8123/dev-template
- Use this code to generate a code:
```yaml
{% raw %}0b11000{{ range(100,700) | random | int }}bc0cfe0{{ range(0,10) | random | int }}010f70{% endraw %}
```
- Use this code to add a new switch in your `configuration.yaml`
- Launch your Home Assistant and go to the website.
- Enable learning mode on your switch (i.e., push learn button or plug it in a wall socket)
- Toggle your new switch in the Home Assistant interface
## Examples
Basic configuration with 3 devices:
```yaml
# Example configuration.yaml entry
switch:
platform: rfxtrx
automatic_add: false
signal_repetitions: 2
devices:
0b1100ce3213c7f210010f70:
name: Movement1
0b11000a02ef2gf210010f50:
name: Movement2
0b1111e003af16aa10000060:
name: Door
```

5
source/_redirects
View File

@ -173,6 +173,7 @@
/components/binary_sensor.rainmachine /integrations/rainmachine /components/binary_sensor.rainmachine /integrations/rainmachine
/components/binary_sensor.random /integrations/random#binary-sensor /components/binary_sensor.random /integrations/random#binary-sensor
/components/binary_sensor.raspihats /integrations/raspihats#binary-sensor /components/binary_sensor.raspihats /integrations/raspihats#binary-sensor
/components/binary_sensor.rfxtrx /integrations/rfxtrx#binary-sensor
/components/binary_sensor.ring /integrations/ring#binary-sensor /components/binary_sensor.ring /integrations/ring#binary-sensor
/components/binary_sensor.rpi_gpio /integrations/rpi_gpio#binary-sensor /components/binary_sensor.rpi_gpio /integrations/rpi_gpio#binary-sensor
/components/binary_sensor.rpi_pfio /integrations/rpi_pfio#binary-sensor /components/binary_sensor.rpi_pfio /integrations/rpi_pfio#binary-sensor
@ -304,6 +305,7 @@
/components/cover.lutron_caseta /integrations/lutron_caseta#cover /components/cover.lutron_caseta /integrations/lutron_caseta#cover
/components/cover.myq /integrations/myq /components/cover.myq /integrations/myq
/components/cover.opengarage /integrations/opengarage /components/cover.opengarage /integrations/opengarage
/components/cover.rfxtrx /integrations/rfxtrx#cover
/components/cover.rpi_gpio /integrations/rpi_gpio#cover /components/cover.rpi_gpio /integrations/rpi_gpio#cover
/components/cover.scsgate /integrations/scsgate#cover /components/cover.scsgate /integrations/scsgate#cover
/components/cover.smartthings /integrations/smartthings#cover /components/cover.smartthings /integrations/smartthings#cover
@ -447,6 +449,7 @@
/components/light.plum_lightpad /integrations/plum_lightpad /components/light.plum_lightpad /integrations/plum_lightpad
/components/light.qwikswitch /integrations/qwikswitch /components/light.qwikswitch /integrations/qwikswitch
/components/light.rpi_gpio_pwm /integrations/rpi_gpio_pwm /components/light.rpi_gpio_pwm /integrations/rpi_gpio_pwm
/components/light.rfxtrx /integrations/rfxtrx#light
/components/light.scsgate /integrations/scsgate#light /components/light.scsgate /integrations/scsgate#light
/components/light.sensehat /integrations/sensehat#light /components/light.sensehat /integrations/sensehat#light
/components/light.sisyphus /integrations/sisyphus /components/light.sisyphus /integrations/sisyphus
@ -827,6 +830,7 @@
/components/sensor.reddit /integrations/reddit /components/sensor.reddit /integrations/reddit
/components/sensor.rejseplanen /integrations/rejseplanen /components/sensor.rejseplanen /integrations/rejseplanen
/components/sensor.rest /integrations/rest /components/sensor.rest /integrations/rest
/components/sensor.rfxtrx /integrations/rfxtrx#sensor
/components/sensor.ring /integrations/ring#sensor /components/sensor.ring /integrations/ring#sensor
/components/sensor.ripple /integrations/ripple /components/sensor.ripple /integrations/ripple
/components/sensor.rmvtransport /integrations/rmvtransport /components/sensor.rmvtransport /integrations/rmvtransport
@ -1006,6 +1010,7 @@
/components/switch.raspihats /integrations/raspihats#switch /components/switch.raspihats /integrations/raspihats#switch
/components/switch.raspyrfm /integrations/raspyrfm /components/switch.raspyrfm /integrations/raspyrfm
/components/switch.recswitch /integrations/recswitch /components/switch.recswitch /integrations/recswitch
/components/switch.rfxtrx /integrations/rfxtrx#switch
/components/switch.rpi_gpio /integrations/rpi_gpio#switch /components/switch.rpi_gpio /integrations/rpi_gpio#switch
/components/switch.rpi_pfio /integrations/rpi_pfio#switch /components/switch.rpi_pfio /integrations/rpi_pfio#switch
/components/switch.rpi_rf /integrations/rpi_rf /components/switch.rpi_rf /integrations/rpi_rf