Add legacy GetNetInfo JSON command (#893)

Author: nanomad

deebot_client/commands/json/__init__.py

@@ -37,7 +37,7 @@
 )
 from .moveup_warning import GetMoveUpWarning, SetMoveUpWarning
 from .multimap_state import GetMultimapState, SetMultimapState
-from .network import GetNetInfo
+from .network import GetNetInfo, GetNetInfoLegacy
 from .ota import GetOta, SetOta
 from .play_sound import PlaySound
 from .pos import GetPos
@@ -88,6 +88,7 @@
     "GetMoveUpWarning",
     "GetMultimapState",
     "GetNetInfo",
+    "GetNetInfoLegacy",
     "GetOta",
     "GetPos",
     "GetSafeProtect",
@@ -198,6 +199,7 @@
     SetMultimapState,
 
     GetNetInfo,
+    GetNetInfoLegacy,
 
     GetOta,
     SetOta,

deebot_client/commands/json/network.py

@@ -4,10 +4,15 @@
 
 from typing import TYPE_CHECKING, Any
 
+from deebot_client.command import CommandWithMessageHandling
 from deebot_client.events import NetworkInfoEvent
-from deebot_client.message import HandlingResult, MessageBodyDataDict
+from deebot_client.message import (
+    HandlingResult,
+    MessageBodyDataDict,
+    MessageDict,
+)
 
-from .common import JsonCommandWithMessageHandling
+from .common import JsonCommand, JsonCommandWithMessageHandling
 
 if TYPE_CHECKING:
     from deebot_client.event_bus import EventBus
@@ -35,3 +40,27 @@ def _handle_body_data_dict(
             )
         )
         return HandlingResult.success()
+
+
+class GetNetInfoLegacy(JsonCommand, CommandWithMessageHandling, MessageDict):
+    """Get network info command."""
+
+    NAME = "GetNetInfo"
+
+    @classmethod
+    def _handle_dict(
+        cls, event_bus: EventBus, message: dict[str, Any]
+    ) -> HandlingResult:
+        """Handle message->body->data and notify the correct event subscribers.
+
+        :return: A message response
+        """
+        event_bus.notify(
+            NetworkInfoEvent(
+                ip=message.get("wi", ""),
+                ssid=message.get("s", ""),
+                rssi=int(message.get("st", "0")),
+                mac=message.get("wm", ""),
+            )
+        )
+        return HandlingResult.success()

deebot_client/message.py

@@ -140,7 +140,42 @@ def _handle(
         return super()._handle(event_bus, message)
 
 
-class MessageBody(Message, ABC):
+class MessageDict(Message, ABC):
+    """Dict message."""
+
+    @classmethod
+    @abstractmethod
+    def _handle_dict(
+        cls, event_bus: EventBus, message: dict[str, Any]
+    ) -> HandlingResult:
+        """Handle string message and notify the correct event subscribers.
+
+        :return: A message response
+        """
+
+    @classmethod
+    @_handle_error_or_analyse
+    @final
+    def __handle_dict(
+        cls, event_bus: EventBus, message: dict[str, Any]
+    ) -> HandlingResult:
+        return cls._handle_dict(event_bus, message)
+
+    @classmethod
+    def _handle(
+        cls, event_bus: EventBus, message: dict[str, Any] | str
+    ) -> HandlingResult:
+        """Handle message and notify the correct event subscribers.
+
+        :return: A message response
+        """
+        if isinstance(message, dict):
+            return cls.__handle_dict(event_bus, message)
+
+        return super()._handle(event_bus, message)
+
+
+class MessageBody(MessageDict, ABC):
     """Dict message with body attribute."""
 
     @classmethod
@@ -158,17 +193,17 @@ def __handle_body(cls, event_bus: EventBus, body: dict[str, Any]) -> HandlingRes
         return cls._handle_body(event_bus, body)
 
     @classmethod
-    def _handle(
-        cls, event_bus: EventBus, message: dict[str, Any] | str
+    def _handle_dict(
+        cls, event_bus: EventBus, message: dict[str, Any]
     ) -> HandlingResult:
         """Handle message and notify the correct event subscribers.
 
         :return: A message response
         """
-        if isinstance(message, dict):
+        if "body" in message:
             return cls.__handle_body(event_bus, message["body"])
 
-        return super()._handle(event_bus, message)
+        return super()._handle_dict(event_bus, message)
 
 
 class MessageBodyData(MessageBody, ABC):

tests/commands/json/test_network.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from deebot_client.commands.json import GetNetInfo
+from deebot_client.commands.json import GetNetInfo, GetNetInfoLegacy
 from deebot_client.events import NetworkInfoEvent
 from tests.commands.json import assert_command
 from tests.helpers import (
@@ -9,7 +9,7 @@
 )
 
 
-async def test_GetFanSpeed() -> None:
+async def test_GetNetInfo() -> None:
     json = get_request_json(
         get_success_body(
             {
@@ -28,3 +28,26 @@ async def test_GetFanSpeed() -> None:
             ip="192.168.1.100", ssid="WLAN", rssi=-61, mac="AA:BB:CC:DD:EE:FF"
         ),
     )
+
+
+async def test_GetNetInfoLegacy() -> None:
+    json = {
+        "ret": "ok",
+        "resp": {
+            "ret": "ok",
+            "s": "WLAN",
+            "p": "",
+            "wi": "192.168.1.100",
+            "wm": "AA:BB:CC:DD:EE:FF",
+            "st": "-61",
+        },
+        "id": "qvHH",
+        "payloadType": "j",
+    }
+    await assert_command(
+        GetNetInfoLegacy(),
+        json,
+        NetworkInfoEvent(
+            ip="192.168.1.100", ssid="WLAN", rssi=-61, mac="AA:BB:CC:DD:EE:FF"
+        ),
+    )