python-roborock 2.6.1__tar.gz → 2.8.1__tar.gz

{python_roborock-2.6.1 → python_roborock-2.8.1}/PKG-INFO

@@ -1,20 +1,19 @@
 Metadata-Version: 2.1
 Name: python-roborock
-Version: 2.6.1
+Version: 2.8.1
 Summary: A package to control Roborock vacuums.
 Home-page: https://github.com/humbertogontijo/python-roborock
 License: GPL-3.0-only
 Keywords: roborock,vacuum,homeassistant
 Author: humbertogontijo
 Author-email: humbertogontijo@users.noreply.github.com
-Requires-Python: >=3.10,<4.0
+Requires-Python: >=3.11,<4.0
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
 Classifier: Natural Language :: English
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
@@ -27,6 +26,7 @@ Requires-Dist: dacite (>=1.8.0,<2.0.0)
 Requires-Dist: paho-mqtt (>=1.6.1,<2.0.0)
 Requires-Dist: pycryptodome (>=3.18,<4.0)
 Requires-Dist: pycryptodomex (>=3.18,<4.0) ; sys_platform == "darwin"
+Requires-Dist: vacuum-map-parser-roborock
 Project-URL: Documentation, https://python-roborock.readthedocs.io/
 Project-URL: Repository, https://github.com/humbertogontijo/python-roborock
 Description-Content-Type: text/markdown

