77 lines
2.3 KiB
ReStructuredText
77 lines
2.3 KiB
ReStructuredText
GPIO Switch
|
|
===========
|
|
|
|
.. seo::
|
|
:description: Instructions for setting up GPIO pin switches in esphomelib that control GPIO outputs.
|
|
:image: pin.png
|
|
|
|
The ``gpio`` switch platform allows you to use any pin on your node as a
|
|
switch. You can for example hook up a relay to a GPIO pin and use it
|
|
through this platform.
|
|
|
|
.. figure:: images/gpio-ui.png
|
|
:align: center
|
|
:width: 80.0%
|
|
|
|
.. code-block:: yaml
|
|
|
|
# Example configuration entry
|
|
switch:
|
|
- platform: gpio
|
|
pin: 25
|
|
name: "Living Room Dehumidifier"
|
|
|
|
Configuration variables:
|
|
------------------------
|
|
|
|
- **pin** (**Required**, :ref:`Pin Schema <config-pin_schema>`): The
|
|
GPIO pin to use for the switch.
|
|
- **name** (**Required**, string): The name for the switch.
|
|
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
|
|
- **restore_mode** (*Optional*): Control how the GPIO Switch attempts to restore state on bootup.
|
|
|
|
- ``RESTORE_DEFAULT_OFF`` (Default) - Attempt to restore state and default to OFF if not possible to restore.
|
|
- ``RESTORE_DEFAULT_ON`` - Attempt to restore state and default to ON.
|
|
- ``ALWAYS_OFF`` - Always initialize the pin as OFF on bootup.
|
|
- ``ALWAYS_ON`` - Always initialize the pin as ON on bootup.
|
|
|
|
- All other options from :ref:`Switch <config-switch>` and :ref:`MQTT Component <config-mqtt-component>`.
|
|
|
|
To create an active-low switch (one that is turned off by default), use the :ref:`Pin Schema <config-pin_schema>`:
|
|
|
|
.. code-block:: yaml
|
|
|
|
# Example configuration entry
|
|
switch:
|
|
- platform: gpio
|
|
pin:
|
|
number: 25
|
|
inverted: yes
|
|
|
|
And to create momentary switches, for example switches that toggle a pin for a moment, use :doc:`template switches <template>`:
|
|
|
|
.. code-block:: yaml
|
|
|
|
# Example configuration entry
|
|
switch:
|
|
- platform: gpio
|
|
pin: 25
|
|
id: relay
|
|
- platform: template
|
|
name: "Momentary Switch"
|
|
optimistic: yes
|
|
turn_on_action:
|
|
- switch.turn_on: relay
|
|
- delay: 100ms
|
|
- switch.turn_off: relay
|
|
|
|
See Also
|
|
--------
|
|
|
|
- :doc:`index`
|
|
- :doc:`/esphomeyaml/components/output/gpio`
|
|
- :doc:`API Reference </api/switch/index>`
|
|
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/switch/gpio.rst>`__
|
|
|
|
.. disqus::
|