jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-16 22:06:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update HEOS documentation style (#12446)

Browse Source 
* Use YAML in examples

* Add additional column in tables to clarify whether an attribute is
  required or not for a service call.
This commit is contained in:
Dan Klaffenbach 2020-03-31 20:32:14 +02:00 committed by GitHub
parent 1edf9e5cf1
commit 4d99bcefb9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 43 additions and 53 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

96
source/_integrations/heos.markdown
View File

@ -47,17 +47,15 @@ A connection to a single device enables control for all devices on the network.
Use the sign-in service to sign the connected controller into a HEOS account so that it can retrieve and play HEOS favorites and playlists. An error message is logged if sign-in is unsuccessful. Example service data payload: Use the sign-in service to sign the connected controller into a HEOS account so that it can retrieve and play HEOS favorites and playlists. An error message is logged if sign-in is unsuccessful. Example service data payload:
```json ```yaml
{ username: "example@example.com"
"username": "example@example.com", password: "password"
"password": "password"
}
``` ```
| Attribute | Description | Service data attribute | Optional | Description |
| ---------------------- | ---------------------------------------------------------| | ---------------------- | -------- | ----------- |
| `username` | The username or email of the HEOS account. [Required] | `username` | no | The username or email of the HEOS account.
| `password` | The password of the HEOS account. [Required] | `password` | no | The password of the HEOS account.
### Service `heos.sign_out` ### Service `heos.sign_out`
@ -69,73 +67,65 @@ Use the sign-out service to sign the connected controller out of a HEOS account.
You can play a HEOS favorite by number or name with the `media_player.play_media` service. Example service data payload: You can play a HEOS favorite by number or name with the `media_player.play_media` service. Example service data payload:
```json ```yaml
{ entity_id: media_player.office
"entity_id": "media_player.office", media_content_type: "favorite"
"media_content_type": "favorite", media_content_id: "1"
"media_content_id": "1"
}
``` ```
| Attribute | Description | Service data attribute | Optional | Description |
| ---------------------- | ---------------------------------------------------------| | ---------------------- | -------- | ----------- |
| `entity_id` | `entity_id` of the player | `entity_id` | yes | `entity_id` of the player(s)
| `media_content_type` | Set to the value `favorite` | `media_content_type` | no | Set to the value `favorite`
| `media_content_id` | The nubmer (i.e., `1`) or name (i.e., `Thumbprint Radio`) of the HEOS favorite | `media_content_id` | no | (i.e., `1`) or name (i.e., `Thumbprint Radio`) of the HEOS favorite
#### Play Playlist #### Play Playlist
You can play a HEOS playlist with the `media_player.play_media` service. Example service data payload: You can play a HEOS playlist with the `media_player.play_media` service. Example service data payload:
```json ```yaml
{ entity_id: media_player.office
"entity_id": "media_player.office", media_content_type: "playlist"
"media_content_type": "playlist", media_content_id: "Awesome Music"
"media_content_id": "Awesome Music"
}
``` ```
| Attribute | Description | Service data attribute | Optional | Description |
| ---------------------- | ---------------------------------------------------------| | ---------------------- | -------- | ----------- |
| `entity_id` | `entity_id` of the player | `entity_id` | yes | `entity_id` of the player(s)
| `media_content_type` | Set to the value `playlist` | `media_content_type` | no | Set to the value `playlist`
| `media_content_id` | The name of the HEOS playlist | `media_content_id` | no | The name of the HEOS playlist
#### Play Quick Select #### Play Quick Select
You can play a HEOS Quick Select by nubmer or name with the `media_player.play_media` service. Example service data payload: You can play a HEOS Quick Select by nubmer or name with the `media_player.play_media` service. Example service data payload:
```json ```yaml
{ entity_id: media_player.office
"entity_id": "media_player.office", media_content_type: "quick_select"
"media_content_type": "quick_select", media_content_id": "1"
"media_content_id": "1"
}
``` ```
| Attribute | Description | Service data attribute | Optional | Description |
| ---------------------- | ---------------------------------------------------------| | ---------------------- | -------- | ----------- |
| `entity_id` | `entity_id` of the player | `entity_id` | yes | `entity_id` of the player(s)
| `media_content_type` | Set to the value `quick_select` | `media_content_type` | no | Set to the value `quick_select`
| `media_content_id` | The quick select number (i.e., `1`) or name (i.e., `Quick Select 1`) | `media_content_id` | no | The quick select number (i.e., `1`) or name (i.e., `Quick Select 1`)
#### Play URL #### Play URL
You can play a URL through a HEOS media player using the `media_player.play_media` service. The HEOS player must be able to reach the URL. Example service data payload: You can play a URL through a HEOS media player using the `media_player.play_media` service. The HEOS player must be able to reach the URL. Example service data payload:
```json ```yaml
{ entity_id: media_player.office
"entity_id": "media_player.office", media_content_type: "url"
"media_content_type": "url", media_content_id: "http://path.to/stream.mp3"
"media_content_id": "http://path.to/stream.mp3"
}
``` ```
| Attribute | Description | Service data attribute | Optional | Description |
| ---------------------- | ---------------------------------------------------------| | ---------------------- | -------- | ----------- |
| `entity_id` | `entity_id` of the player to play the URL | `entity_id` | yes | `entity_id` of the player(s) to play the URL
| `media_content_type` | Set to the value `url` | `media_content_type` | no | Set to the value `url`
| `media_content_id` | The full URL to the stream | `media_content_id` | no | The full URL to the stream
## Notes ## Notes