From 8fee1fa0a1a92717797eb6fe92f326fd2225ce0d Mon Sep 17 00:00:00 2001 From: Alex Peters Date: Thu, 15 Jun 2023 05:14:30 +1000 Subject: [PATCH] Update light.template documentation (#27822) Co-authored-by: Franck Nijhof --- source/_integrations/light.template.markdown | 21 ++++++-------------- 1 file changed, 6 insertions(+), 15 deletions(-) diff --git a/source/_integrations/light.template.markdown b/source/_integrations/light.template.markdown index 64bb2d0bc66..05b65ff2055 100644 --- a/source/_integrations/light.template.markdown +++ b/source/_integrations/light.template.markdown @@ -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 %}