Merge branch 'main' into feat/q10-cli-commands

Author: lboue

CHANGELOG.md

@@ -2,6 +2,67 @@
 
 <!-- version list -->
 
+## v4.12.0 (2026-02-02)
+
+### Bug Fixes
+
+- **map**: Removed unnecessary conversion of empty dict to none
+  ([#763](https://github.com/Python-roborock/python-roborock/pull/763),
+  [`5e28569`](https://github.com/Python-roborock/python-roborock/commit/5e285694b329701c019d804540493d856299a138))
+
+### Features
+
+- Add support for hiding walls and rooms in map rendering
+  ([#763](https://github.com/Python-roborock/python-roborock/pull/763),
+  [`5e28569`](https://github.com/Python-roborock/python-roborock/commit/5e285694b329701c019d804540493d856299a138))
+
+- **map**: Add option to hide walls and rooms in map rendering
+  ([#763](https://github.com/Python-roborock/python-roborock/pull/763),
+  [`5e28569`](https://github.com/Python-roborock/python-roborock/commit/5e285694b329701c019d804540493d856299a138))
+
+
+## v4.11.0 (2026-02-02)
+
+### Features
+
+- Add clean route and repeat for q7
+  ([#756](https://github.com/Python-roborock/python-roborock/pull/756),
+  [`35f7910`](https://github.com/Python-roborock/python-roborock/commit/35f7910263dd4e61ffbd0c20e2d88d2f34b4c34c))
+
+
+## v4.10.1 (2026-02-02)
+
+### Bug Fixes
+
+- Fix typo in B01_Q10_DP constant from REQUETDPS to REQUEST_DPS
+  ([#762](https://github.com/Python-roborock/python-roborock/pull/762),
+  [`601a402`](https://github.com/Python-roborock/python-roborock/commit/601a4029fa975f43b6a04bfcd863dc2c8bd8b8ae))
+
+- Fix typos in code mappings for Roborock
+  ([#762](https://github.com/Python-roborock/python-roborock/pull/762),
+  [`601a402`](https://github.com/Python-roborock/python-roborock/commit/601a4029fa975f43b6a04bfcd863dc2c8bd8b8ae))
+
+- Rename FUN_LEVEL to FAN_LEVEL in code mappings
+  ([#762](https://github.com/Python-roborock/python-roborock/pull/762),
+  [`601a402`](https://github.com/Python-roborock/python-roborock/commit/601a4029fa975f43b6a04bfcd863dc2c8bd8b8ae))
+
+- Typos in code mappings for Q10
+  ([#762](https://github.com/Python-roborock/python-roborock/pull/762),
+  [`601a402`](https://github.com/Python-roborock/python-roborock/commit/601a4029fa975f43b6a04bfcd863dc2c8bd8b8ae))
+
+### Chores
+
+- Set typing for from_code_optional to use Self
+  ([#761](https://github.com/Python-roborock/python-roborock/pull/761),
+  [`220ae8b`](https://github.com/Python-roborock/python-roborock/commit/220ae8bfc8b53d2e5070dc6c5211ef9b23df606d))
+
+### Documentation
+
+- Add comments documenting source code typos in B01_Q10_DP mappings
+  ([#762](https://github.com/Python-roborock/python-roborock/pull/762),
+  [`601a402`](https://github.com/Python-roborock/python-roborock/commit/601a4029fa975f43b6a04bfcd863dc2c8bd8b8ae))
+
+
 ## v4.10.0 (2026-02-01)
 
 ### Features

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "python-roborock"
-version = "4.10.0"
+version = "4.12.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/data/b01_q10/b01_q10_code_mappings.py

@@ -34,7 +34,7 @@ class B01_Q10_DP(RoborockModeEnum):
     DUST_SETTING = ("dpDustSetting", 50)
     MAP_SAVE_SWITCH = ("dpMapSaveSwitch", 51)
     CLEAN_RECORD = ("dpCleanRecord", 52)
-    RECEND_CLEAN_RECORD = ("dpRecendCleanRecord", 53)
+    RECENT_CLEAN_RECORD = ("dpRecentCleanRecord", 53)  # NOTE: typo "dpRecendCleanRecord" in source code
     RESTRICTED_ZONE = ("dpRestrictedZone", 54)
     RESTRICTED_ZONE_UP = ("dpRestrictedZoneUp", 55)
     VIRTUAL_WALL = ("dpVirtualWall", 56)
@@ -56,7 +56,7 @@ class B01_Q10_DP(RoborockModeEnum):
     ROOM_MERGE = ("dpRoomMerge", 72)
     ROOM_SPLIT = ("dpRoomSplit", 73)
     RESET_ROOM_NAME = ("dpResetRoomName", 74)
-    REQUSET_NOT_DISTURB_DATA = ("dpRequsetNotDisturbData", 75)
+    REQUEST_NOT_DISTURB_DATA = ("dpRequestNotDisturbData", 75)  # NOTE: typo "dpRequsetNotDisturbData" in source code
     CARPET_CLEAN_TYPE = ("dpCarpetCleanType", 76)
     BUTTON_LIGHT_SWITCH = ("dpButtonLightSwitch", 77)
     CLEAN_LINE = ("dpCleanLine", 78)
@@ -68,7 +68,7 @@ class B01_Q10_DP(RoborockModeEnum):
     LOG_SWITCH = ("dpLogSwitch", 84)
     FLOOR_MATERIAL = ("dpFloorMaterial", 85)
     LINE_LASER_OBSTACLE_AVOIDANCE = ("dpLineLaserObstacleAvoidance", 86)
-    CLEAN_PROGESS = ("dpCleanProgess", 87)
+    CLEAN_PROGRESS = ("dpCleanProgress", 87)  # NOTE: typo "dpCleanProgess" in source code
     GROUND_CLEAN = ("dpGroundClean", 88)
     IGNORE_OBSTACLE = ("dpIgnoreObstacle", 89)
     FAULT = ("dpFault", 90)
@@ -84,7 +84,7 @@ class B01_Q10_DP(RoborockModeEnum):
     SUSPECTED_THRESHOLD_UP = ("dpSuspectedThresholdUp", 100)
     COMMON = ("dpCommon", 101)
     JUMP_SCAN = ("dpJumpScan", 101)
-    REQUETDPS = ("dpRequetdps", 102)  # NOTE: THIS TYPO IS FOUND IN SOURCE CODE
+    REQUEST_DPS = ("dpRequestDps", 102)  # NOTE: typo "dpRequetdps" in source code
     CLIFF_RESTRICTED_AREA = ("dpCliffRestrictedArea", 102)
     CLIFF_RESTRICTED_AREA_UP = ("dpCliffRestrictedAreaUp", 103)
     BREAKPOINT_CLEAN = ("dpBreakpointClean", 104)
@@ -96,7 +96,7 @@ class B01_Q10_DP(RoborockModeEnum):
     HEARTBEAT = ("dpHeartbeat", 110)
     STATUS = ("dpStatus", 121)
     BATTERY = ("dpBattery", 122)
-    FUN_LEVEL = ("dpfunLevel", 123)
+    FAN_LEVEL = ("dpFanLevel", 123)  # NOTE: typo "dpfunLevel" in source code
     WATER_LEVEL = ("dpWaterLevel", 124)
     MAIN_BRUSH_LIFE = ("dpMainBrushLife", 125)
     SIDE_BRUSH_LIFE = ("dpSideBrushLife", 126)
@@ -125,8 +125,7 @@ class YXFanLevel(RoborockModeEnum):
     NORMAL = "normal", 2
     STRONG = "strong", 3
     MAX = "max", 4
-    SUPER = "super", 5
-    CUSTOM = "custom", 8
+    SUPER = "super", 8
 
 
 class YXWaterLevel(RoborockModeEnum):

roborock/data/b01_q7/b01_q7_code_mappings.py

@@ -46,8 +46,15 @@ class CleanTypeMapping(RoborockModeEnum):
 class CleanRepeatMapping(RoborockModeEnum):
     """Maps the cleaning repeat parameter."""
 
-    ONCE = ("once", 0)
-    TWICE = ("twice", 1)
+    ONE = ("one", 0)
+    TWO = ("two", 1)
+
+
+class CleanPathPreferenceMapping(RoborockModeEnum):
+    """Maps the cleaning path preference parameter."""
+
+    BALANCED = ("balanced", 0)
+    DEEP = ("deep", 1)
 
 
 class SCDeviceCleanParam(RoborockModeEnum):

roborock/data/b01_q7/b01_q7_containers.py

@@ -7,6 +7,8 @@
 from ..containers import RoborockBase
 from .b01_q7_code_mappings import (
     B01Fault,
+    CleanPathPreferenceMapping,
+    CleanRepeatMapping,
     CleanTypeMapping,
     SCWindMapping,
     WaterLevelMapping,
@@ -94,10 +96,10 @@ class B01Props(RoborockBase):
     mop_life: int | None = None
     main_sensor: int | None = None
     net_status: NetStatus | None = None
-    repeat_state: int | None = None
+    repeat_state: CleanRepeatMapping | None = None
     tank_state: int | None = None
     sweep_type: int | None = None
-    clean_path_preference: int | None = None
+    clean_path_preference: CleanPathPreferenceMapping | None = None
     cloth_state: int | None = None
     time_zone: int | None = None
     time_zone_info: str | None = None
@@ -210,6 +212,16 @@ def work_mode_name(self) -> str | None:
         """Returns the name of the current work mode."""
         return self.work_mode.value if self.work_mode is not None else None
 
+    @property
+    def repeat_state_name(self) -> str | None:
+        """Returns the name of the current repeat state."""
+        return self.repeat_state.value if self.repeat_state is not None else None
+
+    @property
+    def clean_path_preference_name(self) -> str | None:
+        """Returns the name of the current clean path preference."""
+        return self.clean_path_preference.value if self.clean_path_preference is not None else None
+
 
 @dataclass
 class CleanRecordDetail(RoborockBase):

roborock/devices/traits/b01/q7/__init__.py

@@ -5,6 +5,8 @@
 
 from roborock import B01Props
 from roborock.data.b01_q7.b01_q7_code_mappings import (
+    CleanPathPreferenceMapping,
+    CleanRepeatMapping,
     CleanTaskTypeMapping,
     CleanTypeMapping,
     SCDeviceCleanParam,
@@ -66,6 +68,14 @@ async def set_mode(self, mode: CleanTypeMapping) -> None:
         """Set the cleaning mode (vacuum, mop, or vacuum and mop)."""
         await self.set_prop(RoborockB01Props.MODE, mode.code)
 
+    async def set_clean_path_preference(self, preference: CleanPathPreferenceMapping) -> None:
+        """Set the cleaning path preference (route)."""
+        await self.set_prop(RoborockB01Props.CLEAN_PATH_PREFERENCE, preference.code)
+
+    async def set_repeat_state(self, repeat: CleanRepeatMapping) -> None:
+        """Set the cleaning repeat state (cycles)."""
+        await self.set_prop(RoborockB01Props.REPEAT_STATE, repeat.code)
+
     async def start_clean(self) -> None:
         """Start cleaning."""
         await self.send(

roborock/map/map_parser.py

@@ -51,6 +51,12 @@ class MapParserConfig:
     show_background: bool = True
     """Whether to show the background of the map."""
 
+    show_walls: bool = True
+    """Whether to show the walls of the map."""
+
+    show_rooms: bool = True
+    """Whether to show the rooms of the map."""
+
     map_scale: int = DEFAULT_MAP_SCALE
     """Scale factor for the map."""
 
@@ -94,11 +100,22 @@ def parse(self, map_bytes: bytes) -> ParsedMapData | None:
 
 def _create_map_data_parser(config: MapParserConfig) -> RoborockMapDataParser:
     """Create a RoborockMapDataParser based on the config entry."""
-    colors = ColorsPalette()
+    color_dicts = {}
+    room_colors = {}
+
     if not config.show_background:
-        colors = ColorsPalette({SupportedColor.MAP_OUTSIDE: (0, 0, 0, 0)})
+        color_dicts[SupportedColor.MAP_OUTSIDE] = (0, 0, 0, 0)
+
+    if not config.show_walls:
+        color_dicts[SupportedColor.GREY_WALL] = (0, 0, 0, 0)
+        color_dicts[SupportedColor.MAP_WALL] = (0, 0, 0, 0)
+        color_dicts[SupportedColor.MAP_WALL_V2] = (0, 0, 0, 0)
+
+    if not config.show_rooms:
+        room_colors = {str(x): (0, 0, 0, 0) for x in range(1, 32)}
+
     return RoborockMapDataParser(
-        colors,
+        ColorsPalette(color_dicts, room_colors),
         Sizes({k: v * config.map_scale for k, v in Sizes.SIZES.items() if k != Size.MOP_PATH_WIDTH}),
         config.drawables,
         ImageConfig(scale=config.map_scale),

tests/data/b01_q7/test_b01_q7_containers.py

@@ -5,8 +5,10 @@
 from roborock.data.b01_q7 import (
     B01Fault,
     B01Props,
+    CleanPathPreferenceMapping,
     CleanRecordDetail,
     CleanRecordList,
+    CleanRepeatMapping,
     SCWindMapping,
     WorkStatusMapping,
 )
@@ -106,6 +108,10 @@ def test_b01props_deserialization():
     assert deserialized.wind == SCWindMapping.STRONG
     assert deserialized.net_status is not None
     assert deserialized.net_status.ip == "192.168.1.102"
+    assert deserialized.repeat_state == CleanRepeatMapping.TWO
+    assert deserialized.clean_path_preference == CleanPathPreferenceMapping.DEEP
+    assert deserialized.repeat_state_name == "two"
+    assert deserialized.clean_path_preference_name == "deep"
 
 
 def test_b01_q7_clean_record_list_parses_detail_fields():

tests/e2e/test_device_manager.py

@@ -439,7 +439,7 @@ async def test_q10_device(
     # against the golden byte stream snapshot.
     assert device.b01_q10_properties
     command = device.b01_q10_properties.command
-    await command.send(B01_Q10_DP.REQUETDPS, params={})
+    await command.send(B01_Q10_DP.REQUEST_DPS, params={})
 
     # In the future here we can verify receiving requests from the device
 

tests/protocols/__snapshots__/test_b01_q10_protocol.ambr

@@ -11,7 +11,7 @@
   {
     "dpStatus": 8,
     "dpBattery": 100,
-    "dpfunLevel": 2,
+    "dpFanLevel": 2,
     "dpWaterLevel": 1,
     "dpMainBrushLife": 0,
     "dpSideBrushLife": 0,
@@ -35,7 +35,7 @@
     "dpChildLock": 0,
     "dpDustSetting": 0,
     "dpMapSaveSwitch": true,
-    "dpRecendCleanRecord": false,
+    "dpRecentCleanRecord": false,
     "dpCleanTime": 0,
     "dpMultiMapSwitch": 1,
     "dpSensorLife": 0,
@@ -55,7 +55,7 @@
     },
     "dpRobotType": 1,
     "dpLineLaserObstacleAvoidance": 1,
-    "dpCleanProgess": 100,
+    "dpCleanProgress": 100,
     "dpGroundClean": 0,
     "dpFault": 0,
     "dpNotDisturbExpand": {
@@ -77,10 +77,10 @@
   }
   '''
 # ---
-# name: test_encode_mqtt_payload[dpRequetdps-None]
+# name: test_encode_mqtt_payload[dpRequestDps-None]
   b'{"dps": {"102": {}}}'
 # ---
-# name: test_encode_mqtt_payload[dpRequetdps-params0]
+# name: test_encode_mqtt_payload[dpRequestDps-params0]
   b'{"dps": {"102": {}}}'
 # ---
 # name: test_encode_mqtt_payload[dpStartClean-params2]