Improve roon media player docs for current integration. (#15339)

This commit is contained in:
Greg Dowling 2020-10-25 11:35:50 +00:00 committed by GitHub
parent a84647f723
commit 6eb16d2846
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 15 additions and 2 deletions

View File

@ -67,7 +67,7 @@ Currently only supported on [Denon AVR](/integrations/denonavr/) and [Songpal](
#### Service `media_player.shuffle_set` #### Service `media_player.shuffle_set`
Currently only supported on [Sonos](/integrations/sonos), [Spotify](/integrations/spotify), [MPD](/integrations/mpd), [Kodi](/integrations/kodi), [Squeezebox](/integrations/squeezebox) and [Universal](/integrations/universal). Currently only supported on [Sonos](/integrations/sonos), [Spotify](/integrations/spotify), [MPD](/integrations/mpd), [Kodi](/integrations/kodi), [Roon](/integrations/roon), [Squeezebox](/integrations/squeezebox) and [Universal](/integrations/universal).
| Service data attribute | Optional | Description | | Service data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------------------- | | ---------------------- | -------- | ---------------------------------------------------- |

View File

@ -19,7 +19,7 @@ To integrate with Roon, you need to provide Home Assistant with the Hostname or
If you use an IP address, please assign a static IP address to the machine that runs Roon Core. This ensures that it won't change IP addresses, so you won't have to change the configuration in Home Assistant if it reboots and changes IP address. See your router's manual for details on how to set this up. If you use an IP address, please assign a static IP address to the machine that runs Roon Core. This ensures that it won't change IP addresses, so you won't have to change the configuration in Home Assistant if it reboots and changes IP address. See your router's manual for details on how to set this up.
### Configuration ## Configuration
You need the Hostname or IP address of the machine that runs your Roon Core. This might be a machine name (which can be followed by `.local`, e.g., `myserver.local`) or can be an IP address. You need the Hostname or IP address of the machine that runs your Roon Core. This might be a machine name (which can be followed by `.local`, e.g., `myserver.local`) or can be an IP address.
@ -28,3 +28,16 @@ You need the Hostname or IP address of the machine that runs your Roon Core. Thi
3. Home Assistant will then contact your Roon Core and ask to be authorized. You will need to enable this extension in the Room Application. Go to **Settings** and then **Extensions**, there you will see an entry for Home Assistant with a button next to it. Click **Enable**. 3. Home Assistant will then contact your Roon Core and ask to be authorized. You will need to enable this extension in the Room Application. Go to **Settings** and then **Extensions**, there you will see an entry for Home Assistant with a button next to it. Click **Enable**.
4. Roon core will then provide Home Assistant with the details of your media players. 4. Roon core will then provide Home Assistant with the details of your media players.
5. In Home Assistant you can then pick an area for each of your music players, and add them to Home Assistant. 5. In Home Assistant you can then pick an area for each of your music players, and add them to Home Assistant.
#### Service `media_player.play_media`
Roon doesn't use file names or URLs to track media and so the roon integration is currently limited in how it supports this call.
| Service data attribute | Optional | Description |
| -----------------------| -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `entity_id` | yes | Target a specific media player. To target all media players, use `all`. |
| `media_content_id` | no | The text for roon to search for in your library. |
| `media_content_type` | no | A media type. Currently supported are `radio`, `playlist` and `genre` |
For example to play BBC Radio 4 you would set `media_content_type` to `radio` and `media_content_id` to `BBC Radio 4`