Template Light Platform documentation #2661
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
3 tasks
fabaff
reviewed
May 19, 2017
| theater_volume: | ||
| friendly_name: 'Receiver Volume' | ||
| value_template: >- | ||
| {%- if is_state("media_player.receiver", "on") -%} |
There was a problem hiding this comment.
To avoid render of the template, use {% raw %}{{your_template}}{% endraw %}.
Landrash
requested changes
May 19, 2017
| To enable Template lights in your installation, add the following to your `configuration.yaml` file: | ||
|
|
||
| ```yaml | ||
| # Example configuration.yaml entry |
There was a problem hiding this comment.
This example doesn't seem to have anything todo with lights?
|
|
||
| The `template` platform creates lights that combine components. | ||
|
|
||
| For example, if you have a garage door with a toggle switch that operates the motor and a sensor that allows you know whether the door is open or closed, you can combine these into a switch that knows whether the garage door is open or closed. If your garage door also has the ability to where you can set its position, you can bind the `set_level` command to a script or service and capture the brightness variable and manipulate it before sending it to your script or service. |
There was a problem hiding this comment.
Template light and example is for a garage door?
|
|
||
| ```yaml | ||
| # Example configuration.yaml entry | ||
| light: |
There was a problem hiding this comment.
A simpler example for users getting started could be preferable and having the advanced one as an option after the configuration variables.
Landrash
approved these changes
May 19, 2017
emlove
reviewed
May 22, 2017
|
|
||
| The `template` platform creates lights that combine components. | ||
|
|
||
| This provides pretty much the same functionality as a [template switch](/components/switch.template/) with the exception is that you can pass brightness commands through. |
There was a problem hiding this comment.
I'd rewrite this paragraph assuming the user hasn't yet read about template switches. Just describe what this platform will do here. You can keep a link at the end, or in a see also section, but this page should stand alone.
Landrash
approved these changes
May 23, 2017
emlove
reviewed
May 24, 2017
| - **turn_off** (*Required*): Defines an [action](/getting-started/automation/) to run when the light is turned off. | ||
| - **set_level** (*Optional*): Defines an [action](/getting-started/automation/) to run when the light is given a brightness command. | ||
| - **level_template** (*Optional): Defines a [template](/topics/templating/) to get the brightness of the light. If not provided the component defaults to optimisitc brightness determination. | ||
|
|
There was a problem hiding this comment.
entity_id is missing here. It can be copied from the template switch docs.
…ine with actual example
|
I fixed the name of the light in the example while I was in there
…On Wed, May 24, 2017 at 2:17 PM, Adam Mills ***@***.***> wrote:
***@***.**** commented on this pull request.
------------------------------
In source/_components/light.template.markdown
<#2661 (comment)>
:
> + service: script.theater_lights_level
+ data_template:
+ volume_level: "{% raw %}{{brightness}}{% endraw %}"
+ level_template: "{% raw %}{{is_state('sensor.theater_brightness.attributes.lux'}}{% endraw %}"
+```
+
+Configuration variables:
+
+- **lights** array (*Required*): List of your lights.
+ - **friendly_name** (*Optional*): Name to use in the Frontend.
+ - **value_template** (*Optional*): Defines a [template](/topics/templating/) to get the state of the light. If not provided the component defaults to optimisitc state determination.
+ - **turn_on** (*Required*): Defines an [action](/getting-started/automation/) to run when the light is turned on.
+ - **turn_off** (*Required*): Defines an [action](/getting-started/automation/) to run when the light is turned off.
+ - **set_level** (*Optional*): Defines an [action](/getting-started/automation/) to run when the light is given a brightness command.
+ - **level_template** (*Optional): Defines a [template](/topics/templating/) to get the brightness of the light. If not provided the component defaults to optimisitc brightness determination.
+
entity_id is missing here. It can be copied from the template switch docs.
—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub
<#2661 (review)>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/ABjyferX-w7SY08RZq-X7cxjaENh0SuPks5r9HQpgaJpZM4Nghbn>
.
|
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:
The Light platform analog to the Template Switch
Pull request in home-assistant (if applicable): home-assistant/core#7657