esphome-docs/api/switch/shutdown.rst

30 lines
641 B
ReStructuredText
Raw Normal View History

2018-05-13 11:37:02 +02:00
Shutdown Switch
===============
This platform allows you to put your ESP8266/ESP32 to sleep until it is manually restarted
by either pressing the reset button or toggling the power supply.
It is especially useful if you're using esphomelib with battery cells that must not
be discharged too much.
Example Usage
-------------
.. code-block:: cpp
App.make_shutdown_switch("Livingroom Shutdown");
2018-05-14 21:15:49 +02:00
.. cpp:namespace:: nullptr
2018-05-13 11:37:02 +02:00
See :cpp:func:`Application::make_shutdown_switch`.
API Reference
-------------
.. cpp:namespace:: nullptr
.. doxygenclass:: switch_::ShutdownSwitch
:members:
:protected-members:
:undoc-members: