jeans/core
jeans/core
1
0
Fork 0
mirror of https://github.com/home-assistant/core.git synced 2025-07-20 11:47:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add target and selectors to sonos services (#49536)

Browse Source
This commit is contained in:
tkdrob 2021-04-25 16:28:42 -04:00 committed by GitHub
parent f7b72669dc
commit d24cbde913
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 69 additions and 45 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

112
homeassistant/components/sonos/services.yaml
View File

@ -3,6 +3,7 @@ join:
description: Group player together. description: Group player together.
fields: fields:
master: master:
name: Master
description: description:
Entity ID of the player that should become the coordinator of the group. Entity ID of the player that should become the coordinator of the group.
example: "media_player.living_room_sonos" example: "media_player.living_room_sonos"
@ -11,7 +12,8 @@ join:
integration: sonos integration: sonos
domain: media_player domain: media_player
entity_id: entity_id:
description: Name(s) of entities that will join the master. name: Entity
description: Name of entity that will join the master.
example: "media_player.living_room_sonos" example: "media_player.living_room_sonos"
selector: selector:
entity: entity:
@ -23,7 +25,8 @@ unjoin:
description: Unjoin the player from a group. description: Unjoin the player from a group.
fields: fields:
entity_id: entity_id:
description: Name(s) of entities that will be unjoined from their group. name: Entity
description: Name of entity that will be unjoined from their group.
example: "media_player.living_room_sonos" example: "media_player.living_room_sonos"
selector: selector:
entity: entity:
@ -35,49 +38,56 @@ snapshot:
description: Take a snapshot of the media player. description: Take a snapshot of the media player.
fields: fields:
entity_id: entity_id:
description: Name(s) of entities that will be snapshot. name: Entity
description: Name of entity that will be snapshot.
example: "media_player.living_room_sonos" example: "media_player.living_room_sonos"
selector: selector:
entity: entity:
integration: sonos integration: sonos
domain: media_player domain: media_player
with_group: with_group:
description: True (default) or False. Also snapshot the group layout. name: With group
description: True or False. Also snapshot the group layout.
example: "true" example: "true"
default: true
selector:
boolean:
restore: restore:
name: Restore name: Restore
description: Restore a snapshot of the media player. description: Restore a snapshot of the media player.
fields: fields:
entity_id: entity_id:
description: Name(s) of entities that will be restored. name: Entity
description: Name of entity that will be restored.
example: "media_player.living_room_sonos" example: "media_player.living_room_sonos"
selector: selector:
entity: entity:
integration: sonos integration: sonos
domain: media_player domain: media_player
with_group: with_group:
description: True (default) or False. Also restore the group layout. name: With group
description: True or False. Also restore the group layout.
example: "true" example: "true"
default: true
selector:
boolean:
set_sleep_timer: set_sleep_timer:
name: Set timer name: Set timer
description: Set a Sonos timer. description: Set a Sonos timer.
fields: target:
entity_id: device:
description: Name(s) of entities that will have a timer set.
example: "media_player.living_room_sonos"
selector:
entity:
integration: sonos integration: sonos
domain: media_player fields:
sleep_time: sleep_time:
name: Sleep Time
description: Number of seconds to set the timer. description: Number of seconds to set the timer.
example: "900" example: "900"
selector: selector:
number: number:
min: 0 min: 0
max: 3600 max: 7200
step: 1 step: 1
unit_of_measurement: seconds unit_of_measurement: seconds
mode: slider mode: slider
@ -85,37 +95,31 @@ set_sleep_timer:
clear_sleep_timer: clear_sleep_timer:
name: Clear timer name: Clear timer
description: Clear a Sonos timer. description: Clear a Sonos timer.
fields: target:
entity_id: device:
description: Name(s) of entities that will have the timer cleared.
example: "media_player.living_room_sonos"
selector:
entity:
integration: sonos integration: sonos
domain: media_player
set_option: set_option:
name: Set option name: Set option
description: Set Sonos sound options. description: Set Sonos sound options.
fields: target:
entity_id: device:
description: Name(s) of entities that will have options set.
example: "media_player.living_room_sonos"
selector:
entity:
integration: sonos integration: sonos
domain: media_player fields:
night_sound: night_sound:
name: Night sound
description: Enable Night Sound mode description: Enable Night Sound mode
example: "true" example: "true"
selector: selector:
boolean: boolean:
speech_enhance: speech_enhance:
name: Speech enhance
description: Enable Speech Enhancement mode description: Enable Speech Enhancement mode
example: "true" example: "true"
selector: selector:
boolean: boolean:
status_light: status_light:
name: Status light
description: Enable Status (LED) Light description: Enable Status (LED) Light
example: "true" example: "true"
selector: selector:
@ -124,59 +128,79 @@ set_option:
play_queue: play_queue:
name: Play queue name: Play queue
description: Start playing the queue from the first item. description: Start playing the queue from the first item.
fields: target:
entity_id: device:
description: Name(s) of entities that will start playing.
example: "media_player.living_room_sonos"
selector:
entity:
integration: sonos integration: sonos
domain: media_player fields:
queue_position: queue_position:
name: Queue position
description: Position of the song in the queue to start playing from. description: Position of the song in the queue to start playing from.
example: "0" example: "0"
selector: selector:
number: number:
min: 0 min: 0
max: 100000000 max: 10000
mode: box mode: box
remove_from_queue: remove_from_queue:
name: Remove from queue name: Remove from queue
description: Removes an item from the queue. description: Removes an item from the queue.
fields: target:
entity_id: device:
description: Name(s) of entities that will remove an item.
example: "media_player.living_room_sonos"
selector:
entity:
integration: sonos integration: sonos
domain: media_player fields:
queue_position: queue_position:
name: Queue position
description: Position in the queue to remove. description: Position in the queue to remove.
example: "0" example: "0"
selector: selector:
number: number:
min: 0 min: 0
max: 100000000 max: 10000
mode: box mode: box
update_alarm: update_alarm:
name: Update alarm name: Update alarm
description: Updates an alarm with new time and volume settings. description: Updates an alarm with new time and volume settings.
target:
device:
integration: sonos
fields: fields:
alarm_id: alarm_id:
name: Alarm ID
description: ID for the alarm to be updated. description: ID for the alarm to be updated.
example: "1" example: "1"
required: true
selector:
number:
min: 1
max: 1440
mode: box
time: time:
name: Time
description: Set time for the alarm. description: Set time for the alarm.
example: "07:00" example: "07:00"
selector:
time:
volume: volume:
name: Volume
description: Set alarm volume level. description: Set alarm volume level.
example: "0.75" example: "0.75"
selector:
number:
min: 0
max: 1
step: 0.01
mode: slider
enabled: enabled:
name: Alarm enabled
description: Enable or disable the alarm. description: Enable or disable the alarm.
example: "true" example: "true"
selector:
boolean:
include_linked_zones: include_linked_zones:
name: Include linked zones
description: Enable or disable including grouped rooms. description: Enable or disable including grouped rooms.
example: "true" example: "true"
selector:
boolean: