Skip to content

Cambridge Audio add control bus text #38109

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

Conversation

ichbinsteffen
Copy link

@ichbinsteffen ichbinsteffen commented Mar 21, 2025

Proposed change

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

    • Introduced "Control Bus mode" for managing Power Amplifier volume adjustments via simple increase/decrease commands.
  • Documentation

    • Updated the integration guide with details on how "Control Bus mode" interacts with Pre-Amp mode for enhanced volume control flexibility.

@home-assistant home-assistant bot added has-parent This PR has a parent PR in a other repo next This PR goes into the next branch labels Mar 21, 2025
Copy link

netlify bot commented Mar 21, 2025

Deploy Preview for home-assistant-docs ready!

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

Copy link
Contributor

coderabbitai bot commented Mar 21, 2025

📝 Walkthrough

Walkthrough

The changes update the Cambridge Audio integration documentation by introducing a new configuration entity called Control Bus mode. This mode allows the network player to control a connected power amplifier through increase and decrease commands, bypassing Pre-Amp mode which is documented separately. The documentation now explains the limitations of Control Bus mode and provides details on the functionality and role of Pre-Amp mode in volume control.

Changes

File Change Summary
source/_integrations/cambridge_audio.markdown Added a new configuration entity Control Bus mode for volume adjustment via increase/decrease commands; updated documentation to detail its interaction with Pre-Amp mode.

Sequence Diagram(s)

sequenceDiagram
    participant HA as Home Assistant
    participant CAP as Cambridge Audio Player
    participant PA as Power Amplifier

    HA->>CAP: Send volume increase/decrease command
    CAP->>PA: Forward full volume signal (Control Bus mode enabled)
Loading
sequenceDiagram
    participant HA as Home Assistant
    participant CAP as Cambridge Audio Player
    participant Pre as Pre-Amplifier

    HA->>CAP: Send volume control command
    CAP->>Pre: Adjust volume via Pre-Amp mode
Loading

🪧 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.

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 (2)
source/_integrations/cambridge_audio.markdown (2)

73-75: Typographical & Markdown Formatting Issues in the Pre-Amp Section

There is a typographical error in the Pre-Amp section: the phrase "Home Home Assistant" on line 74 contains a duplicated word. Additionally, consider adding blank lines above and below the "### Pre-Amp" heading to satisfy markdown style guidelines.

Apply this diff:

-When Pre-Amp mode is enabled, Home Home Assistant can control the output volume of your Pre-Amplifier.
+When Pre-Amp mode is enabled, Home Assistant can control the output volume of your Pre-Amplifier.
🧰 Tools
🪛 LanguageTool

[duplication] ~74-~74: Possible typo: you repeated a word.
Context: ...# Pre-Amp When Pre-Amp mode is enabled, Home Home Assistant can control the output volume...

(ENGLISH_WORD_REPEAT_RULE)

🪛 markdownlint-cli2 (0.17.2)

73-73: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)


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

(MD009, no-trailing-spaces)


76-77: Resolve Typos and Enhance Clarity in the Control Bus Section

There are multiple issues in the Control Bus section:

  • "ebabled" should be corrected to "enabled".
  • "metwork player" should be corrected to "network player".
  • A comma after the introductory phrase "In this case" would improve readability.

Apply this diff:

-When Control Bus mode is ebabled, Home Assistant can control the output volume of your Power Amplifier when it is connected to a Cambridge Audio network player using the Control Bus interface. In this case Pre-Amp mode can be disabled, the metwork player will send the signal with full volume to the power amplifier and the volume of the power amplifier can be controlled using volume up and down controls. Control Bus does not support setting the volume to a certain value, it can only increase and decrease the current volume.
+When Control Bus mode is enabled, Home Assistant can control the output volume of your Power Amplifier when it is connected to a Cambridge Audio network player using the Control Bus interface. In this case, Pre-Amp mode can be disabled, the network player will send the signal at full volume to the power amplifier, and the amplifier’s volume can be controlled using volume up and down controls. Control Bus does not support setting the volume to a specific value; it can only increase or decrease the current volume.
🧰 Tools
🪛 LanguageTool

[formatting] ~77-~77: Consider inserting a comma after an introductory phrase for better readability.
Context: ...player using the Control Bus interface. In this case Pre-Amp mode can be disabled, the metwo...

(IN_THAT_CASE_COMMA)


[uncategorized] ~77-~77: You might be missing the article “the” here.
Context: ...lled using volume up and down controls. Control Bus does not support setting the volume...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)

🪛 markdownlint-cli2 (0.17.2)

