esphome-docs/esphomeyaml/components/light/monochromatic.rst

63 lines
2.3 KiB
ReStructuredText
Raw Normal View History

2018-05-13 11:37:02 +02:00
Monochromatic Light
===================
2018-06-01 18:10:00 +02:00
The ``monochromatic`` light platform creates a simple brightness-only light from an
:ref:`float output component <output>`.
2018-05-13 11:37:02 +02:00
2018-06-01 18:10:00 +02:00
.. 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%
2018-05-13 11:37:02 +02:00
.. code:: yaml
# Example configuration entry
light:
- platform: monochromatic
name: "Kitchen Lights"
output: output_component1
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.
- **output** (**Required**, :ref:`config-id`): The id of the float :ref:`output` to use for this light.
- **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``.
- **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 ``monochromatic`` 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
2018-06-07 16:01:31 +02:00
.. figure:: images/monochromatic-detail.jpg
2018-06-01 18:10:00 +02:00
:align: center
:width: 75.0%
- :doc:`/esphomeyaml/components/output/index`
- :doc:`/esphomeyaml/components/light/index`
- :doc:`/esphomeyaml/components/light/binary`
- :doc:`/esphomeyaml/components/power_supply`
- :doc:`/esphomeyaml/components/output/ledc`
- :doc:`/esphomeyaml/components/output/esp8266_pwm`
- :doc:`/esphomeyaml/components/output/pca9685`
- :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/monochromatic.rst>`__