Add buttons for sleep timer to bluesound integration (#36438)

This commit is contained in:
Louis Christ 2025-05-19 14:24:59 +02:00 committed by GitHub
parent ff67248a03
commit eb88953711
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -8,6 +8,7 @@ ha_iot_class: Local Polling
ha_domain: bluesound
ha_platforms:
- media_player
- button
ha_codeowners:
- '@thrawnarn'
- '@LouisChrist'
@ -23,6 +24,36 @@ The `bluesound` platform allows you to control your [Bluesound](https://www.blue
{% include integrations/config_flow.md %}
## Buttons
These are the available button entities:
- `button.speaker_name_set_sleep_timer`: Setting a sleep timer.
- `button.speaker_name_sleep_timer`: Clearing the sleep timer.
Replace `speaker_name` with the name of your speaker.
### Button `button.speaker_name_set_sleep_timer`
Sets a timer that will turn off the speaker. For each time you call this it will increase the time by one step. The steps are (in minutes): 15, 30, 45, 60, 90, 0.
If you increase an ongoing timer of for example 13 minutes, it will increase it to 15. If the timer is set to 90, it will remove the time (hence the 0).
{% note %}
This button is disabled by default.
{% endnote %}
### Button `button.speaker_name_clear_sleep_timer`
Clear the sleep timer on a speaker, if one is set.
{% note %}
This button is disabled by default.
{% endnote %}
## Actions
The Bluesound integration makes some custom actions available in addition to the [standard media player actions](/integrations/media_player/#actions).
### Action `bluesound.join`
Group players together under a single master speaker. That will make a new group or join an existing group.
@ -42,6 +73,10 @@ Remove one or more speakers from a group of speakers. If no `entity_id` is provi
### Action `bluesound.set_sleep_timer`
{% note %}
This action is deprecated. Use `button.<player_name>_set_set_timer` instead.
{% endnote %}
Sets a timer that will turn off the speaker. For each time you call this it will increase the time by one step. The steps are (in minutes): 15, 30, 45, 60, 90, 0.
If you increase an ongoing timer of for example 13 minutes, it will increase it to 15. If the timer is set to 90, it will remove the time (hence the 0).
@ -51,6 +86,10 @@ If you increase an ongoing timer of for example 13 minutes, it will increase it
### Action `bluesound.clear_sleep_timer`
{% note %}
This action is deprecated. Use `button.<player_name>_clear_set_timer` instead.
{% endnote %}
Clear the sleep timer on a speaker, if one is set.
| Data attribute | Optional | Description |