python-roborock 5.37.1__tar.gz → 6.1.0__tar.gz

{python_roborock-5.37.1 → python_roborock-6.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-roborock
-Version: 5.37.1
+Version: 6.1.0
 Summary: A package to control Roborock vacuums.
 Project-URL: Repository, https://github.com/python-roborock/python-roborock
 Project-URL: Documentation, https://python-roborock.readthedocs.io/

{python_roborock-5.37.1 → python_roborock-6.1.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "python-roborock"
-version = "5.37.1"
+version = "6.1.0"
 description = "A package to control Roborock vacuums."
 authors = [{ name = "humbertogontijo", email = "humbertogontijo@users.noreply.github.com" }, {name="Lash-L"}, {name="allenporter"}]
 requires-python = ">=3.11, <4"

{python_roborock-5.37.1 → python_roborock-6.1.0}/roborock/data/code_mappings.py

@@ -10,10 +10,22 @@ completed_warnings = set()
 class RoborockEnum(IntEnum):
     """Roborock Enum for codes with int values"""
 
+    _display_name_: str | None
+
+    def __new__(cls, value: int, display_name: str | None = None) -> Self:
+        member = int.__new__(cls, value)
+        member._value_ = value
+        member._display_name_ = display_name
+        return member
+
     @property
     def name(self) -> str:
         return super().name.lower()
 
+    @property
+    def display_name(self) -> str:
+        return self._display_name_ or self.name
+
     @classmethod
     def _missing_(cls: type[Self], key) -> Self:
         if hasattr(cls, "unknown"):
@@ -30,8 +42,13 @@ class RoborockEnum(IntEnum):
         return default_value
 
     @classmethod
-    def as_dict(cls: type[Self]):
-        return {i.name: i.value for i in cls if i.name != "missing"}
+    def as_dict(cls: type[Self]) -> dict[str, int]:
+        result: dict[str, int] = {}
+        for item in cls:
+            if item.name == "missing":
+                continue
+            result.setdefault(item.display_name, item.value)
+        return result
 
     @classmethod
     def as_enum_dict(cls: type[Self]):

{python_roborock-5.37.1 → python_roborock-6.1.0}/roborock/data/dyad/dyad_code_mappings.py

@@ -95,7 +95,7 @@ class DyadError(RoborockEnum):
     battery_temperature_protection = (
         20007  # Battery temperature protection. Wait for the temperature to return to a normal range.
     )
-    battery_temperature_protection_2 = 20008
+    battery_temperature_protection_2 = (20008, "battery_temperature_protection")
     power_adapter_error = 20009  # Check if the power adapter is working properly.
     dirty_charging_contacts = 10007  # Disconnection between the device and dock. Wipe charging contacts.
     low_battery = 20017  # Low battery level. Charge before starting self-cleaning.

{python_roborock-5.37.1 → python_roborock-6.1.0}/roborock/data/v1/v1_code_mappings.py

@@ -8,40 +8,40 @@ class RoborockFinishReason(RoborockEnum):
     manual_interrupt = 21  # Cleaning interrupted by user
     cleanup_interrupted = 24  # Cleanup interrupted
     manual_interrupt_2 = 21
-    manual_interrupt_12 = 29
+    manual_interrupt_12 = (29, "manual_interrupt")
     breakpoint = 32  # Could not continue cleaning
-    breakpoint_2 = 33
-    cleanup_interrupted_2 = 34
-    manual_interrupt_3 = 35
-    manual_interrupt_4 = 36
-    manual_interrupt_5 = 37
-    manual_interrupt_6 = 43
+    breakpoint_2 = (33, "breakpoint")
+    cleanup_interrupted_2 = (34, "cleanup_interrupted")
+    manual_interrupt_3 = (35, "manual_interrupt")
+    manual_interrupt_4 = (36, "manual_interrupt")
+    manual_interrupt_5 = (37, "manual_interrupt")
+    manual_interrupt_6 = (43, "manual_interrupt")
     locate_fail = 45  # Positioning Failed
-    cleanup_interrupted_3 = 64
-    locate_fail_2 = 65
-    manual_interrupt_7 = 48
-    manual_interrupt_8 = 49
-    manual_interrupt_9 = 50
-    cleanup_interrupted_4 = 51
+    cleanup_interrupted_3 = (64, "cleanup_interrupted")
+    locate_fail_2 = (65, "locate_fail")
+    manual_interrupt_7 = (48, "manual_interrupt")
+    manual_interrupt_8 = (49, "manual_interrupt")
+    manual_interrupt_9 = (50, "manual_interrupt")
+    cleanup_interrupted_4 = (51, "cleanup_interrupted")
     finished_cleaning = 52  # Finished cleaning
-    finished_cleaning_2 = 54
-    finished_cleaning_3 = 55
-    finished_cleaning_4 = 56
-    finished_clenaing_5 = 57
-    manual_interrupt_10 = 60
+    finished_cleaning_2 = (54, "finished_cleaning")
+    finished_cleaning_3 = (55, "finished_cleaning")
+    finished_cleaning_4 = (56, "finished_cleaning")
+    finished_clenaing_5 = (57, "finished_cleaning")
+    manual_interrupt_10 = (60, "manual_interrupt")
     area_unreachable = 61  # Area unreachable
-    area_unreachable_2 = 62
+    area_unreachable_2 = (62, "area_unreachable")
     washing_error = 67  # Washing error
     back_to_wash_failure = 68  # Failed to return to the dock
-    cleanup_interrupted_5 = 101
-    breakpoint_4 = 102
-    manual_interrupt_11 = 103
-    cleanup_interrupted_6 = 104
-    cleanup_interrupted_7 = 105
-    cleanup_interrupted_8 = 106
-    cleanup_interrupted_9 = 107
-    cleanup_interrupted_10 = 109
-    cleanup_interrupted_11 = 110
+    cleanup_interrupted_5 = (101, "cleanup_interrupted")
+    breakpoint_4 = (102, "breakpoint")
+    manual_interrupt_11 = (103, "manual_interrupt")
+    cleanup_interrupted_6 = (104, "cleanup_interrupted")
+    cleanup_interrupted_7 = (105, "cleanup_interrupted")
+    cleanup_interrupted_8 = (106, "cleanup_interrupted")
+    cleanup_interrupted_9 = (107, "cleanup_interrupted")
+    cleanup_interrupted_10 = (109, "cleanup_interrupted")
+    cleanup_interrupted_11 = (110, "cleanup_interrupted")
     patrol_success = 114  # Cruise completed
     patrol_fail = 115  # Cruise failed
     pet_patrol_success = 116  # Pet found
@@ -159,7 +159,7 @@ class ClearWaterBoxStatus(RoborockDssCodes):
 
     okay = 0
     out_of_water = 1
-    out_of_water_2 = 38
+    out_of_water_2 = (38, "out_of_water")
     refill_error = 48
 
 
@@ -168,7 +168,7 @@ class DirtyWaterBoxStatus(RoborockDssCodes):
 
     okay = 0
     full_not_installed = 1
-    full_not_installed_2 = 39
+    full_not_installed_2 = (39, "full_not_installed")
     drain_error = 49
 
 
@@ -232,7 +232,7 @@ class RoborockErrorCode(RoborockEnum):
     clear_brush_exception = 42  # Check that the water filter has been correctly installed
     clear_brush_exception_2 = 43  # Positioning button error
     filter_screen_exception = 44  # Clean the dock water filter
-    mopping_roller_2 = 45  # Wash roller may be jammed
+    mopping_roller_2 = (45, "mopping_roller_1")  # Wash roller may be jammed
     up_water_exception = 48
     drain_water_exception = 49
     temperature_protection = 51  # Unit temperature protection
@@ -421,7 +421,7 @@ class RoborockStateCode(RoborockEnum):
     segment_cleaning = 18
     emptying_the_bin = 22  # on s7+
     washing_the_mop = 23  # on a46
-    washing_the_mop_2 = 25
+    washing_the_mop_2 = (25, "washing_the_mop")
     going_to_wash_the_mop = 26  # on a46
     in_call = 28
     mapping = 29

{python_roborock-5.37.1 → python_roborock-6.1.0}/roborock/data/v1/v1_containers.py

@@ -144,11 +144,11 @@ class StatusV2(RoborockBase):
 
     @property
     def error_code_name(self) -> str | None:
-        return self.error_code.name if self.error_code is not None else None
+        return self.error_code.display_name if self.error_code is not None else None
 
     @property
     def state_name(self) -> str | None:
-        return self.state.name if self.state is not None else None
+        return self.state.display_name if self.state is not None else None
 
     @property
     def current_map(self) -> int | None:

python_roborock-6.1.0/roborock/data/zeo/zeo_code_mappings.py

@@ -0,0 +1,320 @@
+"""Zeo (washing machine) device enums.
+
+Member-level comments show the manufacturer's official identifiers
+extracted from the React Native app plugin bundle.
+
+For enums that map between protocol-level positions and physical units
+(e.g. spin speed, temperature), the comment format is
+``# L<N>, <physical-value>`` where ``L<N>`` is the protocol position
+and ``<physical-value>`` is the user-facing display value
+(RPM, degrees Celsius, minutes, etc.).
+
+Enums commented out at the bottom of this file are App-internal lookup
+tables and UI state machines — they are not DP protocol enums and are
+never sent to the device.
+"""
+
+from ..code_mappings import RoborockEnum
+
+
+class ZeoFeatureBits(RoborockEnum):
+    """Bit positions in DP 237 (FEATURE_BITS).
+
+    Extracted from the official Roborock Washer app plugin bundle
+    (index.ios.bundle, module 726).  Each member's integer value
+    is the exact bit offset the device reports at DP 237.
+    """
+
+    smart_hosting = 0
+    silent_mode = 1
+    new_custom_program = 2
+    dry_care = 3
+    set_uvc_in_appointment = 4
+    detect_door_status = 5
+    expand_softener = 6
+    set_params_in_working = 7
+    thirty_min_soak = 8
+    smile_light = 9
+    set_uvc_in_pause = 10
+    concentrated_detergent = 11
+    wool_detergent = 12
+    voice_assistant = 13
+    adapted_custom_program = 14
+    voice_assistant_record = 15
+    fluff_clean_notification = 16
+    power_button_indicator_light = 17
+    dirt_detection = 18
+    deep_self_clean = 19
+    save_panel_program_params = 20
+    steam_care = 21
+    wash_dry_linkage = 22
+    ion_deodorization = 23
+
+
+class ZeoMode(RoborockEnum):
+    null = 0  # (not found in app bundle)
+    wash = 1
+    wash_and_dry = 2
+    dry = 3
+    treatment = 4
+
+
+class ZeoState(RoborockEnum):
+    standby = 1
+    weighing = 2  # Checking
+    soaking = 3
+    washing = 4
+    rinsing = 5
+    spinning = 6  # Dewatering
+    drying = 7
+    cooling = 8
+    under_delay_start = 9  # Appointment
+    done = 10  # Complete
+    updating = 11
+    aftercare = 12  # SmartHosting
+    waiting_for_aftercare = 13  # SmartHostingWaiting
+    steam_caring = 14
+    descaling = 15
+    cloth_ready = 16
+    waiting_for_drying = 17
+    pre_heating = 18
+    pre_heat_complete = 19
+    in_care = 20
+
+
+class ZeoProgram(RoborockEnum):
+    null = 0  # (not found in app bundle)
+    standard = 1  # Mixed
+    quick = 2
+    sanitize = 3  # Sterilization
+    wool = 4
+    air_refresh = 5  # Air
+    custom = 6  # CloudProgram
+    bedding = 7  # HomeTextile
+    down = 8
+    silk = 9
+    rinse_and_spin = 10  # RinseAndDehydrate
+    spin = 11  # Dehydrate
+    down_clean = 12  # SelfClean
+    baby_care = 13  # Baby
+    anti_allergen = 14  # MitesRemoval
+    sportswear = 15  # Sports
+    night = 16
+    new_clothes = 17  # New
+    shirts = 18  # Shirt
+    synthetics = 19  # ChemicalFiber
+    underwear = 20
+    gentle = 21  # Soft
+    intensive = 22  # Strong
+    cotton_linen = 23  # CottonOrLinen
+    season = 24
+    warming = 25  # Warm
+    bra = 26
+    panties = 27  # Underpants
+    boiling_wash = 28  # Boiling
+    soaking = 29
+    socks = 30
+    towels = 31  # Towel
+    anti_mite = 32  # MitesRemoval2
+    exo_40_60 = 33  # Eco
+    twenty_c = 34  # TwentyDegrees
+    t_shirts = 35  # TShirt
+    stain_removal = 36  # Dirt
+    small_things = 37
+    mixing = 39
+    bath_towel = 40
+    jeans = 41
+    outdoors = 42
+    timed_drying = 43
+    outdoor_jackets = 44
+    yoga = 45
+    quilt_drying = 46
+    flax = 47
+    suit = 48
+    sport_shoes = 49
+    rack_drying = 50
+    summer_quilt = 51
+    wind_breaker = 52
+    steam_care = 53
+    descaling = 54
+    deep_self_clean = 55
+    pet_care = 56
+    small_things_drying = 57
+
+
+class ZeoSoak(RoborockEnum):
+    normal = 0  # L0, 0min
+    low = 1  # L1, 5min
+    medium = 2  # L2, 10min
+    high = 3  # L3, 15min
+    max = 4  # L4, 20min
+    very_max = 5  # L5, 30min
+
+
+class ZeoTemperature(RoborockEnum):
+    normal = 1  # L1, 0 C
+    low = 2  # L2, 30 C
+    medium = 3  # L3, 40 C
+    high = 4  # L4, 60 C
+    max = 5  # L5, 90 C
+    twenty_c = 6  # L6, 20 C
+    ninety_c = 7  # L7, 95 C
+
+
+class ZeoRinse(RoborockEnum):
+    none = 0  # L0, None
+    min = 1  # L1, Min
+    low = 2  # L2, Low
+    mid = 3  # L3, Mid
+    high = 4  # L4, High
+    max = 5  # L5, Max
+
+
+class ZeoSpin(RoborockEnum):
+    null = 0  # (not found in app bundle)
+    none = 1  # L1, 0 RPM
+    very_low = 2  # L2, 400 RPM
+    low = 3  # L3, 600 RPM
+    mid = 4  # L4, 800 RPM
+    high = 5  # L5, 1000 RPM
+    very_high = 6  # L6, 1200 RPM
+    max = 7  # L7, 1400 RPM
+
+
+class ZeoDryingMode(RoborockEnum):
+    none = 0
+    quick = 1  # Quick, Mid
+    iron = 2  # Iron, Low
+    store = 3  # Store, High
+
+
+class ZeoDetergentType(RoborockEnum):
+    empty = 0  # T0
+    low = 1  # T1
+    medium = 2  # T2
+    high = 3  # T3
+
+
+class ZeoSoftenerType(RoborockEnum):
+    empty = 0  # T0
+    low = 1  # T1
+    medium = 2  # T2
+    high = 3  # T3
+
+
+class ZeoDetergentExpansionType(RoborockEnum):
+    concentrated_detergent = 1
+    detergent = 2
+
+
+class ZeoSoftenerExpansionType(RoborockEnum):
+    softener = 1
+    softener_expansion = 2
+    wool_detergent = 3
+
+
+class ZeoDirtDetectionStatus(RoborockEnum):
+    idle = 0
+    detecting = 1
+    detection_completed = 2
+
+
+class ZeoError(RoborockEnum):
+    none = 0  # No error
+    refill_error = 1  # Refill error (E1). Check if the water tap is turned on.
+    drain_error = 2  # Drain error (E2). Check the drain hose.
+    door_lock_error = 3  # Door lock error (E3). Close the door properly.
+    water_level_error = 4  # Drum water level error (E4).
+    inverter_error = 5  # DD motor variable-frequency drive error (E5).
+    heating_error = 6  # Water heater error (E6).
+    temperature_error = 7  # Drum water temperature error (E7).
+    communication_error = 10  # Communication error (E10).
+    drying_error = 11  # Temperature error (E11).
+    drying_error_e_12 = 12  # Temperature error (E12).
+    drying_error_e_13 = 13  # Temperature error (E13).
+    drying_error_e_14 = 14  # Temperature error (E14).
+    drying_error_e_15 = 15  # Drying air heater error (E15).
+    drying_error_e_16 = 16  # Fan RPM error (E16).
+    drying_error_water_flow = 17  # Drying temperature protection (E17).
+    drying_error_restart = 18  # Fan RPM error (E18).
+    spin_error = 19  # Balance error (Unb).
+
+
+class ZeoDryingMethod(RoborockEnum):
+    l1 = 1  # L1, Saving
+    l2 = 2  # L2, Standard
+    l3 = 3  # L3, SuperFast
+
+
+class ZeoSteamVolume(RoborockEnum):
+    none = 0  # L0, None
+    low = 1  # L1, Min
+    medium = 2  # L2, Low
+    high = 3  # L3, Mid
+    max = 4  # L4, High
+
+
+class ZeoDryAndCare(RoborockEnum):
+    soft = 1
+    normal = 2
+
+
+class ZeoDryerStartError(RoborockEnum):
+    dryer_running = 1  # Washer-Dryer Pairing cannot start: Dryer is running.
+    dryer_error = 2  # Washer-Dryer Pairing cannot start: Dryer has an error.
+    dryer_done = 3  # Dryer drying is complete, please remove the clothes first.
+    dryer_waiting_hosting = 4  # Dryer is waiting for smart hosting.
+    dryer_smart_hosting = 5  # Dryer is in smart hosting mode.
+    dryer_countdown = 6  # Dryer is in preset countdown.
+    dryer_network_fail = 7  # Please check the dryer network connection.
+
+
+# The following are App-internal lookup tables extracted from the bundle.
+# They are NOT DP protocol enums — the device never receives these values.
+# They control how the official app adjusts recommended dosages or UI visibility.
+#
+# class Cleanser(RoborockEnum):
+#     detergent = 0
+#     additions = 1
+#
+# class Detergents(RoborockEnum):
+#     concentrated = 1
+#     regular = 2
+#     baby = 3
+#
+# class Additions(RoborockEnum):
+#     softener = 1
+#     disinfectant = 2
+#     fragrance = 3
+#
+# The following are App UI state enums — internal state machines used by the
+# official app for page rendering and progress display.
+#
+# class HomePageStatus(RoborockEnum):
+#     updating = 0
+#     loading = 1
+#     load_failed = 2
+#     idle = 3
+#     working = 4
+#     smart_hosting = 5
+#     preset = 6
+#     descaling = 7
+#     cloth_ready = 8
+#     wait_to_dry = 9
+#
+# class Progress(RoborockEnum):
+#     soak = 0
+#     wash = 1
+#     rinse = 2
+#     spin = 3
+#     dry = 4
+#     steam_care = 5
+#
+# class ProgressStatus(RoborockEnum):
+#     done = 0
+#     doing = 1
+#     will_do = 2
+#
+# class SmartHostStatus(RoborockEnum):
+#     smart_host_waiting = 0
+#     smart_hosting = 1

python_roborock-6.1.0/roborock/data/zeo/zeo_containers.py

@@ -0,0 +1,140 @@
+"""Data containers for Zeo (washing machine / dryer) devices."""
+
+from dataclasses import dataclass
+
+from ..containers import RoborockBase
+from .zeo_code_mappings import (
+    ZeoDryAndCare,
+    ZeoDryingMethod,
+    ZeoDryingMode,
+    ZeoMode,
+    ZeoProgram,
+    ZeoRinse,
+    ZeoSoak,
+    ZeoSpin,
+    ZeoSteamVolume,
+    ZeoTemperature,
+)
+
+
+@dataclass
+class ZeoStartParams(RoborockBase):
+    """Parameters that must be bundled with a START command.
+
+    All Zeo devices require ``mode`` and ``program`` to be sent together
+    with the start signal. The remaining fields are optional and only
+    included when the device reports a non-None value.
+    """
+
+    mode: ZeoMode
+    program: ZeoProgram
+    temperature: ZeoTemperature | None = None
+    rinse: ZeoRinse | None = None
+    spin: ZeoSpin | None = None
+    drying_mode: ZeoDryingMode | None = None
+
+
+# ── DP 222 (LoadCloudProgram) bitfield decoder ──────────────────────────
+# The official app packs all custom-program parameters into a single
+# 32-bit integer at DP 222.  This mirrors WasherDpsCache.customMode in
+# module 725 of the React Native plugin bundle.
+
+
+@dataclass
+class ZeoCustomMode(RoborockBase):
+    """Decoded custom programme parameters from DP 222 (LoadCloudProgram).
+
+    Null / absent fields are represented as ``0`` which matches the
+    official app's behaviour (the right-shifted-and-masked value is
+    always non-negative).
+    """
+
+    program: ZeoProgram
+    """Wash program (bits 0-7)."""
+
+    mode: ZeoMode
+    """Wash mode (bits 8-9)."""
+
+    temperature: ZeoTemperature
+    """Temperature (bits 10-12)."""
+
+    rinse: ZeoRinse
+    """Rinse cycle (bits 13-15)."""
+
+    spin: ZeoSpin
+    """Spin speed (bits 16-18)."""
+
+    drying_mode: ZeoDryingMode
+    """Drying mode (bits 19-21)."""
+
+    soak: ZeoSoak
+    """Soak (bits 22-24)."""
+
+    dry_and_care: ZeoDryAndCare
+    """Dry-care mode (bits 25-27)."""
+
+    steam_volume: ZeoSteamVolume
+    """Steam volume (bits 28-30)."""
+
+    total_time_min: int = 0
+    """Total programme time in minutes (from DP 239)."""
+
+    @classmethod
+    def from_raw(cls, raw: int, total_time_min: int | None = None) -> "ZeoCustomMode":
+        """Decode a raw 32-bit custom-programme value."""
+        return cls(
+            program=ZeoProgram(raw & 0xFF),
+            mode=ZeoMode((raw >> 8) & 0x3),
+            temperature=ZeoTemperature((raw >> 10) & 0x7),
+            rinse=ZeoRinse((raw >> 13) & 0x7),
+            spin=ZeoSpin((raw >> 16) & 0x7),
+            drying_mode=ZeoDryingMode((raw >> 19) & 0x7),
+            soak=ZeoSoak((raw >> 22) & 0x7),
+            dry_and_care=ZeoDryAndCare((raw >> 25) & 0x7),
+            steam_volume=ZeoSteamVolume((raw >> 28) & 0x7),
+            total_time_min=total_time_min or 0,
+        )
+
+
+@dataclass
+class ZeoDryerCustomMode(RoborockBase):
+    """Decoded custom programme from DP 222 for a standalone dryer.
+
+    Dryers pack a different (shorter) bitfield than washers — only 5
+    fields after program/mode.  Mirrors ``WasherDpsCache.dryerCustomMode``
+    in module 725 of the plugin bundle.
+    """
+
+    program: ZeoProgram
+    """Drying program (bits 0-7)."""
+
+    mode: ZeoMode
+    """Drying mode (bits 8-10)."""
+
+    drying_mode: ZeoDryingMode
+    """Drying level (bits 11-13)."""
+
+    drying_method: ZeoDryingMethod
+    """Drying method (bits 14-16)."""
+
+    steam_volume: ZeoSteamVolume
+    """Steam volume (bits 17-19)."""
+
+    total_time_min: int = 0
+    """Total programme time in minutes (from DP 239)."""
+
+    @classmethod
+    def from_raw(cls, raw: int, total_time_min: int | None = None) -> "ZeoDryerCustomMode":
+        """Decode a raw 32-bit dryer custom-programme value."""
+        return cls(
+            program=ZeoProgram(raw & 0xFF),
+            # Dryer mode spans bits 8-10 (0x700, 3 bits) because the
+            # temperature field is absent from the dryer bitfield and
+            # bit 10 is re-allocated to mode.  Washer uses 2 bits
+            # (0x300, bits 8-9) to make room for temperature at 10-12.
+            mode=ZeoMode((raw >> 8) & 0x7),
+            drying_mode=ZeoDryingMode((raw >> 11) & 0x7),
+            drying_method=ZeoDryingMethod((raw >> 14) & 0x7),
+            steam_volume=ZeoSteamVolume((raw >> 17) & 0x7),
+            total_time_min=total_time_min or 0,
+        )