Merge branch 'main' into leo/q7-map-content-followup

Author: arduano

CHANGELOG.md

@@ -2,6 +2,104 @@
 
 <!-- version list -->
 
+## v5.0.0 (2026-03-22)
+
+### Bug Fixes
+
+- **cli**: Make clean mode option case insensitive
+  ([#794](https://github.com/Python-roborock/python-roborock/pull/794),
+  [`7baeb65`](https://github.com/Python-roborock/python-roborock/commit/7baeb658fd80b40bfb631dc250b899e659e20210))
+
+- **q10**: Restrict clean mode cli choices
+  ([#794](https://github.com/Python-roborock/python-roborock/pull/794),
+  [`7baeb65`](https://github.com/Python-roborock/python-roborock/commit/7baeb658fd80b40bfb631dc250b899e659e20210))
+
+### Features
+
+- **api**: Again rename `YXDeviceState` enum members to have consistency with V1 state values
+  ([#795](https://github.com/Python-roborock/python-roborock/pull/795),
+  [`ad3ceea`](https://github.com/Python-roborock/python-roborock/commit/ad3ceeaea6f1b12dc51513c48476bcdf2756392b))
+
+- **api**: Rename `YXWaterLevel` enum values to mirror v1 values
+  ([#796](https://github.com/Python-roborock/python-roborock/pull/796),
+  [`c630022`](https://github.com/Python-roborock/python-roborock/commit/c63002264e40beb0f6e51281afd90e10e7b731cc))
+
+### Refactoring
+
+- **q10**: Use readable YXCleanType values with legacy aliases
+  ([#794](https://github.com/Python-roborock/python-roborock/pull/794),
+  [`7baeb65`](https://github.com/Python-roborock/python-roborock/commit/7baeb658fd80b40bfb631dc250b899e659e20210))
+
+- **YXCleanType**: Move legacy values to a separate dictionary and update from_value method
+  ([#794](https://github.com/Python-roborock/python-roborock/pull/794),
+  [`7baeb65`](https://github.com/Python-roborock/python-roborock/commit/7baeb658fd80b40bfb631dc250b899e659e20210))
+
+- **YXCleanType**: Remove legacy test for readable public values
+  ([#794](https://github.com/Python-roborock/python-roborock/pull/794),
+  [`7baeb65`](https://github.com/Python-roborock/python-roborock/commit/7baeb658fd80b40bfb631dc250b899e659e20210))
+
+- **YXCleanType**: Simplify clean type definitions and remove legacy alias support
+  ([#794](https://github.com/Python-roborock/python-roborock/pull/794),
+  [`7baeb65`](https://github.com/Python-roborock/python-roborock/commit/7baeb658fd80b40bfb631dc250b899e659e20210))
+
+
+## v4.26.3 (2026-03-22)
+
+### Bug Fixes
+
+- **q10**: Add tests for Q10 status values and code mappings
+  ([#793](https://github.com/Python-roborock/python-roborock/pull/793),
+  [`dce00a2`](https://github.com/Python-roborock/python-roborock/commit/dce00a2499c3976f1cd25239bc4f81d996d51a79))
+
+- **q10**: Normalize status names to canonical values
+  ([#793](https://github.com/Python-roborock/python-roborock/pull/793),
+  [`dce00a2`](https://github.com/Python-roborock/python-roborock/commit/dce00a2499c3976f1cd25239bc4f81d996d51a79))
+
+- **q10**: Normalize YXDeviceState status names to canonical values
+  ([#793](https://github.com/Python-roborock/python-roborock/pull/793),
+  [`dce00a2`](https://github.com/Python-roborock/python-roborock/commit/dce00a2499c3976f1cd25239bc4f81d996d51a79))
+
+- **q10**: Refactor test for canonical status names using a dictionary
+  ([#793](https://github.com/Python-roborock/python-roborock/pull/793),
+  [`dce00a2`](https://github.com/Python-roborock/python-roborock/commit/dce00a2499c3976f1cd25239bc4f81d996d51a79))
+
+
+## v4.26.2 (2026-03-21)
+
+### Bug Fixes
+
+- **q10**: Add missing fault field to Q10Status
+  ([#792](https://github.com/Python-roborock/python-roborock/pull/792),
+  [`66d76fc`](https://github.com/Python-roborock/python-roborock/commit/66d76fc9b3cd6d6d15f5883bfa8a22c688d9b960))
+
+
+## v4.26.1 (2026-03-21)
+
+### Bug Fixes
+
+- Add missing DPS fields to Q10Status and fix CLEAN_PROGRESS mapping
+  ([#791](https://github.com/Python-roborock/python-roborock/pull/791),
+  [`526da01`](https://github.com/Python-roborock/python-roborock/commit/526da01d02f6b52cab3674145273448eb602620e))
+
+- Correct comment for fan level in test_status_trait_refresh
+  ([#791](https://github.com/Python-roborock/python-roborock/pull/791),
+  [`526da01`](https://github.com/Python-roborock/python-roborock/commit/526da01d02f6b52cab3674145273448eb602620e))
+
+### Chores
+
+- Disable commitlint rules for header max length and header full stop.
+  ([#789](https://github.com/Python-roborock/python-roborock/pull/789),
+  [`711f49e`](https://github.com/Python-roborock/python-roborock/commit/711f49e9a6e4d7fc964b164c7f23265979aa166b))
+
+- Increase commit header maximum length to 200
+  ([#789](https://github.com/Python-roborock/python-roborock/pull/789),
+  [`711f49e`](https://github.com/Python-roborock/python-roborock/commit/711f49e9a6e4d7fc964b164c7f23265979aa166b))
+
+- Increase commit header maximum length to 200 in commitlint configuration.
+  ([#789](https://github.com/Python-roborock/python-roborock/pull/789),
+  [`711f49e`](https://github.com/Python-roborock/python-roborock/commit/711f49e9a6e4d7fc964b164c7f23265979aa166b))
+
+
 ## v4.26.0 (2026-03-19)
 
 ### Features

commitlint.config.mjs

@@ -8,7 +8,11 @@ export default {
         // Disable the rule that enforces lowercase in subject
         "subject-case": [0], // 0 = disable, 1 = warn, 2 = error
         // Disable the rule that enforces a maximum line length in the body
-        "body-max-line-length": [0, "always"]
+        "body-max-line-length": [0, "always"],
+        // Disable header max length for AI-generated commits
+        "header-max-length": [0],
+        // Disable the rule that prevents periods at the end of subjects
+        "header-full-stop": [0]
     },
 
 };

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "python-roborock"
-version = "4.26.0"
+version = "5.0.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"

roborock/broadcast_protocol.py

@@ -1,5 +1,3 @@
-from __future__ import annotations
-
 import asyncio
 import hashlib
 import json

roborock/cli.py

@@ -1275,7 +1275,12 @@ async def q10_empty_dustbin(ctx: click.Context, device_id: str) -> None:
 
 @session.command()
 @click.option("--device_id", required=True, help="Device ID")
-@click.option("--mode", required=True, type=click.Choice(["bothwork", "onlysweep", "onlymop"]), help="Clean mode")
+@click.option(
+    "--mode",
+    required=True,
+    type=click.Choice(["vac_and_mop", "vacuum", "mop"], case_sensitive=False),
+    help='Clean mode (preferred: "vac_and_mop", "vacuum", "mop")',
+)
 @click.pass_context
 @async_command
 async def q10_set_clean_mode(ctx: click.Context, device_id: str, mode: str) -> None:

roborock/data/b01_q10/b01_q10_code_mappings.py

@@ -136,9 +136,9 @@ class YXFanLevel(RoborockModeEnum):
 
 class YXWaterLevel(RoborockModeEnum):
     UNKNOWN = "unknown", -1
-    CLOSE = "close", 0
+    OFF = "off", 0  # close
     LOW = "low", 1
-    MIDDLE = "middle", 2
+    MEDIUM = "medium", 2  # middle
     HIGH = "high", 3
 
 
@@ -157,31 +157,31 @@ class YXRoomMaterial(RoborockModeEnum):
 
 class YXCleanType(RoborockModeEnum):
     UNKNOWN = "unknown", -1
-    BOTH_WORK = "bothwork", 1
-    ONLY_SWEEP = "onlysweep", 2
-    ONLY_MOP = "onlymop", 3
+    VAC_AND_MOP = "vac_and_mop", 1  # bothwork
+    VACUUM = "vacuum", 2  # onlysweep
+    MOP = "mop", 3  # onlymop
 
 
 class YXDeviceState(RoborockModeEnum):
     UNKNOWN = "unknown", -1
-    SLEEP_STATE = "sleepstate", 2
-    STANDBY_STATE = "standbystate", 3
-    CLEANING_STATE = "cleaningstate", 5
-    TO_CHARGE_STATE = "tochargestate", 6
-    REMOTEING_STATE = "remoteingstate", 7
-    CHARGING_STATE = "chargingstate", 8
-    PAUSE_STATE = "pausestate", 10
-    FAULT_STATE = "faultstate", 12
-    UPGRADE_STATE = "upgradestate", 14
-    DUSTING = "dusting", 22
-    CREATING_MAP_STATE = "creatingmapstate", 29
-    MAP_SAVE_STATE = "mapsavestate", 99
-    RE_LOCATION_STATE = "relocationstate", 101
-    ROBOT_SWEEPING = "robotsweeping", 102
-    ROBOT_MOPING = "robotmoping", 103
-    ROBOT_SWEEP_AND_MOPING = "robotsweepandmoping", 104
-    ROBOT_TRANSITIONING = "robottransitioning", 105
-    ROBOT_WAIT_CHARGE = "robotwaitcharge", 108
+    SLEEPING = "sleeping", 2  # sleepstate
+    IDLE = "idle", 3  # standbystate
+    CLEANING = "cleaning", 5  # cleaningstate
+    RETURNING_HOME = "returning_home", 6  # tochargestate
+    REMOTE_CONTROL_ACTIVE = "remote_control_active", 7  # remoteingstate
+    CHARGING = "charging", 8  # chargingstate
+    PAUSED = "paused", 10  # pausestate
+    ERROR = "error", 12  # faultstate
+    UPDATING = "updating", 14  # upgradestate
+    EMPTYING_THE_BIN = "emptying_the_bin", 22  # dusting
+    MAPPING = "mapping", 29  # creatingmapstate
+    SAVING_MAP = "saving_map", 99  # mapsavestate
+    RELOCATING = "relocating", 101  # relocationstate
+    SWEEPING = "sweeping", 102  # robotsweeping
+    MOPPING = "mopping", 103  # robotmoping
+    SWEEP_AND_MOP = "sweep_and_mop", 104  # robotsweepandmoping
+    TRANSITIONING = "transitioning", 105  # robottransitioning
+    WAITING_TO_CHARGE = "waiting_to_charge", 108  # robotwaitcharge
 
 
 class YXBackType(RoborockModeEnum):

roborock/data/b01_q10/b01_q10_containers.py

@@ -96,7 +96,15 @@ class Q10Status(RoborockBase):
     fan_level: YXFanLevel | None = field(default=None, metadata={"dps": B01_Q10_DP.FAN_LEVEL})
     water_level: YXWaterLevel | None = field(default=None, metadata={"dps": B01_Q10_DP.WATER_LEVEL})
     clean_count: int | None = field(default=None, metadata={"dps": B01_Q10_DP.CLEAN_COUNT})
+    total_clean_area: int | None = field(default=None, metadata={"dps": B01_Q10_DP.TOTAL_CLEAN_AREA})
+    total_clean_count: int | None = field(default=None, metadata={"dps": B01_Q10_DP.TOTAL_CLEAN_COUNT})
+    total_clean_time: int | None = field(default=None, metadata={"dps": B01_Q10_DP.TOTAL_CLEAN_TIME})
+    main_brush_life: int | None = field(default=None, metadata={"dps": B01_Q10_DP.MAIN_BRUSH_LIFE})
+    side_brush_life: int | None = field(default=None, metadata={"dps": B01_Q10_DP.SIDE_BRUSH_LIFE})
+    filter_life: int | None = field(default=None, metadata={"dps": B01_Q10_DP.FILTER_LIFE})
+    sensor_life: int | None = field(default=None, metadata={"dps": B01_Q10_DP.SENSOR_LIFE})
     clean_mode: YXDeviceWorkMode | None = field(default=None, metadata={"dps": B01_Q10_DP.CLEAN_MODE})
     clean_task_type: YXDeviceCleanTask | None = field(default=None, metadata={"dps": B01_Q10_DP.CLEAN_TASK_TYPE})
     back_type: YXBackType | None = field(default=None, metadata={"dps": B01_Q10_DP.BACK_TYPE})
-    cleaning_progress: int | None = field(default=None, metadata={"dps": B01_Q10_DP.CLEANING_PROGRESS})
+    cleaning_progress: int | None = field(default=None, metadata={"dps": B01_Q10_DP.CLEAN_PROGRESS})
+    fault: int | None = field(default=None, metadata={"dps": B01_Q10_DP.FAULT})

roborock/data/code_mappings.py

@@ -1,5 +1,3 @@
-from __future__ import annotations
-
 import logging
 from collections import namedtuple
 from enum import Enum, IntEnum, StrEnum
@@ -17,7 +15,7 @@ def name(self) -> str:
         return super().name.lower()
 
     @classmethod
-    def _missing_(cls: type[RoborockEnum], key) -> RoborockEnum:
+    def _missing_(cls: type[Self], key) -> Self:
         if hasattr(cls, "unknown"):
             warning = f"Missing {cls.__name__} code: {key} - defaulting to 'unknown'"
             if warning not in completed_warnings:
@@ -32,23 +30,23 @@ def _missing_(cls: type[RoborockEnum], key) -> RoborockEnum:
         return default_value
 
     @classmethod
-    def as_dict(cls: type[RoborockEnum]):
+    def as_dict(cls: type[Self]):
         return {i.name: i.value for i in cls if i.name != "missing"}
 
     @classmethod
-    def as_enum_dict(cls: type[RoborockEnum]):
+    def as_enum_dict(cls: type[Self]):
         return {i.value: i for i in cls if i.name != "missing"}
 
     @classmethod
-    def values(cls: type[RoborockEnum]) -> list[int]:
+    def values(cls: type[Self]) -> list[int]:
         return list(cls.as_dict().values())
 
     @classmethod
-    def keys(cls: type[RoborockEnum]) -> list[str]:
+    def keys(cls: type[Self]) -> list[str]:
         return list(cls.as_dict().keys())
 
     @classmethod
-    def items(cls: type[RoborockEnum]):
+    def items(cls: type[Self]):
         return cls.as_dict().items()
 
 

roborock/data/v1/v1_code_mappings.py

@@ -1,3 +1,5 @@
+from typing import Self
+
 from ..code_mappings import RoborockEnum
 
 
@@ -91,7 +93,7 @@ class RoborockStartType(RoborockEnum):
 
 class RoborockDssCodes(RoborockEnum):
     @classmethod
-    def _missing_(cls: type[RoborockEnum], key) -> RoborockEnum:
+    def _missing_(cls: type[Self], key) -> Self:
         # If the calculated value is not provided, then it should be viewed as okay.
         # As the math will sometimes result in you getting numbers that don't matter.
         return cls.okay  # type: ignore

roborock/device_features.py

@@ -1,8 +1,6 @@
-from __future__ import annotations
-
 from dataclasses import dataclass, field, fields
 from enum import IntEnum, StrEnum
-from typing import Any
+from typing import Any, Self
 
 from roborock.data.code_mappings import RoborockProductNickname
 from roborock.data.containers import RoborockBase
@@ -566,7 +564,7 @@ def from_feature_flags(
         new_feature_info_str: str,
         feature_info: list[int],
         product_nickname: RoborockProductNickname | None,
-    ) -> DeviceFeatures:
+    ) -> Self:
         """Creates a DeviceFeatures instance from raw feature flags.
         :param new_feature_info: A int from get_init_status (sometimes can be found in homedata, but it is not always)
         :param new_feature_info_str: A hex string from get_init_status or home_data.