From e19680eb69efcfec64758d2d57ed9316d7a327d4 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Sat, 27 Aug 2016 12:53:28 +0200 Subject: [PATCH] Minor updates --- .../_components/cover.command_line.markdown | 24 ++++++------------- source/_components/cover.rpi_gpio.markdown | 5 ++-- source/_components/cover.scsgate.markdown | 19 ++++++++------- source/_components/cover.zwave.markdown | 7 +++--- 4 files changed, 25 insertions(+), 30 deletions(-) diff --git a/source/_components/cover.command_line.markdown b/source/_components/cover.command_line.markdown index 23778344f76..d7e223ca011 100644 --- a/source/_components/cover.command_line.markdown +++ b/source/_components/cover.command_line.markdown @@ -9,13 +9,12 @@ sharing: true footer: true logo: command_line.png ha_category: Cover +ha_release: 0.14 --- -A cover platform that issues specific commands when it is moved up, down and -stopped. It allows anyone to integrate any type of cover into Home Assistant -that can be controlled from the command line. -To enable a command line cover in your installation, add the following to your -`configuration.yaml` file: +A `command_line`cover platform that issues specific commands when it is moved up, down and stopped. It allows anyone to integrate any type of cover into Home Assistant that can be controlled from the command line. + +To enable a command line cover in your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry @@ -39,18 +38,9 @@ cover: Configuration variables: - **covers** (*Required*): The array that contains all command line covers. - - **entry** (*Required*): Name of the command line cover. Multiple entries - are possible. + - **entry** (*Required*): Name of the command line cover. Multiple entries are possible. - **open_cmd** (*Required*): The command to open the cover. - **close_cmd** (*Required*): The action to close the cover. - **stop_cmd** (*Required*): The action to stop the cover. - - **state_cmd** (*Optional*): If given, this will act as a sensor that runs - in the background and updates the state of the cover. If the command - returns a `0` the indicates the cover is fully closed, whereas a 100 - indicates the cover is fully open. - - **value_template** (*optional - default: '{% raw %}{{ value }}{% endraw - %}'*): if specified, `state_cmd` will ignore the result code of the - command but the template evaluating will indicate the position of the - cover. For example, if your `state_cmd` returns a string "open", - using `value_template` as in the example config above will allow you to - translate that into the valid state `100`. + - **state_cmd** (*Optional*): If given, this will act as a sensor that runs in the background and updates the state of the cover. If the command returns a `0` the indicates the cover is fully closed, whereas a 100 indicates the cover is fully open. + - **value_template** (*optional - default: '{% raw %}{{ value }}{% endraw%}'*): if specified, `state_cmd` will ignore the result code of the command but the template evaluating will indicate the position of the cover. For example, if your `state_cmd` returns a string "open", using `value_template` as in the example config above will allow you to translate that into the valid state `100`. diff --git a/source/_components/cover.rpi_gpio.markdown b/source/_components/cover.rpi_gpio.markdown index 86d58fe0213..eafa1d6f97f 100644 --- a/source/_components/cover.rpi_gpio.markdown +++ b/source/_components/cover.rpi_gpio.markdown @@ -9,12 +9,13 @@ sharing: true footer: true logo: raspberry-pi.png ha_category: Cover -ha_release: 0.27 +ha_release: 0.23 --- The `rpi_gpio` cover platform allows you to use a Raspberry Pi to control your cover such as Garage doors. -It uses two pins on the Raspberry Pi. +It uses two pins on the Raspberry Pi. + - The `state_pin` will detect if the cover is closed, and - the `relay_pin` will trigger the cover to open or close. diff --git a/source/_components/cover.scsgate.markdown b/source/_components/cover.scsgate.markdown index 7d8542f5b64..44777a28154 100644 --- a/source/_components/cover.scsgate.markdown +++ b/source/_components/cover.scsgate.markdown @@ -10,11 +10,10 @@ footer: true logo: bus_scs.png ha_category: Cover --- -The SCSGate devices can control motorized covers connected to the BTicino -MyHome system. -To enable SCSGate covers in your installation, add the following to your -`configuration.yaml` file: +The SCSGate devices can control motorized covers connected to the BTicino MyHome system. + +To enable SCSGate covers in your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry @@ -28,8 +27,12 @@ cover: Configuration variables: -- **devices** (*Required*): A list of devices with their name to use in the - frontend. +- **devices** array (*Required*): A list of devices. + - **[slug]** (*Required*): Slug of the device. + - **name** (*Required*): Name to use in the frontend. + - **scs_id** (*Required*): The ID of your SCSGate device. + +

+**Known limitation:** It is not possible to know the current state of the cover. +

-**Known limitation:** it is not possible to know the current state of the -cover. diff --git a/source/_components/cover.zwave.markdown b/source/_components/cover.zwave.markdown index 33d724a85d5..b01b2af5ab4 100644 --- a/source/_components/cover.zwave.markdown +++ b/source/_components/cover.zwave.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Z-Wave Cover" -description: "Instructions how to setup the Z-Wave binary sensors within Home Assistant." +description: "Instructions how to setup the Z-Wave covers within Home Assistant." date: 2016-08-24 14:15 sidebar: true comments: false @@ -9,8 +9,9 @@ sharing: true footer: true logo: z-wave.png ha_category: Cover -ha_release: 0.27 +ha_release: 0.23 --- -Garage doors and Rollershuters are supported as Cover in Home Assistant. +Z-Wave garage doors, blinds, and roller shutters are supported as cover in Home Assistant. + To get your Z-Wave covers working with Home Assistant, follow the instructions for the general [Z-Wave component](/components/zwave/).