Difference between revisions of "Sonos"
Jump to navigation
Jump to search
Line 201: | Line 201: | ||
=== UISET Actions === | === UISET Actions === | ||
+ | |||
+ | {| class="wikitable" | ||
+ | !ID | ||
+ | !Attribute | ||
+ | !colspan="2"|Set to | ||
+ | |||
+ | |- | ||
+ | |||
+ | |rowspan="2"|connection | ||
+ | |rowspan="2"|visible | ||
+ | |true | ||
+ | |when datapoint connection = offline | ||
+ | |- | ||
+ | |false | ||
+ | |when datapoint connection = online | ||
+ | |||
+ | |- | ||
+ | |||
+ | |rowspan="2"|state.playing | ||
+ | |rowspan="2"|visible | ||
+ | |true | ||
+ | |when datapoint state = playing | ||
+ | |- | ||
+ | |false | ||
+ | |otherwise | ||
+ | |||
+ | |- | ||
+ | |||
+ | |rowspan="2"|state.paused_playback | ||
+ | |rowspan="2"|visible | ||
+ | |true | ||
+ | |when datapoint state = paused_playback | ||
+ | |- | ||
+ | |false | ||
+ | |otherwise | ||
+ | |||
+ | |- | ||
+ | |||
+ | |rowspan="2"|state.transitioning | ||
+ | |rowspan="2"|visible | ||
+ | |true | ||
+ | |when datapoint state = transitioning | ||
+ | |- | ||
+ | |false | ||
+ | |otherwise | ||
+ | |||
+ | |- | ||
+ | |||
+ | |rowspan="2"|state.stopped | ||
+ | |rowspan="2"|visible | ||
+ | |true | ||
+ | |when datapoint state = stopped | ||
+ | |- | ||
+ | |false | ||
+ | |otherwise | ||
+ | |||
+ | |- | ||
+ | |||
+ | |track.number | ||
+ | |value | ||
+ | |colspan="2"|the current track number | ||
+ | |||
+ | |- | ||
+ | |||
+ | |track.title | ||
+ | |value | ||
+ | |colspan="2"|the current track's title | ||
+ | |||
+ | |- | ||
+ | |||
+ | |track.creator | ||
+ | |value | ||
+ | |colspan="2"|the current track's author | ||
+ | |||
+ | |- | ||
+ | |||
+ | |track.album | ||
+ | |value | ||
+ | |colspan="2"|the name of the current track's album | ||
+ | |||
+ | |- | ||
+ | |||
+ | |rowspan="2"|mute.1 | ||
+ | |rowspan="2"|visible | ||
+ | |true | ||
+ | |when datapoint mute = 1 | ||
+ | |- | ||
+ | |false | ||
+ | |when datapoint mute = 0 | ||
+ | |||
+ | |- | ||
+ | |||
+ | |rowspan="2"|mute.0 | ||
+ | |rowspan="2"|visible | ||
+ | |true | ||
+ | |when datapoint mute = 0 | ||
+ | |- | ||
+ | |false | ||
+ | |when datapoint mute = 1 | ||
+ | |||
+ | |- | ||
+ | |||
+ | |volume | ||
+ | |value | ||
+ | |colspan="2"|the current volume's value (0 ... 100) | ||
+ | |||
+ | |} | ||
=== USER Commands === | === USER Commands === |
Revision as of 10:24, 12 February 2015
Sonos is...
Contents
Communication
Just make sure the Sonos device is connected to the same local network as HSYCO server is.
HSYCO Configuration
Add a SONOS I/O Server in the I/O Servers section of the Settings and set its parameters:
High Availability
- Shutdown when inactive: defaults to false.
Options
ID | Default | Values | Description |
---|---|---|---|
startupevents | false | true | generate IO events also during the driver’s start-up phase |
false | start generating events only after HSYCO is aligned with the current status of the system | ||
room | <room_name> | If specified, the driver will connect to the device with the corresponding room name. If not specified this driver will look for and connect to any Sonos device on the local network |
Datapoints
ID | Value | R/W | Description |
---|---|---|---|
connection | online | R | connection established |
offline | R | HSYCO can't connect to the device | |
state | playing | R | the audio is playing |
paused_playback | R | the audio is paused | |
transitioning | R | the device is transitioning between audio streams | |
stopped | R | the audio is stopped | |
unknown | R | the current state is unknown | |
track.number | <n> | R | the current track is the number <n> in the current queue (can be "unknown") |
track.title | <title> | R | title of the current track (can be "unknown") |
track.creator | <name> | R | name of the author of the current track (can be "unknown") |
track.album | <name> | R | name of the album of the current track (can be "unknown") |
track.albumarturi | <uri> | R | uri of the album art of the current track (can be "unknown") |
mute | 1 | R | the audio is muted |
W | mute the audio | ||
0 | R | the audio is not muted | |
W | unmute the audio | ||
volume | 0 ... 100 | R | the volume is set to the reported value |
W | set the volume to the specified value | ||
+<n> | W | increase the volume of the specified value | |
-<n> | W | decrease the volume of the specified value | |
play | W | start playing | |
<uri> | W | play the audio file located at the specified URI | |
pause | W | pause the audio | |
stop | W | stop the current queue | |
next | W | go to the next queued track | |
previous | W | go to the previous queued track | |
queue | <n>:<uri> | W | add to the current queue, in <n>-th position, the audio file located at the specified URI (set <n> to 0 to add it at the end of the queue) |
User Interface
UISET Actions
ID | Attribute | Set to | |
---|---|---|---|
connection | visible | true | when datapoint connection = offline |
false | when datapoint connection = online | ||
state.playing | visible | true | when datapoint state = playing |
false | otherwise | ||
state.paused_playback | visible | true | when datapoint state = paused_playback |
false | otherwise | ||
state.transitioning | visible | true | when datapoint state = transitioning |
false | otherwise | ||
state.stopped | visible | true | when datapoint state = stopped |
false | otherwise | ||
track.number | value | the current track number | |
track.title | value | the current track's title | |
track.creator | value | the current track's author | |
track.album | value | the name of the current track's album | |
mute.1 | visible | true | when datapoint mute = 1 |
false | when datapoint mute = 0 | ||
mute.0 | visible | true | when datapoint mute = 0 |
false | when datapoint mute = 1 | ||
volume | value | the current volume's value (0 ... 100) |
USER Commands
Release Notes
3.5.0
- initial release
Sonos is a registered trademarks of Sonos, Inc