76-76: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 93a396b and 0a80b24.

📒 Files selected for processing (1)
  • source/_integrations/cambridge_audio.markdown (1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/cambridge_audio.markdown

[duplication] ~74-~74: Possible typo: you repeated a word.
Context: ...# Pre-Amp When Pre-Amp mode is enabled, Home Home Assistant can control the output volume...

(ENGLISH_WORD_REPEAT_RULE)


[formatting] ~77-~77: Consider inserting a comma after an introductory phrase for better readability.
Context: ...player using the Control Bus interface. In this case Pre-Amp mode can be disabled, the metwo...

(IN_THAT_CASE_COMMA)


[uncategorized] ~77-~77: You might be missing the article “the” here.
Context: ...lled using volume up and down controls. Control Bus does not support setting the volume...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)

🪛 markdownlint-cli2 (0.17.2)
source/_integrations/cambridge_audio.markdown

73-73: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)


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

(MD009, no-trailing-spaces)


76-76: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)

🔇 Additional comments (1)
source/_integrations/cambridge_audio.markdown (1)

71-72: New Configuration Entity Added: Control Bus mode

The new entity "Control Bus mode" is clearly added to the list of available configuration entities. Please ensure that its functionality is fully documented and that any related configuration or testing updates are completed as needed.

ichbinsteffen and others added 2 commits March 21, 2025 17:28
Co-authored-by: Simon Lamon <32477463+silamon@users.noreply.github.com>
Co-authored-by: Simon Lamon <32477463+silamon@users.noreply.github.com>
@silamon silamon added the awaits-parent Awaits the merge of an parent PR label Mar 21, 2025
@github-project-automation github-project-automation bot moved this from Todo to Approved in Documentation PRs Mar 21, 2025
@ichbinsteffen
Copy link
Author

@silamon Lol yeah thank you for the corrections. I had eye surgery done and am very light sensitive at the moment, so I spent the least time possible looking at the screen.

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 (2)
source/_integrations/cambridge_audio.markdown (2)

73-75: Markdown Formatting for Headings
The Pre-Amp section header and its accompanying description would benefit from having blank lines before and after the heading to satisfy markdown lint rules (MD022). In addition, please ensure there are no trailing spaces (MD009) at the end of the description line.

🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

73-73: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)


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

(MD009, no-trailing-spaces)


76-77: Punctuation and Formatting in New Section
For the Control Bus section, please insert a comma after the introductory phrase "In this case" to improve readability. The sentence should read:

"In this case, Pre-Amp mode can be disabled..."
In addition, add blank lines around the header to address markdown lint warnings.

🧰 Tools
🪛 LanguageTool

[formatting] ~77-~77: Consider inserting a comma after an introductory phrase for better readability.
Context: ...player using the Control Bus interface. In this case Pre-Amp mode can be disabled, the netwo...

(IN_THAT_CASE_COMMA)


[uncategorized] ~77-~77: You might be missing the article “the” here.
Context: ...lled using volume up and down controls. Control Bus does not support setting the volume...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)

🪛 markdownlint-cli2 (0.17.2)

76-76: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 0a80b24 and f0c9a76.

📒 Files selected for processing (1)
  • source/_integrations/cambridge_audio.markdown (1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/cambridge_audio.markdown

[formatting] ~77-~77: Consider inserting a comma after an introductory phrase for better readability.
Context: ...player using the Control Bus interface. In this case Pre-Amp mode can be disabled, the netwo...

(IN_THAT_CASE_COMMA)


[uncategorized] ~77-~77: You might be missing the article “the” here.
Context: ...lled using volume up and down controls. Control Bus does not support setting the volume...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)

🪛 markdownlint-cli2 (0.17.2)
source/_integrations/cambridge_audio.markdown

73-73: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)


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

(MD009, no-trailing-spaces)


76-76: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)

🔇 Additional comments (1)
source/_integrations/cambridge_audio.markdown (1)

71-71: Entity Addition Consistency
The new list entry for Control Bus mode has been added consistently with the other configuration entities. Please verify that its naming and formatting align with the overall documentation standards.

@ichbinsteffen
Copy link
Author

Awaits parent means this will be merged when home-assistant/core#139131 is merged I guess?

@joostlek joostlek merged commit 9ec3508 into home-assistant:next May 9, 2025
7 checks passed
@home-assistant home-assistant bot removed the awaits-parent Awaits the merge of an parent PR label May 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
has-parent This PR has a parent PR in a other repo next This PR goes into the next branch
Projects
No open projects
Status: Approved
Development

Successfully merging this pull request may close these issues.

3 participants