mirror of
https://github.com/esphome/esphome-docs.git
synced 2024-12-25 17:17:54 +01:00
Add shutdown&safe mode button (#1725)
This commit is contained in:
parent
4bbb868882
commit
d16f1069e7
BIN
components/button/images/safemode-ui.png
Normal file
BIN
components/button/images/safemode-ui.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 6.8 KiB |
BIN
components/button/images/shutdown-ui.png
Normal file
BIN
components/button/images/shutdown-ui.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 5.7 KiB |
38
components/button/safe_mode.rst
Normal file
38
components/button/safe_mode.rst
Normal file
@ -0,0 +1,38 @@
|
||||
Safe Mode Button
|
||||
================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up buttons that can remotely reboot the ESP in ESPHome into safe mode.
|
||||
:image: restart.svg
|
||||
|
||||
The ``safe_mode`` button allows you to remotely reboot your node into :ref:`Safe Mode <config-ota>`. This is useful in certain situations
|
||||
where a misbehaving component is preventing Over-The-Air updates from completing successfully.
|
||||
|
||||
This component requires :ref:`OTA <config-ota>` to be configured.
|
||||
|
||||
.. figure:: images/safemode-ui.png
|
||||
:align: center
|
||||
:width: 80.0%
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
# Example configuration entry
|
||||
button:
|
||||
- platform: safe_mode
|
||||
name: "Living Room Restart (Safe Mode)"
|
||||
|
||||
Configuration variables:
|
||||
------------------------
|
||||
|
||||
- **name** (**Required**, string): The name for the button.
|
||||
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
|
||||
- All other options from :ref:`Button <config-button>`.
|
||||
|
||||
See Also
|
||||
--------
|
||||
|
||||
- :doc:`shutdown`
|
||||
- :doc:`restart`
|
||||
- :doc:`template`
|
||||
- :apiref:`safe_mode/safe_mode_button.h`
|
||||
- :ghedit:`Edit`
|
37
components/button/shutdown.rst
Normal file
37
components/button/shutdown.rst
Normal file
@ -0,0 +1,37 @@
|
||||
Shutdown Button
|
||||
===============
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up buttons that can remotely shut down the ESP.
|
||||
:image: power_settings.svg
|
||||
|
||||
The ``shutdown`` button platform allows you to shutdown your node remotely
|
||||
through Home Assistant. It does this by putting the node into deep sleep mode with no
|
||||
wakeup source selected. After enabling, the only way to startup the ESP again is by
|
||||
pressing the reset button or restarting the power supply.
|
||||
|
||||
.. figure:: images/shutdown-ui.png
|
||||
:align: center
|
||||
:width: 80.0%
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
# Example configuration entry
|
||||
button:
|
||||
- platform: shutdown
|
||||
name: "Living Room Shutdown"
|
||||
|
||||
Configuration variables:
|
||||
------------------------
|
||||
|
||||
- **name** (**Required**, string): The name for the button.
|
||||
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
|
||||
- All other options from :ref:`Button <config-button>`.
|
||||
|
||||
See Also
|
||||
--------
|
||||
|
||||
- :doc:`restart`
|
||||
- :doc:`template`
|
||||
- :apiref:`shutdown/shutdown_button.h`
|
||||
- :ghedit:`Edit`
|
Loading…
Reference in New Issue
Block a user