{python_roborock-2.6.1 → python_roborock-2.8.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "python-roborock"
-version = "2.6.1"
+version = "2.8.1"
 description = "A package to control Roborock vacuums."
 authors = ["humbertogontijo <humbertogontijo@users.noreply.github.com>"]
 license = "GPL-3.0-only"
@@ -21,7 +21,7 @@ keywords = ["roborock", "vacuum", "homeassistant"]
 roborock = "roborock.cli:main"
 
 [tool.poetry.dependencies]
-python = "^3.10"
+python = "^3.11"
 click = ">=8"
 aiohttp = "^3.8.2"
 async-timeout = "*"
@@ -30,6 +30,7 @@ pycryptodomex = {version = "^3.18", markers = "sys_platform == 'darwin'"}
 paho-mqtt = "^1.6.1"
 dacite = "^1.8.0"
 construct = "^2.10.57"
+vacuum-map-parser-roborock = "*"
 
 
 [build-system]
@@ -47,7 +48,7 @@ pyshark = "^0.6"
 
 [tool.semantic_release]
 branch = "main"
-version_toml = "pyproject.toml:tool.poetry.version"
+version_toml = ["pyproject.toml:tool.poetry.version"]
 build_command = "pip install poetry && poetry build"
 [tool.semantic_release.commit_parser_options]
 allowed_tags = [

{python_roborock-2.6.1 → python_roborock-2.8.1}/roborock/api.py

@@ -23,7 +23,7 @@ from .roborock_message import (
     RoborockMessage,
 )
 from .roborock_typing import RoborockCommand
-from .util import RoborockLoggerAdapter, get_running_loop_or_create_one
+from .util import RoborockLoggerAdapter, get_next_int, get_running_loop_or_create_one
 
 _LOGGER = logging.getLogger(__name__)
 KEEPALIVE = 60
@@ -113,6 +113,13 @@ class RoborockClient:
         self, request_id: int, protocol_id: int = 0
     ) -> Coroutine[Any, Any, tuple[Any, VacuumError | None]]:
         queue = RoborockFuture(protocol_id)
+        if request_id in self._waiting_queue:
+            new_id = get_next_int(10000, 32767)
+            _LOGGER.warning(
+                f"Attempting to create a future with an existing request_id... New id is {new_id}. "
+                f"Code may not function properly."
+            )
+            request_id = new_id
         self._waiting_queue[request_id] = queue
         return self._wait_response(request_id, queue)
 

{python_roborock-2.6.1 → python_roborock-2.8.1}/roborock/code_mappings.py

@@ -243,6 +243,15 @@ class RoborockFanSpeedQ7Max(RoborockFanPowerCode):
     max = 104
 
 
+class RoborockFanSpeedQRevoMaster(RoborockFanPowerCode):
+    quiet = 101
+    balanced = 102
+    turbo = 103
+    max = 104
+    max_plus = 105
+    custom = 110  # Smartplan
+
+
 class RoborockFanSpeedP10(RoborockFanPowerCode):
     off = 105
     quiet = 101
@@ -288,6 +297,7 @@ class RoborockMopModeS8ProUltra(RoborockMopModeCode):
 class RoborockMopModeS8MaxVUltra(RoborockMopModeCode):
     standard = 300
     deep = 301
+    custom = 302
     deep_plus = 303
     fast = 304
     deep_plus_pearl = 305
@@ -318,6 +328,17 @@ class RoborockMopIntensityV2(RoborockMopIntensityCode):
     custom = 207
 
 
+class RoborockMopIntensityQRevoMaster(RoborockMopIntensityCode):
+    """Describes the mop intensity of the vacuum cleaner."""
+
+    off = 200
+    low = 201
+    medium = 202
+    high = 203
+    custom_water_flow = 207
+    custom = 209  # SmartPlan
+
+
 class RoborockMopIntensityP10(RoborockMopIntensityCode):
     """Describes the mop intensity of the vacuum cleaner."""
 
@@ -362,6 +383,16 @@ class RoborockMopIntensityS6MaxV(RoborockMopIntensityCode):
     custom_water_flow = 207
 
 
+class RoborockMopIntensityQ7Max(RoborockMopIntensityCode):
+    """Describes the mop intensity of the vacuum cleaner."""
+
+    off = 200
+    low = 201
+    medium = 202
+    high = 203
+    custom_water_flow = 207
+
+
 class RoborockDockErrorCode(RoborockEnum):
     """Describes the error code of the dock."""
 

{python_roborock-2.6.1 → python_roborock-2.8.1}/roborock/const.py

@@ -30,6 +30,7 @@ ROBOROCK_Q5_PRO = "roborock.vacuum.a72"
 ROBOROCK_Q7 = "roborock.vacuum.a40"
 ROBOROCK_Q7_MAX = "roborock.vacuum.a38"
 ROBOROCK_Q7PLUS = "roborock.vacuum.a40"
+ROBOROCK_QREVO_MASTER = "roborock.vacuum.a117"
 ROBOROCK_Q8_MAX = "roborock.vacuum.a73"
 ROBOROCK_G10S_PRO = "roborock.vacuum.a26"
 ROBOROCK_G10S = "roborock.vacuum.a46"

{python_roborock-2.6.1 → python_roborock-2.8.1}/roborock/containers.py

@@ -7,9 +7,7 @@ import re
 from dataclasses import asdict, dataclass, field
 from datetime import timezone
 from enum import Enum
-from typing import Any, NamedTuple
-
-from dacite import Config, from_dict
+from typing import Any, NamedTuple, get_args, get_origin
 
 from .code_mappings import (
     RoborockCategory,
@@ -22,6 +20,7 @@ from .code_mappings import (
     RoborockFanPowerCode,
     RoborockFanSpeedP10,
     RoborockFanSpeedQ7Max,
+    RoborockFanSpeedQRevoMaster,
     RoborockFanSpeedS6Pure,
     RoborockFanSpeedS7,
     RoborockFanSpeedS7MaxV,
@@ -30,11 +29,12 @@ from .code_mappings import (
     RoborockInCleaning,
     RoborockMopIntensityCode,
     RoborockMopIntensityP10,
+    RoborockMopIntensityQ7Max,
+    RoborockMopIntensityQRevoMaster,
     RoborockMopIntensityS5Max,
     RoborockMopIntensityS6MaxV,
     RoborockMopIntensityS7,
     RoborockMopIntensityS8MaxVUltra,
-    RoborockMopIntensityV2,
     RoborockMopModeCode,
     RoborockMopModeS7,
     RoborockMopModeS8MaxVUltra,
@@ -51,6 +51,7 @@ from .const import (
     ROBOROCK_G10S_PRO,
     ROBOROCK_P10,
     ROBOROCK_Q7_MAX,
+    ROBOROCK_QREVO_MASTER,
     ROBOROCK_QREVO_MAXV,
     ROBOROCK_QREVO_PRO,
     ROBOROCK_QREVO_S,
@@ -102,14 +103,70 @@ class RoborockBase:
     _ignore_keys = []  # type: ignore
     is_cached = False
 
+    @staticmethod
+    def convert_to_class_obj(type, value):
+        try:
+            class_type = eval(type)
+            if get_origin(class_type) is list:
+                return_list = []
+                cls_type = get_args(class_type)[0]
+                for obj in value:
+                    if issubclass(cls_type, RoborockBase):
+                        return_list.append(cls_type.from_dict(obj))
+                    elif cls_type in {str, int, float}:
+                        return_list.append(cls_type(obj))
+                    else:
+                        return_list.append(cls_type(**obj))
+                return return_list
+            if issubclass(class_type, RoborockBase):
+                converted_value = class_type.from_dict(value)
+            else:
+                converted_value = class_type(value)
+            return converted_value
+        except NameError as err:
+            _LOGGER.exception(err)
+        except ValueError as err:
+            _LOGGER.exception(err)
+        except Exception as err:
+            _LOGGER.exception(err)
+        raise Exception("Fail")
+
     @classmethod
     def from_dict(cls, data: dict[str, Any]):
         if isinstance(data, dict):
             ignore_keys = cls._ignore_keys
-            try:
-                return from_dict(cls, decamelize_obj(data, ignore_keys), config=Config(cast=[Enum]))
-            except AttributeError as err:
-                raise RoborockException("It seems like you have an outdated version of dacite.") from err
+            data = decamelize_obj(data, ignore_keys)
+            cls_annotations: dict[str, str] = {}
+            for base in reversed(cls.__mro__):
+                cls_annotations.update(getattr(base, "__annotations__", {}))
+            remove_keys = []
+            for key, value in data.items():
+                if key not in cls_annotations:
+                    remove_keys.append(key)
+                    continue
+                if value == "None" or value is None:
+                    data[key] = None
+                    continue
+                field_type: str = cls_annotations[key]
+                if "|" in field_type:
+                    # It's a union
+                    types = field_type.split("|")
+                    for type in types:
+                        if "None" in type or "Any" in type:
+                            continue
+                        try:
+                            data[key] = RoborockBase.convert_to_class_obj(type, value)
+                            break
+                        except Exception:
+                            ...
+                else:
+                    try:
+                        data[key] = RoborockBase.convert_to_class_obj(field_type, value)
+                    except Exception:
+                        ...
+            for key in remove_keys:
+                del data[key]
+            return cls(**data)
 
     def as_dict(self) -> dict:
         return asdict(
@@ -185,6 +242,7 @@ class HomeDataProductSchema(RoborockBase):
     mode: Any | None = None
     type: Any | None = None
     product_property: Any | None = None
+    property: Any | None = None
     desc: Any | None = None
 
 
@@ -195,7 +253,7 @@ class HomeDataProduct(RoborockBase):
     model: str
     category: RoborockCategory
     code: str | None = None
-    iconurl: str | None = None
+    icon_url: str | None = None
     attribute: Any | None = None
     capability: int | None = None
     schema: list[HomeDataProductSchema] | None = None
@@ -512,7 +570,13 @@ class S5MaxStatus(Status):
 @dataclass
 class Q7MaxStatus(Status):
     fan_power: RoborockFanSpeedQ7Max | None = None
-    water_box_mode: RoborockMopIntensityV2 | None = None
+    water_box_mode: RoborockMopIntensityQ7Max | None = None
+
+
+@dataclass
+class QRevoMasterStatus(Status):
+    fan_power: RoborockFanSpeedQRevoMaster | None = None
+    water_box_mode: RoborockMopIntensityQRevoMaster | None = None
 
 
 @dataclass
@@ -572,6 +636,7 @@ ModelStatus: dict[str, type[Status]] = {
     ROBOROCK_S4_MAX: S4MaxStatus,
     ROBOROCK_S5_MAX: S5MaxStatus,
     ROBOROCK_Q7_MAX: Q7MaxStatus,
+    ROBOROCK_QREVO_MASTER: QRevoMasterStatus,
     ROBOROCK_S6: S6PureStatus,
     ROBOROCK_S6_MAXV: S6MaxVStatus,
     ROBOROCK_S6_PURE: S6PureStatus,
@@ -612,7 +677,7 @@ class CleanSummary(RoborockBase):
     last_clean_t: int | None = None
 
     def __post_init__(self) -> None:
-        if isinstance(self.clean_area, list):
+        if isinstance(self.clean_area, list | str):
             _LOGGER.warning(f"Clean area is a unexpected type! Please give the following in a issue: {self.clean_area}")
         else:
             self.square_meter_clean_area = round(self.clean_area / 1000000, 1) if self.clean_area is not None else None

{python_roborock-2.6.1 → python_roborock-2.8.1}/roborock/roborock_message.py

@@ -4,9 +4,9 @@ import json
 import math
 import time
 from dataclasses import dataclass
-from random import randint
 
 from roborock import RoborockEnum
+from roborock.util import get_next_int
 
 
 class RoborockMessageProtocol(RoborockEnum):
@@ -155,9 +155,9 @@ class MessageRetry:
 class RoborockMessage:
     protocol: RoborockMessageProtocol
     payload: bytes | None = None
-    seq: int = randint(100000, 999999)
+    seq: int = get_next_int(100000, 999999)
     version: bytes = b"1.0"
-    random: int = randint(10000, 99999)
+    random: int = get_next_int(10000, 99999)
     timestamp: int = math.floor(time.time())
     message_retry: MessageRetry | None = None
 

{python_roborock-2.6.1 → python_roborock-2.8.1}/roborock/roborock_typing.py

@@ -116,6 +116,7 @@ class RoborockCommand(str, Enum):
     GET_MAP_STATUS = "get_map_status"
     GET_MAP_V1 = "get_map_v1"
     GET_MAP_V2 = "get_map_v2"
+    GET_MAP_CALIBRATION = "get_map_calibration"  # Custom command
     GET_MOP_MOTOR_STATUS = "get_mop_motor_status"
     GET_MOP_TEMPLATE_PARAMS_BY_ID = "get_mop_template_params_by_id"
     GET_MOP_TEMPLATE_PARAMS_SUMMARY = "get_mop_template_params_summary"

{python_roborock-2.6.1 → python_roborock-2.8.1}/roborock/util.py

@@ -108,3 +108,15 @@ class RoborockLoggerAdapter(logging.LoggerAdapter):
 
     def process(self, msg: str, kwargs: MutableMapping[str, Any]) -> tuple[str, MutableMapping[str, Any]]:
         return f"[{self.prefix}] {msg}", kwargs
+
+
+counter_map: dict[tuple[int, int], int] = {}
+
+
+def get_next_int(min_val: int, max_val: int):
+    """Gets a random int in the range, precached to help keep it fast."""
+    if (min_val, max_val) not in counter_map:
+        # If we have never seen this range, or if the cache is getting low, make a bunch of preshuffled values.
+        counter_map[(min_val, max_val)] = min_val
+    counter_map[(min_val, max_val)] += 1
+    return counter_map[(min_val, max_val)] % max_val + min_val

{python_roborock-2.6.1 → python_roborock-2.8.1}/roborock/version_1_apis/roborock_client_v1.py

@@ -5,7 +5,6 @@ import math
 import struct
 import time
 from collections.abc import Callable, Coroutine
-from random import randint
 from typing import Any, TypeVar, final
 
 from roborock import (
@@ -54,12 +53,16 @@ from roborock.roborock_message import (
     RoborockMessage,
     RoborockMessageProtocol,
 )
-from roborock.util import RepeatableTask, unpack_list
+from roborock.util import RepeatableTask, get_next_int, unpack_list
 
-COMMANDS_SECURED = [
+COMMANDS_SECURED = {
     RoborockCommand.GET_MAP_V1,
     RoborockCommand.GET_MULTI_MAP,
-]
+}
+
+CUSTOM_COMMANDS = {RoborockCommand.GET_MAP_CALIBRATION}
+
+CLOUD_REQUIRED = COMMANDS_SECURED.union(CUSTOM_COMMANDS)
 
 WASH_N_FILL_DOCK = [
     RoborockDockTypeCode.empty_wash_fill_dock,
@@ -334,7 +337,7 @@ class RoborockClientV1(RoborockClient):
         secured=False,
     ):
         timestamp = math.floor(time.time())
-        request_id = randint(10000, 32767)
+        request_id = get_next_int(10000, 32767)
         inner = {
             "id": request_id,
             "method": method,

{python_roborock-2.6.1 → python_roborock-2.8.1}/roborock/version_1_apis/roborock_mqtt_client_v1.py

@@ -2,6 +2,10 @@ import asyncio
 import base64
 
 import paho.mqtt.client as mqtt
+from vacuum_map_parser_base.config.color import ColorsPalette
+from vacuum_map_parser_base.config.image_config import ImageConfig
+from vacuum_map_parser_base.config.size import Sizes
+from vacuum_map_parser_roborock.map_data_parser import RoborockMapDataParser
 
 from roborock.cloud_api import RoborockMqttClient
 
@@ -13,7 +17,7 @@ from ..roborock_message import (
     RoborockMessageProtocol,
 )
 from ..roborock_typing import RoborockCommand
-from .roborock_client_v1 import COMMANDS_SECURED, RoborockClientV1
+from .roborock_client_v1 import COMMANDS_SECURED, CUSTOM_COMMANDS, RoborockClientV1
 
 
 class RoborockMqttClientV1(RoborockMqttClient, RoborockClientV1):
@@ -66,10 +70,21 @@ class RoborockMqttClientV1(RoborockMqttClient, RoborockClientV1):
         method: RoborockCommand | str,
         params: list | dict | int | None = None,
     ):
+        if method in CUSTOM_COMMANDS:
+            # When we have more custom commands do something more complicated here
+            return await self._get_calibration_points()
         request_id, timestamp, payload = self._get_payload(method, params, True)
         request_protocol = RoborockMessageProtocol.RPC_REQUEST
         roborock_message = RoborockMessage(timestamp=timestamp, protocol=request_protocol, payload=payload)
         return await self.send_message(roborock_message)
 
+    async def _get_calibration_points(self):
+        map: bytes = await self.send_command(RoborockCommand.GET_MAP_V1)
+        parser = RoborockMapDataParser(ColorsPalette(), Sizes(), [], ImageConfig(), [])
+        parsed_map = parser.parse(map)
+        calibration = parsed_map.calibration()
+        self._logger.info(parsed_map.calibration())
+        return calibration
+
     async def get_map_v1(self) -> bytes | None:
         return await self.send_command(RoborockCommand.GET_MAP_V1)