Merge branch 'main' into q10-map-layers

Author: tubededentifrice

CHANGELOG.md

@@ -2,6 +2,82 @@
 
 <!-- version list -->
 
+## v5.31.1 (2026-07-18)
+
+### Bug Fixes
+
+- Correct reset consumable parameters for strainer and cleaning brush
+  ([#879](https://github.com/Python-roborock/python-roborock/pull/879),
+  [`b11fc49`](https://github.com/Python-roborock/python-roborock/commit/b11fc4984445daa9a1837cef366d8543c3d1b7c8))
+
+### Chores
+
+- Add note about apache-II in CONTRIBUTING.md
+  ([#877](https://github.com/Python-roborock/python-roborock/pull/877),
+  [`a8a5821`](https://github.com/Python-roborock/python-roborock/commit/a8a582192b3ec1c74f9b56c83bda026bd6ec194b))
+
+
+## v5.31.0 (2026-07-15)
+
+### Features
+
+- Add Q10 integration test and support stream streaming on FakeChannel
+  ([#869](https://github.com/Python-roborock/python-roborock/pull/869),
+  [`502fa42`](https://github.com/Python-roborock/python-roborock/commit/502fa424c4a8fd36b759de8c8557c8665e4d0d13))
+
+- Implement Q10VacuumSimulator and export it
+  ([#869](https://github.com/Python-roborock/python-roborock/pull/869),
+  [`502fa42`](https://github.com/Python-roborock/python-roborock/commit/502fa424c4a8fd36b759de8c8557c8665e4d0d13))
+
+- Implement stateful Q10 device simulator and integration tests
+  ([#869](https://github.com/Python-roborock/python-roborock/pull/869),
+  [`502fa42`](https://github.com/Python-roborock/python-roborock/commit/502fa424c4a8fd36b759de8c8557c8665e4d0d13))
+
+
+## v5.30.0 (2026-07-13)
+
+### Bug Fixes
+
+- Gate dock_error_status on has_dock rather than is_collectable
+  ([#875](https://github.com/Python-roborock/python-roborock/pull/875),
+  [`86acd87`](https://github.com/Python-roborock/python-roborock/commit/86acd874e74c391d85c63483bee02a88b8a2debb))
+
+### Documentation
+
+- Document metadata keys in field_metadata and is_field_supported
+  ([#875](https://github.com/Python-roborock/python-roborock/pull/875),
+  [`86acd87`](https://github.com/Python-roborock/python-roborock/commit/86acd874e74c391d85c63483bee02a88b8a2debb))
+
+### Features
+
+- Implement device capability metadata for status computed property fields
+  ([#875](https://github.com/Python-roborock/python-roborock/pull/875),
+  [`86acd87`](https://github.com/Python-roborock/python-roborock/commit/86acd874e74c391d85c63483bee02a88b8a2debb))
+
+
+## v5.29.0 (2026-07-12)
+
+### Features
+
+- Truncate large payloads in RoborockMessage __repr__
+  ([#873](https://github.com/Python-roborock/python-roborock/pull/873),
+  [`95460d7`](https://github.com/Python-roborock/python-roborock/commit/95460d77a599613a0eddab3f4db7a36904f894d6))
+
+
+## v5.28.1 (2026-07-12)
+
+### Bug Fixes
+
+- Correct some dock mapping ([#872](https://github.com/Python-roborock/python-roborock/pull/872),
+  [`9e95992`](https://github.com/Python-roborock/python-roborock/commit/9e95992fcfceb70a0e73c86dc819cecc6dc572d1))
+
+### Refactoring
+
+- Use stateful fakes and fixtures in integration tests
+  ([#868](https://github.com/Python-roborock/python-roborock/pull/868),
+  [`89c8074`](https://github.com/Python-roborock/python-roborock/commit/89c80743e2c560f36f56e0c17c85c0d14544f406))
+
+
 ## v5.28.0 (2026-07-08)
 
 ### Features

CONTRIBUTING.md

@@ -2,6 +2,16 @@
 
 Thank you for your interest in contributing to `python-roborock`! We welcome contributions from the community.
 
+## Licensing of Contributions
+
+By submitting a contribution to this repository, you agree that your contribution is
+licensed under the [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0),
+and you certify that you have the right to submit it under that license.
+
+Note: the project is currently distributed under GPL-3.0 while we complete a planned
+migration to Apache 2.0. Apache 2.0 is GPL-compatible, so contributions made under
+Apache 2.0 can be included today and will carry over unchanged after the migration.
+
 ## Getting Started
 
 1.  **Fork the repository** on GitHub.

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "python-roborock"
-version = "5.28.0"
+version = "5.31.1"
 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"
@@ -52,6 +52,8 @@ dev = [
     # Pull in the CLI dependencies so maintainers can run the `roborock`
     # command and pdoc can import roborock.cli for docs generation.
     "python-roborock[cli]",
+    # aioresponses is not compatible with aiohttp 3.14 yet. https://github.com/pnuckowski/aioresponses/issues/289
+    "aiohttp>=3.8.2,<3.14",
     "pytest-asyncio>=1.1.0",
     "pytest",
     "pre-commit>=3.5,<5.0",

roborock/data/containers.py

@@ -60,6 +60,25 @@ def _attr_repr(obj: Any) -> str:
     return f"{type(obj).__name__}({', '.join(parts)})"
 
 
+def field_metadata(**kwargs):
+    """Decorator to attach capability check metadata to a property.
+
+    This attaches a `_field_metadata` dictionary to the underlying getter function,
+    which is then preserved when decorated with `@property`.
+
+    Supported metadata keys:
+    - `feature` (str): Name of a capability property on `DeviceFeaturesTrait`.
+    - `dock_feature` (str): Name of a capability property on `RoborockDockFeatures`.
+    - `dps` (str/int): RoborockDataProtocol ID to check against supported schema IDs.
+    """
+
+    def decorator(func):
+        func._field_metadata = kwargs
+        return func
+
+    return decorator
+
+
 @dataclass(repr=False)
 class RoborockBase:
     """Base class for all Roborock data classes."""

roborock/data/v1/v1_code_mappings.py

@@ -675,6 +675,7 @@ class RoborockDockTypeCode(RoborockEnum):
     type_27_dock = 27
     k1c_lite_dock = 28
     shell_2e_lite_dock = 30
+    shell_2e_heat_dock = 40
 
 
 class RoborockDockDustCollectionModeCode(RoborockEnum):

roborock/data/v1/v1_containers.py

@@ -39,7 +39,7 @@
 from roborock.exceptions import RoborockException
 from roborock.roborock_message import RoborockDataProtocol
 
-from ..containers import NamedRoomMapping, RoborockBase, RoborockBaseTimer, _attr_repr
+from ..containers import NamedRoomMapping, RoborockBase, RoborockBaseTimer, _attr_repr, field_metadata
 from .v1_clean_modes import WashTowelModes
 from .v1_code_mappings import (
     CleanFluidStatus,
@@ -117,6 +117,15 @@ class StatusField(FieldNameBase):
     CHARGE_STATUS = "charge_status"
     DRY_STATUS = "dry_status"
     ERROR_CODE = "error_code"
+    WATER_BOX_CARRIAGE_STATUS = "water_box_carriage_status"
+    WATER_BOX_STATUS = "water_box_status"
+    WATER_SHORTAGE_STATUS = "water_shortage_status"
+    DIRTY_WATER_BOX_STATUS = "dirty_water_box_status"
+    CLEAR_WATER_BOX_STATUS = "clear_water_box_status"
+    CLEAN_FLUID_STATUS = "clean_fluid_status"
+    CLEAN_PERCENT = "clean_percent"
+    DOCK_ERROR_STATUS = "dock_error_status"
+    RDT = "rdt"
 
 
 @dataclass
@@ -246,12 +255,14 @@ def has_am(self) -> bool | None:
         return (self.dss & 3) == 2
 
     @property
+    @field_metadata(dock_feature="is_washable")
     def clear_water_box_status(self) -> ClearWaterBoxStatus | None:
         if self.dss:
             return ClearWaterBoxStatus((self.dss >> 2) & 3)
         return None
 
     @property
+    @field_metadata(dock_feature="is_washable")
     def dirty_water_box_status(self) -> DirtyWaterBoxStatus | None:
         if self.dss:
             return DirtyWaterBoxStatus((self.dss >> 4) & 3)
@@ -270,6 +281,9 @@ def water_box_filter_status(self) -> int | None:
         return None
 
     @property
+    @field_metadata(
+        dock_feature="is_clean_fluid_auto_delivery_supported",
+    )
     def clean_fluid_status(self) -> CleanFluidStatus | None:
         if self.dss:
             value = (self.dss >> 10) & 3
@@ -313,7 +327,7 @@ class StatusV2(RoborockBase):
     in_returning: int | None = None
     in_fresh_state: int | None = None
     lab_status: int | None = None
-    water_box_status: int | None = None
+    water_box_status: int | None = field(default=None, metadata={"feature": "is_support_water_mode"})
     back_type: int | None = None
     wash_phase: int | None = None
     wash_ready: int | None = None
@@ -323,14 +337,14 @@ class StatusV2(RoborockBase):
     is_locating: int | None = None
     lock_status: int | None = None
     water_box_mode: int | None = field(default=None, metadata={"dps": RoborockDataProtocol.WATER_BOX_MODE})
-    water_box_carriage_status: int | None = None
+    water_box_carriage_status: int | None = field(default=None, metadata={"feature": "is_support_water_mode"})
     mop_forbidden_enable: int | None = None
     camera_status: int | None = None
     is_exploring: int | None = None
     home_sec_status: int | None = None
     home_sec_enable_password: int | None = None
     adbumper_status: list[int] | None = None
-    water_shortage_status: int | None = None
+    water_shortage_status: int | None = field(default=None, metadata={"feature": "is_support_water_mode"})
     dock_type: RoborockDockTypeCode | None = None
     dust_collection_status: int | None = None
     auto_dust_collection: int | None = None
@@ -339,7 +353,8 @@ class StatusV2(RoborockBase):
     debug_mode: int | None = None
     collision_avoid_status: int | None = None
     switch_map_mode: int | None = None
-    dock_error_status: RoborockDockErrorCode | None = None
+    dock_error_status: RoborockDockErrorCode | None = field(default=None, metadata={"dock_feature": "has_dock"})
+
     charge_status: RoborockChargeStatus | None = field(
         default=None, metadata={"dps": RoborockDataProtocol.CHARGE_STATUS}
     )
@@ -349,8 +364,8 @@ class StatusV2(RoborockBase):
     distance_off: int | None = None
     in_warmup: int | None = None
     dry_status: int | None = field(default=None, metadata={"dps": RoborockDataProtocol.DRYING_STATUS})
-    rdt: int | None = None
-    clean_percent: int | None = None
+    rdt: int | None = field(default=None, metadata={"feature": "is_supported_drying"})
+    clean_percent: int | None = field(default=None, metadata={"feature": "is_support_clean_estimate"})
     rss: int | None = None
     dss: int | None = None
     common_status: int | None = None
@@ -389,12 +404,14 @@ def has_am(self) -> bool | None:
         return (self.dss & 3) == 2
 
     @property
+    @field_metadata(dock_feature="is_washable")
     def clear_water_box_status(self) -> ClearWaterBoxStatus | None:
         if self.dss:
             return ClearWaterBoxStatus((self.dss >> 2) & 3)
         return None
 
     @property
+    @field_metadata(dock_feature="is_washable")
     def dirty_water_box_status(self) -> DirtyWaterBoxStatus | None:
         if self.dss:
             return DirtyWaterBoxStatus((self.dss >> 4) & 3)
@@ -413,6 +430,9 @@ def water_box_filter_status(self) -> int | None:
         return None
 
     @property
+    @field_metadata(
+        dock_feature="is_clean_fluid_auto_delivery_supported",
+    )
     def clean_fluid_status(self) -> CleanFluidStatus | None:
         if self.dss:
             value = (self.dss >> 10) & 3

roborock/device_features.py

@@ -674,14 +674,14 @@ def get_supported_features(self) -> list[str]:
 
 _CLEAN_FLUID_AUTO_DELIVERY_DOCK_TYPES = {
     RoborockDockTypeCode.o4_dock,
+    RoborockDockTypeCode.o5_dock,
     RoborockDockTypeCode.pearl_plus_dock,
     RoborockDockTypeCode.shell_3s_dock,
     RoborockDockTypeCode.o6_dock,
     RoborockDockTypeCode.couple_dock,
 }
 
 _CLEAN_FLUID_AUTO_DELIVERY_AM_DOCK_TYPES = {
-    RoborockDockTypeCode.o5_dock,
     RoborockDockTypeCode.shell_2s_dock,
     RoborockDockTypeCode.shell_3_dock,
     RoborockDockTypeCode.shell_2c_dock,
@@ -734,9 +734,11 @@ def get_supported_features(self) -> list[str]:
     RoborockDockTypeCode.shell_2c_dock,
     RoborockDockTypeCode.shell_3s_dock,
     RoborockDockTypeCode.k1_dock,
+    RoborockDockTypeCode.k1s_dock,
     RoborockDockTypeCode.o6_dock,
     RoborockDockTypeCode.shell_e_dock,
     RoborockDockTypeCode.shell_2e_dock,
+    RoborockDockTypeCode.shell_3c_dock,
 }
 
 _HATCH_DOOR_DOCK_COOL_FAN_DOCK_TYPES = {

roborock/devices/traits/v1/__init__.py

@@ -264,6 +264,7 @@ async def discover_features(self) -> None:
         # Dock type also acts like a device feature for some traits.
         dock_type = await self._dock_type()
         dock_features = RoborockDockFeatures.from_dock_type(dock_type, has_am=self.status.has_am)
+        self.device_features.dock_features = dock_features
 
         # Initialize traits with special arguments before the generic loop
         if self.wash_towel_mode is None and self._is_supported(WashTowelModeTrait, "wash_towel_mode", dock_features):

roborock/devices/traits/v1/consumeable.py

@@ -30,8 +30,8 @@ class ConsumableAttribute(StrEnum):
     FILTER_WORK_TIME = "filter_work_time"
     SIDE_BRUSH_WORK_TIME = "side_brush_work_time"
     MAIN_BRUSH_WORK_TIME = "main_brush_work_time"
-    STRAINER_WORK_TIME = "strainer_work_time"
-    CLEANING_BRUSH_WORK_TIME = "cleaning_brush_work_time"
+    STRAINER_WORK_TIME = "strainer_work_times"
+    CLEANING_BRUSH_WORK_TIME = "cleaning_brush_work_times"
 
     @classmethod
     def from_str(cls, value: str) -> Self: