chore: add comment about rpc channel hacks and separate property files

Author: allenporter

roborock/devices/traits/traits_mixin.py

@@ -40,7 +40,6 @@ def __init__(self, trait: Trait) -> None:
         This will populate the appropriate trait attributes based on the types
         of the traits provided.
         """
-        # trait_map: dict[type[Trait], Trait] = {type(item): item for item in traits}
         for item in fields(self):
             trait_type = _get_trait_type(item)
             if trait_type == type(trait):

roborock/devices/traits/v1/__init__.py

@@ -6,14 +6,19 @@
 from roborock.devices.traits import Trait
 from roborock.devices.v1_rpc_channel import V1RpcChannel
 
+from .clean_summary import CleanSummaryTrait
 from .common import V1TraitMixin
-from .properties import CleanSummaryTrait, DoNotDisturbTrait, SoundVolumeTrait, StatusTrait
+from .do_not_disturb import DoNotDisturbTrait
+from .status import StatusTrait
+from .volume import SoundVolumeTrait
 
 __all__ = [
     "create",
     "PropertiesApi",
-    "properties",
-    "V1TraitMixin",
+    "StatusTrait",
+    "DoNotDisturbTrait",
+    "CleanSummaryTrait",
+    "SoundVolumeTrait",
 ]
 
 
@@ -36,7 +41,10 @@ def __init__(self, product: HomeDataProduct, rpc_channel: V1RpcChannel) -> None:
         """Initialize the V1TraitProps with None values."""
         self.status = StatusTrait(product)
 
-        # Create traits and set the RPC channel
+        # This is a hack to allow setting the rpc_channel on all traits. This is
+        # used so we can preserve the dataclass behavior when the values in the
+        # traits are updated, but still want to allow them to have a reference
+        # to the rpc channel for sending commands.
         for item in fields(self):
             if (trait := getattr(self, item.name, None)) is None:
                 trait = item.type()

roborock/devices/traits/v1/clean_summary.py

@@ -0,0 +1,29 @@
+from typing import Self
+
+from roborock.containers import CleanSummary
+from roborock.devices.traits.v1 import common
+from roborock.roborock_typing import RoborockCommand
+from roborock.util import unpack_list
+
+
+class CleanSummaryTrait(CleanSummary, common.V1TraitMixin):
+    """Trait for managing the clean summary of Roborock devices."""
+
+    command = RoborockCommand.GET_CLEAN_SUMMARY
+
+    @classmethod
+    def _parse_type_response(cls, response: common.V1ResponseData) -> Self:
+        """Parse the response from the device into a CleanSummary."""
+        if isinstance(response, dict):
+            return CleanSummaryTrait.from_dict(response)  # type: ignore[return-value]
+        elif isinstance(response, list):
+            clean_time, clean_area, clean_count, records = unpack_list(response, 4)
+            return CleanSummaryTrait(  # type: ignore[return-value]
+                clean_time=clean_time,
+                clean_area=clean_area,
+                clean_count=clean_count,
+                records=records,
+            )
+        elif isinstance(response, int):
+            return CleanSummaryTrait(clean_time=response)  # type: ignore[return-value]
+        raise ValueError(f"Unexpected clean summary format: {response!r}")

roborock/devices/traits/v1/do_not_disturb.py

@@ -0,0 +1,17 @@
+from roborock.containers import DnDTimer
+from roborock.devices.traits.v1 import common
+from roborock.roborock_typing import RoborockCommand
+
+
+class DoNotDisturbTrait(DnDTimer, common.V1TraitMixin):
+    """Trait for managing Do Not Disturb (DND) settings on Roborock devices."""
+
+    command = RoborockCommand.GET_DND_TIMER
+
+    async def set_dnd_timer(self, dnd_timer: DnDTimer) -> None:
+        """Set the Do Not Disturb (DND) timer settings of the device."""
+        await self.rpc_channel.send_command(RoborockCommand.SET_DND_TIMER, params=dnd_timer.as_dict())
+
+    async def clear_dnd_timer(self) -> None:
+        """Clear the Do Not Disturb (DND) timer settings of the device."""
+        await self.rpc_channel.send_command(RoborockCommand.CLOSE_DND_TIMER)

roborock/devices/traits/v1/properties.py

@@ -0,0 +1,24 @@
+from typing import Self
+
+from roborock.containers import HomeDataProduct, ModelStatus, S7MaxVStatus, Status
+from roborock.devices.traits.v1 import common
+from roborock.roborock_typing import RoborockCommand
+
+
+class StatusTrait(Status, common.V1TraitMixin):
+    """Trait for managing the status of Roborock devices."""
+
+    command = RoborockCommand.GET_STATUS
+
+    def __init__(self, product_info: HomeDataProduct) -> None:
+        """Initialize the StatusTrait."""
+        self._product_info = product_info
+
+    def _parse_response(self, response: common.V1ResponseData) -> Self:
+        """Parse the response from the device into a CleanSummary."""
+        status_type: type[Status] = ModelStatus.get(self._product_info.model, S7MaxVStatus)
+        if isinstance(response, list):
+            response = response[0]
+        if isinstance(response, dict):
+            return status_type.from_dict(response)
+        raise ValueError(f"Unexpected status format: {response!r}")

roborock/devices/traits/v1/status.py

@@ -0,0 +1,26 @@
+from dataclasses import dataclass, field
+
+from roborock.devices.traits.v1 import common
+from roborock.roborock_typing import RoborockCommand
+
+# TODO: This is currently the pattern for holding all the commands that hold a
+# single value, but it still seems too verbose. Maybe we can generate these
+# dynamically or somehow make them less code.
+
+
+@dataclass
+class SoundVolume(common.RoborockValueBase):
+    """Dataclass for sound volume."""
+
+    volume: int | None = field(default=None, metadata={"roborock_value": True})
+    """Sound volume level (0-100)."""
+
+
+class SoundVolumeTrait(SoundVolume, common.V1TraitMixin):
+    """Trait for controlling the sound volume of a Roborock device."""
+
+    command = RoborockCommand.GET_SOUND_VOLUME
+
+    async def set_volume(self, volume: int) -> None:
+        """Set the sound volume of the device."""
+        await self.rpc_channel.send_command(RoborockCommand.CHANGE_SOUND_VOLUME, params=[volume])

roborock/devices/traits/v1/volume.py

@@ -6,7 +6,7 @@
 
 from roborock.containers import CleanSummary
 from roborock.devices.device import RoborockDevice
-from roborock.devices.traits.v1.properties import CleanSummaryTrait
+from roborock.devices.traits.v1.clean_summary import CleanSummaryTrait
 from roborock.exceptions import RoborockException
 from roborock.roborock_typing import RoborockCommand
 

tests/devices/traits/v1/test_clean_summary.py

@@ -6,7 +6,7 @@
 
 from roborock.containers import DnDTimer
 from roborock.devices.device import RoborockDevice
-from roborock.devices.traits.v1.properties import DoNotDisturbTrait
+from roborock.devices.traits.v1.do_not_disturb import DoNotDisturbTrait
 from roborock.roborock_typing import RoborockCommand