Skip to content

Update service examples for HEOS integration #33591

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
klaasnicolaas merged 1 commit into from
Jul 6, 2024
Merged

Update service examples for HEOS integration #33591

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 37 additions & 19 deletions source/_integrations/heos.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,10 @@ A connection to a single device enables control for all devices on the network.
Use the sign-in service (go to Developer Tools -> Services and then run the `heos.sign_in` with your username and password. Use the "Fill example data" first, then change it with your data. Check the logs right after, there you should see if the sign-in was successful or not) 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:
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot Jul 6, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fix spelling and improve clarity.

Correct the spelling mistakes and use 'whether' for better clarity.

- heos.sign_in` with your username and passwor...
+ heos.sign_in` with your username and password...

- there you should see if the sign-in was successful or not
+ there you should see whether the sign-in was successful or not
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
Use the sign-in service (go to Developer Tools -> Services and then run the `heos.sign_in` with your username and password. Use the "Fill example data" first, then change it with your data. Check the logs right after, there you should see if the sign-in was successful or not) 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 (go to Developer Tools -> Services and then run the `heos.sign_in` with your username and password. Use the "Fill example data" first, then change it with your data. Check the logs right after, there you should see whether the sign-in was successful or not) 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:
Tools
LanguageTool

[misspelling] ~37-~37: Possible spelling mistake found.
Context: ...oper Tools -> Services and then run the heos.sign_in with your username and passwor...

(MORFOLOGIK_RULE_EN_US)

[style] ~37-~37: In contexts where ‘if’ is followed by ‘or’, using ‘whether’ may be more appropriate (and formal).
Context: ... logs right after, there you should see if the sign-in was successful or not) to s...

(IF_WHETHER)

[misspelling] ~37-~37: Possible spelling mistake found.
Context: ...to sign the connected controller into a HEOS account so that it can retrieve and pla...

(MORFOLOGIK_RULE_EN_US)

[misspelling] ~37-~37: Possible spelling mistake found.
Context: ...ccount so that it can retrieve and play HEOS favorites and playlists. An error messa...

(MORFOLOGIK_RULE_EN_US)


```yaml
username: "example@example.com"
password: "password"
service: heos.sign_in
data:
username: "example@example.com"
password: "password"
```

| Service data attribute | Optional | Description |
Expand All @@ -57,9 +59,11 @@ 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:
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot Jul 6, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fix spelling mistake.

Correct the spelling mistake in the section header.

- #### Play favorite
+ #### Play Favorite
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
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:
Tools
LanguageTool

[misspelling] ~59-~59: Possible spelling mistake found.
Context: ...ia #### Play favorite You can play a HEOS favorite by number or name with theme...

(MORFOLOGIK_RULE_EN_US)


```yaml
entity_id: media_player.office
media_content_type: "favorite"
media_content_id: "1"
service: media_player.play_media
data:
entity_id: media_player.office
media_content_type: "favorite"
media_content_id: "1"
```

| Service data attribute | Optional | Description |
Expand All @@ -73,9 +77,11 @@ media_content_id: "1"
You can play a HEOS playlist with the `media_player.play_media` service. Example service data payload:
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot Jul 6, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fix spelling mistake.

Correct the spelling mistake in the section header.

- #### Play playlist
+ #### Play Playlist

Committable suggestion was skipped due to low confidence.

Tools
LanguageTool

[misspelling] ~77-~77: Possible spelling mistake found.
Context: ...e | #### Play playlist You can play a HEOS playlist with the `media_player.play_me...

(MORFOLOGIK_RULE_EN_US)


```yaml
entity_id: media_player.office
media_content_type: "playlist"
media_content_id: "Awesome Music"
service: media_player.play_media
data:
entity_id: media_player.office
media_content_type: "playlist"
media_content_id: "Awesome Music"
```

| Service data attribute | Optional | Description |
Expand All @@ -89,9 +95,11 @@ media_content_id: "Awesome Music"
You can play a HEOS Quick Select by number or name with the `media_player.play_media` service. Example service data payload:
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot Jul 6, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fix spelling mistake.

Correct the spelling mistake in the section header.

- #### Play Quick Select
+ #### Play Quick select

Committable suggestion was skipped due to low confidence.

Tools
LanguageTool

[misspelling] ~95-~95: Possible spelling mistake found.
Context: ... #### Play Quick Select You can play a HEOS Quick Select by number or name with the...

(MORFOLOGIK_RULE_EN_US)


```yaml
entity_id: media_player.office
media_content_type: "quick_select"
media_content_id": "1"
service: media_player.play_media
data:
entity_id: media_player.office
media_content_type: "quick_select"
media_content_id": "1"
```

| Service data attribute | Optional | Description |
Expand All @@ -105,9 +113,11 @@ media_content_id": "1"
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:

```yaml
entity_id: media_player.office
media_content_type: "url"
media_content_id: "http://path.to/stream.mp3"
service: media_player.play_media
data:
entity_id: media_player.office
media_content_type: "url"
media_content_id: "http://path.to/stream.mp3"
```

