Sonos

 

Channel 0

Variables

CONFIG_PENDING

Type:Boolean
Readable:Yes
Writeable:No

RSSI_DEVICE

Type:Integer
Readable:Yes
Writeable:No

RSSI_PEER

Type:Integer
Readable:Yes
Writeable:No

STICKY_UNREACH (Sticky unreachable)

Set to "true" when the device is unreachable. It stays "true" until reset manually.
 
Type:Boolean
Readable:Yes
Writeable:Yes

UNREACH (Unreachable)

Set to "true" when the device is unreachable.
 
Type:Boolean
Readable:Yes
Writeable:No

Channel 1

This channel can be the link source for the following link types:

  • SPEAKER_LINK

This channel can be the link target for the following link types:

  • SPEAKER_LINK

Variables

ADD_MEMBER

Type:String
Readable:No
Writeable:Yes

ADD_SPEAKER

Type:Integer
Readable:Yes
Writeable:Yes
Minimum Value:1

ADD_SPEAKER_BY_SERIAL

Type:String
Readable:Yes
Writeable:Yes

ADD_URI_TO_QUEUE

Type:String
Readable:Yes
Writeable:Yes

ADD_URI_TO_QUEUE_DESIRED_FIRST_TRACK_NUMBER

Type:Integer
Readable:Yes
Writeable:Yes
Minimum Value:0
Default Value:0

ADD_URI_TO_QUEUE_ENQUEUE_NEXT

Type:Boolean
Readable:Yes
Writeable:Yes
Default Value:true

ADD_URI_TO_QUEUE_METADATA

Type:String
Readable:Yes
Writeable:Yes

ALARM_RUNNING

Type:String
Readable:Yes
Writeable:No
Default Value:

AV_TRANSPORT_CLASS

Type:String
Readable:Yes
Writeable:No
Default Value:

AV_TRANSPORT_DESCRIPTION

Type:String
Readable:Yes
Writeable:No
Default Value:

AV_TRANSPORT_ID

Type:String
Readable:Yes
Writeable:No
Default Value:

AV_TRANSPORT_METADATA

Type:String
Readable:Yes
Writeable:Yes

AV_TRANSPORT_PARENT_ID

Type:String
Readable:Yes
Writeable:No
Default Value:

AV_TRANSPORT_RESTRICTED

Type:Boolean
Readable:Yes
Writeable:No
Default Value:false

AV_TRANSPORT_TITLE

Type:String
Readable:Yes
Writeable:No
Default Value:

AV_TRANSPORT_URI

Type:String
Readable:Yes
Writeable:Yes

BASS

Type:Integer
Readable:Yes
Writeable:Yes
Minimum Value:0
Maximum Value:100

CONTAINER_UPDATE_IDS

Type:String
Readable:Yes
Writeable:No
Default Value:

CURRENT_ALBUM

Type:String
Readable:Yes
Writeable:No
Default Value:

CURRENT_ALBUM_ART

Type:String
Readable:Yes
Writeable:No
Default Value:

CURRENT_ARTIST

Type:String
Readable:Yes
Writeable:No
Default Value:

CURRENT_CROSSFADE_MODE

Type:Boolean
Readable:Yes
Writeable:No

CURRENT_MEDIA_DURATION

Type:String
Readable:Yes
Writeable:No
Default Value:

CURRENT_PLAY_MODE

Type:Enumeration
Readable:Yes
Writeable:Yes
Default Value:0
Values:
0NORMAL
1SHUFFLE
2REPEAT_ONE
3REPEAT_ALL
4SHUFFLE_NOREPEAT
5SHUFFLE_REPEAT_ONE

CURRENT_PLAY_MODES

Type:String
Readable:Yes
Writeable:No
Default Value:

CURRENT_RECORD_QUALITY_MODE

Type:String
Readable:Yes
Writeable:No
Default Value:

CURRENT_SECTION

Type:String
Readable:Yes
Writeable:No
Default Value:

CURRENT_TITLE

Type:String
Readable:Yes
Writeable:No
Default Value:

CURRENT_TRACK

Type:Integer
Readable:Yes
Writeable:Yes
Minimum Value:1

CURRENT_TRACK_ABSOLUTE_COUNT

Type:Integer
Readable:Yes
Writeable:No

CURRENT_TRACK_ABSOLUTE_TIME

Type:String
Readable:Yes
Writeable:No
Default Value:

CURRENT_TRACK_CLASS

Type:String
Readable:Yes
Writeable:No
Default Value:

CURRENT_TRACK_DURATION

Type:Integer
Unit:s
Readable:Yes
Writeable:No
Minimum Value:0

CURRENT_TRACK_DURATION2

Type:Integer
Unit:s
Readable:Yes
Writeable:No
Minimum Value:0

CURRENT_TRACK_ID

Type:String
Readable:Yes
Writeable:No
Default Value:

CURRENT_TRACK_METADATA

Type:String
Readable:Yes
Writeable:No
Default Value:

CURRENT_TRACK_PARENT_ID

Type:String
Readable:Yes
Writeable:No
Default Value:

CURRENT_TRACK_PROTOCOL

Type:String
Readable:Yes
Writeable:No
Default Value:

CURRENT_TRACK_RADIO_SHOW_MD

Type:String
Readable:Yes
Writeable:No
Default Value:

CURRENT_TRACK_RELATIVE_COUNT

Type:Integer
Readable:Yes
Writeable:No

CURRENT_TRACK_RELATIVE_TIME

Type:Integer
Unit:s
Readable:Yes
Writeable:Yes
Minimum Value:0

CURRENT_TRACK_RESOURCE

Type:String
Readable:Yes
Writeable:No
Default Value:

CURRENT_TRACK_RESTRICTED

Type:Boolean
Readable:Yes
Writeable:No
Default Value:false

CURRENT_TRACK_STREAM_CONTENT

Type:String
Readable:Yes
Writeable:No
Default Value:

CURRENT_TRACK_URI

Type:String
Readable:Yes
Writeable:No
Default Value:

CURRENT_TRANSPORT_ACTIONS

Type:String
Readable:Yes
Writeable:No
Default Value:

ENQUEUED_TRANSPORT_CLASS

Type:String
Readable:Yes
Writeable:No
Default Value:

ENQUEUED_TRANSPORT_DESCRIPTION

Type:String
Readable:Yes
Writeable:No
Default Value:

ENQUEUED_TRANSPORT_ID

Type:String
Readable:Yes
Writeable:No
Default Value:

ENQUEUED_TRANSPORT_METADATA

Type:String
Readable:Yes
Writeable:No
Default Value:

ENQUEUED_TRANSPORT_PARENT_ID

Type:String
Readable:Yes
Writeable:No
Default Value:

ENQUEUED_TRANSPORT_RESTRICTED

Type:Boolean
Readable:Yes
Writeable:No
Default Value:false

ENQUEUED_TRANSPORT_TITLE

Type:String
Readable:Yes
Writeable:No
Default Value:

ENQUEUED_TRANSPORT_URI

Type:String
Readable:Yes
Writeable:No
Default Value:

ENQUEUE_AUDIO_FILE

Type:String
Readable:Yes
Writeable:Yes

FAVORITES

Type:Array
Readable:Yes
Writeable:No

FAVORITES_UPDATE_ID

Type:String
Readable:Yes
Writeable:No
Default Value:

FAVORITE_PRESETS_UPDATE_ID

Type:String
Readable:Yes
Writeable:No
Default Value:

FIRST_TRACK_NUMBER_ENQUEUED

Type:Integer
Readable:Yes
Writeable:No
Minimum Value:0

HEADPHONE_CONNECTED

Type:Boolean
Readable:Yes
Writeable:Yes

ID

Type:String
Readable:Yes
Writeable:No

IP_ADDRESS

Type:String
Readable:Yes
Writeable:No

IS_MASTER

Type:Boolean
Readable:Yes
Writeable:No

IS_STREAM

Type:Boolean
Readable:Yes
Writeable:No

LED_STATE

Type:Boolean
Readable:Yes
Writeable:Yes

LOUDNESS

Type:Integer
Readable:Yes
Writeable:Yes
Minimum Value:0
Maximum Value:100

MASTER_ID

Type:Integer
Readable:Yes
Writeable:No
Minimum Value:0

MUTE

Type:Boolean
Readable:Yes
Writeable:Yes

MUTE_LF

Type:Boolean
Readable:Yes
Writeable:Yes

MUTE_RF

Type:Boolean
Readable:Yes
Writeable:Yes

NEXT

Type:Action
Readable:Yes
Writeable:Yes

NEXT_ALBUM

Type:String
Readable:Yes
Writeable:No
Default Value:

NEXT_ALBUM_ART

Type:String
Readable:Yes
Writeable:No
Default Value:

NEXT_ARTIST

Type:String
Readable:Yes
Writeable:No
Default Value:

NEXT_AV_TRANSPORT_CLASS

Type:String
Readable:Yes
Writeable:No
Default Value:

NEXT_AV_TRANSPORT_DESCRIPTION

Type:String
Readable:Yes
Writeable:No
Default Value:

NEXT_AV_TRANSPORT_ID

Type:String
Readable:Yes
Writeable:No
Default Value:

NEXT_AV_TRANSPORT_METADATA

Type:String
Readable:Yes
Writeable:No
Default Value:

NEXT_AV_TRANSPORT_PARENT_ID

Type:String
Readable:Yes
Writeable:No
Default Value:

NEXT_AV_TRANSPORT_RESTRICTED

Type:Boolean
Readable:Yes
Writeable:No
Default Value:false

NEXT_AV_TRANSPORT_TITLE

Type:String
Readable:Yes
Writeable:No
Default Value:

NEXT_AV_TRANSPORT_URI

Type:String
Readable:Yes
Writeable:No
Default Value:

NEXT_TITLE

Type:String
Readable:Yes
Writeable:No
Default Value:

NEXT_TRACK_CLASS

Type:String
Readable:Yes
Writeable:No
Default Value:

NEXT_TRACK_DURATION

Type:Integer
Unit:s
Readable:Yes
Writeable:No
Minimum Value:0

NEXT_TRACK_ID

Type:String
Readable:Yes
Writeable:No
Default Value:

NEXT_TRACK_METADATA

Type:String
Readable:Yes
Writeable:No
Default Value:

NEXT_TRACK_PARENT_ID

Type:String
Readable:Yes
Writeable:No
Default Value:

NEXT_TRACK_PROTOCOL

Type:String
Readable:Yes
Writeable:No
Default Value:

NEXT_TRACK_RADIO_SHOW_MD

Type:String
Readable:Yes
Writeable:No
Default Value:

NEXT_TRACK_RESOURCE

Type:String
Readable:Yes
Writeable:No
Default Value:

NEXT_TRACK_RESTRICTED

Type:Boolean
Readable:Yes
Writeable:No
Default Value:false

NEXT_TRACK_STREAM_CONTENT

Type:String
Readable:Yes
Writeable:No
Default Value:

NEXT_TRACK_URI

Type:String
Readable:Yes
Writeable:No
Default Value:

NUMBER_OF_TRACKS

Type:Integer
Readable:Yes
Writeable:No
Minimum Value:0

OUTPUT_FIXED

Type:Boolean
Readable:Yes
Writeable:Yes

PAUSE

Type:Action
Readable:Yes
Writeable:Yes

PEER_ID

Type:Integer
Readable:Yes
Writeable:Yes

PLAY

Type:Action
Readable:Yes
Writeable:Yes

PLAYBACK_STORAGE_MEDIUM

Type:String
Readable:Yes
Writeable:No
Default Value:

PLAYLISTS

Type:Array
Readable:Yes
Writeable:No

PLAY_AUDIO_FILE

Type:String
Readable:Yes
Writeable:Yes

PLAY_AUDIO_FILE_UNMUTE

Type:Boolean
Readable:Yes
Writeable:Yes
Default Value:true

PLAY_AUDIO_FILE_VOLUME

Type:Integer
Readable:Yes
Writeable:Yes
Minimum Value:-1
Maximum Value:100

PLAY_FADE

Type:Action
Readable:Yes
Writeable:Yes

PLAY_FAVORITE

Type:String
Readable:Yes
Writeable:Yes

PLAY_PLAYLIST

Type:String
Readable:Yes
Writeable:Yes

PLAY_RADIO_FAVORITE

Type:String
Readable:Yes
Writeable:Yes

PLAY_TTS

Type:String
Readable:Yes
Writeable:Yes

PLAY_TTS_LANGUAGE

Type:String
Readable:Yes
Writeable:Yes
Default Value:en-US

PLAY_TTS_UNMUTE

Type:Boolean
Readable:Yes
Writeable:Yes
Default Value:true

PLAY_TTS_VOICE

Type:String
Readable:Yes
Writeable:Yes
Default Value:Justin

PLAY_TTS_VOLUME

Type:Integer
Readable:Yes
Writeable:Yes
Minimum Value:-1
Maximum Value:100

POSSIBLE_PLAYBACK_STORAGE_MEDIUM

Type:String
Readable:Yes
Writeable:No
Default Value:

POSSIBLE_RECORD_QUALITY_MODES

Type:String
Readable:Yes
Writeable:No
Default Value:

POSSIBLE_RECORD_STORAGE_MEDIUM

Type:String
Readable:Yes
Writeable:No
Default Value:

PRESET_NAME_LIST

Type:String
Readable:Yes
Writeable:Yes
Default Value:

PREVIOUS

Type:Action
Readable:Yes
Writeable:Yes

QUEUE_TITLES

Type:Array
Readable:Yes
Writeable:No

RADIO_FAVORITES

Type:Array
Readable:Yes
Writeable:No

RADIO_FAVORITES_UPDATE_ID

Type:String
Readable:Yes
Writeable:No
Default Value:

RADIO_LOCATION_UPDATE_ID

Type:String
Readable:Yes
Writeable:No
Default Value:

RAMP_TO_VOLUME

Type:Integer
Readable:Yes
Writeable:Yes
Minimum Value:0
Maximum Value:100

RECENTLY_PLAYED_UPDATE_ID

Type:String
Readable:Yes
Writeable:No
Default Value:

RECORD_MEDIUM_WRITE_STATUS

Type:String
Readable:Yes
Writeable:No
Default Value:

RECORD_STORAGE_MEDIUM

Type:String
Readable:Yes
Writeable:No
Default Value:

REMAINING_SLEEP_TIMER_DURATION

Type:String
Readable:Yes
Writeable:No
Default Value:

REMOVE_ALL_TRACKS_FROM_QUEUE

Type:Action
Readable:Yes
Writeable:Yes

REMOVE_MEMBER

Type:String
Readable:No
Writeable:Yes

REMOVE_SPEAKER

Type:Integer
Readable:Yes
Writeable:Yes
Minimum Value:1

REMOVE_SPEAKER_BY_SERIAL

Type:String
Readable:Yes
Writeable:Yes

RESTART_PENDING

Type:String
Readable:Yes
Writeable:No
Default Value:

ROOMNAME

Type:String
Readable:Yes
Writeable:No

SAVED_QUEUES_UPDATE_ID

Type:String
Readable:Yes
Writeable:No
Default Value:

SHARE_INDEX_IN_PROGRESS

Type:String
Readable:Yes
Writeable:No
Default Value:

SHARE_INDEX_LAST_ERROR

Type:String
Readable:Yes
Writeable:No
Default Value:

SHARE_LIST_REFRESH_STATE

Type:String
Readable:Yes
Writeable:No
Default Value:

SHARE_LIST_UPDATE_ID

Type:String
Readable:Yes
Writeable:No
Default Value:

SLEEP_TIMER_GENERATION

Type:String
Readable:Yes
Writeable:No
Default Value:

SNOOZE_RUNNING

Type:String
Readable:Yes
Writeable:No
Default Value:

SPEAKER_SIZE

Type:Integer
Readable:Yes
Writeable:Yes
Minimum Value:0
Maximum Value:100

STOP

Type:Action
Readable:Yes
Writeable:Yes

STREAM_LOCAL_INPUT (Stream local input)

Play the local audio input (e. g. from the 3.5 mm jack plug on the speaker). Only works, if the speaker has an audio input and something is connected to it.
 
Type:Action
Readable:Yes
Writeable:Yes

SUB_CROSSOVER

Type:Boolean
Readable:Yes
Writeable:Yes

SUB_ENABLED

Type:Boolean
Readable:Yes
Writeable:Yes

SUB_GAIN

Type:Integer
Readable:Yes
Writeable:Yes
Minimum Value:0
Maximum Value:100

SUB_POLARITY

Type:Boolean
Readable:Yes
Writeable:Yes

SYSTEM_UPDATE_ID

Type:String
Readable:Yes
Writeable:No
Default Value:

TRANSPORT_PLAY_SPEED

Type:String
Readable:Yes
Writeable:No
Default Value:

TRANSPORT_STATE

Type:Enumeration
Readable:Yes
Writeable:No
Default Value:0
Values:
0STOPPED
1PAUSED_PLAYBACK
2TRANSITIONING
3PLAYING

TRANSPORT_STATUS

Type:String
Readable:Yes
Writeable:No
Default Value:

TREBLE

Type:Integer
Readable:Yes
Writeable:Yes
Minimum Value:0
Maximum Value:100

VOLUME

Type:Integer
Readable:Yes
Writeable:Yes
Minimum Value:0
Maximum Value:100

VOLUME_LF

Type:Integer
Readable:Yes
Writeable:Yes
Minimum Value:0
Maximum Value:100

VOLUME_RF

Type:Integer
Readable:Yes
Writeable:Yes
Minimum Value:0
Maximum Value:100