Update Flux switch component configuration (#7045)

* Update Flux switch component configuration

* ✏️ update description of lights
This commit is contained in:
Klaas Schoute 2018-10-24 09:26:46 +02:00 committed by Fabian Affolter
parent 399b2089fc
commit 1e61a6d2a3

View File

@ -34,20 +34,63 @@ switch:
- light.lamp - light.lamp
``` ```
Configuration variables: {% configuration %}
lights:
- **lights** (*Required*) array: List of light entities. description: array list of light entities.
- **name** (*Optional*): The name to use when displaying this switch. required: true
- **start_time** (*Optional*): The start time. Default to sunrise. type: list
- **stop_time** (*Optional*): The stop time. Defaults to dusk. name:
- **start_colortemp** (*Optional*): The color temperature at the start. Defaults to `4000`. description: The name to use when displaying this switch.
- **sunset_colortemp** (*Optional*): The sun set color temperature. Defaults to `3000`. required: false
- **stop_colortemp** (*Optional*): The color temperature at the end. Defaults to `1900`. default: Flux
- **brightness** (*Optional*): The brightness of the lights. Calculated with `RGB_to_xy` by default. type: string
- **disable_brightness_adjust** (*Optional*): If true, brightness will not be adjusted besides color temperature. Defaults to False. start_time:
- **mode** (*Optional*): Select how color temperature is passed to lights. Valid values are `xy`, `mired` and `rgb`. Defaults to `xy`. description: The start time.
- **transition** (*Optional*): Transition time for the light changes (high values may not be supported by all light models). Defaults to 30. required: false
- **interval** (*Optional*): Frequency at which the lights should be updated. Defaults to 30. 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: Full example:
@ -70,4 +113,3 @@ switch:
transition: 30 transition: 30
interval: 60 interval: 60
``` ```