python-roborock 2.50.4__tar.gz → 2.51.0__tar.gz

{python_roborock-2.50.4 → python_roborock-2.51.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-roborock
-Version: 2.50.4
+Version: 2.51.0
 Summary: A package to control Roborock vacuums.
 Home-page: https://github.com/humbertogontijo/python-roborock
 License: GPL-3.0-only

{python_roborock-2.50.4 → python_roborock-2.51.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "python-roborock"
-version = "2.50.4"
+version = "2.51.0"
 description = "A package to control Roborock vacuums."
 authors = ["humbertogontijo <humbertogontijo@users.noreply.github.com>"]
 license = "GPL-3.0-only"

{python_roborock-2.50.4 → python_roborock-2.51.0}/roborock/cli.py

@@ -21,6 +21,7 @@ roborock> list-devices
 roborock> status --device_id <device_id>
 ```
 """
+
 import asyncio
 import datetime
 import functools
@@ -46,6 +47,7 @@ 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.devices.traits.v1.consumeable import ConsumableAttribute
 from roborock.protocol import MessageParser
 from roborock.version_1_apis.roborock_mqtt_client_v1 import RoborockMqttClientV1
 from roborock.web_api import RoborockApiClient
@@ -449,6 +451,30 @@ async def maps(ctx, device_id: str):
     await _display_v1_trait(context, device_id, lambda v1: v1.maps)
 
 
+@session.command()
+@click.option("--device_id", required=True)
+@click.pass_context
+@async_command
+async def consumables(ctx, device_id: str):
+    """Get device consumables."""
+    context: RoborockContext = ctx.obj
+    await _display_v1_trait(context, device_id, lambda v1: v1.consumables)
+
+
+@session.command()
+@click.option("--device_id", required=True)
+@click.option("--consumable", required=True, type=click.Choice([e.value for e in ConsumableAttribute]))
+@click.pass_context
+@async_command
+async def reset_consumable(ctx, device_id: str, consumable: str):
+    """Reset a specific consumable attribute."""
+    context: RoborockContext = ctx.obj
+    trait = await _v1_trait(context, device_id, lambda v1: v1.consumables)
+    attribute = ConsumableAttribute.from_str(consumable)
+    await trait.reset_consumable(attribute)
+    click.echo(f"Reset {consumable} for device {device_id}")
+
+
 @click.command()
 @click.option("--device_id", required=True)
 @click.option("--cmd", required=True)
@@ -691,6 +717,8 @@ cli.add_command(clean_summary)
 cli.add_command(volume)
 cli.add_command(set_volume)
 cli.add_command(maps)
+cli.add_command(consumables)
+cli.add_command(reset_consumable)
 
 
 def main():

{python_roborock-2.50.4 → python_roborock-2.51.0}/roborock/devices/traits/v1/__init__.py

@@ -9,6 +9,7 @@ from roborock.devices.v1_rpc_channel import V1RpcChannel
 
 from .clean_summary import CleanSummaryTrait
 from .common import V1TraitMixin
+from .consumeable import ConsumableTrait
 from .do_not_disturb import DoNotDisturbTrait
 from .maps import MapsTrait
 from .status import StatusTrait
@@ -24,6 +25,7 @@ __all__ = [
     "CleanSummaryTrait",
     "SoundVolumeTrait",
     "MapsTrait",
+    "ConsumableTrait",
 ]
 
 
@@ -40,6 +42,7 @@ class PropertiesApi(Trait):
     clean_summary: CleanSummaryTrait
     sound_volume: SoundVolumeTrait
     maps: MapsTrait
+    consumables: ConsumableTrait
 
     # In the future optional fields can be added below based on supported features
 

python_roborock-2.51.0/roborock/devices/traits/v1/consumeable.py

@@ -0,0 +1,47 @@
+"""Trait for managing consumable attributes.
+
+A consumable attribute is one that is expected to be replaced or refilled
+periodically, such as filters, brushes, etc.
+"""
+
+from enum import StrEnum
+from typing import Self
+
+from roborock.containers import Consumable
+from roborock.devices.traits.v1 import common
+from roborock.roborock_typing import RoborockCommand
+
+__all__ = [
+    "ConsumableTrait",
+]
+
+
+class ConsumableAttribute(StrEnum):
+    """Enum for consumable attributes."""
+
+    SENSOR_DIRTY_TIME = "sensor_dirty_time"
+    FILTER_WORK_TIME = "filter_work_time"
+    SIDE_BRUSH_WORK_TIME = "side_brush_work_time"
+    MAIN_BRUSH_WORK_TIME = "main_brush_work_time"
+
+    @classmethod
+    def from_str(cls, value: str) -> Self:
+        """Create a ConsumableAttribute from a string value."""
+        for member in cls:
+            if member.value == value:
+                return member
+        raise ValueError(f"Unknown ConsumableAttribute: {value}")
+
+
+class ConsumableTrait(Consumable, common.V1TraitMixin):
+    """Trait for managing consumable attributes on Roborock devices.
+
+    After the first refresh, you can tell what consumables are supported by
+    checking which attributes are not None.
+    """
+
+    command = RoborockCommand.GET_CONSUMABLE
+
+    async def reset_consumable(self, consumable: ConsumableAttribute) -> None:
+        """Reset a specific consumable attribute on the device."""
+        await self.rpc_channel.send_command(RoborockCommand.RESET_CONSUMABLE, params=[consumable.value])