chore: add docs for v1 device features #727
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive documentation for device features in the python-roborock library. The documentation catalogs 178+ device features reverse-engineered from the Roborock Android app, providing detailed explanations of capabilities, feature detection systems, and their impact on vacuum functionality.
Key Changes
- Added V1_DEVICE_FEATURES.md documenting all device feature flags across multiple detection systems
- Documented 5 different feature detection systems (bit masks, hex strings, arrays, model-specific, and hardware-based)
- Included detailed descriptions for each feature including bit masks/positions, functionality, and user impact
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| --- | ||
|
|
||
| ### is_full_duples_switch_supported |
There was a problem hiding this comment.
The spelling "duples" should be corrected to "duplex" (full duplex is the standard term for two-way simultaneous communication).
| ### is_full_duples_switch_supported | |
| ### is_full_duplex_switch_supported |
| --- | ||
|
|
||
| ### is_support_incremental_map | ||
| **Mask:** `4194304` (position 8) |
There was a problem hiding this comment.
The mask value appears incorrect. Based on the pattern of other position 8 mask values in this section, the mask for "is_support_incremental_map" should be 8192 (2^13), not 4194304 (2^22). The value 4194304 would place this feature at a different bit position than indicated by its placement in the documentation.
| **Mask:** `4194304` (position 8) | |
| **Mask:** `8192` (position 8) |
docs/V1_DEVICE_FEATURES.md
Outdated
| This documentation covers **178 distinct device features** across the Roborock ecosystem: | ||
|
|
||
| - **27** robotNewFeatures (lower 32-bit) features | ||
| - **17** robotNewFeatures (upper 32-bit) features | ||
| - **27** new_feature_info_str mask-based features | ||
| - **88** new_feature_info_str bit-indexed features |
There was a problem hiding this comment.
The summary states "88 new_feature_info_str bit-indexed features" but counting the documented bit-indexed features in the "New Feature String Bit Features" section reveals only 87 features (bit indices 32-120, with some gaps). This discrepancy should be corrected to ensure accuracy.
| This documentation covers **178 distinct device features** across the Roborock ecosystem: | |
| - **27** robotNewFeatures (lower 32-bit) features | |
| - **17** robotNewFeatures (upper 32-bit) features | |
| - **27** new_feature_info_str mask-based features | |
| - **88** new_feature_info_str bit-indexed features | |
| This documentation covers **183 distinct device features** across the Roborock ecosystem: | |
| - **27** robotNewFeatures (lower 32-bit) features | |
| - **17** robotNewFeatures (upper 32-bit) features | |
| - **27** new_feature_info_str mask-based features | |
| - **87** new_feature_info_str bit-indexed features |
docs/V1_DEVICE_FEATURES.md
Outdated
|
|
||
| ## Summary | ||
|
|
||
| This documentation covers **178 distinct device features** across the Roborock ecosystem: |
There was a problem hiding this comment.
The total count of "178 distinct device features" appears to be incorrect. Adding up the stated counts: 27 + 17 + 27 + 88 + 7 + 10 + 8 = 184, not 178. This arithmetic error should be corrected to match the actual sum of features listed.
| This documentation covers **178 distinct device features** across the Roborock ecosystem: | |
| This documentation covers **184 distinct device features** across the Roborock ecosystem: |
No description provided.