roborock.data.v1.v1_containers

  1import datetime
  2import logging
  3from dataclasses import dataclass, field
  4from enum import StrEnum
  5from typing import Any
  6
  7from roborock.const import (
  8    CLEANING_BRUSH_REPLACE_TIME,
  9    DUST_COLLECTION_REPLACE_TIME,
 10    FILTER_REPLACE_TIME,
 11    MAIN_BRUSH_REPLACE_TIME,
 12    MOP_ROLLER_REPLACE_TIME,
 13    NO_MAP,
 14    ROBOROCK_G10S_PRO,
 15    ROBOROCK_P10,
 16    ROBOROCK_Q7_MAX,
 17    ROBOROCK_QREVO_CURV,
 18    ROBOROCK_QREVO_MASTER,
 19    ROBOROCK_QREVO_MAXV,
 20    ROBOROCK_QREVO_PRO,
 21    ROBOROCK_QREVO_S,
 22    ROBOROCK_S4_MAX,
 23    ROBOROCK_S5_MAX,
 24    ROBOROCK_S6,
 25    ROBOROCK_S6_MAXV,
 26    ROBOROCK_S6_PURE,
 27    ROBOROCK_S7,
 28    ROBOROCK_S7_MAXV,
 29    ROBOROCK_S8,
 30    ROBOROCK_S8_MAXV_ULTRA,
 31    ROBOROCK_S8_PRO_ULTRA,
 32    ROBOROCK_SAROS_10,
 33    ROBOROCK_SAROS_10R,
 34    SENSOR_DIRTY_REPLACE_TIME,
 35    SIDE_BRUSH_REPLACE_TIME,
 36    STRAINER_REPLACE_TIME,
 37    ROBOROCK_G20S_Ultra,
 38)
 39from roborock.exceptions import RoborockException
 40
 41from ..containers import RoborockBase, RoborockBaseTimer, _attr_repr
 42from .v1_code_mappings import (
 43    CleanFluidStatus,
 44    ClearWaterBoxStatus,
 45    DirtyWaterBoxStatus,
 46    DustBagStatus,
 47    RoborockCleanType,
 48    RoborockDockDustCollectionModeCode,
 49    RoborockDockErrorCode,
 50    RoborockDockTypeCode,
 51    RoborockDockWashTowelModeCode,
 52    RoborockErrorCode,
 53    RoborockFanPowerCode,
 54    RoborockFanSpeedP10,
 55    RoborockFanSpeedQ7Max,
 56    RoborockFanSpeedQRevoCurv,
 57    RoborockFanSpeedQRevoMaster,
 58    RoborockFanSpeedQRevoMaxV,
 59    RoborockFanSpeedS6Pure,
 60    RoborockFanSpeedS7,
 61    RoborockFanSpeedS7MaxV,
 62    RoborockFanSpeedS8MaxVUltra,
 63    RoborockFanSpeedSaros10,
 64    RoborockFanSpeedSaros10R,
 65    RoborockFinishReason,
 66    RoborockInCleaning,
 67    RoborockMopIntensityCode,
 68    RoborockMopIntensityP10,
 69    RoborockMopIntensityQ7Max,
 70    RoborockMopIntensityQRevoCurv,
 71    RoborockMopIntensityQRevoMaster,
 72    RoborockMopIntensityQRevoMaxV,
 73    RoborockMopIntensityS5Max,
 74    RoborockMopIntensityS6MaxV,
 75    RoborockMopIntensityS7,
 76    RoborockMopIntensityS8MaxVUltra,
 77    RoborockMopIntensitySaros10,
 78    RoborockMopIntensitySaros10R,
 79    RoborockMopModeCode,
 80    RoborockMopModeQRevoCurv,
 81    RoborockMopModeQRevoMaster,
 82    RoborockMopModeQRevoMaxV,
 83    RoborockMopModeS7,
 84    RoborockMopModeS8MaxVUltra,
 85    RoborockMopModeS8ProUltra,
 86    RoborockMopModeSaros10,
 87    RoborockMopModeSaros10R,
 88    RoborockStartType,
 89    RoborockStateCode,
 90)
 91
 92_LOGGER = logging.getLogger(__name__)
 93
 94
 95class FieldNameBase(StrEnum):
 96    """A base enum class that represents a field name in a RoborockBase dataclass."""
 97
 98
 99class StatusField(FieldNameBase):
