Sonos Command Line Controller Available (Python soco-cli)

Incidentally, there’s now a simple Python SoCo-CLI API that avoids the overhead of starting the program for each command (or command sequence). For example:

$ sonos Kitchen volume 30

becomes:

exit_code, output, error = api.run_command("Kitchen", "volume", "30")

The API call returns a three-tuple of exit code, output string, and error string. Assuming success (exit code 0), the output string contains exactly what would have been printed by the standalone command.

The command handles all the speaker discovery machinations behind the scenes, and caches discovery results. It also traps all exceptions, with the exception description appearing in the error string.

Docs at: https://github.com/avantrec/soco-cli#using-soco-cli-as-a-python-library

Hi there! I have never used python and am a complete and absolute beginner. 

Is there a step by step instruction manual for a total idiot anywhere? 

This is a pretty comprehensive guide to installing Python on various platforms:

https://realpython.com/installing-python/

Once you’ve done this, you can install SoCo-CLI and its dependencies using pip install -U soco-cli from a command window (terminal), then run it using all of the various sonos commands.

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

No, there isn’t, sorry. I think updates are done outside the UPnP control mechanisms that are used by SoCo.

How do you group more then 2 speakers? 

sonos -l "family room" group "media room"

combines 2 but I need 2 more rooms grouped.

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.)

SoCo-CLI v0.3.31 introduces additional control over Sonos alarms.

In addition to being able to list alarms, it’s now possible to create alarms, delete alarms, and enable or disable alarms, using their alarm IDs. The new actions are: ‘create_alarm’, ‘remove_alarm’, and ‘enable_alarm’.

As always, feedback is welcome.

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.

Version 0.3.34 adds the ability to copy and modify alarms, making it very quick and convenient to copy an alarm from one speaker to another, and then modify it if required. (I’ll also add a move_alarm function -- which I just thought of! -- in the next release.)

Example: sonos Kitchen copy_alarm 123 will copy the alarm with ID ‘123’ to the Kitchen speaker. (Alarm IDs are discovered using ‘list_alarms’.)