jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-25 10:17:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update light.template documentation (#27822)

Browse Source 
Co-authored-by: Franck Nijhof <frenck@frenck.nl>
This commit is contained in:
Alex Peters 2023-06-15 05:14:30 +10:00 committed by GitHub
parent 60c82707a9
commit 8fee1fa0a1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
source/_integrations/light.template.markdown
View File

@ -105,11 +105,6 @@ light:
required: false
type: template
default: optimistic
white_value_template:
description: Defines a template to get the white value of the light.
required: false
type: template
default: optimistic
color_template:
description: Defines a template to get the color of the light. Must render a tuple (hue, saturation)
required: false
@ -150,31 +145,27 @@ light:
type: template
default: true
turn_on:
description: Defines an action to run when the light is turned on.
description: Defines an action to run when the light is turned on. May receive variables `brightness` and/or `transition`.
required: true
type: action
turn_off:
description: Defines an action to run when the light is turned off.
description: Defines an action to run when the light is turned off. May receive variable `transition`.
required: true
type: action
set_level:
description: Defines an action to run when the light is given a brightness command. The script will only be called if the `turn_on` call only has brightness, and optionally transition.
description: Defines an action to run when the light is given a brightness command. The script will only be called if the `turn_on` call only has brightness, and optionally transition. Receives variables `brightness` and optionally `transition`.
required: false
type: action
set_temperature:
description: Defines an action to run when the light is given a color temperature command.
required: false
type: action
set_white_value:
description: Defines an action to run when the light is given a white value command.
description: Defines an action to run when the light is given a color temperature command. Receives variable `color_temp`. May also receive variables `brightness` and/or `transition`.
required: false
type: action
set_color:
description: Defines an action to run when the light is given a color command.
description: Defines an action to run when the light is given a color command. Receives variables `h`, `s`, and `hs` (which is equivalent to `(h, s)`). May also receive variables `brightness` and/or `transition`.
required: false
type: action
set_effect:
description: Defines an action to run when the light is given an effect command.
description: Defines an action to run when the light is given an effect command. Receives variable `effect`. May also receive variables `brightness` and/or `transition`.
required: inclusive
type: action
{% endconfiguration %}