Skip to content

Commit 7b311e8

Browse files
committed
feat(v1): add CleanSequenceTrait for the room cleaning order
Reads get_clean_sequence into CleanSequence.rooms and writes it with set_clean_sequence. Gated on is_order_clean_supported (robot feature 123).
1 parent 109f433 commit 7b311e8

4 files changed

Lines changed: 150 additions & 0 deletions

File tree

‎roborock/data/v1/v1_containers.py‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -553,6 +553,16 @@ def clean_then_mop(self) -> bool | None:
553553
return self.seq_type == SEQ_TYPE_CLEAN_THEN_MOP
554554

555555

556+
@dataclass
557+
class CleanSequence(RoborockBase):
558+
"""The order in which the device cleans rooms, as segment ids.
559+
560+
Rooms that are not listed are cleaned after the listed ones.
561+
"""
562+
563+
rooms: list[int] | None = None
564+
565+
556566
@dataclass
557567
class CustomizeCleanModes(RoborockBase):
558568
"""Collection of per-room clean mode overrides."""

‎roborock/devices/traits/v1/__init__.py‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,7 @@
7171
from . import (
7272
camera,
7373
child_lock,
74+
clean_sequence,
7475
clean_summary,
7576
command,
7677
common,
@@ -97,6 +98,7 @@
9798
)
9899
from .camera import CameraTrait
99100
from .child_lock import ChildLockTrait
101+
from .clean_sequence import CleanSequenceTrait
100102
from .clean_summary import CleanSummaryTrait
101103
from .command import CommandTrait
102104
from .common import V1TraitMixin
@@ -127,6 +129,7 @@
127129
"PropertiesApi",
128130
"camera",
129131
"child_lock",
132+
"clean_sequence",
130133
"clean_summary",
131134
"command",
132135
"common",
@@ -187,6 +190,7 @@ class PropertiesApi(Trait):
187190
obstacle_photos: ObstaclePhotoTrait | None = None
188191
mop_dryer: MopDryerTrait | None = None
189192
customize_clean_mode: CustomizeCleanModeTrait | None = None
193+
clean_sequence: CleanSequenceTrait | None = None
190194

