1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690
|
"""Command line interface for python-roborock.
The CLI supports both one-off commands and an interactive session mode. In session
mode, an asyncio event loop is created in a separate thread, allowing users to
interactively run commands that require async operations.
Typical CLI usage:
```
$ roborock login --email <email> [--password <password>]
$ roborock discover
$ roborock list-devices
$ roborock status --device_id <device_id>
```
...
Session mode usage:
```
$ roborock session
roborock> list-devices
...
roborock> status --device_id <device_id>
```
"""
import asyncio
import datetime
import functools
import json
import logging
import threading
from collections.abc import Callable
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
from roborock import SHORT_MODEL_TO_ENUM, DeviceFeatures, RoborockCommand, RoborockException
from roborock.containers import DeviceData, HomeData, NetworkInfo, RoborockBase, UserData
from roborock.devices.cache import Cache, CacheData
from roborock.devices.device import RoborockDevice
from roborock.devices.device_manager import DeviceManager, create_device_manager, create_home_data_api
from roborock.devices.traits import Trait
from roborock.devices.traits.v1 import V1TraitMixin
from roborock.protocol import MessageParser
from roborock.version_1_apis.roborock_mqtt_client_v1 import RoborockMqttClientV1
from roborock.web_api import RoborockApiClient
_LOGGER = logging.getLogger(__name__)
def dump_json(obj: Any) -> Any:
"""Dump an object as JSON."""
def custom_json_serializer(obj):
if isinstance(obj, datetime.time):
return obj.isoformat()
raise TypeError(f"Object of type {obj.__class__.__name__} is not JSON serializable")
return json.dumps(obj, default=custom_json_serializer)
def async_command(func):
"""Decorator for async commands that work in both CLI and session modes.
The CLI supports two execution modes:
1. CLI mode: One-off commands that create their own event loop
2. Session mode: Interactive shell with a persistent background event loop
This decorator ensures async commands work correctly in both modes:
- CLI mode: Uses asyncio.run() to create a new event loop
- Session mode: Uses the existing session event loop via run_in_session()
"""
@functools.wraps(func)
def wrapper(*args, **kwargs):
ctx = args[0]
context: RoborockContext = ctx.obj
async def run():
return await func(*args, **kwargs)
if context.is_session_mode():
# Session mode - run in the persistent loop
return context.run_in_session(run())
else:
# CLI mode - just run normally (asyncio.run handles loop creation)
return asyncio.run(run())
return wrapper
@dataclass
class ConnectionCache(RoborockBase):
"""Cache for Roborock data.
This is used to store data retrieved from the Roborock API, such as user
data and home data to avoid repeated API calls.
This cache is superset of `LoginData` since we used to directly store that
dataclass, but now we also store additional data.
"""
user_data: UserData
email: str
home_data: HomeData | None = None
network_info: dict[str, NetworkInfo] | None = None
class DeviceConnectionManager:
"""Manages device connections for both CLI and session modes."""
def __init__(self, context: "RoborockContext", loop: asyncio.AbstractEventLoop | None = None):
self.context = context
self.loop = loop
self.device_manager: DeviceManager | None = None
self._devices: dict[str, RoborockDevice] = {}
async def ensure_device_manager(self) -> DeviceManager:
"""Ensure device manager is initialized."""
if self.device_manager is None:
cache_data = self.context.cache_data()
home_data_api = create_home_data_api(cache_data.email, cache_data.user_data)
self.device_manager = await create_device_manager(cache_data.user_data, home_data_api, self.context)
# Cache devices for quick lookup
devices = await self.device_manager.get_devices()
self._devices = {device.duid: device for device in devices}
return self.device_manager
async def get_device(self, device_id: str) -> RoborockDevice:
"""Get a device by ID, creating connections if needed."""
await self.ensure_device_manager()
if device_id not in self._devices:
raise RoborockException(f"Device {device_id} not found")
return self._devices[device_id]
async def close(self):
"""Close device manager connections."""
if self.device_manager:
await self.device_manager.close()
self.device_manager = None
self._devices = {}
class RoborockContext(Cache):
"""Context that handles both CLI and session modes internally."""
roborock_file = Path("~/.roborock").expanduser()
_cache_data: ConnectionCache | None = None
def __init__(self):
self.reload()
self._session_loop: asyncio.AbstractEventLoop | None = None
self._session_thread: threading.Thread | None = None
self._device_manager: DeviceConnectionManager | None = None
def reload(self):
if self.roborock_file.is_file():
with open(self.roborock_file) as f:
data = json.load(f)
if data:
self._cache_data = ConnectionCache.from_dict(data)
def update(self, cache_data: ConnectionCache):
data = json.dumps(cache_data.as_dict(), default=vars, indent=4)
with open(self.roborock_file, "w") as f:
f.write(data)
self.reload()
def validate(self):
if self._cache_data is None:
raise RoborockException("You must login first")
def cache_data(self) -> ConnectionCache:
"""Get the cache data."""
self.validate()
return cast(ConnectionCache, self._cache_data)
def start_session_mode(self):
"""Start session mode with a background event loop."""
if self._session_loop is not None:
return # Already started
self._session_loop = asyncio.new_event_loop()
self._session_thread = threading.Thread(target=self._run_session_loop)
self._session_thread.daemon = True
self._session_thread.start()
def _run_session_loop(self):
"""Run the session event loop in a background thread."""
assert self._session_loop is not None # guaranteed by start_session_mode
asyncio.set_event_loop(self._session_loop)
self._session_loop.run_forever()
def is_session_mode(self) -> bool:
return self._session_loop is not None
def run_in_session(self, coro):
"""Run a coroutine in the session loop (session mode only)."""
if not self._session_loop:
raise RoborockException("Not in session mode")
future = asyncio.run_coroutine_threadsafe(coro, self._session_loop)
return future.result()
async def get_device_manager(self) -> DeviceConnectionManager:
"""Get device manager, creating if needed."""
await self.get_devices()
if self._device_manager is None:
self._device_manager = DeviceConnectionManager(self, self._session_loop)
return self._device_manager
async def refresh_devices(self) -> ConnectionCache:
"""Refresh device data from server (always fetches fresh data)."""
cache_data = self.cache_data()
client = RoborockApiClient(cache_data.email)
home_data = await client.get_home_data_v3(cache_data.user_data)
cache_data.home_data = home_data
self.update(cache_data)
return cache_data
async def get_devices(self) -> ConnectionCache:
"""Get device data (uses cache if available, fetches if needed)."""
cache_data = self.cache_data()
if not cache_data.home_data:
cache_data = await self.refresh_devices()
return cache_data
async def cleanup(self):
"""Clean up resources (mainly for session mode)."""
if self._device_manager:
await self._device_manager.close()
self._device_manager = None
# Stop session loop if running
if self._session_loop:
self._session_loop.call_soon_threadsafe(self._session_loop.stop)
if self._session_thread:
self._session_thread.join(timeout=5.0)
self._session_loop = None
self._session_thread = None
def finish_session(self) -> None:
"""Finish the session and clean up resources."""
if self._session_loop:
future = asyncio.run_coroutine_threadsafe(self.cleanup(), self._session_loop)
future.result(timeout=5.0)
async def get(self) -> CacheData:
"""Get cached value."""
connection_cache = self.cache_data()
return CacheData(home_data=connection_cache.home_data, network_info=connection_cache.network_info or {})
async def set(self, value: CacheData) -> None:
"""Set value in the cache."""
connection_cache = self.cache_data()
connection_cache.home_data = value.home_data
connection_cache.network_info = value.network_info
self.update(connection_cache)
@click.option("-d", "--debug", default=False, count=True)
@click.version_option(package_name="python-roborock")
@click.group()
@click.pass_context
def cli(ctx, debug: int):
logging_config: dict[str, Any] = {"level": logging.DEBUG if debug > 0 else logging.INFO}
logging.basicConfig(**logging_config) # type: ignore
ctx.obj = RoborockContext()
@click.command()
@click.option("--email", 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
@async_command
async def login(ctx, email, password):
"""Login to Roborock account."""
context: RoborockContext = ctx.obj
try:
context.validate()
_LOGGER.info("Already logged in")
return
except RoborockException:
pass
client = RoborockApiClient(email)
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(ConnectionCache(user_data=user_data, email=email))
def _shell_session_finished(ctx):
"""Callback for when shell session finishes."""
context: RoborockContext = ctx.obj
try:
context.finish_session()
except Exception as e:
click.echo(f"Error during cleanup: {e}", err=True)
click.echo("Session finished")
@click_shell.shell(
prompt="roborock> ",
on_finished=_shell_session_finished,
)
@click.pass_context
def session(ctx):
"""Start an interactive session."""
context: RoborockContext = ctx.obj
# Start session mode with background loop
context.start_session_mode()
context.run_in_session(context.get_device_manager())
click.echo("OK")
@session.command()
@click.pass_context
@async_command
async def discover(ctx):
"""Discover devices."""
context: RoborockContext = ctx.obj
# Use the explicit refresh method for the discover command
cache_data = await context.refresh_devices()
home_data = cache_data.home_data
click.echo(f"Discovered devices {', '.join([device.name for device in home_data.get_all_devices()])}")
@session.command()
@click.pass_context
@async_command
async def list_devices(ctx):
context: RoborockContext = ctx.obj
cache_data = await context.get_devices()
home_data = cache_data.home_data
device_name_id = {device.name: device.duid for device in home_data.get_all_devices()}
click.echo(json.dumps(device_name_id, indent=4))
@click.command()
@click.option("--device_id", required=True)
@click.pass_context
@async_command
async def list_scenes(ctx, device_id):
context: RoborockContext = ctx.obj
cache_data = await context.get_devices()
client = RoborockApiClient(cache_data.email)
scenes = await client.get_scenes(cache_data.user_data, device_id)
output_list = []
for scene in scenes:
output_list.append(scene.as_dict())
click.echo(json.dumps(output_list, indent=4))
@click.command()
@click.option("--scene_id", required=True)
@click.pass_context
@async_command
async def execute_scene(ctx, scene_id):
context: RoborockContext = ctx.obj
cache_data = await context.get_devices()
client = RoborockApiClient(cache_data.email)
await client.execute_scene(cache_data.user_data, scene_id)
async def _v1_trait(context: RoborockContext, device_id: str, display_func: Callable[[], V1TraitMixin]) -> Trait:
device_manager = await context.get_device_manager()
device = await device_manager.get_device(device_id)
if device.v1_properties is None:
raise RoborockException(f"Device {device.name} does not support V1 protocol")
trait = display_func(device.v1_properties)
await trait.refresh()
return trait
async def _display_v1_trait(context: RoborockContext, device_id: str, display_func: Callable[[], Trait]) -> None:
trait = await _v1_trait(context, device_id, display_func)
click.echo(dump_json(trait.as_dict()))
@session.command()
@click.option("--device_id", required=True)
@click.pass_context
@async_command
async def status(ctx, device_id: str):
"""Get device status."""
context: RoborockContext = ctx.obj
await _display_v1_trait(context, device_id, lambda v1: v1.status)
@session.command()
@click.option("--device_id", required=True)
@click.pass_context
@async_command
async def clean_summary(ctx, device_id: str):
"""Get device clean summary."""
context: RoborockContext = ctx.obj
await _display_v1_trait(context, device_id, lambda v1: v1.clean_summary)
@session.command()
@click.option("--device_id", required=True)
@click.pass_context
@async_command
async def volume(ctx, device_id: str):
"""Get device volume."""
context: RoborockContext = ctx.obj
await _display_v1_trait(context, device_id, lambda v1: v1.sound_volume)
@session.command()
@click.option("--device_id", required=True)
@click.option("--volume", required=True, type=int)
@click.pass_context
@async_command
async def set_volume(ctx, device_id: str, volume: int):
"""Set the devicevolume."""
context: RoborockContext = ctx.obj
volume_trait = await _v1_trait(context, device_id, lambda v1: v1.sound_volume)
await volume_trait.set_volume(volume)
click.echo(f"Set Device {device_id} volume to {volume}")
@click.command()
@click.option("--device_id", required=True)
@click.option("--cmd", required=True)
@click.option("--params", required=False)
@click.pass_context
@async_command
async def command(ctx, cmd, device_id, params):
context: RoborockContext = ctx.obj
cache_data = await context.get_devices()
home_data = cache_data.home_data
devices = home_data.get_all_devices()
device = next(device for device in devices if device.duid == device_id)
model = next(
(product.model for product in home_data.products if device is not None and product.id == device.product_id),
None,
)
if model is None:
raise RoborockException(f"Could not find model for device {device.name}")
device_info = DeviceData(device=device, model=model)
mqtt_client = RoborockMqttClientV1(cache_data.user_data, device_info)
await mqtt_client.send_command(cmd, json.loads(params) if params is not None else None)
await mqtt_client.async_release()
@click.command()
@click.option("--local_key", required=True)
@click.option("--device_ip", required=True)
@click.option("--file", required=False)
@click.pass_context
@async_command
async def parser(_, local_key, device_ip, file):
file_provided = file is not None
if file_provided:
capture = FileCapture(file)
else:
_LOGGER.info("Listen for interface rvi0 since no file was provided")
capture = LiveCapture(interface="rvi0")
buffer = {"data": b""}
def on_package(packet: Packet):
if hasattr(packet, "ip"):
if packet.transport_layer == "TCP" and (packet.ip.dst == device_ip or packet.ip.src == device_ip):
if hasattr(packet, "DATA"):
if hasattr(packet.DATA, "data"):
if packet.ip.dst == device_ip:
try:
f, buffer["data"] = MessageParser.parse(
buffer["data"] + bytes.fromhex(packet.DATA.data),
local_key,
)
print(f"Received request: {f}")
except BaseException as e:
print(e)
pass
elif packet.ip.src == device_ip:
try:
f, buffer["data"] = MessageParser.parse(
buffer["data"] + bytes.fromhex(packet.DATA.data),
local_key,
)
print(f"Received response: {f}")
except BaseException as e:
print(e)
pass
try:
await capture.packets_from_tshark(on_package, close_tshark=not file_provided)
except UnknownInterfaceException:
raise RoborockException(
"You need to run 'rvictl -s XXXXXXXX-XXXXXXXXXXXXXXXX' first, with an iPhone connected to usb port"
)
@click.command()
@click.pass_context
@async_command
async def get_device_info(ctx: click.Context):
"""
Connects to devices and prints their feature information in YAML format.
"""
click.echo("Discovering devices...")
context: RoborockContext = ctx.obj
cache_data = await context.get_devices()
home_data = cache_data.home_data
all_devices = home_data.get_all_devices()
if not all_devices:
click.echo("No devices found.")
return
click.echo(f"Found {len(all_devices)} devices. Fetching data...")
all_products_data = {}
for device in all_devices:
click.echo(f" - Processing {device.name} ({device.duid})")
product_info = home_data.product_map[device.product_id]
device_data = DeviceData(device, product_info.model)
mqtt_client = RoborockMqttClientV1(cache_data.user_data, device_data)
try:
init_status_result = await mqtt_client.send_command(
RoborockCommand.APP_GET_INIT_STATUS,
)
product_nickname = SHORT_MODEL_TO_ENUM.get(product_info.model.split(".")[-1]).name
current_product_data = {
"Protocol Version": device.pv,
"Product Nickname": product_nickname,
"New Feature Info": init_status_result.get("new_feature_info"),
"New Feature Info Str": init_status_result.get("new_feature_info_str"),
"Feature Info": init_status_result.get("feature_info"),
}
all_products_data[product_info.model] = current_product_data
except Exception as e:
click.echo(f" - Error processing device {device.name}: {e}", err=True)
finally:
await mqtt_client.async_release()
if all_products_data:
click.echo("\n--- Device Information (copy to your YAML file) ---\n")
# Use yaml.dump to print in a clean, copy-paste friendly format
click.echo(yaml.dump(all_products_data, sort_keys=False))
@click.command()
@click.option("--data-file", default="../device_info.yaml", help="Path to the YAML file with device feature data.")
@click.option("--output-file", default="../SUPPORTED_FEATURES.md", help="Path to the output markdown file.")
def update_docs(data_file: str, output_file: str):
"""
Generates a markdown file by processing raw feature data from a YAML file.
"""
data_path = Path(data_file)
output_path = Path(output_file)
if not data_path.exists():
click.echo(f"Error: Data file not found at '{data_path}'", err=True)
return
click.echo(f"Loading data from {data_path}...")
with open(data_path, encoding="utf-8") as f:
product_data_from_yaml = yaml.safe_load(f)
if not product_data_from_yaml:
click.echo("No data found in YAML file. Exiting.", err=True)
return
product_features_map = {}
all_feature_names = set()
# Process the raw data from YAML to build the feature map
for model, data in product_data_from_yaml.items():
# Reconstruct the DeviceFeatures object from the raw data in the YAML file
device_features = DeviceFeatures.from_feature_flags(
new_feature_info=data.get("New Feature Info"),
new_feature_info_str=data.get("New Feature Info Str"),
feature_info=data.get("Feature Info"),
product_nickname=data.get("Product Nickname"),
)
features_dict = asdict(device_features)
# This dictionary will hold the final data for the markdown table row
current_product_data = {
"Product Nickname": data.get("Product Nickname", ""),
"Protocol Version": data.get("Protocol Version", ""),
"New Feature Info": data.get("New Feature Info", ""),
"New Feature Info Str": data.get("New Feature Info Str", ""),
}
# Populate features from the calculated DeviceFeatures object
for feature, is_supported in features_dict.items():
all_feature_names.add(feature)
if is_supported:
current_product_data[feature] = "X"
supported_codes = data.get("Feature Info", [])
if isinstance(supported_codes, list):
for code in supported_codes:
feature_name = str(code)
all_feature_names.add(feature_name)
current_product_data[feature_name] = "X"
product_features_map[model] = current_product_data
# --- Helper function to write the markdown table ---
def write_markdown_table(product_features: dict[str, dict[str, any]], all_features: set[str]):
"""Writes the data into a markdown table (products as columns)."""
sorted_products = sorted(product_features.keys())
special_rows = [
"Product Nickname",
"Protocol Version",
"New Feature Info",
"New Feature Info Str",
]
# Regular features are the remaining keys, sorted alphabetically
# We filter out the special rows to avoid duplicating them.
sorted_features = sorted(list(all_features - set(special_rows)))
header = ["Feature"] + sorted_products
click.echo(f"Writing documentation to {output_path}...")
with open(output_path, "w", encoding="utf-8") as f:
f.write("| " + " | ".join(header) + " |\n")
f.write("|" + "---|" * len(header) + "\n")
# Write the special metadata rows first
for row_name in special_rows:
row_values = [str(product_features[p].get(row_name, "")) for p in sorted_products]
f.write("| " + " | ".join([row_name] + row_values) + " |\n")
# Write the feature rows
for feature in sorted_features:
# Use backticks for feature names that are just numbers (from the list)
display_feature = f"`{feature}`"
feature_row = [display_feature]
for product in sorted_products:
# Use .get() to place an 'X' or an empty string
feature_row.append(product_features[product].get(feature, ""))
f.write("| " + " | ".join(feature_row) + " |\n")
write_markdown_table(product_features_map, all_feature_names)
click.echo("Done.")
cli.add_command(login)
cli.add_command(discover)
cli.add_command(list_devices)
cli.add_command(list_scenes)
cli.add_command(execute_scene)
cli.add_command(status)
cli.add_command(command)
cli.add_command(parser)
cli.add_command(session)
cli.add_command(get_device_info)
cli.add_command(update_docs)
cli.add_command(clean_summary)
cli.add_command(volume)
cli.add_command(set_volume)
def main():
return cli()
if __name__ == "__main__":
main()
|