Skip to content

Commit 0594819

Browse files
author
Harry Coureau
committed
feat: add Q10 customized cleaning controls
1 parent 8e471dc commit 0594819

11 files changed

Lines changed: 687 additions & 7 deletions

File tree

‎roborock/data/b01_q10/b01_q10_code_mappings.py‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -152,6 +152,7 @@ class YXWaterLevel(RoborockModeEnum):
152152

153153

154154
class YXCleanLine(RoborockModeEnum):
155+
UNKNOWN = "unknown", -1
155156
FAST = "fast", 0
156157
DAILY = "daily", 1
157158
FINE = "fine", 2
@@ -354,3 +355,32 @@ class RemoteCommand(IntEnum):
354355
RIGHT = 3
355356
STOP = 4
356357
EXIT = 5
358+
359+
360+
class Q10RoomFanLevel(RoborockModeEnum):
361+
"""Suction levels used inside a Q10 customized-room payload."""
362+
363+
UNKNOWN = "unknown", -1
364+
QUIET = "quiet", 1
365+
BALANCED = "balanced", 2
366+
TURBO = "turbo", 3
367+
MAX = "max", 4
368+
MAX_PLUS = "max_plus", 5
369+
370+
371+
class Q10CleanCount(RoborockModeEnum):
372+
"""Number of passes for a Q10 cleaning task."""
373+
374+
UNKNOWN = "unknown", -1
375+
ONCE = "once", 1
376+
TWICE = "twice", 2
377+
THREE_TIMES = "three_times", 3
378+
379+
380+
class Q10RoomCleanType(RoborockModeEnum):
381+
"""Work performed in one Q10 customized-room setting."""
382+
383+
UNKNOWN = "unknown", -1
384+
VAC_AND_MOP = "vac_and_mop", 1
385+
VACUUM = "vacuum", 2
386+
MOP = "mop", 3

