mirror of
https://github.com/esphome/esphome-docs.git
synced 2024-07-04 11:55:10 +02:00
118 lines
2.8 KiB
ReStructuredText
118 lines
2.8 KiB
ReStructuredText
Switch Component
|
||
================
|
||
|
||
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:: 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``.
|
||
- 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:: 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:: 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:: yaml
|
||
|
||
on_...:
|
||
then:
|
||
- switch.turn_off: relay_1
|
||
|
||
lambda calls
|
||
************
|
||
|
||
From :ref:`lambdas <config-lambda>`, you can call several methods on all covers to do some
|
||
advanced stuff (see the full :doc:`API Reference </api/cover/index>` 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:: 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:: 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
|
||
}
|
||
|
||
- ``write_state()``: Manually cause the cover to go into an OFF/ON state from code.
|
||
Similar to the ``switch.turn_on`` and ``switch.turn_off`` actions,
|
||
but can be used in complex lambda expressions.
|
||
|
||
.. code:: yaml
|
||
|
||
id(my_switch).write_state(false);
|
||
id(my_switch).write_state(true);
|
||
// Toggle the switch
|
||
id(my_switch).write_state(!id(my_switch).state);
|
||
|
||
See Also
|
||
--------
|
||
|
||
- :doc:`API Reference </api/switch/index>`
|
||
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/switch/index.rst>`__
|
||
|
||
.. toctree::
|
||
:maxdepth: 1
|
||
:glob:
|
||
|
||
*
|
||
|
||
.. disqus::
|