feat: Add consumable fields

Author: allenporter

roborock/data/v1/v1_containers.py

@@ -625,11 +625,27 @@ class CleanSummaryWithDetail(CleanSummary):
     last_clean_record: CleanRecord | None = None
 
 
+class ConsumableField(FieldNameBase):
+    """An enum that represents a field in the `Consumable` class.
+
+    This is used with `roborock.devices.traits.v1.status.DeviceFeaturesTrait`
+    to understand if a feature is supported by the device using `is_field_supported`.
+
+    The enum values are names of fields in the `Consumable` class. Each field is
+    annotated with `requires_schema_code` metadata to map the field to a schema
+    code in the product schema, which may have a different name than the field/attribute name.
+    """
+
+    MAIN_BRUSH_WORK_TIME = "main_brush_work_time"
+    SIDE_BRUSH_WORK_TIME = "side_brush_work_time"
+    FILTER_WORK_TIME = "filter_work_time"
+
+
 @dataclass
 class Consumable(RoborockBase):
-    main_brush_work_time: int | None = None
-    side_brush_work_time: int | None = None
-    filter_work_time: int | None = None
+    main_brush_work_time: int | None = field(metadata={"requires_schema_code": "main_brush_life"}, default=None)
+    side_brush_work_time: int | None = field(metadata={"requires_schema_code": "side_brush_life"}, default=None)
+    filter_work_time: int | None = field(metadata={"requires_schema_code": "filter_life"}, default=None)
     filter_element_work_time: int | None = None
     sensor_dirty_time: int | None = None
     strainer_work_times: int | None = None

tests/devices/traits/v1/__snapshots__/test_device_features.ambr

@@ -32,3 +32,24 @@
     'water_box_mode': True,
   })
 # ---
+# name: test_is_consumable_field_supported[home_data_device_s5e.json]
+  dict({
+    'filter_work_time': True,
+    'main_brush_work_time': True,
+    'side_brush_work_time': True,
+  })
+# ---
+# name: test_is_consumable_field_supported[home_data_device_s7_maxv.json]
+  dict({
+    'filter_work_time': True,
+    'main_brush_work_time': True,
+    'side_brush_work_time': True,
+  })
+# ---
+# name: test_is_consumable_field_supported[home_data_device_saros_10r.json]
+  dict({
+    'filter_work_time': True,
+    'main_brush_work_time': True,
+    'side_brush_work_time': True,
+  })
+# ---

tests/devices/traits/v1/test_device_features.py

@@ -4,8 +4,9 @@
 from syrupy import SnapshotAssertion
 
 from roborock.data import HomeDataDevice
-from roborock.data.v1.v1_containers import StatusField
+from roborock.data.v1.v1_containers import ConsumableField, StatusField
 from roborock.devices.device import RoborockDevice
+from roborock.devices.traits.v1.consumeable import ConsumableTrait
 from roborock.devices.traits.v1.status import StatusTrait
 from tests import mock_data
 
@@ -33,3 +34,24 @@ async def test_is_attribute_supported(
         field.value: device_features_trait.is_field_supported(StatusTrait, field) for field in StatusField
     }
     assert is_v1_supported == snapshot
+
+
+@pytest.mark.parametrize(
+    ("device_info"),
+    V1_DEVICES.values(),
+    ids=list(V1_DEVICES.keys()),
+)
+async def test_is_consumable_field_supported(
+    device_info: HomeDataDevice,
+    device: RoborockDevice,
+    snapshot: SnapshotAssertion,
+) -> None:
+    """Test if a field is supported."""
+    assert device.v1_properties is not None
+    assert device.v1_properties.device_features is not None
+    device_features_trait = device.v1_properties.device_features
+
+    is_v1_supported = {
+        field.value: device_features_trait.is_field_supported(ConsumableTrait, field) for field in ConsumableField
+    }
+    assert is_v1_supported == snapshot