Merge branch 'dev'

Author: edenhaus

.devcontainer.json

@@ -5,6 +5,7 @@
     // Configure properties specific to VS Code.
     "vscode": {
       "extensions": [
+        "charliermarsh.ruff",
         "eamodio.gitlens",
         "github.vscode-pull-request-github",
         "ms-python.python",
@@ -15,6 +16,9 @@
       ],
       // Set *default* container specific settings.json values on container create.
       "settings": {
+        "[python]": {
+          "editor.defaultFormatter": "charliermarsh.ruff"
+        },
         "editor.formatOnPaste": false,
         "editor.formatOnSave": true,
         "editor.formatOnType": true,

.github/workflows/ci.yml

@@ -18,7 +18,7 @@ jobs:
       - uses: "actions/checkout@v4"
       - name: Set up Python ${{ env.DEFAULT_PYTHON }}
         id: python
-        uses: actions/setup-python@v4.7.1
+        uses: actions/setup-python@v5.0.0
         with:
           python-version: ${{ env.DEFAULT_PYTHON }}
           cache: "pip"
@@ -42,7 +42,7 @@ jobs:
       - uses: "actions/checkout@v4"
       - name: Set up Python ${{ env.DEFAULT_PYTHON }}
         id: python
-        uses: actions/setup-python@v4.7.1
+        uses: actions/setup-python@v5.0.0
         with:
           python-version: ${{ env.DEFAULT_PYTHON }}
           cache: "pip"

.github/workflows/python-publish.yml

@@ -23,7 +23,7 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Set up Python
-        uses: actions/setup-python@v4.7.1
+        uses: actions/setup-python@v5.0.0
         with:
           python-version: "3.11"
 

.pre-commit-config.yaml

@@ -1,4 +1,5 @@
 ci:
+  autofix_prs: false
   skip:
     # This steps run in the ci workflow. Keep in sync
     - mypy
@@ -10,23 +11,19 @@ default_language_version:
 
 repos:
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.1.1
+    rev: v0.1.6
     hooks:
       - id: ruff
         args:
           - --fix
+          # - --unsafe-fixes
+      - id: ruff-format
   - repo: https://github.com/asottile/pyupgrade
     rev: v3.15.0
     hooks:
       - id: pyupgrade
         args:
           - --py311-plus
-  - repo: https://github.com/psf/black-pre-commit-mirror
-    rev: 23.10.0
-    hooks:
-      - id: black
-        args:
-          - --quiet
   - repo: https://github.com/codespell-project/codespell
     rev: v2.2.6
     hooks:
@@ -48,16 +45,16 @@ repos:
         args: [--branch, main, --branch, dev]
       - id: requirements-txt-fixer
   - repo: https://github.com/pre-commit/mirrors-prettier
-    rev: v3.0.3
+    rev: v3.1.0
     hooks:
       - id: prettier
         additional_dependencies:
-          - prettier@3.0.3
-          - prettier-plugin-sort-json@3.0.1
+          - prettier@3.1.0
+          - prettier-plugin-sort-json@3.1.0
         exclude_types:
           - python
   - repo: https://github.com/adrienverge/yamllint.git
-    rev: v1.32.0
+    rev: v1.33.0
     hooks:
       - id: yamllint
   - repo: local

deebot_client/api_client.py

@@ -15,7 +15,7 @@
 class ApiClient:
     """Api client."""
 
-    def __init__(self, authenticator: Authenticator):
+    def __init__(self, authenticator: Authenticator) -> None:
         self._authenticator = authenticator
 
     async def get_devices(self) -> list[DeviceInfo]:
@@ -38,9 +38,8 @@ async def get_devices(self) -> list[DeviceInfo]:
                     _LOGGER.debug("Skipping device as it is not supported: %s", device)
             return devices
         _LOGGER.error("Failed to get devices: %s", resp)
-        raise ApiError(
-            f"failure {resp.get('error', '')} ({resp.get('errno', '')}) on getting devices"
-        )
+        msg = f"failure {resp.get('error', '')} ({resp.get('errno', '')}) on getting devices"
+        raise ApiError(msg)
 
     async def get_product_iot_map(self) -> dict[str, Any]:
         """Get product iot map."""
@@ -55,6 +54,5 @@ async def get_product_iot_map(self) -> dict[str, Any]:
                 result[entry["classid"]] = entry["product"]
             return result
         _LOGGER.error("Failed to get product iot map")
-        raise ApiError(
-            f"failure {resp['error']} ({resp['errno']}) on getting product iot map"
-        )
+        msg = f"failure {resp['error']} ({resp['errno']}) on getting product iot map"
+        raise ApiError(msg)

deebot_client/authentication.py

@@ -51,7 +51,7 @@ def __init__(
         config: Configuration,
         account_id: str,
         password_hash: str,
-    ):
+    ) -> None:
         self._config = config
         self._account_id = account_id
         self._password_hash = password_hash
@@ -107,17 +107,16 @@ async def __do_auth_response(
             content_type = res.headers.get(hdrs.CONTENT_TYPE, "").lower()
             json = await res.json(content_type=content_type)
             _LOGGER.debug("got %s", json)
-            # todo better error handling # pylint: disable=fixme
+            # TODO better error handling # pylint: disable=fixme
             if json["code"] == "0000":
                 data: dict[str, Any] = json["data"]
                 return data
             if json["code"] in ["1005", "1010"]:
                 raise InvalidAuthenticationError
 
             _LOGGER.error("call to %s failed with %s", url, json)
-            raise AuthenticationError(
-                f"failure code {json['code']} ({json['msg']}) for call {url}"
-            )
+            msg = f"failure code {json['code']} ({json['msg']}) for call {url}"
+            raise AuthenticationError(msg)
 
     async def __call_login_api(
         self, account_id: str, password_hash: str
@@ -204,9 +203,10 @@ async def __call_login_by_it_token(
                 continue
 
             _LOGGER.error("call to %s failed with %s", _PATH_USERS_USER, resp)
-            raise AuthenticationError(
+            msg = (
                 f"failure {resp['error']} ({resp['errno']}) for call {_PATH_USERS_USER}"
             )
+            raise AuthenticationError(msg)
 
         raise AuthenticationError("failed to login with token")
 
@@ -302,7 +302,7 @@ def __init__(
         config: Configuration,
         account_id: str,
         password_hash: str,
-    ):
+    ) -> None:
         self._auth_client = _AuthClient(
             config,
             account_id,
@@ -317,7 +317,7 @@ def __init__(
         self._refresh_handle: asyncio.TimerHandle | None = None
         self._tasks: set[asyncio.Future[Any]] = set()
 
-    async def authenticate(self, force: bool = False) -> Credentials:
+    async def authenticate(self, *, force: bool = False) -> Credentials:
         """Authenticate on ecovacs servers."""
         async with self._lock:
             if (
@@ -379,7 +379,7 @@ def refresh() -> None:
 
             async def async_refresh() -> None:
                 try:
-                    await self.authenticate(True)
+                    await self.authenticate(force=True)
                 except Exception:  # pylint: disable=broad-except
                     _LOGGER.exception("An exception occurred during refreshing token")
 

deebot_client/capabilities.py

@@ -4,8 +4,7 @@
 from types import MappingProxyType
 from typing import TYPE_CHECKING, Any, Generic, TypeVar
 
-from deebot_client.command import Command
-from deebot_client.commands.json.common import SetCommand
+from deebot_client.command import Command, SetCommand
 from deebot_client.events import (
     AdvancedModeEvent,
     AvailabilityEvent,
@@ -35,12 +34,14 @@
     StatsEvent,
     TotalStatsEvent,
     TrueDetectEvent,
+    VoiceAssistantStateEvent,
     VolumeEvent,
     WaterAmount,
     WaterInfoEvent,
     WorkMode,
     WorkModeEvent,
 )
+from deebot_client.events.efficiency_mode import EfficiencyMode, EfficiencyModeEvent
 from deebot_client.models import CleanAction, CleanMode
 
 if TYPE_CHECKING:
@@ -121,7 +122,7 @@ class CapabilityClean:
     action: CapabilityCleanAction
     continuous: CapabilitySetEnable[ContinuousCleaningEvent]
     count: CapabilitySet[CleanCountEvent, int] | None = None
-    log: CapabilityEvent[CleanLogEvent]
+    log: CapabilityEvent[CleanLogEvent] | None = None
     preference: CapabilitySetEnable[CleanPreferenceEvent] | None = None
     work_mode: CapabilitySetTypes[WorkModeEvent, WorkMode] | None = None
 
@@ -169,7 +170,11 @@ class CapabilitySettings:
 
     advanced_mode: CapabilitySetEnable[AdvancedModeEvent]
     carpet_auto_fan_boost: CapabilitySetEnable[CarpetAutoFanBoostEvent]
+    efficiency_mode: (
+        CapabilitySetTypes[EfficiencyModeEvent, EfficiencyMode] | None
+    ) = None
     true_detect: CapabilitySetEnable[TrueDetectEvent] | None = None
+    voice_assistant: CapabilitySetEnable[VoiceAssistantStateEvent] | None = None
     volume: CapabilitySet[VolumeEvent, int]
 
 

deebot_client/command.py

@@ -2,15 +2,17 @@
 from abc import ABC, abstractmethod
 import asyncio
 from dataclasses import dataclass, field
+from types import MappingProxyType
 from typing import Any, final
 
+from deebot_client.events import AvailabilityEvent
 from deebot_client.exceptions import DeebotError
 
 from .authentication import Authenticator
 from .const import PATH_API_IOT_DEVMANAGER, REQUEST_HEADERS, DataType
 from .event_bus import EventBus
 from .logging_filter import get_logger
-from .message import HandlingResult, HandlingState
+from .message import HandlingResult, HandlingState, MessageBody
 from .models import DeviceInfo
 
 _LOGGER = get_logger(__name__)
@@ -53,7 +55,7 @@ def name(cls) -> str:
     @classmethod
     @abstractmethod
     def data_type(cls) -> DataType:
-        """Data type."""  # noqa: D401
+        """Data type."""
 
     @abstractmethod
     def _get_payload(self) -> dict[str, Any] | list[Any] | str:
@@ -189,6 +191,49 @@ def __hash__(self) -> int:
         return hash(self.name) + hash(self._args)
 
 
+class CommandWithMessageHandling(Command, MessageBody, ABC):
+    """Command, which handle response by itself."""
+
+    _is_available_check: bool = False
+
+    def _handle_response(
+        self, event_bus: EventBus, response: dict[str, Any]
+    ) -> CommandResult:
+        """Handle response from a command.
+
+        :return: A message response
+        """
+        if response.get("ret") == "ok":
+            data = response.get("resp", response)
+            result = self.handle(event_bus, data)
+            return CommandResult(result.state, result.args)
+
+        if errno := response.get("errno", None):
+            match errno:
+                case 4200:
+                    # bot offline
+                    _LOGGER.info(
+                        'Device is offline. Could not execute command "%s"', self.name
+                    )
+                    event_bus.notify(AvailabilityEvent(available=False))
+                    return CommandResult(HandlingState.FAILED)
+                case 500:
+                    if self._is_available_check:
+                        _LOGGER.info(
+                            'No response received for command "%s" during availability-check.',
+                            self.name,
+                        )
+                    else:
+                        _LOGGER.warning(
+                            'No response received for command "%s". This can happen if the device has network issues or does not support the command',
+                            self.name,
+                        )
+                    return CommandResult(HandlingState.FAILED)
+
+        _LOGGER.warning('Command "%s" was not successfully.', self.name)
+        return CommandResult(HandlingState.ANALYSE)
+
+
 @dataclass
 class InitParam:
     """Init param."""
@@ -200,7 +245,7 @@ class InitParam:
 class CommandMqttP2P(Command, ABC):
     """Command which can handle mqtt p2p messages."""
 
-    _mqtt_params: dict[str, InitParam | None]
+    _mqtt_params: MappingProxyType[str, InitParam | None]
 
     @abstractmethod
     def handle_mqtt_p2p(self, event_bus: EventBus, response: dict[str, Any]) -> None:
@@ -230,10 +275,29 @@ def _pop_or_raise(name: str, type_: type, data: dict[str, Any]) -> Any:
     try:
         value = data.pop(name)
     except KeyError as err:
-        raise DeebotError(f'"{name}" is missing in {data}') from err
+        msg = f'"{name}" is missing in {data}'
+        raise DeebotError(msg) from err
     try:
         return type_(value)
     except ValueError as err:
-        raise DeebotError(
-            f'Could not convert "{value}" of {name} into {type_}'
-        ) from err
+        msg = f'Could not convert "{value}" of {name} into {type_}'
+        raise DeebotError(msg) from err
+
+
+class SetCommand(CommandWithMessageHandling, CommandMqttP2P, ABC):
+    """Base set command.
+
+    Command needs to be linked to the "get" command, for handling (updating) the sensors.
+    """
+
+    @property
+    @abstractmethod
+    def get_command(self) -> type[CommandWithMessageHandling]:
+        """Return the corresponding "get" command."""
+        raise NotImplementedError  # pragma: no cover
+
+    def handle_mqtt_p2p(self, event_bus: EventBus, response: dict[str, Any]) -> None:
+        """Handle response received over the mqtt channel "p2p"."""
+        result = self.handle(event_bus, response)
+        if result.state == HandlingState.SUCCESS and isinstance(self._args, dict):
+            self.get_command.handle(event_bus, self._args)