chore: make v1_protocol responsible for parsing api error code

Author: Lash-L

roborock/devices/traits/v1/common.py

@@ -9,7 +9,6 @@
 from typing import ClassVar, Self
 
 from roborock.data import RoborockBase
-from roborock.exceptions import RoborockException
 from roborock.protocols.v1_protocol import V1RpcChannel
 from roborock.roborock_typing import RoborockCommand
 
@@ -18,20 +17,6 @@
 V1ResponseData = dict | list | int | str
 
 
-def extract_v1_api_error_code(err: RoborockException) -> int | None:
-    """Extract a V1 RPC API error code from a RoborockException, if present.
-
-    V1 RPC error responses typically look like: {"code": -10007, "message": "..."}.
-    """
-    if not err.args:
-        return None
-    payload = err.args[0]
-    if isinstance(payload, dict):
-        code = payload.get("code")
-        return code if isinstance(code, int) else None
-    return None
-
-
 @dataclass
 class V1TraitMixin(ABC):
     """Base model that supports v1 traits.

roborock/devices/traits/v1/home.py

@@ -24,7 +24,7 @@
 from roborock.data.v1.v1_code_mappings import RoborockStateCode
 from roborock.devices.cache import DeviceCache
 from roborock.devices.traits.v1 import common
-from roborock.exceptions import RoborockDeviceBusy, RoborockException
+from roborock.exceptions import RoborockDeviceBusy, RoborockException, RoborockInvalidStatus
 from roborock.roborock_typing import RoborockCommand
 
 from .map_content import MapContent, MapContentTrait
@@ -152,13 +152,10 @@ async def _build_home_map_info(self) -> tuple[dict[int, CombinedMapInfo], dict[i
                 _LOGGER.debug("Loading map %s", map_info.map_flag)
                 try:
                     await self._maps_trait.set_current_map(map_info.map_flag)
-                except RoborockException as ex:
-                    # Some firmware revisions return -10007 ("invalid status"/action locked) when attempting
-                    # to switch maps while the device is in a state that forbids it. Treat this as a
-                    # "busy" condition so callers can fall back to refreshing the current map only.
-                    if common.extract_v1_api_error_code(ex) == -10007:
-                        raise RoborockDeviceBusy("Cannot switch maps right now (device action locked)") from ex
-                    raise
+                except RoborockInvalidStatus as ex:
+                    # Device is in a state that forbids map switching. Translate to
+                    # "busy" so callers can fall back to refreshing the current map only.
+                    raise RoborockDeviceBusy("Cannot switch maps right now (device action locked)") from ex
                 await asyncio.sleep(MAP_SLEEP)
 
             map_content = await self._refresh_map_content()

roborock/exceptions.py

@@ -87,5 +87,9 @@ class RoborockDeviceBusy(RoborockException):
     """Class for Roborock device busy exceptions."""
 
 
+class RoborockInvalidStatus(RoborockException):
+    """Class for Roborock invalid status exceptions (device action locked)."""
+
+
 class RoborockUnsupportedFeature(RoborockException):
     """Class for Roborock unsupported feature exceptions."""

roborock/protocols/v1_protocol.py

@@ -13,7 +13,7 @@
 from typing import Any, Protocol, TypeVar, overload
 
 from roborock.data import RoborockBase, RRiot
-from roborock.exceptions import RoborockException, RoborockUnsupportedFeature
+from roborock.exceptions import RoborockException, RoborockInvalidStatus, RoborockUnsupportedFeature
 from roborock.protocol import Utils
 from roborock.roborock_message import RoborockMessage, RoborockMessageProtocol
 from roborock.roborock_typing import RoborockCommand
@@ -106,6 +106,24 @@ def _as_payload(self, security_data: SecurityData | None) -> bytes:
 
 ResponseData = dict[str, Any] | list | int
 
+# V1 RPC error code mappings to specific exception types
+_V1_ERROR_CODE_EXCEPTIONS: dict[int, type[RoborockException]] = {
+    -10007: RoborockInvalidStatus,  # "invalid status" - device action locked
+}
+
+
+def _create_api_error(error: Any) -> RoborockException:
+    """Create an appropriate exception for a V1 RPC error response.
+
+    Maps known error codes to specific exception types for easier handling
+    at higher levels.
+    """
+    if isinstance(error, dict):
+        code = error.get("code")
+        if isinstance(code, int) and (exc_type := _V1_ERROR_CODE_EXCEPTIONS.get(code)):
+            return exc_type(error)
+    return RoborockException(error)
+
 
 @dataclass(kw_only=True, frozen=True)
 class ResponseMessage:
@@ -156,7 +174,7 @@ def decode_rpc_response(message: RoborockMessage) -> ResponseMessage:
     request_id: int | None = data_point_response.get("id")
     api_error: RoborockException | None = None
     if error := data_point_response.get("error"):
-        api_error = RoborockException(error)
+        api_error = _create_api_error(error)
 
     if (result := data_point_response.get("result")) is None:
         # Some firmware versions return an error-only response (no "result" key).

tests/devices/traits/v1/test_home.py

@@ -15,7 +15,7 @@
 from roborock.devices.traits.v1.maps import MapsTrait
 from roborock.devices.traits.v1.rooms import RoomsTrait
 from roborock.devices.traits.v1.status import StatusTrait
-from roborock.exceptions import RoborockDeviceBusy, RoborockException
+from roborock.exceptions import RoborockDeviceBusy, RoborockException, RoborockInvalidStatus
 from roborock.map.map_parser import ParsedMapData
 from roborock.roborock_typing import RoborockCommand
 from tests import mock_data
@@ -550,7 +550,7 @@ async def test_refresh_falls_back_when_map_switch_action_locked(
     # Discovery attempt: we can list maps, but switching maps fails with -10007.
     mock_mqtt_rpc_channel.send_command.side_effect = [
         MULTI_MAP_LIST_DATA,  # Maps refresh during discover_home()
-        RoborockException({"code": -10007, "message": "invalid status"}),  # LOAD_MULTI_MAP action locked
+        RoborockInvalidStatus({"code": -10007, "message": "invalid status"}),  # LOAD_MULTI_MAP action locked
         MULTI_MAP_LIST_DATA,  # Maps refresh during refresh() fallback
     ]