From f1cf975b7240368a60ecff4f139eae3d632b38a8 Mon Sep 17 00:00:00 2001 From: NP v/d Spek Date: Mon, 14 Jul 2025 23:38:50 +0200 Subject: [PATCH 1/4] add deep_sleep button doc --- components/button/deep_sleep | 37 ++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 components/button/deep_sleep diff --git a/components/button/deep_sleep b/components/button/deep_sleep new file mode 100644 index 0000000000..05d7408f98 --- /dev/null +++ b/components/button/deep_sleep @@ -0,0 +1,37 @@ +Deep_sleep Button +=============== + +.. seo:: + :description: Instructions for setting up buttons that can remotely shut down the ESP. + :image: power_settings.svg + +The ``deep_sleep`` button platform allows you to shutdown your node remotely +through Home Assistant. It does this by putting the node into deep sleep mode using the settings of the ``deep_sleep`` component. + + +.. figure:: images/shutdown-ui.png + :align: center + :width: 80.0% + +.. code-block:: yaml + + # Example configuration entry + button: + - platform: deep_sleep + name: "Living Room Shutdown" + override: true + +Configuration variables: +------------------------ + +- All options from :ref:`Button `. + +See Also +-------- + +- :doc:`factory_reset` +- :doc:`/components/deep_sleep` +- :doc:`/components/switch/deep_sleep` +- :doc:`template` +- :apiref:`shutdown/shutdown_button.h` +- :ghedit:`Edit` From 18591f66ad4343cc9dccc72a335cb24ff35fcd60 Mon Sep 17 00:00:00 2001 From: NP v/d Spek Date: Tue, 15 Jul 2025 00:28:25 +0200 Subject: [PATCH 2/4] Rename deep_sleep to deep_sleep.rst --- components/button/{deep_sleep => deep_sleep.rst} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename components/button/{deep_sleep => deep_sleep.rst} (100%) diff --git a/components/button/deep_sleep b/components/button/deep_sleep.rst similarity index 100% rename from components/button/deep_sleep rename to components/button/deep_sleep.rst From 5d640f78b399826ceb2e42d0999917bae630028c Mon Sep 17 00:00:00 2001 From: NP v/d Spek Date: Tue, 15 Jul 2025 00:30:24 +0200 Subject: [PATCH 3/4] Create deep_sleep.rst --- components/switch/deep_sleep.rst | 33 ++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 components/switch/deep_sleep.rst diff --git a/components/switch/deep_sleep.rst b/components/switch/deep_sleep.rst new file mode 100644 index 0000000000..262e95732a --- /dev/null +++ b/components/switch/deep_sleep.rst @@ -0,0 +1,33 @@ +Deep_sleep Switch +================= + +.. seo:: + :description: Instructions for setting up switches that can remotely shut down the ESP. + :image: power_settings.svg + +The ``deep_sleep`` switch platform allows you to prevent the node to go to deep sleep. + +.. figure:: images/shutdown-ui.png + :align: center + :width: 80.0% + +.. code-block:: yaml + + # Example configuration entry + switch: + - platform: deep_sleep + name: "Living Room Shutdown" + +Configuration variables: +------------------------ + +- All options from :ref:`Switch `. + +See Also +-------- + +- :doc:`/components/deep_sleep` +- :doc:`/components/button/deep_sleep` +- :doc:`template` +- :apiref:`deep_sleep/deep_sleep_switch.h` +- :ghedit:`Edit` From abc808ac03882084617b8827b77cf3b3ce06464b Mon Sep 17 00:00:00 2001 From: NP v/d Spek Date: Tue, 15 Jul 2025 00:35:46 +0200 Subject: [PATCH 4/4] Update index.rst --- components/index.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/components/index.rst b/components/index.rst index 16c4f5fd9c..ac78bb9f2d 100644 --- a/components/index.rst +++ b/components/index.rst @@ -688,6 +688,7 @@ Button Components Generic Output Button, components/button/output, upload.svg, dark-invert Restart Button, components/button/restart, restart.svg, dark-invert Safe Mode Button, components/button/safe_mode, restart-alert.svg, dark-invert + Deep_sleep Button, components/button/deep_sleep, power_settings.svg, dark-invert Shutdown Button, components/button/shutdown, power_settings.svg, dark-invert UART Button, components/button/uart, uart.svg Wake-on-LAN, components/button/wake_on_lan, power_settings.svg, dark-invert @@ -1002,6 +1003,7 @@ Switch Components Nextion Switch, components/switch/nextion, nextion.jpg Restart Switch, components/switch/restart, restart.svg, dark-invert Safe Mode Switch, components/switch/safe_mode, restart-alert.svg, dark-invert + Deep_sleep Switch, components/switchdeep_sleep, power_settings.svg, dark-invert Shutdown Switch, components/switch/shutdown, power_settings.svg, dark-invert Tuya Switch, components/switch/tuya, tuya.png UART Switch, components/switch/uart, uart.svg