python-roborock 5.15.0__tar.gz → 5.15.2__tar.gz

{python_roborock-5.15.0 → python_roborock-5.15.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-roborock
-Version: 5.15.0
+Version: 5.15.2
 Summary: A package to control Roborock vacuums.
 Project-URL: Repository, https://github.com/python-roborock/python-roborock
 Project-URL: Documentation, https://python-roborock.readthedocs.io/
@@ -17,8 +17,6 @@ Classifier: Topic :: Software Development :: Libraries
 Requires-Python: <4,>=3.11
 Requires-Dist: aiohttp<4,>=3.8.2
 Requires-Dist: aiomqtt<3,>=2.5.0
-Requires-Dist: click-shell~=2.1
-Requires-Dist: click>=8
 Requires-Dist: construct<3,>=2.10.57
 Requires-Dist: paho-mqtt<3.0.0,>=1.6.1
 Requires-Dist: protobuf<8,>=6.31.1
@@ -26,6 +24,11 @@ Requires-Dist: pycryptodomex~=3.18; sys_platform == 'darwin'
 Requires-Dist: pycryptodome~=3.18
 Requires-Dist: pyrate-limiter<5,>=4.0.0
 Requires-Dist: vacuum-map-parser-roborock
+Provides-Extra: cli
+Requires-Dist: click-shell~=2.1; extra == 'cli'
+Requires-Dist: click>=8; extra == 'cli'
+Requires-Dist: pyshark<0.7,>=0.6; extra == 'cli'
+Requires-Dist: pyyaml>=6.0.3; extra == 'cli'
 Description-Content-Type: text/markdown
 
 # Roborock
@@ -50,6 +53,11 @@ Install this via pip (or your favourite package manager):
 
 `pip install python-roborock`
 
+To use the `roborock` command line tool, install the `cli` extra, which pulls in
+its additional dependencies (click, pyyaml, pyshark):
+
+`pip install python-roborock[cli]`
+
 ## Example Usage
 
 See [examples/example.py](examples/example.py) for a more full featured example,

{python_roborock-5.15.0 → python_roborock-5.15.2}/README.md

@@ -20,6 +20,11 @@ Install this via pip (or your favourite package manager):
 
 `pip install python-roborock`
 
+To use the `roborock` command line tool, install the `cli` extra, which pulls in
+its additional dependencies (click, pyyaml, pyshark):
+
+`pip install python-roborock[cli]`
+
 ## Example Usage
 
 See [examples/example.py](examples/example.py) for a more full featured example,

{python_roborock-5.15.0 → python_roborock-5.15.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "python-roborock"
-version = "5.15.0"
+version = "5.15.2"
 description = "A package to control Roborock vacuums."
 authors = [{ name = "humbertogontijo", email = "humbertogontijo@users.noreply.github.com" }, {name="Lash-L"}, {name="allenporter"}]
 requires-python = ">=3.11, <4"
@@ -19,7 +19,6 @@ classifiers = [
     "Topic :: Software Development :: Libraries",
 ]
 dependencies = [
-    "click>=8",
     "aiohttp>=3.8.2,<4",
     "pycryptodome~=3.18",
     "pycryptodomex~=3.18 ; sys_platform == 'darwin'",
@@ -29,7 +28,16 @@ dependencies = [
     "vacuum-map-parser-roborock",
     "pyrate-limiter>=4.0.0,<5",
     "aiomqtt>=2.5.0,<3",
+]
+
+[project.optional-dependencies]
+# Dependencies required by the `roborock` command line tool (roborock.cli).
+# Install with: pip install python-roborock[cli]
+cli = [
+    "click>=8",
     "click-shell~=2.1",
+    "pyyaml>=6.0.3",
+    "pyshark>=0.6,<0.7",
 ]
 
 [project.urls]
@@ -41,20 +49,20 @@ roborock = "roborock.cli:main"
 
 [dependency-groups]
 dev = [
+    # Pull in the CLI dependencies so maintainers can run the `roborock`
+    # command and pdoc can import roborock.cli for docs generation.
+    "python-roborock[cli]",
     "pytest-asyncio>=1.1.0",
     "pytest",
     "pre-commit>=3.5,<5.0",
     "mypy",
     "ruff==0.14.11",
     "codespell",
-    "pyshark>=0.6,<0.7",
     "aioresponses>=0.7.7,<0.8",
     "freezegun>=1.5.1,<2",
     "pytest-timeout>=2.3.1,<3",
     "syrupy>=4.9.1,<6",
     "pdoc>=15.0.4,<17",
-    "pyyaml>=6.0.3",
-    "pyshark>=0.6",
     "pytest-cov>=7.0.0",
 ]
 

{python_roborock-5.15.0 → python_roborock-5.15.2}/roborock/cli.py

@@ -34,12 +34,18 @@ from dataclasses import asdict, dataclass
 from pathlib import Path
 from typing import Any, cast
 
-import click
-import click_shell
-import yaml
-from pyshark import FileCapture  # type: ignore
-from pyshark.capture.live_capture import LiveCapture, UnknownInterfaceException  # type: ignore
-from pyshark.packet.packet import Packet  # type: ignore
+try:
+    import click
+    import click_shell
+    import yaml
+    from pyshark import FileCapture  # type: ignore
+    from pyshark.capture.live_capture import LiveCapture, UnknownInterfaceException  # type: ignore
+    from pyshark.packet.packet import Packet  # type: ignore
+except ImportError as err:
+    raise SystemExit(
+        f"The 'roborock' command line tool requires extra dependencies that are not installed ({err.name}).\n"
+        "Install them with:\n\n    pip install python-roborock[cli]\n"
+    ) from err
 
 from roborock import RoborockCommand
 from roborock.data import RoborockBase, UserData

{python_roborock-5.15.0 → python_roborock-5.15.2}/roborock/web_api.py

@@ -1,6 +1,7 @@
 import base64
 import hashlib
 import hmac
+import json
 import logging
 import math
 import secrets
@@ -646,6 +647,31 @@ class RoborockApiClient:
         else:
             raise RoborockException(f"schedule_response result was an unexpected type: {schedules}")
 
+    async def create_job(self, user_data: UserData, device_id: str, job: dict) -> dict:
+        """Create a /jobs entry (schedule or one-time room clean) on a B01 device.
+
+        Body-bearing writes must sign the request body in the Hawk payload slot and send those same
+        compact bytes via ``data=``; ``json=`` would re-serialize with spaces and break the MAC.
+        """
+        rriot = user_data.rriot
+        if rriot is None:
+            raise RoborockException("rriot is none")
+        if rriot.r.a is None:
+            raise RoborockException("Missing field 'a' in rriot reference")
+        path = f"/user/devices/{device_id}/jobs"
+        job_request = PreparedRequest(
+            rriot.r.a,
+            self.session,
+            {
+                "Authorization": _get_hawk_authentication(rriot, path, body=job),
+                "Content-Type": "application/json",
+            },
+        )
+        response = await job_request.request("post", path, data=_compact_json(job).encode())
+        if not response.get("success"):
+            raise RoborockException(response)
+        return response
+
     async def get_products(self, user_data: UserData) -> ProductResponse:
         """Gets all products and their schemas, good for determining status codes and model numbers."""
         base_url = await self.base_url
@@ -738,11 +764,25 @@ def _process_extra_hawk_values(values: dict | None) -> str:
         return hashlib.md5("&".join(result).encode()).hexdigest()
 
 
-def _get_hawk_authentication(rriot: RRiot, url: str, formdata: dict | None = None, params: dict | None = None) -> str:
+def _compact_json(body: dict) -> str:
+    """Serialize a JSON body to the exact compact bytes that are both signed and sent."""
+    return json.dumps(body, separators=(",", ":"))
+
+
+def _get_hawk_authentication(
+    rriot: RRiot,
+    url: str,
+    formdata: dict | None = None,
+    params: dict | None = None,
+    body: dict | None = None,
+) -> str:
     timestamp = math.floor(time.time())
     nonce = secrets.token_urlsafe(6)
-    formdata_str = _process_extra_hawk_values(formdata)
     params_str = _process_extra_hawk_values(params)
+    if body is not None:
+        payload_str = hashlib.md5(_compact_json(body).encode()).hexdigest()
+    else:
+        payload_str = _process_extra_hawk_values(formdata)
 
     prestr = ":".join(
         [
@@ -752,7 +792,7 @@ def _get_hawk_authentication(rriot: RRiot, url: str, formdata: dict | None = Non
             str(timestamp),
             hashlib.md5(url.encode()).hexdigest(),
             params_str,
-            formdata_str,
+            payload_str,
         ]
     )
     mac = base64.b64encode(hmac.new(rriot.h.encode(), prestr.encode(), hashlib.sha256).digest()).decode()