Skip to content

Commit d244532

Browse files
committed
feat: add V1 smart wash params setter
1 parent fbea2bb commit d244532

6 files changed

Lines changed: 265 additions & 20 deletions

File tree

‎docs/V1_API_COMMANDS.md‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -718,48 +718,48 @@ Parameters:
718718

719719
### get_smart_wash_params
720720

721-
Description: Returns the smartwash parameters
721+
Description: Returns when the dock washes the mop during a clean (app: mop wash frequency)
722722

723723
Parameters: None
724724

725-
<!--
726-
Not clear what this does
727-
-->
728-
729725
Returns:
730726

731-
smart_wash: 0 is off, 1 is on
727+
smart_wash: 0 by time, 1 by room, 2 new smart (only on devices with is_back_wash_new_smart_supported)
732728

733-
wash_interval: The interval in seconds between washes
729+
wash_interval: The interval in seconds between washes when washing by time (app offers 600, 900, 1200, 1500; 600 to 3000 in steps of 300 on TopazS, TopazSV, TopazSPlus, TopazSC, TopazSPower and UltronSPlus)
734730

735731
Example:
736732

737733
```json
738-
{'smart_wash': 0, 'wash_interval': 1200}
734+
{'smart_wash': 1, 'wash_interval': 1200}
739735
```
740736

737+
Source: Roborock Saros 10R
741738

742739
**Supported devices:**
743740

744741
* Roborock S8 Pro Ultra: ✅
742+
* Roborock Saros 10R: ✅
745743

746744
### set_smart_wash_params
747745

748-
Description: Sets the smartwash parameters
746+
Description: Sets when the dock washes the mop during a clean
749747

750748
Parameters:
751749

752-
smart_wash: 0 is off, 1 is on
750+
smart_wash: 0 by time, 1 by room, 2 new smart (only on devices with is_back_wash_new_smart_supported)
753751

754-
wash_interval: The interval in seconds between washes
752+
wash_interval: The interval in seconds between washes when washing by time: 600, 900, 1200 or 1500; 600 to 3000 in steps of 300 on TopazS, TopazSV, TopazSPlus, TopazSC, TopazSPower and UltronSPlus
755753

756754

757-
`{'smart_wash': 0, 'wash_interval': 1200}`
755+
`{'smart_wash': 1, 'wash_interval': 1200}`
758756

757+
Source: Roborock Saros 10R, Roborock app plugin
759758

760759
**Supported devices:**
761760

762761
* Roborock S8 Pro Ultra: ✅
762+
* Roborock Saros 10R: ✅
763763

764764
## Cleaning history
765765

‎roborock/data/v1/v1_code_mappings.py‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -438,6 +438,15 @@ class RoborockDockCleaningFluidCode(RoborockEnum):
438438
large = 3
439439

440440

441+
class RoborockDockSmartWashModeCode(RoborockEnum):
442+
"""Describes when the dock washes the mop during a clean (app: mop wash frequency)."""
443+
444+
unknown = -1
445+
by_time = 0
446+
by_room = 1
447+
new_smart = 2
448+
449+
441450
class RoborockStateCode(RoborockEnum):
442451
unknown = 0
443452
starting = 1

‎roborock/data/v1/v1_containers.py‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@
3131
RoborockDockDustCollectionFrequencyCode,
3232
RoborockDockDustCollectionModeCode,
3333
RoborockDockErrorCode,
34+
RoborockDockSmartWashModeCode,
3435
RoborockDockState,
3536
RoborockDockTypeCode,
3637
RoborockDockWashWaterTemperatureCode,
@@ -482,8 +483,9 @@ class MultiMapsList(RoborockBase):
482483

483484
@dataclass
484485
class SmartWashParams(RoborockBase):
485-
smart_wash: int | None = None
486+
smart_wash: RoborockDockSmartWashModeCode | None = None
486487
wash_interval: int | None = None
488+
"""Seconds between mop washes when washing by time."""
487489

