Skip to content

Commit 94cfa63

Browse files
committed
fix(v1): decode unrecognized error and status codes as unknown
RoborockErrorCode, RoborockDockErrorCode, RoborockInCleaning, RoborockFinishReason, RoborockCleanType and RoborockStartType had no unknown member, so an unrecognized code fell back to the first member: an unmapped robot or dock error read as none/ok and an unmapped in_cleaning value as complete. These enums now decode such codes as unknown, and StatusTrait.resolve_error() without an explicit code skips an unknown error instead of sending -1.
1 parent 109f433 commit 94cfa63

5 files changed

Lines changed: 73 additions & 13 deletions

File tree

‎roborock/data/v1/v1_code_mappings.py‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55

66

77
class RoborockFinishReason(RoborockEnum):
8+
unknown = -1
89
manual_interrupt = 21 # Cleaning interrupted by user
910
cleanup_interrupted = 24 # Cleanup interrupted
1011
manual_interrupt_2 = 21
@@ -49,13 +50,15 @@ class RoborockFinishReason(RoborockEnum):
4950

5051

5152
class RoborockInCleaning(RoborockEnum):
53+
unknown = -1
5254
complete = 0
5355
global_clean_not_complete = 1
5456
zone_clean_not_complete = 2
5557
segment_clean_not_complete = 3
5658

5759

5860
class RoborockCleanType(RoborockEnum):
61+
unknown = -1
5962
all_zone = 1
6063
draw_zone = 2
6164
select_zone = 3
@@ -119,6 +122,7 @@ class RoborockDockState(StrEnum):
119122

120123

121124
class RoborockStartType(RoborockEnum):
125+
unknown = -1
122126
button = 1
123127
app = 2
124128
schedule = 3
@@ -188,6 +192,7 @@ class CleanFluidStatus(RoborockDssCodes):
188192

189193

190194
class RoborockErrorCode(RoborockEnum):
195+
unknown = -1
191196
none = 0
192197
lidar_blocked = 1
193198
bumper_stuck = 2
@@ -298,6 +303,9 @@ class RoborockMopIntensityV2(RoborockMopIntensityCode):
298303
class RoborockDockErrorCode(RoborockEnum):
299304
"""Describes the error code of the dock."""
300305

