Implement vacuum dustbin module (dust_bucket) (#1423)

Initial implementation for dustbin auto-emptying.

New features:
- `dustbin_empty` action to empty the dustbin immediately
- `dustbin_autocollection_enabled` to toggle the auto collection
- `dustbin_mode` to choose how often the auto collection is performed
This commit is contained in:
Teemu R.
2025-01-14 17:30:18 +01:00
committed by GitHub
parent 68f50aa763
commit 3c98efb015
8 changed files with 227 additions and 3 deletions

View File

@@ -640,7 +640,12 @@ class FakeSmartTransport(BaseTransport):
elif method[:3] == "set":
target_method = f"get{method[3:]}"
# Some vacuum commands do not have a getter
if method in ["setRobotPause", "setSwitchClean", "setSwitchCharge"]:
if method in [
"setRobotPause",
"setSwitchClean",
"setSwitchCharge",
"setSwitchDustCollection",
]:
return {"error_code": 0}
info[target_method].update(params)

View File

@@ -202,6 +202,10 @@
"getMopState": {
"mop_state": false
},
"getDustCollectionInfo": {
"auto_dust_collection": true,
"dust_collection_mode": 0
},
"getVacStatus": {
"err_status": [
0

View File

@@ -0,0 +1,92 @@
from __future__ import annotations
import pytest
from pytest_mock import MockerFixture
from kasa import Module
from kasa.smart import SmartDevice
from kasa.smart.modules.dustbin import Mode
from ...device_fixtures import get_parent_and_child_modules, parametrize
dustbin = parametrize(
"has dustbin", component_filter="dust_bucket", protocol_filter={"SMART"}
)
@dustbin
@pytest.mark.parametrize(
("feature", "prop_name", "type"),
[
("dustbin_autocollection_enabled", "auto_collection", bool),
("dustbin_mode", "mode", str),
],
)
async def test_features(dev: SmartDevice, feature: str, prop_name: str, type: type):
"""Test that features are registered and work as expected."""
dustbin = next(get_parent_and_child_modules(dev, Module.Dustbin))
assert dustbin is not None
prop = getattr(dustbin, prop_name)
assert isinstance(prop, type)
feat = dustbin._device.features[feature]
assert feat.value == prop
assert isinstance(feat.value, type)
@dustbin
async def test_dustbin_mode(dev: SmartDevice, mocker: MockerFixture):
"""Test dust mode."""
dustbin = next(get_parent_and_child_modules(dev, Module.Dustbin))
call = mocker.spy(dustbin, "call")
mode_feature = dustbin._device.features["dustbin_mode"]
assert dustbin.mode == mode_feature.value
new_mode = Mode.Max
await dustbin.set_mode(new_mode.name)
params = dustbin._settings.copy()
params["dust_collection_mode"] = new_mode.value
call.assert_called_with("setDustCollectionInfo", params)
await dev.update()
assert dustbin.mode == new_mode.name
with pytest.raises(ValueError, match="Invalid auto/emptying mode speed"):
await dustbin.set_mode("invalid")
@dustbin
async def test_autocollection(dev: SmartDevice, mocker: MockerFixture):
"""Test autocollection switch."""
dustbin = next(get_parent_and_child_modules(dev, Module.Dustbin))
call = mocker.spy(dustbin, "call")
auto_collection = dustbin._device.features["dustbin_autocollection_enabled"]
assert dustbin.auto_collection == auto_collection.value
await auto_collection.set_value(True)
params = dustbin._settings.copy()
params["auto_dust_collection"] = True
call.assert_called_with("setDustCollectionInfo", params)
await dev.update()
assert dustbin.auto_collection is True
@dustbin
async def test_empty_dustbin(dev: SmartDevice, mocker: MockerFixture):
"""Test the empty dustbin feature."""
dustbin = next(get_parent_and_child_modules(dev, Module.Dustbin))
call = mocker.spy(dustbin, "call")
await dustbin.start_emptying()
call.assert_called_with("setSwitchDustCollection", {"switch_dust_collection": True})