Merge branch 'main' into roborock_supported_features_auto

Author: Lash-L

.github/workflows/ci.yml

@@ -50,7 +50,7 @@ jobs:
         run: poetry install
         shell: bash
       - name: Test with Pytest
-        run: poetry run pytest
+        run: poetry run pytest --log-cli-level=DEBUG -vv -s
         shell: bash
   release:
     runs-on: ubuntu-latest
@@ -75,7 +75,7 @@ jobs:
         persist-credentials: false
     - name: Python Semantic Release
       id: release
-      uses: python-semantic-release/python-semantic-release@v9.21.0
+      uses: python-semantic-release/python-semantic-release@v10.2.0
       with:
         github_token: ${{ secrets.GH_TOKEN }}
 

CHANGELOG.md

@@ -1,6 +1,57 @@
 # CHANGELOG
 
 
+## v2.19.0 (2025-05-13)
+
+### Bug Fixes
+
+- Add Saros 10 dock type code ([#362](https://github.com/Python-roborock/python-roborock/pull/362),
+  [`240bf59`](https://github.com/Python-roborock/python-roborock/commit/240bf59df1873e85e05356496e5be01f1a000199))
+
+### Chores
+
+- **deps**: Bump aiomqtt from 2.3.2 to 2.4.0
+  ([#375](https://github.com/Python-roborock/python-roborock/pull/375),
+  [`b243a25`](https://github.com/Python-roborock/python-roborock/commit/b243a25569c2cb6b54e6c0e1eed6dadecb9ad84c))
+
+Bumps [aiomqtt](https://github.com/empicano/aiomqtt) from 2.3.2 to 2.4.0. - [Release
+  notes](https://github.com/empicano/aiomqtt/releases) -
+  [Changelog](https://github.com/empicano/aiomqtt/blob/main/CHANGELOG.md) -
+  [Commits](https://github.com/empicano/aiomqtt/compare/v2.3.2...v2.4.0)
+
+--- updated-dependencies: - dependency-name: aiomqtt dependency-version: 2.4.0
+
+dependency-type: direct:production
+
+update-type: version-update:semver-minor ...
+
+Signed-off-by: dependabot[bot] <[email protected]>
+
+Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
+
+### Features
+
+- Add some logging for the web api
+  ([#377](https://github.com/Python-roborock/python-roborock/pull/377),
+  [`74c1b5f`](https://github.com/Python-roborock/python-roborock/commit/74c1b5f6e88ce410f95676de802bd04d304963b1))
+
+
+## v2.18.2 (2025-05-04)
+
+### Bug Fixes
+
+- Add session to home_data_v3 ([#372](https://github.com/Python-roborock/python-roborock/pull/372),
+  [`77061fe`](https://github.com/Python-roborock/python-roborock/commit/77061fe1545a3d2f9e874a3f7e4a94eedfd17706))
+
+
+## v2.18.1 (2025-05-04)
+
+### Bug Fixes
+
+- Get home_data_v3 working ([#371](https://github.com/Python-roborock/python-roborock/pull/371),
+  [`f9e6c54`](https://github.com/Python-roborock/python-roborock/commit/f9e6c546e68a71a321dafabd5d502abef3e89b31))
+
+
 ## v2.18.0 (2025-04-06)
 
 ### Features

poetry.lock

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "python-roborock"
-version = "2.18.0"
+version = "2.27.0"
 description = "A package to control Roborock vacuums."
 authors = ["humbertogontijo <[email protected]>"]
 license = "GPL-3.0-only"
@@ -31,6 +31,7 @@ paho-mqtt = ">=1.6.1,<3.0.0"
 construct = "^2.10.57"
 vacuum-map-parser-roborock = "*"
 pyrate-limiter = "^3.7.0"
+aiomqtt = "^2.3.2"
 
 
 [build-system]
@@ -74,4 +75,5 @@ select=["E", "F", "UP", "I"]
 [tool.pytest.ini_options]
 asyncio_mode = "auto"
 asyncio_default_fixture_loop_scope = "function"
-timeout = 20
+timeout = 30
+log_format = "%(asctime)s.%(msecs)03d %(levelname)s (%(threadName)s) [%(name)s] %(message)s"

pyproject.toml

@@ -85,7 +85,7 @@ def should_keepalive(self) -> bool:
 
     async def validate_connection(self) -> None:
         if not self.should_keepalive():
-            self._logger.info("Resetting Roborock connection due to kepalive timeout")
+            self._logger.info("Resetting Roborock connection due to keepalive timeout")
             await self.async_disconnect()
         await self.async_connect()
 

roborock/api.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+import asyncio
 import json
 import logging
 from pathlib import Path
@@ -11,7 +12,8 @@
 from pyshark.packet.packet import Packet  # type: ignore
 
 from roborock import RoborockException
-from roborock.containers import DeviceData, HomeDataProduct, LoginData
+from roborock.containers import DeviceData, HomeData, HomeDataProduct, LoginData
+from roborock.devices.device_manager import create_device_manager, create_home_data_api
 from roborock.protocol import MessageParser
 from roborock.util import run_sync
 from roborock.version_1_apis.roborock_local_client_v1 import RoborockLocalClientV1
@@ -45,7 +47,8 @@ def validate(self):
         if self._login_data is None:
             raise RoborockException("You must login first")
 
-    def login_data(self):
+    def login_data(self) -> LoginData:
+        """Get the login data."""
         self.validate()
         return self._login_data
 
@@ -62,7 +65,11 @@ def cli(ctx, debug: int):
 
 @click.command()
 @click.option("--email", required=True)
-@click.option("--password", required=True)
+@click.option(
+    "--password",
+    required=False,
+    help="Password for the Roborock account. If not provided, an email code will be requested.",
+)
 @click.pass_context
 @run_sync()
 async def login(ctx, email, password):
@@ -75,10 +82,55 @@ async def login(ctx, email, password):
     except RoborockException:
         pass
     client = RoborockApiClient(email)
-    user_data = await client.pass_login(password)
+    if password is not None:
+        user_data = await client.pass_login(password)
+    else:
+        print(f"Requesting code for {email}")
+        await client.request_code()
+        code = click.prompt("A code has been sent to your email, please enter the code", type=str)
+        user_data = await client.code_login(code)
+        print("Login successful")
     context.update(LoginData(user_data=user_data, email=email))
 
 
+@click.command()
+@click.pass_context
+@click.option("--duration", default=10, help="Duration to run the MQTT session in seconds")
+@run_sync()
+async def session(ctx, duration: int):
+    context: RoborockContext = ctx.obj
+    login_data = context.login_data()
+
+    home_data_api = create_home_data_api(login_data.email, login_data.user_data)
+
+    async def home_data_cache() -> HomeData:
+        if login_data.home_data is None:
+            login_data.home_data = await home_data_api()
+            context.update(login_data)
+        return login_data.home_data
+
+    # Create device manager
+    device_manager = await create_device_manager(login_data.user_data, home_data_cache)
+
+    devices = await device_manager.get_devices()
+    click.echo(f"Discovered devices: {', '.join([device.name for device in devices])}")
+
+    click.echo("MQTT session started. Querying devices...")
+    for device in devices:
+        try:
+            status = await device.get_status()
+        except RoborockException as e:
+            click.echo(f"Failed to get status for {device.name}: {e}")
+        else:
+            click.echo(f"Device {device.name} status: {status.as_dict()}")
+
+    click.echo("Listening for messages.")
+    await asyncio.sleep(duration)
+
+    # Close the device manager (this will close all devices and MQTT session)
+    await device_manager.close()
+
+
 async def _discover(ctx):
     context: RoborockContext = ctx.obj
     login_data = context.login_data()
@@ -253,6 +305,7 @@ def on_package(packet: Packet):
 cli.add_command(status)
 cli.add_command(command)
 cli.add_command(parser)
+cli.add_command(session)
 
 
 def main():

roborock/cli.py

@@ -6,14 +6,19 @@
 from abc import ABC
 from asyncio import Lock
 from typing import Any
-from urllib.parse import urlparse
 
 import paho.mqtt.client as mqtt
 
 from .api import KEEPALIVE, RoborockClient
 from .containers import DeviceData, UserData
 from .exceptions import RoborockException, VacuumError
-from .protocol import MessageParser, md5hex
+from .protocol import (
+    Decoder,
+    Encoder,
+    create_mqtt_decoder,
+    create_mqtt_encoder,
+    create_mqtt_params,
+)
 from .roborock_future import RoborockFuture
 
 _LOGGER = logging.getLogger(__name__)
@@ -53,27 +58,24 @@ def __init__(self, user_data: UserData, device_info: DeviceData) -> None:
         if rriot is None:
             raise RoborockException("Got no rriot data from user_data")
         RoborockClient.__init__(self, device_info)
+        mqtt_params = create_mqtt_params(rriot)
         self._mqtt_user = rriot.u
-        self._hashed_user = md5hex(self._mqtt_user + ":" + rriot.k)[2:10]
-        url = urlparse(rriot.r.m)
-        if not isinstance(url.hostname, str):
-            raise RoborockException("Url parsing returned an invalid hostname")
-        self._mqtt_host = str(url.hostname)
-        self._mqtt_port = url.port
-        self._mqtt_ssl = url.scheme == "ssl"
+        self._hashed_user = mqtt_params.username
+        self._mqtt_host = mqtt_params.host
+        self._mqtt_port = mqtt_params.port
 
         self._mqtt_client = _Mqtt()
         self._mqtt_client.on_connect = self._mqtt_on_connect
         self._mqtt_client.on_message = self._mqtt_on_message
         self._mqtt_client.on_disconnect = self._mqtt_on_disconnect
-        if self._mqtt_ssl:
+        if mqtt_params.tls:
             self._mqtt_client.tls_set()
 
-        self._mqtt_password = rriot.s
-        self._hashed_password = md5hex(self._mqtt_password + ":" + rriot.k)[16:]
-        self._mqtt_client.username_pw_set(self._hashed_user, self._hashed_password)
+        self._mqtt_client.username_pw_set(mqtt_params.username, mqtt_params.password)
         self._waiting_queue: dict[int, RoborockFuture] = {}
         self._mutex = Lock()
+        self._decoder: Decoder = create_mqtt_decoder(device_info.device.local_key)
+        self._encoder: Encoder = create_mqtt_encoder(device_info.device.local_key)
 
     def _mqtt_on_connect(self, *args, **kwargs):
         _, __, ___, rc, ____ = args
@@ -102,7 +104,7 @@ def _mqtt_on_connect(self, *args, **kwargs):
     def _mqtt_on_message(self, *args, **kwargs):
         client, __, msg = args
         try:
-            messages, _ = MessageParser.parse(msg.payload, local_key=self.device_info.device.local_key)
+            messages = self._decoder(msg.payload)
             super().on_message_received(messages)
         except Exception as ex:
             self._logger.exception(ex)