306+
unknown = -1
307+
"""Error code not recognized by this library."""
308+
301309
ok = 0
302310
"""No error condition."""
303311

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

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,9 @@
55
from roborock import (
66
CleaningMode,
77
CleanRoutes,
8+
RoborockDockErrorCode,
89
RoborockDockState,
10+
RoborockErrorCode,
911
StatusV2,
1012
VacuumModes,
1113
WaterModes,
@@ -158,12 +160,13 @@ async def resolve_error(self, error_code: int | None = None) -> None:
158160
159161
Without an explicit code this resolves the current dock error if there is one,
160162
otherwise the current robot error. A dock error such as water_empty stays latched
161-
on the device until it is resolved, even after the cause has been fixed.
163+
on the device until it is resolved, even after the cause has been fixed. Error
164+
codes this library does not recognize are not resolved automatically.
162165
"""
163166
if error_code is None:
164-
if self.dock_error_status:
167+
if self.dock_error_status and self.dock_error_status != RoborockDockErrorCode.unknown:
165168
error_code = int(self.dock_error_status)
166-
elif self.error_code:
169+
elif self.error_code and self.error_code != RoborockErrorCode.unknown:
167170
error_code = int(self.error_code)
168171
else:
169172
return

‎tests/conformance/test_enum_conformance.py‎

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -36,20 +36,14 @@
3636
"roborock.data.v1.v1_code_mappings.ClearWaterBoxStatus",
3737
"roborock.data.v1.v1_code_mappings.DirtyWaterBoxStatus",
3838
"roborock.data.v1.v1_code_mappings.DustBagStatus",
39-
"roborock.data.v1.v1_code_mappings.RoborockCleanType",
40-
"roborock.data.v1.v1_code_mappings.RoborockDockErrorCode",
4139
"roborock.data.v1.v1_code_mappings.RoborockDssCodes",
42-
"roborock.data.v1.v1_code_mappings.RoborockErrorCode",
4340
"roborock.data.v1.v1_code_mappings.RoborockFanPowerCode",
4441
"roborock.data.v1.v1_code_mappings.RoborockFanSpeedE2",
4542
"roborock.data.v1.v1_code_mappings.RoborockFanSpeedV1",
4643
"roborock.data.v1.v1_code_mappings.RoborockFanSpeedV2",
4744
"roborock.data.v1.v1_code_mappings.RoborockFanSpeedV3",
48-
"roborock.data.v1.v1_code_mappings.RoborockFinishReason",
49-
"roborock.data.v1.v1_code_mappings.RoborockInCleaning",
5045
"roborock.data.v1.v1_code_mappings.RoborockMopIntensityCode",
5146
"roborock.data.v1.v1_code_mappings.RoborockMopIntensityV2",
52-
"roborock.data.v1.v1_code_mappings.RoborockStartType",
5347
"roborock.data.zeo.zeo_code_mappings.ZeoDetergentExpansionType",
5448
"roborock.data.zeo.zeo_code_mappings.ZeoDetergentType",
5549
"roborock.data.zeo.zeo_code_mappings.ZeoDirtDetectionStatus",

‎tests/data/test_code_mappings.py‎

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,15 @@
88

99
from roborock import CleanRoutes, HomeDataProduct, RoborockCategory
1010
from roborock.data.b01_q10.b01_q10_code_mappings import B01_Q10_DP, YXCleanType
11-
from roborock.data.code_mappings import completed_warnings
11+
from roborock.data.code_mappings import RoborockEnum, completed_warnings
1212
from roborock.data.dyad.dyad_code_mappings import DyadCleanMode, DyadError
1313
from roborock.data.v1.v1_code_mappings import (
14+
RoborockCleanType,
15+
RoborockDockErrorCode,
1416
RoborockErrorCode,
1517
RoborockFinishReason,
18+
RoborockInCleaning,
19+
RoborockStartType,
1620
RoborockStateCode,
1721
)
1822

@@ -193,3 +197,19 @@ def test_dyad_clean_mode_codes(code: int, expected: DyadCleanMode, caplog: pytes
193197
def test_dyad_clean_mode_unknown_code() -> None:
194198
"""An unrecognized Dyad clean mode falls back to 'unknown' instead of 'auto'."""
195199
assert DyadCleanMode(99) == DyadCleanMode.unknown
200+
201+
202+
@pytest.mark.parametrize(
203+
("enum_cls", "code"),
204+
[
205+
(RoborockErrorCode, 57),
206+
(RoborockDockErrorCode, 9),
207+
(RoborockInCleaning, 4),
208+
(RoborockFinishReason, 78),
209+
(RoborockCleanType, 9),
210+
(RoborockStartType, 999),
211+
],
212+
)
213+
def test_v1_enum_unknown_code(enum_cls: type[RoborockEnum], code: int) -> None:
214+
"""An unrecognized V1 code falls back to 'unknown' instead of the first member."""
215+
assert enum_cls(code).name == "unknown"

‎tests/devices/traits/v1/test_status.py‎

Lines changed: 38 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -214,9 +214,44 @@ async def test_resolve_error_defaults_to_robot_error(status_trait: StatusTrait,
214214
]
215215

216216

217-
async def test_resolve_error_no_error(status_trait: StatusTrait, mock_rpc_channel: AsyncMock) -> None:
218-
"""Test that nothing is sent when there is no error to resolve."""
219-
mock_rpc_channel.send_command.return_value = STATUS
217+
async def test_resolve_error_skips_unknown_dock_error(status_trait: StatusTrait, mock_rpc_channel: AsyncMock) -> None:
218+
"""Test that an unrecognized dock error falls through to the robot error."""
219+
mock_rpc_channel.send_command.side_effect = [
220+
{**STATUS, "dock_error_status": 9, "error_code": RoborockErrorCode.bumper_stuck.value},
221+
"ok",
222+
STATUS,
223+
]
224+
await status_trait.refresh()
225+
226+
await status_trait.resolve_error()
227+
228+
assert mock_rpc_channel.send_command.mock_calls[1:] == [
229+
call(RoborockCommand.RESOLVE_ERROR, params={"error_code": RoborockErrorCode.bumper_stuck.value}),
230+
call(RoborockCommand.GET_STATUS),
231+
]
232+
233+
234+
@pytest.mark.parametrize(
235+
("dock_error_status", "error_code"),
236+
[
237+
(RoborockDockErrorCode.ok.value, RoborockErrorCode.none.value),
238+
(9, RoborockErrorCode.none.value),
239+
(RoborockDockErrorCode.ok.value, 57),
240+
],
241+
ids=["no-error", "unknown-dock-error", "unknown-robot-error"],
242+
)
243+
async def test_resolve_error_no_known_error(
244+
status_trait: StatusTrait,
245+
mock_rpc_channel: AsyncMock,
246+
dock_error_status: int,
247+
error_code: int,
248+
) -> None:
249+
"""Test that nothing is sent when there is no known error to resolve."""
250+
mock_rpc_channel.send_command.return_value = {
251+
**STATUS,
252+
"dock_error_status": dock_error_status,
253+
"error_code": error_code,
254+
}
220255
await status_trait.refresh()
221256

222257
await status_trait.resolve_error()

0 commit comments

Comments
 (0)