roborock.data.b01_q7.b01_q7_containers

  1import datetime
  2import json
  3from dataclasses import dataclass, field
  4from functools import cached_property
  5
  6from ...exceptions import RoborockException
  7from ..containers import RoborockBase
  8from .b01_q7_code_mappings import (
  9    B01Fault,
 10    CleanPathPreferenceMapping,
 11    CleanRepeatMapping,
 12    CleanTypeMapping,
 13    SCWindMapping,
 14    WaterLevelMapping,
 15    WorkModeMapping,
 16    WorkStatusMapping,
 17)
 18
 19
 20@dataclass
 21class NetStatus(RoborockBase):
 22    """Represents the network status of the device."""
 23
 24    rssi: str
 25    loss: int
 26    ping: int
 27    ip: str
 28    mac: str
 29    ssid: str
 30    frequency: int
 31    bssid: str
 32
 33
 34@dataclass
 35class OrderTotal(RoborockBase):
 36    """Represents the order total information."""
 37
 38    total: int
 39    enable: int
 40
 41
 42@dataclass
 43class Privacy(RoborockBase):
 44    """Represents the privacy settings of the device."""
 45
 46    ai_recognize: int
 47    dirt_recognize: int
 48    pet_recognize: int
 49    carpet_turbo: int
 50    carpet_avoid: int
 51    carpet_show: int
 52    map_uploads: int
 53    ai_agent: int
 54    ai_avoidance: int
 55    record_uploads: int
 56    along_floor: int
 57    auto_upgrade: int
 58
 59
 60@dataclass
 61class PvCharging(RoborockBase):
 62    """Represents the photovoltaic charging status."""
 63
 64    status: int
 65    begin_time: int
 66    end_time: int
 67
 68
 69@dataclass
 70class Recommend(RoborockBase):
 71    """Represents cleaning recommendations."""
 72
 73    sill: int
 74    wall: int
 75    room_id: list[int] = field(default_factory=list)
 76
 77
 78@dataclass
 79class B01Props(RoborockBase):
 80    """
 81    Represents the complete properties and status for a Roborock B01 model.
 82    This dataclass is generated based on the device's status JSON object.
 83    """
 84
 85    status: WorkStatusMapping | None = None
 86    fault: B01Fault | None = None
 87    wind: SCWindMapping | None = None
 88    water: WaterLevelMapping | None = None
 89    mode: CleanTypeMapping | None = None
 90    quantity: int | None = None
 91    alarm: int | None = None
 92    volume: int | None = None
 93    hypa: int | None = None
 94    main_brush: int | None = None
 95    side_brush: int | None = None
 96    mop_life: int | None = None
 97    main_sensor: int | None = None
 98    net_status: NetStatus | None = None
 99    repeat_state: CleanRepeatMapping | None = None
