Is there documentation for ST-Sonos?

[CStockard]

I'd love to be able to send commands to my Sonos Controller from ISY programs. I think this Node Server probably has that ability. The problem I am having is that I can't find and documentation of the command structure. I suspect form the limited instructions in the Node configuration that I can do this using a TTS phrase and a value.

I have no idea what values are allowed, their parameters, or syntax.

Can someone direct me to this information??

[bpwwer]

I don't have this node server installed and don't have any Sonos devices, so I may be completely off base here.  

Typically the commands a node server can send to a device are predefined. To use them in a program you go into the program interface and select 'Control' for the 'then' part of the program and select the specific node server as the device.  It should then have a drop down list of the commands you can send to the device.

Following the links to the node server documentation  https://github.com/simplextech/pg3_docs/tree/main/ST-Sonos

says it supports all the functionality of the API which lists the following:

The actions supported as of today:

• play
• pause
• playpause (toggles playing state)
• volume (parameter is absolute or relative volume. Prefix +/- indicates relative volume)
• groupVolume (parameter is absolute or relative volume. Prefix +/- indicates relative volume)
• mute / unmute
• groupMute / groupUnmute
• togglemute (toggles mute state)
• trackseek (parameter is queue index)
• timeseek (parameter is in seconds, 60 for 1:00, 120 for 2:00 etc)
• next
• previous
• state (will return a json-representation of the current state of player)
• favorite
• favorites (with optional "detailed" parameter)
• playlist
• lockvolumes / unlockvolumes (experimental, will enforce the volume that was selected when locking!)
• repeat (on(=all)/one/off(=none)/toggle)
• shuffle (on/off/toggle)
• crossfade (on/off/toggle)
• pauseall (with optional timeout in minutes)
• resumeall (will resume the ones that was pause on the pauseall call. Useful for doorbell, phone calls, etc. Optional timeout)
• say
• sayall
• saypreset
• queue
• clearqueue
• sleep (values in seconds)
• linein (only analog linein, not PLAYBAR yet)
• clip (announce custom mp3 clip)
• clipall
• clippreset
• join / leave (Grouping actions)
• sub (on/off/gain/crossover/polarity) See SUB section for more info
• nightmode (on/off/toggle, PLAYBAR only)
• speechenhancement (on/off/toggle, PLAYBAR only)
• bass/treble (use -10 thru 10 as value. 0 is neutral)

Is there something beyond that you need help with?

[CStockard]

Thanks. Not exactly what I was seeking, but tracking through some of the links you provided got me enough hints to get the node working. For some reason I hadn't been able to find those links even though I was on the same GitHub section. 

 

Again thanks.