diff --git a/components/light/color_temperature.rst b/components/light/color_temperature.rst new file mode 100644 index 000000000..fa9cba442 --- /dev/null +++ b/components/light/color_temperature.rst @@ -0,0 +1,53 @@ +Color Temperature Light +======================= + +.. seo:: + :description: Instructions for setting up Color Temperature lights. + :image: brightness-medium.png + +The ``color_temperature`` light platform creates a Color Temperature +light from 2 :ref:`float output components `. One channel controls the LED temperature, +and the other channel controls the brightness. + +.. code-block:: yaml + + # Example configuration entry + light: + - platform: color_temperature + name: "Livingroom Lights" + color_temperature: output_component1 + brightness: output_component2 + cold_white_color_temperature: 6536 K + warm_white_color_temperature: 2000 K + +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. +- **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 `. + +See Also +-------- + +- :doc:`/components/output/index` +- :doc:`/components/light/index` +- :doc:`/components/light/cwww` +- :doc:`/components/light/rgb` +- :doc:`/components/light/rgbw` +- :doc:`/components/light/rgbww` +- :doc:`/components/light/rgbct` +- :doc:`/components/power_supply` +- :doc:`/components/output/ledc` +- :doc:`/components/output/esp8266_pwm` +- :doc:`/components/output/pca9685` +- :doc:`/components/output/tlc59208f` +- :apiref:`color_temperature/ct_light_output.h` +- :ghedit:`Edit` diff --git a/components/light/cwww.rst b/components/light/cwww.rst index 36d3fdbfd..e52e6a98a 100644 --- a/components/light/cwww.rst +++ b/components/light/cwww.rst @@ -43,10 +43,13 @@ See Also - :doc:`/components/light/index` - :doc:`/components/light/rgb` - :doc:`/components/light/rgbw` +- :doc:`/components/light/rgbww` +- :doc:`/components/light/rgbct` +- :doc:`/components/light/color_temperature` - :doc:`/components/power_supply` - :doc:`/components/output/ledc` - :doc:`/components/output/esp8266_pwm` - :doc:`/components/output/pca9685` - :doc:`/components/output/tlc59208f` -- :apiref:`cwww/cww_light_output.h` +- :apiref:`cwww/cwww_light_output.h` - :ghedit:`Edit` diff --git a/components/light/rgb.rst b/components/light/rgb.rst index 692e418fe..ef701a9c3 100644 --- a/components/light/rgb.rst +++ b/components/light/rgb.rst @@ -82,6 +82,8 @@ See Also - :doc:`/components/output/index` - :doc:`/components/light/index` - :doc:`/components/light/rgbw` +- :doc:`/components/light/rgbww` +- :doc:`/components/light/rgbct` - :doc:`/components/power_supply` - :doc:`/components/output/ledc` - :doc:`/components/output/esp8266_pwm` diff --git a/components/light/rgbct.rst b/components/light/rgbct.rst new file mode 100644 index 000000000..071fcd6dc --- /dev/null +++ b/components/light/rgbct.rst @@ -0,0 +1,62 @@ +RGBCT Light +=========== + +.. seo:: + :description: Instructions for setting up RGBCT lights. + :image: rgbw.png + +The ``rgbct`` light platform creates an RGBWT (colour temperature + white brightness) +light from 5 :ref:`float output components ` (one for each channel). + +.. code-block:: yaml + + # Example configuration entry + light: + - platform: rgbct + name: "Livingroom Lights" + red: output_component1 + green: output_component2 + blue: output_component3 + color_temperature: output_component4 + white_brightness: output_component5 + cold_white_color_temperature: 153 mireds + warm_white_color_temperature: 500 mireds + +Configuration variables: +------------------------ + +- **name** (**Required**, string): The name of the light. +- **red** (**Required**, :ref:`config-id`): The id of the float :ref:`output` to use for the red channel. +- **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. +- **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. +- **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. +- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. +- All other options from :ref:`Light `. + +See Also +-------- + +- :doc:`/components/output/index` +- :doc:`/components/light/index` +- :doc:`/components/light/rgb` +- :doc:`/components/light/rgbw` +- :doc:`/components/light/rgbww` +- :doc:`/components/power_supply` +- :doc:`/components/output/ledc` +- :doc:`/components/output/esp8266_pwm` +- :doc:`/components/output/pca9685` +- :doc:`/components/output/tlc59208f` +- :doc:`/components/output/my9231` +- :doc:`/components/output/sm16716` +- :apiref:`rgbct/rgbct_light_output.h` +- :ghedit:`Edit` diff --git a/components/light/rgbw.rst b/components/light/rgbw.rst index 9cf710ae6..4894be33c 100644 --- a/components/light/rgbw.rst +++ b/components/light/rgbw.rst @@ -76,7 +76,11 @@ See Also - :doc:`/components/output/index` - :doc:`/components/light/index` +- :doc:`/components/light/cwww` +- :doc:`/components/light/color_temperature` - :doc:`/components/light/rgb` +- :doc:`/components/light/rgbww` +- :doc:`/components/light/rgbct` - :doc:`/components/power_supply` - :doc:`/components/output/ledc` - :doc:`/components/output/esp8266_pwm` diff --git a/index.rst b/index.rst index 900d4ae79..40eb4fcb1 100644 --- a/index.rst +++ b/index.rst @@ -398,14 +398,16 @@ Light Components Monochromatic Light, components/light/monochromatic, brightness-medium.svg Cold+Warm White Light, components/light/cwww, brightness-medium.svg + Color Temperature Light, components/light/color_temperature, brightness-medium.svg RGB Light, components/light/rgb, rgb.png RGBW Light, components/light/rgbw, rgbw.png - RGBWW Light, components/light/rgbww, rgbw.png + RGBCT Light, components/light/rgbct, rgbw.png + FastLED Light, components/light/fastled, color_lens.svg NeoPixelBus Light, components/light/neopixelbus, color_lens.svg - Light Partition, components/light/partition, color_lens.svg + Tuya Dimmer, components/light/tuya, tuya.png Custom Light, components/light/custom, language-cpp.svg