From 92d4a2568fc296e8ac47116208e3fa05eddd2346 Mon Sep 17 00:00:00 2001 From: Micha LaQua Date: Tue, 10 May 2016 20:47:08 +0200 Subject: [PATCH] rpi_rf: Update module description --- source/_components/switch.rpi_rf.markdown | 28 +++++++++++++++-------- 1 file changed, 18 insertions(+), 10 deletions(-) diff --git a/source/_components/switch.rpi_rf.markdown b/source/_components/switch.rpi_rf.markdown index 0338a091cbc..683c919e84f 100644 --- a/source/_components/switch.rpi_rf.markdown +++ b/source/_components/switch.rpi_rf.markdown @@ -1,8 +1,8 @@ --- layout: page -title: "Raspberry PI GPIO Switch" -description: "Instructions how to integrate the GPIO of a Raspberry PI into Home Assistant as a switch." -date: 2016-05-07 09:00 +title: "Raspberry Pi RF Switch" +description: "Instructions how to integrate devices controlled via codes sent with low-cost GPIO RF modules on a Raspberry Pi into Home Assistant as a switch." +date: 2016-05-10 09:00 sidebar: true comments: false sharing: true @@ -15,7 +15,10 @@ ha_release: 0.19 The `rpi_rf` switch platform allows you to control devices over 433/315MHz LPD/SRD signals with generic low-cost GPIO RF modules on a [Raspberry Pi](https://www.raspberrypi.org/). -To use your Raspberry Pi with a 433MHz adaptor in your installation, add the following to your `configuration.yaml` file: +Interoperable with codes sniffed via [the rpi-rf module](https://pypi.python.org/pypi/rpi-rf) or [rc-switch](https://github.com/sui77/rc-switch). +For more info see the PyPi module description: [rpi-rf](https://pypi.python.org/pypi/rpi-rf). + +To enable, add the following to your `configuration.yaml`: ```yaml # Example configuration.yaml entry @@ -30,14 +33,19 @@ switch: pulselength: 200 code_on: 987654 code_off: 133742 + living_room_light: + protocol: 5 + code_on: 654321 + code_off: 654320 ``` Configuration variables: -- **gpio** array (*Required*): Array of used ports. -- **switches:** (*Required*): Array of switches. - - **[name]** (*Requireld*): If true, inverts the output logic to ACTIVE LOW. Default is false (ACTIVE HIGH). - - **code_on** (*Requireld*): Code to switch the device on, eg. `987654`. - - **code_off** (*Requireld*): Code to switch the device off, eg. `133742`. - - **pulselength** (*Optional*): Length of the pulse +- **gpio** (*Required*): GPIO to which the data line of the TX module is connected. +- **switches:** (*Required*): The array that contains all switches. + - **[entry]** (*Required*): Name of the switch. Multiple entries are possible. + - **code_on** (*Required*): Decimal code to switch the device on. + - **code_off** (*Required*): Decimal code to switch the device off. + - **protocol** (*Optional*): RF Protocol (Default is `1`). + - **pulselength** (*Optional*): Pulselength (Default is the protocol default).