Play on SpeakerHub

The YoLink: Play on SpeakerHub action converts a text message to speech and plays it on a YoLink SpeakerHub. You can optionally play a tone first, set the volume for this message, and repeat the message.

Using this action from the user interface

If you prefer building automations and scripts visually, Home Assistant walks you through this action step by step. You pick what to target, tweak a few options, and save. No YAML knowledge required.

To play a message from an automation or a script:

1. Go to Settings > Automations & scenes.
2. Open an existing automation or script, or select Create automation > Create new automation.
3. If you’re setting up a new automation, add a trigger in the When section. Scripts don’t need a trigger.
4. In the Then do section, select Add action.
5. From the search box, search for and select YoLink: Play on SpeakerHub.
6. Select the SpeakerHub device to play the message on.
7. Enter the Text message to play.
8. Optionally, set a Tone, Volume, and Repeat count.
9. Select Save.

This action does not support targets. In the UI, you are not prompted to choose an area, device, entity, or label. You select the SpeakerHub through the SpeakerHub device option instead.

Options in the UI

Using this action in YAML

If you work directly in YAML, or you want to know exactly what Home Assistant does under the hood, this section has the technical reference. It lists the field names you use in YAML, their types, and which ones are required. For how an automation or a script is built in YAML, refer to Automations in YAML and Scripts.

In YAML, refer to this action as yolink.play_on_speaker_hub:

action: yolink.play_on_speaker_hub
data:
  target_device: 12a34b56c7d8ef9ghijklm0n1op2345q
  message: "The front door is open"
  tone: "alert"
  repeat: 1

This plays an alert tone followed by the message on the selected SpeakerHub.

Options in YAML

Try it yourself

Ready to test this? Open Settings > Tools > Actions, search for this action, fill in the fields, and select Perform action. You see what happens on your actual entitiesAn entity represents a sensor, actor, or function in Home Assistant. Entities are used to monitor physical properties or to control other entities. An entity is usually part of a device or a service. [Learn more] without writing a line of YAML.

More examples

Real scenarios where this action shows up in automations and scripts. Copy any example and adapt it to your setup. In the visual editor, select the UI options listed in the example or paste the YAML code.

Automation: Announce when a door is left open

This automation plays a spoken alert on your YoLink SpeakerHub when the front door stays open for more than two minutes.

• Trigger: State changed
  • Entity: Front door sensor
  • To: Open
  • For at least: 00:02:00
• Action: YoLink: Play on SpeakerHub
  • SpeakerHub device: Your SpeakerHub
  • Text message: The front door is open
  • Tone: Alert

alias: "Announce front door left open"
triggers:
  - trigger: state
    entity_id: binary_sensor.front_door
    to: "on"
    for:
      minutes: 2
actions:
  - action: yolink.play_on_speaker_hub
    data:
      target_device: 12a34b56c7d8ef9ghijklm0n1op2345q
      message: "The front door is open"
      tone: "alert"

Still stuck?

To test the action on its own, run it in the automation editor with Run action, and check the message that it shows. To see what the action did when the automation ran, open the trace of that run. For details, refer to Testing automations. For common problems and their solutions, refer to Troubleshooting automations.

If that doesn’t help, the Home Assistant community is quick to help: join Discord for real-time chat, post on the community forum with the action you’re calling and what you expected to happen, or share on our subreddit /r/homeassistant.