roborock.data.v1.v1_code_mappings

  1from typing import Self
  2
  3from ..code_mappings import RoborockEnum
  4
  5
  6class RoborockFinishReason(RoborockEnum):
  7    manual_interrupt = 21  # Cleaning interrupted by user
  8    cleanup_interrupted = 24  # Cleanup interrupted
  9    manual_interrupt_2 = 21
 10    manual_interrupt_12 = 29
 11    breakpoint = 32  # Could not continue cleaning
 12    breakpoint_2 = 33
 13    cleanup_interrupted_2 = 34
 14    manual_interrupt_3 = 35
 15    manual_interrupt_4 = 36
 16    manual_interrupt_5 = 37
 17    manual_interrupt_6 = 43
 18    locate_fail = 45  # Positioning Failed
 19    cleanup_interrupted_3 = 64
 20    locate_fail_2 = 65
 21    manual_interrupt_7 = 48
 22    manual_interrupt_8 = 49
 23    manual_interrupt_9 = 50
 24    cleanup_interrupted_4 = 51
 25    finished_cleaning = 52  # Finished cleaning
 26    finished_cleaning_2 = 54
 27    finished_cleaning_3 = 55
 28    finished_cleaning_4 = 56
 29    finished_clenaing_5 = 57
 30    manual_interrupt_10 = 60
 31    area_unreachable = 61  # Area unreachable
 32    area_unreachable_2 = 62
 33    washing_error = 67  # Washing error
 34    back_to_wash_failure = 68  # Failed to return to the dock
 35    cleanup_interrupted_5 = 101
 36    breakpoint_4 = 102
 37    manual_interrupt_11 = 103
 38    cleanup_interrupted_6 = 104
 39    cleanup_interrupted_7 = 105
 40    cleanup_interrupted_8 = 106
 41    cleanup_interrupted_9 = 107
 42    cleanup_interrupted_10 = 109
 43    cleanup_interrupted_11 = 110
 44    patrol_success = 114  # Cruise completed
 45    patrol_fail = 115  # Cruise failed
 46    pet_patrol_success = 116  # Pet found
 47    pet_patrol_fail = 117  # Pet found failed
 48
 49
 50class RoborockInCleaning(RoborockEnum):
 51    complete = 0
 52    global_clean_not_complete = 1
 53    zone_clean_not_complete = 2
 54    segment_clean_not_complete = 3
 55
 56
 57class RoborockCleanType(RoborockEnum):
 58    all_zone = 1
 59    draw_zone = 2
 60    select_zone = 3
 61    quick_build = 4
 62    video_patrol = 5
 63    pet_patrol = 6
 64
 65
 66class RoborockStartType(RoborockEnum):
 67    button = 1
 68    app = 2
 69    schedule = 3
 70    mi_home = 4
 71    quick_start = 5
 72    voice_control = 13
 73    routines = 101
 74    alexa = 801
 75    google = 802
 76    ifttt = 803
 77    yandex = 804
 78    homekit = 805
 79    xiaoai = 806
 80    tmall_genie = 807
 81    duer = 808
 82    dingdong = 809
 83    siri = 810
 84    clova = 811
 85    wechat = 901
 86    alipay = 902
 87    aqara = 903
 88    hisense = 904
 89    huawei = 905
 90    widget_launch = 820
 91    smart_watch = 821
 92
 93
 94class RoborockDssCodes(RoborockEnum):
 95    @classmethod
 96    def _missing_(cls: type[Self], key) -> Self:
 97        # If the calculated value is not provided, then it should be viewed as okay.
 98        # As the math will sometimes result in you getting numbers that don't matter.
 99        return cls.okay  # type: ignore
