Fix configuration variables and add full configuration sample

This commit is contained in:
Fabian Affolter 2016-12-18 09:50:18 +01:00
parent 733559db17
commit 418fde8100
No known key found for this signature in database
GPG Key ID: DDF3D6F44AAB1336

View File

@ -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: 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 ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
cover: cover:
@ -37,12 +57,4 @@ cover:
name: 'Right door' 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.