#263 observe deep sleep and keep sensors always available

hatasmota/const.py

@@ -182,6 +182,7 @@
 # Power units
 POWER_WATT: Final = "W"
 REACTIVE_POWER = "VAr"
+POWER_FACTOR: Final = "Cos φ"
 
 # Voltage units
 VOLT: Final = "V"

hatasmota/device_status.py

@@ -26,6 +26,7 @@
     get_topic_stat_status,
     get_topic_tele_state,
     get_topic_tele_will,
+    get_topic_sleep_state,
     get_value_by_path,
 )
 
@@ -98,6 +99,7 @@ def from_discovery_message(cls, config: dict) -> TasmotaDeviceStatusConfig:
             poll_payload=str(STATUS_TOPICS.get(sensor)),
             poll_topic=get_topic_command_status(config),
             availability_topic=get_topic_tele_will(config),
+            sleep_state_topic=get_topic_sleep_state(config),
             availability_offline=config_get_state_offline(config),
             availability_online=config_get_state_online(config),
             state_topic=get_topic_tele_state(config),

hatasmota/entity.py

@@ -5,6 +5,11 @@
 from dataclasses import dataclass
 import logging
 from typing import Any
+import time
+import json
+from .utils import (
+    get_value_by_path,
+)
 
 from .mqtt import ReceiveMessage, TasmotaMQTTClient
 
@@ -36,6 +41,7 @@ class TasmotaAvailabilityConfig(TasmotaEntityConfig):
     availability_topic: str
     availability_offline: str
     availability_online: str
+    sleep_state_topic: str
 
 
 class TasmotaEntity:
@@ -98,27 +104,65 @@ def __init__(self, **kwds: Any):
         self._on_availability_callback: Callable[
             [bool], Coroutine[Any, Any, None]
         ] | None = None
+        self.uses_deep_sleep = False
+        self.deep_sleep_interval = None
+        self.last_up=0
+        self.available=None
         super().__init__(**kwds)
 
     def get_availability_topics(self) -> dict:
         """Return MQTT topics to subscribe to for availability state."""
 
         async def availability_message_received(msg: ReceiveMessage) -> None:
             """Handle a new received MQTT availability message."""
+            last_up_retain=self.last_up
             if msg.payload == self._cfg.availability_online:
+                if self.last_up and self.deep_sleep_interval is None:
+                    self.deep_sleep_interval = int(time.time() - self.last_up)
                 await self.poll_status()
+            else:
+                self.last_up=time.time()
+            available=self.available
+            if msg.payload == self._cfg.availability_online:
+                available=True
+            if msg.payload == self._cfg.availability_offline and not(self.uses_deep_sleep):
+                if not(self.uses_deep_sleep):
+                    available=False
+                else:
+                    _LOGGER.debug("inhibit deep sleep %s", msg.topic)
             if not self._on_availability_callback:
+                self.available=available
                 return
-            if msg.payload == self._cfg.availability_online:
-                await self._on_availability_callback(True)
-            if msg.payload == self._cfg.availability_offline:
-                await self._on_availability_callback(False)
-
+            if self.available != available: 
+                await self._on_availability_callback(available)
+                self.available=available
+
+        async def sleep_state_message_received(msg: ReceiveMessage) -> None:
+            """Handle state messages to indicate deep sleep."""
+            #try:
+            #    payload = json.loads(msg.payload)
+            #except json.decoder.JSONDecodeError:
+            #    return
+            _LOGGER.debug("sleep state %s -> %s", msg.topic, msg.payload)
+            state = get_value_by_path(msg.payload, ["StatusPRM","RestartReason"])
+            if state is not None:
+                state=str(state).lower()
+                if state.startswith('deep sleep'):
+                    if not(self.uses_deep_sleep):
+                        _LOGGER.debug("switching to deep sleep mode %s", msg.topic)
+                        self.deep_sleep_interval=None
+                        self.uses_deep_sleep=True
+
         topics = {
             "availability_topic": {
                 "event_loop_safe": True,
                 "msg_callback": availability_message_received,
                 "topic": self._cfg.availability_topic,
+            },
+            "sleep_state_topic": {
+                "event_loop_safe": True,
+                "msg_callback": sleep_state_message_received,
+                "topic": self._cfg.sleep_state_topic,
             }
         }
         return topics

hatasmota/fan.py

@@ -28,6 +28,7 @@
     get_topic_stat_result,
     get_topic_tele_state,
     get_topic_tele_will,
+    get_topic_sleep_state,
     get_value_by_path,
 )
 
@@ -56,6 +57,7 @@ def from_discovery_message(cls, config: dict, platform: str) -> TasmotaFanConfig
             poll_payload="",
             poll_topic=get_topic_command_state(config),
             availability_topic=get_topic_tele_will(config),
