2018-05-13 11:37:02 +02:00
|
|
|
RGBW Light
|
|
|
|
|
==========
|
|
|
|
|
|
2018-11-14 22:12:27 +01:00
|
|
|
.. seo::
|
|
|
|
|
:description: Instructions for setting up RGB + White-Channel lights.
|
|
|
|
|
:image: rgbw.png
|
|
|
|
|
|
2018-06-01 18:10:00 +02:00
|
|
|
The ``rgbw`` light platform creates an RGBW light from 4 :ref:`float output components <output>` (one for each channel).
|
2018-05-13 11:37:02 +02:00
|
|
|
|
|
|
|
|
.. code:: yaml
|
|
|
|
|
|
|
|
|
|
# Example configuration entry
|
|
|
|
|
light:
|
2018-06-01 18:10:00 +02:00
|
|
|
- platform: rgbw
|
2018-05-13 11:37:02 +02:00
|
|
|
name: "Livingroom Lights"
|
|
|
|
|
red: output_component1
|
|
|
|
|
green: output_component2
|
|
|
|
|
blue: output_component3
|
|
|
|
|
white: output_component4
|
|
|
|
|
|
|
|
|
|
Configuration variables:
|
2018-08-24 22:44:01 +02:00
|
|
|
------------------------
|
2018-05-13 11:37:02 +02:00
|
|
|
|
2018-06-01 18:10:00 +02:00
|
|
|
- **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.
|
|
|
|
|
- **white** (**Required**, :ref:`config-id`): The id of the float :ref:`output` to use for the white channel.
|
|
|
|
|
- **gamma_correct** (*Optional*, float): The `gamma correction
|
|
|
|
|
factor <https://en.wikipedia.org/wiki/Gamma_correction>`__ for the light. Defaults to ``2.8``.
|
|
|
|
|
- **default_transition_length** (*Optional*, :ref:`config-time`): The length of
|
|
|
|
|
the transition if no transition parameter is provided by Home Assistant. Defaults to ``1s``.
|
2018-08-22 22:05:28 +02:00
|
|
|
- **effects** (*Optional*, list): A list of :ref:`light effects <light-effects>` to use for this light.
|
2018-06-01 18:10:00 +02:00
|
|
|
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
|
|
|
|
|
- All other options from :ref:`MQTT Component <config-mqtt-component>`.
|
|
|
|
|
|
|
|
|
|
.. note::
|
|
|
|
|
|
|
|
|
|
The RGBW light platform only works with ``float`` :ref:`outputs <output>` that
|
|
|
|
|
can output any light intensity percentage like the :doc:`ESP32 LEDC </esphomeyaml/components/output/ledc>` or
|
|
|
|
|
:doc:`ESP8266 PWM </esphomeyaml/components/output/esp8266_pwm>` components and does **not** work with output
|
|
|
|
|
platforms like the :doc:`/esphomeyaml/components/output/gpio`.
|
|
|
|
|
|
|
|
|
|
See Also
|
2018-08-24 22:44:01 +02:00
|
|
|
--------
|
2018-06-01 18:10:00 +02:00
|
|
|
|
|
|
|
|
- :doc:`/esphomeyaml/components/output/index`
|
|
|
|
|
- :doc:`/esphomeyaml/components/light/index`
|
|
|
|
|
- :doc:`/esphomeyaml/components/light/rgb`
|
|
|
|
|
- :doc:`/esphomeyaml/components/power_supply`
|
|
|
|
|
- :doc:`/esphomeyaml/components/output/ledc`
|
|
|
|
|
- :doc:`/esphomeyaml/components/output/esp8266_pwm`
|
|
|
|
|
- :doc:`/esphomeyaml/components/output/pca9685`
|
2018-11-13 16:51:42 +01:00
|
|
|
- :doc:`/esphomeyaml/components/output/my9231`
|
2018-06-01 18:10:00 +02:00
|
|
|
- :doc:`API Reference </api/light/index>`
|
2018-06-04 08:17:22 +02:00
|
|
|
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/light/rgbw.rst>`__
|
2018-10-12 16:33:22 +02:00
|
|
|
|
|
|
|
|
.. disqus::
|
