feat: Combine the clean record trait with the clean summary

This makes the calling code simpler for inspecting cleaning data, and reduces interdependencies between traits exposing internal API details.

Author: allenporter

roborock/data/v1/v1_containers.py

@@ -449,6 +449,12 @@ def __repr__(self) -> str:
         return _attr_repr(self)
 
 
+class CleanSummaryWithDetail(CleanSummary):
+    """CleanSummary with the last CleanRecord included."""
+
+    last_clean_record: CleanRecord | None = None
+
+
 @dataclass
 class Consumable(RoborockBase):
     main_brush_work_time: int | None = None

roborock/devices/traits/v1/__init__.py

@@ -42,7 +42,6 @@
 from roborock.map.map_parser import MapParserConfig
 
 from .child_lock import ChildLockTrait
-from .clean_record import CleanRecordTrait
 from .clean_summary import CleanSummaryTrait
 from .command import CommandTrait
 from .common import V1TraitMixin
@@ -70,7 +69,6 @@
     "StatusTrait",
     "DoNotDisturbTrait",
     "CleanSummaryTrait",
-    "CleanRecordTrait",
     "SoundVolumeTrait",
     "MapsTrait",
     "MapContentTrait",
@@ -100,7 +98,6 @@ class PropertiesApi(Trait):
     command: CommandTrait
     dnd: DoNotDisturbTrait
     clean_summary: CleanSummaryTrait
-    clean_record: CleanRecordTrait
     sound_volume: SoundVolumeTrait
     rooms: RoomsTrait
     maps: MapsTrait
@@ -135,8 +132,6 @@ def __init__(
         self._cache = cache
 
         self.status = StatusTrait(product)
-        self.clean_summary = CleanSummaryTrait()
-        self.clean_record = CleanRecordTrait(self.clean_summary)
         self.consumables = ConsumableTrait()
         self.rooms = RoomsTrait(home_data)
         self.maps = MapsTrait(self.status)

roborock/devices/traits/v1/clean_record.py

@@ -1,16 +1,33 @@
+import logging
 from typing import Self
 
-from roborock.data import CleanSummary
+from roborock.data import CleanRecord, CleanSummaryWithDetail
 from roborock.devices.traits.v1 import common
 from roborock.roborock_typing import RoborockCommand
 from roborock.util import unpack_list
 
+_LOGGER = logging.getLogger(__name__)
 
-class CleanSummaryTrait(CleanSummary, common.V1TraitMixin):
+
+class CleanSummaryTrait(CleanSummaryWithDetail, common.V1TraitMixin):
     """Trait for managing the clean summary of Roborock devices."""
 
     command = RoborockCommand.GET_CLEAN_SUMMARY
 
+    async def refresh(self) -> Self:
+        """Refresh the clean summary data and last clean record.
+
+        Assumes that the clean summary has already been fetched.
+        """
+        await super().refresh()
+        if not self.records:
+            _LOGGER.debug("No clean records available in clean summary.")
+            self.last_clean_record = None
+            return self
+        last_record_id = self.records[-1]
+        self.last_clean_record = await self.get_clean_record(last_record_id)
+        return self
+
     @classmethod
     def _parse_type_response(cls, response: common.V1ResponseData) -> Self:
         """Parse the response from the device into a CleanSummary."""
@@ -27,3 +44,39 @@ def _parse_type_response(cls, response: common.V1ResponseData) -> Self:
         elif isinstance(response, int):
             return cls(clean_time=response)
         raise ValueError(f"Unexpected clean summary format: {response!r}")
+
+    async def get_clean_record(self, record_id: int) -> CleanRecord:
+        """Load a specific clean record by ID."""
+        response = await self.rpc_channel.send_command(RoborockCommand.GET_CLEAN_RECORD, params=[record_id])
+        return self._parse_clean_record_response(response)
+
+    @classmethod
+    def _parse_clean_record_response(cls, response: common.V1ResponseData) -> CleanRecord:
+        """Parse the response from the device into a CleanRecord."""
+        if isinstance(response, dict):
+            return CleanRecord.from_dict(response)
+        if isinstance(response, list):
+            if isinstance(response[-1], dict):
+                records = [CleanRecord.from_dict(rec) for rec in response]
+                final_record = records[-1]
+                try:
+                    # This code is semi-presumptions - so it is put in a try finally to be safe.
+                    final_record.begin = records[0].begin
+                    final_record.begin_datetime = records[0].begin_datetime
+                    final_record.start_type = records[0].start_type
+                    for rec in records[0:-1]:
+                        final_record.duration = (final_record.duration or 0) + (rec.duration or 0)
+                        final_record.area = (final_record.area or 0) + (rec.area or 0)
+                        final_record.avoid_count = (final_record.avoid_count or 0) + (rec.avoid_count or 0)
+                        final_record.wash_count = (final_record.wash_count or 0) + (rec.wash_count or 0)
+                        final_record.square_meter_area = (final_record.square_meter_area or 0) + (
+                            rec.square_meter_area or 0
+                        )
+                    return final_record
+                except Exception:
+                    # Return final record when an exception occurred
+                    return final_record
+            # There are still a few unknown variables in this.
+            begin, end, duration, area = unpack_list(response, 4)
+            return CleanRecord(begin=begin, end=end, duration=duration, area=area)
+        raise ValueError(f"Unexpected clean record format: {response!r}")

roborock/devices/traits/v1/clean_summary.py

@@ -6,7 +6,7 @@
   DoNotDisturbTrait(start_hour=22, start_minute=0, end_hour=8, end_minute=0, enabled=1)
 # ---
 # name: test_device_trait_command_parsing[payload2-<lambda>]
-  CleanSummaryTrait(clean_area=24258125000, clean_count=296, clean_time=1442559, command=<RoborockCommand.GET_CLEAN_SUMMARY: 'get_clean_summary'>, dust_collection_count=None, last_clean_t=None, records=[1756848207, 1754930385, 1753203976, 1752183435, 1747427370, 1746204046, 1745601543, 1744387080, 1743528522, 1742489154, 1741022299, 1740433682, 1739902516, 1738875106, 1738864366, 1738620067, 1736873889, 1736197544, 1736121269, 1734458038], square_meter_clean_area=24258.1)
+  CleanSummaryTrait(clean_area=24258125000, clean_count=296, clean_time=1442559, command=<RoborockCommand.GET_CLEAN_SUMMARY: 'get_clean_summary'>, dust_collection_count=None, last_clean_record=[1442559, 24258125000, 296, [1756848207, 1754930385, 1753203976, 1752183435, 1747427370, 1746204046, 1745601543, 1744387080, 1743528522, 1742489154, 1741022299, 1740433682, 1739902516, 1738875106, 1738864366, 1738620067, 1736873889, 1736197544, 1736121269, 1734458038]], last_clean_t=None, records=[1756848207, 1754930385, 1753203976, 1752183435, 1747427370, 1746204046, 1745601543, 1744387080, 1743528522, 1742489154, 1741022299, 1740433682, 1739902516, 1738875106, 1738864366, 1738620067, 1736873889, 1736197544, 1736121269, 1734458038], square_meter_clean_area=24258.1)
 # ---
 # name: test_device_trait_command_parsing[payload3-<lambda>]
   SoundVolumeTrait(volume=90)