Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions roborock/data/v1/v1_code_mappings.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -49,13 +50,15 @@ class RoborockFinishReason(RoborockEnum):


class RoborockInCleaning(RoborockEnum):
unknown = -1
complete = 0
global_clean_not_complete = 1
zone_clean_not_complete = 2
segment_clean_not_complete = 3


class RoborockCleanType(RoborockEnum):
unknown = -1
all_zone = 1
draw_zone = 2
select_zone = 3
Expand Down Expand Up @@ -119,6 +122,7 @@ class RoborockDockState(StrEnum):


class RoborockStartType(RoborockEnum):
unknown = -1
button = 1
app = 2
schedule = 3
Expand Down Expand Up @@ -188,6 +192,7 @@ class CleanFluidStatus(RoborockDssCodes):


class RoborockErrorCode(RoborockEnum):
unknown = -1
none = 0
lidar_blocked = 1
bumper_stuck = 2
Expand Down Expand Up @@ -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."""

Expand Down
9 changes: 6 additions & 3 deletions roborock/devices/traits/v1/status.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@
from roborock import (
CleaningMode,
CleanRoutes,
RoborockDockErrorCode,
RoborockDockState,
RoborockErrorCode,
StatusV2,
VacuumModes,
WaterModes,
Expand Down Expand Up @@ -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
Expand Down
6 changes: 0 additions & 6 deletions tests/conformance/test_enum_conformance.py
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
22 changes: 21 additions & 1 deletion tests/data/test_code_mappings.py
Original file line number Diff line number Diff line change
Expand Up @@ -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,
)

Expand Down Expand Up @@ -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"
41 changes: 38 additions & 3 deletions tests/devices/traits/v1/test_status.py
Original file line number Diff line number Diff line change
Expand Up @@ -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()
Expand Down
Loading