100    tank_state: int | None = None
101    sweep_type: int | None = None
102    clean_path_preference: CleanPathPreferenceMapping | None = None
103    cloth_state: int | None = None
104    time_zone: int | None = None
105    time_zone_info: str | None = None
106    language: int | None = None
107    cleaning_time: int | None = None
108    real_clean_time: int | None = None
109    cleaning_area: int | None = None
110    custom_type: int | None = None
111    sound: int | None = None
112    work_mode: WorkModeMapping | None = None
113    station_act: int | None = None
114    charge_state: int | None = None
115    current_map_id: int | None = None
116    map_num: int | None = None
117    dust_action: int | None = None
118    quiet_is_open: int | None = None
119    quiet_begin_time: int | None = None
120    quiet_end_time: int | None = None
121    clean_finish: int | None = None
122    voice_type: int | None = None
123    voice_type_version: int | None = None
124    order_total: OrderTotal | None = None
125    build_map: int | None = None
126    privacy: Privacy | None = None
127    dust_auto_state: int | None = None
128    dust_frequency: int | None = None
129    child_lock: int | None = None
130    multi_floor: int | None = None
131    map_save: int | None = None
132    light_mode: int | None = None
133    green_laser: int | None = None
134    dust_bag_used: int | None = None
135    order_save_mode: int | None = None
136    manufacturer: str | None = None
137    back_to_wash: int | None = None
138    charge_station_type: int | None = None
139    pv_cut_charge: int | None = None
140    pv_charging: PvCharging | None = None
141    serial_number: str | None = None
142    recommend: Recommend | None = None
143    add_sweep_status: int | None = None
144
145    @property
146    def main_brush_time_left(self) -> int | None:
147        """
148        Returns estimated remaining life of the main brush in minutes.
149        Total life is 300 hours (18000 minutes).
150        """
151        if self.main_brush is None:
152            return None
153        return max(0, 18000 - self.main_brush)
154
155    @property
156    def side_brush_time_left(self) -> int | None:
157        """
158        Returns estimated remaining life of the side brush in minutes.
159        Total life is 200 hours (12000 minutes).
160        """
161        if self.side_brush is None:
162            return None
163        return max(0, 12000 - self.side_brush)
164
165    @property
166    def filter_time_left(self) -> int | None:
167        """
168        Returns estimated remaining life of the filter (hypa) in minutes.
169        Total life is 150 hours (9000 minutes).
170        """
171        if self.hypa is None:
172            return None
173        return max(0, 9000 - self.hypa)
174
175    @property
176    def mop_life_time_left(self) -> int | None:
177        """
178        Returns estimated remaining life of the mop in minutes.
179        Total life is 180 hours (10800 minutes).
180        """
181        if self.mop_life is None:
182            return None
183        return max(0, 10800 - self.mop_life)
184
185    @property
186    def sensor_dirty_time_left(self) -> int | None:
187        """
188        Returns estimated time until sensors need cleaning in minutes.
189        Maintenance interval is typically 30 hours (1800 minutes).
190        """
191        if self.main_sensor is None:
192            return None
193        return max(0, 1800 - self.main_sensor)
194
195    @property
196    def status_name(self) -> str | None:
197        """Returns the name of the current status."""
198        return self.status.value if self.status is not None else None
199
200    @property
201    def fault_name(self) -> str | None:
202        """Returns the name of the current fault."""
203        return self.fault.value if self.fault is not None else None
204
205    @property
206    def wind_name(self) -> str | None:
207        """Returns the name of the current fan speed (wind)."""
208        return self.wind.value if self.wind is not None else None
209
210    @property
211    def work_mode_name(self) -> str | None:
212        """Returns the name of the current work mode."""
213        return self.work_mode.value if self.work_mode is not None else None
214
215    @property
216    def repeat_state_name(self) -> str | None:
217        """Returns the name of the current repeat state."""
218        return self.repeat_state.value if self.repeat_state is not None else None
219
220    @property
221    def clean_path_preference_name(self) -> str | None:
222        """Returns the name of the current clean path preference."""
223        return self.clean_path_preference.value if self.clean_path_preference is not None else None
224
225
226@dataclass
227class CleanRecordDetail(RoborockBase):
228    """Represents a single clean record detail (from `record_list[].detail`)."""
229
230    record_start_time: int | None = None
231    method: int | None = None
232    record_use_time: int | None = None
233    clean_count: int | None = None
234    # This is seemingly returned in meters (non-squared)
235    record_clean_area: int | None = None
236    record_clean_mode: int | None = None
237    record_clean_way: int | None = None
238    record_task_status: int | None = None
239    record_faultcode: int | None = None
240    record_dust_num: int | None = None
241    clean_current_map: int | None = None
242    record_map_url: str | None = None
243
244    @property
245    def start_datetime(self) -> datetime.datetime | None:
246        """Convert the start datetime into a datetime object."""
247        if self.record_start_time is not None:
248            return datetime.datetime.fromtimestamp(self.record_start_time).astimezone(datetime.UTC)
249        return None
250
251    @property
252    def square_meters_area_cleaned(self) -> float | None:
253        """Returns the area cleaned in square meters."""
254        if self.record_clean_area is not None:
255            return self.record_clean_area / 100
256        return None
257
258
259@dataclass
260class CleanRecordListItem(RoborockBase):
261    """Represents an entry in the clean record list returned by `service.get_record_list`."""
262
263    url: str | None = None
264    detail: str | None = None
265
266    @cached_property
267    def detail_parsed(self) -> CleanRecordDetail | None:
268        """Parse and return the detail as a CleanRecordDetail object."""
269        if self.detail is None:
270            return None
271        try:
272            parsed = json.loads(self.detail)
273        except json.JSONDecodeError as ex:
274            raise RoborockException(f"Invalid B01 record detail JSON: {self.detail!r}") from ex
275        return CleanRecordDetail.from_dict(parsed)
276
277
278@dataclass
279class CleanRecordList(RoborockBase):
280    """Represents the clean record list response from `service.get_record_list`."""
281
282    total_area: int | None = None
283    total_time: int | None = None  # stored in seconds
284    total_count: int | None = None
285    record_list: list[CleanRecordListItem] = field(default_factory=list)
286
287    @property
288    def square_meters_area_cleaned(self) -> float | None:
289        """Returns the area cleaned in square meters."""
290        if self.total_area is not None:
291            return self.total_area / 100
292        return None
293
294
295@dataclass
296class CleanRecordSummary(RoborockBase):
297    """Represents clean record totals for B01/Q7 devices."""
298
299    total_time: int | None = None
300    total_area: int | None = None
301    total_count: int | None = None
302    last_record_detail: CleanRecordDetail | None = None