‎roborock/data/b01_q10/b01_q10_containers.py‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@
1212
from ..containers import RoborockBase
1313
from .b01_q10_code_mappings import (
1414
B01_Q10_DP,
15+
Q10CleanCount,
16+
Q10RoomCleanType,
17+
Q10RoomFanLevel,
1518
YXAreaUnit,
1619
YXBackType,
1720
YXCarpetCleanType,
@@ -286,6 +289,11 @@ def fault_name(self) -> str | None:
286289
"""Returns the name of the current fault."""
287290
return self.fault.value if self.fault is not None else None
288291

292+
@property
293+
def clean_count_mode(self) -> Q10CleanCount | None:
294+
"""Return the typed cleaning pass count from the reported status."""
295+
return Q10CleanCount.from_code_optional(self.clean_count) if self.clean_count is not None else None
296+
289297

290298
@dataclass
291299
class SoundVolume(RoborockBase):
@@ -342,3 +350,15 @@ class Q10NetworkInfo(RoborockBase):
342350
"""
343351

344352
net_info: dpNetInfo | None = field(default=None, metadata={"dps": B01_Q10_DP.NET_INFO})
353+
354+
355+
@dataclass
356+
class Q10RoomCleanSettings(RoborockBase):
357+
"""Writable cleaning settings for one Q10 room."""
358+
359+
room_id: int
360+
fan_level: Q10RoomFanLevel
361+
water_level: YXWaterLevel
362+
clean_type: Q10RoomCleanType
363+
clean_count: Q10CleanCount
364+
clean_line: YXCleanLine

‎roborock/devices/traits/b01/q10/__init__.py‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222
from .maps import MapsTrait
2323
from .network_info import NetworkInfoTrait
2424
from .remote import RemoteTrait
25+
from .room_cleaning import RoomCleaningTrait
2526
from .status import StatusTrait
2627
from .vacuum import VacuumTrait
2728
from .volume import SoundVolumeTrait
@@ -37,6 +38,7 @@
3738
"MapContentTrait",
3839
"MapsTrait",
3940
"NetworkInfoTrait",
41+
"RoomCleaningTrait",
4042
"SoundVolumeTrait",
4143
"StatusTrait",
4244
]
@@ -83,6 +85,9 @@ class Q10PropertiesApi(Trait):
8385
map: MapContentTrait
8486
"""Composed map image plus caller-facing map and trace data."""
8587

88+
room_cleaning: RoomCleaningTrait
89+
"""Customized cleaning settings and room-cleaning controls."""
90+
8691
maps: MapsTrait
8792
"""Saved-map list metadata."""
8893

@@ -108,7 +113,8 @@ def __init__(self, channel: B01Q10Channel) -> None:
108113
self._map_dps = MapDpsTrait()
109114
self.maps = MapsTrait(self.command)
110115
self.map = MapContentTrait(self._map_dps, self.maps, self.command)
111-
self.vacuum = VacuumTrait(self.command, self.status, self.map)
116+
self.room_cleaning = RoomCleaningTrait(self.command)
117+
self.vacuum = VacuumTrait(self.command, self.status, self.map, self.room_cleaning)
112118
self.clean_history = CleanHistoryTrait(self.command)
113119
# Read-model traits updated from the device's DPS push stream.
114120
self._updatable_traits = [
@@ -122,6 +128,7 @@ def __init__(self, channel: B01Q10Channel) -> None:
122128
self.clean_history,
123129
self._map_dps,
124130
self.maps,
131+
self.room_cleaning,
125132
]
126133
self._subscribe_task: asyncio.Task[None] | None = None
127134

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
"""Customized room-cleaning controls for Q10 devices."""
2+
3+
import logging
4+
from collections.abc import Sequence
5+
from dataclasses import dataclass
6+
from typing import Any
7+
8+
from roborock.data.b01_q10.b01_q10_code_mappings import B01_Q10_DP, YXCleanType, YXDeviceCleanTask
9+
from roborock.data.b01_q10.b01_q10_containers import Q10RoomCleanSettings
10+
from roborock.data.containers import RoborockBase
11+
from roborock.exceptions import RoborockException
12+
from roborock.protocols.b01_q10_protocol import decode_room_clean_settings, encode_room_clean_settings
13+
14+
from .command import CommandTrait
15+
from .common import UpdatableTrait
16+
17+
_LOGGER = logging.getLogger(__name__)
18+
19+
20+
@dataclass
21+
class RoomCleaning(RoborockBase):
22+
"""Current customized room-cleaning state."""
23+
24+
settings: tuple[Q10RoomCleanSettings, ...] = ()
25+
settings_available: bool = False
26+
27+
28+
class RoomCleaningTrait(RoomCleaning, UpdatableTrait):
29+
"""Read and control Q10 per-room cleaning settings."""
30+
31+
def __init__(self, command: CommandTrait) -> None:
32+
RoomCleaning.__init__(self)
33+
UpdatableTrait.__init__(self, command, _LOGGER)
34+
self._command: CommandTrait = command
35+
36+
def settings_for_room(self, room_id: int) -> Q10RoomCleanSettings | None:
37+
"""Return the latest reported settings for one room."""
38+
return next((room for room in self.settings if room.room_id == room_id), None)
39+
40+
async def refresh(self) -> None:
41+
"""Request the complete customized-room settings."""
42+
await self._command.send(B01_Q10_DP.COMMON, {str(B01_Q10_DP.CUSTOMER_CLEAN_REQUEST.code): 0})
43+
44+
async def set_settings(self, settings: Sequence[Q10RoomCleanSettings]) -> None:
45+
"""Publish customized settings, then request a complete settings push."""
46+
payload = encode_room_clean_settings(settings)
47+
await self._command.send(B01_Q10_DP.COMMON, {str(B01_Q10_DP.CUSTOMER_CLEAN.code): payload})
48+
await self.refresh()
49+
50+
async def clean(self, settings: Sequence[Q10RoomCleanSettings]) -> None:
51+
"""Publish settings, select customized mode, and start the selected rooms."""
52+
selected = tuple(settings)
53+
payload = encode_room_clean_settings(selected)
54+
await self._command.send(B01_Q10_DP.COMMON, {str(B01_Q10_DP.CUSTOMER_CLEAN.code): payload})
55+
await self._command.send(B01_Q10_DP.CLEAN_MODE, YXCleanType.CUSTOMIZED.code)
56+
await self._command.send(
57+
B01_Q10_DP.START_CLEAN,
58+
{"cmd": YXDeviceCleanTask.ELECTORAL.code, "clean_paramters": [room.room_id for room in selected]},
59+
)
60+
61+
def update_from_dps(self, decoded_dps: dict[B01_Q10_DP, Any]) -> None:
62+
"""Replace full settings or upsert the rooms in a compact push."""
63+
payload = decoded_dps.get(B01_Q10_DP.CUSTOMER_CLEAN)
64+
if not isinstance(payload, str):
65+
return
66+
try:
67+
update = decode_room_clean_settings(payload)
68+
except RoborockException:
69+
_LOGGER.debug("Ignoring malformed Q10 customized-room settings", exc_info=True)
70+
return
71+
if update.complete:
72+
settings = update.settings
73+
else:
74+
by_room = {room.room_id: room for room in self.settings}
75+
by_room.update((room.room_id, room) for room in update.settings)
76+
settings = tuple(by_room.values())
77+
changed = settings != self.settings or not self.settings_available
78+
self.settings = settings
79+
self.settings_available = True
80+
if changed:
81+
self._notify_update()

‎roborock/devices/traits/b01/q10/vacuum.py‎

Lines changed: 35 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,26 @@
22

33
import asyncio
44
import logging
5-
from collections.abc import Callable
5+
from collections.abc import Callable, Sequence
66
from math import hypot
77

88
from roborock.data.b01_q10.b01_q10_code_mappings import (
99
B01_Q10_DP,
10+
Q10CleanCount,
11+
YXCleanLine,
1012
YXCleanType,
1113
YXDeviceCleanTask,
1214
YXFanLevel,
15+
YXWaterLevel,
1316
)
14-
from roborock.data.b01_q10.b01_q10_containers import Q10RoborockPoint
17+
from roborock.data.b01_q10.b01_q10_containers import Q10RoborockPoint, Q10RoomCleanSettings
1518
from roborock.exceptions import RoborockException
1619
from roborock.protocols.b01_q10_protocol import CleanParams, encode_clean_params
1720

1821
from .command import CommandTrait
1922
from .goto import GotoAction, GotoActionCommand, GotoSnapshot
2023
from .map import MapContentTrait
24+
from .room_cleaning import RoomCleaningTrait
2125
from .status import StatusTrait
2226

2327
_GOTO_HALF_ZONE_SIZE = 200
@@ -40,11 +44,13 @@ def __init__(
4044
command: CommandTrait,
4145
status: StatusTrait,
4246
map_content: MapContentTrait,
47+
room_cleaning: RoomCleaningTrait,
4348
) -> None:
4449
"""Initialize the VacuumTrait."""
4550
self._command = command
4651
self._status = status
4752
self._map = map_content
53+
self._room_cleaning = room_cleaning
4854
self._goto_action: GotoAction | None = None
4955
self._goto_action_remove_listener: Callable[[], None] | None = None
5056
self._goto_timeout_task: asyncio.Task[None] | None = None
@@ -167,6 +173,11 @@ async def clean_segments(self, segment_ids: list[int]) -> None:
167173
)
168174
self.cancel_goto()
169175

176+
async def clean_rooms(self, settings: Sequence[Q10RoomCleanSettings]) -> None:
177+
"""Start a customized clean for the supplied rooms."""
178+
await self._room_cleaning.clean(settings)
179+
self.cancel_goto()
180+
170181
async def clean_zone(
171182
self,
172183
first_corner: Q10RoborockPoint,
@@ -278,14 +289,36 @@ async def empty_dustbin(self) -> None:
278289

279290
async def set_clean_mode(self, mode: YXCleanType) -> None:
280291
"""Set the cleaning mode (vacuum, mop, or both)."""
292+
if mode is YXCleanType.UNKNOWN:
293+
raise ValueError("mode must be a supported YXCleanType")
281294
await self._command.send(
282295
command=B01_Q10_DP.CLEAN_MODE,
283296
params=mode.code,
284297
)
285298

286299
async def set_fan_level(self, level: YXFanLevel) -> None:
287300
"""Set the fan suction level."""
301+
if level is YXFanLevel.UNKNOWN:
302+
raise ValueError("level must be a supported YXFanLevel")
288303
await self._command.send(
289304
command=B01_Q10_DP.FAN_LEVEL,
290305
params=level.code,
291306
)
307+
308+
async def set_water_level(self, level: YXWaterLevel) -> None:
309+
"""Set the mop water level."""
310+
if level is YXWaterLevel.UNKNOWN:
311+
raise ValueError("level must be a supported YXWaterLevel")
312+
await self._command.send(B01_Q10_DP.WATER_LEVEL, level.code)
313+
314+
async def set_clean_count(self, count: Q10CleanCount) -> None:
315+
"""Set the number of passes for ordinary cleaning."""
316+
if count is Q10CleanCount.UNKNOWN:
317+
raise ValueError("count must be a supported Q10CleanCount")
318+
await self._command.send(B01_Q10_DP.CLEAN_COUNT, count.code)
319+
320+
async def set_clean_line(self, line: YXCleanLine) -> None:
321+
"""Set the cleaning route preference."""
322+
if line is YXCleanLine.UNKNOWN:
323+
raise ValueError("line must be a supported YXCleanLine")
324+
await self._command.send(B01_Q10_DP.COMMON, {str(B01_Q10_DP.CLEAN_LINE.code): line.code})

0 commit comments

Comments
 (0)