From 418fde81004191bb60ad7beb5458ac74493bca00 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Sun, 18 Dec 2016 09:50:18 +0100 Subject: [PATCH] Fix configuration variables and add full configuration sample --- source/_components/cover.rpi_gpio.markdown | 28 +++++++++++++++------- 1 file changed, 20 insertions(+), 8 deletions(-) diff --git a/source/_components/cover.rpi_gpio.markdown b/source/_components/cover.rpi_gpio.markdown index 3b2205d724b..e51d150d2d5 100644 --- a/source/_components/cover.rpi_gpio.markdown +++ b/source/_components/cover.rpi_gpio.markdown @@ -23,6 +23,26 @@ Although you do not need Andrews Hilliday's software controller when you run Hom To enable Raspberry Pi Covers in your installation, add the following to your `configuration.yaml` file: +```yaml +# Example configuration.yaml entry +cover: + platform: rpi_gpio + covers: + - relay_pin: 10 + state_pin: 11 +``` + +Configuration variables: + +- **relay_time** (*Optional*): The time that the relay will be on for in seconds. Default is .2 seconds. +- **state_pull_mode** (*Optional*): The direction the State pin is pulling. It can be UP or DOWN. Default is UP. +- **covers** array (*Required*): List of your doors. + - **relay_pin** (*Required*): The pin of your Raspberry Pi where the relay is connected. + - **state_pin** (*Required*): The pin of your Raspberry Pi to retrieve the state. + - **name** (*Optional*): Name to use in the frontend. + +Full example: + ```yaml # Example configuration.yaml entry cover: @@ -37,12 +57,4 @@ cover: name: 'Right door' ``` -Configuration variables: - -- **covers** array (*Required*): List of your doors. - - **name** (*Optional*): Name to use in the Frontend. - - **relay_pin** (*Required*): The pin of your Raspberry Pi where the relay is connected. - - **state_pin** (*Required*): The pin of your Raspberry Pi to retrieve the state. - - **state_pull_mode** (*Optional*): The direction the State pin is pulling. It can be UP or DOWN. Default is UP. - - **relay_time** (*Optional*): The time that the relay will be on for in seconds. Default is .2 seconds.