Document HEOS play queue feature #38210

andrewsayre · 2025-03-26T14:59:01Z

Proposed change

Adds documentation and a service call example for playing a HEOS queue item.

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).
- I've opened up a PR to add logos and icons in Brands repository.
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: Add play queue item to HEOS core#141480
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

Documentation
- Introduced a new section titled "Play a queue item" in the HEOS integration guide.
- Added clear instructions for controlling your media queue, including setting the media type and selecting a queue item based on its index.
- Provided an example action data payload and detailed descriptions of the required attributes.
- Enhanced guidance for accessing and enumerating the play queue via the appropriate service.

netlify · 2025-03-26T14:59:28Z

✅ Deploy Preview for home-assistant-docs ready!

Name	Link
🔨 Latest commit	`faea288`
🔍 Latest deploy log	https://app.netlify.com/sites/home-assistant-docs/deploys/67e53fe993a1cb000876a8bb
😎 Deploy Preview	https://deploy-preview-38210--home-assistant-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

coderabbitai · 2025-03-26T15:03:15Z

📝 Walkthrough

Walkthrough

A new section titled “Play a queue item” has been added to the HEOS integration documentation. This section explains how to use the media_player.play_media action with the media_content_type set to queue and the media_content_id set to the queue index (starting at 1) to play or move to a selected queue item. It also notes that users can enumerate the play queue using the heos.get_queue service and provides an example payload along with a table describing relevant data attributes.

Changes

File	Change Summary
source/_integrations/heos.markdown	Added a new "Play a queue item" section. The section details using `media_player.play_media` with `media_content_type=queue`, explains the queue indexing, and provides an example payload with a description of attributes like `entity_id`, `media_content_type`, and `media_content_id`.

Sequence Diagram(s)

sequenceDiagram
    participant U as User
    participant HA as Home Assistant
    participant HI as HEOS Integration
    participant HP as HEOS Device

    U->>HA: Call heos.get_queue to retrieve current queue
    HA->>HI: Process get_queue request
    HI->>HP: Fetch queue data
    HP-->>HI: Return queue data
    HI-->>HA: Provide queue data to user

    U->>HA: Call media_player.play_media with media_content_type: "queue", media_content_id: index
    HA->>HI: Process play_media command
    HI->>HP: Command HEOS Device to play queue item at given index
    HP-->>HI: Acknowledge play command
    HI-->>HA: Confirm command success

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 9aa63be and faea288.

📒 Files selected for processing (1)

source/_integrations/heos.markdown (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

source/_integrations/heos.markdown

🪧 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 plan to trigger planning for file edits and PR creation.
@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

Actionable comments posted: 0

🧹 Nitpick comments (1)

source/_integrations/heos.markdown (1)

181-196: Enhance Documentation Clarity in the "Play a queue item" section.
The new section is clear and follows a similar format to existing examples. The example code snippet and accompanying table are well formatted and provide a good overview of how to use the media_player.play_media action with the queue media content type.

A minor suggestion: Consider adding a brief note that explicitly states the queue index in media_content_id corresponds directly to the numbering provided by the heos.get_queue service. This can help users avoid any potential confusion regarding whether the index is zero-based or one-based, even though the text currently mentions "starting from 1".

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 8fe696a and 9aa63be.

📒 Files selected for processing (1)

source/_integrations/heos.markdown (1 hunks)

source/_integrations/heos.markdown

c0ffeeca7

Thank you, @andrewsayre 👍

andrewsayre added 2 commits March 26, 2025 14:56

Document play queue

db2d6ac

Fix line break

9aa63be

github-project-automation bot added this to Documentation PRs Mar 26, 2025

github-project-automation bot moved this to Todo in Documentation PRs Mar 26, 2025

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 26, 2025

andrewsayre mentioned this pull request Mar 26, 2025

Add play queue item to HEOS home-assistant/core#141480

Merged

19 tasks

coderabbitai bot reviewed Mar 26, 2025

View reviewed changes

home-assistant bot added the parent-merged The parent PR has been merged already label Mar 26, 2025

c0ffeeca7 added this to the 2025.4 milestone Mar 27, 2025

c0ffeeca7 reviewed Mar 27, 2025

View reviewed changes

source/_integrations/heos.markdown Outdated Show resolved Hide resolved

Update source/_integrations/heos.markdown

faea288

c0ffeeca7 approved these changes Mar 27, 2025

View reviewed changes

github-project-automation bot moved this from Todo to Approved in Documentation PRs Mar 27, 2025

c0ffeeca7 merged commit 4aa11fc into next Mar 27, 2025
9 checks passed

c0ffeeca7 deleted the heos_play_queue branch March 27, 2025 12:14

home-assistant bot removed the parent-merged The parent PR has been merged already label Mar 27, 2025

github-project-automation bot moved this from Approved to Done in Documentation PRs Mar 27, 2025

github-actions bot locked and limited conversation to collaborators Mar 28, 2025

frenck added the cherry-picked This PR has been manually picked and merged into the current branch label Apr 2, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Document HEOS play queue feature #38210

Document HEOS play queue feature #38210

andrewsayre commented Mar 26, 2025 •

edited by coderabbitai bot

Loading

netlify bot commented Mar 26, 2025 •

edited

Loading

coderabbitai bot commented Mar 26, 2025 •

edited

Loading

Walkthrough

Changes

Sequence Diagram(s)

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

coderabbitai bot left a comment

c0ffeeca7 left a comment

Document HEOS play queue feature #38210

Document HEOS play queue feature #38210

Conversation

andrewsayre commented Mar 26, 2025 • edited by coderabbitai bot Loading

Proposed change

Type of change

Additional information

Checklist

Summary by CodeRabbit

netlify bot commented Mar 26, 2025 • edited Loading

✅ Deploy Preview for home-assistant-docs ready!

coderabbitai bot commented Mar 26, 2025 • edited Loading

Walkthrough

Changes

Sequence Diagram(s)

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

c0ffeeca7 left a comment

Choose a reason for hiding this comment

andrewsayre commented Mar 26, 2025 •

edited by coderabbitai bot

Loading

netlify bot commented Mar 26, 2025 •

edited

Loading

coderabbitai bot commented Mar 26, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)