python-roborock 4.14.0__tar.gz → 4.16.0__tar.gz

{python_roborock-4.14.0 → python_roborock-4.16.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-roborock
-Version: 4.14.0
+Version: 4.16.0
 Summary: A package to control Roborock vacuums.
 Project-URL: Repository, https://github.com/humbertogontijo/python-roborock
 Project-URL: Documentation, https://python-roborock.readthedocs.io/

{python_roborock-4.14.0 → python_roborock-4.16.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "python-roborock"
-version = "4.14.0"
+version = "4.16.0"
 description = "A package to control Roborock vacuums."
 authors = [{ name = "humbertogontijo", email = "humbertogontijo@users.noreply.github.com" }, {name="Lash-L"}, {name="allenporter"}]
 requires-python = ">=3.11, <4"

{python_roborock-4.14.0 → python_roborock-4.16.0}/roborock/devices/traits/b01/q10/common.py

@@ -36,12 +36,41 @@ and call `update_from_dps` whenever new data is received from the device stream.
 """
 
 import dataclasses
+import logging
+from collections.abc import Callable
 from typing import Any
 
+from roborock.callbacks import CallbackList
 from roborock.data.b01_q10.b01_q10_code_mappings import B01_Q10_DP
 from roborock.data.containers import RoborockBase
 
 
+class TraitUpdateListener:
+    """Trait update listener.
+
+    This is a base class for traits to support notifying listeners when they
+    have been updated. Clients may register callbacks to be notified when the
+    trait has been updated. When the listener callback is invoked, the client
+    should read the trait's properties to get the updated values.
+    """
+
+    def __init__(self, logger: logging.Logger) -> None:
+        """Initialize the trait update listener."""
+        self._update_callbacks: CallbackList[None] = CallbackList(logger=logger)
+
+    def add_update_listener(self, callback: Callable[[], None]) -> Callable[[], None]:
+        """Register a callback when the trait has been updated.
+
+        Returns a callable to remove the listener.
+        """
+        # We wrap the callback to ignore the value passed to it.
+        return self._update_callbacks.add_callback(lambda _: callback())
+
+    def _notify_update(self) -> None:
+        """Notify all update listeners."""
+        self._update_callbacks(None)
+
+
 class DpsDataConverter:
     """Utility to handle the transformation and merging of DPS data into models.
 
@@ -66,7 +95,7 @@ class DpsDataConverter:
                 dps_field_map[dps_id] = field_obj.name
         return cls(dps_type_map, dps_field_map)
 
-    def update_from_dps(self, target: RoborockBase, decoded_dps: dict[B01_Q10_DP, Any]) -> None:
+    def update_from_dps(self, target: RoborockBase, decoded_dps: dict[B01_Q10_DP, Any]) -> bool:
         """Convert and merge raw DPS data into the target object.
 
         Uses the pre-calculated type mapping to ensure values are converted to the
@@ -75,8 +104,12 @@ class DpsDataConverter:
         Args:
             target: The target object to update.
             decoded_dps: The decoded DPS data to convert.
+
+        Returns:
+            True if any values were updated, False otherwise.
         """
         conversions = RoborockBase.convert_dict(self._dps_type_map, decoded_dps)
         for dps_id, value in conversions.items():
             field_name = self._dps_field_map[dps_id]
             setattr(target, field_name, value)
+        return bool(conversions)

python_roborock-4.16.0/roborock/devices/traits/b01/q10/status.py

@@ -0,0 +1,32 @@
+"""Status trait for Q10 B01 devices."""
+
+import logging
+from typing import Any
+
+from roborock.data.b01_q10.b01_q10_code_mappings import B01_Q10_DP
+from roborock.data.b01_q10.b01_q10_containers import Q10Status
+
+from .common import DpsDataConverter, TraitUpdateListener
+
+_LOGGER = logging.getLogger(__name__)
+
+_CONVERTER = DpsDataConverter.from_dataclass(Q10Status)
+
+
+class StatusTrait(Q10Status, TraitUpdateListener):
+    """Trait for managing the status of Q10 Roborock devices.
+
+    This is a thin wrapper around Q10Status that provides the Trait interface.
+    The current values reflect the most recently received data from the device.
+    New values can be requested through the `Q10PropertiesApi`'s `refresh` method.
+    """
+
+    def __init__(self) -> None:
+        """Initialize the status trait."""
+        super().__init__()
+        TraitUpdateListener.__init__(self, logger=_LOGGER)
+
+    def update_from_dps(self, decoded_dps: dict[B01_Q10_DP, Any]) -> None:
+        """Update the trait from raw DPS data."""
+        if _CONVERTER.update_from_dps(self, decoded_dps):
+            self._notify_update()

python_roborock-4.14.0/roborock/devices/traits/b01/q10/status.py

@@ -1,26 +0,0 @@
-"""Status trait for Q10 B01 devices."""
-
-import logging
-
-from roborock.data.b01_q10.b01_q10_containers import Q10Status
-
-from .common import DpsDataConverter
-
-_LOGGER = logging.getLogger(__name__)
-
-_CONVERTER = DpsDataConverter.from_dataclass(Q10Status)
-
-
-class StatusTrait(Q10Status):
-    """Trait for managing the status of Q10 Roborock devices.
-
-    This is a thin wrapper around Q10Status that provides the Trait interface.
-    The current values reflect the most recently received data from the device.
-    New values can be requited through the `Q10PropertiesApi`'s `refresh` method.
-    """
-
-    def update_from_dps(self, decoded_dps: dict) -> None:
-        """Update the trait from raw DPS data."""
-        _CONVERTER.update_from_dps(self, decoded_dps)
-        # In the future we can register listeners and notify them here on update
-        # if `update_from_dps` performed any updates.