Handle MapTrace events

Author: nanomad

deebot_client/messages/xml/__init__.py

@@ -12,7 +12,7 @@
     CleanReportServer,
     CleanSt,
 )
-from deebot_client.messages.xml.map import MapP
+from deebot_client.messages.xml.map import MapP, Trace
 from deebot_client.messages.xml.pos import Pos
 from deebot_client.messages.xml.sleep import SleepStatus
 from deebot_client.messages.xml.water_info import WaterBoxInfo
@@ -30,6 +30,7 @@
     "MapP",
     "Pos",
     "SleepStatus",
+    "Trace",
     "WaterBoxInfo",
 ]
 # fmt: off
@@ -44,6 +45,7 @@
     MapP,
     Pos,
     SleepStatus,
+    Trace,
     WaterBoxInfo,
 ]
 # fmt: on

deebot_client/messages/xml/clean.py

@@ -39,9 +39,10 @@ def _handle_xml(cls, _event_bus: EventBus, _xml: Element) -> HandlingResult:
 
         b"<ctl td='CleanSt' a='21' s='1743945874' l='1595' t='' type='auto'/>"
 
+        We currently ignore this message as we prefer to use CleanReport
         :return: A message response
         """
-        return HandlingResult.analyse()
+        return HandlingResult.success()
 
 
 class CleanReport(XmlMessage):
@@ -93,29 +94,34 @@ def _handle_xml(cls, event_bus: EventBus, xml: Element) -> HandlingResult:
         :return: A message response
         """
         event_reported = False
-        if act := xml.attrib.get("act"):
+        if (
+            (act := xml.attrib.get("act")) is not None
+            and (last := xml.attrib.get("last")) is not None
+            and (area := xml.attrib.get("area")) is not None
+        ):
             clean_session = xml.attrib.get("cs")
-            last = xml.attrib.get("last")
-            area = xml.attrib.get("area")
-            type = xml.attrib.get("type")
+            clean_type = xml.attrib.get("type")
+
             clean_action = CleanAction.from_xml(act)
             if clean_action == CleanAction.STOP:
-                event_bus.notify(StatsEvent(area=area, time=last, type=type))
+                event_bus.notify(
+                    StatsEvent(area=int(area), time=int(last), type=clean_type)
+                )
                 event_reported = True
             if clean_session:
                 if clean_action == CleanAction.STOP:
                     job_status = CleanJobStatus.FINISHED
                 elif clean_action == CleanAction.START:
                     job_status = CleanJobStatus.CLEANING
                 elif clean_action == CleanAction.PAUSE:
-                    job_status = CleanJobStatus.PAUSED
+                    job_status = CleanJobStatus.MANUALLY_STOPPED
                 else:
                     job_status = CleanJobStatus.NO_STATUS
                 event_bus.notify(
                     ReportStatsEvent(
-                        area=area,
-                        time=last,
-                        type=type,
+                        area=int(area),
+                        time=int(last),
+                        type=clean_type,
                         cleaning_id=clean_session,
                         status=job_status,
                         content=[],

deebot_client/messages/xml/map.py

@@ -4,6 +4,7 @@
 
 from typing import TYPE_CHECKING
 
+from deebot_client.events.map import MapTraceEvent
 from deebot_client.message import HandlingResult
 from deebot_client.messages.xml.common import XmlMessage
 
@@ -27,6 +28,31 @@ def _handle_xml(cls, _event_bus: EventBus, _xml: Element) -> HandlingResult:
 
         b"<ctl td='MapP' i='1245233875' pid='27' p='XQAABAAQJwAAAABv/f//o7f/Rz5IFXI5YVG4kYRDU5g6Z4W8UflplyVyfWyHmYdt2YVgA/k3ENxVye1lEM...fqEp3pept9Re5qT0lZFDWpoFg4D51VXQopPSDLSo2ZpM/zQ4IAhvgWIKnp7zlwcd6Ekj7U2FnOTTAQeWq3DPT+MTrAVO2wL/6mmGODzk4hBtA/wjZzOujPgEA=='/>"
 
+        This is currently ignored as we prefer to pull map pieces
         :return: A message response
         """
+        return HandlingResult.success()
+
+
+class Trace(XmlMessage):
+    """Trace message."""
+
+    NAME = "trace"
+
+    @classmethod
+    def _handle_xml(cls, event_bus: EventBus, xml: Element) -> HandlingResult:
+        """Handle xml message and notify the correct event subscribers.
+
+        Sample message:
+        <ctl td='trace' trid='631369' tf='16' tt='17' tr='XQAABAAKAAAAAG0/wEAAA2cAS5AAAA=='/>
+
+        :return: A message response
+        """
+        if (
+            (tf := xml.attrib.get("tf"))
+            and (tt := xml.attrib.get("tt"))
+            and (tr := xml.attrib.get("tr"))
+        ):
+            event_bus.notify(MapTraceEvent(start=int(tf), total=int(tt), data=tr))
+            return HandlingResult.success()
         return HandlingResult.analyse()

deebot_client/messages/xml/sleep.py

@@ -24,6 +24,8 @@ def _handle_xml(cls, _event_bus: EventBus, _xml: Element) -> HandlingResult:
 
         b"<ctl ts='1744467249545' td='SleepStatus' st='0'/>"
 
+        We currently ignore this message
+
         :return: A message response
         """
-        return HandlingResult.analyse()
+        return HandlingResult.success()

deebot_client/messages/xml/water_info.py

@@ -4,7 +4,7 @@
 
 from typing import TYPE_CHECKING
 
-from deebot_client.events import WaterAmount, WaterInfoEvent
+from deebot_client.events import WaterInfoEvent
 from deebot_client.message import HandlingResult
 from deebot_client.messages.xml.common import XmlMessage
 
@@ -28,7 +28,5 @@ def _handle_xml(cls, event_bus: EventBus, xml: Element) -> HandlingResult:
         if (on := xml.attrib.get("on")) is None:
             return HandlingResult.analyse()
 
-        event_bus.notify(
-            WaterInfoEvent(amount=WaterAmount.HIGH, mop_attached=on != "0")
-        )
+        event_bus.notify(WaterInfoEvent(mop_attached=on != "0"))
         return HandlingResult.success()