roborock.devices.traits.v1.status

 1from functools import cached_property
 2
 3from roborock import (
 4    CleanRoutes,
 5    StatusV2,
 6    VacuumModes,
 7    WaterModes,
 8    get_clean_modes,
 9    get_clean_routes,
10    get_water_mode_mapping,
11    get_water_modes,
12)
13from roborock.roborock_typing import RoborockCommand
14
15from . import common
16from .device_features import DeviceFeaturesTrait
17
18
19class StatusTrait(StatusV2, common.V1TraitMixin):
20    """Trait for managing the status of Roborock devices.
21
22    The StatusTrait gives you the access to the state of a Roborock vacuum.
23    The various attribute options on state change per each device.
24    Values like fan speed, mop mode, etc. have different options for every device
25    and are dynamically determined.
26
27    Usage:
28        Before accessing status properties, you should call `refresh()` to fetch
29        the latest data from the device. You must pass in the device feature trait
30        to this trait so that the dynamic attributes can be pre-determined.
31
32    The current dynamic attributes are:
33    - Fan Speed
34    - Water Mode
35    - Mop Route
36
37    You should call the _options() version of the attribute to know which are supported for your device
38    (i.e. fan_speed_options())
39    Then you can call the _mapping to convert an int value to the actual Enum. (i.e. fan_speed_mapping())
40    You can call the _name property to get the str value of the enum. (i.e. fan_speed_name)
41
42    """
43
44    command = RoborockCommand.GET_STATUS
45    converter = common.DefaultConverter(StatusV2)
46
47    def __init__(self, device_feature_trait: DeviceFeaturesTrait, region: str | None = None) -> None:
48        """Initialize the StatusTrait."""
49        super().__init__()
50        self._device_features_trait = device_feature_trait
51        self._region = region
52
53    @cached_property
54    def fan_speed_options(self) -> list[VacuumModes]:
55        return get_clean_modes(self._device_features_trait)
56
57    @cached_property
58    def fan_speed_mapping(self) -> dict[int, str]:
59        return {fan.code: fan.value for fan in self.fan_speed_options}
60
61    @cached_property
62    def water_mode_options(self) -> list[WaterModes]:
63        return get_water_modes(self._device_features_trait)
64
65    @cached_property
66    def water_mode_mapping(self) -> dict[int, str]:
67        return get_water_mode_mapping(self._device_features_trait)
68
69    @cached_property
70    def mop_route_options(self) -> list[CleanRoutes]:
71        return get_clean_routes(self._device_features_trait, self._region or "us")
72
73    @cached_property
74    def mop_route_mapping(self) -> dict[int, str]:
75        return {route.code: route.value for route in self.mop_route_options}
76
77    @property
78    def fan_speed_name(self) -> str | None:
79        if self.fan_power is None:
80            return None
81        return self.fan_speed_mapping.get(self.fan_power)
82
83    @property
84    def water_mode_name(self) -> str | None:
85        if self.water_box_mode is None:
86            return None
87        return self.water_mode_mapping.get(self.water_box_mode)
88
89    @property
90    def mop_route_name(self) -> str | None:
91        if self.mop_mode is None:
92            return None
93        return self.mop_route_mapping.get(self.mop_mode)