488490

489491
@dataclass

‎roborock/devices/traits/v1/__init__.py‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -306,6 +306,13 @@ async def discover_features(self) -> None:
306306
wash_towel_mode._rpc_channel = self._get_rpc_channel(wash_towel_mode) # type: ignore[assignment]
307307
self.wash_towel_mode = wash_towel_mode
308308

309+
if self.smart_wash_params is None and self._is_supported(
310+
SmartWashParamsTrait, "smart_wash_params", dock_features
311+
):
312+
smart_wash_params = SmartWashParamsTrait(self.device_features, self._product.product_nickname)
313+
smart_wash_params._rpc_channel = self._get_rpc_channel(smart_wash_params) # type: ignore[assignment]
314+
self.smart_wash_params = smart_wash_params
315+
309316
# The wash water temperature needs a washing dock, a device that can heat wash water,
310317
# and a product and dock for which the app shows it.
311318
if (
Lines changed: 55 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,71 @@
11
"""Trait for smart wash parameters."""
22

3-
from roborock.data import SmartWashParams
3+
from roborock.data import RoborockDockSmartWashModeCode, RoborockProductNickname, SmartWashParams
44
from roborock.device_features import RoborockDockFeatures
55
from roborock.devices.traits.v1 import common
6+
from roborock.devices.traits.v1.device_features import DeviceFeaturesTrait
7+
from roborock.exceptions import RoborockUnsupportedFeature
68
from roborock.roborock_typing import RoborockCommand
79

10+
# Products the app gives a 10 to 50 minute slider instead of the four interval buttons
11+
_OLD_WASH_FREQUENCY_PRODUCTS = {
12+
RoborockProductNickname.TOPAZS,
13+
RoborockProductNickname.TOPAZSV,
14+
RoborockProductNickname.TOPAZSPLUS,
15+
RoborockProductNickname.TOPAZSC,
16+
RoborockProductNickname.TOPAZSPOWER,
17+
RoborockProductNickname.ULTRONSPLUS,
18+
}
19+
20+
21+
def get_wash_interval_options(product_nickname: RoborockProductNickname) -> list[int]:
22+
"""Return the mop wash intervals in seconds the app offers for a product.
23+
24+
Older products get 10 to 50 minutes in 5 minute steps; all others 10, 15, 20 and 25 minutes.
25+
"""
26+
if product_nickname in _OLD_WASH_FREQUENCY_PRODUCTS:
27+
return list(range(600, 3001, 300))
28+
return [600, 900, 1200, 1500]
29+
830

931
def _supports_smart_wash_params(dock_features: RoborockDockFeatures) -> bool:
1032
return dock_features.is_washable
1133

1234

1335
class SmartWashParamsTrait(SmartWashParams, common.V1TraitMixin):
14-
"""Trait for smart wash parameters."""
36+
"""When the dock washes the mop during a clean (app: mop wash frequency)."""
1537

1638
command = RoborockCommand.GET_SMART_WASH_PARAMS
1739
converter = common.DefaultConverter(SmartWashParams)
1840
requires_dock_features = _supports_smart_wash_params
41+
42+
def __init__(self, device_feature_trait: DeviceFeaturesTrait, product_nickname: RoborockProductNickname) -> None:
43+
super().__init__()
44+
self.device_feature_trait = device_feature_trait
45+
self.product_nickname = product_nickname
46+
47+
@property
48+
def smart_wash_mode_options(self) -> list[RoborockDockSmartWashModeCode]:
49+
"""Return the mop wash modes offered by the device."""
50+
options = [RoborockDockSmartWashModeCode.by_time, RoborockDockSmartWashModeCode.by_room]
51+
if self.device_feature_trait.is_back_wash_new_smart_supported:
52+
options.append(RoborockDockSmartWashModeCode.new_smart)
53+
return options
54+
55+
@property
56+
def wash_interval_options(self) -> list[int]:
57+
"""Return the mop wash intervals in seconds offered by the app."""
58+
return get_wash_interval_options(self.product_nickname)
59+
60+
async def set_smart_wash_params(self, mode: RoborockDockSmartWashModeCode, wash_interval: int) -> None:
61+
"""Set the mop wash mode and the interval in seconds used when washing by time."""
62+
if mode not in self.smart_wash_mode_options:
63+
raise RoborockUnsupportedFeature(f"Smart wash mode {mode.name} is not supported")
64+
if wash_interval not in self.wash_interval_options:
65+
raise RoborockUnsupportedFeature(f"Wash interval {wash_interval} is not supported")
66+
await self.rpc_channel.send_command(
67+
RoborockCommand.SET_SMART_WASH_PARAMS, params={"smart_wash": mode.value, "wash_interval": wash_interval}
68+
)
69+
# Optimistic update to avoid an extra refresh
70+
self.smart_wash = mode
71+
self.wash_interval = wash_interval

‎tests/devices/traits/v1/test_smart_wash_params.py‎

Lines changed: 179 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,69 @@
1-
"""Tests for the DockSummaryTrait class."""
1+
"""Tests for the SmartWashParamsTrait class."""
22

33
from unittest.mock import AsyncMock, call
44

55
import pytest
66

7+
from roborock.data import RoborockDockSmartWashModeCode, RoborockProductNickname
78
from roborock.data.v1.v1_code_mappings import (
89
RoborockDockTypeCode,
910
)
1011
from roborock.devices.device import RoborockDevice
11-
from roborock.devices.traits.v1.smart_wash_params import SmartWashParamsTrait
12+
from roborock.devices.traits.v1.smart_wash_params import SmartWashParamsTrait, get_wash_interval_options
13+
from roborock.exceptions import RoborockException, RoborockUnsupportedFeature
1214
from roborock.roborock_typing import RoborockCommand
1315
from tests.devices.traits.v1.helpers import dock_types_with_capability
1416

15-
SMART_WASH_DATA = [{"smart_wash": 5, "wash_interval": 6}]
17+
# Saros 10R: wash the mop after every room, interval 1200 s kept for the time mode
18+
SMART_WASH_DATA = [{"smart_wash": 1, "wash_interval": 1200}]
19+
SAROS_10R_DOCK = RoborockDockTypeCode.shell_3s_dock
20+
# 10 to 50 minutes in 5 minute steps
21+
OLD_WASH_INTERVALS = [600, 900, 1200, 1500, 1800, 2100, 2400, 2700, 3000]
22+
23+
24+
@pytest.fixture(name="product_model")
25+
def product_model_fixture() -> str:
26+
"""Default to the Saros 10R, which has the four interval buttons."""
27+
return "roborock.vacuum.a144"
28+
29+
30+
@pytest.mark.parametrize(
31+
("product_nickname", "expected"),
32+
[
33+
(RoborockProductNickname.CORALPRO, [600, 900, 1200, 1500]), # Saros 10R
34+
(RoborockProductNickname.PEARLPLUS, [600, 900, 1200, 1500]),
35+
(RoborockProductNickname.TOPAZS, OLD_WASH_INTERVALS),
36+
(RoborockProductNickname.TOPAZSV, OLD_WASH_INTERVALS),
37+
(RoborockProductNickname.TOPAZSPLUS, OLD_WASH_INTERVALS),
38+
(RoborockProductNickname.TOPAZSC, OLD_WASH_INTERVALS),
39+
(RoborockProductNickname.TOPAZSPOWER, OLD_WASH_INTERVALS),
40+
(RoborockProductNickname.ULTRONSPLUS, OLD_WASH_INTERVALS),
41+
],
42+
)
43+
def test_get_wash_interval_options(product_nickname: RoborockProductNickname, expected: list[int]) -> None:
44+
"""Test the wash intervals offered for each product."""
45+
assert get_wash_interval_options(product_nickname) == expected
46+
47+
48+
@pytest.mark.parametrize(("product_model"), ["roborock.vacuum.a27"]) # S7 MaxV (TopazSV)
49+
@pytest.mark.parametrize(("dock_type_code"), [RoborockDockTypeCode.o6_dock])
50+
async def test_old_product_wash_intervals(
51+
smart_wash_params: SmartWashParamsTrait | None,
52+
mock_rpc_channel: AsyncMock,
53+
product_model: str,
54+
dock_type_code: RoborockDockTypeCode,
55+
) -> None:
56+
"""Test that an older product offers and accepts the longer wash intervals."""
57+
assert smart_wash_params is not None
58+
assert smart_wash_params.wash_interval_options == OLD_WASH_INTERVALS
59+
60+
await smart_wash_params.set_smart_wash_params(RoborockDockSmartWashModeCode.by_time, 3000)
61+
62+
mock_rpc_channel.send_command.assert_called_once_with(
63+
RoborockCommand.SET_SMART_WASH_PARAMS, params={"smart_wash": 0, "wash_interval": 3000}
64+
)
65+
with pytest.raises(RoborockUnsupportedFeature):
66+
await smart_wash_params.set_smart_wash_params(RoborockDockSmartWashModeCode.by_time, 3300)
1667

1768

1869
@pytest.fixture(name="smart_wash_params")
@@ -53,8 +104,8 @@ async def test_smart_wash_available(
53104
)
54105

55106
# Verify the summary object contains the traits
56-
assert smart_wash_params.smart_wash == 5
57-
assert smart_wash_params.wash_interval == 6
107+
assert smart_wash_params.smart_wash == RoborockDockSmartWashModeCode.by_room
108+
assert smart_wash_params.wash_interval == 1200
58109

59110

60111
@pytest.mark.parametrize(
@@ -66,3 +117,126 @@ async def test_unsupported_smart_wash_params(
66117
) -> None:
67118
"""Test successfully refreshing the dock summary."""
68119
assert smart_wash_params is None
120+
121+
122+
@pytest.mark.parametrize(("dock_type_code"), [SAROS_10R_DOCK])
123+
async def test_refresh_unknown_code(
124+
smart_wash_params: SmartWashParamsTrait | None,
125+
mock_rpc_channel: AsyncMock,
126+
dock_type_code: RoborockDockTypeCode,
127+
) -> None:
128+
"""Test that refresh tolerates an unknown smart wash mode code."""
129+
assert smart_wash_params is not None
130+
mock_rpc_channel.send_command.side_effect = [[{"smart_wash": 7, "wash_interval": 1200}]]
131+
132+
await smart_wash_params.refresh()
133+
134+
assert smart_wash_params.smart_wash == RoborockDockSmartWashModeCode.unknown
135+
assert smart_wash_params.wash_interval == 1200
136+
137+
138+
@pytest.mark.parametrize(("dock_type_code"), [SAROS_10R_DOCK])
139+
@pytest.mark.parametrize(
140+
("new_smart_supported", "expected"),
141+
[
142+
(False, [RoborockDockSmartWashModeCode.by_time, RoborockDockSmartWashModeCode.by_room]),
143+
(
144+
True,
145+
[
146+
RoborockDockSmartWashModeCode.by_time,
147+
RoborockDockSmartWashModeCode.by_room,
148+
RoborockDockSmartWashModeCode.new_smart,
149+
],
150+
),
151+
],
152+
)
153+
async def test_smart_wash_mode_options(
154+
device: RoborockDevice,
155+
smart_wash_params: SmartWashParamsTrait | None,
156+
dock_type_code: RoborockDockTypeCode,
157+
new_smart_supported: bool,
158+
expected: list[RoborockDockSmartWashModeCode],
159+
) -> None:
160+
"""Test that the new smart mode is offered only with its device feature."""
161+
assert device.v1_properties
162+
assert smart_wash_params is not None
163+
device.v1_properties.device_features.is_back_wash_new_smart_supported = new_smart_supported
164+
165+
assert smart_wash_params.smart_wash_mode_options == expected
166+
assert smart_wash_params.wash_interval_options == [600, 900, 1200, 1500]
167+
168+
169+
@pytest.mark.parametrize(("dock_type_code"), [SAROS_10R_DOCK])
170+
@pytest.mark.parametrize(
171+
("mode", "wash_interval"),
172+
[
173+
(RoborockDockSmartWashModeCode.by_room, 1200),
174+
(RoborockDockSmartWashModeCode.by_time, 900),
175+
(RoborockDockSmartWashModeCode.by_time, 600),
176+
(RoborockDockSmartWashModeCode.by_time, 1500),
177+
],
178+
)
179+
async def test_set_smart_wash_params(
180+
smart_wash_params: SmartWashParamsTrait | None,
181+
mock_rpc_channel: AsyncMock,
182+
dock_type_code: RoborockDockTypeCode,
183+
mode: RoborockDockSmartWashModeCode,
184+
wash_interval: int,
185+
) -> None:
186+
"""Test setting an offered smart wash mode and interval."""
187+
assert smart_wash_params is not None
188+
189+
await smart_wash_params.set_smart_wash_params(mode, wash_interval)
190+
191+
mock_rpc_channel.send_command.assert_called_once_with(
192+
RoborockCommand.SET_SMART_WASH_PARAMS, params={"smart_wash": mode.value, "wash_interval": wash_interval}
193+
)
194+
assert smart_wash_params.smart_wash == mode
195+
assert smart_wash_params.wash_interval == wash_interval
196+
197+
198+
@pytest.mark.parametrize(("dock_type_code"), [SAROS_10R_DOCK])
199+
@pytest.mark.parametrize(
200+
("mode", "wash_interval"),
201+
[
202+
(RoborockDockSmartWashModeCode.new_smart, 1200),
203+
(RoborockDockSmartWashModeCode.unknown, 1200),
204+
(RoborockDockSmartWashModeCode.by_time, 1000),
205+
],
206+
)
207+
async def test_set_rejects_unoffered(
208+
device: RoborockDevice,
209+
smart_wash_params: SmartWashParamsTrait | None,
210+
mock_rpc_channel: AsyncMock,
211+
dock_type_code: RoborockDockTypeCode,
212+
mode: RoborockDockSmartWashModeCode,
213+
wash_interval: int,
214+
) -> None:
215+
"""Test that a mode or interval the device does not offer is rejected without sending."""
216+
assert device.v1_properties
217+
assert smart_wash_params is not None
218+
device.v1_properties.device_features.is_back_wash_new_smart_supported = False
219+
220+
with pytest.raises(RoborockUnsupportedFeature):
221+
await smart_wash_params.set_smart_wash_params(mode, wash_interval)
222+
223+
mock_rpc_channel.send_command.assert_not_called()
224+
225+
226+
@pytest.mark.parametrize(("dock_type_code"), [SAROS_10R_DOCK])
227+
async def test_set_failure_keeps_state(
228+
smart_wash_params: SmartWashParamsTrait | None,
229+
mock_rpc_channel: AsyncMock,
230+
dock_type_code: RoborockDockTypeCode,
231+
) -> None:
232+
"""Test that a failed command leaves the smart wash params unchanged."""
233+
assert smart_wash_params is not None
234+
smart_wash_params.smart_wash = RoborockDockSmartWashModeCode.by_room
235+
smart_wash_params.wash_interval = 1200
236+
mock_rpc_channel.send_command.side_effect = RoborockException("boom")
237+
238+
with pytest.raises(RoborockException):
239+
await smart_wash_params.set_smart_wash_params(RoborockDockSmartWashModeCode.by_time, 900)
240+
241+
assert smart_wash_params.smart_wash == RoborockDockSmartWashModeCode.by_room
242+
assert smart_wash_params.wash_interval == 1200

0 commit comments

Comments
 (0)