esphome-docs/components/switch/index.rst
Oxan van Leeuwen 5e3102a123
Use lowercase true/false values (#1327)
Co-authored-by: Jesse Hills <3060199+jesserockz@users.noreply.github.com>
2021-07-29 09:56:11 +12:00

183 lines
4.7 KiB
ReStructuredText
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

Switch Component
================
.. seo::
:description: Instructions for setting up generic switches in ESPHome.
:image: folder-open.png
The ``switch`` domain includes all platforms that should show up like a
switch and can only be turned ON or OFF.
.. _config-switch:
Base Switch Configuration
-------------------------
.. code-block:: yaml
switch:
- platform: ...
name: "Switch Name"
icon: "mdi:restart"
Configuration variables:
- **name** (**Required**, string): The name of the switch.
- **icon** (*Optional*, icon): Manually set the icon to use for the
sensor in the frontend.
- **inverted** (*Optional*, boolean): Whether to invert the binary
state, i.e. report ON states as OFF and vice versa. Defaults
to ``false``.
- **internal** (*Optional*, boolean): Mark this component as internal. Internal components will
not be exposed to the frontend (like Home Assistant). Only specifying an ``id`` without
a ``name`` will implicitly set this to true.
- **on_turn_on** (*Optional*, :ref:`Action <config-action>`): An automation to perform
when the switch is turned on. See :ref:`switch-on_turn_on_off_trigger`.
- **on_turn_off** (*Optional*, :ref:`Action <config-action>`): An automation to perform
when the switch is turned off. See :ref:`switch-on_turn_on_off_trigger`.
- If MQTT enabled, All other options from :ref:`MQTT Component <config-mqtt-component>`.
.. _switch-toggle_action:
``switch.toggle`` Action
************************
This action toggles a switch with the given ID when executed.
.. code-block:: yaml
on_...:
then:
- switch.toggle: relay_1
.. _switch-turn_on_action:
``switch.turn_on`` Action
*************************
This action turns a switch with the given ID on when executed.
.. code-block:: yaml
on_...:
then:
- switch.turn_on: relay_1
.. _switch-turn_off_action:
``switch.turn_off`` Action
**************************
This action turns a switch with the given ID off when executed.
.. code-block:: yaml
on_...:
then:
- switch.turn_off: relay_1
.. _switch-is_on_condition:
.. _switch-is_off_condition:
``switch.is_on`` / ``switch.is_off`` Condition
**********************************************
This :ref:`Condition <config-condition>` checks if the given switch is ON (or OFF).
.. code-block:: yaml
# In some trigger:
on_...:
if:
condition:
# Same syntax for is_off
switch.is_on: my_switch
.. _switch-lambda_calls:
lambda calls
************
From :ref:`lambdas <config-lambda>`, you can call several methods on all covers to do some
advanced stuff (see the full API Reference for more info).
- ``publish_state()``: Manually cause the switch to publish a new state and store it internally.
If it's different from the last internal state, it's additionally published to the frontend.
.. code-block:: yaml
// Within lambda, make the switch report a specific state
id(my_switch).publish_state(false);
id(my_switch).publish_state(true);
- ``state``: Retrieve the current state of the switch.
.. code-block:: yaml
// Within lambda, get the switch state and conditionally do something
if (id(my_switch).state) {
// Switch is ON, do something here
} else {
// Switch is OFF, do something else here
}
- ``turn_off()``/``turn_on()``: Manually turn the switch ON/OFF from code.
Similar to the ``switch.turn_on`` and ``switch.turn_off`` actions,
but can be used in complex lambda expressions.
.. code-block:: yaml
id(my_switch).turn_off();
id(my_switch).turn_on();
// Toggle the switch
id(my_switch).toggle();
.. _switch-is_on_off_condition:
``switch.is_on`` / ``switch.is_off`` Condition
**********************************************
This :ref:`condition <config-condition>` passes if the given switch is on/off.
.. code-block:: yaml
# in a trigger:
on_...:
if:
condition:
switch.is_on: my_switch
# same goes for is_off
then:
- script.execute: my_script
.. _switch-on_turn_on_off_trigger:
``switch.on_turn_on`` / ``switch.on_turn_off`` Trigger
******************************************************
This trigger is activated each time the switch is turned on. It becomes active
right after the switch component has acknowledged the state (e.g. after it switched
ON/OFF itself).
.. code-block:: yaml
switch:
- platform: gpio # or any other platform
# ...
on_turn_on:
- logger.log: "Switch Turned On!"
on_turn_off:
- logger.log: "Switch Turned Off!"
See Also
--------
- :apiref:`switch/switch.h`
- :ghedit:`Edit`
.. toctree::
:maxdepth: 1
:glob:
*