esphome-docs/components/output/gpio.rst

45 lines
1.3 KiB
ReStructuredText
Raw Normal View History

2018-05-13 11:37:02 +02:00
GPIO Output
===========
2018-11-14 22:12:27 +01:00
.. seo::
:description: Instructions for setting up binary outputs for GPIO pins.
:image: pin.svg
2018-11-14 22:12:27 +01:00
2018-05-13 11:37:02 +02:00
The GPIO output component is quite simple: It exposes a single GPIO pin
as an output component. Note that output components are **not** switches and
will not show up in Home Assistant. See :doc:`/components/switch/gpio`.
2018-05-13 11:37:02 +02:00
.. code-block:: yaml
2018-05-13 11:37:02 +02:00
# Example configuration entry
output:
- platform: gpio
pin: GPIOXX
2018-06-01 18:10:00 +02:00
id: gpio_d1
2018-05-13 11:37:02 +02:00
Configuration variables:
2018-10-12 16:33:22 +02:00
------------------------
2018-05-13 11:37:02 +02:00
2022-01-19 20:32:58 +01:00
- **pin** (**Required**, :ref:`Pin Schema <config-pin_schema>`): The pin to turn on and off.
2018-06-01 18:10:00 +02:00
- **id** (**Required**, :ref:`config-id`): The id to use for this output component.
- All other options from :ref:`Output <config-output>`.
.. warning::
2022-02-09 22:01:28 +01:00
This is an **output component** and will not be visible from the frontend. Output components are intermediary
2018-06-01 18:10:00 +02:00
components that can be attached to for example lights. To have a GPIO pin in the Home Assistant frontend, please
see the :doc:`/components/switch/gpio`.
2018-06-01 18:10:00 +02:00
See Also
2018-10-12 16:33:22 +02:00
--------
2018-06-01 18:10:00 +02:00
- :doc:`/components/switch/gpio`
- :doc:`/components/output/index`
- :doc:`/components/output/esp8266_pwm`
- :doc:`/components/output/ledc`
- :doc:`/components/light/binary`
- :doc:`/components/fan/binary`
- :doc:`/components/power_supply`
2019-05-12 22:44:59 +02:00
- :apiref:`gpio/output/gpio_binary_output.h`
- :ghedit:`Edit`