Skip to content

add description for vacuums models #39904

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 2 commits into
base: next
Choose a base branch
from
Open

add description for vacuums models #39904

wants to merge 2 commits into from

Conversation

XiaoLing-git
Copy link
Contributor

@XiaoLing-git XiaoLing-git commented Jul 7, 2025 •
edited
Loading

Proposed change

add supported models description

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

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 the SwitchBot Cloud integration documentation to list additional supported vacuum models: K10+ Pro Combo, K20+ Pro, S10, and S20.

@home-assistant home-assistant bot added 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 next This PR goes into the next branch labels Jul 7, 2025
@home-assistant
Copy link

home-assistant bot commented Jul 7, 2025

It seems that this PR is targeted against an incorrect branch. Documentation updates which apply to our current stable release should target the current branch. Please change the target branch of this PR to current and rebase if needed. If this is documentation for a new feature, please add a link to that PR in your description.

@netlify Netlify
Copy link

netlify bot commented Jul 7, 2025 •
edited
Loading

✅ Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit d369346
🔍 Latest deploy log https://app.netlify.com/projects/home-assistant-docs/deploys/686baa2c6fd6240008c723fa
😎 Deploy Preview https://deploy-preview-39904--home-assistant-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

@XiaoLing-git XiaoLing-git mentioned this pull request Jul 7, 2025
Open
19 tasks
@home-assistant home-assistant bot added the has-parent This PR has a parent PR in another repo label Jul 7, 2025
@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Jul 7, 2025

📝 Walkthrough

Walkthrough

The documentation for the SwitchBot Cloud integration was updated to list four additional supported vacuum models. The entity description was revised to reflect support for these new models. No code or functional changes were made; only documentation was updated.

Changes

File Change Summary
source/_integrations/switchbot_cloud.markdown Added four new vacuum models to supported devices and updated vacuum entity description.

Sequence Diagram(s)

No sequence diagram generated as the changes are limited to documentation updates.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between 2cc9c15 and d369346.

📒 Files selected for processing (1)
  • source/_integrations/switchbot_cloud.markdown (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
  • GitHub Check: Redirect rules - home-assistant-docs
  • GitHub Check: Header rules - home-assistant-docs
  • GitHub Check: Pages changed - home-assistant-docs
🔇 Additional comments (2)
source/_integrations/switchbot_cloud.markdown (2)

79-82: Order & link consistency for newly-added vacuum models

  1. Ordering: the existing list follows a rough “K-series first, then S-series” pattern and within each series is ascending. S20 appears before S10, breaking that expectation. A quick swap will keep the list deterministic and easier to scan.

  2. URL sanity-check:
    • K20+ Pro points to the JP store (switchbot.jp) whereas the others use .com. That may be intentional (JP-only model) but worth double-checking – the .com store sometimes carries the same product.
    • Please verify the …/switchbot-k10-pro-combo slug exists; the naming of SwitchBot pages is not always consistent.

- - [S20](https://www.switch-bot.com/products/switchbot-floor-cleaning-robot-s20)
- - [S10](https://www.switch-bot.com/products/switchbot-floor-cleaning-robot-s10)
+ - [S10](https://www.switch-bot.com/products/switchbot-floor-cleaning-robot-s10)
+ - [S20](https://www.switch-bot.com/products/switchbot-floor-cleaning-robot-s20)

If the above URL/domain concerns check out, feel free to ignore.

190-193: Vacuum-entity support list no longer mentions S1 / S1 Plus – intentional?

Line 192 now lists K10+, K10+ Pro, K10+ Pro Combo, K20+ Pro, S10, S20, but omits S1 and S1 Plus, which still remain in the supported-devices table above (lines 83-85). If S1 models continue to expose a vacuum entity through the integration, they should remain in this sentence; otherwise they should probably be removed from the device list as well to avoid conflicting information.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @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.

@c0ffeeca7
Copy link
Contributor

Please fill out the PR template.

@c0ffeeca7 c0ffeeca7 marked this pull request as draft July 7, 2025 11:50
@c0ffeeca7
Copy link
Contributor

I'm drafting this PR, as changes are needed. Please undraft it, once the changes have been implemented and the PR is ready for review again.

@home-assistant home-assistant bot removed the needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch label Jul 7, 2025
@XiaoLing-git XiaoLing-git marked this pull request as ready for review July 7, 2025 13:41
c0ffeeca7
c0ffeeca7 approved these changes Jul 7, 2025
View reviewed changes
Copy link
Contributor

@c0ffeeca7 c0ffeeca7 left a comment

Choose a reason for hiding this comment

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

Thank you, @XiaoLing-git 👍

@c0ffeeca7 c0ffeeca7 added the awaits-parent Awaits the merge of an parent PR label Jul 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@c0ffeeca7 c0ffeeca7 c0ffeeca7 approved these changes

Assignees
No one assigned
Labels
awaits-parent Awaits the merge of an parent PR has-parent This PR has a parent PR in another repo in-progress This PR/Issue is currently being worked on next This PR goes into the next branch
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@XiaoLing-git @c0ffeeca7
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy