Add map id to RoomsEvent (#1434)

Author: edenhaus

deebot_client/commands/json/map/__init__.py

@@ -84,7 +84,7 @@ def _handle_subsets(
         :return: A message response
         """
         subset_ids = [int(subset["mssid"]) for subset in data["subsets"]]
-        event_bus.notify(MapSetEvent(MapSetType(data["type"]), subset_ids))
+        event_bus.notify(MapSetEvent(MapSetType(data["type"]), subset_ids, data["mid"]))
         return cls._get_handling_success_with_subset_command_args(data, subset_ids)
 
     @classmethod
@@ -236,10 +236,11 @@ def _handle_subsets(
         """
         # subset is based64 7z compressed
         subsets = orjson.loads(decompress_base64_data(data["subsets"]).decode())
+        map_id = data["mid"]
 
         match map_type := data["type"]:
             case MapSetType.ROOMS:
-                return cls._handle_rooms_subsets(event_bus, data, subsets)
+                return cls._handle_rooms_subsets(event_bus, data, subsets, map_id)
 
             case MapSetType.VIRTUAL_WALLS | MapSetType.NO_MOP_ZONES:
                 subset_ids = []
@@ -258,7 +259,7 @@ def _handle_subsets(
                     )
                     subset_ids.append(int(mssid))
 
-                event_bus.notify(MapSetEvent(MapSetType(map_type), subset_ids))
+                event_bus.notify(MapSetEvent(MapSetType(map_type), subset_ids, map_id))
                 return HandlingResult.success()
 
         return HandlingResult.analyse()
@@ -269,6 +270,7 @@ def _handle_rooms_subsets(
         event_bus: EventBus,
         data: dict[str, Any],
         subsets: list[list[str]],
+        map_id: str,
     ) -> HandlingResult:
         # there are two versions of this message, depending on the number of values
         if subsets and len(subsets[0]) == 10:
@@ -286,7 +288,9 @@ def _handle_rooms_subsets(
 
             # coordinates are sent in the MapInfo_V2 message
             event_bus.notify(
-                RoomsEvent([Room(subset[1], int(subset[0]), "") for subset in subsets])
+                RoomsEvent(
+                    map_id, [Room(subset[1], int(subset[0]), "") for subset in subsets]
+                )
             )
 
             # GetMapSubSet isn't supported for this robot and not needed
@@ -303,7 +307,7 @@ def _handle_rooms_subsets(
         # 8 -> named all as 'settingName1'
         # return the subset ids to trigger GetMapSubSet for each one
         subset_ids = [int(subset[0]) for subset in subsets]
-        event_bus.notify(MapSetEvent(MapSetType.ROOMS, subset_ids))
+        event_bus.notify(MapSetEvent(MapSetType.ROOMS, subset_ids, map_id))
         return cls._get_handling_success_with_subset_command_args(data, subset_ids)
 
 

deebot_client/commands/xml/map.py

@@ -125,7 +125,9 @@ def _handle_xml(cls, event_bus: EventBus, xml: Element) -> HandlingResult:
 
         xml_subsets = xml.findall("m")
         subsets = cls._find_subsets(xml_subsets)
-        event_bus.notify(MapSetEvent(MapSetType(area_type), subsets=subsets))
+        event_bus.notify(
+            MapSetEvent(MapSetType(area_type), subsets=subsets, map_id=msid)
+        )
         args = {
             cls._ARGS_MSID: msid,
             cls._ARGS_TYPE: area_type,

deebot_client/events/__init__.py

@@ -170,6 +170,7 @@ class LifeSpanEvent(Event):
 class RoomsEvent(Event):
     """Room event representation."""
 
+    map_id: str
     rooms: list[Room]
 
 

deebot_client/events/map.py

@@ -93,6 +93,7 @@ class MapSetEvent(Event):
 
     type: MapSetType
     subsets: list[int]
+    map_id: str
 
 
 @dataclass(frozen=True)

deebot_client/map.py

@@ -270,11 +270,13 @@ def __init__(self, event_bus: EventBus, on_change: Callable[[], None]) -> None:
         self._amount_rooms: int = 0
         self._rooms: OnChangedDict[int, Room] = OnChangedDict(on_change)
         self._unsubscribers: list[Callable[[], None]] = []
+        self._map_id: str = ""
 
         async def on_map_set(event: MapSetEvent) -> None:
             if event.type != MapSetType.ROOMS:
                 return
 
+            self._map_id = event.map_id
             self._amount_rooms = len(event.subsets)
             for room_id in self._rooms.copy():
                 if room_id not in event.subsets:
@@ -291,7 +293,9 @@ async def on_map_subset(event: MapSubsetEvent) -> None:
                 self._rooms[room.id] = room
 
                 if len(self._rooms) == self._amount_rooms:
-                    event_bus.notify(RoomsEvent(list(self._rooms.values())))
+                    event_bus.notify(
+                        RoomsEvent(self._map_id, list(self._rooms.values()))
+                    )
 
         self._unsubscribers.append(event_bus.subscribe(MapSubsetEvent, on_map_subset))
 

tests/commands/json/map/test_init.py

@@ -206,7 +206,7 @@ async def test_getMapSet() -> None:
             for subset in subsets
         ),
     )
-    events = [firmware_event, MapSetEvent(MapSetType.ROOMS, subsets)]
+    events = [firmware_event, MapSetEvent(MapSetType.ROOMS, subsets, mid)]
     for subset in subsets:
         events.extend(
             [
@@ -255,7 +255,7 @@ async def test_getMapSet() -> None:
                     MapSetType.VIRTUAL_WALLS,
                     "['2120', '-4581', '2106', '-6271']",
                 ),
-                MapSetEvent(MapSetType.VIRTUAL_WALLS, [0, 1]),
+                MapSetEvent(MapSetType.VIRTUAL_WALLS, [0, 1], "1132127808"),
             ],
         ),
         (
@@ -276,7 +276,7 @@ async def test_getMapSet() -> None:
                     MapSetType.NO_MOP_ZONES,
                     "['-6217', '3919', '-6217', '231', '-2642', '231', '-2642', '3919']",
                 ),
-                MapSetEvent(MapSetType.NO_MOP_ZONES, [4]),
+                MapSetEvent(MapSetType.NO_MOP_ZONES, [4], "199390082"),
             ],
         ),
         (
@@ -312,7 +312,7 @@ async def test_getMapSet() -> None:
                     MapSetType.VIRTUAL_WALLS,
                     "['-5667', '317', '-4888', '-56']",
                 ),
