|
| 1 | +"""Roborock V1 Protocol Encoder.""" |
| 2 | + |
| 3 | +from __future__ import annotations |
| 4 | + |
| 5 | +import json |
| 6 | +import math |
| 7 | +import time |
| 8 | +from collections.abc import Callable |
| 9 | +from dataclasses import dataclass, field |
| 10 | +from typing import Any |
| 11 | + |
| 12 | +from roborock.roborock_message import MessageRetry, RoborockMessage, RoborockMessageProtocol |
| 13 | +from roborock.roborock_typing import RoborockCommand |
| 14 | +from roborock.util import get_next_int |
| 15 | + |
| 16 | +CommandType = RoborockCommand | str |
| 17 | +ParamsType = list | dict | int | None |
| 18 | + |
| 19 | + |
| 20 | +@dataclass(frozen=True, kw_only=True) |
| 21 | +class SecurityData: |
| 22 | + """Security data included in the request for some V1 commands.""" |
| 23 | + |
| 24 | + endpoint: str |
| 25 | + nonce: bytes |
| 26 | + |
| 27 | + def to_dict(self) -> dict[str, Any]: |
| 28 | + """Convert security data to a dictionary for sending in the payload.""" |
| 29 | + return {"security": {"endpoint": self.endpoint, "nonce": self.nonce.hex().lower()}} |
| 30 | + |
| 31 | + |
| 32 | +@dataclass |
| 33 | +class RequestMessage: |
| 34 | + """Data structure for v1 RoborockMessage payloads.""" |
| 35 | + |
| 36 | + method: RoborockCommand | str |
| 37 | + params: ParamsType |
| 38 | + timestamp: int = field(default_factory=lambda: math.floor(time.time())) |
| 39 | + request_id: int = field(default_factory=lambda: get_next_int(10000, 32767)) |
| 40 | + |
| 41 | + def as_payload(self, security_data: SecurityData | None) -> bytes: |
| 42 | + """Convert the request arguments to a dictionary.""" |
| 43 | + inner = { |
| 44 | + "id": self.request_id, |
| 45 | + "method": self.method, |
| 46 | + "params": self.params or [], |
| 47 | + **(security_data.to_dict() if security_data else {}), |
| 48 | + } |
| 49 | + return bytes( |
| 50 | + json.dumps( |
| 51 | + { |
| 52 | + "dps": {"101": json.dumps(inner, separators=(",", ":"))}, |
| 53 | + "t": self.timestamp, |
| 54 | + }, |
| 55 | + separators=(",", ":"), |
| 56 | + ).encode() |
| 57 | + ) |
| 58 | + |
| 59 | + |
| 60 | +def create_mqtt_payload_encoder(security_data: SecurityData) -> Callable[[CommandType, ParamsType], RoborockMessage]: |
| 61 | + """Create a payload encoder for V1 commands over MQTT.""" |
| 62 | + |
| 63 | + def _get_payload(method: CommandType, params: ParamsType) -> RoborockMessage: |
| 64 | + """Build the payload for a V1 command.""" |
| 65 | + request = RequestMessage(method=method, params=params) |
| 66 | + payload = request.as_payload(security_data) # always secure |
| 67 | + return RoborockMessage( |
| 68 | + timestamp=request.timestamp, |
| 69 | + protocol=RoborockMessageProtocol.RPC_REQUEST, |
| 70 | + payload=payload, |
| 71 | + ) |
| 72 | + |
| 73 | + return _get_payload |
| 74 | + |
| 75 | + |
| 76 | +def encode_local_payload(method: CommandType, params: ParamsType) -> RoborockMessage: |
| 77 | + """Encode payload for V1 commands over local connection.""" |
| 78 | + |
| 79 | + request = RequestMessage(method=method, params=params) |
| 80 | + payload = request.as_payload(security_data=None) |
| 81 | + |
| 82 | + message_retry: MessageRetry | None = None |
| 83 | + if method == RoborockCommand.RETRY_REQUEST and isinstance(params, dict): |
| 84 | + message_retry = MessageRetry(method=method, retry_id=params["retry_id"]) |
| 85 | + |
| 86 | + return RoborockMessage( |
| 87 | + timestamp=request.timestamp, |
| 88 | + protocol=RoborockMessageProtocol.GENERAL_REQUEST, |
| 89 | + payload=payload, |
| 90 | + message_retry=message_retry, |
| 91 | + ) |
0 commit comments