Initial documentation for cover templates #2842
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Landrash
requested changes
Jun 20, 2017
| @@ -0,0 +1,77 @@ | |||
| --- | |||
| layout: page | |||
| title: "Template Light" | |||
| --- | ||
| layout: page | ||
| title: "Template Light" | ||
| description: "Instructions how to integrate Template lights into Home Assistant." |
| layout: page | ||
| title: "Template Light" | ||
| description: "Instructions how to integrate Template lights into Home Assistant." | ||
| date: 2016-05-18 20:32 |
There was a problem hiding this comment.
Update date to actual date of creation?
| logo: home-assistant.png | ||
| --- | ||
|
|
||
| The `template` platform creates covers that combine components and provides the ability to run scripts or invoke services for each of the open, close, stop, position, and tilt commands of a cover. |
There was a problem hiding this comment.
The templateplatform can create.
|
|
||
| Configuration variables: | ||
|
|
||
| - **coverss** array (*Required*): List of your coverss. |
There was a problem hiding this comment.
cover instead of coverss?
| - **coverss** array (*Required*): List of your coverss. | ||
| - **friendly_name** (*Optional*): Name to use in the Frontend. | ||
| - **value_template** (*Optional*): Defines a [template](/topics/templating/) to get the state of the cover. Legal valules are open/true or closed/false. Either value_template or position_template must be specified. | ||
| - **position_template** (*Optional*): Defines a [template](/topics/templating/) to get the state of the cover. Legal values are numbers between 0 (closed and 100 (open). Either value_template or position_template must be specified. |
There was a problem hiding this comment.
(closed is missing closing ).
| - **stop_cover** (*Required*): Defines an [action](/getting-started/automation/) to run when the cover is stopped. | ||
| - **set_cover_position** (*Optional*): Defines an [action](/getting-started/automation/) to run when the cover is set to a specific value (between 0 and 100). | ||
| - **set_cover_tilt_position** (*Optional*): Defines an [action](/getting-started/automation/) to run when the cover tilt is set to a specific value (between 0 and 100). | ||
| - **entity_id** (*Optional*): Add a list of entity IDs so the switch only reacts to state changes of these entities. This will reduce the number of times the light will try to update it's state. |
|
|
||
| ## {% linkable_title Examples %} | ||
|
|
||
| In this section you will find some real life examples of how to use this light. |
|
Thank you for taking the time to review this |
|
@PhracturedBlue No problem. Looks good and can be merged when parent PR is merged. |
Landrash
approved these changes
Jun 21, 2017
3 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description:
Documentation for cover templates
Pull request in home-assistant (if applicable): home-assistant/core#8100