From c8c3316d574f1949ef44d5762a322860288dc20c Mon Sep 17 00:00:00 2001 From: Oxan van Leeuwen Date: Wed, 18 Aug 2021 01:07:43 +0200 Subject: [PATCH] Clarify some color temperature settings (#1396) --- components/light/color_temperature.rst | 10 ++++++---- components/light/cwww.rst | 4 ++-- components/light/rgbct.rst | 14 ++++++++------ components/light/rgbww.rst | 6 ++++-- 4 files changed, 20 insertions(+), 14 deletions(-) diff --git a/components/light/color_temperature.rst b/components/light/color_temperature.rst index fa9cba442..4689b9653 100644 --- a/components/light/color_temperature.rst +++ b/components/light/color_temperature.rst @@ -26,10 +26,12 @@ Configuration variables: - **name** (**Required**, string): The name of the light. - **color_temperature** (**Required**, :ref:`config-id`): The id of the float :ref:`output` to use for the color temperature. - **brightness** (**Required**, :ref:`config-id`): The id of the float :ref:`output` to use for the brightness. -- **cold_white_color_temperature** (**Required**, float): The color temperate (in `mireds `__ or Kelvin) - of the cold white channel. -- **warm_white_color_temperature** (**Required**, float): The color temperate (in `mireds `__ or Kelvin) - of the warm white channel. +- **cold_white_color_temperature** (**Required**, float): The coldest color temperature supported by this light. This + is the lowest value when expressed in `mireds `__, or the highest value when + expressed in Kelvin. +- **warm_white_color_temperature** (**Required**, float): The warmest color temperature supported by this light. This + is the highest value when expressed in `mireds `__, or the lowest value when + expressed in Kelvin. - **effects** (*Optional*, list): A list of :ref:`light effects ` to use for this light. - **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. - All other options from :ref:`Light `. diff --git a/components/light/cwww.rst b/components/light/cwww.rst index 589d1c517..6c008644e 100644 --- a/components/light/cwww.rst +++ b/components/light/cwww.rst @@ -40,9 +40,9 @@ Configuration variables: - **cold_white** (**Required**, :ref:`config-id`): The id of the float :ref:`output` to use for the cold white channel. - **warm_white** (**Required**, :ref:`config-id`): The id of the float :ref:`output` to use for the warm white channel. - **cold_white_color_temperature** (*Optional*, float): The color temperature (in `mireds `__ or Kelvin) - of the cold white channel. + of the cold white channel. Note that this option is required to control the mixing from Home Assistant. - **warm_white_color_temperature** (*Optional*, float): The color temperature (in `mireds `__ or Kelvin) - of the warm white channel. + of the warm white channel. Note that this option is required to control the mixing from Home Assistant. - **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 ` to use for this light. - **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. diff --git a/components/light/rgbct.rst b/components/light/rgbct.rst index 071fcd6dc..7e198bbb2 100644 --- a/components/light/rgbct.rst +++ b/components/light/rgbct.rst @@ -5,7 +5,7 @@ RGBCT Light :description: Instructions for setting up RGBCT lights. :image: rgbw.png -The ``rgbct`` light platform creates an RGBWT (colour temperature + white brightness) +The ``rgbct`` light platform creates an RGBWT (color temperature + white brightness) light from 5 :ref:`float output components ` (one for each channel). .. code-block:: yaml @@ -30,13 +30,15 @@ Configuration variables: - **green** (**Required**, :ref:`config-id`): The id of the float :ref:`output` to use for the green channel. - **blue** (**Required**, :ref:`config-id`): The id of the float :ref:`output` to use for the blue channel. - **color_temperature** (**Required**, :ref:`config-id`): The id of the float :ref:`output` to use for the - color temperature cannel. + color temperature channel. - **white_brightness** (**Required**, :ref:`config-id`): The id of the float :ref:`output` to use for the brightness of the white leds. -- **cold_white_color_temperature** (**Required**, float): The color temperate (in - `mireds `__ or Kelvin) of the cold white channel. -- **warm_white_color_temperature** (**Required**, float): The color temperate (in - `mireds `__ or Kelvin) of the warm white channel. +- **cold_white_color_temperature** (**Required**, float): The coldest color temperature supported by this light. This + is the lowest value when expressed in `mireds `__, or the highest value when + expressed in Kelvin. +- **warm_white_color_temperature** (**Required**, float): The warmest color temperature supported by this light. This + is the highest value when expressed in `mireds `__, or the lowest value when + expressed in Kelvin. - **color_interlock** (*Optional*, boolean): When enabled, this will prevent white leds being on at the same time as RGB leds. See :ref:`rgbw_color_interlock` for more information. Defaults to ``false``. - **effects** (*Optional*, list): A list of :ref:`light effects ` to use for this light. diff --git a/components/light/rgbww.rst b/components/light/rgbww.rst index d599682d7..e49adbd25 100644 --- a/components/light/rgbww.rst +++ b/components/light/rgbww.rst @@ -75,9 +75,11 @@ Configuration variables: - **warm_white** (**Required**, :ref:`config-id`): The id of the float :ref:`output` to use for the warm white channel. - **cold_white_color_temperature** (*Optional*, float): The color temperature (in - `mireds `__ or Kelvin) of the cold white channel. + `mireds `__ or Kelvin) of the cold white channel. Note that when the color interlock + is enabled, this option is required to control the light from Home Assistant. - **warm_white_color_temperature** (*Optional*, float): The color temperature (in - `mireds `__ or Kelvin) of the warm white channel. + `mireds `__ or Kelvin) of the warm white channel. Note that when the color interlock + is enabled, this option is required to control the light from Home Assistant. - **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