Document optional arguments for yolink "play on speaker hub" service

[mxr]

Proposed change

The SpeakerHub.playAudio accepts optional arguments for the tone, repeat, and volume parameters. But the HA service definition makes these arguments required. I've updated the service definition so that the arguments are optional. This PR updates the corresponding docs

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: Update yolink "play on speaker hub" action to allow optional values (to match YoLink API) core#133099
• 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

Summary by CodeRabbit

• Documentation
  • Updated the YoLink integration documentation to clarify that tone, volume, and repeat parameters in the Play on SpeakerHub action are now optional.
  • Revised descriptions for the optional parameters to explain their default behaviors when unset.
  • Retained community notes regarding MQTT connection requirements and potential network issues.

[netlify]

✅ Deploy Preview for home-assistant-docs ready!

Name	Link
🔨 Latest commit	e1f5bba
🔍 Latest deploy log	https://app.netlify.com/sites/home-assistant-docs/deploys/6763310ea9c3cb0008d9b4f3
😎 Deploy Preview	https://deploy-preview-36324--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]

📝 Walkthrough

📝 Walkthrough

Walkthrough

The changes in this pull request focus on updating the documentation for the YoLink integration within Home Assistant. Specifically, the parameters tone, volume, and repeat in the Play on SpeakerHub action have been modified to be optional instead of mandatory. The documentation now clarifies the default behaviors of these parameters when they are not set. Additionally, the community notes section has been preserved, emphasizing the need for an MQTT connection and addressing potential issues related to network proxies and UAC credentials.

Changes

File	Change Summary
source/_integrations/yolink.markdown	Updated tone, volume, and repeat parameters in Play on SpeakerHub action to be optional; revised descriptions for default behaviors. Retained community notes on MQTT connection requirements and potential issues.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant SpeakerHub
    User->>SpeakerHub: Play on SpeakerHub (tone, volume, repeat)
    alt tone is unset
        SpeakerHub->>User: No tone played
    end
    alt volume is unset
        SpeakerHub->>User: Using global volume
    end
    alt repeat is unset
        SpeakerHub->>User: Text will not repeat
    end

Loading

---

📜 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 e9b82c0 and e1f5bba.

📒 Files selected for processing (1)

• source/_integrations/yolink.markdown (1 hunks)

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

• source/_integrations/yolink.markdown

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

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