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-24 17:57:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

Remove deprecated HEOS sign_in/out actions (#36724)

Browse Source
This commit is contained in:
Andrew Sayre 2025-01-04 18:03:34 -06:00 committed by GitHub
parent dade4022d6
commit 29d08bde02
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 1 additions and 42 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
source/_integrations/heos.markdown
View File

@ -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: "example@example.com"
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