Initial room configuration support for Q10 devices by lboue · Pull Request #837 · Python-roborock/python-roborock

lboue · 2026-06-03T18:41:00Z

Summary

This PR adds initial room configuration support for Q10 devices using the B01 protocol.

It introduces parsing for the CUSTOMER_CLEAN payload, exposes a dedicated Q10 rooms trait, and wires that trait into Q10PropertiesApi so room configuration can be refreshed and accessed through high-level helpers. It also adds focused test coverage for room parsing, streaming updates, and the new API helpers.

What Changed

Added Q10 room payload parsing in b01_q10_containers.py
Added a new Q10 rooms trait in rooms.py
Exposed room helpers on init.py:
- refresh_room_config()
- room_map
- room_names
- get_room()
- get_room_name()
Added tests for room parsing and Q10 rooms API behavior in test_rooms.py

Behavior

Q10 devices can now request and decode the current room configuration from the robot
rr_* firmware room names are normalized into user-friendly labels such as Living Room

Validation

Focused Q10 rooms tests pass locally: 4 passed
Local smoke test with a real Roborock account succeeded via local script

… helpers Co-authored-by: Copilot <copilot@github.com>

Co-authored-by: Copilot <copilot@github.com>

Copilot

Pull request overview

Note

Copilot was unable to run its full agentic suite in this review.

Adds support for reading and refreshing room configuration for Q10 (B01) devices, including parsing the CUSTOMER_CLEAN payload and exposing room helpers on the properties API.

Changes:

Introduces RoomsTrait and wires it into Q10PropertiesApi subscribe loop and helper methods.
Adds room-config parsing/container models for the CUSTOMER_CLEAN base64 payload.
Adds tests covering streaming updates, listener notifications, and refresh requests for room config.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 8 comments.

File	Description
tests/devices/traits/b01/q10/test_rooms.py	Adds integration-style tests for rooms streaming, listener behavior, and refresh request payload.
roborock/devices/traits/b01/q10/rooms.py	Implements `RoomsTrait` to refresh and parse room configuration updates and notify listeners.
roborock/devices/traits/b01/q10/init.py	Wires `RoomsTrait` into `Q10PropertiesApi` and adds convenience room helper APIs.
roborock/data/b01_q10/b01_q10_containers.py	Adds dataclasses and parsing/normalization for the room configuration payload.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Lash-L · 2026-06-05T00:07:25Z

+
+    assert parsed.declared_count == 1
+    assert parsed.parsed_count == 1
+    room = parsed.rooms[0]


Can you add a test for an instance with multiple rooms?

Lash-L · 2026-06-05T00:10:21Z

+
+    for index in range(count):
+        if offset + _Q10_CUSTOMER_CLEAN_ROOM_BLOCK_SIZE > len(raw):
+            break


So I'm not sure about all of theses breaks. if one step fails, we are returning partial data, which I think can be problematic.

Also we could just check them all at once. Seems like the total length be the count * (26+20+1] then read vertex count then check its vertex_count * _Q10_CUSTOMER_CLEAN_VERTEX_SIZE, then we don't ned to check again.

Wonder if using construct would be helpful like how some of the other packages are parsed in protocol.py...

allenporter · 2026-06-06T03:49:13Z

+    rooms: RoomsTrait
+    """Trait for reading room configuration from Q10 devices."""
+
+    @property


Seems like these should just be on RoomsTrait and not here

allenporter · 2026-06-06T03:49:26Z

        # to the device. Updates will be received by the subscribe loop below.
        await self.command.send(B01_Q10_DP.REQUEST_DPS, params={})

+    async def refresh_room_config(self) -> None:


Similar here, these should all be on the rooms trait

allenporter · 2026-06-06T03:50:26Z

+        return {room.room_id: room for room in self.rooms}
+
+
+def parse_customer_clean_payload(payload_b64: str) -> Q10RoomsConfig:


This seems to me like it fits better next to RoomsTrait.

allenporter · 2026-06-06T03:52:27Z

+
+
+def normalize_q10_room_name(room_name: str) -> str:
+    """Normalize room names reported by the Q10 firmware."""


Maybe would be good to give some examples in the pydoc of what this is doing.

allenporter · 2026-06-06T03:53:24Z

+    return Q10RoomsConfig(raw_length=len(raw), declared_count=count, rooms=rooms)
+
+
+def normalize_q10_room_name(room_name: str) -> str:


Could also consider making this a property on Q10RoomConfig which exposes the name (e.g.raw_name and name as a property.)

allenporter · 2026-06-06T03:56:22Z

+
+    for index in range(count):
+        if offset + _Q10_CUSTOMER_CLEAN_ROOM_BLOCK_SIZE > len(raw):
+            break


Also we could just check them all at once. Seems like the total length be the count * (26+20+1] then read vertex count then check its vertex_count * _Q10_CUSTOMER_CLEAN_VERTEX_SIZE, then we don't ned to check again.

allenporter · 2026-06-06T04:00:30Z

+
+    for index in range(count):
+        if offset + _Q10_CUSTOMER_CLEAN_ROOM_BLOCK_SIZE > len(raw):
+            break


Wonder if using construct would be helpful like how some of the other packages are parsed in protocol.py...

allenporter · 2026-06-06T04:01:29Z

+class Q10RoomConfig(RoborockBase):
+    index: int
+    room_id: int
+    room_type: int


Are these all some kind of enum value? trying to reason about what "-1" will mean here and wondering if int | None would be better or RoomTypeEnum | None if we can figure those out.

lboue and others added 5 commits June 3, 2026 20:18

feat: add Q10 rooms support

47de002

feat: enhance Q10PropertiesApi and RoomsTrait with room configuration…

26a528d

… helpers Co-authored-by: Copilot <copilot@github.com>

feat: add room name normalization for Q10 firmware

40d9769

Co-authored-by: Copilot <copilot@github.com>

feat: update room name from "Kitchen" to "Living Room" in tests

df20787

Co-authored-by: Copilot <copilot@github.com>

fix: correct formatting and encoding in Q10 room tests and containers

c70a2d3

Co-authored-by: Copilot <copilot@github.com>

lboue marked this pull request as ready for review June 3, 2026 18:45

Copilot AI review requested due to automatic review settings June 3, 2026 18:45

Copilot AI reviewed Jun 3, 2026

View reviewed changes

fix(q10): address PR review warnings for room parsing

48456f8

Lash-L reviewed Jun 5, 2026

View reviewed changes

allenporter requested changes Jun 6, 2026

View reviewed changes

		return {room.room_id: room for room in self.rooms}


		def parse_customer_clean_payload(payload_b64: str) -> Q10RoomsConfig:



		def normalize_q10_room_name(room_name: str) -> str:
		"""Normalize room names reported by the Q10 firmware."""

		return Q10RoomsConfig(raw_length=len(raw), declared_count=count, rooms=rooms)


		def normalize_q10_room_name(room_name: str) -> str:

Conversation

lboue commented Jun 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

What Changed

Behavior

Validation

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

lboue commented Jun 3, 2026 •

edited

Loading