-                MapSetEvent(MapSetType.VIRTUAL_WALLS, [0, 1, 2, 3]),
+                MapSetEvent(MapSetType.VIRTUAL_WALLS, [0, 1, 2, 3], "199390082"),
             ],
         ),
         (
@@ -338,7 +338,7 @@ async def test_getMapSet() -> None:
                     MapSetType.VIRTUAL_WALLS,
                     "['3315', '3754', '3353', '-655']",
                 ),
-                MapSetEvent(MapSetType.VIRTUAL_WALLS, [0, 1]),
+                MapSetEvent(MapSetType.VIRTUAL_WALLS, [0, 1], "199390082"),
             ],
         ),
     ],
@@ -390,7 +390,7 @@ async def test_getMapSetV2_rooms() -> None:
             for subset in subsets
         ),
     )
-    events = [firmware_event, MapSetEvent(MapSetType(set_type), subsets)]
+    events = [firmware_event, MapSetEvent(MapSetType(set_type), subsets, mid)]
     for subset in subsets:
         events.extend(
             [
@@ -454,7 +454,7 @@ async def test_getMapSetV2_rooms_v2() -> None:
         Room(room_name, subset, "")
         for subset, room_name in zip(subsets, rooms_names, strict=False)
     ]
-    events = [firmware_event, RoomsEvent(rooms)]
+    events = [firmware_event, RoomsEvent(mid, rooms)]
 
     await assert_command(
         GetMapSetV2(mid, set_type),

tests/commands/xml/test_map.py

@@ -107,6 +107,7 @@ async def test_GetMapSet(
         MapSetEvent(
             map_type if isinstance(map_type, MapSetType) else MapSetType(map_type),
             subsets=subsets,
+            map_id="1",
         ),
         handling_result=HandlingResult(
             HandlingState.SUCCESS,

tests/data/map/test_1.py

@@ -120,7 +120,9 @@
         index=26,
         value="XQAABAAQJwAAAABv/f//o7f/Rz5IFXI5YVG4kijmo4YH+e7kHoLTL8U6OwczrMl+5Cn+j6EvprKUdquBVZgFpQToAHLTz2AlAA==",
     ),
-    MapSetEvent(type=MapSetType.ROOMS, subsets=[5, 8, 10, 3, 4, 7, 9]),
+    MapSetEvent(
+        type=MapSetType.ROOMS, subsets=[5, 8, 10, 3, 4, 7, 9], map_id="1132127808"
+    ),
     MapSubsetEvent(
         id=0,
         type=MapSetType.VIRTUAL_WALLS,

tests/data/map/test_2.py

@@ -21,7 +21,9 @@
             Position(type=PositionType.CHARGER, x=-384, y=-360, a=43),
         ]
     ),
-    MapSetEvent(type=MapSetType.ROOMS, subsets=[5, 8, 10, 3, 4, 7, 9]),
+    MapSetEvent(
+        type=MapSetType.ROOMS, subsets=[5, 8, 10, 3, 4, 7, 9], map_id="1132127808"
+    ),
     MapSubsetEvent(
         id=0,
         type=MapSetType.VIRTUAL_WALLS,
@@ -34,7 +36,7 @@
         coordinates="['2120', '-4581', '2106', '-6271']",
         name=None,
     ),
-    MapSetEvent(type=MapSetType.VIRTUAL_WALLS, subsets=[0, 1]),
+    MapSetEvent(type=MapSetType.VIRTUAL_WALLS, subsets=[0, 1], map_id="1132127808"),
     MapSubsetEvent(
         id=2,
         type=MapSetType.NO_MOP_ZONES,

tests/data/map/test_4.py

@@ -20,7 +20,9 @@
             Position(type=PositionType.CHARGER, x=-384, y=-360, a=43),
         ]
     ),
-    MapSetEvent(type=MapSetType.ROOMS, subsets=[5, 8, 10, 3, 4, 7, 9]),
+    MapSetEvent(
+        type=MapSetType.ROOMS, subsets=[5, 8, 10, 3, 4, 7, 9], map_id="1132127808"
+    ),
     MapSubsetEvent(
         id=0,
         type=MapSetType.VIRTUAL_WALLS,
@@ -33,7 +35,7 @@
         coordinates="['2120', '-4581', '2106', '-6271']",
         name=None,
     ),
-    MapSetEvent(type=MapSetType.VIRTUAL_WALLS, subsets=[0, 1]),
+    MapSetEvent(type=MapSetType.VIRTUAL_WALLS, subsets=[0, 1], map_id="1132127808"),
     MapSubsetEvent(
         id=2,
         type=MapSetType.NO_MOP_ZONES,