Merge branch 'main' into cleaning_mode

Author: Lash-L

CHANGELOG.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,

README.md

@@ -1196,3 +1196,316 @@ roborock.vacuum.sc05:
       mode: rw
       type: RAW
       property: 'null'
+roborock.vacuum.a288:
+  protocol_version: '1.0'
+  product_nickname: PEARLPLUS
+  new_feature_info: 4499197267967999
+  new_feature_info_str: 0000000000099518CCFF7EFDA8E93EDDDBFF8F7F7EFEFFFF
+  feature_info:
+  - 111
+  - 112
+  - 113
+  - 114
+  - 115
+  - 116
+  - 117
+  - 118
+  - 119
+  - 120
+  - 121
+  - 122
+  - 123
+  - 124
+  - 125
+  product:
+    id: 3eizObJLFvPAxXvdW96ftd
+    name: Saros 20
+    model: roborock.vacuum.a288
+    category: robot.vacuum.cleaner
+    capability: 0
+    schema:
+    - id: 101
+      name: rpc_request
+      code: rpc_request
+      mode: rw
+      type: RAW
+    - id: 102
+      name: rpc_response
+      code: rpc_response
+      mode: rw
+      type: RAW
+    - id: 120
+      name: "\u9519\u8BEF\u4EE3\u7801"
+      code: error_code
+      mode: ro
+      type: ENUM
+      property: '{"range": [""]}'
+    - id: 121
+      name: "\u8BBE\u5907\u72B6\u6001"
+      code: state
+      mode: ro
+      type: ENUM
+      property: '{"range": [""]}'
+    - id: 122
+      name: "\u8BBE\u5907\u7535\u91CF"
+      code: battery
+      mode: ro
+      type: ENUM
+      property: '{"range": [""]}'
+    - id: 123
+      name: "\u6E05\u626B\u6A21\u5F0F"
+      code: fan_power
+      mode: rw
+      type: ENUM
+      property: '{"range": [""]}'
+    - id: 124
+      name: "\u62D6\u5730\u6A21\u5F0F"
+      code: water_box_mode
+      mode: rw
+      type: ENUM
+      property: '{"range": [""]}'
+    - id: 125
+      name: "\u4E3B\u5237\u5BFF\u547D"
+      code: main_brush_life
+      mode: rw
+      type: VALUE
+      property: '{"max": 100, "min": 0, "step": 1, "unit": "null", "scale": 1}'
+    - id: 126
+      name: "\u8FB9\u5237\u5BFF\u547D"
+      code: side_brush_life
+      mode: rw
+      type: VALUE
+      property: '{"max": 100, "min": 0, "step": 1, "unit": "null", "scale": 1}'
+    - id: 127
+      name: "\u6EE4\u7F51\u5BFF\u547D"
+      code: filter_life
+      mode: rw
+      type: VALUE
+      property: '{"max": 100, "min": 0, "step": 1, "unit": "null", "scale": 1}'
+    - id: 128
+      name: "\u989D\u5916\u72B6\u6001"
+      code: additional_props
+      mode: ro
+      type: RAW
+    - id: 130
+      name: "\u5B8C\u6210\u4E8B\u4EF6"
+      code: task_complete
+      mode: ro
+      type: RAW
+    - id: 131
+      name: "\u7535\u91CF\u4E0D\u8DB3\u4EFB\u52A1\u53D6\u6D88"
+      code: task_cancel_low_power
+      mode: ro
+      type: RAW
+    - id: 132
+      name: "\u8FD0\u52A8\u4E2D\u4EFB\u52A1\u53D6\u6D88"
+      code: task_cancel_in_motion
+      mode: ro
+      type: RAW
+    - id: 133
+      name: "\u5145\u7535\u72B6\u6001"
+      code: charge_status
+      mode: ro
+      type: RAW
+    - id: 134
+      name: "\u70D8\u5E72\u72B6\u6001"
+      code: drying_status
+      mode: ro
+      type: RAW
+    - id: 135
+      name: "\u79BB\u7EBF\u539F\u56E0\u7EC6\u5206"
+      code: offline_status
+      mode: ro
+      type: RAW
+    - id: 138
+      name: "\u5DE5\u4F5C\u4EFB\u52A1\u7C7B\u578B"
+      code: clean_task_type
+      mode: ro
+      type: ENUM
+      property: "{\"range\": [\"0 \u7A7A\u95F2\", \"1 \u5168\u5C4B\u6E05\u6D01\",\
+        \ \"2 \u9009\u533A\u6E05\u6D01\", \"3 \u5212\u533A\u6E05\u6D01\", \"4 \u5EFA\
+        \u56FE\", \"5 \u5C40\u90E8\u6E05\u6D01\", \"6 \u9065\u63A7\u6A21\u5F0F\",\
+        \ \"7 \u5DE1\u822A\", \"8 \u5BFB\u5BA0\", \"9 \u6574\u7406\"]}"
+    - id: 139
+      name: "\u56DE\u57FA\u7AD9\u76EE\u7684"
+      code: back_type
+      mode: ro
+      type: RAW
+    - id: 141
+      name: "\u6E05\u6D01\u8FDB\u5EA6"
+      code: cleaning_progress
+      mode: ro
+      type: VALUE
+      property: "{\"max\": 100, \"min\": 0, \"step\": 1, \"unit\": \"\u767E\u5206\u6BD4\
+        \", \"scale\": 1}"
+    - id: 142
+      name: publish_dsp
+      code: publish_dsp
+      mode: ro
+      type: RAW
+    - id: 143
+      name: "\u5730\u56FE\u53D8\u5316\u6570\u636E"
+      code: map_diff
+      mode: ro
+      type: RAW
+
+roborock.vacuum.ss07:
+  protocol_version: B01
+  product_nickname: PEARLPLUS
+  product:
+    id: 3gKDz7BnDrjXOVBAEXj4uw
+    name: Roborock Q10 Series
+    model: roborock.vacuum.ss07
+    category: robot.vacuum.cleaner
+    capability: 0
+    schema:
+    - id: 101
+      name: RPC Request
+      code: rpc_request
+      mode: rw
+      type: RAW
+      property: 'null'
+    - id: 102
+      name: RPC Response
+      code: rpc_response
+      mode: rw
+      type: RAW
+      property: 'null'
+    - id: 120
+      name: "\u9519\u8BEF\u4EE3\u7801"
+      code: error_code
+      mode: ro
+      type: ENUM
+      property: '{"range": []}'
+    - id: 121
+      name: "\u8BBE\u5907\u72B6\u6001"
+      code: state
+      mode: ro
+      type: VALUE
+      property: 'null'
+    - id: 122
+      name: "\u8BBE\u5907\u7535\u91CF"
+      code: battery
+      mode: ro
+      type: ENUM
+      property: '{"range": []}'
+    - id: 123
+      name: "\u5438\u529B\u6863\u4F4D"
+      code: fan_power
+      mode: rw
+      type: ENUM
+      property: '{"range": []}'
+    - id: 124
+      name: "\u62D6\u5730\u6863\u4F4D"
+      code: water_box_mode
+      mode: rw
+      type: RAW
+      property: 'null'
+    - id: 125
+      name: "\u4E3B\u5237\u5BFF\u547D"
+      code: main_brush_life
+      mode: ro
+      type: ENUM
+      property: '{"range": []}'
+    - id: 126
+      name: "\u8FB9\u5237\u5BFF\u547D"
+      code: side_brush_life
+      mode: ro
+      type: ENUM
+      property: '{"range": []}'
+    - id: 127
+      name: "\u6EE4\u7F51\u5BFF\u547D"
+      code: filter_life
+      mode: ro
+      type: ENUM
+      property: '{"range": []}'
+    - id: 135
+      name: "\u79BB\u7EBF\u539F\u56E0"
+      code: offline_status
+      mode: ro
+      type: ENUM
+      property: '{"range": []}'
+    - id: 136
+      name: "\u6E05\u6D01\u6B21\u6570"
+      code: clean_times
+      mode: rw
+      type: ENUM
+      property: '{"range": []}'
+    - id: 137
+      name: "\u626B\u62D6\u6A21\u5F0F"
+      code: cleaning_preference
+      mode: rw
+      type: ENUM
+      property: '{"range": []}'
+    - id: 138
+      name: "\u6E05\u6D01\u4EFB\u52A1\u7C7B\u578B"
+      code: clean_task_type
+      mode: ro
+      type: ENUM
+      property: '{"range": []}'
+    - id: 139
+      name: "\u8FD4\u56DE\u57FA\u7AD9\u7C7B\u578B"
+      code: back_type
+      mode: ro
+      type: ENUM
+      property: '{"range": []}'
+    - id: 140
+      name: "\u57FA\u7AD9\u4EFB\u52A1\u7C7B\u578B"
+      code: dock_task_type
+      mode: ro
+      type: ENUM
+      property: '{"range": []}'
+    - id: 141
+      name: "\u6E05\u6D01\u8FDB\u5EA6"
+      code: cleaning_progress
+      mode: ro
+      type: ENUM
+      property: '{"range": []}'
+    - id: 142
+      name: "\u7A9C\u8D27\u4FE1\u606F"
+      code: fc_state
+      mode: ro
+      type: RAW
+      property: 'null'
+    - id: 201
+      name: "\u542F\u52A8\u6E05\u6D01\u4EFB\u52A1"
+      code: start_clean_task
+      mode: wo
+      type: ENUM
+      property: '{"range": []}'
+    - id: 202
+      name: "\u8FD4\u56DE\u57FA\u7AD9\u4EFB\u52A1"
+      code: start_back_dock_task
+      mode: wo
+      type: ENUM
+      property: '{"range": []}'
+    - id: 203
+      name: "\u542F\u52A8\u57FA\u7AD9\u4EFB\u52A1"
+      code: start_dock_task
+      mode: wo
+      type: ENUM
+      property: '{"range": []}'
+    - id: 204
+      name: "\u6682\u505C\u4EFB\u52A1"
+      code: pause
+      mode: wo
+      type: RAW
+      property: 'null'
+    - id: 205
+      name: "\u7EE7\u7EED\u4EFB\u52A1"
+      code: resume
+      mode: wo
+      type: RAW
+      property: 'null'
+    - id: 206
+      name: "\u7ED3\u675F\u4EFB\u52A1"
+      code: stop
+      mode: wo
+      type: RAW
+      property: 'null'
+    - id: 207
+      name: "\u7528\u6237\u6539\u5584\u8BA1\u5212"
+      code: ceip
+      mode: rw
+      type: ENUM
+      property: '{"range": ["0,1"]}'

device_info.yaml

@@ -357,7 +357,7 @@ graph LR
 1. **Temporary Subscriptions**: Each RPC creates a temporary subscription that matches the request ID
 2. **Subscription Reuse**: `MqttSession` keeps subscriptions alive for 60 seconds (or idle timeout) to enable reuse during command bursts
 3. **Timeout Handling**: Commands timeout after 10 seconds if no response is received
-4. **Multiple Strategies**: `V1Channel` tries local first, then falls back to MQTT if local fails
+4. **Multiple Strategies**: `V1Channel` tries connect to both Local faster local commands and MQTT for streaming updates.
 
 ## Class Design & Components
 

docs/DEVICES.md

@@ -3,3 +3,6 @@ check_untyped_defs = True
 
 [mypy-construct]
 ignore_missing_imports = True
+
+[mypy-roborock.cli]
+ignore_errors = True