botslab360 0.4.1__tar.gz → 0.4.2__tar.gz

{botslab360-0.4.1/src/botslab360.egg-info → botslab360-0.4.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: botslab360
-Version: 0.4.1
+Version: 0.4.2
 Summary: Async Python client for Botslab/360 robot vacuums
 License-Expression: MIT
 Project-URL: Source, https://github.com/placix/python-botslab360
@@ -217,12 +217,13 @@ map coordinate system (integer millimetres, original point order). Missing or
 malformed polygons are exposed as `None`; raw MapInfo data is not exposed.
 
 The Android room-attribute UI defines one or two cleaning passes, four suction
-modes, and three mopping water levels. Optional settings can override the
-current attributes for selected rooms in one cleaning request:
+modes, three mopping water levels, and three cleaning modes. Optional settings
+can override the current attributes for selected rooms in one cleaning request:
 
 ```python
 from botslab360 import (
     RoomCleaningSettings,
+    RoomCleaningMode,
     RoomFanMode,
     RoomWaterLevel,
 )
@@ -232,6 +233,7 @@ await client.clean_rooms(
     [1],
     room_settings={
         1: RoomCleaningSettings(
+            mode=RoomCleaningMode.SWEEP,
             clean_times=2,
             fan_mode=RoomFanMode.STRONG,
             water_pump=RoomWaterLevel.MEDIUM,
@@ -248,6 +250,12 @@ Water levels are `1` (low), `2` (medium), and `3` (high). An existing vendor
 `waterPump=0` value is preserved when not overridden, but `0` is not exposed as
 an "off" choice because that meaning has not been confirmed.
 
+Cleaning modes are `1` (sweep and mop), `2` (sweep), and `3` (mop). Mode `2`
+has been verified on a real robot; the assignments for modes `1` and `3` remain
+provisional pending real-device verification. `Room.mode` preserves unknown
+integer values reported by future vendor firmware, while outgoing overrides are
+limited to the currently supported values.
+
 ## Status information
 
 Depending on the robot model, status information may include:

{botslab360-0.4.1 → botslab360-0.4.2}/README.md

@@ -197,12 +197,13 @@ map coordinate system (integer millimetres, original point order). Missing or
 malformed polygons are exposed as `None`; raw MapInfo data is not exposed.
 
 The Android room-attribute UI defines one or two cleaning passes, four suction
-modes, and three mopping water levels. Optional settings can override the
-current attributes for selected rooms in one cleaning request:
+modes, three mopping water levels, and three cleaning modes. Optional settings
+can override the current attributes for selected rooms in one cleaning request:
 
 ```python
 from botslab360 import (
     RoomCleaningSettings,
+    RoomCleaningMode,
     RoomFanMode,
     RoomWaterLevel,
 )
@@ -212,6 +213,7 @@ await client.clean_rooms(
     [1],
     room_settings={
         1: RoomCleaningSettings(
+            mode=RoomCleaningMode.SWEEP,
             clean_times=2,
             fan_mode=RoomFanMode.STRONG,
             water_pump=RoomWaterLevel.MEDIUM,
@@ -228,6 +230,12 @@ Water levels are `1` (low), `2` (medium), and `3` (high). An existing vendor
 `waterPump=0` value is preserved when not overridden, but `0` is not exposed as
 an "off" choice because that meaning has not been confirmed.
 
+Cleaning modes are `1` (sweep and mop), `2` (sweep), and `3` (mop). Mode `2`
+has been verified on a real robot; the assignments for modes `1` and `3` remain
+provisional pending real-device verification. `Room.mode` preserves unknown
+integer values reported by future vendor firmware, while outgoing overrides are
+limited to the currently supported values.
+
 ## Status information
 
 Depending on the robot model, status information may include:

{botslab360-0.4.1 → botslab360-0.4.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "botslab360"
-version = "0.4.1"
+version = "0.4.2"
 description = "Async Python client for Botslab/360 robot vacuums"
 readme = "README.md"
 requires-python = ">=3.10"

{botslab360-0.4.1 → botslab360-0.4.2}/src/botslab360/__init__.py

@@ -19,6 +19,7 @@ from .models import (
     QihooCredentials,
     RobotStatus,
     Room,
+    RoomCleaningMode,
     RoomCleaningSettings,
     RoomFanMode,
     RoomWaterLevel,
@@ -42,6 +43,7 @@ __all__ = [
     "QucAuthenticationError",
     "RobotStatus",
     "Room",
+    "RoomCleaningMode",
     "RoomCleaningSettings",
     "RoomFanMode",
     "RoomWaterLevel",

{botslab360-0.4.1 → botslab360-0.4.2}/src/botslab360/models.py

@@ -111,6 +111,7 @@ class Room:
     fan_mode: str | None
     water_pump: int | None
     vertices: tuple[tuple[int, int], ...] | None = None
+    mode: int | None = None
 
 
 class RoomFanMode(str, Enum):
@@ -130,6 +131,14 @@ class RoomWaterLevel(IntEnum):
     HIGH = 3
 
 
+class RoomCleaningMode(IntEnum):
+    """Cleaning modes supported by the Android room-attribute UI."""
+
+    SWEEP_AND_MOP = 1
+    SWEEP = 2
+    MOP = 3
+
+
 ROOM_CLEAN_TIMES = (1, 2)
 
 
@@ -140,6 +149,7 @@ class RoomCleaningSettings:
     clean_times: int | None = None
     fan_mode: str | None = None
     water_pump: int | None = None
+    mode: int | None = None
 
 
 @dataclass(frozen=True, slots=True)

{botslab360-0.4.1 → botslab360-0.4.2}/src/botslab360/rooms.py

@@ -18,6 +18,7 @@ from .exceptions import ApiError
 from .models import (
     ROOM_CLEAN_TIMES,
     Room,
+    RoomCleaningMode,
     RoomCleaningSettings,
     RoomFanMode,
     RoomWaterLevel,
@@ -73,6 +74,7 @@ class RoomMap:
 
 _ROOM_FAN_MODE_VALUES = frozenset(mode.value for mode in RoomFanMode)
 _ROOM_WATER_LEVEL_VALUES = frozenset(level.value for level in RoomWaterLevel)
+_ROOM_CLEANING_MODE_VALUES = frozenset(mode.value for mode in RoomCleaningMode)
 
 
 def validate_room_cleaning_settings(settings: object) -> RoomCleaningSettings:
@@ -99,6 +101,11 @@ def validate_room_cleaning_settings(settings: object) -> RoomCleaningSettings:
             raise TypeError("water_pump must be an integer")
         if settings.water_pump not in _ROOM_WATER_LEVEL_VALUES:
             raise ValueError("water_pump must be 1, 2, or 3")
+    if settings.mode is not None:
+        if isinstance(settings.mode, bool) or not isinstance(settings.mode, int):
+            raise TypeError("mode must be an integer")
+        if settings.mode not in _ROOM_CLEANING_MODE_VALUES:
+            raise ValueError("mode must be 1, 2, or 3")
     return settings
 
 
@@ -273,6 +280,7 @@ def parse_room_map(map_info: object) -> RoomMap:
                 fan_mode=_optional_str(area.get("windMode")),
                 water_pump=_optional_int(area.get("waterPump")),
                 vertices=_room_vertices(area.get("vertexs")),
+                mode=_optional_int(area.get("mode")),
             )
         )
     return RoomMap(
@@ -299,6 +307,8 @@ def _apply_room_settings(
             area["windMode"] = settings.fan_mode
         if settings.water_pump is not None:
             area["waterPump"] = settings.water_pump
+        if settings.mode is not None:
+            area["mode"] = settings.mode
 
 
 def prepare_area_setting(

{botslab360-0.4.1 → botslab360-0.4.2/src/botslab360.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: botslab360
-Version: 0.4.1
+Version: 0.4.2
 Summary: Async Python client for Botslab/360 robot vacuums
 License-Expression: MIT
 Project-URL: Source, https://github.com/placix/python-botslab360
@@ -217,12 +217,13 @@ map coordinate system (integer millimetres, original point order). Missing or
 malformed polygons are exposed as `None`; raw MapInfo data is not exposed.
 
 The Android room-attribute UI defines one or two cleaning passes, four suction
-modes, and three mopping water levels. Optional settings can override the
-current attributes for selected rooms in one cleaning request:
+modes, three mopping water levels, and three cleaning modes. Optional settings
+can override the current attributes for selected rooms in one cleaning request:
 
 ```python
 from botslab360 import (
     RoomCleaningSettings,
+    RoomCleaningMode,
     RoomFanMode,
     RoomWaterLevel,
 )
@@ -232,6 +233,7 @@ await client.clean_rooms(
     [1],
     room_settings={
         1: RoomCleaningSettings(
+            mode=RoomCleaningMode.SWEEP,
             clean_times=2,
             fan_mode=RoomFanMode.STRONG,
             water_pump=RoomWaterLevel.MEDIUM,
@@ -248,6 +250,12 @@ Water levels are `1` (low), `2` (medium), and `3` (high). An existing vendor
 `waterPump=0` value is preserved when not overridden, but `0` is not exposed as
 an "off" choice because that meaning has not been confirmed.
 
+Cleaning modes are `1` (sweep and mop), `2` (sweep), and `3` (mop). Mode `2`
+has been verified on a real robot; the assignments for modes `1` and `3` remain
+provisional pending real-device verification. `Room.mode` preserves unknown
+integer values reported by future vendor firmware, while outgoing overrides are
+limited to the currently supported values.
+
 ## Status information
 
 Depending on the robot model, status information may include:

{botslab360-0.4.1 → botslab360-0.4.2}/tests/test_rooms.py

@@ -17,6 +17,7 @@ from botslab360 import (
     Device,
     InvalidSessionError,
     Room,
+    RoomCleaningMode,
     RoomCleaningSettings,
     RoomFanMode,
     RoomWaterLevel,
@@ -56,7 +57,7 @@ def smart_area() -> dict:
             "forbidType": "none",
             "id": room_id,
             "material": 0,
-            "mode": "normal",
+            "mode": 2,
             "name": encoded_name(f"Room {room_id}"),
             "radius": 0,
             "relativeRoom": -1,
@@ -143,6 +144,7 @@ def test_map_info_parses_ten_public_rooms() -> None:
         clean_times=2,
         fan_mode="max",
         water_pump=2,
+        mode=2,
     )
     assert parsed.rooms[9].room_type is None
     assert parsed.map_id == 1
@@ -213,6 +215,22 @@ def test_room_model_remains_compatible_without_vertices() -> None:
     room = Room(1, "Bad", None, 2, "max", 0)
 
     assert room.vertices is None
+    assert room.mode is None
+
+
+@pytest.mark.parametrize("mode", [1, 2, 3, 99])
+def test_room_mode_parsing_preserves_supported_and_unknown_values(mode: int) -> None:
+    payload = map_info()
+    payload["smartArea"]["value"][1]["mode"] = mode
+
+    assert parse_room_map(payload).rooms[1].mode == mode
+
+
+def test_room_mode_parsing_ignores_malformed_values() -> None:
+    payload = map_info()
+    payload["smartArea"]["value"][1]["mode"] = "future-mode"
+
+    assert parse_room_map(payload).rooms[1].mode is None
 
 
 def test_public_room_setting_choices_match_android_values() -> None:
@@ -224,6 +242,19 @@ def test_public_room_setting_choices_match_android_values() -> None:
         "max",
     ]
     assert [level.value for level in RoomWaterLevel] == [1, 2, 3]
+    assert [mode.value for mode in RoomCleaningMode] == [1, 2, 3]
+
+
+@pytest.mark.parametrize("mode", [1, 2, 3])
+def test_prepare_area_setting_accepts_supported_cleaning_modes(mode: int) -> None:
+    room_map = parse_room_map(map_info())
+
+    result = json.loads(
+        prepare_area_setting(room_map, [1], {1: RoomCleaningSettings(mode=mode)})
+    )
+
+    assert result["value"][1]["mode"] == mode
+    assert result["value"][0] == room_map.area_setting["value"][0]
 
 
 @pytest.mark.parametrize(
@@ -232,13 +263,20 @@ def test_public_room_setting_choices_match_android_values() -> None:
         (RoomCleaningSettings(clean_times=1), {"cleanTimes": 1}),
         (RoomCleaningSettings(fan_mode="quiet"), {"windMode": "quiet"}),
         (RoomCleaningSettings(water_pump=3), {"waterPump": 3}),
+        (RoomCleaningSettings(mode=2), {"mode": 2}),
         (
             RoomCleaningSettings(
                 clean_times=1,
                 fan_mode=RoomFanMode.AUTO,
                 water_pump=RoomWaterLevel.LOW,
+                mode=RoomCleaningMode.SWEEP_AND_MOP,
             ),
-            {"cleanTimes": 1, "windMode": "auto", "waterPump": 1},
+            {
+                "cleanTimes": 1,
+                "windMode": "auto",
+                "waterPump": 1,
+                "mode": 1,
+            },
         ),
     ],
 )
@@ -300,6 +338,10 @@ def test_prepare_area_setting_supports_different_selected_room_settings() -> Non
         (RoomCleaningSettings(water_pump=4), ValueError),
         (RoomCleaningSettings(water_pump=True), TypeError),
         (RoomCleaningSettings(water_pump="1"), TypeError),  # type: ignore[arg-type]
+        (RoomCleaningSettings(mode=0), ValueError),
+        (RoomCleaningSettings(mode=4), ValueError),
+        (RoomCleaningSettings(mode=True), TypeError),
+        (RoomCleaningSettings(mode="2"), TypeError),  # type: ignore[arg-type]
         (object(), TypeError),
     ],
 )
@@ -477,13 +519,15 @@ def test_clean_rooms_sends_per_room_overrides_through_public_api(
         (RoomCleaningSettings(clean_times=1), {"cleanTimes": 1}),
         (RoomCleaningSettings(fan_mode="quiet"), {"windMode": "quiet"}),
         (RoomCleaningSettings(water_pump=3), {"waterPump": 3}),
+        (RoomCleaningSettings(mode=2), {"mode": 2}),
         (
             RoomCleaningSettings(
                 clean_times=1,
                 fan_mode="strong",
                 water_pump=3,
+                mode=3,
             ),
-            {"cleanTimes": 1, "windMode": "strong", "waterPump": 3},
+            {"cleanTimes": 1, "windMode": "strong", "waterPump": 3, "mode": 3},
         ),
     ],
 )
@@ -603,6 +647,9 @@ def test_clean_rooms_preserves_vendor_water_pump_zero(monkeypatch) -> None:
         ([1], {1: RoomCleaningSettings(water_pump=0)}, ValueError),
         ([1], {1: RoomCleaningSettings(water_pump=4)}, ValueError),
         ([1], {1: RoomCleaningSettings(water_pump=True)}, TypeError),
+        ([1], {1: RoomCleaningSettings(mode=0)}, ValueError),
+        ([1], {1: RoomCleaningSettings(mode=4)}, ValueError),
+        ([1], {1: RoomCleaningSettings(mode=True)}, TypeError),
         ([1], {1: object()}, TypeError),
         ([1], {6: RoomCleaningSettings(clean_times=1)}, ValueError),
         ([1], {True: RoomCleaningSettings(clean_times=1)}, TypeError),