Skip to content

Add documentation for TuneBlade Remote integration #39916

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

Open
wants to merge 4 commits into
base: next
Choose a base branch
from

Conversation

spycle
Copy link
Contributor

@spycle spycle commented Jul 7, 2025

Proposed change

Documentation for proposed new integration

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
    • Added user documentation for the new TuneBlade Remote integration, detailing setup, features, entity controls, prerequisites, troubleshooting, and debug logging instructions.

@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 Jul 7, 2025
Copy link

netlify bot commented Jul 7, 2025

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit 0c38866
🔍 Latest deploy log https://app.netlify.com/projects/home-assistant-docs/deploys/686eda76061f2b0008d2a892
😎 Deploy Preview https://deploy-preview-39916--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.

Copy link
Contributor

coderabbitai bot commented Jul 7, 2025

📝 Walkthrough

Walkthrough

A new documentation file for the "TuneBlade Remote" integration has been added. This file describes how Home Assistant can control TuneBlade on Windows, representing AirPlay receivers as media player entities and supporting features such as toggling connection and volume control. The documentation covers setup, features, troubleshooting, and debug logging.

Changes

File(s) Change Summary
source/_integrations/tuneblade_remote.markdown Added documentation for the new "TuneBlade Remote" integration, including setup and troubleshooting details.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant HomeAssistant
    participant TuneBlade
    participant AirPlayDevice

    User -> HomeAssistant: Initiate TuneBlade Remote integration
    HomeAssistant -> TuneBlade: Discover and connect via zeroconf/config flow
    HomeAssistant -> TuneBlade: Send control commands (power, volume)
    TuneBlade -> AirPlayDevice: Stream audio / relay commands
    AirPlayDevice -> TuneBlade: Status updates
    TuneBlade -> HomeAssistant: Report device states
    HomeAssistant -> User: Display/control AirPlay devices as media players
Loading

📜 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 c0d20c2 and 0c38866.

📒 Files selected for processing (1)
  • source/_integrations/tuneblade_remote.markdown (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • source/_integrations/tuneblade_remote.markdown
⏰ 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

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

🧹 Nitpick comments (3)
source/_integrations/tuneblade_remote.markdown (3)

18-18: Prefer HTTPS for external links

TuneBlade’s site supports HTTPS; linking securely avoids mixed-content warnings.

-[TuneBlade](http://www.tuneblade.com/)
+[TuneBlade](https://www.tuneblade.com/)

24-24: Missing blank line before include breaks markdown rendering

Some MD engines require a blank line before an include to avoid it being swallowed by the preceding paragraph.

-If the TuneBlade master control options are enabled, a separate "master" control is also available as an additional entity.
-{% include integrations/config_flow.md %}
+If the TuneBlade master control options are enabled, a separate "master" control is also available as an additional entity.
+
+{% include integrations/config_flow.md %}

41-46: Bullet nesting is ambiguous – indent master entity bullets

Current layout renders the master-entity bullets at the same level; indenting clarifies hierarchy.

-  - Volume control
-- **Master Media Player** (optional):
-  - Exposed when `Show master control options` is enabled in TuneBlade.
+  - Volume control
+  - **Master Media Player** (optional):
+    - Exposed when `Show master control options` is enabled in TuneBlade.
📜 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 818305d.

📒 Files selected for processing (1)
  • source/_integrations/tuneblade_remote.markdown (1 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 (1)
source/_integrations/tuneblade_remote.markdown (1)

7-7: Release tag format doesn’t follow Home Assistant convention

ha_release should be the major.minor version in the form YYYY.M (optionally .x for patch).
Format like 2025.8 (or 2025.8.x if a patch release is already planned).

-ha_release: 2025.08.1
+ha_release: 2025.8

@c0ffeeca7 c0ffeeca7 added the new-integration This PR adds documentation for a new Home Assistant integration label Jul 8, 2025
@spycle
Copy link
Contributor Author

spycle commented Jul 9, 2025

Actionable comments posted: 1

🧹 Nitpick comments (3)

source/_integrations/tuneblade_remote.markdown (3)> 18-18: Prefer HTTPS for external links

TuneBlade’s site supports HTTPS; linking securely avoids mixed-content warnings.

-[TuneBlade](http://www.tuneblade.com/)
+[TuneBlade](https://www.tuneblade.com/)

Doesn't work for me. Has to be http

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 (3)
source/_integrations/tuneblade_remote.markdown (3)

23-25: Collapse consecutive blank lines (markdownlint MD012)
Two empty lines here break the docs style guide and trigger the linter. Delete one of them.

-
-
+ 

31-34: Emoji check mark renders inconsistently in dark-mode / Windows browsers
Using is visually nice but not used elsewhere in HA docs and can display as a monochrome glyph. Consider replacing with a regular list item or a plain word “Enable”.

- - ✅ **Enable Remote Control**  
- - ✅ **Show master control options** *(optional, but recommended)*
+ - **Enable Remote Control**  
+ - **Show master control options** *(optional, but recommended)*

63-68: Ensure the file ends with a single newline
Some CI checks (and Git diffs) complain when the final line is not newline-terminated. Add one if missing.

📜 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 de5e990 and c0d20c2.

📒 Files selected for processing (1)
  • source/_integrations/tuneblade_remote.markdown (1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/tuneblade_remote.markdown

24-24: Multiple consecutive blank lines
Expected: 1; Actual: 2

(MD012, no-multiple-blanks)

⏰ 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 (1)
source/_integrations/tuneblade_remote.markdown (1)

7-7: Verify ha_release format – looks non-standard
Home Assistant switched to CalVer (YYYY.M.P), e.g. 2025.8.0.
2025.08.1 uses a leading-zero month and an unexpected patch level. Please confirm against the core PR version and adjust to the exact release that will ship the integration.

-ha_release: 2025.08.1
+ha_release: 2025.8.0        # or the precise version bump used in core

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 new-integration This PR adds documentation for a new Home Assistant integration next This PR goes into the next branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants