python-roborock 5.14.2__tar.gz → 5.15.1__tar.gz

{python_roborock-5.14.2 → python_roborock-5.15.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-roborock
-Version: 5.14.2
+Version: 5.15.1
 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/
@@ -17,8 +17,6 @@ Classifier: Topic :: Software Development :: Libraries
 Requires-Python: <4,>=3.11
 Requires-Dist: aiohttp<4,>=3.8.2
 Requires-Dist: aiomqtt<3,>=2.5.0
-Requires-Dist: click-shell~=2.1
-Requires-Dist: click>=8
 Requires-Dist: construct<3,>=2.10.57
 Requires-Dist: paho-mqtt<3.0.0,>=1.6.1
 Requires-Dist: protobuf<8,>=6.31.1
@@ -26,6 +24,11 @@ Requires-Dist: pycryptodomex~=3.18; sys_platform == 'darwin'
 Requires-Dist: pycryptodome~=3.18
 Requires-Dist: pyrate-limiter<5,>=4.0.0
 Requires-Dist: vacuum-map-parser-roborock
+Provides-Extra: cli
+Requires-Dist: click-shell~=2.1; extra == 'cli'
+Requires-Dist: click>=8; extra == 'cli'
+Requires-Dist: pyshark<0.7,>=0.6; extra == 'cli'
+Requires-Dist: pyyaml>=6.0.3; extra == 'cli'
 Description-Content-Type: text/markdown
 
 # Roborock
@@ -50,6 +53,11 @@ Install this via pip (or your favourite package manager):
 
 `pip install python-roborock`
 
+To use the `roborock` command line tool, install the `cli` extra, which pulls in
+its additional dependencies (click, pyyaml, pyshark):
+
+`pip install python-roborock[cli]`
+
 ## Example Usage
 
 See [examples/example.py](examples/example.py) for a more full featured example,

{python_roborock-5.14.2 → python_roborock-5.15.1}/README.md

@@ -20,6 +20,11 @@ Install this via pip (or your favourite package manager):
 
 `pip install python-roborock`
 
+To use the `roborock` command line tool, install the `cli` extra, which pulls in
+its additional dependencies (click, pyyaml, pyshark):
+
+`pip install python-roborock[cli]`
+
 ## Example Usage
 
 See [examples/example.py](examples/example.py) for a more full featured example,

{python_roborock-5.14.2 → python_roborock-5.15.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "python-roborock"
-version = "5.14.2"
+version = "5.15.1"
 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"
@@ -19,7 +19,6 @@ classifiers = [
     "Topic :: Software Development :: Libraries",
 ]
 dependencies = [
-    "click>=8",
     "aiohttp>=3.8.2,<4",
     "pycryptodome~=3.18",
     "pycryptodomex~=3.18 ; sys_platform == 'darwin'",
@@ -29,7 +28,16 @@ dependencies = [
     "vacuum-map-parser-roborock",
     "pyrate-limiter>=4.0.0,<5",
     "aiomqtt>=2.5.0,<3",
+]
+
+[project.optional-dependencies]
+# Dependencies required by the `roborock` command line tool (roborock.cli).
+# Install with: pip install python-roborock[cli]
+cli = [
+    "click>=8",
     "click-shell~=2.1",
+    "pyyaml>=6.0.3",
+    "pyshark>=0.6,<0.7",
 ]
 
 [project.urls]
@@ -41,20 +49,20 @@ roborock = "roborock.cli:main"
 
 [dependency-groups]
 dev = [
+    # Pull in the CLI dependencies so maintainers can run the `roborock`
+    # command and pdoc can import roborock.cli for docs generation.
+    "python-roborock[cli]",
     "pytest-asyncio>=1.1.0",
     "pytest",
     "pre-commit>=3.5,<5.0",
     "mypy",
     "ruff==0.14.11",
     "codespell",
-    "pyshark>=0.6,<0.7",
     "aioresponses>=0.7.7,<0.8",
     "freezegun>=1.5.1,<2",
     "pytest-timeout>=2.3.1,<3",
     "syrupy>=4.9.1,<6",
     "pdoc>=15.0.4,<17",
-    "pyyaml>=6.0.3",
-    "pyshark>=0.6",
     "pytest-cov>=7.0.0",
 ]
 

{python_roborock-5.14.2 → python_roborock-5.15.1}/roborock/cli.py

@@ -34,12 +34,18 @@ from dataclasses import asdict, dataclass
 from pathlib import Path
 from typing import Any, cast
 
-import click
-import click_shell
-import yaml
-from pyshark import FileCapture  # type: ignore
-from pyshark.capture.live_capture import LiveCapture, UnknownInterfaceException  # type: ignore
-from pyshark.packet.packet import Packet  # type: ignore
+try:
+    import click
+    import click_shell
+    import yaml
+    from pyshark import FileCapture  # type: ignore
+    from pyshark.capture.live_capture import LiveCapture, UnknownInterfaceException  # type: ignore
+    from pyshark.packet.packet import Packet  # type: ignore
+except ImportError as err:
+    raise SystemExit(
+        f"The 'roborock' command line tool requires extra dependencies that are not installed ({err.name}).\n"
+        "Install them with:\n\n    pip install python-roborock[cli]\n"
+    ) from err
 
 from roborock import RoborockCommand
 from roborock.data import RoborockBase, UserData

{python_roborock-5.14.2 → python_roborock-5.15.1}/roborock/devices/traits/v1/__init__.py

@@ -199,7 +199,7 @@ class PropertiesApi(Trait):
         self.device_features = DeviceFeaturesTrait(product, self._device_cache)
         self.status = StatusTrait(self.device_features, region=self._region)
         self.consumables = ConsumableTrait()
-        self.rooms = RoomsTrait(home_data, web_api)
+        self.rooms = RoomsTrait(home_data, device_uid, web_api)
         self.maps = MapsTrait(self.status)
         self.map_content = MapContentTrait(map_parser_config)
         self.home = HomeTrait(self.status, self.maps, self.map_content, self.rooms, self._device_cache)

{python_roborock-5.14.2 → python_roborock-5.15.1}/roborock/devices/traits/v1/rooms.py

@@ -84,12 +84,21 @@ class RoomsTrait(Rooms, common.V1TraitMixin):
     command = RoborockCommand.GET_ROOM_MAPPING
     converter = RoomsConverter()
 
-    def __init__(self, home_data: HomeData, web_api: UserWebApiClient) -> None:
+    def __init__(self, home_data: HomeData, device_uid: str, web_api: UserWebApiClient) -> None:
         """Initialize the RoomsTrait."""
         super().__init__()
         self._home_data = home_data
+        self._device_uid = device_uid
+        self._shared_device_uid = next(
+            (device.duid for device in home_data.received_devices if device.duid == device_uid), None
+        )
         self._web_api = web_api
         self._discovered_iot_ids: set[str] = set()
+        self._room_names: dict[str, str] = dict(home_data.rooms_name_map)
+
+    @property
+    def _room_name_map(self) -> dict[str, str]:
+        return self._room_names
 
     async def refresh(self) -> None:
         """Refresh room mappings and backfill unknown room names from the web API."""
@@ -104,12 +113,14 @@ class RoomsTrait(Rooms, common.V1TraitMixin):
 
         segment_map = RoomsConverter.extract_segment_map(response)
         # Track all iot ids seen before. Refresh the room list when new ids are found.
-        new_iot_ids = set(segment_map.values()) - set(self._home_data.rooms_map.keys())
+        new_iot_ids = set(segment_map.values()) - set(self._room_name_map.keys())
         if new_iot_ids - self._discovered_iot_ids:
             _LOGGER.debug("Refreshing room list to discover new room names")
             if updated_rooms := await self._refresh_rooms():
                 _LOGGER.debug("Updating rooms: %s", list(updated_rooms))
-                self._home_data.rooms = updated_rooms
+                self._room_names = {room.iot_id: room.name for room in updated_rooms}
+                if self._shared_device_uid is None:
+                    self._home_data.rooms = updated_rooms
             self._discovered_iot_ids.update(new_iot_ids)
         try:
             rooms = self.converter.convert(response)
@@ -121,12 +132,17 @@ class RoomsTrait(Rooms, common.V1TraitMixin):
                 inner_error=err,
             ) from err
 
-        rooms = rooms.with_room_names(self._home_data.rooms_name_map)
+        rooms = rooms.with_room_names(self._room_name_map)
         common.merge_trait_values(self, rooms)
 
     async def _refresh_rooms(self) -> list[HomeDataRoom]:
         """Fetch the latest rooms from the web API."""
         try:
+            if self._shared_device_uid is not None:
+                rooms_by_id = {room.iot_id: room for room in self._home_data.rooms}
+                shared_rooms = await self._web_api.get_shared_device_rooms(self._shared_device_uid)
+                rooms_by_id.update({room.iot_id: room for room in shared_rooms})
+                return list(rooms_by_id.values())
             return await self._web_api.get_rooms()
         except Exception:
             _LOGGER.debug("Failed to fetch rooms from web API", exc_info=True)

{python_roborock-5.14.2 → python_roborock-5.15.1}/roborock/web_api.py

@@ -558,6 +558,33 @@ class RoborockApiClient:
         else:
             raise RoborockException("home_response result was an unexpected type")
 
+    async def get_shared_device_rooms(self, user_data: UserData, device_id: str) -> list[HomeDataRoom]:
+        """Fetch room names for a shared (received) device."""
+        rriot = user_data.rriot
+        if rriot is None:
+            raise RoborockException("rriot is none")
+        if rriot.r.a is None:
+            raise RoborockException("Missing field 'a' in rriot reference")
+        path = f"/user/deviceshare/query/{device_id}/rooms"
+        room_request = PreparedRequest(
+            rriot.r.a,
+            self.session,
+            {"Authorization": _get_hawk_authentication(rriot, path)},
+        )
+        room_response = await room_request.request("get", path)
+        if not room_response.get("success"):
+            raise RoborockException(room_response)
+        rooms = room_response.get("result")
+        if isinstance(rooms, list):
+            output_list = []
+            for room in rooms:
+                normalized_room = room
+                if isinstance(room, dict) and "id" not in room and "roomId" in room:
+                    normalized_room = {**room, "id": room["roomId"]}
+                output_list.append(HomeDataRoom.from_dict(normalized_room))
+            return output_list
+        raise RoborockException("get_shared_device_rooms result was an unexpected type")
+
     async def get_scenes(self, user_data: UserData, device_id: str) -> list[HomeDataScene]:
         rriot = user_data.rriot
         if rriot is None:
@@ -775,6 +802,10 @@ class UserWebApiClient:
                 self._unauthorized_hook()
             raise
 
+    async def get_shared_device_rooms(self, device_id: str) -> list[HomeDataRoom]:
+        """Fetch shared-device rooms using the API client."""
+        return await self._web_api.get_shared_device_rooms(self._user_data, device_id)
+
     async def execute_routine(self, scene_id: int) -> None:
         """Execute a specific routine (scene) by its ID."""
         try: