esphome-docs/components/light/rgbww.rst

59 lines
2.4 KiB
ReStructuredText
Raw Normal View History

2018-08-24 22:44:01 +02:00
RGBWW Light
===========
2018-11-14 22:12:27 +01:00
.. seo::
:description: Instructions for setting up RGBWW lights.
:image: rgbw.png
2018-08-24 22:44:01 +02:00
The ``rgbww`` light platform creates an RGBWW (cold white + warm white)
light from 5 :ref:`float output components <output>` (one for each channel). The cold white
and warm white channels will be mixed using the color temperature configuration options.
.. code-block:: yaml
2018-08-24 22:44:01 +02:00
# Example configuration entry
light:
- platform: rgbww
name: "Livingroom Lights"
red: output_component1
green: output_component2
blue: output_component3
cold_white: output_component4
warm_white: output_component5
2019-03-17 15:56:16 +01:00
cold_white_color_temperature: 6536 K
warm_white_color_temperature: 2000 K
2018-08-24 22:44:01 +02:00
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.
- **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.
2019-02-17 12:28:17 +01:00
- **cold_white_color_temperature** (**Required**, float): The color temperate (in `mireds <https://en.wikipedia.org/wiki/Mired>`__ or Kelvin)
2018-08-24 22:44:01 +02:00
of the cold white channel.
2019-02-17 12:28:17 +01:00
- **warm_white_color_temperature** (**Required**, float): The color temperate (in `mireds <https://en.wikipedia.org/wiki/Mired>`__ or Kelvin)
2018-08-24 22:44:01 +02:00
of the warm white channel.
- **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.
2019-05-12 22:44:59 +02:00
- All other options from :ref:`Light <config-light>`.
2018-08-24 22:44:01 +02:00
See Also
--------
- :doc:`/components/output/index`
- :doc:`/components/light/index`
- :doc:`/components/light/rgb`
- :doc:`/components/light/rgbw`
- :doc:`/components/power_supply`
- :doc:`/components/output/ledc`
- :doc:`/components/output/esp8266_pwm`
- :doc:`/components/output/pca9685`
2019-10-14 11:38:20 +02:00
- :doc:`/components/output/tlc59208f`
- :doc:`/components/output/my9231`
- :doc:`/components/output/sm16716`
2019-05-12 22:44:59 +02:00
- :apiref:`rgbww/rgbww_light_output.h`
- :ghedit:`Edit`