2021-10-06 09:44:52 +02:00
Safe Mode Switch
================
.. seo ::
:description: Instructions for setting up switches that can remotely reboot the ESP in ESPHome into safe mode.
2021-11-16 03:19:33 +01:00
:image: restart.svg
2021-10-06 09:44:52 +02:00
2024-05-22 03:08:59 +02:00
The `` safe_mode `` switch allows you to remotely reboot your node into :doc: `/components/safe_mode` . This is useful in certain situations where a misbehaving component, or low memory state is preventing Over-The-Air updates from completing successfully.
2021-10-06 09:44:52 +02:00
2024-05-22 03:08:59 +02:00
This component requires :doc: `/components/safe_mode` to be configured.
2021-10-06 09:44:52 +02:00
.. figure :: images/safemode-ui.png
:align: center
:width: 80.0%
.. code-block :: yaml
# Example configuration entry
switch:
- platform: safe_mode
name: "Living Room Restart (Safe Mode)"
Configuration variables:
------------------------
- **name** (**Required** , string): The name for the switch.
- **id** (*Optional* , :ref: `config-id` ): Manually specify the ID used for code generation.
- All other options from :ref: `Switch <config-switch>` .
See Also
--------
- :doc: `shutdown`
- :doc: `restart`
2022-09-12 00:23:55 +02:00
- :doc: `factory_reset`
- :doc: `/components/button/safe_mode`
2021-10-06 09:44:52 +02:00
- :doc: `template`
- :apiref: `safe_mode/safe_mode_switch.h`
- :ghedit: `Edit`