Revert Sonos service call reformatting (#9048)

This commit is contained in:
Anders Melchiorsen 2019-03-30 14:11:09 +01:00 committed by Franck Nijhof
parent 71d82e9a0f
commit 9b29fb4a91

View File

@ -31,16 +31,11 @@ Take a snapshot of what is currently playing on one or more speakers. This servi
The queue is not snapshotted and must be left untouched until the restore. Using `media_player.play_media` is safe and can be used to play a notification sound, including [TTS](/components/tts/) announcements. The queue is not snapshotted and must be left untouched until the restore. Using `media_player.play_media` is safe and can be used to play a notification sound, including [TTS](/components/tts/) announcements.
</p> </p>
{% configuration %} | Service data attribute | Optional | Description |
entity_id: | ---------------------- | -------- | ----------- |
description: The speakers to snapshot. | `entity_id` | yes | The speakers to snapshot.
required: false | `with_group` | yes | Should we also snapshot the group layout and the state of other speakers in the group.
type: entity_id
with_group:
description: Should we also snapshot the group layout and the state of other speakers in the group.
required: false
type: boolean
{% endconfiguration %}
### {% linkable_title Service `media_player.sonos_restore` %} ### {% linkable_title Service `media_player.sonos_restore` %}
@ -54,99 +49,55 @@ The playing queue is not snapshotted. Using `media_player.sonos_restore` on a sp
A cloud queue cannot be restarted. This includes queues started from within Spotify and queues controlled by Amazon Alexa. A cloud queue cannot be restarted. This includes queues started from within Spotify and queues controlled by Amazon Alexa.
</p> </p>
{% configuration %} | Service data attribute | Optional | Description |
entity_id: | ---------------------- | -------- | ----------- |
description: The speakers that should have their snapshot restored. | `entity_id` | yes | String or list of `entity_id`s that should have their snapshot restored.
required: false | `with_group` | yes | Should we also restore the group layout and the state of other speakers in the group.
type: entity_id
with_group:
description: Should we also restore the group layout and the state of other speakers in the group.
required: false
type: boolean
{% endconfiguration %}
### {% linkable_title Service `media_player.sonos_join` %} ### {% linkable_title Service `media_player.sonos_join` %}
Group players together under a single coordinator. This will make a new group or join to an existing group. Group players together under a single coordinator. This will make a new group or join to an existing group.
| Service data attribute | Optional | Description |
{% configuration %} | ---------------------- | -------- | ----------- |
master: | `master` | no | A single `entity_id` that will become/stay the coordinator speaker.
description: A single `entity_id` that will become/stay the coordinator speaker. | `entity_id` | no | String or list of `entity_id`s to join to the master.
required: true
type: entity_id
entity_id:
description: The speakers to join to the master.
required: false
type: entity_id
{% endconfiguration %}
### {% linkable_title Service `media_player.sonos_unjoin` %} ### {% linkable_title Service `media_player.sonos_unjoin` %}
Remove one or more speakers from their group of speakers. If no `entity_id` is provided, all speakers are unjoined. Remove one or more speakers from their group of speakers. If no `entity_id` is provided, all speakers are unjoined.
| Service data attribute | Optional | Description |
{% configuration %} | ---------------------- | -------- | ----------- |
entity_id: | `entity_id` | no | String or list of `entity_id`s to separate from their coordinator speaker.
description: The speakers to separate from their coordinator speaker.
required: false
type: entity_id
{% endconfiguration %}
### {% linkable_title Service `media_player.sonos_set_sleep_timer` %} ### {% linkable_title Service `media_player.sonos_set_sleep_timer` %}
Sets a timer that will turn off a speaker by tapering the volume down to 0 after a certain amount of time. Protip: If you set the sleep_time value to 0, then the speaker will immediately start tapering the volume down. Sets a timer that will turn off a speaker by tapering the volume down to 0 after a certain amount of time. Protip: If you set the sleep_time value to 0, then the speaker will immediately start tapering the volume down.
{% configuration %} | Service data attribute | Optional | Description |
entity_id: | ---------------------- | -------- | ----------- |
description: The speakers that will have their timers set. | `entity_id` | no | String or list of `entity_id`s that will have their timers set.
required: true | `sleep_time` | no | Integer number of seconds that the speaker should wait until it starts tapering. Cannot exceed 86399 (one day).
type: entity_id
sleep_time:
description: Number of seconds that the speaker should wait until it starts tapering. Cannot exceed 86399 (one day).
required: true
type: integer
{% endconfiguration %}
### {% linkable_title Service `media_player.sonos_clear_sleep_timer` %} ### {% linkable_title Service `media_player.sonos_clear_sleep_timer` %}
Clear the sleep timer on a speaker, if one is set. Clear the sleep timer on a speaker, if one is set.
{% configuration %} | Service data attribute | Optional | Description |
entity_id: | ---------------------- | -------- | ----------- |
description: The speakers that will have their timers cleared. | `entity_id` | no | String or list of `entity_id`s that will have their timers cleared. Must be a coordinator speaker.
required: true
type: entity_id
{% endconfiguration %}
### {% linkable_title Service `media_player.sonos_update_alarm` %} ### {% linkable_title Service `media_player.sonos_update_alarm` %}
Update an existing Sonos alarm. Update an existing Sonos alarm.
{% configuration %} | Service data attribute | Optional | Description |
entity_id: | ---------------------- | -------- | ----------- |
description: The speaker that will have its alarm updated. | `entity_id` | no | String or list of `entity_id`s that will have their timers cleared. Must be a coordinator speaker.
required: true | `alarm_id` | no | Integer that is used in Sonos to refer to your alarm.
type: entity_id | `time` | yes | Time to set the alarm.
alarm_id: | `volume` | yes | Float for volume level.
description: Integer that is used in Sonos to refer to your alarm. | `enabled` | yes | Boolean for whether or not to enable this alarm.
required: true | `include_linked_zones` | yes | Boolean that defines if the alarm also plays on grouped players.
type: integer
time:
description: Time to set the alarm.
required: no
type: time
volume:
description: Float for volume level (0.0-1.0).
required: no
type: float
enabled:
description: Boolean for whether or not to enable this alarm.
required: no
type: boolean
include_linked_zones:
description: Boolean that defines if the alarm also plays on grouped players.
required: no
type: boolean
{% endconfiguration %}
### {% linkable_title Service `media_player.sonos_set_option` %} ### {% linkable_title Service `media_player.sonos_set_option` %}
@ -154,20 +105,11 @@ Set Sonos speaker options.
Night Sound and Speech Enhancement modes are only supported when playing from the TV source of products like Sonos Playbar and Sonos Beam. Other speaker types will ignore these options. Night Sound and Speech Enhancement modes are only supported when playing from the TV source of products like Sonos Playbar and Sonos Beam. Other speaker types will ignore these options.
{% configuration %} | Service data attribute | Optional | Description |
entity_id: | ---------------------- | -------- | ----------- |
description: The speakers that will have their options set. | `entity_id` | no | String or list of `entity_id`s that will have their options set.
required: true | `night_sound` | yes | Boolean to control Night Sound mode.
type: entity_id | `speech_enhance` | yes | Boolean to control Speech Enhancement mode.
night_sound:
description: Boolean to control Night Sound mode.
required: no
type: boolean
speech_enhance:
description: Boolean to control Speech Enhancement mode.
required: no
type: boolean
{% endconfiguration %}
## {% linkable_title Advanced use %} ## {% linkable_title Advanced use %}