core/homeassistant/components/sonos/services.yaml

186 lines
4.0 KiB
YAML

join:
name: Join group
description: Group player together.
fields:
master:
name: Master
description:
Entity ID of the player that should become the coordinator of the group.
required: true
selector:
entity:
integration: sonos
domain: media_player
entity_id:
name: Entity
description: Name of entity that will join the master.
required: true
selector:
entity:
integration: sonos
domain: media_player
unjoin:
name: Unjoin group
description: Unjoin the player from a group.
target:
entity:
integration: sonos
domain: media_player
snapshot:
name: Snapshot
description: Take a snapshot of the media player.
fields:
entity_id:
name: Entity
description: Name of entity that will be snapshot.
selector:
entity:
integration: sonos
domain: media_player
with_group:
name: With group
description: True or False. Also snapshot the group layout.
default: true
selector:
boolean:
restore:
name: Restore
description: Restore a snapshot of the media player.
fields:
entity_id:
name: Entity
description: Name of entity that will be restored.
selector:
entity:
integration: sonos
domain: media_player
with_group:
name: With group
description: True or False. Also restore the group layout.
default: true
selector:
boolean:
set_sleep_timer:
name: Set timer
description: Set a Sonos timer.
target:
device:
integration: sonos
fields:
sleep_time:
name: Sleep Time
description: Number of seconds to set the timer.
selector:
number:
min: 0
max: 7200
unit_of_measurement: seconds
clear_sleep_timer:
name: Clear timer
description: Clear a Sonos timer.
target:
device:
integration: sonos
set_option:
name: Set option
description: Set Sonos sound options.
target:
device:
integration: sonos
fields:
bass_level:
name: Bass Level
description: Bass level for EQ.
selector:
number:
min: -10
max: 10
mode: box
treble_level:
name: Treble Level
description: Treble level for EQ.
selector:
number:
min: -10
max: 10
mode: box
play_queue:
name: Play queue
description: Start playing the queue from the first item.
target:
device:
integration: sonos
fields:
queue_position:
name: Queue position
description: Position of the song in the queue to start playing from.
selector:
number:
min: 0
max: 10000
mode: box
remove_from_queue:
name: Remove from queue
description: Removes an item from the queue.
target:
device:
integration: sonos
fields:
queue_position:
name: Queue position
description: Position in the queue to remove.
selector:
number:
min: 0
max: 10000
mode: box
update_alarm:
name: Update alarm
description: Updates an alarm with new time and volume settings.
target:
device:
integration: sonos
fields:
alarm_id:
name: Alarm ID
description: ID for the alarm to be updated.
required: true
selector:
number:
min: 1
max: 1440
mode: box
time:
name: Time
description: Set time for the alarm.
example: "07:00"
selector:
time:
volume:
name: Volume
description: Set alarm volume level.
selector:
number:
min: 0
max: 1
step: 0.01
enabled:
name: Alarm enabled
description: Enable or disable the alarm.
selector:
boolean:
include_linked_zones:
name: Include linked zones
description: Enable or disable including grouped rooms.
selector:
boolean: