python-roborock 2.34.0__tar.gz → 2.34.2__tar.gz

{python_roborock-2.34.0 → python_roborock-2.34.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-roborock
-Version: 2.34.0
+Version: 2.34.2
 Summary: A package to control Roborock vacuums.
 Home-page: https://github.com/humbertogontijo/python-roborock
 License: GPL-3.0-only

{python_roborock-2.34.0 → python_roborock-2.34.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "python-roborock"
-version = "2.34.0"
+version = "2.34.2"
 description = "A package to control Roborock vacuums."
 authors = ["humbertogontijo <humbertogontijo@users.noreply.github.com>"]
 license = "GPL-3.0-only"

{python_roborock-2.34.0 → python_roborock-2.34.2}/roborock/api.py

@@ -116,7 +116,3 @@ class RoborockClient(ABC):
             request_id = new_id
         self._waiting_queue[request_id] = queue
         return asyncio.ensure_future(self._wait_response(request_id, queue))
-
-    @abstractmethod
-    async def send_message(self, roborock_message: RoborockMessage):
-        """Send a message to the Roborock device."""

{python_roborock-2.34.0 → python_roborock-2.34.2}/roborock/protocols/v1_protocol.py

@@ -15,7 +15,7 @@ from typing import Any
 from roborock.containers import RRiot
 from roborock.exceptions import RoborockException
 from roborock.protocol import Utils
-from roborock.roborock_message import MessageRetry, RoborockMessage, RoborockMessageProtocol
+from roborock.roborock_message import RoborockMessage, RoborockMessageProtocol
 from roborock.roborock_typing import RoborockCommand
 from roborock.util import get_next_int
 
@@ -102,15 +102,10 @@ def encode_local_payload(method: CommandType, params: ParamsType) -> RoborockMes
     request = RequestMessage(method=method, params=params)
     payload = request.as_payload(security_data=None)
 
-    message_retry: MessageRetry | None = None
-    if method == RoborockCommand.RETRY_REQUEST and isinstance(params, dict):
-        message_retry = MessageRetry(method=method, retry_id=params["retry_id"])
-
     return RoborockMessage(
         timestamp=request.timestamp,
         protocol=RoborockMessageProtocol.GENERAL_REQUEST,
         payload=payload,
-        message_retry=message_retry,
     )
 
 

{python_roborock-2.34.0 → python_roborock-2.34.2}/roborock/roborock_message.py

@@ -239,12 +239,6 @@ ROBOROCK_DATA_CONSUMABLE_PROTOCOL = [
 ]
 
 
-@dataclass
-class MessageRetry:
-    method: str
-    retry_id: int
-
-
 @dataclass
 class RoborockMessage:
     protocol: RoborockMessageProtocol
@@ -253,7 +247,6 @@ class RoborockMessage:
     version: bytes = b"1.0"
     random: int = field(default_factory=lambda: get_next_int(10000, 99999))
     timestamp: int = field(default_factory=lambda: math.floor(time.time()))
-    message_retry: MessageRetry | None = None
 
     def get_request_id(self) -> int | None:
         if self.payload:
@@ -264,14 +257,7 @@ class RoborockMessage:
                     return data_point_response.get("id")
         return None
 
-    def get_retry_id(self) -> int | None:
-        if self.message_retry:
-            return self.message_retry.retry_id
-        return self.get_request_id()
-
     def get_method(self) -> str | None:
-        if self.message_retry:
-            return self.message_retry.method
         protocol = self.protocol
         if self.payload and protocol in [4, 5, 101, 102]:
             payload = json.loads(self.payload.decode())

python_roborock-2.34.0/roborock/local_api.py → python_roborock-2.34.2/roborock/version_1_apis/roborock_local_client_v1.py

@@ -1,19 +1,19 @@
-from __future__ import annotations
-
 import asyncio
 import logging
-from abc import ABC
 from asyncio import Lock, TimerHandle, Transport, get_running_loop
 from collections.abc import Callable
 from dataclasses import dataclass
 
 import async_timeout
 
-from . import DeviceData
-from .api import RoborockClient
-from .exceptions import RoborockConnectionException, RoborockException
-from .protocol import Decoder, Encoder, create_local_decoder, create_local_encoder
-from .roborock_message import RoborockMessage, RoborockMessageProtocol
+from .. import CommandVacuumError, DeviceData, RoborockCommand
+from ..api import RoborockClient
+from ..exceptions import RoborockConnectionException, RoborockException, VacuumError
+from ..protocol import Decoder, Encoder, create_local_decoder, create_local_encoder
+from ..protocols.v1_protocol import encode_local_payload
+from ..roborock_message import RoborockMessage, RoborockMessageProtocol
+from ..util import RoborockLoggerAdapter
+from .roborock_client_v1 import CLOUD_REQUIRED, RoborockClientV1
 
 _LOGGER = logging.getLogger(__name__)
 
@@ -34,10 +34,10 @@ class _LocalProtocol(asyncio.Protocol):
         self.connection_lost_cb(exc)
 
 
-class RoborockLocalClient(RoborockClient, ABC):
-    """Roborock local client base class."""
+class RoborockLocalClientV1(RoborockClientV1, RoborockClient):
+    """Roborock local client for v1 devices."""
 
-    def __init__(self, device_data: DeviceData):
+    def __init__(self, device_data: DeviceData, queue_timeout: int = 4):
         """Initialize the Roborock local client."""
         if device_data.host is None:
             raise RoborockException("Host is required")
@@ -47,10 +47,13 @@ class RoborockLocalClient(RoborockClient, ABC):
         self.transport: Transport | None = None
         self._mutex = Lock()
         self.keep_alive_task: TimerHandle | None = None
+        RoborockClientV1.__init__(self, device_data, "abc")
         RoborockClient.__init__(self, device_data)
         self._local_protocol = _LocalProtocol(self._data_received, self._connection_lost)
         self._encoder: Encoder = create_local_encoder(device_data.device.local_key)
         self._decoder: Decoder = create_local_decoder(device_data.device.local_key)
+        self.queue_timeout = queue_timeout
+        self._logger = RoborockLoggerAdapter(device_data.device.name, _LOGGER)
 
     def _data_received(self, message):
         """Called when data is received from the transport."""
@@ -109,7 +112,7 @@ class RoborockLocalClient(RoborockClient, ABC):
         request_id = 1
         protocol = RoborockMessageProtocol.HELLO_REQUEST
         try:
-            return await self.send_message(
+            return await self._send_message(
                 RoborockMessage(
                     protocol=protocol,
                     seq=request_id,
@@ -122,7 +125,7 @@ class RoborockLocalClient(RoborockClient, ABC):
     async def ping(self) -> None:
         request_id = 2
         protocol = RoborockMessageProtocol.PING_REQUEST
-        return await self.send_message(
+        return await self._send_message(
             RoborockMessage(
                 protocol=protocol,
                 seq=request_id,
@@ -137,3 +140,53 @@ class RoborockLocalClient(RoborockClient, ABC):
             self.transport.write(data)
         except Exception as e:
             raise RoborockException(e) from e
+
+    async def _send_command(
+        self,
+        method: RoborockCommand | str,
+        params: list | dict | int | None = None,
+    ):
+        if method in CLOUD_REQUIRED:
+            raise RoborockException(f"Method {method} is not supported over local connection")
+
+        roborock_message = encode_local_payload(method, params)
+        self._logger.debug("Building message id %s for method %s", roborock_message.get_request_id(), method)
+        return await self._send_message(roborock_message)
+
+    async def _send_message(self, roborock_message: RoborockMessage):
+        await self.validate_connection()
+        method = roborock_message.get_method()
+        params = roborock_message.get_params()
+        request_id: int | None
+        if not method or not method.startswith("get"):
+            request_id = roborock_message.seq
+            response_protocol = request_id + 1
+        else:
+            request_id = roborock_message.get_request_id()
+            response_protocol = RoborockMessageProtocol.GENERAL_REQUEST
+        if request_id is None:
+            raise RoborockException(f"Failed build message {roborock_message}")
+        msg = self._encoder(roborock_message)
+        if method:
+            self._logger.debug(f"id={request_id} Requesting method {method} with {params}")
+        # Send the command to the Roborock device
+        async_response = self._async_response(request_id, response_protocol)
+        self._send_msg_raw(msg)
+        diagnostic_key = method if method is not None else "unknown"
+        try:
+            response = await async_response
+        except VacuumError as err:
+            self._diagnostic_data[diagnostic_key] = {
+                "params": roborock_message.get_params(),
+                "error": err,
+            }
+            raise CommandVacuumError(method, err) from err
+        self._diagnostic_data[diagnostic_key] = {
+            "params": roborock_message.get_params(),
+            "response": response,
+        }
+        if roborock_message.protocol == RoborockMessageProtocol.GENERAL_REQUEST:
+            self._logger.debug(f"id={request_id} Response from method {roborock_message.get_method()}: {response}")
+        if response == "retry":
+            raise RoborockException(f"Command {method} failed with 'retry' message; Device is busy, try again later")
+        return response

{python_roborock-2.34.0 → python_roborock-2.34.2}/roborock/version_a01_apis/roborock_mqtt_client_a01.py

@@ -39,7 +39,7 @@ class RoborockMqttClientA01(RoborockMqttClient, RoborockClientA01):
         self.queue_timeout = queue_timeout
         self._logger = RoborockLoggerAdapter(device_info.device.name, _LOGGER)
 
-    async def send_message(self, roborock_message: RoborockMessage):
+    async def _send_message(self, roborock_message: RoborockMessage):
         await self.validate_connection()
         response_protocol = RoborockMessageProtocol.RPC_RESPONSE
 
@@ -67,11 +67,11 @@ class RoborockMqttClientA01(RoborockMqttClient, RoborockClientA01):
         message = encode_mqtt_payload(
             {RoborockDyadDataProtocol.ID_QUERY: str([int(protocol) for protocol in dyad_data_protocols])}
         )
-        return await self.send_message(message)
+        return await self._send_message(message)
 
     async def set_value(
         self, protocol: RoborockDyadDataProtocol | RoborockZeoProtocol, value: typing.Any
     ) -> dict[int, typing.Any]:
         """Set a value for a specific protocol on the A01 device."""
         message = encode_mqtt_payload({protocol: value})
-        return await self.send_message(message)
+        return await self._send_message(message)

python_roborock-2.34.0/roborock/version_1_apis/roborock_local_client_v1.py

@@ -1,76 +0,0 @@
-import logging
-
-from roborock.local_api import RoborockLocalClient
-
-from .. import CommandVacuumError, DeviceData, RoborockCommand, RoborockException
-from ..exceptions import VacuumError
-from ..protocols.v1_protocol import encode_local_payload
-from ..roborock_message import RoborockMessage, RoborockMessageProtocol
-from ..util import RoborockLoggerAdapter
-from .roborock_client_v1 import CLOUD_REQUIRED, RoborockClientV1
-
-_LOGGER = logging.getLogger(__name__)
-
-
-class RoborockLocalClientV1(RoborockLocalClient, RoborockClientV1):
-    """Roborock local client for v1 devices."""
-
-    def __init__(self, device_data: DeviceData, queue_timeout: int = 4):
-        """Initialize the Roborock local client."""
-        RoborockLocalClient.__init__(self, device_data)
-        RoborockClientV1.__init__(self, device_data, "abc")
-        self.queue_timeout = queue_timeout
-        self._logger = RoborockLoggerAdapter(device_data.device.name, _LOGGER)
-
-    async def _send_command(
-        self,
-        method: RoborockCommand | str,
-        params: list | dict | int | None = None,
-    ):
-        if method in CLOUD_REQUIRED:
-            raise RoborockException(f"Method {method} is not supported over local connection")
-
-        roborock_message = encode_local_payload(method, params)
-        self._logger.debug("Building message id %s for method %s", roborock_message.get_request_id(), method)
-        return await self.send_message(roborock_message)
-
-    async def send_message(self, roborock_message: RoborockMessage):
-        await self.validate_connection()
-        method = roborock_message.get_method()
-        params = roborock_message.get_params()
-        request_id: int | None
-        if not method or not method.startswith("get"):
-            request_id = roborock_message.seq
-            response_protocol = request_id + 1
-        else:
-            request_id = roborock_message.get_request_id()
-            response_protocol = RoborockMessageProtocol.GENERAL_REQUEST
-        if request_id is None:
-            raise RoborockException(f"Failed build message {roborock_message}")
-        msg = self._encoder(roborock_message)
-        if method:
-            self._logger.debug(f"id={request_id} Requesting method {method} with {params}")
-        # Send the command to the Roborock device
-        async_response = self._async_response(request_id, response_protocol)
-        self._send_msg_raw(msg)
-        diagnostic_key = method if method is not None else "unknown"
-        try:
-            response = await async_response
-        except VacuumError as err:
-            self._diagnostic_data[diagnostic_key] = {
-                "params": roborock_message.get_params(),
-                "error": err,
-            }
-            raise CommandVacuumError(method, err) from err
-        self._diagnostic_data[diagnostic_key] = {
-            "params": roborock_message.get_params(),
-            "response": response,
-        }
-        if roborock_message.protocol == RoborockMessageProtocol.GENERAL_REQUEST:
-            self._logger.debug(f"id={request_id} Response from method {roborock_message.get_method()}: {response}")
-        if response == "retry":
-            retry_id = roborock_message.get_retry_id()
-            return self.send_command(
-                RoborockCommand.RETRY_REQUEST, {"retry_id": retry_id, "retry_count": 8, "method": method}
-            )
-        return response