2021-12-20 22:26:06 +01:00
|
|
|
Safe Mode Button
|
|
|
|
|
================
|
|
|
|
|
|
|
|
|
|
.. seo::
|
|
|
|
|
:description: Instructions for setting up buttons that can remotely reboot the ESP in ESPHome into safe mode.
|
|
|
|
|
:image: restart.svg
|
|
|
|
|
|
2024-05-22 03:08:59 +02:00
|
|
|
The ``safe_mode`` button allows you to remotely reboot your node into :doc:`/components/safe_mode`. This is useful in certain situations
|
2021-12-20 22:26:06 +01:00
|
|
|
where a misbehaving component is preventing Over-The-Air updates from completing successfully.
|
|
|
|
|
|
2024-05-22 03:08:59 +02:00
|
|
|
This component requires :doc:`/components/safe_mode` to be configured.
|
2021-12-20 22:26:06 +01:00
|
|
|
|
|
|
|
|
.. 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`
|
2022-09-12 00:23:55 +02:00
|
|
|
- :doc:`factory_reset`
|
|
|
|
|
- :doc:`/components/switch/safe_mode`
|
2021-12-20 22:26:06 +01:00
|
|
|
- :doc:`template`
|
|
|
|
|
- :apiref:`safe_mode/safe_mode_button.h`
|
|
|
|
|
- :ghedit:`Edit`
|
