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

37 lines
1.1 KiB
ReStructuredText
Raw Normal View History

2018-05-13 11:37:02 +02:00
Binary Light
============
2018-06-01 18:10:00 +02:00
The ``binary`` light platform creates a simple ON/OFF-only light from a
:ref:`binary output component <output>`.
2018-05-13 11:37:02 +02:00
2018-06-01 18:10:00 +02:00
.. figure:: images/binary-ui.png
:align: center
:width: 40.0%
2018-05-13 11:37:02 +02:00
.. code:: yaml
# Example configuration entry
light:
- platform: binary
name: "Desk Lamp"
output: output_component1
Configuration variables:
~~~~~~~~~~~~~~~~~~~~~~~~
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
binary :ref:`output` to use for this light.
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
- All other options from :ref:`MQTT Component <config-mqtt-component>`.
See Also
^^^^^^^^
- :doc:`/esphomeyaml/components/output/index`
- :doc:`/esphomeyaml/components/light/index`
- :doc:`/esphomeyaml/components/output/gpio`
- :doc:`/esphomeyaml/components/power_supply`
- :doc:`API Reference </api/light/index>`
2018-06-03 12:50:44 +02:00
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/components/light/binary.rst>`__