Skip to content

Revise the Roborock integration documentation#45761

Open
vemboy200 wants to merge 27 commits into
home-assistant:currentfrom
vemboy200:current
Open

Revise the Roborock integration documentation#45761
vemboy200 wants to merge 27 commits into
home-assistant:currentfrom
vemboy200:current

Conversation

@vemboy200
Copy link
Copy Markdown

Proposed change

My main 2 goals with these changes are to

  1. remove or change outdated info (like room cleaning or features that exist now but according to the docs dont exist)
  2. Help with the quality_scale.yaml gold requirements. This included adding
    1. Automation ideas ( docs-use-cases )
    2. Improving the trouble shooting for the cloud vs local (docs-troubleshooting)
    3. Known limitations (docs-known-limitations)
    4. Removed the compatibility note and changed it into supported devices (docs-supported-devices)

Type of change

  • Spelling, grammar or other readability improvements (current branch).
  • Adjusted missing or incorrect information in the current documentation (current branch).
  • Added documentation for a new integration I'm adding to Home Assistant (next branch).
  • Added documentation for a new feature I'm adding to Home Assistant (next branch).
  • Removed stale or deprecated documentation.

Additional information

  • Link to parent pull request in the codebase: N/A
  • Link to parent pull request in the Brands repository: N/A
  • This PR fixes or closes issue: fixes # N/A

Stuff that may need changing:

  1. I may still have some grammatical errors
  2. While I did mention that the app polls every two seconds (thats based on my observation) I dont really know whether its actually polling every two seconds or the robot vacuum is sending a push packet to the app every two seconds
  3. I also dont fully know whether the links i put that refer to other parts of the documentation actually work despite me testing it

Checklist

  • This PR uses the correct branch, based on one of the following:
    • I made a change to the existing documentation and used the current branch.
    • I made a change that is related to an upcoming version of Home Assistant and used the next branch.
  • The documentation follows the Home Assistant documentation standards.

Updated compatibility information and added details on supported devices and automation use cases for the Roborock integration.
@vemboy200 vemboy200 requested a review from allenporter as a code owner June 5, 2026 03:38
Copilot AI review requested due to automatic review settings June 5, 2026 03:38
@home-assistant home-assistant Bot added the current This PR goes into the current branch label Jun 5, 2026
@netlify
Copy link
Copy Markdown

netlify Bot commented Jun 5, 2026

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit 7cb1939
🔍 Latest deploy log https://app.netlify.com/projects/home-assistant-docs/deploys/6a2357f923aa6c0007d74aa8
😎 Deploy Preview https://deploy-preview-45761--home-assistant-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Note

Copilot was unable to run its full agentic suite in this review.

Updates the Roborock integration documentation to better describe supported device types, clarify networking/cloud limitations and rate-limiting behavior, and add example automations for Home Assistant.

Changes:

  • Replaces the compatibility note with a more detailed “Supported Devices” section (vacuums vs. non-vacuum appliances).
  • Expands/rewrites limitations and troubleshooting guidance (polling, cloud dependency, rate limiting, connectivity checks).
  • Adds a “Creative Use Cases and Automations” section with YAML automation examples.

Comment thread source/_integrations/roborock.markdown Outdated
Comment thread source/_integrations/roborock.markdown Outdated
Comment thread source/_integrations/roborock.markdown Outdated
Comment thread source/_integrations/roborock.markdown Outdated
Comment thread source/_integrations/roborock.markdown Outdated
@fdmarcin fdmarcin self-requested a review June 5, 2026 11:07
Copy link
Copy Markdown
Contributor

@fdmarcin fdmarcin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi, thanks for working on this doc! Here are some style review suggestions 🏓

