Skip to content

Add Control Bus mode to Available configuration entities #38051

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
Closed
wants to merge 2 commits into from
Closed

Add Control Bus mode to Available configuration entities #38051

wants to merge 2 commits into from

Conversation

ichbinsteffen
Copy link

@ichbinsteffen ichbinsteffen commented Mar 18, 2025 •
edited by silamon
Loading

Proposed change

Add Control Bus mode to Available configuration entities

I think this configuration switch needs a little more explanation. The other configuration entities could use a documentation too, but this one (and Pre-Amp mode) should be explained well.
I will try to come up with a good documentation, and @noahhusby if you want I can also add documentation for the other entities too.

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:
  • 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

  • New Features
    • Added a "Control Bus mode" option to the Cambridge Audio integration configuration, expanding available device setting choices without affecting existing options.

@home-assistant home-assistant bot added the current This PR goes into the current branch label Mar 18, 2025
@netlify Netlify
Copy link

netlify bot commented Mar 18, 2025 •
edited
Loading

✅ Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit be8018f
🔍 Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/67dd2f75b7bc1800088eac40
😎 Deploy Preview https://deploy-preview-38051--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 site configuration.

@ichbinsteffen ichbinsteffen mentioned this pull request Mar 18, 2025
Merged
19 tasks
@home-assistant home-assistant bot added the has-parent This PR has a parent PR in a other repo label Mar 18, 2025
@noahhusby
Copy link
Contributor

@ichbinsteffen Please mark this as ready for review. The core reviewers will merge this once the core PR is merged.

@ichbinsteffen ichbinsteffen marked this pull request as ready for review March 19, 2025 06:32
@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 19, 2025

📝 Walkthrough

Walkthrough

The change adds a new configuration entity called Control Bus mode to the Cambridge Audio integration documentation. This update expands the available configuration options for users by including the Control Bus mode alongside existing settings such as Display brightness, Pre-Amp, Early update, and Audio output. No existing entities were removed or modified.

Changes

File(s) Change Summary
source/_integrations/cambridge_audio.markdown Added a new configuration entity: Control Bus mode to the list of configurable device settings.

Tip

⚡🧪 Multi-step agentic review comment chat (experimental)
  • We're introducing multi-step agentic chat in review comments. This experimental feature enhances review discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments.
    - To enable this feature, set early_access to true under in the settings.

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.
    • 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 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[bot]
coderabbitai bot reviewed Mar 19, 2025
View reviewed changes
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/cambridge_audio.markdown (1)

71-71: Enhance Documentation for 'Control Bus mode'

The new configuration entity "Control Bus mode" has been added as expected. However, according to the PR objectives, this feature requires further explanation—especially in comparison to the other configuration entities listed. Consider adding a brief description or a link to additional documentation that highlights its purpose, configuration requirements, and how it differs from the existing options.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between a09c479 and 7536fc5.

📒 Files selected for processing (1)
  • source/_integrations/cambridge_audio.markdown (1 hunks)

@ichbinsteffen ichbinsteffen changed the title [Draft] Add Control Bus mode to Available configuration entities Add Control Bus mode to Available configuration entities Mar 19, 2025
@noahhusby
Copy link
Contributor

@ichbinsteffen Also this should be based and merged into the next branch not current, since the feature in the parent PR won't be included until the next release.

@silamon silamon marked this pull request as draft March 20, 2025 16:47
@ichbinsteffen ichbinsteffen marked this pull request as ready for review March 21, 2025 09:19
@ichbinsteffen
Copy link
Author

@ichbinsteffen Also this should be based and merged into the next branch not current, since the feature in the parent PR won't be included until the next release.

Okay I think i'll need to create a new PR then

@silamon
Copy link
Contributor

silamon commented Mar 21, 2025

@ichbinsteffen Also this should be based and merged into the next branch not current, since the feature in the parent PR won't be included until the next release.

Okay I think i'll need to create a new PR then

That's fine and mostly considered the easiest way.

@ichbinsteffen
Copy link
Author

@ichbinsteffen Also this should be based and merged into the next branch not current, since the feature in the parent PR won't be included until the next release.

Okay I think i'll need to create a new PR then

That's fine and mostly considered the easiest way.

Hey @silamon
This is the new PR
#38109

@silamon silamon closed this Mar 21, 2025
@github-project-automation github-project-automation bot moved this from Todo to Done in Documentation PRs Mar 21, 2025
@github-actions github-actions bot locked and limited conversation to collaborators Mar 22, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

Assignees
No one assigned
Labels
current This PR goes into the current branch has-parent This PR has a parent PR in a other repo
Projects
No open projects
Documentation PRs
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@ichbinsteffen @noahhusby @silamon