Uh oh!
There was an error while loading. Please reload this page.
feat(web_api): add inbox message retrieval - #840
Draft
ximex wants to merge 1 commit into
Draft
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Adds support for fetching Roborock “inbox” messages via the web API and introduces a corresponding data container plus test coverage.
Changes:
- Add
RoborockApiClient.get_inbox_messages()that calls/user/inboxusing Hawk auth. - Introduce
InboxMessagecontainer for parsed inbox message entries. - Add an
aioresponsesfixture route and a new async test validating message parsing.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| tests/test_web_api.py | Adds a new async test for fetching inbox messages. |
| tests/fixtures/web_api_fixtures.py | Mocks the /user/inbox endpoint response for tests. |
| roborock/web_api.py | Implements get_inbox_messages() and imports InboxMessage. |
| roborock/data/containers.py | Adds InboxMessage dataclass container. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+77
to
+81
| async def test_get_inbox_messages(): | ||
| """Test that we can fetch device inbox messages.""" | ||
| api = RoborockApiClient(username="test_user@gmail.com") | ||
| ud = await api.pass_login("password") | ||
| messages = await api.get_inbox_messages(ud, "NOTIFICATION", duid="abc123") |
| "Authorization": _get_hawk_authentication(rriot, path, params=params), | ||
| }, | ||
| ) | ||
| inbox_response = await inbox_request.request("get", path, params=params) |
Lash-L
marked this pull request as draft
June 3, 2026 23:52
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds retrieval of the user/device inbox to
RoborockApiClient. This is theapp's server-side, localized event history for a device (cleaning finished,
battery low, ...) — richer context than the raw MQTT status. Part of #739.
GET /user/inboxon the rriot API host (api-eu.roborock.com) with Hawk auth.What's added
InboxMessagedataclass (id,trigger,duid,subject,content,extra,read,create_time).get_inbox_messages(user_data, message_type="NOTIFICATION", duid=None, offset=0, limit=20)-> list ofInboxMessage, newest first.Message types
NOTIFICATION/WARNING— device-scoped (requireduid).SYSTEM/MARKETING/SHARE— account-scoped.extracarries a raw JSON string with action/templateIdmetadata; thetemplateIdis a language-independent message-type code (more stable than thelocalized text).
Verification
ruffclean.