-
-
Notifications
You must be signed in to change notification settings - Fork 7.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Remove deprecated HEOS sign_in/out actions (#36724)
- Loading branch information
1 parent
dade402
commit 29d08bd
Showing
1 changed file
with
1 addition
and
42 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -200,48 +200,7 @@ data: | |
|
||
## Actions | ||
|
||
The HEOS integration makes various custom {% term actions %} available in addition to the standard [Media Player actions](/integrations/media_player#actions). | ||
|
||
### Action `heos.sign_in` | ||
|
||
Use the sign-in action to sign the connected device 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. | ||
|
||
{% note %} | ||
The [configuration options](#configuration-options) is the preferred method for managing your HEOS Account credentials. This service action will be deprecated in the future. | ||
|
||
| ||
|
||
The device the integration connects to authenticates independently of other devices and the HEOS mobile app. When you first set up the integration, or after a device firmware update, the device will most likely not be logged in. | ||
{% endnote %} | ||
|
||
To run, go to **Developer Tools** > **Actions** and then type in `heos.sign_in`. Then enter your HEOS account username and password, and click the Perform Action button. An error message is only logged if sign-in is unsuccessful. | ||
|
||
Example action data payload: | ||
|
||
```yaml | ||
action: heos.sign_in | ||
data: | ||
username: "[email protected]" | ||
password: "password" | ||
``` | ||
|
||
| Data attribute | Optional | Description | | ||
| ---------------------- | -------- | ------------------------------------------ | | ||
| `username` | no | The username or email of the HEOS account. | | ||
| `password` | no | The password of the HEOS account. | | ||
|
||
### Action `heos.sign_out` | ||
|
||
Use the sign-out action to sign the connected device out of a HEOS account. An error message is logged if sign-out is unsuccessful. There are no parameters to this action Example action data payload: | ||
|
||
{% note %} | ||
The [configuration options](#configuration-options) is the preferred method for managing your HEOS Account credentials. This service action will be deprecated in the future. | ||
{% endnote %} | ||
|
||
```yaml | ||
action: heos.sign_out | ||
data: {% raw %}{}{% endraw %} | ||
``` | ||
The HEOS integration makes available the standard [Media Player actions](/integrations/media_player#actions). | ||
|
||
## Supported devices | ||
|
||
|