Update roborock docs with routines #38459

regevbr · 2025-04-09T13:03:11Z

Proposed change

#37817 changes somehow got lost. This adds back the new routine control docs

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).
- I've opened up a PR to add logos and icons in Brands repository.
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: Add Roborock buttons for starting routines core#139845
Link to parent pull request in the Brands repository:
This PR fixes or closes issue: fixes #

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.

Summary by CodeRabbit

Documentation
- Updated integration details to specify that both map data and routines are now fetched through the cloud.
- Added information that supported devices can set up routines in-app, with dedicated controls to trigger each routine.

home-assistant · 2025-04-09T13:03:16Z

It seems that this PR is targeted against an incorrect branch since it has a parent PR on one of our codebases. Documentation that needs to be updated for an upcoming release should target the next branch. Please change the target branch of this PR to next and rebase if needed.

netlify · 2025-04-09T13:03:56Z

✅ Deploy Preview for home-assistant-docs ready!

Name	Link
🔨 Latest commit	`c00de6d`
🔍 Latest deploy log	https://app.netlify.com/sites/home-assistant-docs/deploys/67f6714c92359a0008dd3d54
😎 Deploy Preview	https://deploy-preview-38459--home-assistant-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

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

regevbr · 2025-04-09T13:04:28Z

It seems that this PR is targeted against an incorrect branch since it has a parent PR on one of our codebases. Documentation that needs to be updated for an upcoming release should target the next branch. Please change the target branch of this PR to next and rebase if needed.

The feature was already released

coderabbitai · 2025-04-09T13:06:13Z

📝 Walkthrough

Walkthrough

The change updates the Roborock integration documentation. It amends the data fetching description by clarifying that both map data and routines are now retrieved via the cloud. Additionally, it introduces information about button entities; the documentation now explains that some vacuums allow routines to be configured through the app and that a button entity will be created for each routine. There were no changes made to declared public or exported entities.

Changes

File	Change Summary
`source/_integrations/roborock.markdown`	Updated description to mention that both map data and routines are fetched through the cloud, and added a sentence on the creation of button entities for routines.

Sequence Diagram(s)

sequenceDiagram
    participant User as App User
    participant Int as Roborock Integration
    participant Cloud as Cloud Service

    User->>Int: Request vacuum integration info
    Int->>Cloud: Fetch map data and routines
    Cloud-->>Int: Return map data and routines
    Note right of Int: Create button entities for each routine
    User->>Int: Tap button entity to trigger routine
    Int->>Cloud: Execute routine command
    Cloud-->>Int: Send confirmation

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6cec1ff and c00de6d.

📒 Files selected for processing (1)

