-
-
Notifications
You must be signed in to change notification settings - Fork 7.8k
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
base: next
Are you sure you want to change the base?
Conversation
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
📝 WalkthroughWalkthroughA 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
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
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ 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)
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this 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 linksTuneBlade’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 renderingSome 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 bulletsCurrent 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
📒 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 formYYYY.M
(optionally.x
for patch).
Format like2025.8
(or2025.8.x
if a patch release is already planned).-ha_release: 2025.08.1 +ha_release: 2025.8
Doesn't work for me. Has to be http |
There was a problem hiding this 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
📒 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
: Verifyha_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
Proposed change
Documentation for proposed new integration
Type of change
current
branch).current
branch).next
branch).next
branch).Additional information
Checklist
current
branch.next
branch.Summary by CodeRabbit