Sonos Command Line Controller Available (Python soco-cli)

The following will group sp2, sp3 and sp4 with sp1 as the group coordinator:

sonos -l sp2 group sp1 : sp3 group sp1 : sp4 group sp1

(The ‘ : ’ allows multiple sonos actions to be invoked as part of the same command, but it’s equivalent to issuing multiple separate sonos commands.)

Just wanted to say thanks for this!  I played around with it this morning expecting a moderately useful utility.  WOW was I surprised about how much work you have put into this - very comprehensive functionality.

Anyone with Sonos speakers who spends time at the CLI should grab this.

Amazing utility! I’ve incorporated it into the Apple Home app via Homebridge with buttons to play a certain radio station and another for power nap - pause music, set a once only alarm, resume. A cron’ed job groups certain rooms. Command line rules!

The most concise way to find a speaker’s current state is to use the state action, i.e.:

sonos -l office state

This will return a short description of the player state, and if directed at a slave speaker in a group it will be redirected to report the state of the group coordinator. The track action also reports playback state, along with details of what’s playing.

The info action isn’t redirected to the group coordinator, so it just dumps the data for the target speaker. When a speaker is a slave in a group, Sonos doesn’t bother to keep the playback state correct.

I’ve now moved the details of the state action to a more sensible section of the documentation:

https://github.com/avantrec/soco-cli/blob/v0.3.37/README.md#speaker-and-sonos-system-information

• state (or status, playback): Returns the current playback state for the speaker, one of: PAUSED_PLAYBACK, PLAYING, STOPPED, or TRANSITIONING.

This change is now released in SoCo-CLI v0.3.37.

You may want to take this discussion over to GitHub (https://github.com/avantrec/soco-cli/issues), where it’s generally easier to work on issues.

Either way, (A) could you provide the output of the following:

1. sonos -v
2. sonos -l office play_favourite number 28 --log=info

(B) Could you try ‘play_favourite’ using the favourite name instead of its number, and report whether this works.

(C) What type of favourite are you trying to play?

(D) Is it only #28 that fails, or is it a problem across all favourite numbers.

(It may be worth noting that not all Sonos Favourites are playable using SoCo-CLI; e.g., single tracks from Spotify will work, but not albums. That’s not the problem you’re seeing, however.)

Thanks!

SoCo-CLI version 0.3.43 introduces support for imported local library playlists.

There are new actions to list library playlists, list the tracks in a library playlist, and to add a library playlist to the queue:

• list_library_playlists or llp
• list_library_playlist_tracks <playlist_name> or llpt
• add_library_playlist_to_queue <playlist_name> or alpq

The actions operate in the same way as the existing ones for Sonos playlists.

SoCo-CLI version 0.4.0 introduces an HTTP REST API server mode.

This means that SoCo-CLI can be run as an HTTP server, responding to HTTP GET requests by performing actions on your Sonos system. This is useful for some automation scenarios; the functionality is similar to that offered by the node-sonos-http-api application.

More details at: https://github.com/avantrec/soco-cli/blob/v0.4.0/README.md#the-soco-cli-http-api

SoCo-CLI v0.4.4 introduces the ability to play share links from Spotify and Tidal. This feature is considered experimental for the time being, and feedback on your experience is welcome.

Example:

sonos Kitchen sharelink "https://open.spotify.com/track/6cpcorzV5cmVjBsuAXq4wD"
sonos Kitchen play_from_queue

Documentation: https://github.com/avantrec/soco-cli#spotify-and-tidal-share-links

SoCo-CLI v0.4.18 adds the ability to play share links from Deezer. Share links can refer to tracks, albums or playlists, which are added to the Sonos queue. This feature is considered experimental and feedback is welcome.

Example:

> sonos Kitchen sharelink “https://www.deezer.com/en/playlist/5390258182”
> sonos Kitchen play_from_queue

Documentation: https://github.com/avantrec/soco-cli#spotify-tidal-and-deezer-share-links 

First let me say great work @pwt on putting this all together.  It’s been very helpful.  

So I have 99% of this figured out, but am stuck on the last step of running a script from on the webserver I hope someone can help with a recommendation / advice.

Background:  I have configured a doorbell to chime the sonos speakers that is called via the API webserver.  I do all this using Container on my QNAP NAS and running the sonos-http-api-server.  That way I have a dedicated machine always waiting for a command.

A sample call would look something like this:

http://192.168.xx.xx:8000/Pool/play_file/Law-and-order-sound.mp3

So this is the same as sonos Pool play_file Law-and-order-sound.mp3 in Python.   

Pretty cool, it plays the Law and Order sound on my Sonos Speaker called Pool.  The problem i have is that I need to play the sound on all the speakers in the house.

So example would be:

sonos Pool group Garage : sp2 group Garage : Garage play_File Law-and-order-sound.mp3 : Garage ungroup

I just need to know how to call something like that from the Web Server.  Should I do a bash command to run a script?  Should I execute a python script to get it to work?   

Any advice or help would be appreciated.

I’ve now added a ‘macros’ feature that allows one to define custom actions and sequences of actions to be executed by the HTTP API server. For example, for this use case one might define a ‘doorbell’ macro:

http://192.168.xx.xx:8000/macro/doorbell

This would invoke the necessary sequence of actions, defined in a local macros file at the server end.

I’ve implemented the feature and I’ll release it later today once it’s documented.