Update documentation to point to the newer device APIs #589
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR updates documentation and API exports to guide users toward the newer device APIs. The changes improve discoverability of the new device management system and align module exports with the current API design.
Key changes:
- Updated README example to demonstrate the newer
create_device_managerand trait-based APIs - Refined
__all__exports across multiple modules to expose the new device APIs while removing references to deprecated version-specific classes - Enhanced devices module documentation to include the markdown README
Reviewed Changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| roborock/protocols/init.py | Added new init file with empty exports list for protocols module |
| roborock/devices/traits/v1/init.py | Changed __all__ from class names to module names for submodule exports |
| roborock/devices/traits/b01/init.py | Attempted to remove create_b01_traits from exports (typo: __init__ should be __all__) |
| roborock/devices/init.py | Updated docstring to include markdown README and added traits to exports |
| roborock/init.py | Updated top-level exports to feature new devices API and removed deprecated version-specific APIs |
| README.md | Replaced old API example with new device manager and traits-based example |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
| status = await local_client.send_command(RoborockCommand.GET_STATUS) | ||
| # Or use existing functions that will give you data classes | ||
| status = await local_client.get_status() | ||
| # Create a device manager that can discover devices. |
There was a problem hiding this comment.
I think it would be helpful to show the cache
There was a problem hiding this comment.
I added an examples/ directory and put in a more complex example. It shows where we can still simplify the login APIs in the future. In order to make the cache work, I added a file backed cache.
2 participants
This is a first pass to update the documentation with these changes:
__all__to either include or exclude apisdevices/pydoc to include the markdown readme