Update rfxtrx documentation

This commit is contained in:
Daniel Høyer Iversen 2016-04-26 15:31:55 +02:00 committed by Paulus Schoutsen
parent f74237f582
commit 99536c46da
6 changed files with 116 additions and 54 deletions

View File

@ -12,19 +12,42 @@ ha_category: Light
The `rfxtrx` platform support lights that communicate in the frequency range of 433.92 MHz. The `rfxtrx` platform support lights that communicate in the frequency range of 433.92 MHz.
To enable RFXtrx lights in your installation, add the following to your `configuration.yaml` file: First you have to set up your [rfxtrx hub.](/components/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 homeassistant and go the website.
Push your remote and your device should be added:
<p class='img'>
<img src='/images/components/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 ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
light: light:
platform: rfxtrx platform: rfxtrx
signal_repetitions: 3 devices:
devices: 0b11000f10e9e5660b010f70:
living_room: name: Light1
name: Living Room 0b1100100f29e5660c010f70:
packetid: XXXXX name: Light_TV
fire_event: True
automatic_add: True
``` ```
Configuration variables: Configuration variables:

View File

@ -20,33 +20,10 @@ rfxtrx:
debug: True debug: True
``` ```
Configuration variables: Configuration variables:
- **device** (*Required*): The path to your device, e.g. `/dev/serial/by-id/usb-RFXCOM_RFXtrx433_A1Y0NJGR-if00-port0` - **device** (*Required*): The path to your device, e.g. `/dev/serial/by-id/usb-RFXCOM_RFXtrx433_A1Y0NJGR-if00-port0`
- **debug** (*Optional*): If you want to receive debug output. - **debug** (*Optional*): If you want to receive debug output.
### How to find the packet_id for your devices
Make sure you have enabled all RFXtrx related platforms. Push your remote and the device will be added automatically. After that you can see you device packetid in the state developer tools in the app.
Example for X10 and Chacon DI.O signals, if you see in state developer tools the following entities:
```
light.123efab1__1b2200000890efab1213f60
light.a8__0123454041230170
```
You must add the following to your `configuration.yaml`:
```YAML
light:
platform: rfxtrx
automatic_add: True
devices:
123efab1:
name: My DI.0 light device
packetid: 1b2200000890efab1213f60
a8:
name: My X10 light device
packetid: 0123454041230170
```

View File

@ -12,25 +12,59 @@ ha_category: Sensor
The `rfxtrx` platform support sensors that communicate in the frequency range of 433.92 MHz. The `rfxtrx` platform support sensors that communicate in the frequency range of 433.92 MHz.
To enable RFXtrx sensors in your installation, add the following to your `configuration.yaml` file: First you have to set up your [rfxtrx hub.](/components/rfxtrx/)
The easiest way to find your sensors is to add this to your `configuration.yaml`:
```yaml
sensor:
platform: rfxtrx
automatic_add: True
```
Then when the sensor emits a signal it will be automatically added:
<p class='img'>
<img src='/images/components/rfxtrx/sensor.png' />
</p>
Here the name is 0a52080000301004d240259 and you can verify that it works from the frontend.
Then you should update your configuration to:
```yaml
sensor:
platform: rfxtrx
devices:
0a52080000301004d240259:
name: device_name
```
If you want to display several data types from one sensor:
```yaml
sensor:
platform: rfxtrx
devices:
0a520802060100ff0e0269:
name: Bath
data_type:
- Humidity
- Temperature
```
Example configuration:
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
sensor: sensor:
platform: rfxtrx platform: rfxtrx
automatic_add: True automatic_add: True
devices: devices:
sensor_0502: 0a52080705020095220269:
name: Lving name: Lving
packetid: 0a52080705020095220269 0a520802060100ff0e0269:
data_type: Temperature name: Bath
sensor_0601: data_type:
name: Bath_Humidity - Humidity
packetid: 0a520802060100ff0e0269 - Temperature
data_type: Humidity
sensor_0601 2:
name: Bath
packetid: 0a520802060100ff0e0269
``` ```
Configuration variables: Configuration variables:
@ -38,3 +72,4 @@ Configuration variables:
- **devices** (*Optional*): A list of devices with their name to use in the frontend. - **devices** (*Optional*): A list of devices with their name to use in the frontend.
- **automatic_add** (*Optional*): To enable the automatic addition of new lights. - **automatic_add** (*Optional*): To enable the automatic addition of new lights.
- **data_type** (*Optional*): Which data type the sensor should show - **data_type** (*Optional*): Which data type the sensor should show

View File

@ -12,19 +12,46 @@ ha_category: Switch
The `rfxtrx` platform support switches that communicate in the frequency range of 433.92 MHz. The `rfxtrx` platform support switches that communicate in the frequency range of 433.92 MHz.
To enable RFXtrx switches in your installation, add the following to your `configuration.yaml` file: First you have to set up your [rfxtrx hub.](/components/rfxtrx/)
The easiest way to find your switches is to add this to your `configuration.yaml`:
```yaml ```yaml
# Example configuration.yaml entry
switch: switch:
platform: rfxtrx platform: rfxtrx
signal_repetitions: 3 automatic_add: True
devices: ```
living_room:
name: Living Room Launch your homeassistant and go the website.
packetid: XXXXX Push your remote and your device should be added:
fire_event: True
automatic_add: True <p class='img'>
<img src='/images/components/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
switch:
platform: rfxtrx
devices:
0b11000102ef9f210010f70:
name: device_name
```
Example configuration:
```yaml
# Example configuration.yaml entry
switch:
platform: rfxtrx
automatic_add: False
signal_repetitions: 2
devices:
0b1100ce3213c7f210010f70:
name: Movment1
0b11000a02ef2gf210010f50:
name: Movment2
0b1111e003af16aa10000060:
name: Door
``` ```
Configuration variables: Configuration variables:

Binary file not shown.

After

Width:  |  Height:  |  Size: 24 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.9 KiB