Merge branch 'music-assistant:main' into main

docs/ha-plugin.md

@@ -0,0 +1,31 @@
+---
+title: Home Assistant Plugin Provider
+description: The Home Assistant Plugin provides a connection from HA to MA
+---
+# Home Assistant Plugin Provider
+
+The Home Assistant Plugin provides a connection from HA to MA. This will allow HA players to be visible in MA and be streamed to.
+
+To achieve this functionality both the HA plugin and the HA Player Provider need to be installed.
+
+## Installation of the Home Assistant Plugin
+
+Before the Plugin can be added the HA Integration must be [installed](integration/installation.md). 
+
+- Navigate to MA SETTINGS>>PROVIDERS and add the plug-in provider
+- If using the Music Assistant add-on (i.e. HAOS), you wont need any server details, it should auto connect to the local HA instance
+- If using the docker version of the MA server, you will be required to enter the URL to your HA instance and then authenticate
+
+## Installation of the Home Assistant Player Provider
+
+Before the Player Provider can be added the Plugin must be installed. The following image shows what a successful installation looks like
+
+![screenshot](assets/screenshots/plugin-provider.png)
+
+- In the MA SETTINGS select ADD PLAYER PROVIDER then HOME ASSISTANT MEDIA PLAYERS
+- In the provider settings, select which players are desired to be utilised. These can be changed at any time.
+- Only players that support "play_media" will be shown; other players will be filtered out
+- MA players will also be filtered out
+
+!!! note
+    Features are most likely limited with these players. Always prefer a native player provider if it exists in MA as that is optimised

docs/integration/installation.md

@@ -12,24 +12,6 @@ The Integration to connect Music Assistant to Home Assistant is available as an
 !!! note
     The HA integration will create new media_player entities for those player types which are supported natively by MA. To see the names of those players go to `HA SETTINGS >>  DEVICES & SERVICES >> INTEGRATIONS >> MUSIC ASSISTANT` and view the entities. It is these players that need to be targeted in automations and scripts
 
-## Installation of the Home Assistant Player Provider
-
-Once the HA Integration is installed it is possible to stream to HA media player entities. In order to do so the HA Player Provider needs to be installed.  However, before that can be done the Home Assistant Plug-in provider needs to be installed.
-
-- Navigate to MA SETTINGS>>PROVIDERS and add the plug-in provider
-- If using the Music Assistant add-on (i.e. HAOS), you wont need any server details, it should auto connect to the local HA instance
-- If using the docker version of the MA server, you will be required to enter the URL to your HA instance and then authenticate
-
-Next install the Home Assistant Player Provider
-
-- You need the HA plug-in first before you can use/install this provider
-- In the provider settings, you can select which players you want to utilise
-- You can only use players that support "play_media", other players will be filtered out
-- MA players will also be filtered out
-
-!!! note
-    Features are most likely limited with these players. Always prefer a native player provider if it exists in MA as that is optimised
-
 ## Actions
 
 Music Assistant provides (next to the standard media player actions), several custom actions to allow control over the players and media. See the [Home Assistant documentation](https://www.home-assistant.io/integrations/music_assistant/#additional-actions) for information.

mkdocs.yml

@@ -18,6 +18,7 @@ nav:
       - Get Library Action: faq/get_library.md
       - Get Queue Action: faq/get_queue.md
       - Transfer Queue Action: faq/masstransfer.md
+  - Home Assistant Plugin: ha-plugin.md
   - Companion App: companion-app.md
   - Usage:
       - General: usage.md