esphome-docs/components/light/cwww.rst
Guillermo Ruffino 4578e6f97a
Add documentation for cwww and rgbww constant_brightness variables. (#530) (#540)
Co-authored-by: kroimon <github@kroimon.de>
2020-04-10 12:47:45 -03:00

53 lines
2.4 KiB
ReStructuredText

Cold White + Warm White Light
=============================
.. seo::
:description: Instructions for setting up Cold White + Warm White lights.
:image: brightness-medium.png
The ``cwww`` light platform creates an Cold-White+Warm-White
light from 2 :ref:`float output components <output>` (one for each channel). The two
channels will be mixed using the color temperature configuration options.
.. code-block:: yaml
# Example configuration entry
light:
- platform: cwww
name: "Livingroom Lights"
cold_white: output_component1
warm_white: output_component2
cold_white_color_temperature: 6536 K
warm_white_color_temperature: 2000 K
constant_brightness: true
Configuration variables:
------------------------
- **name** (**Required**, string): The name of the light.
- **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** (**Required**, float): The color temperate (in `mireds <https://en.wikipedia.org/wiki/Mired>`__ or Kelvin)
of the cold white channel.
- **warm_white_color_temperature** (**Required**, float): The color temperate (in `mireds <https://en.wikipedia.org/wiki/Mired>`__ or Kelvin)
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.
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
- All other options from :ref:`Light <config-light>`.
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`
- :doc:`/components/output/tlc59208f`
- :apiref:`cwww/cww_light_output.h`
- :ghedit:`Edit`