191195
def __init__(
192196
self,
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
"""Trait for the room cleaning order of Roborock devices."""
2+
3+
from roborock.data import CleanSequence
4+
from roborock.devices.traits.v1 import common
5+
from roborock.roborock_typing import RoborockCommand
6+
7+
from .common import V1ResponseData
8+
9+
10+
class CleanSequenceConverter(common.V1TraitDataConverter):
11+
"""Converts get_clean_sequence responses to CleanSequence."""
12+
13+
def convert(self, response: V1ResponseData) -> CleanSequence:
14+
"""Parse the list of segment ids returned by the device."""
15+
if not isinstance(response, list) or not all(isinstance(room, int) for room in response):
16+
raise ValueError(f"Unexpected CleanSequence response format: {response!r}")
17+
return CleanSequence(rooms=list(response))
18+
19+
20+
class CleanSequenceTrait(CleanSequence, common.V1TraitMixin):
21+
"""Trait for reading and setting the order in which rooms are cleaned.
22+
23+
The device keeps this order and uses it for room cleaning
24+
(`app_segment_clean`), whatever order the segments are sent in.
25+
"""
26+
27+
command = RoborockCommand.GET_CLEAN_SEQUENCE
28+
converter = CleanSequenceConverter()
29+
requires_feature = "is_order_clean_supported"
30+
31+
async def set_order(self, rooms: list[int]) -> None:
32+
"""Set the room cleaning order.
33+
34+
A device rejects a new order with an invalid status error while it is
35+
cleaning or moving; set it while the device is idle or docked.
36+
"""
37+
if not rooms or len(set(rooms)) != len(rooms):
38+
raise ValueError(f"rooms must be a non-empty list of distinct segment ids: {rooms!r}")
39+
await self.rpc_channel.send_command(RoborockCommand.SET_CLEAN_SEQUENCE, params=list(rooms))
40+
# Optimistic update to avoid an extra refresh
41+
self.rooms = list(rooms)
Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
"""Tests for the CleanSequenceTrait class."""
2+
3+
from unittest.mock import AsyncMock
4+
5+
import pytest
6+
7+
from roborock.data import HomeDataDevice
8+
from roborock.devices.device import RoborockDevice
9+
from roborock.devices.traits.v1.clean_sequence import CleanSequenceTrait
10+
from roborock.exceptions import RoborockParsingException
11+
from roborock.roborock_typing import RoborockCommand
12+
from tests import mock_data
13+
14+
S5E = mock_data.DEVICE_PRODUCT_PAIRS["home_data_device_s5e.json"][0]
15+
16+
17+
@pytest.fixture(name="clean_sequence_trait")
18+
def clean_sequence_trait_fixture(
19+
device: RoborockDevice,
20+
discover_features_fixture: None,
21+
) -> CleanSequenceTrait | None:
22+
"""Return the discovered CleanSequenceTrait from the device."""
23+
assert device.v1_properties
24+
return device.v1_properties.clean_sequence
25+
26+
27+
def test_requires_feature() -> None:
28+
"""The trait is only created on devices that report order cleaning (robot feature 123)."""
29+
assert CleanSequenceTrait.requires_feature == "is_order_clean_supported"
30+
31+
32+
@pytest.mark.parametrize("device_info", [S5E])
33+
async def test_refresh(
34+
clean_sequence_trait: CleanSequenceTrait | None,
35+
mock_rpc_channel: AsyncMock,
36+
device_info: HomeDataDevice,
37+
) -> None:
38+
"""The response is the list of segment ids in cleaning order."""
39+
assert clean_sequence_trait is not None
40+
mock_rpc_channel.send_command.side_effect = [[8, 3, 7, 10, 1, 9]]
41+
42+
await clean_sequence_trait.refresh()
43+
44+
mock_rpc_channel.send_command.assert_called_once_with(RoborockCommand.GET_CLEAN_SEQUENCE)
45+
assert clean_sequence_trait.rooms == [8, 3, 7, 10, 1, 9]
46+
47+
48+
@pytest.mark.parametrize("device_info", [S5E])
49+
@pytest.mark.parametrize("response", [{"unexpected": "shape"}, ["7"], [7, None]])
50+
async def test_refresh_bad_format(
51+
clean_sequence_trait: CleanSequenceTrait | None,
52+
mock_rpc_channel: AsyncMock,
53+
device_info: HomeDataDevice,
54+
response: object,
55+
) -> None:
56+
"""A response that is not a list of segment ids raises a parsing error."""
57+
assert clean_sequence_trait is not None
58+
mock_rpc_channel.send_command.side_effect = [response]
59+
60+
with pytest.raises(RoborockParsingException):
61+
await clean_sequence_trait.refresh()
62+
63+
64+
@pytest.mark.parametrize("device_info", [S5E])
65+
async def test_set_order(
66+
clean_sequence_trait: CleanSequenceTrait | None,
67+
mock_rpc_channel: AsyncMock,
68+
device_info: HomeDataDevice,
69+
) -> None:
70+
"""set_order sends the list as is and updates the trait."""
71+
assert clean_sequence_trait is not None
72+
mock_rpc_channel.send_command.side_effect = [["ok"]]
73+
74+
await clean_sequence_trait.set_order([7, 8, 3, 10, 1, 9])
75+
76+
mock_rpc_channel.send_command.assert_called_once_with(
77+
RoborockCommand.SET_CLEAN_SEQUENCE, params=[7, 8, 3, 10, 1, 9]
78+
)
79+
assert clean_sequence_trait.rooms == [7, 8, 3, 10, 1, 9]
80+
81+
82+
@pytest.mark.parametrize("device_info", [S5E])
83+
@pytest.mark.parametrize("rooms", [[], [7, 7]])
84+
async def test_set_order_rejects_bad_input(
85+
clean_sequence_trait: CleanSequenceTrait | None,
86+
mock_rpc_channel: AsyncMock,
87+
device_info: HomeDataDevice,
88+
rooms: list[int],
89+
) -> None:
90+
"""An empty list or a repeated room is refused before anything is sent."""
91+
assert clean_sequence_trait is not None
92+
93+
with pytest.raises(ValueError):
94+
await clean_sequence_trait.set_order(rooms)
95+
mock_rpc_channel.send_command.assert_not_called()

0 commit comments

Comments
 (0)