| Service data attribute | Optional | Description |
Expand All @@ -121,10 +131,12 @@ media_content_id: "http://path.to/stream.mp3"
For grouping HEOS media players together for synchronous playback you can use the `media_player.join` service. With the example service data payload down below you'll expand playback of `media_player.office` to the `media_player.kitchen` and `media_player.bathroom` players. Please note that all of the media players need to be HEOS players.
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot Jul 6, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fix spelling and improve clarity.

Correct the spelling mistake and remove unnecessary 'of' for conciseness.

- Please note that all of the media players need to be HEOS players.
+ Please note that all the media players need to be HEOS players.

Committable suggestion was skipped due to low confidence.

Tools
LanguageTool

[misspelling] ~131-~131: Possible spelling mistake found.
Context: ...rvice media_player.join For grouping HEOS media players together for synchronous ...

(MORFOLOGIK_RULE_EN_US)

[style] ~131-~131: Consider removing “of” to be more concise
Context: ...yer.bathroom` players. Please note that all of the media players need to be HEOS players. ...

(ALL_OF_THE)

[misspelling] ~131-~131: Possible spelling mistake found.
Context: ...hat all of the media players need to be HEOS players. ```yaml service: media_player...

(MORFOLOGIK_RULE_EN_US)


```yaml
entity_id: media_player.office
group_members:
- media_player.kitchen
- media_player.bathroom
service: media_player.join
data:
entity_id: media_player.office
group_members:
- media_player.kitchen
- media_player.bathroom
```

| Service data attribute | Optional | Description |
Expand All @@ -137,6 +149,12 @@ group_members:

For removing a HEOS player from a group you can use the `media_player.unjoin` service.
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot Jul 6, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fix spelling and missing comma.

Correct the spelling mistake and add a missing comma.

- For removing a HEOS player from a group you can use the `media_player.unjoin` service.
+ For removing a HEOS player from a group, you can use the `media_player.unjoin` service.
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
For removing a HEOS player from a group you can use the `media_player.unjoin` service.
For removing a HEOS player from a group, you can use the `media_player.unjoin` service.
Tools
LanguageTool

[misspelling] ~150-~150: Possible spelling mistake found.
Context: ...e media_player.unjoin For removing a HEOS player from a group you can use the `me...

(MORFOLOGIK_RULE_EN_US)

[uncategorized] ~150-~150: Possible missing comma found.
Context: ...oin For removing a HEOS player from a group you can use themedia_player.unjoin` s...

(AI_HYDRA_LEO_MISSING_COMMA)

[misspelling] ~150-~150: Possible spelling mistake found.
Context: ...EOS player from a group you can use the media_player.unjoin service. ```yaml service: media_playe...

(MORFOLOGIK_RULE_EN_US)


```yaml
service: media_player.unjoin
data:
entity_id: media_player.office
```

| Service data attribute | Optional | Description |
| ---------------------- | -------- | ------------------------------------------------ |
| `entity_id` | yes | Unjoin this media player from any player groups. |
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot Jul 6, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fix spelling mistake.

Correct the spelling mistake in the description.

- Unjoin this media player from any player group...
+ Unjoin this media player from any player groups...

Committable suggestion was skipped due to low confidence.

Tools
LanguageTool

[misspelling] ~160-~160: Possible spelling mistake found.
Context: ...| | entity_id | yes | Unjoin this media player from any player group...

(MORFOLOGIK_RULE_EN_US)

Expand All @@ -146,7 +164,7 @@ For removing a HEOS player from a group you can use the `media_player.unjoin` se
- Receivers with multiple zones are represented as a single media player. They will be turned on when playback is started, but cannot be turned off by the integration at this time.
- [Denon AVR](/integrations/denonar/) and HEOS media players can be combined into a [Universal Media Player](/integrations/universal/#denon-avr--heos)
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot Jul 6, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fix spelling mistakes.

Correct the spelling mistakes in the notes section.

- [Denon AVR](/integrations/denonar/) and HEOS media players can be combined into a [Universal Media Player](/integrations/universal/#denon-avr--heos)
+ [Denon AVR](/integrations/denon_avr/) and HEOS media players can be combined into a [Universal Media Player](/integrations/universal/#denon-avr--heos)
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
- [Denon AVR](/integrations/denonar/) and HEOS media players can be combined into a [Universal Media Player](/integrations/universal/#denon-avr--heos)
[Denon AVR](/integrations/denon_avr/) and HEOS media players can be combined into a [Universal Media Player](/integrations/universal/#denon-avr--heos)
Tools
LanguageTool

[misspelling] ~165-~165: Possible spelling mistake found.
Context: ...off by the integration at this time. - Denon AVR and HEOS m...

(MORFOLOGIK_RULE_EN_US)

[misspelling] ~165-~165: Possible spelling mistake found.
Context: ...e integration at this time. - Denon AVR and HEOS media players can be combine...

(MORFOLOGIK_RULE_EN_US)

[misspelling] ~165-~165: Possible spelling mistake found.
Context: ...Denon AVR and HEOS media players can be combined into a [U...

(MORFOLOGIK_RULE_EN_US)


## Troubleshooing
## Troubleshooting

### Debugging

Expand Down