Add documentation for cwww and rgbww constant_brightness variables. (#530)

This commit is contained in:
kroimon 2020-04-08 14:31:35 +02:00 committed by GitHub
parent 00abf8b483
commit f832223c41
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 4 additions and 0 deletions

View File

@ -19,6 +19,7 @@ channels will be mixed using the color temperature configuration options.
warm_white: output_component2 warm_white: output_component2
cold_white_color_temperature: 6536 K cold_white_color_temperature: 6536 K
warm_white_color_temperature: 2000 K warm_white_color_temperature: 2000 K
constant_brightness: true
Configuration variables: Configuration variables:
------------------------ ------------------------
@ -30,6 +31,7 @@ Configuration variables:
of the cold white channel. of the cold white channel.
- **warm_white_color_temperature** (**Required**, float): The color temperate (in `mireds <https://en.wikipedia.org/wiki/Mired>`__ or Kelvin) - **warm_white_color_temperature** (**Required**, float): The color temperate (in `mireds <https://en.wikipedia.org/wiki/Mired>`__ or Kelvin)
of the warm white channel. of the warm white channel.
- **constant_brightness** (*Optional*, boolean): When enabled, this will keep the overall brightness of the cold and warm white channels constant by limiting the combined output to 100% of a single channel. This reduces the possible overall brightness but is necessary for some power supplies that are not able to run both channels at full brightness at once. Defaults to ``false``.
- **effects** (*Optional*, list): A list of :ref:`light effects <light-effects>` to use for this light. - **effects** (*Optional*, list): A list of :ref:`light effects <light-effects>` to use for this light.
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. - **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
- All other options from :ref:`Light <config-light>`. - All other options from :ref:`Light <config-light>`.

View File

@ -22,6 +22,7 @@ and warm white channels will be mixed using the color temperature configuration
warm_white: output_component5 warm_white: output_component5
cold_white_color_temperature: 6536 K cold_white_color_temperature: 6536 K
warm_white_color_temperature: 2000 K warm_white_color_temperature: 2000 K
constant_brightness: true
Color Correction Color Correction
---------------- ----------------
@ -63,6 +64,7 @@ Configuration variables:
of the cold white channel. of the cold white channel.
- **warm_white_color_temperature** (**Required**, float): The color temperate (in `mireds <https://en.wikipedia.org/wiki/Mired>`__ or Kelvin) - **warm_white_color_temperature** (**Required**, float): The color temperate (in `mireds <https://en.wikipedia.org/wiki/Mired>`__ or Kelvin)
of the warm white channel. of the warm white channel.
- **constant_brightness** (*Optional*, boolean): When enabled, this will keep the overall brightness of the cold and warm white channels constant by limiting the combined output to 100% of a single channel. This reduces the possible overall brightness but is necessary for some power supplies that are not able to run both channels at full brightness at once. Defaults to ``false``.
- **effects** (*Optional*, list): A list of :ref:`light effects <light-effects>` to use for this light. - **effects** (*Optional*, list): A list of :ref:`light effects <light-effects>` to use for this light.
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. - **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
- All other options from :ref:`Light <config-light>`. - All other options from :ref:`Light <config-light>`.