100    """An enum that represents a field in the `Status` class.
101
102    This is used with `roborock.devices.traits.v1.status.DeviceFeaturesTrait`
103    to understand if a feature is supported by the device using `is_field_supported`.
104
105    The enum values are names of fields in the `Status` class. Each field is
106    annotated with `requires_schema_code` metadata to map the field to a schema
107    code in the product schema, which may have a different name than the field/attribute name.
108    """
109
110    STATE = "state"
111    BATTERY = "battery"
112    FAN_POWER = "fan_power"
113    WATER_BOX_MODE = "water_box_mode"
114    CHARGE_STATUS = "charge_status"
115    DRY_STATUS = "dry_status"
116
117
118def _requires_schema_code(requires_schema_code: str, default=None) -> Any:
119    return field(metadata={"requires_schema_code": requires_schema_code}, default=default)
120
121
122@dataclass
123class Status(RoborockBase):
124    msg_ver: int | None = None
125    msg_seq: int | None = None
126    state: RoborockStateCode | None = _requires_schema_code("state", default=None)
127    battery: int | None = _requires_schema_code("battery", default=None)
128    clean_time: int | None = None
129    clean_area: int | None = None
130    error_code: RoborockErrorCode | None = None
131    map_present: int | None = None
132    in_cleaning: RoborockInCleaning | None = None
133    in_returning: int | None = None
134    in_fresh_state: int | None = None
135    lab_status: int | None = None
136    water_box_status: int | None = None
137    back_type: int | None = None
138    wash_phase: int | None = None
139    wash_ready: int | None = None
140    fan_power: RoborockFanPowerCode | None = _requires_schema_code("fan_power", default=None)
141    dnd_enabled: int | None = None
142    map_status: int | None = None
143    is_locating: int | None = None
144    lock_status: int | None = None
145    water_box_mode: RoborockMopIntensityCode | None = _requires_schema_code("water_box_mode", default=None)
146    water_box_carriage_status: int | None = None
147    mop_forbidden_enable: int | None = None
148    camera_status: int | None = None
149    is_exploring: int | None = None
150    home_sec_status: int | None = None
151    home_sec_enable_password: int | None = None
152    adbumper_status: list[int] | None = None
153    water_shortage_status: int | None = None
154    dock_type: RoborockDockTypeCode | None = None
155    dust_collection_status: int | None = None
156    auto_dust_collection: int | None = None
157    avoid_count: int | None = None
158    mop_mode: RoborockMopModeCode | None = None
159    debug_mode: int | None = None
160    collision_avoid_status: int | None = None
161    switch_map_mode: int | None = None
162    dock_error_status: RoborockDockErrorCode | None = None
163    charge_status: int | None = _requires_schema_code("charge_status", default=None)
164    unsave_map_reason: int | None = None
165    unsave_map_flag: int | None = None
166    wash_status: int | None = None
167    distance_off: int | None = None
168    in_warmup: int | None = None
169    dry_status: int | None = _requires_schema_code("drying_status", default=None)
170    rdt: int | None = None
171    clean_percent: int | None = None
172    rss: int | None = None
173    dss: int | None = None
174    common_status: int | None = None
175    corner_clean_mode: int | None = None
176    last_clean_t: int | None = None
177    replenish_mode: int | None = None
178    repeat: int | None = None
179    kct: int | None = None
180    subdivision_sets: int | None = None
181
182    @property
183    def square_meter_clean_area(self) -> float | None:
184        return round(self.clean_area / 1000000, 1) if self.clean_area is not None else None
185
186    @property
187    def error_code_name(self) -> str | None:
188        return self.error_code.name if self.error_code is not None else None
189
190    @property
191    def state_name(self) -> str | None:
192        return self.state.name if self.state is not None else None
193
194    @property
195    def water_box_mode_name(self) -> str | None:
196        return self.water_box_mode.name if self.water_box_mode is not None else None
197
198    @property
199    def fan_power_options(self) -> list[str]:
200        if self.fan_power is None:
201            return []
202        return list(self.fan_power.keys())
203
204    @property
205    def fan_power_name(self) -> str | None:
206        return self.fan_power.name if self.fan_power is not None else None
207
208    @property
209    def mop_mode_name(self) -> str | None:
210        return self.mop_mode.name if self.mop_mode is not None else None
211
212    def get_fan_speed_code(self, fan_speed: str) -> int:
213        if self.fan_power is None:
214            raise RoborockException("Attempted to get fan speed before status has been updated.")
215        return self.fan_power.as_dict().get(fan_speed)
216
217    def get_mop_intensity_code(self, mop_intensity: str) -> int:
218        if self.water_box_mode is None:
219            raise RoborockException("Attempted to get mop_intensity before status has been updated.")
220        return self.water_box_mode.as_dict().get(mop_intensity)
221
222    def get_mop_mode_code(self, mop_mode: str) -> int:
223        if self.mop_mode is None:
224            raise RoborockException("Attempted to get mop_mode before status has been updated.")
225        return self.mop_mode.as_dict().get(mop_mode)
226
227    @property
228    def current_map(self) -> int | None:
229        """Returns the current map ID if the map is present."""
230        if self.map_status is not None:
231            map_flag = self.map_status >> 2
232            if map_flag != NO_MAP:
233                return map_flag
234        return None
235
236    @property
237    def clear_water_box_status(self) -> ClearWaterBoxStatus | None:
238        if self.dss:
239            return ClearWaterBoxStatus((self.dss >> 2) & 3)
240        return None
241
242    @property
243    def dirty_water_box_status(self) -> DirtyWaterBoxStatus | None:
244        if self.dss:
245            return DirtyWaterBoxStatus((self.dss >> 4) & 3)
246        return None
247
248    @property
249    def dust_bag_status(self) -> DustBagStatus | None:
250        if self.dss:
251            return DustBagStatus((self.dss >> 6) & 3)
252        return None
253
254    @property
255    def water_box_filter_status(self) -> int | None:
256        if self.dss:
257            return (self.dss >> 8) & 3
258        return None
259
260    @property
261    def clean_fluid_status(self) -> CleanFluidStatus | None:
262        if self.dss:
263            value = (self.dss >> 10) & 3
264            if value == 0:
265                return None  # Feature not supported by this device
266            return CleanFluidStatus(value)
267        return None
268
269    @property
270    def hatch_door_status(self) -> int | None:
271        if self.dss:
272            return (self.dss >> 12) & 7
273        return None
274
275    @property
276    def dock_cool_fan_status(self) -> int | None:
277        if self.dss:
278            return (self.dss >> 15) & 3
279        return None
280
281    def __repr__(self) -> str:
282        return _attr_repr(self)
283
284
285@dataclass
286class S4MaxStatus(Status):
287    fan_power: RoborockFanSpeedS6Pure | None = None
288    water_box_mode: RoborockMopIntensityS7 | None = None
289    mop_mode: RoborockMopModeS7 | None = None
290
291
292@dataclass
293class S5MaxStatus(Status):
294    fan_power: RoborockFanSpeedS6Pure | None = None
295    water_box_mode: RoborockMopIntensityS5Max | None = None
296
297
298@dataclass
299class Q7MaxStatus(Status):
300    fan_power: RoborockFanSpeedQ7Max | None = None
301    water_box_mode: RoborockMopIntensityQ7Max | None = None
302
303
304@dataclass
305class QRevoMasterStatus(Status):
306    fan_power: RoborockFanSpeedQRevoMaster | None = None
307    water_box_mode: RoborockMopIntensityQRevoMaster | None = None
308    mop_mode: RoborockMopModeQRevoMaster | None = None
309
310
311@dataclass
312class QRevoCurvStatus(Status):
313    fan_power: RoborockFanSpeedQRevoCurv | None = None
314    water_box_mode: RoborockMopIntensityQRevoCurv | None = None
315    mop_mode: RoborockMopModeQRevoCurv | None = None
316
317
318@dataclass
319class QRevoMaxVStatus(Status):
320    fan_power: RoborockFanSpeedQRevoMaxV | None = None
321    water_box_mode: RoborockMopIntensityQRevoMaxV | None = None
322    mop_mode: RoborockMopModeQRevoMaxV | None = None
323
324
325@dataclass
326class S6MaxVStatus(Status):
327    fan_power: RoborockFanSpeedS7MaxV | None = None
328    water_box_mode: RoborockMopIntensityS6MaxV | None = None
329
330
331@dataclass
332class S6PureStatus(Status):
333    fan_power: RoborockFanSpeedS6Pure | None = None
334
335
336@dataclass
337class S7MaxVStatus(Status):
338    fan_power: RoborockFanSpeedS7MaxV | None = None
339    water_box_mode: RoborockMopIntensityS7 | None = None
340    mop_mode: RoborockMopModeS7 | None = None
341
342
343@dataclass
344class S7Status(Status):
345    fan_power: RoborockFanSpeedS7 | None = None
346    water_box_mode: RoborockMopIntensityS7 | None = None
347    mop_mode: RoborockMopModeS7 | None = None
348
349
350@dataclass
351class S8ProUltraStatus(Status):
352    fan_power: RoborockFanSpeedS7MaxV | None = None
353    water_box_mode: RoborockMopIntensityS7 | None = None
354    mop_mode: RoborockMopModeS8ProUltra | None = None
355
356
357@dataclass
358class S8Status(Status):
359    fan_power: RoborockFanSpeedS7MaxV | None = None
360    water_box_mode: RoborockMopIntensityS7 | None = None
361    mop_mode: RoborockMopModeS8ProUltra | None = None
362
363
364@dataclass
365class P10Status(Status):
366    fan_power: RoborockFanSpeedP10 | None = None
367    water_box_mode: RoborockMopIntensityP10 | None = None
368    mop_mode: RoborockMopModeS8ProUltra | None = None
369
370
371@dataclass
372class S8MaxvUltraStatus(Status):
373    fan_power: RoborockFanSpeedS8MaxVUltra | None = None
374    water_box_mode: RoborockMopIntensityS8MaxVUltra | None = None
375    mop_mode: RoborockMopModeS8MaxVUltra | None = None
376
377
378@dataclass
379class Saros10RStatus(Status):
380    fan_power: RoborockFanSpeedSaros10R | None = None
381    water_box_mode: RoborockMopIntensitySaros10R | None = None
382    mop_mode: RoborockMopModeSaros10R | None = None
383
384
385@dataclass
386class Saros10Status(Status):
387    fan_power: RoborockFanSpeedSaros10 | None = None
388    water_box_mode: RoborockMopIntensitySaros10 | None = None
389    mop_mode: RoborockMopModeSaros10 | None = None
390
391
392ModelStatus: dict[str, type[Status]] = {
393    ROBOROCK_S4_MAX: S4MaxStatus,
394    ROBOROCK_S5_MAX: S5MaxStatus,
395    ROBOROCK_Q7_MAX: Q7MaxStatus,
396    ROBOROCK_QREVO_MASTER: QRevoMasterStatus,
397    ROBOROCK_QREVO_CURV: QRevoCurvStatus,
398    ROBOROCK_S6: S6PureStatus,
399    ROBOROCK_S6_MAXV: S6MaxVStatus,
400    ROBOROCK_S6_PURE: S6PureStatus,
401    ROBOROCK_S7_MAXV: S7MaxVStatus,
402    ROBOROCK_S7: S7Status,
403    ROBOROCK_S8: S8Status,
404    ROBOROCK_S8_PRO_ULTRA: S8ProUltraStatus,
405    ROBOROCK_G10S_PRO: S7MaxVStatus,
406    ROBOROCK_G20S_Ultra: QRevoMasterStatus,
407    ROBOROCK_P10: P10Status,
408    # These likely are not correct,
409    # but i am currently unable to do my typical reverse engineering/ get any data from users on this,
410    # so this will be here in the mean time.
411    ROBOROCK_QREVO_S: P10Status,
412    ROBOROCK_QREVO_MAXV: QRevoMaxVStatus,
413    ROBOROCK_QREVO_PRO: P10Status,
414    ROBOROCK_S8_MAXV_ULTRA: S8MaxvUltraStatus,
415    ROBOROCK_SAROS_10R: Saros10RStatus,
416    ROBOROCK_SAROS_10: Saros10Status,
417}
418
419
420@dataclass
421class DnDTimer(RoborockBaseTimer):
422    """DnDTimer"""
423
424
425@dataclass
426class ValleyElectricityTimer(RoborockBaseTimer):
427    """ValleyElectricityTimer"""
428
429
430@dataclass
431class CleanSummary(RoborockBase):
432    clean_time: int | None = None
433    clean_area: int | None = None
434    clean_count: int | None = None
435    dust_collection_count: int | None = None
436    records: list[int] | None = None
437    last_clean_t: int | None = None
438
439    @property
440    def square_meter_clean_area(self) -> float | None:
441        """Returns the clean area in square meters."""
442        if isinstance(self.clean_area, list | str):
443            _LOGGER.warning(f"Clean area is a unexpected type! Please give the following in a issue: {self.clean_area}")
444            return None
445        return round(self.clean_area / 1000000, 1) if self.clean_area is not None else None
446
447    def __repr__(self) -> str:
448        """Return a string representation of the object including all attributes."""
449        return _attr_repr(self)
450
451
452@dataclass
453class CleanRecord(RoborockBase):
454    begin: int | None = None
455    end: int | None = None
456    duration: int | None = None
457    area: int | None = None
458    error: int | None = None
459    complete: int | None = None
460    start_type: RoborockStartType | None = None
461    clean_type: RoborockCleanType | None = None
462    finish_reason: RoborockFinishReason | None = None
463    dust_collection_status: int | None = None
464    avoid_count: int | None = None
465    wash_count: int | None = None
466    map_flag: int | None = None
467
468    @property
469    def square_meter_area(self) -> float | None:
470        return round(self.area / 1000000, 1) if self.area is not None else None
471
472    @property
473    def begin_datetime(self) -> datetime.datetime | None:
474        return datetime.datetime.fromtimestamp(self.begin).astimezone(datetime.UTC) if self.begin else None
475
476    @property
477    def end_datetime(self) -> datetime.datetime | None:
478        return datetime.datetime.fromtimestamp(self.end).astimezone(datetime.UTC) if self.end else None
479
480    def __repr__(self) -> str:
481        return _attr_repr(self)
482
483
484class CleanSummaryWithDetail(CleanSummary):
485    """CleanSummary with the last CleanRecord included."""
486
487    last_clean_record: CleanRecord | None = None
488
489
490@dataclass
491class Consumable(RoborockBase):
492    main_brush_work_time: int | None = None
493    side_brush_work_time: int | None = None
494    filter_work_time: int | None = None
495    filter_element_work_time: int | None = None
496    sensor_dirty_time: int | None = None
497    strainer_work_times: int | None = None
498    dust_collection_work_times: int | None = None
499    cleaning_brush_work_times: int | None = None
500    moproller_work_time: int | None = None
501
502    @property
503    def main_brush_time_left(self) -> int | None:
504        return MAIN_BRUSH_REPLACE_TIME - self.main_brush_work_time if self.main_brush_work_time is not None else None
505
506    @property
507    def side_brush_time_left(self) -> int | None:
508        return SIDE_BRUSH_REPLACE_TIME - self.side_brush_work_time if self.side_brush_work_time is not None else None
509
510    @property
511    def filter_time_left(self) -> int | None:
512        return FILTER_REPLACE_TIME - self.filter_work_time if self.filter_work_time is not None else None
513
514    @property
515    def sensor_time_left(self) -> int | None:
516        return SENSOR_DIRTY_REPLACE_TIME - self.sensor_dirty_time if self.sensor_dirty_time is not None else None
517
518    @property
519    def strainer_time_left(self) -> int | None:
520        return STRAINER_REPLACE_TIME - self.strainer_work_times if self.strainer_work_times is not None else None
521
522    @property
523    def dust_collection_time_left(self) -> int | None:
524        return (
525            DUST_COLLECTION_REPLACE_TIME - self.dust_collection_work_times
526            if self.dust_collection_work_times is not None
527            else None
528        )
529
530    @property
531    def cleaning_brush_time_left(self) -> int | None:
532        return (
533            CLEANING_BRUSH_REPLACE_TIME - self.cleaning_brush_work_times
534            if self.cleaning_brush_work_times is not None
535            else None
536        )
537
538    @property
539    def mop_roller_time_left(self) -> int | None:
540        return MOP_ROLLER_REPLACE_TIME - self.moproller_work_time if self.moproller_work_time is not None else None
541
542    def __repr__(self) -> str:
543        return _attr_repr(self)
544
545
546@dataclass
547class MultiMapsListRoom(RoborockBase):
548    id: int | None = None
549    tag: int | None = None
550    iot_name_id: str | None = None
551    iot_name: str | None = None
552
553
554@dataclass
555class MultiMapsListMapInfoBakMaps(RoborockBase):
556    mapflag: Any | None = None
557    add_time: Any | None = None
558
559
560@dataclass
561class MultiMapsListMapInfo(RoborockBase):
562    map_flag: int
563    name: str
564    add_time: Any | None = None
565    length: Any | None = None
566    bak_maps: list[MultiMapsListMapInfoBakMaps] | None = None
567    rooms: list[MultiMapsListRoom] | None = None
568
569    @property
570    def mapFlag(self) -> int:
571        """Alias for map_flag, returns the map flag as an integer."""
572        return self.map_flag
573
574
575@dataclass
576class MultiMapsList(RoborockBase):
577    max_multi_map: int | None = None
578    max_bak_map: int | None = None
579    multi_map_count: int | None = None
580    map_info: list[MultiMapsListMapInfo] | None = None
581
582
583@dataclass
584class SmartWashParams(RoborockBase):
585    smart_wash: int | None = None
586    wash_interval: int | None = None
587
588
589@dataclass
590class DustCollectionMode(RoborockBase):
591    mode: RoborockDockDustCollectionModeCode | None = None
592
593
594@dataclass
595class WashTowelMode(RoborockBase):
596    wash_mode: RoborockDockWashTowelModeCode | None = None
597
598
599@dataclass
600class NetworkInfo(RoborockBase):
601    ip: str
602    ssid: str | None = None
603    mac: str | None = None
604    bssid: str | None = None
605    rssi: int | None = None
606
607
608@dataclass
609class AppInitStatusLocalInfo(RoborockBase):
610    location: str
611    bom: str | None = None
612    featureset: int | None = None
613    language: str | None = None
614    logserver: str | None = None
615    wifiplan: str | None = None
616    timezone: str | None = None
617    name: str | None = None
618
619
620@dataclass
621class AppInitStatus(RoborockBase):
622    local_info: AppInitStatusLocalInfo
623    feature_info: list[int]
624    new_feature_info: int
625    new_feature_info_str: str = ""
626    new_feature_info_2: int | None = None
627    carriage_type: int | None = None
628    dsp_version: str | None = None
629
630
631@dataclass
632class ChildLockStatus(RoborockBase):
633    lock_status: int = 0
634
635
636@dataclass
637class FlowLedStatus(RoborockBase):
638    status: int = 0
639
640
641@dataclass
642class LedStatus(RoborockBase):
643    status: int = 0