Merge branch 'main' into diagnostics

Author: allenporter

CHANGELOG.md

@@ -2,6 +2,146 @@
 
 <!-- version list -->
 
+## v3.16.1 (2025-12-14)
+
+### Bug Fixes
+
+- Share a HealthManager instance across all mqtt channels
+  ([#672](https://github.com/Python-roborock/python-roborock/pull/672),
+  [`4ad95dd`](https://github.com/Python-roborock/python-roborock/commit/4ad95ddee4d4d4cd64c7908f150c71d81f45e705))
+
+
+## v3.16.0 (2025-12-14)
+
+### Bug Fixes
+
+- Fix bugs in the subscription idle timeout
+  ([#665](https://github.com/Python-roborock/python-roborock/pull/665),
+  [`85b7bee`](https://github.com/Python-roborock/python-roborock/commit/85b7beeb810cfb3d501658cd44f06b2c0052ca33))
+
+- Harden the device connection logic used in startup
+  ([#666](https://github.com/Python-roborock/python-roborock/pull/666),
+  [`19703f4`](https://github.com/Python-roborock/python-roborock/commit/19703f42fe692a38f8f8639b1136a7585eae76fc))
+
+- Harden the initial startup logic
+  ([#666](https://github.com/Python-roborock/python-roborock/pull/666),
+  [`19703f4`](https://github.com/Python-roborock/python-roborock/commit/19703f42fe692a38f8f8639b1136a7585eae76fc))
+
+### Chores
+
+- Apply suggestions from code review
+  ([#675](https://github.com/Python-roborock/python-roborock/pull/675),
+  [`ab2de5b`](https://github.com/Python-roborock/python-roborock/commit/ab2de5bda7b8e1ff1ad46c7f2bf3b39dc9af4ace))
+
+- Clarify comments and docstrings
+  ([#666](https://github.com/Python-roborock/python-roborock/pull/666),
+  [`19703f4`](https://github.com/Python-roborock/python-roborock/commit/19703f42fe692a38f8f8639b1136a7585eae76fc))
+
+- Fix logging ([#666](https://github.com/Python-roborock/python-roborock/pull/666),
+  [`19703f4`](https://github.com/Python-roborock/python-roborock/commit/19703f42fe692a38f8f8639b1136a7585eae76fc))
+
+- Reduce whitespace changes ([#666](https://github.com/Python-roborock/python-roborock/pull/666),
+  [`19703f4`](https://github.com/Python-roborock/python-roborock/commit/19703f42fe692a38f8f8639b1136a7585eae76fc))
+
+- Revert whitespace change ([#666](https://github.com/Python-roborock/python-roborock/pull/666),
+  [`19703f4`](https://github.com/Python-roborock/python-roborock/commit/19703f42fe692a38f8f8639b1136a7585eae76fc))
+
+### Features
+
+- Add basic schedule getting ([#675](https://github.com/Python-roborock/python-roborock/pull/675),
+  [`ab2de5b`](https://github.com/Python-roborock/python-roborock/commit/ab2de5bda7b8e1ff1ad46c7f2bf3b39dc9af4ace))
+
+
+## v3.15.0 (2025-12-14)
+
+### Chores
+
+- Address some comments ([#662](https://github.com/Python-roborock/python-roborock/pull/662),
+  [`b3664bc`](https://github.com/Python-roborock/python-roborock/commit/b3664bcc0764d1dfbde2af9588dc0821c3ca1317))
+
+- Apply suggestions from code review
+  ([#662](https://github.com/Python-roborock/python-roborock/pull/662),
+  [`b3664bc`](https://github.com/Python-roborock/python-roborock/commit/b3664bcc0764d1dfbde2af9588dc0821c3ca1317))
+
+- Fix test naming ([#662](https://github.com/Python-roborock/python-roborock/pull/662),
+  [`b3664bc`](https://github.com/Python-roborock/python-roborock/commit/b3664bcc0764d1dfbde2af9588dc0821c3ca1317))
+
+- Small tweaks ([#662](https://github.com/Python-roborock/python-roborock/pull/662),
+  [`b3664bc`](https://github.com/Python-roborock/python-roborock/commit/b3664bcc0764d1dfbde2af9588dc0821c3ca1317))
+
+- Update roborock/devices/b01_channel.py
+  ([#662](https://github.com/Python-roborock/python-roborock/pull/662),
+  [`b3664bc`](https://github.com/Python-roborock/python-roborock/commit/b3664bcc0764d1dfbde2af9588dc0821c3ca1317))
+
+- Update snapshot ([#662](https://github.com/Python-roborock/python-roborock/pull/662),
+  [`b3664bc`](https://github.com/Python-roborock/python-roborock/commit/b3664bcc0764d1dfbde2af9588dc0821c3ca1317))
+
+### Features
+
+- Add b01 Q7 basic getter support
+  ([#662](https://github.com/Python-roborock/python-roborock/pull/662),
+  [`b3664bc`](https://github.com/Python-roborock/python-roborock/commit/b3664bcc0764d1dfbde2af9588dc0821c3ca1317))
+
+- Add b01 Q7 support ([#662](https://github.com/Python-roborock/python-roborock/pull/662),
+  [`b3664bc`](https://github.com/Python-roborock/python-roborock/commit/b3664bcc0764d1dfbde2af9588dc0821c3ca1317))
+
+
+## v3.14.3 (2025-12-14)
+
+### Bug Fixes
+
+- Allow firmware version as an optional field
+  ([#670](https://github.com/Python-roborock/python-roborock/pull/670),
+  [`0f70bf9`](https://github.com/Python-roborock/python-roborock/commit/0f70bf9dd2010c2c72b3b9543d891a1071dc22c4))
+
+### Chores
+
+- Add test for example offline device
+  ([#670](https://github.com/Python-roborock/python-roborock/pull/670),
+  [`0f70bf9`](https://github.com/Python-roborock/python-roborock/commit/0f70bf9dd2010c2c72b3b9543d891a1071dc22c4))
+
+
+## v3.14.2 (2025-12-14)
+
+### Bug Fixes
+
+- Additional device logging improvements
+  ([#668](https://github.com/Python-roborock/python-roborock/pull/668),
+  [`a86db71`](https://github.com/Python-roborock/python-roborock/commit/a86db717a07d24b0e6ab471ee814b0853b523918))
+
+- Improve device logging ([#668](https://github.com/Python-roborock/python-roborock/pull/668),
+  [`a86db71`](https://github.com/Python-roborock/python-roborock/commit/a86db717a07d24b0e6ab471ee814b0853b523918))
+
+### Chores
+
+- Further readability improvements to device logging
+  ([#668](https://github.com/Python-roborock/python-roborock/pull/668),
+  [`a86db71`](https://github.com/Python-roborock/python-roborock/commit/a86db717a07d24b0e6ab471ee814b0853b523918))
+
+- Improve device logging container summary string
+  ([#668](https://github.com/Python-roborock/python-roborock/pull/668),
+  [`a86db71`](https://github.com/Python-roborock/python-roborock/commit/a86db717a07d24b0e6ab471ee814b0853b523918))
+
+
+## v3.14.1 (2025-12-14)
+
+### Bug Fixes
+
+- Fix diagnostic data redaction to use camelized keys
+  ([#669](https://github.com/Python-roborock/python-roborock/pull/669),
+  [`6a20e27`](https://github.com/Python-roborock/python-roborock/commit/6a20e27506d01fbb30683c2d74d26ab073aa3036))
+
+### Chores
+
+- Remove redundant/broken part of the readme
+  ([#667](https://github.com/Python-roborock/python-roborock/pull/667),
+  [`b629a61`](https://github.com/Python-roborock/python-roborock/commit/b629a61f28f3bb64914a9bc461ce9f7a27a30c35))
+
+- **deps**: Bump pdoc from 15.0.4 to 16.0.0
+  ([#652](https://github.com/Python-roborock/python-roborock/pull/652),
+  [`5f4c14e`](https://github.com/Python-roborock/python-roborock/commit/5f4c14ead4eda21cd6954e3898d79a6eaa983f62))
+
+
 ## v3.14.0 (2025-12-14)
 
 ### Bug Fixes

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "python-roborock"
-version = "3.14.0"
+version = "3.16.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"
@@ -51,7 +51,7 @@ dev = [
     "freezegun>=1.5.1,<2",
     "pytest-timeout>=2.3.1,<3",
     "syrupy>=4.9.1,<6",
-    "pdoc>=15.0.4,<16",
+    "pdoc>=15.0.4,<17",
     "pyyaml>=6.0.3",
     "pyshark>=0.6",
     "pytest-cov>=7.0.0",

roborock/data/b01_q7/b01_q7_containers.py

@@ -69,62 +69,62 @@ class B01Props(RoborockBase):
     This dataclass is generated based on the device's status JSON object.
     """
 
-    status: WorkStatusMapping
-    fault: B01Fault
-    wind: SCWindMapping
-    water: int
-    mode: int
-    quantity: int
-    alarm: int
-    volume: int
-    hypa: int
-    main_brush: int
-    side_brush: int
-    mop_life: int
-    main_sensor: int
-    net_status: NetStatus
-    repeat_state: int
-    tank_state: int
-    sweep_type: int
-    clean_path_preference: int
-    cloth_state: int
-    time_zone: int
-    time_zone_info: str
-    language: int
-    cleaning_time: int
-    real_clean_time: int
-    cleaning_area: int
-    custom_type: int
-    sound: int
-    work_mode: WorkModeMapping
-    station_act: int
-    charge_state: int
-    current_map_id: int
-    map_num: int
-    dust_action: int
-    quiet_is_open: int
-    quiet_begin_time: int
-    quiet_end_time: int
-    clean_finish: int
-    voice_type: int
-    voice_type_version: int
-    order_total: OrderTotal
-    build_map: int
-    privacy: Privacy
-    dust_auto_state: int
-    dust_frequency: int
-    child_lock: int
-    multi_floor: int
-    map_save: int
-    light_mode: int
-    green_laser: int
-    dust_bag_used: int
-    order_save_mode: int
-    manufacturer: str
-    back_to_wash: int
-    charge_station_type: int
-    pv_cut_charge: int
-    pv_charging: PvCharging
-    serial_number: str
-    recommend: Recommend
-    add_sweep_status: int
+    status: WorkStatusMapping | None = None
+    fault: B01Fault | None = None
+    wind: SCWindMapping | None = None
+    water: int | None = None
+    mode: int | None = None
+    quantity: int | None = None
+    alarm: int | None = None
+    volume: int | None = None
+    hypa: int | None = None
+    main_brush: int | None = None
+    side_brush: int | None = None
+    mop_life: int | None = None
+    main_sensor: int | None = None
+    net_status: NetStatus | None = None
+    repeat_state: int | None = None
+    tank_state: int | None = None
+    sweep_type: int | None = None
+    clean_path_preference: int | None = None
+    cloth_state: int | None = None
+    time_zone: int | None = None
+    time_zone_info: str | None = None
+    language: int | None = None
+    cleaning_time: int | None = None
+    real_clean_time: int | None = None
+    cleaning_area: int | None = None
+    custom_type: int | None = None
+    sound: int | None = None
+    work_mode: WorkModeMapping | None = None
+    station_act: int | None = None
+    charge_state: int | None = None
+    current_map_id: int | None = None
+    map_num: int | None = None
+    dust_action: int | None = None
+    quiet_is_open: int | None = None
+    quiet_begin_time: int | None = None
+    quiet_end_time: int | None = None
+    clean_finish: int | None = None
+    voice_type: int | None = None
+    voice_type_version: int | None = None
+    order_total: OrderTotal | None = None
+    build_map: int | None = None
+    privacy: Privacy | None = None
+    dust_auto_state: int | None = None
+    dust_frequency: int | None = None
+    child_lock: int | None = None
+    multi_floor: int | None = None
+    map_save: int | None = None
+    light_mode: int | None = None
+    green_laser: int | None = None
+    dust_bag_used: int | None = None
+    order_save_mode: int | None = None
+    manufacturer: str | None = None
+    back_to_wash: int | None = None
+    charge_station_type: int | None = None
+    pv_cut_charge: int | None = None
+    pv_charging: PvCharging | None = None
+    serial_number: str | None = None
+    recommend: Recommend | None = None
+    add_sweep_status: int | None = None

roborock/data/containers.py

@@ -228,14 +228,18 @@ class HomeDataProduct(RoborockBase):
     def product_nickname(self) -> RoborockProductNickname:
         return SHORT_MODEL_TO_ENUM.get(self.model.split(".")[-1], RoborockProductNickname.PEARLPLUS)
 
+    def summary_info(self) -> str:
+        """Return a string with key product information for logging purposes."""
+        return f"{self.name} (model={self.model}, category={self.category})"
+
 
 @dataclass
 class HomeDataDevice(RoborockBase):
     duid: str
     name: str
     local_key: str
-    fv: str
     product_id: str
+    fv: str | None = None
     attribute: Any | None = None
     active_time: int | None = None
     runtime_env: Any | None = None
@@ -263,6 +267,10 @@ class HomeDataDevice(RoborockBase):
     share_type: Any | None = None
     share_expired_time: int | None = None
 
+    def summary_info(self) -> str:
+        """Return a string with key device information for logging purposes."""
+        return f"{self.name} (pv={self.pv}, fv={self.fv}, online={self.online})"
+
 
 @dataclass
 class HomeDataRoom(RoborockBase):
@@ -276,6 +284,15 @@ class HomeDataScene(RoborockBase):
     name: str
 
 
+@dataclass
+class HomeDataSchedule(RoborockBase):
+    id: int
+    cron: str
+    repeated: bool
+    enabled: bool
+    param: dict | None = None
+
+
 @dataclass
 class HomeData(RoborockBase):
     id: int

roborock/devices/README.md

@@ -124,38 +124,6 @@ graph TB
    - **LocalSession**: Factory for creating device-specific local connections
 6. **Protocol Layer**: Message encoding/decoding for different device versions
 7. **Transport Layer**: Low-level MQTT and TCP communication
-    LC --> V1P
-
-    MS --> MQTT
-    LC --> TCP
-    MQTT <--> TCP
-
-    style User fill:#e1f5ff
-    style DM fill:#fff4e1
-    style V1C fill:#ffe1e1
-    style RPC fill:#ffe1e1
-    style MS fill:#e1ffe1
-    style V1P fill:#f0e1ff
-    style A01P fill:#f0e1ff
-    style B01P fill:#f0e1ff
-```
-
-### Layer Responsibilities
-
-1. **Device Management Layer**: Detects protocol version (`pv` field) and creates appropriate channels
-2. **Device Types**: Different devices based on protocol version (V1, A01, B01)
-3. **Traits Layer**: Protocol-specific device capabilities and commands
-4. **Channel Layer**: Protocol-specific communication patterns
-   - **V1**: Full RPC channel with local + MQTT fallback
-   - **A01/B01**: Helper functions wrapping MqttChannel (MQTT only)
-   - **MqttChannel**: Per-device wrapper (each device has its own `MqttChannel` instance)
-5. **Session Layer**: Connection pooling and subscription management
-   - **MqttSession**: **Single shared connection** for ALL devices (efficiency!)
-   - **LocalSession**: Factory for creating device-specific local connections
-6. **Protocol Layer**: Message encoding/decoding for different device versions
-7. **Transport Layer**: Low-level MQTT and TCP communication
-
-
 
 **Important:** All `MqttChannel` instances share the same `MqttSession`, which maintains a single MQTT connection to the broker. This means:
 - Only one TCP connection to the MQTT broker regardless of device count