100
101
102class ClearWaterBoxStatus(RoborockDssCodes):
103    """Status of the clear water box."""
104
105    okay = 0
106    out_of_water = 1
107    out_of_water_2 = 38
108    refill_error = 48
109
110
111class DirtyWaterBoxStatus(RoborockDssCodes):
112    """Status of the dirty water box."""
113
114    okay = 0
115    full_not_installed = 1
116    full_not_installed_2 = 39
117    drain_error = 49
118
119
120class DustBagStatus(RoborockDssCodes):
121    """Status of the dust bag."""
122
123    okay = 0
124    not_installed = 1
125    full = 34
126
127
128class CleanFluidStatus(RoborockDssCodes):
129    """Status of the cleaning fluid container."""
130
131    empty_not_installed = 1
132    okay = 2
133
134
135class RoborockErrorCode(RoborockEnum):
136    none = 0
137    lidar_blocked = 1
138    bumper_stuck = 2
139    wheels_suspended = 3
140    cliff_sensor_error = 4
141    main_brush_jammed = 5
142    side_brush_jammed = 6
143    wheels_jammed = 7
144    robot_trapped = 8
145    no_dustbin = 9
146    strainer_error = 10  # Filter is wet or blocked
147    compass_error = 11  # Strong magnetic field detected
148    low_battery = 12
149    charging_error = 13
150    battery_error = 14
151    wall_sensor_dirty = 15
152    robot_tilted = 16
153    side_brush_error = 17
154    fan_error = 18
155    dock = 19  # Dock not connected to power
156    optical_flow_sensor_dirt = 20
157    vertical_bumper_pressed = 21
158    dock_locator_error = 22
159    return_to_dock_fail = 23
160    nogo_zone_detected = 24
161    visual_sensor = 25  # Camera error
162    light_touch = 26  # Wall sensor error
163    vibrarise_jammed = 27
164    robot_on_carpet = 28
165    filter_blocked = 29
166    invisible_wall_detected = 30
167    cannot_cross_carpet = 31
168    internal_error = 32
169    collect_dust_error_3 = 34  # Clean auto-empty dock
170    collect_dust_error_4 = 35  # Auto empty dock voltage error
171    mopping_roller_1 = 36  # Wash roller may be jammed
172    mopping_roller_error_2 = 37  # wash roller not lowered properly
173    clear_water_box_hoare = 38  # Check the clean water tank
174    dirty_water_box_hoare = 39  # Check the dirty water tank
175    sink_strainer_hoare = 40  # Reinstall the water filter
176    clear_water_box_exception = 41  # Clean water tank empty
177    clear_brush_exception = 42  # Check that the water filter has been correctly installed
178    clear_brush_exception_2 = 43  # Positioning button error
179    filter_screen_exception = 44  # Clean the dock water filter
180    mopping_roller_2 = 45  # Wash roller may be jammed
181    up_water_exception = 48
182    drain_water_exception = 49
183    temperature_protection = 51  # Unit temperature protection
184    clean_carousel_exception = 52
185    clean_carousel_water_full = 53
186    water_carriage_drop = 54
187    check_clean_carouse = 55
188    audio_error = 56
189
190
191class RoborockFanPowerCode(RoborockEnum):
192    """Describes the fan power of the vacuum cleaner."""
193
194    # Fan speeds should have the first letter capitalized - as there is no way to change the name in translations as
195    # far as I am aware
196
197
198class RoborockFanSpeedV1(RoborockFanPowerCode):
199    silent = 38
200    standard = 60
201    medium = 77
202    turbo = 90
203
204
205class RoborockFanSpeedV2(RoborockFanPowerCode):
206    silent = 101
207    balanced = 102
208    turbo = 103
209    max = 104
210    gentle = 105
211    auto = 106
212
213
214class RoborockFanSpeedV3(RoborockFanPowerCode):
215    silent = 38
216    standard = 60
217    medium = 75
218    turbo = 100
219
220
221class RoborockFanSpeedE2(RoborockFanPowerCode):
222    gentle = 41
223    silent = 50
224    standard = 68
225    medium = 79
226    turbo = 100
227
228
229class RoborockFanSpeedS7(RoborockFanPowerCode):
230    off = 105
231    quiet = 101
232    balanced = 102
233    turbo = 103
234    max = 104
235    custom = 106
236
237
238class RoborockFanSpeedS7MaxV(RoborockFanPowerCode):
239    off = 105
240    quiet = 101
241    balanced = 102
242    turbo = 103
243    max = 104
244    custom = 106
245    max_plus = 108
246
247
248class RoborockFanSpeedS6Pure(RoborockFanPowerCode):
249    gentle = 105
250    quiet = 101
251    balanced = 102
252    turbo = 103
253    max = 104
254    custom = 106
255
256
257class RoborockFanSpeedQ7Max(RoborockFanPowerCode):
258    quiet = 101
259    balanced = 102
260    turbo = 103
261    max = 104
262
263
264class RoborockFanSpeedQRevoMaster(RoborockFanPowerCode):
265    off = 105
266    quiet = 101
267    balanced = 102
268    turbo = 103
269    max = 104
270    custom = 106
271    max_plus = 108
272    smart_mode = 110
273
274
275class RoborockFanSpeedQRevoCurv(RoborockFanPowerCode):
276    quiet = 101
277    balanced = 102
278    turbo = 103
279    max = 104
280    off = 105
281    custom = 106
282    max_plus = 108
283    smart_mode = 110
284
285
286class RoborockFanSpeedQRevoMaxV(RoborockFanPowerCode):
287    off = 105
288    quiet = 101
289    balanced = 102
290    turbo = 103
291    max = 104
292    custom = 106
293    max_plus = 108
294    smart_mode = 110
295
296
297class RoborockFanSpeedP10(RoborockFanPowerCode):
298    off = 105
299    quiet = 101
300    balanced = 102
301    turbo = 103
302    max = 104
303    custom = 106
304    max_plus = 108
305    smart_mode = 110
306
307
308class RoborockFanSpeedS8MaxVUltra(RoborockFanPowerCode):
309    off = 105
310    quiet = 101
311    balanced = 102
312    turbo = 103
313    max = 104
314    custom = 106
315    max_plus = 108
316    smart_mode = 110
317
318
319class RoborockFanSpeedSaros10(RoborockFanPowerCode):
320    off = 105
321    quiet = 101
322    balanced = 102
323    turbo = 103
324    max = 104
325    custom = 106
326    max_plus = 108
327    smart_mode = 110
328
329
330class RoborockFanSpeedSaros10R(RoborockFanPowerCode):
331    off = 105
332    quiet = 101
333    balanced = 102
334    turbo = 103
335    max = 104
336    custom = 106
337    max_plus = 108
338    smart_mode = 110
339
340
341class RoborockMopModeCode(RoborockEnum):
342    """Describes the mop mode of the vacuum cleaner."""
343
344
345class RoborockMopModeQRevoCurv(RoborockMopModeCode):
346    standard = 300
347    deep = 301
348    custom = 302
349    deep_plus = 303
350    fast = 304
351    smart_mode = 306
352
353
354class RoborockMopModeS7(RoborockMopModeCode):
355    """Describes the mop mode of the vacuum cleaner."""
356
357    standard = 300
358    deep = 301
359    custom = 302
360    deep_plus = 303
361
362
363class RoborockMopModeS8ProUltra(RoborockMopModeCode):
364    standard = 300
365    deep = 301
366    deep_plus = 303
367    fast = 304
368    custom = 302
369    smart_mode = 306
370
371
372class RoborockMopModeS8MaxVUltra(RoborockMopModeCode):
373    standard = 300
374    deep = 301
375    custom = 302
376    deep_plus = 303
377    fast = 304
378    deep_plus_pearl = 305
379    smart_mode = 306
380
381
382class RoborockMopModeSaros10R(RoborockMopModeCode):
383    standard = 300
384    deep = 301
385    custom = 302
386    deep_plus = 303
387    fast = 304
388    smart_mode = 306
389
390
391class RoborockMopModeQRevoMaster(RoborockMopModeCode):
392    standard = 300
393    deep = 301
394    custom = 302
395    deep_plus = 303
396    fast = 304
397    smart_mode = 306
398
399
400class RoborockMopModeQRevoMaxV(RoborockMopModeCode):
401    standard = 300
402    deep = 301
403    custom = 302
404    deep_plus = 303
405    fast = 304
406    smart_mode = 306
407
408
409class RoborockMopModeSaros10(RoborockMopModeCode):
410    standard = 300
411    deep = 301
412    custom = 302
413    deep_plus = 303
414    fast = 304
415    smart_mode = 306
416
417
418class RoborockMopIntensityCode(RoborockEnum):
419    """Describes the mop intensity of the vacuum cleaner."""
420
421
422class RoborockMopIntensityS7(RoborockMopIntensityCode):
423    """Describes the mop intensity of the vacuum cleaner."""
424
425    off = 200
426    mild = 201
427    moderate = 202
428    intense = 203
429    custom = 204
430
431
432class RoborockMopIntensityV2(RoborockMopIntensityCode):
433    """Describes the mop intensity of the vacuum cleaner."""
434
435    off = 200
436    low = 201
437    medium = 202
438    high = 203
439    custom = 207
440
441
442class RoborockMopIntensityQRevoMaster(RoborockMopIntensityCode):
443    """Describes the mop intensity of the vacuum cleaner."""
444
445    off = 200
446    low = 201
447    medium = 202
448    high = 203
449    custom = 204
450    custom_water_flow = 207
451    smart_mode = 209
452
453
454class RoborockMopIntensityQRevoCurv(RoborockMopIntensityCode):
455    off = 200
456    low = 201
457    medium = 202
458    high = 203
459    custom = 204
460    custom_water_flow = 207
461    smart_mode = 209
462
463
464class RoborockMopIntensityQRevoMaxV(RoborockMopIntensityCode):
465    off = 200
466    low = 201
467    medium = 202
468    high = 203
469    custom = 204
470    custom_water_flow = 207
471    smart_mode = 209
472
473
474class RoborockMopIntensityP10(RoborockMopIntensityCode):
475    """Describes the mop intensity of the vacuum cleaner."""
476
477    off = 200
478    low = 201
479    medium = 202
480    high = 203
481    custom = 204
482    custom_water_flow = 207
483    smart_mode = 209
484
485
486class RoborockMopIntensityS8MaxVUltra(RoborockMopIntensityCode):
487    off = 200
488    low = 201
489    medium = 202
490    high = 203
491    custom = 204
492    max = 208
493    smart_mode = 209
494    custom_water_flow = 207
495
496
497class RoborockMopIntensitySaros10(RoborockMopIntensityCode):
498    off = 200
499    mild = 201
500    standard = 202
501    intense = 203
502    extreme = 208
503    custom = 204
504    smart_mode = 209
505
506
507class RoborockMopIntensitySaros10R(RoborockMopIntensityCode):
508    off = 200
509    low = 201
510    medium = 202
511    high = 203
512    custom = 204
513    extreme = 250
514    vac_followed_by_mop = 235
515    smart_mode = 209
516
517
518class RoborockMopIntensityS5Max(RoborockMopIntensityCode):
519    """Describes the mop intensity of the vacuum cleaner."""
520
521    off = 200
522    low = 201
523    medium = 202
524    high = 203
525    custom = 204
526    custom_water_flow = 207
527
528
529class RoborockMopIntensityS6MaxV(RoborockMopIntensityCode):
530    """Describes the mop intensity of the vacuum cleaner."""
531
532    off = 200
533    low = 201
534    medium = 202
535    high = 203
536    custom = 204
537    custom_water_flow = 207
538
539
540class RoborockMopIntensityQ7Max(RoborockMopIntensityCode):
541    """Describes the mop intensity of the vacuum cleaner."""
542
543    off = 200
544    low = 201
545    medium = 202
546    high = 203
547    custom_water_flow = 207
548
549
550class RoborockDockErrorCode(RoborockEnum):
551    """Describes the error code of the dock."""
552
553    ok = 0
554    duct_blockage = 34
555    water_empty = 38
556    waste_water_tank_full = 39
557    maintenance_brush_jammed = 42
558    dirty_tank_latch_open = 44
559    no_dustbin = 46
560    cleaning_tank_full_or_blocked = 53
561
562
563class RoborockDockTypeCode(RoborockEnum):
564    unknown = -9999
565    no_dock = 0
566    auto_empty_dock = 1
567    empty_wash_fill_dock = 3
568    auto_empty_dock_pure = 5
569    s7_max_ultra_dock = 6
570    s8_dock = 7
571    p10_dock = 8
572    p10_pro_dock = 9
573    s8_maxv_ultra_dock = 10
574    qrevo_master_dock = 14
575    qrevo_s_dock = 15
576    saros_r10_dock = 16
577    qrevo_curv_dock = 17
578    saros_10_dock = 18
579
580
581class RoborockDockDustCollectionModeCode(RoborockEnum):
582    """Describes the dust collection mode of the vacuum cleaner."""
583
584    # TODO: Get the correct values for various different docks
585    unknown = -9999
586    smart = 0
587    light = 1
588    balanced = 2
589    max = 4
590
591
592class RoborockStateCode(RoborockEnum):
593    unknown = 0
594    starting = 1
595    charger_disconnected = 2
596    idle = 3
597    remote_control_active = 4
598    cleaning = 5
599    returning_home = 6
600    manual_mode = 7
601    charging = 8
602    charging_problem = 9
603    paused = 10
604    spot_cleaning = 11
605    error = 12
606    shutting_down = 13
607    updating = 14
608    docking = 15
609    going_to_target = 16
610    zoned_cleaning = 17
611    segment_cleaning = 18
612    emptying_the_bin = 22  # on s7+
613    washing_the_mop = 23  # on a46
614    washing_the_mop_2 = 25
615    going_to_wash_the_mop = 26  # on a46
616    in_call = 28
617    mapping = 29
618    egg_attack = 30
619    patrol = 32
620    attaching_the_mop = 33  # on g20s ultra
621    detaching_the_mop = 34  # on g20s ultra
622    charging_complete = 100
623    device_offline = 101
624    locked = 103
625    air_drying_stopping = 202
626    robot_status_mopping = 6301
627    clean_mop_cleaning = 6302
628    clean_mop_mopping = 6303
629    segment_mopping = 6304
630    segment_clean_mop_cleaning = 6305
631    segment_clean_mop_mopping = 6306
632    zoned_mopping = 6307
633    zoned_clean_mop_cleaning = 6308
634    zoned_clean_mop_mopping = 6309
635    back_to_dock_washing_duster = 6310