Sonos Command Line Controller Available (Python soco-cli)

Just to note that I’ve added a cue_favourite action in soco-cli v0.1.28.

This silently cues up one of your Sonos Favourites so that it plays next time you press ‘play’ on the speaker. It’s convenient shorthand for the sequence: mute speaker, play_favourite, stop playback, unmute speaker. I found myself repeating this action sequence in several scripts, so decided to encode it in a single action.

Example: If I like to listen to Radio 4 sometime after 7am in the Kitchen. I can cue up the station ready to respond to hitting the play button, with the following script:

sonos wait_until 0700 : Kitchen cue_fav “Radio 4”

Thanks for testing!

It should be possible to enclose the playlist name in double quotes, i.e., “Saturday Afternoon Mix”. On Linux and macOS either single or double quotes can be used, but Windows requires doubles.

Also, it’s possible to use fuzzy matching with partial playlist names (without spaces), provided they’re not ambiguous.

I’ll include a fix for this (along with some other goodies) in a release later today.

FYI, folks: SoCo-CLI version 0.3.40 introduces the ability to snooze playing alarms, e.g.:

sonos bedroom snooze_alarm 10       <-- Snoozes for 10 mins
sonos bedroom snooze alarm 30m      <-- Snoozes for 30 mins
sonos bedroom snooze_alarm 01:20:00 <-- Snoozes for 1hr 20 mins

Support for alarms management is now quite comprehensive: see the documentation at:

https://github.com/avantrec/soco-cli#alarms

SoCo-CLI v0.4.10 does a more comprehensive job of listing information when using the track, track_follow and track_follow_compact actions.

For example, radio streams will now show the Channel and Radio Show metadata (where present), Audio Books will show Author, Chapter, etc., and Podcasts will show the Podcast Series Title and Release Date.

Suggestions and feedback welcome, as always!

This is awesome and thanks for sharing! Is there a command to force download and install firmware updates to Sonos speakers?

Hi @pwt, thanks for sharing that with us and greatly appreciate all your efforts. If you need anything just let us know. Thanks!

@pwt Very nice piece of software!

When using the http-api-server, I am not able to add a sharelink (e.g. the one you provided in the docs: https://music.apple.com/dk/album/black-velvet/217502930?i=217503142)

http://api.example.com:8000/Dachgeschoss/sharelink/https%3A%2F%2Fmusic.apple.com%2Fdk%2Falbum%2Fblack-velvet%2F217502930%3Fi%3D217503142

Always returns { "detail": "Not Found" }

What am I doing wrong? Do I need to encode the link or somehow escape it?

Regards
Christian

Thanks. I’ve done substantial additional work on the utility, and it’s in quite good shape now, with several Improvements and new features. I’m finding it fun to use, and useful. There’s good documentation on the GitHub page.

if anyone has any questions or suggestions, please feel free to ask them here.

Great! Please do report any problems or suggest ideas for enhancements.

Here’s a handful of quick examples to whet the appetites of others.

1. Group the Bathroom with the Bedroom, play a favourite radio station until a specific time, then stop the stream and ungroup:

C:> sonos Bathroom group Bedroom : Bedroom play_fav “Radio 4” : wait_until 09:00 : Bedroom stop : Bathroom ungroup

2. Set the sleep timer for a specific time:

c:> sonos Bedroom sleep_at 23:45

3. Reset speaker volumes overnight:

C:> sonos wait_until 03:00 : Bedroom vol 25 : Bathroom vol 25

4. Set a speaker to play another’s Line-In, and play for an hour:

C:> sonos Bedroom line_in Lounge : Bedroom play : wait 01:00 : Bedroom stop

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.

http://api.example.com:8000/Dachgeschoss/sharelink/https%3A%2F%2Fmusic.apple.com%2Fdk%2Falbum%2Fblack-velvet%2F217502930%3Fi%3D217503142

Defect raised at: https://github.com/avantrec/soco-cli/issues/38

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!