Beolink join

The Beolink join action makes a Bang & Olufsen device join an active Beolink multiroom experience.

This is useful for grouping a device with others that are already playing, so the same audio plays in another room.

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 join a Beolink experience 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. They run when something else calls them.
4. In the Then do section, select Add action.
5. Select what you want to control. Under By target (see Targets), select the Bang & Olufsen device you want to control. You can also select an area, a device, or a label.
6. From the actions shown for that target, select Beolink join.
7. Optionally, set the Beolink JID and Source to join a specific experience or source.
8. Select Save.

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.

In YAML, refer to this action as bang_olufsen.beolink_join. A basic example looks like this:

action: bang_olufsen.beolink_join
target:
  entity_id: media_player.beosound_balance_12345678

Without any data, this joins the closest active Beolink experience. Calling it repeatedly cycles through the available devices.

Options in YAML

Targets of the action

This action requires a target. The target is the object of the action. You can point the action at a single entityAn 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], a device, an area, a floor, or a label, and Home Assistant will run the action on every matching media_player entity behind that target.

• Entity: one specific media_player entity, such as media_player.living_room.
• Device: every media_player entity that belongs to a device.
• Area: every media_player entity in a room or area.
• Floor: every media_player entity on a floor.
• Label: every media_player entity that shares a label.

You can also select different target types in one action. For example, you can add a specific entity and an area as targets in the same action to run the action on both of them at once.

Good to know

• Calling this action with an empty list of group_members on the media_player.join action has the same effect.
• The available sources depend on the hardware platform of the device you join:
  • ASE: beoradio
  • ASE and Mozart: deezer, spotify
  • Mozart: tidal
  • Beolink Converter NL/ML: radio, tp1, tp2, cd, aux_a, ph

Try it yourself

Ready to test this? Open Developer 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.

Join a specific Beolink experience

action: bang_olufsen.beolink_join
target:
  entity_id: media_player.beosound_balance_12345678
data:
  beolink_jid: [email protected]

Join the radio source on a Beolink Converter NL/ML

action: bang_olufsen.beolink_join
target:
  entity_id: media_player.beosound_balance_12345678
data:
  beolink_jid: [email protected]
  source_id: radio

Still stuck?

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.

Related actions

These actions work well alongside this one:

• Beolink expand: Adds devices to the current Beolink experience.

• Beolink leave: Leaves a Beolink experience.

• Beolink all standby: Sets all connected Beolink devices to standby.