From eb3cfff7606435979f548f579e35d1b7ae8d51f5 Mon Sep 17 00:00:00 2001 From: Kevin Reilly Date: Tue, 27 Feb 2024 22:51:46 -0800 Subject: [PATCH] FAQ: unavailable entities during deep sleep (#3648) * FAQ: unavailable entities during deep sleep * Deep sleep: added note about unavailable entity states --------- Co-authored-by: Kevin Reilly --- components/deep_sleep.rst | 8 +++++--- guides/faq.rst | 9 ++++++++- 2 files changed, 13 insertions(+), 4 deletions(-) diff --git a/components/deep_sleep.rst b/components/deep_sleep.rst index c9914a96a..41fc166de 100644 --- a/components/deep_sleep.rst +++ b/components/deep_sleep.rst @@ -21,7 +21,9 @@ to wake up on any RTC pin (``GPIO0``, ``GPIO2``, ``GPIO4``, ``GPIO12``, ``GPIO13 ``GPIO15``, ``GPIO25``, ``GPIO26``, ``GPIO27``, ``GPIO32``, ``GPIO39``). While in deep sleep mode, the node will not do any work and not respond to any network traffic, -even Over The Air updates. +even Over The Air updates. If the device's entities are appearing as **Unavailable** while your device is actively +sleeping, this component was likely added after the device was added to Home Assistant. To prevent this behavior, +you can remove and re-add the device within ESPHome. .. code-block:: yaml @@ -32,8 +34,8 @@ even Over The Air updates. .. note:: - Some ESP8266s have an onboard USB chip (e.g. D1 mini) on the chips' control line that is connected to the RST pin. This enables the flasher to reboot the ESP when required. This may interfere with deep sleep on some devices and prevent the ESP from waking when it's powered through its USB connector. Powering the ESP from a separate 3.3V source connected to the 3.3V pin and GND will solve this issue. In these cases, using a USB to TTL adapter will allow you to log ESP activity. - + Some ESP8266s have an onboard USB chip (e.g. D1 mini) on the chips' control line that is connected to the RST pin. This enables the flasher to reboot the ESP when required. This may interfere with deep sleep on some devices and prevent the ESP from waking when it's powered through its USB connector. Powering the ESP from a separate 3.3V source connected to the 3.3V pin and GND will solve this issue. In these cases, using a USB to TTL adapter will allow you to log ESP activity. + Configuration variables: ------------------------ diff --git a/guides/faq.rst b/guides/faq.rst index bf6a86512..e80bfc7c1 100644 --- a/guides/faq.rst +++ b/guides/faq.rst @@ -361,7 +361,7 @@ And a docker compose file looks like this: .. _docker-reference-notes: .. note:: - By default ESPHome uses mDNS to show online/offline state in the dashboard view. So for that feature to work you need to enable host networking mode. + By default ESPHome uses mDNS to show online/offline state in the dashboard view. So for that feature to work you need to enable host networking mode. On MacOS the networking mode ("-net=host" option) doesn't work as expected. You have to use another way to launch the dashboard with a port mapping option and use alternative to mDNS @@ -451,6 +451,13 @@ Note that this only works for Pull Requests that only change files within compon ``esphome/components/`` are added or changed, this method unfortunately doesn't work. Those Pull Requests are labeled with the "core" label on GitHub. +Why do entities show as Unavailable during deep sleep? +------------------------------------------------------ + +The :doc:`Deep Sleep ` component needs to be present within the config when the device +is first added to Home Assistant. To prevent entities from appearing as Unavailable, you can remove and re-add the +device within ESPHome. + See Also --------