source/_integrations/roborock.markdown (2 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

source/_integrations/roborock.markdown

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai plan to trigger planning for file edits and PR creation.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (1)

source/_integrations/roborock.markdown (1)
106-107: Clarify Cloud Data Retrieval and Trim Trailing Whitespaces
The updated line now clearly indicates that both map data and routines are fetched through the cloud, which aligns with the PR objective of restoring routine information in the documentation. Note that a trailing whitespace was detected on this line (as flagged by markdownlint). Please remove the trailing space for consistency with the style guidelines.
-Map data and routines are always fetched through the cloud, and Dyad and Zeo devices are cloud only. 
+Map data and routines are always fetched through the cloud, and Dyad and Zeo devices are cloud only.
🧰 Tools

🪛 markdownlint-cli2 (0.17.2)

106-106: Trailing spaces
Expected: 0 or 2; Actual: 1

(MD009, no-trailing-spaces)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 72acb64 and 6cec1ff.

📒 Files selected for processing (1)

source/_integrations/roborock.markdown (2 hunks)

🧰 Additional context used

🪛 markdownlint-cli2 (0.17.2)

source/_integrations/roborock.markdown

106-106: Trailing spaces
Expected: 0 or 2; Actual: 1

(MD009, no-trailing-spaces)

⏰ Context from checks skipped due to timeout of 90000ms (3)

GitHub Check: Redirect rules - home-assistant-docs
GitHub Check: Header rules - home-assistant-docs
GitHub Check: Pages changed - home-assistant-docs

🔇 Additional comments (1)

source/_integrations/roborock.markdown (1)

253-254: Document Button Entities for Routines
The newly added sentence effectively informs users that some vacuums allow routines to be set up via the app, with a dedicated button entity created to trigger each routine. This addition resolves the missing information regarding routine control as outlined in the PR objectives.

allenporter · 2025-04-09T13:32:31Z

Thank you @regevbr appreciate the follow through on this!

* Update roborock docs with routines * Update roborock.markdown

c0ffeeca7

Thank you, @regevbr 👍

Update roborock docs with routines

6cec1ff

regevbr requested a review from allenporter as a code owner April 9, 2025 13:03

github-project-automation bot added this to Documentation PRs Apr 9, 2025

github-project-automation bot moved this to Todo in Documentation PRs Apr 9, 2025

home-assistant bot assigned regevbr Apr 9, 2025

home-assistant bot added current This PR goes into the current branch has-parent This PR has a parent PR in a other repo in-progress This PR/Issue is currently being worked on needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch labels Apr 9, 2025

coderabbitai bot reviewed Apr 9, 2025

View reviewed changes

Update roborock.markdown

c00de6d

allenporter added parent-merged The parent PR has been merged already and removed needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch labels Apr 9, 2025

allenporter approved these changes Apr 9, 2025

View reviewed changes

github-project-automation bot moved this from Todo to Approved in Documentation PRs Apr 9, 2025

mrdarrengriffin pushed a commit to mrdarrengriffin/home-assistant.io that referenced this pull request Apr 9, 2025

Update roborock docs with routines (home-assistant#38459)

e1eae64

* Update roborock docs with routines * Update roborock.markdown

c0ffeeca7 approved these changes Apr 11, 2025

View reviewed changes

c0ffeeca7 merged commit 0f1983f into home-assistant:current Apr 11, 2025
7 checks passed

home-assistant bot removed in-progress This PR/Issue is currently being worked on parent-merged The parent PR has been merged already labels Apr 11, 2025

github-project-automation bot moved this from Approved to Done in Documentation PRs Apr 11, 2025

github-actions bot locked and limited conversation to collaborators Apr 12, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update roborock docs with routines #38459

Update roborock docs with routines #38459

regevbr commented Apr 9, 2025 •

edited by coderabbitai bot

Loading

home-assistant bot commented Apr 9, 2025

netlify bot commented Apr 9, 2025 •

edited

Loading

regevbr commented Apr 9, 2025

coderabbitai bot commented Apr 9, 2025 •

edited

Loading

Walkthrough

Changes

Sequence Diagram(s)

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

coderabbitai bot left a comment

allenporter commented Apr 9, 2025

c0ffeeca7 left a comment

Update roborock docs with routines #38459

Update roborock docs with routines #38459

Conversation

regevbr commented Apr 9, 2025 • edited by coderabbitai bot Loading

Proposed change

Type of change

Additional information

Checklist

Summary by CodeRabbit

home-assistant bot commented Apr 9, 2025

netlify bot commented Apr 9, 2025 • edited Loading

✅ Deploy Preview for home-assistant-docs ready!

regevbr commented Apr 9, 2025

coderabbitai bot commented Apr 9, 2025 • edited Loading

Walkthrough

Changes

Sequence Diagram(s)

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

allenporter commented Apr 9, 2025

c0ffeeca7 left a comment

Choose a reason for hiding this comment

regevbr commented Apr 9, 2025 •

edited by coderabbitai bot

Loading

netlify bot commented Apr 9, 2025 •

edited

Loading

coderabbitai bot commented Apr 9, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)