From 1e61a6d2a305f2c082b730ed7d294478d3efed5f Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Wed, 24 Oct 2018 09:26:46 +0200 Subject: [PATCH] Update Flux switch component configuration (#7045) * Update Flux switch component configuration * :pencil2: update description of lights --- source/_components/switch.flux.markdown | 72 +++++++++++++++++++------ 1 file changed, 57 insertions(+), 15 deletions(-) diff --git a/source/_components/switch.flux.markdown b/source/_components/switch.flux.markdown index cb9668f74c2..267173689a1 100644 --- a/source/_components/switch.flux.markdown +++ b/source/_components/switch.flux.markdown @@ -34,20 +34,63 @@ switch: - light.lamp ``` -Configuration variables: - -- **lights** (*Required*) array: List of light entities. -- **name** (*Optional*): The name to use when displaying this switch. -- **start_time** (*Optional*): The start time. Default to sunrise. -- **stop_time** (*Optional*): The stop time. Defaults to dusk. -- **start_colortemp** (*Optional*): The color temperature at the start. Defaults to `4000`. -- **sunset_colortemp** (*Optional*): The sun set color temperature. Defaults to `3000`. -- **stop_colortemp** (*Optional*): The color temperature at the end. Defaults to `1900`. -- **brightness** (*Optional*): The brightness of the lights. Calculated with `RGB_to_xy` by default. -- **disable_brightness_adjust** (*Optional*): If true, brightness will not be adjusted besides color temperature. Defaults to False. -- **mode** (*Optional*): Select how color temperature is passed to lights. Valid values are `xy`, `mired` and `rgb`. Defaults to `xy`. -- **transition** (*Optional*): Transition time for the light changes (high values may not be supported by all light models). Defaults to 30. -- **interval** (*Optional*): Frequency at which the lights should be updated. Defaults to 30. +{% configuration %} +lights: + description: array list of light entities. + required: true + type: list +name: + description: The name to use when displaying this switch. + required: false + default: Flux + type: string +start_time: + description: The start time. + required: false + type: time +stop_time: + description: The stop time. + required: false + type: time +start_colortemp: + description: The color temperature at the start. + required: false + default: 4000 + type: integer +sunset_colortemp: + description: The sun set color temperature. + required: false + default: 3000 + type: integer +stop_colortemp: + description: The color temperature at the end. + required: false + default: 1900 + type: integer +brightness: + description: The brightness of the lights. + required: false + type: integer +disable_brightness_adjust: + description: If true, brightness will not be adjusted besides color temperature. + required: false + type: boolean +mode: + description: Select how color temperature is passed to lights. Valid values are `xy`, `mired` and `rgb`. + required: false + default: xy + type: string +transition: + description: Transition time for the light changes (high values may not be supported by all light models). + required: false + default: 30 + type: integer +interval: + description: Frequency at which the lights should be updated. + required: false + default: 30 + type: integer +{% endconfiguration %} Full example: @@ -70,4 +113,3 @@ switch: transition: 30 interval: 60 ``` -