From 13a79a2ce6aefa56d56acb1ff64dfcf91221bdf8 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Fri, 26 Dec 2025 11:39:35 +0000 Subject: [PATCH 1/3] Initial plan From 4e77a2186eac375b3f3e980ed18ad7932f860263 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Fri, 26 Dec 2025 11:45:35 +0000 Subject: [PATCH 2/3] Update project goal and add comprehensive Music Assistant setup guide for December 2025 Co-authored-by: R00S <1279537+R00S@users.noreply.github.com> --- README.md | 12 +- wiki/docs/extend-functionality/index.md | 6 + .../music-assistant-setup.md | 321 ++++++++++++++++++ .../extend-functionality/sentences/index.md | 4 + .../sentences/play-music-with-ma.md | 4 + .../sentences/play-radio-with-ma.md | 4 + wiki/docs/intro.md | 6 + 7 files changed, 355 insertions(+), 2 deletions(-) create mode 100644 wiki/docs/extend-functionality/music-assistant-setup.md diff --git a/README.md b/README.md index 01938c818..e23e61b2a 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,10 @@ -# View-Assist +# View-Assist Learning + +## Project Goal + +This repository is dedicated to learning how to integrate View Assist with [Music Assistant](https://github.com/music-assistant/server). The focus is on creating up-to-date, step-by-step instructions for connecting View Assist installations to Music Assistant using the latest versions available as of December 2025 (HAOS 2025.12.x, Music Assistant 2.7, and current View Assist releases). + +## About View Assist View Assist provides visual feedback for the Home Assistant Assist voice assistant using a collection of different automations, custom sentences, scripts, and extensions with the view being displayed on any Android device. Multiple devices can join the View Assist satellite network and interact. This is not limited to Android devices as ESPHome satellites are also supported. The project is still a work in progress but is fully functional. @@ -8,7 +14,9 @@ View Assist provides visual feedback for the Home Assistant Assist voice assista ^^^ Click for demo video on Youtube ^^^ -The information in this repo is separated into different subdirectories with install information stored in the wiki. This project is designed so that you can pick and choose the parts that you want for your needs. The custom sentences can be modified for those who may only be interested in voice only. The dashboard views may be interesting to others who are writing their own custom sentences. +The information in this repo is separated into different subdirectories with comprehensive setup and integration information stored in the wiki. This project is designed so that you can pick and choose the parts that you want for your needs. The custom sentences can be modified for those who may only be interested in voice only. The dashboard views may be interesting to others who are writing their own custom sentences. + +**For up-to-date Music Assistant integration instructions**, please see the [Music Assistant Setup Guide](wiki/docs/extend-functionality/music-assistant-setup.md) in the wiki. Please see the Wiki for detailed information [https://github.com/dinki/View-Assist/wiki ](https://dinki.github.io/View-Assist/) diff --git a/wiki/docs/extend-functionality/index.md b/wiki/docs/extend-functionality/index.md index 76d6f7e8a..38e1388f1 100644 --- a/wiki/docs/extend-functionality/index.md +++ b/wiki/docs/extend-functionality/index.md @@ -5,4 +5,10 @@ sidebar_position: 4 View Assist is easily extendable by adding custom sentences which provide data to different custom views. In this section you will find a gallery of premade custom sentence blueprints for easy installation. You will find links to the requird integrations, required views and installation instructions. +## Music Assistant Integration + +For comprehensive instructions on connecting View Assist to Music Assistant (December 2025), see the [Music Assistant Setup Guide](./music-assistant-setup.md). + +## Community Contributions + We encourage everyone to share their creations so that others might enjoy what you have brought to life. Note that these submissions will be provided under the 'Community Submissions' section for the blueprints, views and integration requirements. These items are supported by the author of these submissions and any questions or comments should be directed to the author or discussed in the 'Community Submissions' channel on our Discord server. \ No newline at end of file diff --git a/wiki/docs/extend-functionality/music-assistant-setup.md b/wiki/docs/extend-functionality/music-assistant-setup.md new file mode 100644 index 000000000..42d9cd9d9 --- /dev/null +++ b/wiki/docs/extend-functionality/music-assistant-setup.md @@ -0,0 +1,321 @@ +--- +title: "Music Assistant Setup Guide (December 2025)" +sidebar_position: 2 +--- + +# Connecting View Assist to Music Assistant + +This guide provides up-to-date, step-by-step instructions for connecting View Assist to Music Assistant using the latest versions available as of December 2025. + +## System Requirements + +- **Home Assistant OS**: Version 2025.12.x or later +- **Music Assistant**: Version 2.7 or later (released December 2025) +- **View Assist Integration**: Latest version from HACS +- A working View Assist satellite device (Android tablet, ESPHome device, etc.) + +## What's New in Music Assistant 2.7 + +Music Assistant 2.7 (December 2025) includes significant improvements: + +- **Redesigned UI**: Sleeker navigation with improved onboarding +- **Built-in Player**: Preview music directly in your browser +- **User Profiles**: Create tailored profiles for each family member with individual music providers and device access +- **Secure Authentication**: Profile-based authentication with Home Assistant SSO support +- **Multi-room Sync**: SensPin protocol for perfectly synchronized multi-room playback +- **Smart Crossfade**: Beat and BPM-analyzed transitions between tracks +- **Remote Access**: WebRTC streaming allows music playback from anywhere with internet access +- **Enhanced Metadata**: Improved support for lyrics, cover art, and track details +- **Expanded Integrations**: Supports Apple Music, Spotify, YouTube Music, Tidal, SiriusXM, SoundCloud, Plex, Jellyfin, BBC Sounds, and more + +## Step 1: Install Music Assistant + +1. Navigate to **Settings > Add-ons** in Home Assistant +2. Open the **Add-on Store** +3. Search for "**Music Assistant**" +4. Click **Install** +5. After installation completes: + - Enable "**Start on Boot**" for reliability + - Enable "**Watchdog**" to automatically restart if it crashes +6. Click **Start** to launch the add-on +7. Check the **Logs** tab for any startup errors + +## Step 2: Configure Music Assistant + +### Access the Music Assistant Interface + +1. Click "**Open Web UI**" from the Music Assistant add-on page +2. The Music Assistant interface will open in a new tab +3. Follow the initial setup wizard + +### Add Music Sources + +You can combine multiple music sources: + +**Streaming Services:** +- Spotify +- Apple Music +- YouTube Music +- Tidal +- SiriusXM +- SoundCloud +- Others + +**Local Sources:** +- Local music folders on your Home Assistant server +- Network shares (NAS devices) +- Plex or Jellyfin servers + +**To add a music source:** +1. In Music Assistant, go to **Settings > Music Providers** +2. Click **+ Add Provider** +3. Select your desired service +4. Follow the authentication steps +5. Allow time for initial library synchronization (this may take several minutes to hours depending on library size) + +## Step 3: Discover and Configure Audio Players + +Music Assistant will auto-discover compatible media players on your network: + +**Supported Player Types:** +- Google Cast +- Sonos +- AirPlay / AirPlay 2 +- DLNA / UPnP +- HomePods +- Chromecast +- And many more + +**To configure players:** +1. In Music Assistant, go to **Settings > Players** +2. Review the discovered players +3. Enable/disable players as needed +4. Configure player groups for multi-room audio if desired + +:::note +Amazon Echo (Alexa) devices have limited support due to Amazon API restrictions +::: + +## Step 4: Set Up User Profiles (Optional but Recommended) + +Music Assistant 2.7 introduces user profiles for personalized experiences: + +1. Go to **Settings > User Profiles** +2. Click **+ Create Profile** +3. Configure each profile: + - Link to specific music providers + - Set content restrictions + - Assign speaker/device access + - Enable Home Assistant SSO for easier management + +This is particularly useful for families with multiple users and different music preferences. + +## Step 5: Install View Assist Integration + +If you haven't already installed View Assist: + +### Install via HACS + +1. Ensure HACS is installed in your Home Assistant instance + - If not, visit [HACS installation guide](https://hacs.xyz/docs/setup/download) +2. In Home Assistant, go to **HACS** +3. Click the three dots menu > **Custom repositories** +4. Add the repository: `https://github.com/dinki/view_assist_integration/` +5. Category: **Integration** +6. Click **Add** +7. Find **View Assist** in HACS and click **Download** +8. **Restart Home Assistant** + +### Configure View Assist Integration + +1. Go to **Settings > Devices & Services** +2. Click **+ Add Integration** +3. Search for "**View Assist**" +4. Follow the setup wizard to add your View Assist devices + +## Step 6: Connect View Assist to Music Assistant + +### Configure the Music Player Device + +For each View Assist satellite that you want to use with Music Assistant: + +1. Go to **Settings > Devices & Services > View Assist** +2. Click on your View Assist device +3. Find the **musicplayer_device** configuration option +4. Select a Music Assistant player device from the dropdown + - This should be a Music Assistant player entity + - Typically named the same as your `mediaplayer_device` but with a `_2` suffix + - Example: If your media player is `media_player.living_room`, the Music Assistant player might be `media_player.living_room_2` + +:::tip +Music Assistant creates its own media player entities that are separate from your original Home Assistant media players. Look for the Music Assistant-created players in your entity list. +::: + +### Verify the Connection + +1. Open Music Assistant web interface +2. Select a Music Assistant player that corresponds to your View Assist device +3. Try playing some music +4. Verify that: + - Music plays on the correct device + - The Music view appears on your View Assist display (if configured) + - Playback controls work properly + +## Step 7: Install Music Blueprints for Voice Control + +To control Music Assistant via voice commands on your View Assist devices: + +### Install the Music View + +The Music view is automatically installed via the View Assist integration. No additional steps needed. + +### Install Music Control Blueprints + +1. **Play Music with Music Assistant**: [Blueprint documentation](./sentences/play-music-with-ma.md) + - Allows voice commands like: "Play some Beatles music" + - "Play the artist Taylor Swift" + - "Play the song Bohemian Rhapsody by Queen" + +2. **Play Radio with Music Assistant**: [Blueprint documentation](./sentences/play-radio-with-ma.md) + - Allows voice commands for TuneIn and Radio Browser stations + - Example: "Play KEXP radio" + +### Import Blueprints + +1. Go to **Settings > Automations & Scenes > Blueprints** +2. Click **Import Blueprint** +3. Copy the blueprint URLs from the documentation pages above +4. Configure each blueprint according to your devices and preferences + +## Step 8: Test Your Setup + +### Test Voice Commands + +Try these voice commands on your View Assist device: + +- "Play some jazz music" +- "Play the artist Miles Davis" +- "Play the song Blue in Green by Miles Davis" +- "Queue Coltrane" +- "What's playing?" +- "Skip this song" +- "Pause music" +- "Resume music" + +### Test Multi-room Audio (Optional) + +If you have multiple speakers: + +1. Create a player group in Music Assistant +2. Use voice commands to play music on the group +3. Verify synchronization across all speakers + +### Test Remote Access (Optional) + +If you enabled WebRTC streaming: + +1. Access your Home Assistant instance from outside your network +2. Open Music Assistant +3. Try playing music remotely +4. Verify that streaming works properly + +## Troubleshooting + +### Music Assistant Player Not Showing in View Assist + +- Restart both the Music Assistant add-on and Home Assistant +- Check that Music Assistant has fully initialized (check add-on logs) +- Verify your media players are discovered in Music Assistant +- Look for Music Assistant entities in **Developer Tools > States** (filter by "media_player") + +### Music Not Playing + +- Check that your music providers are properly authenticated +- Verify library synchronization is complete +- Test playback directly in Music Assistant UI +- Check the Music Assistant logs for errors + +### Voice Commands Not Working + +- Verify the blueprints are properly configured +- Check that the `musicplayer_device` is correctly set in View Assist device configuration +- Test the Assist pipeline separately to ensure voice recognition works +- Review automation traces in Home Assistant to debug failed commands + +### Synchronization Issues in Multi-room Setup + +- Use speakers from the same manufacturer/protocol for best sync +- Check network quality - ensure all speakers have good WiFi/Ethernet connection +- Try the SensPin protocol if supported by your speakers +- Some combinations of different speaker types may have inherent sync limitations + +## Advanced Features + +### Smart Crossfade + +Enable in Music Assistant settings for seamless transitions: +1. Go to **Settings > Playback** +2. Enable **Smart Crossfade** +3. Adjust fade duration and BPM-matching settings + +### Lyrics and Metadata + +Music Assistant 2.7 includes enhanced metadata support: +- Lyrics display (when available) +- Rich cover art +- Extended track information +- Artist biographies (from connected providers) + +### Automations and Scripts + +Integrate Music Assistant with Home Assistant automations: + +```yaml +# Example: Play music when arriving home +automation: + - alias: "Welcome Home Music" + trigger: + - platform: state + entity_id: person.your_name + to: "home" + action: + - service: media_player.play_media + target: + entity_id: media_player.living_room_2 # Your Music Assistant player + data: + media_content_id: "library://playlists/welcome-home" + media_content_type: "playlist" +``` + +## Additional Resources + +- [Official Music Assistant Documentation](https://music-assistant.io/) +- [Music Assistant GitHub Repository](https://github.com/music-assistant/server) +- [Home Assistant Community Forums](https://community.home-assistant.io/) +- [View Assist Discord Community](https://discord.gg/viewassist) (if available) +- [Music Assistant 2.7 Release Blog Post](https://www.home-assistant.io/blog/2025/12/17/music-assistant-2-7/) + +## Version Notes + +This guide is current as of **December 2025** and reflects: +- Home Assistant OS 2025.12.x +- Music Assistant version 2.7 +- Latest View Assist integration releases + +Music Assistant and View Assist are actively developed projects. Check the official documentation for the most current information and new features. + +## Getting Help + +If you encounter issues: + +1. Check the troubleshooting section above +2. Review the Music Assistant logs in the add-on interface +3. Check View Assist integration logs in Home Assistant +4. Search the Home Assistant community forums +5. Ask for help in the View Assist or Music Assistant community channels + +Remember to include: +- Your Home Assistant version +- Music Assistant version +- Error messages from logs +- Steps to reproduce the issue diff --git a/wiki/docs/extend-functionality/sentences/index.md b/wiki/docs/extend-functionality/sentences/index.md index ba36109c9..9b39c4d40 100644 --- a/wiki/docs/extend-functionality/sentences/index.md +++ b/wiki/docs/extend-functionality/sentences/index.md @@ -5,6 +5,10 @@ sidebar_position: 1 View Assist is easily extendable by adding custom sentences which provide data to different custom views. On this page you will find a gallery of premade custom sentences. You will find links to the requirements and installation instructions. Blueprints have been made available for easy installation. +:::tip Music Assistant Integration +For comprehensive, up-to-date instructions on setting up Music Assistant with View Assist (December 2025), see the [Music Assistant Setup Guide](../music-assistant-setup.md). +::: + We encourage everyone to share their creations so that others might enjoy what you have brought to life. These user submitted blueprints can be found in the [Community Contribution](../../community-contributions/index.md) section of the wiki. | Sentence | Description | diff --git a/wiki/docs/extend-functionality/sentences/play-music-with-ma.md b/wiki/docs/extend-functionality/sentences/play-music-with-ma.md index 7f45c2a93..7b61e37c5 100644 --- a/wiki/docs/extend-functionality/sentences/play-music-with-ma.md +++ b/wiki/docs/extend-functionality/sentences/play-music-with-ma.md @@ -1,5 +1,9 @@ # Play Music with Music Assistant +:::info Current Setup Guide +For comprehensive, up-to-date instructions on setting up Music Assistant with View Assist (December 2025), please see the [Music Assistant Setup Guide](../music-assistant-setup.md). +::: + ## Requirements - Music Assistant server installed and integrated with Home Assistant diff --git a/wiki/docs/extend-functionality/sentences/play-radio-with-ma.md b/wiki/docs/extend-functionality/sentences/play-radio-with-ma.md index b61db6282..77b3636ed 100644 --- a/wiki/docs/extend-functionality/sentences/play-radio-with-ma.md +++ b/wiki/docs/extend-functionality/sentences/play-radio-with-ma.md @@ -1,5 +1,9 @@ # Play TuneIn with Music Assistant +:::info Current Setup Guide +For comprehensive, up-to-date instructions on setting up Music Assistant with View Assist (December 2025), please see the [Music Assistant Setup Guide](../music-assistant-setup.md). +::: + ## Requirements - Music Assistant server installed and integrated with Home Assistant diff --git a/wiki/docs/intro.md b/wiki/docs/intro.md index 15686798e..02e07b3f4 100644 --- a/wiki/docs/intro.md +++ b/wiki/docs/intro.md @@ -4,6 +4,12 @@ sidebar_position: 1 # Welcome to View Assist +## Learning Goals + +This documentation serves as a learning resource for integrating View Assist with [Music Assistant](https://github.com/music-assistant/server). While the wiki contains historical information, this guide focuses on up-to-date instructions for December 2025, using HAOS 2025.12.x, Music Assistant 2.7, and the latest View Assist releases. + +## About View Assist + View Assist provides visual feedback for the Home Assistant Assist voice assistant using a collection of different automations, custom sentences, scripts, and extensions with the view being displayed on any Android device. Multiple devices can join the View Assist satellite network and interact. This is not limited to Android devices as voice only ESPHome satellites like the Home Assistant Voice Preview Edition are also supported. Some users have even brought Linux devices in as View Assist satellites as well. From da9bfd4d20c9e0d641b78a430235efb655b2f584 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Fri, 26 Dec 2025 12:11:17 +0000 Subject: [PATCH 3/3] Add offline playback limitations section for streaming services Co-authored-by: R00S <1279537+R00S@users.noreply.github.com> --- .../extend-functionality/music-assistant-setup.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/wiki/docs/extend-functionality/music-assistant-setup.md b/wiki/docs/extend-functionality/music-assistant-setup.md index 42d9cd9d9..ce11dedba 100644 --- a/wiki/docs/extend-functionality/music-assistant-setup.md +++ b/wiki/docs/extend-functionality/music-assistant-setup.md @@ -73,6 +73,17 @@ You can combine multiple music sources: 4. Follow the authentication steps 5. Allow time for initial library synchronization (this may take several minutes to hours depending on library size) +:::warning Offline Playback Limitations +Music Assistant 2.7 does **not** support offline playback for streaming services like Spotify. Streaming providers require an active internet connection and work via their respective protocols (e.g., Spotify Connect). + +**For offline playback:** +- Use local music files stored on your Home Assistant server or NAS +- Local files can be played without an internet connection +- Spotify playlists cannot be cached locally for offline use due to API and DRM restrictions + +This is a known limitation, and offline caching for streaming services is a feature under consideration for future releases. +::: + ## Step 3: Discover and Configure Audio Players Music Assistant will auto-discover compatible media players on your network: