Skip to content

Commit 44ffbe6

Browse files
authored
feat: add Q7 dock state enums (#958)
1 parent cd5347e commit 44ffbe6

4 files changed

Lines changed: 88 additions & 4 deletions

File tree

‎roborock/data/b01_q7/b01_q7_code_mappings.py‎

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
from typing import Self, cast
22

3-
from ..code_mappings import RoborockModeEnum
3+
from ..code_mappings import RoborockEnum, RoborockModeEnum
44

55

66
class WorkStatusMapping(RoborockModeEnum):
@@ -121,6 +121,22 @@ class WorkModeMapping(RoborockModeEnum):
121121
EXPLORE_IDLE = ("explore_idle", 49)
122122

123123

124+
class StationStateMapping(RoborockEnum):
125+
"""Known dock activity states observed on the Q7 M5+."""
126+
127+
unknown = -1
128+
idle = 0
129+
collecting_dust = 3
130+
131+
132+
class DustCollectionStateMapping(RoborockEnum):
133+
"""Known dust collection states observed on the Q7 M5+."""
134+
135+
unknown = -1
136+
idle = 0
137+
collecting_dust = 1
138+
139+
124140
class StationActionMapping(RoborockModeEnum):
125141
"""Maps actions for the cleaning/drying station."""
126142

‎roborock/data/b01_q7/b01_q7_containers.py‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,9 @@
1010
CleanPathPreferenceMapping,
1111
CleanRepeatMapping,
1212
CleanTypeMapping,
13+
DustCollectionStateMapping,
1314
SCWindMapping,
15+
StationStateMapping,
1416
WaterLevelMapping,
1517
WorkModeMapping,
1618
WorkStatusMapping,
@@ -137,11 +139,11 @@ class B01Props(RoborockBase):
137139
custom_type: int | None = None
138140
sound: int | None = None
139141
work_mode: WorkModeMapping | None = None
140-
station_act: int | None = None # dock activity; 3 while collecting dust, 0 idle. hw-confirmed (Q7 M5+)
142+
station_act: StationStateMapping | None = None
141143
charge_state: int | None = None
142144
current_map_id: int | None = None
143145
map_num: int | None = None
144-
dust_action: int | None = None # 1 while the dock is collecting dust; read-only (prop.set rejected, code 1)
146+
dust_action: DustCollectionStateMapping | None = None # Read-only; prop.set is rejected with code 1 on the Q7 M5+.
145147
quiet_is_open: int | None = None
146148
quiet_begin_time: int | None = None
147149
quiet_end_time: int | None = None

‎tests/data/b01_q7/test_b01_q7_containers.py‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,9 @@
1212
CleanRecordDetail,
1313
CleanRecordList,
1414
CleanRepeatMapping,
15+
DustCollectionStateMapping,
1516
SCWindMapping,
17+
StationStateMapping,
1618
WorkStatusMapping,
1719
)
1820
from roborock.data.code_mappings import completed_warnings
@@ -179,6 +181,55 @@ def test_b01props_deserialization_unknown_work_status(caplog: pytest.LogCaptureF
179181
assert "Failed to convert status" not in caplog.text
180182

181183

184+
@pytest.mark.parametrize("station_key,dust_key", [("station_act", "dust_action"), ("stationAct", "dustAction")])
185+
@pytest.mark.parametrize(
186+
("station_code", "dust_code", "expected_station", "expected_dust"),
187+
[
188+
(0, 0, StationStateMapping.idle, DustCollectionStateMapping.idle),
189+
(3, 1, StationStateMapping.collecting_dust, DustCollectionStateMapping.collecting_dust),
190+
],
191+
)
192+
def test_b01props_dock_states(
193+
station_key: str,
194+
dust_key: str,
195+
station_code: int,
196+
dust_code: int,
197+
expected_station: StationStateMapping,
198+
expected_dust: DustCollectionStateMapping,
199+
) -> None:
200+
"""Decode dock states and preserve integer values when serializing them."""
201+
props = B01Props.from_dict({station_key: station_code, dust_key: dust_code})
202+
203+
assert props.station_act is expected_station
204+
assert props.dust_action is expected_dust
205+
serialized = json.loads(json.dumps(props.as_dict()))
206+
assert serialized == {"stationAct": station_code, "dustAction": dust_code}
207+
restored = B01Props.from_dict(serialized)
208+
assert restored.station_act is expected_station
209+
assert restored.dust_action is expected_dust
210+
211+
212+
@pytest.mark.parametrize("station_code,dust_code", [(-1, -1), (1, 2), (999, 999)])
213+
def test_b01props_unknown_dock_states(station_code: int, dust_code: int, caplog: pytest.LogCaptureFixture) -> None:
214+
"""Unknown dock states must not appear idle or discard other properties."""
215+
props = B01Props.from_dict({"station_act": station_code, "dust_action": dust_code, "quantity": 87})
216+
217+
assert props.station_act is StationStateMapping.unknown
218+
assert props.dust_action is DustCollectionStateMapping.unknown
219+
assert props.quantity == 87
220+
assert "Failed to convert" not in caplog.text
221+
222+
223+
@pytest.mark.parametrize("payload", [{}, {"station_act": None, "dust_action": None}])
224+
def test_b01props_missing_dock_states(payload: dict[str, None]) -> None:
225+
"""Missing dock states stay absent rather than becoming idle or unknown."""
226+
props = B01Props.from_dict(payload)
227+
228+
assert props.station_act is None
229+
assert props.dust_action is None
230+
assert props.as_dict() == {}
231+
232+
182233
def test_b01_q7_clean_record_list_parses_detail_fields():
183234
payload = {
184235
"total_time": 34980,

‎tests/devices/traits/b01/q7/test_init.py‎

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,10 @@
55
from roborock.data.b01_q7 import (
66
CleanTaskTypeMapping,
77
CleanTypeMapping,
8+
DustCollectionStateMapping,
89
SCDeviceCleanParam,
910
SCWindMapping,
11+
StationStateMapping,
1012
WaterLevelMapping,
1113
WorkStatusMapping,
1214
)
@@ -23,6 +25,8 @@ async def test_q7_api_query_values(q7_api: Q7PropertiesApi, fake_channel: FakeQ7
2325
"status": 1,
2426
"wind": 2,
2527
"battery": 100,
28+
"station_act": 3,
29+
"dust_action": 1,
2630
}
2731

2832
fake_channel.response_queue.append(response_data)
@@ -31,17 +35,28 @@ async def test_q7_api_query_values(q7_api: Q7PropertiesApi, fake_channel: FakeQ7
3135
[
3236
RoborockB01Props.STATUS,
3337
RoborockB01Props.WIND,
38+
RoborockB01Props.STATION_ACT,
39+
RoborockB01Props.DUST_ACTION,
3440
]
3541
)
3642

3743
assert result is not None
3844
assert result.status == WorkStatusMapping.WAITING_FOR_ORDERS
3945
assert result.wind == SCWindMapping.STANDARD
46+
assert result.station_act is StationStateMapping.collecting_dust
47+
assert result.dust_action is DustCollectionStateMapping.collecting_dust
4048

4149
assert len(fake_channel.published_commands) == 1
4250
command, params = fake_channel.published_commands[0]
4351
assert command == RoborockB01Q7Methods.GET_PROP
44-
assert params == {"property": [RoborockB01Props.STATUS, RoborockB01Props.WIND]}
52+
assert params == {
53+
"property": [
54+
RoborockB01Props.STATUS,
55+
RoborockB01Props.WIND,
56+
RoborockB01Props.STATION_ACT,
57+
RoborockB01Props.DUST_ACTION,
58+
]
59+
}
4560

4661

4762
@pytest.mark.parametrize(

0 commit comments

Comments
 (0)