python-roborock 2.8.4__tar.gz → 2.9.0__tar.gz

{python_roborock-2.8.4 → python_roborock-2.9.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: python-roborock
-Version: 2.8.4
+Version: 2.9.0
 Summary: A package to control Roborock vacuums.
 Home-page: https://github.com/humbertogontijo/python-roborock
 License: GPL-3.0-only
@@ -53,6 +53,50 @@ Install this via pip (or your favourite package manager):
 
 You can see all of the commands supported [here]("https://python-roborock.readthedocs.io/en/latest/api_commands.html")
 
+## Sending Commands
+
+Here is an example that requires no manual intervention and can be done all automatically. You can skip some steps by
+caching values or looking at them and grabbing them manually.
+```python
+import asyncio
+
+from roborock import HomeDataProduct, DeviceData, RoborockCommand
+from roborock.version_1_apis import RoborockMqttClientV1, RoborockLocalClientV1
+from roborock.web_api import RoborockApiClient
+
+async def main():
+    web_api = RoborockApiClient(username="youremailhere")
+    # Login via your password
+    user_data = await web_api.pass_login(password="pass_here")
+    # Or login via a code
+    await web_api.request_code()
+    code = input("What is the code?")
+    user_data = await web_api.code_login(code)
+
+    # Get home data
+    home_data = await web_api.get_home_data_v2(user_data)
+
+    # Get the device you want
+    device = home_data.devices[0]
+
+    # Get product ids:
+    product_info: dict[str, HomeDataProduct] = {
+            product.id: product for product in home_data.products
+        }
+    # Create the Mqtt(aka cloud required) Client
+    device_data = DeviceData(device, product_info[device.product_id].model)
+    mqtt_client = RoborockMqttClientV1(user_data, device_data)
+    networking = await mqtt_client.get_networking()
+    local_device_data = DeviceData(device, product_info[device.product_id].model, networking)
+    local_client = RoborockLocalClientV1(local_device_data)
+    # You can use the send_command to send any command to the device
+    status = await local_client.send_command(RoborockCommand.GET_STATUS)
+    # Or use existing functions that will give you data classes
+    status = await local_client.get_status()
+
+asyncio.run(main())
+```
+
 ## Supported devices
 
 You can find what devices are supported

python_roborock-2.9.0/README.md

@@ -0,0 +1,76 @@
+# Roborock
+
+<p align="center">
+  <a href="https://pypi.org/project/python-roborock/">
+    <img src="https://img.shields.io/pypi/v/python-roborock.svg?logo=python&logoColor=fff&style=flat-square" alt="PyPI Version">
+  </a>
+  <img src="https://img.shields.io/pypi/pyversions/python-roborock.svg?style=flat-square&logo=python&amp;logoColor=fff" alt="Supported Python versions">
+  <img src="https://img.shields.io/pypi/l/python-roborock.svg?style=flat-square" alt="License">
+</p>
+
+Roborock library for online and offline control of your vacuums.
+
+## Installation
+
+Install this via pip (or your favourite package manager):
+
+`pip install python-roborock`
+
+## Functionality
+
+You can see all of the commands supported [here]("https://python-roborock.readthedocs.io/en/latest/api_commands.html")
+
+## Sending Commands
+
+Here is an example that requires no manual intervention and can be done all automatically. You can skip some steps by
+caching values or looking at them and grabbing them manually.
+```python
+import asyncio
+
+from roborock import HomeDataProduct, DeviceData, RoborockCommand
+from roborock.version_1_apis import RoborockMqttClientV1, RoborockLocalClientV1
+from roborock.web_api import RoborockApiClient
+
+async def main():
+    web_api = RoborockApiClient(username="youremailhere")
+    # Login via your password
+    user_data = await web_api.pass_login(password="pass_here")
+    # Or login via a code
+    await web_api.request_code()
+    code = input("What is the code?")
+    user_data = await web_api.code_login(code)
+
+    # Get home data
+    home_data = await web_api.get_home_data_v2(user_data)
+
+    # Get the device you want
+    device = home_data.devices[0]
+
+    # Get product ids:
+    product_info: dict[str, HomeDataProduct] = {
+            product.id: product for product in home_data.products
+        }
+    # Create the Mqtt(aka cloud required) Client
+    device_data = DeviceData(device, product_info[device.product_id].model)
+    mqtt_client = RoborockMqttClientV1(user_data, device_data)
+    networking = await mqtt_client.get_networking()
+    local_device_data = DeviceData(device, product_info[device.product_id].model, networking)
+    local_client = RoborockLocalClientV1(local_device_data)
+    # You can use the send_command to send any command to the device
+    status = await local_client.send_command(RoborockCommand.GET_STATUS)
+    # Or use existing functions that will give you data classes
+    status = await local_client.get_status()
+
+asyncio.run(main())
+```
+
+## Supported devices
+
+You can find what devices are supported
+[here]("https://python-roborock.readthedocs.io/en/latest/supported_devices.html").
+Please note this may not immediately contain the latest devices.
+
+
+## Credits
+
+Thanks @rovo89 for https://gist.github.com/rovo89/dff47ed19fca0dfdda77503e66c2b7c7 And thanks @PiotrMachowski for https://github.com/PiotrMachowski/Home-Assistant-custom-components-Xiaomi-Cloud-Map-Extractor

{python_roborock-2.8.4 → python_roborock-2.9.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "python-roborock"
-version = "2.8.4"
+version = "2.9.0"
 description = "A package to control Roborock vacuums."
 authors = ["humbertogontijo <humbertogontijo@users.noreply.github.com>"]
 license = "GPL-3.0-only"
@@ -45,6 +45,7 @@ mypy = "*"
 ruff = "*"
 codespell = "*"
 pyshark = "^0.6"
+aioresponses = "^0.7.7"
 
 [tool.semantic_release]
 branch = "main"
@@ -67,3 +68,6 @@ select=["E", "F", "UP", "I"]
 
 [tool.ruff.lint.per-file-ignores]
 "*/__init__.py" = ["F401"]
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"

{python_roborock-2.8.4 → python_roborock-2.9.0}/roborock/api.py

@@ -7,7 +7,7 @@ import base64
 import logging
 import secrets
 import time
-from collections.abc import Callable, Coroutine
+from collections.abc import Coroutine
 from typing import Any
 
 from .containers import (
@@ -36,8 +36,8 @@ class RoborockClient:
         self._endpoint = endpoint
         self._nonce = secrets.token_bytes(16)
         self._waiting_queue: dict[int, RoborockFuture] = {}
-        self._last_device_msg_in = self.time_func()
-        self._last_disconnection = self.time_func()
+        self._last_device_msg_in = time.monotonic()
+        self._last_disconnection = time.monotonic()
         self.keep_alive = KEEPALIVE
         self._diagnostic_data: dict[str, dict[str, Any]] = {
             "misc_info": {"Nonce": base64.b64encode(self._nonce).decode("utf-8")}
@@ -59,15 +59,6 @@ class RoborockClient:
     def diagnostic_data(self) -> dict:
         return self._diagnostic_data
 
-    @property
-    def time_func(self) -> Callable[[], float]:
-        try:
-            # Use monotonic clock if available
-            time_func = time.monotonic
-        except AttributeError:
-            time_func = time.time
-        return time_func
-
     async def async_connect(self):
         raise NotImplementedError
 
@@ -81,13 +72,13 @@ class RoborockClient:
         raise NotImplementedError
 
     def on_connection_lost(self, exc: Exception | None) -> None:
-        self._last_disconnection = self.time_func()
+        self._last_disconnection = time.monotonic()
         self._logger.info("Roborock client disconnected")
         if exc is not None:
             self._logger.warning(exc)
 
     def should_keepalive(self) -> bool:
-        now = self.time_func()
+        now = time.monotonic()
         # noinspection PyUnresolvedReferences
         if now - self._last_disconnection > self.keep_alive**2 and now - self._last_device_msg_in > self.keep_alive:
             return False
@@ -116,8 +107,11 @@ class RoborockClient:
         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."
+                "Attempting to create a future with an existing id %s (%s)... New id is %s. "
+                "Code may not function properly.",
+                request_id,
+                protocol_id,
+                new_id,
             )
             request_id = new_id
         self._waiting_queue[request_id] = queue

{python_roborock-2.8.4 → python_roborock-2.9.0}/roborock/code_mappings.py

@@ -254,6 +254,15 @@ class RoborockFanSpeedQRevoMaster(RoborockFanPowerCode):
     smart_mode = 110
 
 
+class RoborockFanSpeedQRevoCurv(RoborockFanPowerCode):
+    quiet = 101
+    balanced = 102
+    turbo = 103
+    max = 104
+    max_plus = 105
+    smart_mode = 110
+
+
 class RoborockFanSpeedP10(RoborockFanPowerCode):
     off = 105
     quiet = 101
@@ -279,6 +288,14 @@ class RoborockMopModeCode(RoborockEnum):
     """Describes the mop mode of the vacuum cleaner."""
 
 
+class RoborockMopModeQRevoCurv(RoborockMopModeCode):
+    standard = 300
+    deep = 301
+    deep_plus = 303
+    fast = 304
+    smart_mode = 306
+
+
 class RoborockMopModeS7(RoborockMopModeCode):
     """Describes the mop mode of the vacuum cleaner."""
 
@@ -351,6 +368,15 @@ class RoborockMopIntensityQRevoMaster(RoborockMopIntensityCode):
     smart_mode = 209
 
 
+class RoborockMopIntensityQRevoCurv(RoborockMopIntensityCode):
+    off = 200
+    low = 201
+    medium = 202
+    high = 203
+    custom_water_flow = 207
+    smart_mode = 209
+
+
 class RoborockMopIntensityP10(RoborockMopIntensityCode):
     """Describes the mop intensity of the vacuum cleaner."""
 
@@ -431,6 +457,7 @@ class RoborockDockTypeCode(RoborockEnum):
     s8_maxv_ultra_dock = 10
     qrevo_master_dock = 14
     qrevo_s_dock = 15
+    qrevo_curv_dock = 17
 
 
 class RoborockDockDustCollectionModeCode(RoborockEnum):

{python_roborock-2.8.4 → python_roborock-2.9.0}/roborock/const.py

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

{python_roborock-2.8.4 → python_roborock-2.9.0}/roborock/containers.py

@@ -20,6 +20,7 @@ from .code_mappings import (
     RoborockFanPowerCode,
     RoborockFanSpeedP10,
     RoborockFanSpeedQ7Max,
+    RoborockFanSpeedQRevoCurv,
     RoborockFanSpeedQRevoMaster,
     RoborockFanSpeedS6Pure,
     RoborockFanSpeedS7,
@@ -30,12 +31,14 @@ from .code_mappings import (
     RoborockMopIntensityCode,
     RoborockMopIntensityP10,
     RoborockMopIntensityQ7Max,
+    RoborockMopIntensityQRevoCurv,
     RoborockMopIntensityQRevoMaster,
     RoborockMopIntensityS5Max,
     RoborockMopIntensityS6MaxV,
     RoborockMopIntensityS7,
     RoborockMopIntensityS8MaxVUltra,
     RoborockMopModeCode,
+    RoborockMopModeQRevoCurv,
     RoborockMopModeQRevoMaster,
     RoborockMopModeS7,
     RoborockMopModeS8MaxVUltra,
@@ -52,6 +55,7 @@ from .const import (
     ROBOROCK_G10S_PRO,
     ROBOROCK_P10,
     ROBOROCK_Q7_MAX,
+    ROBOROCK_QREVO_CURV,
     ROBOROCK_QREVO_MASTER,
     ROBOROCK_QREVO_MAXV,
     ROBOROCK_QREVO_PRO,
@@ -581,6 +585,13 @@ class QRevoMasterStatus(Status):
     mop_mode: RoborockMopModeQRevoMaster | None = None
 
 
+@dataclass
+class QRevoCurvStatus(Status):
+    fan_power: RoborockFanSpeedQRevoCurv | None = None
+    water_box_mode: RoborockMopIntensityQRevoCurv | None = None
+    mop_mode: RoborockMopModeQRevoCurv | None = None
+
+
 @dataclass
 class S6MaxVStatus(Status):
     fan_power: RoborockFanSpeedS7MaxV | None = None
@@ -639,6 +650,7 @@ ModelStatus: dict[str, type[Status]] = {
     ROBOROCK_S5_MAX: S5MaxStatus,
     ROBOROCK_Q7_MAX: Q7MaxStatus,
     ROBOROCK_QREVO_MASTER: QRevoMasterStatus,
+    ROBOROCK_QREVO_CURV: QRevoCurvStatus,
     ROBOROCK_S6: S6PureStatus,
     ROBOROCK_S6_MAXV: S6MaxVStatus,
     ROBOROCK_S6_PURE: S6PureStatus,
@@ -881,26 +893,28 @@ class RoborockProductSpec(RoborockBase):
 
 @dataclass
 class RoborockProduct(RoborockBase):
-    id: int
-    name: str
-    model: str
-    packagename: str
-    ssid: str
-    picurl: str
-    cardpicurl: str
-    medium_cardpicurl: str
-    resetwifipicurl: str
-    resetwifitext: dict
-    tuyaid: str
-    status: int
-    rriotid: str
-    cardspec: str
-    pictures: list
-    nc_mode: str
-    scope: None
-    product_tags: list
-    agreements: list
-    plugin_pic_url: None
+    id: int | None = None
+    name: str | None = None
+    model: str | None = None
+    packagename: str | None = None
+    ssid: str | None = None
+    picurl: str | None = None
+    cardpicurl: str | None = None
+    mediumCardpicurl: str | None = None
+    resetwifipicurl: str | None = None
+    configPicUrl: str | None = None
+    pluginPicUrl: str | None = None
+    resetwifitext: dict | None = None
+    tuyaid: str | None = None
+    status: int | None = None
+    rriotid: str | None = None
+    pictures: list | None = None
+    ncMode: str | None = None
+    scope: str | None = None
+    product_tags: list | None = None
+    agreements: list | None = None
+    cardspec: str | None = None
+    plugin_pic_url: str | None = None
     products_specification: RoborockProductSpec | None = None
 
     def __post_init__(self):

{python_roborock-2.8.4 → python_roborock-2.9.0}/roborock/roborock_typing.py

@@ -461,6 +461,11 @@ class DeviceProp(RoborockBase):
     consumable: Consumable = field(default_factory=Consumable)
     last_clean_record: CleanRecord | None = None
     dock_summary: DockSummary | None = None
+    dust_collection_mode_name: str | None = None
+
+    def __post_init__(self) -> None:
+        if self.dock_summary and self.dock_summary.dust_collection_mode and self.dock_summary.dust_collection_mode.mode:
+            self.dust_collection_mode_name = self.dock_summary.dust_collection_mode.mode.name
 
     def update(self, device_prop: DeviceProp) -> None:
         if device_prop.status:
@@ -473,3 +478,4 @@ class DeviceProp(RoborockBase):
             self.last_clean_record = device_prop.last_clean_record
         if device_prop.dock_summary:
             self.dock_summary = device_prop.dock_summary
+        self.__post_init__()

{python_roborock-2.8.4 → python_roborock-2.9.0}/roborock/version_1_apis/roborock_client_v1.py

@@ -71,6 +71,7 @@ WASH_N_FILL_DOCK = [
     RoborockDockTypeCode.p10_pro_dock,
     RoborockDockTypeCode.s8_maxv_ultra_dock,
     RoborockDockTypeCode.qrevo_s_dock,
+    RoborockDockTypeCode.qrevo_curv_dock,
 ]
 RT = TypeVar("RT", bound=RoborockBase)
 EVICT_TIME = 60
@@ -361,7 +362,7 @@ class RoborockClientV1(RoborockClient):
 
     def on_message_received(self, messages: list[RoborockMessage]) -> None:
         try:
-            self._last_device_msg_in = self.time_func()
+            self._last_device_msg_in = time.monotonic()
             for data in messages:
                 protocol = data.protocol
                 if data.payload and protocol in [
@@ -391,6 +392,8 @@ class RoborockClientV1(RoborockClient):
                                     if isinstance(result, list) and len(result) == 1:
                                         result = result[0]
                                     queue.resolve((result, None))
+                            else:
+                                self._logger.debug("Received response for unknown request id %s", request_id)
                         else:
                             try:
                                 data_protocol = RoborockDataProtocol(int(data_point_number))
@@ -418,6 +421,12 @@ class RoborockClientV1(RoborockClient):
                                     consumable = Consumable.from_dict(value)
                                     for listener in self.listener_model.protocol_handlers.get(data_protocol, []):
                                         listener(consumable)
+                                else:
+                                    self._logger.warning(
+                                        f"Unknown data protocol {data_point_number}, please create an "
+                                        f"issue on the python-roborock repository"
+                                    )
+                                    self._logger.info(data)
                                 return
                             except ValueError:
                                 self._logger.warning(
@@ -443,10 +452,14 @@ class RoborockClientV1(RoborockClient):
                             if isinstance(decompressed, list):
                                 decompressed = decompressed[0]
                             queue.resolve((decompressed, None))
+                        else:
+                            self._logger.debug("Received response for unknown request id %s", request_id)
                 else:
                     queue = self._waiting_queue.get(data.seq)
                     if queue:
                         queue.resolve((data.payload, None))
+                    else:
+                        self._logger.debug("Received response for unknown request id %s", data.seq)
         except Exception as ex:
             self._logger.exception(ex)
 

{python_roborock-2.8.4 → python_roborock-2.9.0}/roborock/version_1_apis/roborock_local_client_v1.py

@@ -18,6 +18,7 @@ class RoborockLocalClientV1(RoborockLocalClient, RoborockClientV1):
     ) -> RoborockMessage:
         secured = True if method in COMMANDS_SECURED else False
         request_id, timestamp, payload = self._get_payload(method, params, secured)
+        self._logger.debug("Building message id %s for method %s", request_id, method)
         request_protocol = RoborockMessageProtocol.GENERAL_REQUEST
         message_retry: MessageRetry | None = None
         if method == RoborockCommand.RETRY_REQUEST and isinstance(params, dict):

{python_roborock-2.8.4 → python_roborock-2.9.0}/roborock/version_1_apis/roborock_mqtt_client_v1.py

@@ -74,6 +74,7 @@ class RoborockMqttClientV1(RoborockMqttClient, RoborockClientV1):
             # 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)
+        self._logger.debug("Building message id %s for method %s", request_id, method)
         request_protocol = RoborockMessageProtocol.RPC_REQUEST
         roborock_message = RoborockMessage(timestamp=timestamp, protocol=request_protocol, payload=payload)
         return await self.send_message(roborock_message)

{python_roborock-2.8.4 → python_roborock-2.9.0}/roborock/web_api.py

@@ -54,7 +54,7 @@ class RoborockApiClient:
                     raise RoborockMissingParameters(
                         "You are missing parameters for this request, are you sure you " "entered your username?"
                     )
-                raise RoborockUrlException(response.get("error"))
+                raise RoborockUrlException(f"error code: {response_code} msg: {response.get('error')}")
             response_data = response.get("data")
             if response_data is None:
                 raise RoborockUrlException("response does not have 'data'")
@@ -146,7 +146,7 @@ class RoborockApiClient:
         """
         raise NotImplementedError("Pass_login_v3 has not yet been implemented")
 
-    async def code_login(self, code) -> UserData:
+    async def code_login(self, code: int | str) -> UserData:
         base_url = await self._get_base_url()
         header_clientid = self._get_header_client_id()
 
@@ -276,7 +276,7 @@ class RoborockApiClient:
         product_request = PreparedRequest(base_url, {"header_clientid": header_clientid})
         product_response = await product_request.request(
             "get",
-            "/api/v3/product",
+            "/api/v4/product",
             headers={"Authorization": user_data.token},
         )
         if product_response is None:
@@ -288,24 +288,44 @@ class RoborockApiClient:
             return ProductResponse.from_dict(result)
         raise RoborockException("product result was an unexpected type")
 
+    async def download_code(self, user_data: UserData, product_id: int):
+        base_url = await self._get_base_url()
+        header_clientid = self._get_header_client_id()
+        product_request = PreparedRequest(base_url, {"header_clientid": header_clientid})
+        request = {"apilevel": 99999, "productids": [product_id], "type": 2}
+        response = await product_request.request(
+            "post",
+            "/api/v1/appplugin",
+            json=request,
+            headers={"Authorization": user_data.token, "Content-Type": "application/json"},
+        )
+        return response["data"][0]["url"]
+
+    async def download_category_code(self, user_data: UserData):
+        base_url = await self._get_base_url()
+        header_clientid = self._get_header_client_id()
+        product_request = PreparedRequest(base_url, {"header_clientid": header_clientid})
+        response = await product_request.request(
+            "get",
+            "api/v1/plugins?apiLevel=99999&type=2",
+            headers={
+                "Authorization": user_data.token,
+            },
+        )
+        return {r["category"]: r["url"] for r in response["data"]["categoryPluginList"]}
+
 
 class PreparedRequest:
     def __init__(self, base_url: str, base_headers: dict | None = None) -> None:
         self.base_url = base_url
         self.base_headers = base_headers or {}
 
-    async def request(self, method: str, url: str, params=None, data=None, headers=None) -> dict:
+    async def request(self, method: str, url: str, params=None, data=None, headers=None, json=None) -> dict:
         _url = "/".join(s.strip("/") for s in [self.base_url, url])
         _headers = {**self.base_headers, **(headers or {})}
         async with aiohttp.ClientSession() as session:
             try:
-                async with session.request(
-                    method,
-                    _url,
-                    params=params,
-                    data=data,
-                    headers=_headers,
-                ) as resp:
+                async with session.request(method, _url, params=params, data=data, headers=_headers, json=json) as resp:
                     return await resp.json()
             except ContentTypeError as err:
                 """If we get an error, lets log everything for debugging."""

python_roborock-2.8.4/README.md

@@ -1,32 +0,0 @@
-# Roborock
-
-<p align="center">
-  <a href="https://pypi.org/project/python-roborock/">
-    <img src="https://img.shields.io/pypi/v/python-roborock.svg?logo=python&logoColor=fff&style=flat-square" alt="PyPI Version">
-  </a>
-  <img src="https://img.shields.io/pypi/pyversions/python-roborock.svg?style=flat-square&logo=python&amp;logoColor=fff" alt="Supported Python versions">
-  <img src="https://img.shields.io/pypi/l/python-roborock.svg?style=flat-square" alt="License">
-</p>
-
-Roborock library for online and offline control of your vacuums.
-
-## Installation
-
-Install this via pip (or your favourite package manager):
-
-`pip install python-roborock`
-
-## Functionality
-
-You can see all of the commands supported [here]("https://python-roborock.readthedocs.io/en/latest/api_commands.html")
-
-## Supported devices
-
-You can find what devices are supported
-[here]("https://python-roborock.readthedocs.io/en/latest/supported_devices.html").
-Please note this may not immediately contain the latest devices.
-
-
-## Credits
-
-Thanks @rovo89 for https://gist.github.com/rovo89/dff47ed19fca0dfdda77503e66c2b7c7 And thanks @PiotrMachowski for https://github.com/PiotrMachowski/Home-Assistant-custom-components-Xiaomi-Cloud-Map-Extractor