2018-05-13 11:37:02 +02:00
|
|
|
RGB Light
|
|
|
|
|
=========
|
|
|
|
|
|
2018-11-14 22:12:27 +01:00
|
|
|
.. seo::
|
2019-02-16 23:25:23 +01:00
|
|
|
:description: Instructions for setting up RGB lights in ESPHome.
|
2018-11-14 22:12:27 +01:00
|
|
|
:image: rgb.png
|
|
|
|
|
|
2018-06-01 18:10:00 +02:00
|
|
|
The ``rgb`` light platform creates an RGB light from 3 :ref:`float output components <output>`
|
|
|
|
|
(one for each color channel).
|
2018-05-13 11:37:02 +02:00
|
|
|
|
2018-06-01 18:10:00 +02:00
|
|
|
.. figure:: images/rgb-strip.jpg
|
|
|
|
|
:align: center
|
|
|
|
|
:width: 75.0%
|
|
|
|
|
|
|
|
|
|
Example of an RGB LED strip that can be used with this component.
|
|
|
|
|
|
|
|
|
|
.. figure:: images/rgb-ui.png
|
|
|
|
|
:align: center
|
|
|
|
|
:width: 40.0%
|
2018-05-13 11:37:02 +02:00
|
|
|
|
2018-11-19 18:32:16 +01:00
|
|
|
.. code-block:: yaml
|
2018-05-13 11:37:02 +02:00
|
|
|
|
|
|
|
|
# Example configuration entry
|
|
|
|
|
light:
|
|
|
|
|
- platform: rgb
|
|
|
|
|
name: "Living Room Lights"
|
|
|
|
|
red: output_component1
|
|
|
|
|
green: output_component2
|
|
|
|
|
blue: output_component3
|
|
|
|
|
|
2019-02-16 23:25:23 +01:00
|
|
|
# Example output entry
|
|
|
|
|
output:
|
|
|
|
|
- platform: esp8266_pwm
|
|
|
|
|
id: output_component1
|
|
|
|
|
pin: D1
|
|
|
|
|
# Repeat for green and blue output
|
|
|
|
|
|
2018-05-13 11:37:02 +02:00
|
|
|
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.
|
|
|
|
|
- **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.
|
2019-02-17 12:28:17 +01:00
|
|
|
- **internal** (*Optional*, boolean): Mark this component as internal. Internal components will
|
|
|
|
|
not be exposed to the frontend (like Home Assistant). Only specifying an ``id`` without
|
|
|
|
|
a ``name`` will implicitly set this to true.
|
|
|
|
|
- If MQTT enabled, all other options from :ref:`MQTT Component <config-mqtt-component>`.
|
2018-06-01 18:10:00 +02:00
|
|
|
|
|
|
|
|
See Also
|
2018-08-24 22:44:01 +02:00
|
|
|
--------
|
2018-06-01 18:10:00 +02:00
|
|
|
|
|
|
|
|
.. figure:: images/rgb-detail.jpg
|
|
|
|
|
:align: center
|
|
|
|
|
:width: 75.0%
|
|
|
|
|
|
2019-02-07 13:54:45 +01:00
|
|
|
- :doc:`/components/output/index`
|
|
|
|
|
- :doc:`/components/light/index`
|
|
|
|
|
- :doc:`/components/light/rgbw`
|
|
|
|
|
- :doc:`/components/power_supply`
|
|
|
|
|
- :doc:`/components/output/ledc`
|
|
|
|
|
- :doc:`/components/output/esp8266_pwm`
|
|
|
|
|
- :doc:`/components/output/pca9685`
|
|
|
|
|
- :doc:`/components/output/my9231`
|
|
|
|
|
- :apiref:`light/light_state.h`
|
|
|
|
|
- :ghedit:`Edit`
|
2018-10-12 16:33:22 +02:00
|
|
|
|
|
|
|
|
.. disqus::
|
