esphome-docs/components/light/binary.rst

48 lines
1.3 KiB
ReStructuredText
Raw Normal View History

2018-05-13 11:37:02 +02:00
Binary Light
============
2018-11-14 22:12:27 +01:00
.. seo::
2019-02-16 23:25:23 +01:00
:description: Instructions for setting up binary ON/OFF lights in ESPHome.
:image: lightbulb.png
2018-11-14 22:12:27 +01:00
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-block:: yaml
2018-05-13 11:37:02 +02:00
# Example configuration entry
light:
- platform: binary
name: "Desk Lamp"
output: light_output
output:
- id: light_output
platform: gpio
pin: GPIO16
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.
- **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.
- **effects** (*Optional*, list): A list of :ref:`light effects <light-effects>` to use for this light, though binary lights
only support very few of them.
2019-05-12 22:44:59 +02:00
- All other options from :ref:`Light <config-light>`.
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
- :doc:`/components/output/index`
- :doc:`/components/light/index`
- :doc:`/components/output/gpio`
- :doc:`/components/power_supply`
2019-05-12 22:44:59 +02:00
- :apiref:`binary/light/binary_light_output.h`
- :ghedit:`Edit`