Skip to content

Commit

Permalink
Add shutdown&safe mode button (#1725)
Browse files Browse the repository at this point in the history
  • Loading branch information
jsuanet authored Dec 20, 2021
1 parent 4bbb868 commit d16f106
Show file tree
Hide file tree
Showing 4 changed files with 75 additions and 0 deletions.
Binary file added components/button/images/safemode-ui.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added components/button/images/shutdown-ui.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
38 changes: 38 additions & 0 deletions components/button/safe_mode.rst
Original file line number Diff line number Diff line change
@@ -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 changes: 37 additions & 0 deletions components/button/shutdown.rst
Original file line number Diff line number Diff line change
@@ -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`

0 comments on commit d16f106

Please sign in to comment.