esphome-docs/components/light/monochromatic.rst
2019-05-12 22:44:59 +02:00

61 lines
1.7 KiB
ReStructuredText

Monochromatic Light
===================
.. seo::
:description: Instructions for setting up monochromatic (brightness-only) lights.
:image: brightness-medium.png
The ``monochromatic`` light platform creates a simple brightness-only light from an
:ref:`float output component <output>`.
.. figure:: images/monochromatic-strip.jpg
:align: center
:width: 75.0%
Example of a brightness-only LED strip that can be used with this component.
.. figure:: images/kitchen-lights.png
:align: center
:width: 40.0%
.. code-block:: yaml
# Example configuration entry
light:
- platform: monochromatic
name: "Kitchen Lights"
output: output_component1
# Example output entry
output:
- platform: esp8266_pwm
id: output_component1
pin: D1
Configuration variables:
------------------------
- **name** (**Required**, string): The name of the light.
- **output** (**Required**, :ref:`config-id`): The id of the float :ref:`output` to use for this light.
- **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
--------
.. figure:: images/monochromatic-detail.jpg
:align: center
:width: 75.0%
- :doc:`/components/output/index`
- :doc:`/components/light/index`
- :doc:`/components/light/binary`
- :doc:`/components/power_supply`
- :doc:`/components/output/ledc`
- :doc:`/components/output/esp8266_pwm`
- :doc:`/components/output/pca9685`
- :doc:`/components/output/my9231`
- :apiref:`monochromatic/monochromatic_light_output.h`
- :ghedit:`Edit`