8000 Add cover platform to Qbus integration by thomasddn · Pull Request #39686 · home-assistant/home-assistant.io · GitHub
[go: up one dir, main page]

Skip to content

Add cover platform to Qbus integration #39686

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.

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

Merged
merged 7 commits into from
Jun 25, 2025

Conversation

thomasddn
Copy link
Contributor
@thomasddn thomasddn commented Jun 24, 2025

Proposed change

Adds documentation for the cover platform of the Qbus integration.
This is PR is the same as the accidentally closed #39286.

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 Qbus integration documentation to include support for "Cover" and "Hub" categories.
    • Added details about the new "Cover" entity type and its capabilities.
    • Improved descriptions of other entities for consistency and clarity.

@home-assistant home-assistant bot added the in-progress This PR/Issue is currently being worked on label Jun 24, 2025
@home-assistant
Copy link

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.

@home-assistant home-assistant bot added 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 Jun 24, 2025
Copy link
netlify bot commented Jun 24, 2025

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit 2e51979
🔍 Latest deploy log https://app.netlify.com/projects/home-assistant-docs/deploys/685a8ca0ba54f30008792dc3
😎 Deploy Preview https://deploy-preview-39686--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.

@thomasddn thomasddn changed the title Qbus platform cover Add cover platform to Qbus integration Jun 24, 2025
Copy link
Contributor
coderabbitai bot commented Jun 24, 2025
📝 Walkthrough

Walkthrough

The Qbus integration documentation was updated to include the "Cover" and "Hub" categories, and the supported platforms now list "cover." A new section describes the "Cover" entity type and its capabilities. Descriptions for other entities were revised for consistency and clarity, with minor wording adjustments.

Changes

File(s) Change Summary
source/_integrations/qbus.markdown Updated to add "Cover" and "Hub" categories, expanded supported platforms, added "Cover" entity type, and revised entity descriptions for clarity and consistency.

Assessment against linked issues

Objective Addressed Explanation
Add documentation for the cover platform of the Qbus integration (#39286)
Update entity descriptions for clarity and consistency (#39286)

Assessment against linked issues: Out-of-scope changes

No out-of-scope changes found.


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.

Copy link
Contributor
@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
source/_integrations/qbus.markdown (1)

51-55: Align bullet-point phrasing for consistency.

For consistency with the docs style-guide, start each description with an imperative verb and keep them roughly the same length.

-**Climate**: manage thermostats by setting temperature and choosing presets.
-**Cover**: operate covers with support for actions like open, close, stop, position adjustment, and tilt — depending on your setup.
-**Light**: control dimmer lights, allowing both on/off functionality and brightness adjustment.
-**Scene**: activate predefined scenes.
-**Switch**: toggle on/off outputs.
+**Climate**: Set temperatures and select presets for thermostats.
+**Cover**: Open, close, stop, or set position/tilt of covers (where supported).
+**Light**: Turn lights on/off and adjust brightness.
+**Scene**: Activate predefined scenes.
+**Switch**: Toggle outputs on or off.

Optional but improves readability.

📜 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 dcc59ae and e4e16f8.

📒 Files selected for processing (1)
  • source/_integrations/qbus.markdown (2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`source/_integrations/*`: Integration documentation must use the provided template structure and section order.

source/_integrations/*: Integration documentation must use the provided template structure and section order.

  • source/_integrations/qbus.markdown
🔇 Additional comments (2)
source/_integrations/qbus.markdown (2)

4-8: Validate new ha_category entries (Cover, Hub).

ha_category must contain one or more entries from the fixed list defined in the core docs.
Cover and Hub are not part of that list (the integration is already tagged as a hub via ha_integration_type: hub). Keeping unknown values will break the build.

 ha_category:
   - Climate
-  - Cover
-  - Hub
   - Light
   - Scene
   - Switch

Either drop the two lines or replace them with approved categories.
If you’re unsure, run the docs build locally or grep the repo for existing ha_category values.


11-16: cover platform addition looks good.

The new platform is correctly listed and alphabetically ordered. No further action required.

@home-assistant home-assistant bot added has-parent This PR has a parent PR in a other repo and removed needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch labels Jun 24, 2025
@home-assistant home-assistant bot added the parent-merged The parent PR has been merged already label Jun 25, 2025
@joostlek joostlek merged commit 40528cb into home-assistant:next Jun 25, 2025
7 checks passed
@home-assistant home-assistant bot removed parent-merged The parent PR has been merged already in-progress This PR/Issue is currently being worked on labels Jun 25, 2025
@github-actions github-actions bot locked and limited conversation to collaborators Jun 26, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
has-parent This PR has a parent PR in a other repo next This PR goes into the next branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants
0