+            sleep_state_topic=get_topic_sleep_state(config),
             availability_offline=config_get_state_offline(config),
             availability_online=config_get_state_online(config),
             command_topic=get_topic_command(config),

hatasmota/light.py

@@ -53,6 +53,7 @@
     get_topic_stat_result,
     get_topic_tele_state,
     get_topic_tele_will,
+    get_topic_sleep_state,
     get_value_by_path,
 )
 
@@ -154,6 +155,7 @@ def from_discovery_message(
             poll_payload="",
             poll_topic=get_topic_command_state(config),
             availability_topic=get_topic_tele_will(config),
+            sleep_state_topic=get_topic_sleep_state(config),
             availability_offline=config_get_state_offline(config),
             availability_online=config_get_state_online(config),
             dimmer_cmd=dimmer_cmd,

hatasmota/relay.py

@@ -24,6 +24,7 @@
     get_topic_command_state,
     get_topic_stat_result,
     get_topic_tele_state,
+    get_topic_sleep_state,
     get_topic_tele_will,
 )
 
@@ -56,6 +57,7 @@ def from_discovery_message(
             poll_payload="",
             poll_topic=get_topic_command_state(config),
             availability_topic=get_topic_tele_will(config),
+            sleep_state_topic=get_topic_sleep_state(config),
             availability_offline=config_get_state_offline(config),
             availability_online=config_get_state_online(config),
             command_topic=get_topic_command(config),

hatasmota/sensor.py

@@ -102,6 +102,7 @@
     get_topic_stat_status,
     get_topic_tele_sensor,
     get_topic_tele_will,
+    get_topic_sleep_state,
     get_value_by_path,
 )
 
@@ -268,6 +269,7 @@ def from_discovery_message(
             poll_payload="10",
             poll_topic=get_topic_command_status(device_config),
             availability_topic=get_topic_tele_will(device_config),
+            sleep_state_topic=get_topic_sleep_state(device_config),
             availability_offline=config_get_state_offline(device_config),
             availability_online=config_get_state_online(device_config),
             quantity=quantity,

hatasmota/shutter.py

@@ -37,6 +37,7 @@
     get_topic_stat_status,
     get_topic_tele_sensor,
     get_topic_tele_will,
+    get_topic_sleep_state,
     get_value_by_path,
 )
 
@@ -75,6 +76,7 @@ def from_discovery_message(
             poll_payload="10",
             poll_topic=get_topic_command_status(config),
             availability_topic=get_topic_tele_will(config),
+            sleep_state_topic=get_topic_sleep_state(config),
             availability_offline=config_get_state_offline(config),
             availability_online=config_get_state_online(config),
             command_topic=get_topic_command(config),

hatasmota/status_sensor.py

@@ -35,6 +35,7 @@
     get_topic_command_status,
     get_topic_stat_status,
     get_topic_tele_state,
+    get_topic_sleep_state,
     get_topic_tele_will,
     get_value_by_path,
 )
@@ -176,6 +177,7 @@ def from_discovery_message(
                 poll_payload=str(STATUS_TOPICS.get(sensor)),
                 poll_topic=get_topic_command_status(config),
                 availability_topic=get_topic_tele_will(config),
+                sleep_state_topic=get_topic_sleep_state(config),
                 availability_offline=config_get_state_offline(config),
                 availability_online=config_get_state_online(config),
                 sensor=sensor,

hatasmota/switch.py

@@ -52,6 +52,7 @@
     get_topic_stat_status,
     get_topic_tele_sensor,
     get_topic_tele_will,
+    get_topic_sleep_state,
     get_value_by_path,
 )
 
@@ -273,6 +274,7 @@ def from_discovery_message(
             poll_payload="10",
             poll_topic=get_topic_command_status(config),
             availability_topic=get_topic_tele_will(config),
+            sleep_state_topic=get_topic_sleep_state(config),
             availability_offline=config_get_state_offline(config),
             availability_online=config_get_state_online(config),
             off_delay=off_delay,

hatasmota/utils.py

@@ -109,6 +109,10 @@ def get_topic_stat_status(config: ConfigType, idx: int | None = None) -> str:
         return _get_topic_stat(config) + "STATUS"
     return _get_topic_stat(config) + f"STATUS{idx}"
 
+def get_topic_sleep_state(config: ConfigType):
+    topic = get_topic_stat_status(config, 1)
+    _LOGGER.debug("Topic for sleep state %s", topic)
+    return topic
 
 def get_topic_stat_switch(config: ConfigType, idx: int) -> str:
     """Get topic for tele state."""