Add XML Battery commands (#906)

Author: nanomad

deebot_client/commands/xml/__init__.py

@@ -6,6 +6,7 @@
 
 from deebot_client.command import Command, CommandMqttP2P
 
+from .battery import GetBatteryInfo
 from .charge import Charge
 from .charge_state import GetChargeState
 from .error import GetError
@@ -20,6 +21,7 @@
 
 __all__ = [
     "Charge",
+    "GetBatteryInfo",
     "GetChargeState",
     "GetCleanSum",
     "GetError",
@@ -32,6 +34,7 @@
 # fmt: off
 # ordered by file asc
 _COMMANDS: list[type[XmlCommand]] = [
+    GetBatteryInfo,
     GetError,
     GetLifeSpan,
     PlaySound,

deebot_client/commands/xml/battery.py

@@ -0,0 +1,40 @@
+"""Battery Info command."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from deebot_client.events import BatteryEvent
+from deebot_client.message import HandlingResult
+
+from .common import XmlCommandWithMessageHandling
+
+if TYPE_CHECKING:
+    from xml.etree.ElementTree import Element
+
+    from deebot_client.event_bus import EventBus
+
+
+class GetBatteryInfo(XmlCommandWithMessageHandling):
+    """GetBatteryInfo command."""
+
+    NAME = "GetBatteryInfo"
+
+    @classmethod
+    def _handle_xml(cls, event_bus: EventBus, xml: Element) -> HandlingResult:
+        """Handle xml message and notify the correct event subscribers.
+
+        :return: A message response
+        """
+        if (
+            xml.attrib.get("ret") != "ok"
+            or (battery := xml.find("battery")) is None
+            or (power := battery.attrib.get("power")) is None
+        ):
+            return HandlingResult.analyse()
+
+        if power.isdecimal() and (power_int := int(power)) >= 0:
+            event_bus.notify(BatteryEvent(power_int))
+            return HandlingResult.success()
+
+        return HandlingResult.analyse()

tests/commands/xml/test_battery.py

@@ -0,0 +1,57 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+import pytest
+
+from deebot_client.command import CommandResult
+from deebot_client.commands.xml import GetBatteryInfo
+from deebot_client.events import BatteryEvent
+from deebot_client.message import HandlingState
+from tests.commands import assert_command
+
+from . import get_request_xml
+
+if TYPE_CHECKING:
+    from deebot_client.events.base import Event
+
+
+@pytest.mark.parametrize(
+    ("power", "expected_event"),
+    [
+        (40, BatteryEvent(40)),
+    ],
+    ids=["40_pct_battery"],
+)
+async def test_get_battery_info(power: int, expected_event: Event) -> None:
+    xml_message = get_request_xml(f"<ctl ret='ok'><battery power='{power}' /></ctl>")
+    await assert_command(GetBatteryInfo(), xml_message, expected_event)
+
+
+@pytest.mark.parametrize(
+    "payload",
+    [
+        '<ctl ret="error"/>',
+        '<ctl ret="ok"></ctl>',
+        '<ctl ret="ok"><battery /></ctl>',
+        '<ctl ret="ok"><test power="1" /></ctl>',
+        '<ctl ret="ok"><battery power="-1" /></ctl>',
+        '<ctl ret="ok"><battery power="test" /></ctl>',
+    ],
+    ids=[
+        "error",
+        "no_state",
+        "no_power",
+        "wrong_inner_element",
+        "negative_power",
+        "strange_power_reading",
+    ],
+)
+async def test_get_battery_info_error(payload: str) -> None:
+    xml_message = get_request_xml(payload)
+    await assert_command(
+        GetBatteryInfo(),
+        xml_message,
+        None,
+        command_result=CommandResult(HandlingState.ANALYSE_LOGGED),
+    )