From 94cfa630ee8066ea08efe132198a8788708c7d68 Mon Sep 17 00:00:00 2001 From: Harry Coureau Date: Sun, 15 Nov 2026 01:34:35 +0000 Subject: [PATCH] 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. --- roborock/data/v1/v1_code_mappings.py | 8 +++++ roborock/devices/traits/v1/status.py | 9 +++-- tests/conformance/test_enum_conformance.py | 6 ---- tests/data/test_code_mappings.py | 22 +++++++++++- tests/devices/traits/v1/test_status.py | 41 ++++++++++++++++++++-- 5 files changed, 73 insertions(+), 13 deletions(-) diff --git a/roborock/data/v1/v1_code_mappings.py b/roborock/data/v1/v1_code_mappings.py index c5d5037f..99bbb78c 100644 --- a/roborock/data/v1/v1_code_mappings.py +++ b/roborock/data/v1/v1_code_mappings.py @@ -5,6 +5,7 @@ class RoborockFinishReason(RoborockEnum): + unknown = -1 manual_interrupt = 21 # Cleaning interrupted by user cleanup_interrupted = 24 # Cleanup interrupted manual_interrupt_2 = 21 @@ -49,6 +50,7 @@ class RoborockFinishReason(RoborockEnum): class RoborockInCleaning(RoborockEnum): + unknown = -1 complete = 0 global_clean_not_complete = 1 zone_clean_not_complete = 2 @@ -56,6 +58,7 @@ class RoborockInCleaning(RoborockEnum): class RoborockCleanType(RoborockEnum): + unknown = -1 all_zone = 1 draw_zone = 2 select_zone = 3 @@ -119,6 +122,7 @@ class RoborockDockState(StrEnum): class RoborockStartType(RoborockEnum): + unknown = -1 button = 1 app = 2 schedule = 3 @@ -188,6 +192,7 @@ class CleanFluidStatus(RoborockDssCodes): class RoborockErrorCode(RoborockEnum): + unknown = -1 none = 0 lidar_blocked = 1 bumper_stuck = 2 @@ -298,6 +303,9 @@ class RoborockMopIntensityV2(RoborockMopIntensityCode): class RoborockDockErrorCode(RoborockEnum): """Describes the error code of the dock.""" + unknown = -1 + """Error code not recognized by this library.""" + ok = 0 """No error condition.""" diff --git a/roborock/devices/traits/v1/status.py b/roborock/devices/traits/v1/status.py index 01eed9a5..1bf0f09c 100644 --- a/roborock/devices/traits/v1/status.py +++ b/roborock/devices/traits/v1/status.py @@ -5,7 +5,9 @@ from roborock import ( CleaningMode, CleanRoutes, + RoborockDockErrorCode, RoborockDockState, + RoborockErrorCode, StatusV2, VacuumModes, WaterModes, @@ -158,12 +160,13 @@ async def resolve_error(self, error_code: int | None = None) -> None: Without an explicit code this resolves the current dock error if there is one, otherwise the current robot error. A dock error such as water_empty stays latched - on the device until it is resolved, even after the cause has been fixed. + on the device until it is resolved, even after the cause has been fixed. Error + codes this library does not recognize are not resolved automatically. """ if error_code is None: - if self.dock_error_status: + if self.dock_error_status and self.dock_error_status != RoborockDockErrorCode.unknown: error_code = int(self.dock_error_status) - elif self.error_code: + elif self.error_code and self.error_code != RoborockErrorCode.unknown: error_code = int(self.error_code) else: return diff --git a/tests/conformance/test_enum_conformance.py b/tests/conformance/test_enum_conformance.py index 37e446ef..90b928b2 100644 --- a/tests/conformance/test_enum_conformance.py +++ b/tests/conformance/test_enum_conformance.py @@ -36,20 +36,14 @@ "roborock.data.v1.v1_code_mappings.ClearWaterBoxStatus", "roborock.data.v1.v1_code_mappings.DirtyWaterBoxStatus", "roborock.data.v1.v1_code_mappings.DustBagStatus", - "roborock.data.v1.v1_code_mappings.RoborockCleanType", - "roborock.data.v1.v1_code_mappings.RoborockDockErrorCode", "roborock.data.v1.v1_code_mappings.RoborockDssCodes", - "roborock.data.v1.v1_code_mappings.RoborockErrorCode", "roborock.data.v1.v1_code_mappings.RoborockFanPowerCode", "roborock.data.v1.v1_code_mappings.RoborockFanSpeedE2", "roborock.data.v1.v1_code_mappings.RoborockFanSpeedV1", "roborock.data.v1.v1_code_mappings.RoborockFanSpeedV2", "roborock.data.v1.v1_code_mappings.RoborockFanSpeedV3", - "roborock.data.v1.v1_code_mappings.RoborockFinishReason", - "roborock.data.v1.v1_code_mappings.RoborockInCleaning", "roborock.data.v1.v1_code_mappings.RoborockMopIntensityCode", "roborock.data.v1.v1_code_mappings.RoborockMopIntensityV2", - "roborock.data.v1.v1_code_mappings.RoborockStartType", "roborock.data.zeo.zeo_code_mappings.ZeoDetergentExpansionType", "roborock.data.zeo.zeo_code_mappings.ZeoDetergentType", "roborock.data.zeo.zeo_code_mappings.ZeoDirtDetectionStatus", diff --git a/tests/data/test_code_mappings.py b/tests/data/test_code_mappings.py index 741046fb..a4c8dbec 100644 --- a/tests/data/test_code_mappings.py +++ b/tests/data/test_code_mappings.py @@ -8,11 +8,15 @@ from roborock import CleanRoutes, HomeDataProduct, RoborockCategory from roborock.data.b01_q10.b01_q10_code_mappings import B01_Q10_DP, YXCleanType -from roborock.data.code_mappings import completed_warnings +from roborock.data.code_mappings import RoborockEnum, completed_warnings from roborock.data.dyad.dyad_code_mappings import DyadCleanMode, DyadError from roborock.data.v1.v1_code_mappings import ( + RoborockCleanType, + RoborockDockErrorCode, RoborockErrorCode, RoborockFinishReason, + RoborockInCleaning, + RoborockStartType, RoborockStateCode, ) @@ -193,3 +197,19 @@ def test_dyad_clean_mode_codes(code: int, expected: DyadCleanMode, caplog: pytes def test_dyad_clean_mode_unknown_code() -> None: """An unrecognized Dyad clean mode falls back to 'unknown' instead of 'auto'.""" assert DyadCleanMode(99) == DyadCleanMode.unknown + + +@pytest.mark.parametrize( + ("enum_cls", "code"), + [ + (RoborockErrorCode, 57), + (RoborockDockErrorCode, 9), + (RoborockInCleaning, 4), + (RoborockFinishReason, 78), + (RoborockCleanType, 9), + (RoborockStartType, 999), + ], +) +def test_v1_enum_unknown_code(enum_cls: type[RoborockEnum], code: int) -> None: + """An unrecognized V1 code falls back to 'unknown' instead of the first member.""" + assert enum_cls(code).name == "unknown" diff --git a/tests/devices/traits/v1/test_status.py b/tests/devices/traits/v1/test_status.py index 72274ca6..a890e8d9 100644 --- a/tests/devices/traits/v1/test_status.py +++ b/tests/devices/traits/v1/test_status.py @@ -214,9 +214,44 @@ async def test_resolve_error_defaults_to_robot_error(status_trait: StatusTrait, ] -async def test_resolve_error_no_error(status_trait: StatusTrait, mock_rpc_channel: AsyncMock) -> None: - """Test that nothing is sent when there is no error to resolve.""" - mock_rpc_channel.send_command.return_value = STATUS +async def test_resolve_error_skips_unknown_dock_error(status_trait: StatusTrait, mock_rpc_channel: AsyncMock) -> None: + """Test that an unrecognized dock error falls through to the robot error.""" + mock_rpc_channel.send_command.side_effect = [ + {**STATUS, "dock_error_status": 9, "error_code": RoborockErrorCode.bumper_stuck.value}, + "ok", + STATUS, + ] + await status_trait.refresh() + + await status_trait.resolve_error() + + assert mock_rpc_channel.send_command.mock_calls[1:] == [ + call(RoborockCommand.RESOLVE_ERROR, params={"error_code": RoborockErrorCode.bumper_stuck.value}), + call(RoborockCommand.GET_STATUS), + ] + + +@pytest.mark.parametrize( + ("dock_error_status", "error_code"), + [ + (RoborockDockErrorCode.ok.value, RoborockErrorCode.none.value), + (9, RoborockErrorCode.none.value), + (RoborockDockErrorCode.ok.value, 57), + ], + ids=["no-error", "unknown-dock-error", "unknown-robot-error"], +) +async def test_resolve_error_no_known_error( + status_trait: StatusTrait, + mock_rpc_channel: AsyncMock, + dock_error_status: int, + error_code: int, +) -> None: + """Test that nothing is sent when there is no known error to resolve.""" + mock_rpc_channel.send_command.return_value = { + **STATUS, + "dock_error_status": dock_error_status, + "error_code": error_code, + } await status_trait.refresh() await status_trait.resolve_error()