Add XML command "SetFanSpeed"

deebot_client/commands/xml/__init__.py

@@ -8,24 +8,27 @@
 
 from .charge_state import GetChargeState
 from .error import GetError
-from .fan_speed import GetFanSpeed
+from .fan_speed import GetCleanSpeed, SetCleanSpeed
 from .pos import GetPos
 from .stats import GetCleanSum
 
 if TYPE_CHECKING:
     from .common import XmlCommand
 
 __all__ = [
+    "GetCleanSpeed",
+    "SetCleanSpeed",
     "GetChargeState",
     "GetCleanSum",
     "GetError",
-    "GetFanSpeed",
     "GetPos",
 ]
 
 # fmt: off
 # ordered by file asc
 _COMMANDS: list[type[XmlCommand]] = [
+    GetCleanSpeed,
+    SetCleanSpeed,
     GetError,
 ]
 # fmt: on

deebot_client/commands/xml/common.py

@@ -8,10 +8,10 @@
 
 from defusedxml import ElementTree  # type: ignore[import-untyped]
 
-from deebot_client.command import Command, CommandWithMessageHandling
+from deebot_client.command import Command, CommandWithMessageHandling, SetCommand
 from deebot_client.const import DataType
 from deebot_client.logging_filter import get_logger
-from deebot_client.message import HandlingResult, MessageStr
+from deebot_client.message import HandlingResult, MessageStr, HandlingState
 
 if TYPE_CHECKING:
     from deebot_client.event_bus import EventBus
@@ -25,7 +25,6 @@ class XmlCommand(Command):
     data_type: DataType = DataType.XML
 
     @property  # type: ignore[misc]
-    @classmethod
     def has_sub_element(cls) -> bool:
         """Return True if command has inner element."""
         return False
@@ -65,3 +64,27 @@ def _handle_str(cls, event_bus: EventBus, message: str) -> HandlingResult:
         """
         xml = ElementTree.fromstring(message)
         return cls._handle_xml(event_bus, xml)
+
+
+class ExecuteCommand(XmlCommandWithMessageHandling, ABC):
+    """Command, which is executing something (ex. Charge)."""
+
+    @classmethod
+    def _handle_xml(cls, event_bus: EventBus, xml: Element) -> HandlingResult:
+        """Handle message->xml and notify the correct event subscribers.
+
+        :return: A message response
+        """
+        # Success event looks like <ctl ret='ok'/>
+        if xml.attrib.get("ret") == "ok":
+            return HandlingResult.success()
+
+        _LOGGER.warning('Command "%s" was not successful. XML response: %s', cls.name, xml)
+        return HandlingResult(HandlingState.FAILED)
+
+
+class XmlSetCommand(ExecuteCommand, SetCommand, ABC):
+    """Xml base set command.
+
+    Command needs to be linked to the "get" command, for handling (updating) the sensors.
+    """

deebot_client/commands/xml/fan_speed.py

@@ -2,21 +2,23 @@
 
 from __future__ import annotations
 
+from types import MappingProxyType
 from typing import TYPE_CHECKING
 
+from deebot_client.command import InitParam
 from deebot_client.events import FanSpeedEvent, FanSpeedLevel
 from deebot_client.message import HandlingResult
 
-from .common import XmlCommandWithMessageHandling
+from .common import XmlCommandWithMessageHandling, XmlSetCommand
 
 if TYPE_CHECKING:
     from xml.etree.ElementTree import Element
 
     from deebot_client.event_bus import EventBus
 
 
-class GetFanSpeed(XmlCommandWithMessageHandling):
-    """GetFanSpeed command."""
+class GetCleanSpeed(XmlCommandWithMessageHandling):
+    """GetCleanSpeed command."""
 
     name = "GetCleanSpeed"
 
@@ -33,12 +35,26 @@ def _handle_xml(cls, event_bus: EventBus, xml: Element) -> HandlingResult:
 
         match speed.lower():
             case "standard":
-                event = FanSpeedEvent(FanSpeedLevel.NORMAL)
+                event = FanSpeedEvent(FanSpeedLevel.STANDARD)
             case "strong":
-                event = FanSpeedEvent(FanSpeedLevel.MAX)
+                event = FanSpeedEvent(FanSpeedLevel.STRONG)
 
         if event:
             event_bus.notify(event)
             return HandlingResult.success()
 
         return HandlingResult.analyse()
+
+
+class SetCleanSpeed(XmlSetCommand):
+    """Set clean speed command."""
+
+    name = "SetCleanSpeed"
+    get_command = GetCleanSpeed
+    _mqtt_params = MappingProxyType({"speed": InitParam(FanSpeedLevel)})
+
+    def __init__(self, speed: FanSpeedLevel | str) -> None:
+        if isinstance(speed, FanSpeedLevel):
+            speed = speed.name.lower()
+        super().__init__({"speed": speed})
+

deebot_client/events/fan_speed.py

@@ -14,8 +14,10 @@ class FanSpeedLevel(IntEnum):
 
     # Values should be sort from low to high on their meanings
     QUIET = 1000
+    STANDARD = -1
     NORMAL = 0
     MAX = 1
+    STRONG = -2
     MAX_PLUS = 2
 
 

tests/commands/xml/test_fan_speed.py

@@ -5,7 +5,7 @@
 import pytest
 
 from deebot_client.command import CommandResult
-from deebot_client.commands.xml import GetFanSpeed
+from deebot_client.commands.xml import GetCleanSpeed, SetCleanSpeed
 from deebot_client.events import FanSpeedEvent, FanSpeedLevel
 from deebot_client.message import HandlingState
 from tests.commands import assert_command
@@ -19,14 +19,14 @@
 @pytest.mark.parametrize(
     ("speed", "expected_event"),
     [
-        ("standard", FanSpeedEvent(FanSpeedLevel.NORMAL)),
-        ("strong", FanSpeedEvent(FanSpeedLevel.MAX)),
+        ("standard", FanSpeedEvent(FanSpeedLevel.STANDARD)),
+        ("strong", FanSpeedEvent(FanSpeedLevel.STRONG)),
     ],
     ids=["standard", "strong"],
 )
 async def test_get_fan_speed(speed: str, expected_event: Event) -> None:
     json = get_request_xml(f"<ctl ret='ok' speed='{speed}'/>")
-    await assert_command(GetFanSpeed(), json, expected_event)
+    await assert_command(GetCleanSpeed(), json, expected_event)
 
 
 @pytest.mark.parametrize(
@@ -37,8 +37,20 @@ async def test_get_fan_speed(speed: str, expected_event: Event) -> None:
 async def test_get_fan_speed_error(xml: str) -> None:
     json = get_request_xml(xml)
     await assert_command(
-        GetFanSpeed(),
+        GetCleanSpeed(),
         json,
         None,
         command_result=CommandResult(HandlingState.ANALYSE_LOGGED),
     )
+
+
+async def test_set_fan_speed() -> None:
+    command = SetCleanSpeed(FanSpeedLevel.STRONG)
+    json = get_request_xml("<ctl ret='ok' />")
+    await assert_command(command, json, None, command_result=CommandResult(HandlingState.SUCCESS))
+
+
+async def test_set_fan_speed_error() -> None:
+    command = SetCleanSpeed("invalid")
+    json = get_request_xml("<ctl ret='error' />")
+    await assert_command(command, json, None, command_result=CommandResult(HandlingState.FAILED))