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
|
"""Create traits for A01 devices.
This module provides the API implementations for A01 protocol devices, which include
Dyad (Wet/Dry Vacuums) and Zeo (Washing Machines).
Using A01 APIs
--------------
A01 devices expose a single API object that handles all device interactions. This API is
available on the device instance (typically via `device.a01_properties`).
The API provides two main methods:
1. **query_values(protocols)**: Fetches current state for specific data points.
You must pass a list of protocol enums (e.g. `RoborockDyadDataProtocol` or
`RoborockZeoProtocol`) to request specific data.
2. **set_value(protocol, value)**: Sends a command to the device to change a setting
or perform an action.
Note that these APIs fetch data directly from the device upon request and do not
cache state internally.
"""
import json
from collections.abc import Callable
from datetime import time
from typing import Any
from roborock.data import DyadProductInfo, DyadSndState, HomeDataProduct, RoborockCategory
from roborock.data.dyad.dyad_code_mappings import (
DyadBrushSpeed,
DyadCleanMode,
DyadError,
DyadSelfCleanLevel,
DyadSelfCleanMode,
DyadSuction,
DyadWarmLevel,
DyadWaterLevel,
RoborockDyadStateCode,
)
from roborock.data.zeo.zeo_code_mappings import (
ZeoDetergentType,
ZeoDryingMode,
ZeoError,
ZeoMode,
ZeoProgram,
ZeoRinse,
ZeoSoftenerType,
ZeoSpin,
ZeoState,
ZeoTemperature,
)
from roborock.devices.rpc.a01_channel import send_decoded_command
from roborock.devices.traits import Trait
from roborock.devices.transport.mqtt_channel import MqttChannel
from roborock.roborock_message import RoborockDyadDataProtocol, RoborockZeoProtocol
__init__ = [
"DyadApi",
"ZeoApi",
]
DYAD_PROTOCOL_ENTRIES: dict[RoborockDyadDataProtocol, Callable] = {
RoborockDyadDataProtocol.STATUS: lambda val: RoborockDyadStateCode(val).name,
RoborockDyadDataProtocol.SELF_CLEAN_MODE: lambda val: DyadSelfCleanMode(val).name,
RoborockDyadDataProtocol.SELF_CLEAN_LEVEL: lambda val: DyadSelfCleanLevel(val).name,
RoborockDyadDataProtocol.WARM_LEVEL: lambda val: DyadWarmLevel(val).name,
RoborockDyadDataProtocol.CLEAN_MODE: lambda val: DyadCleanMode(val).name,
RoborockDyadDataProtocol.SUCTION: lambda val: DyadSuction(val).name,
RoborockDyadDataProtocol.WATER_LEVEL: lambda val: DyadWaterLevel(val).name,
RoborockDyadDataProtocol.BRUSH_SPEED: lambda val: DyadBrushSpeed(val).name,
RoborockDyadDataProtocol.POWER: lambda val: int(val),
RoborockDyadDataProtocol.AUTO_DRY: lambda val: bool(val),
RoborockDyadDataProtocol.MESH_LEFT: lambda val: int(360000 - val * 60),
RoborockDyadDataProtocol.BRUSH_LEFT: lambda val: int(360000 - val * 60),
RoborockDyadDataProtocol.ERROR: lambda val: DyadError(val).name,
RoborockDyadDataProtocol.VOLUME_SET: lambda val: int(val),
RoborockDyadDataProtocol.STAND_LOCK_AUTO_RUN: lambda val: bool(val),
RoborockDyadDataProtocol.AUTO_DRY_MODE: lambda val: bool(val),
RoborockDyadDataProtocol.SILENT_DRY_DURATION: lambda val: int(val), # in minutes
RoborockDyadDataProtocol.SILENT_MODE: lambda val: bool(val),
RoborockDyadDataProtocol.SILENT_MODE_START_TIME: lambda val: time(
hour=int(val / 60), minute=val % 60
), # in minutes since 00:00
RoborockDyadDataProtocol.SILENT_MODE_END_TIME: lambda val: time(
hour=int(val / 60), minute=val % 60
), # in minutes since 00:00
RoborockDyadDataProtocol.RECENT_RUN_TIME: lambda val: [
int(v) for v in val.split(",")
], # minutes of cleaning in past few days.
RoborockDyadDataProtocol.TOTAL_RUN_TIME: lambda val: int(val),
RoborockDyadDataProtocol.SND_STATE: lambda val: DyadSndState.from_dict(val),
RoborockDyadDataProtocol.PRODUCT_INFO: lambda val: DyadProductInfo.from_dict(val),
}
ZEO_PROTOCOL_ENTRIES: dict[RoborockZeoProtocol, Callable] = {
# read-only
RoborockZeoProtocol.STATE: lambda val: ZeoState(val).name,
RoborockZeoProtocol.COUNTDOWN: lambda val: int(val),
RoborockZeoProtocol.WASHING_LEFT: lambda val: int(val),
RoborockZeoProtocol.ERROR: lambda val: ZeoError(val).name,
RoborockZeoProtocol.TIMES_AFTER_CLEAN: lambda val: int(val),
RoborockZeoProtocol.DETERGENT_EMPTY: lambda val: bool(val),
RoborockZeoProtocol.SOFTENER_EMPTY: lambda val: bool(val),
# read-write
RoborockZeoProtocol.MODE: lambda val: ZeoMode(val).name,
RoborockZeoProtocol.PROGRAM: lambda val: ZeoProgram(val).name,
RoborockZeoProtocol.TEMP: lambda val: ZeoTemperature(val).name,
RoborockZeoProtocol.RINSE_TIMES: lambda val: ZeoRinse(val).name,
RoborockZeoProtocol.SPIN_LEVEL: lambda val: ZeoSpin(val).name,
RoborockZeoProtocol.DRYING_MODE: lambda val: ZeoDryingMode(val).name,
RoborockZeoProtocol.DETERGENT_TYPE: lambda val: ZeoDetergentType(val).name,
RoborockZeoProtocol.SOFTENER_TYPE: lambda val: ZeoSoftenerType(val).name,
RoborockZeoProtocol.SOUND_SET: lambda val: bool(val),
}
def convert_dyad_value(protocol_value: RoborockDyadDataProtocol, value: Any) -> Any:
"""Convert a dyad protocol value to its corresponding type."""
if (converter := DYAD_PROTOCOL_ENTRIES.get(protocol_value)) is not None:
try:
return converter(value)
except (ValueError, TypeError):
return None
return None
def convert_zeo_value(protocol_value: RoborockZeoProtocol, value: Any) -> Any:
"""Convert a zeo protocol value to its corresponding type."""
if (converter := ZEO_PROTOCOL_ENTRIES.get(protocol_value)) is not None:
try:
return converter(value)
except (ValueError, TypeError):
return None
return None
class DyadApi(Trait):
"""API for interacting with Dyad devices."""
def __init__(self, channel: MqttChannel) -> None:
"""Initialize the Dyad API."""
self._channel = channel
async def query_values(self, protocols: list[RoborockDyadDataProtocol]) -> dict[RoborockDyadDataProtocol, Any]:
"""Query the device for the values of the given Dyad protocols."""
response = await send_decoded_command(
self._channel,
{RoborockDyadDataProtocol.ID_QUERY: protocols},
value_encoder=json.dumps,
)
return {protocol: convert_dyad_value(protocol, response.get(protocol)) for protocol in protocols}
async def set_value(self, protocol: RoborockDyadDataProtocol, value: Any) -> dict[RoborockDyadDataProtocol, Any]:
"""Set a value for a specific protocol on the device."""
params = {protocol: value}
return await send_decoded_command(self._channel, params)
class ZeoApi(Trait):
"""API for interacting with Zeo devices."""
name = "zeo"
def __init__(self, channel: MqttChannel) -> None:
"""Initialize the Zeo API."""
self._channel = channel
async def query_values(self, protocols: list[RoborockZeoProtocol]) -> dict[RoborockZeoProtocol, Any]:
"""Query the device for the values of the given protocols."""
response = await send_decoded_command(
self._channel,
{RoborockZeoProtocol.ID_QUERY: protocols},
value_encoder=json.dumps,
)
return {protocol: convert_zeo_value(protocol, response.get(protocol)) for protocol in protocols}
async def set_value(self, protocol: RoborockZeoProtocol, value: Any) -> dict[RoborockZeoProtocol, Any]:
"""Set a value for a specific protocol on the device."""
params = {protocol: value}
return await send_decoded_command(self._channel, params, value_encoder=lambda x: x)
def create(product: HomeDataProduct, mqtt_channel: MqttChannel) -> DyadApi | ZeoApi:
"""Create traits for A01 devices."""
match product.category:
case RoborockCategory.WET_DRY_VAC:
return DyadApi(mqtt_channel)
case RoborockCategory.WASHING_MACHINE:
return ZeoApi(mqtt_channel)
case _:
raise NotImplementedError(f"Unsupported category {product.category}")
|
