Independent directory, made by the developer of Vulpo. Not affiliated with Home Assistant or the Open Home Foundation.

About

Music Assistant is a built-in integration that connects Home Assistant to a Music Assistant server for music playback and control. It communicates locally and is set up in the UI with the server URL and a long-lived access token. Home Assistant can discover the server on the network and offer to add it. The integration provides media player entities along with a button to favorite the current song, number controls such as bass, treble and subwoofer volume, selects such as equalizer mode and sleep timer, switches such as party mode and pure direct, and a text field for the network name. Actions cover playing media and announcements with finer control, searching the library and all providers, getting library items, reading the active queue details of a player, and transferring a queue to another player. New devices appear without repeating setup, removed devices are cleaned up, and a repair notice appears if the server version is wrong.

Automatic summary of Home Assistant's source code. Something wrong? Get in touch

Supports

  • Works locally Talks to your devices on your own network. No vendor cloud in between.

  • Set up in the UI Add it in Settings, Devices and services. Nothing to download.

  • Found by itself Home Assistant spots it on the network and offers to add it.

  • Adds new devices New devices show up without setting it up again.

  • Cleans up devices Devices that are gone are removed by themselves.

  • Bronze quality Home Assistant's own rating of its code and setup experience.

  • Updated with Home Assistant Ships and updates with every Home Assistant release.

Provides

  • Media
  • Switches

Setting it up

Home Assistant usually finds it on the network and offers to add it. It can also be added by hand under Settings, Devices and services.

Connect

  • URLURL of the Music Assistant server

Enter long-lived access token

  • Long-lived access tokenCreate a long-lived access token in your Music Assistant server settings and paste it here

Texts from Home Assistant's source code, Apache License 2.0.

Entities

  • ButtonsFavorite current song
  • NumbersBass, Dialogue level, Dialogue lift, DTS dialogue control, Equalizer high, Equalizer low, Equalizer mid, Subwoofer volume, Treble
  • SelectsDimmer, Equalizer mode, Link audio delay, Link audio quality, Link control, Sleep timer, Surround decoder type, Tone control mode
  • SwitchesAdaptive DRC, Bass extension, Clear voice, Enhancer, Extra bass, Party mode, Pure direct, Speaker A, Speaker B, Surround 3D
  • TextsNetwork name

Actions

  • Get library itemsRetrieves items from a Music Assistant library.Fields: Enable album artists filter (only for artist library), Album type filter (albums library only), Music Assistant instance, Favorites only, Limit, Media type, Offset, Order by, Search, Username
  • Get playerQueue detailsRetrieves the details of the currently active queue of a Music Assistant player.
  • Play announcementPlays an announcement on a Music Assistant player with more fine-grained control options.Fields: Announce volume, Message, Pre-announce URL, Text-to-speech entity, URL, Use pre-announce
  • Play mediaPlays media on a Music Assistant player with more fine-grained control options.Fields: Album name, Artist name, Enqueue, Media ID(s), Media type, Enable radio mode, Username
  • Search Music AssistantPerforms a global search on the Music Assistant library and all providers.Fields: Album name, Artist name, Music Assistant instance, Only library items, Limit, Media type(s), Search name, Username
  • Transfer queueTransfers a player's queue to another player.Fields: Autoplay, Source media player

Troubleshooting

  • Repair noticesNotices it can show in Settings, Repairs:The Music Assistant server is not the correct version

Shows in Vulpo

Media Player card, Up Next queue with editing, Move playback to another speaker, Intercom volume.

Information

Installs
60.7k sharing analytics
Connection
Works locally
Upkeep
Part of Home Assistant
Quality
Bronze on the quality scale
Category
Media and entertainment, Music and radio services
Kind
Built-in integration
Needs
Built into Home Assistant
Domain
music_assistant

More from Music Assistant

You might also like

Independent directory, made by the developer of Vulpo. Not affiliated with Home Assistant or the Open Home Foundation. About these numbers