Comment thread source/_integrations/roborock.markdown Outdated
Comment thread source/_integrations/roborock.markdown Outdated
Comment thread source/_integrations/roborock.markdown Outdated
Comment thread source/_integrations/roborock.markdown Outdated
Comment thread source/_integrations/roborock.markdown Outdated
Comment thread source/_integrations/roborock.markdown Outdated
Comment thread source/_integrations/roborock.markdown Outdated
Comment thread source/_integrations/roborock.markdown
Comment thread source/_integrations/roborock.markdown Outdated
Comment thread source/_integrations/roborock.markdown Outdated
@home-assistant home-assistant Bot marked this pull request as draft June 5, 2026 11:45
@home-assistant
Copy link
Copy Markdown

home-assistant Bot commented Jun 5, 2026

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

@fdmarcin fdmarcin changed the title Revise the Roborock integration documentation to remove or change outdated info and help with the quality_scale.yaml gold requirements Revise the Roborock integration documentation Jun 5, 2026
@home-assistant
Copy link
Copy Markdown

home-assistant Bot commented Jun 5, 2026

Hey there @Lash-L, @allenporter, mind taking a look at this feedback as it has been labeled with an integration (roborock) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of roborock can trigger bot actions by commenting:

  • @home-assistant close Closes the feedback.
  • @home-assistant mark-draft Mark the pull request as draft.
  • @home-assistant ready-for-review Remove the draft status from the pull request.
  • @home-assistant rename Awesome new title Renames the feedback.
  • @home-assistant reopen Reopen the feedback.
  • @home-assistant unassign roborock Removes the current integration label and assignees on the feedback, add the integration domain after the command.
  • @home-assistant update-branch Update the pull request branch with the base branch.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information) to the feedback.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information) on the feedback.

vemboy200 and others added 10 commits June 5, 2026 07:15
Co-authored-by: Marcin Sędłak-Jakubowski <fdmarcin@gmail.com>
Co-authored-by: Marcin Sędłak-Jakubowski <fdmarcin@gmail.com>
Co-authored-by: Marcin Sędłak-Jakubowski <fdmarcin@gmail.com>
Co-authored-by: Marcin Sędłak-Jakubowski <fdmarcin@gmail.com>
Co-authored-by: Marcin Sędłak-Jakubowski <fdmarcin@gmail.com>
Co-authored-by: Marcin Sędłak-Jakubowski <fdmarcin@gmail.com>
Co-authored-by: Marcin Sędłak-Jakubowski <fdmarcin@gmail.com>
Co-authored-by: Marcin Sędłak-Jakubowski <fdmarcin@gmail.com>
Co-authored-by: Marcin Sędłak-Jakubowski <fdmarcin@gmail.com>
Co-authored-by: Marcin Sędłak-Jakubowski <fdmarcin@gmail.com>
vemboy200 and others added 6 commits June 5, 2026 07:17
Co-authored-by: Marcin Sędłak-Jakubowski <fdmarcin@gmail.com>
Co-authored-by: Marcin Sędłak-Jakubowski <fdmarcin@gmail.com>
Co-authored-by: Marcin Sędłak-Jakubowski <fdmarcin@gmail.com>
Co-authored-by: Marcin Sędłak-Jakubowski <fdmarcin@gmail.com>
Co-authored-by: Marcin Sędłak-Jakubowski <fdmarcin@gmail.com>
Co-authored-by: Marcin Sędłak-Jakubowski <fdmarcin@gmail.com>
Comment thread source/_integrations/roborock.markdown Outdated
Comment thread source/_integrations/roborock.markdown Outdated
vemboy200 and others added 3 commits June 5, 2026 10:26
Co-authored-by: Marcin Sędłak-Jakubowski <fdmarcin@gmail.com>
Co-authored-by: Marcin Sędłak-Jakubowski <fdmarcin@gmail.com>
Added YAML examples for automating Roborock vacuum operations based on alarm and cooking events.
@vemboy200 vemboy200 marked this pull request as ready for review June 5, 2026 20:54
@home-assistant home-assistant Bot requested a review from fdmarcin June 5, 2026 20:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

current This PR goes into the current branch integration: roborock

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants