Skip to main content

SoCo (Sonos Controller) is a simple library to control Sonos speakers.

Project description

SoCo (Sonos Controller) is a Python project that allows you to programmatically control Sonos speakers. It was originally created at Music Hack Day Sydney by Rahim Sonawalla and is now developed by a team of people at its GitHub repository

For more background on the project, please see Rahim’s blog post.

Visit the SoCo documentation for a more detailed overview of all the functionailty.

Build Status Requirements Status Latest PyPI version

Installation

SoCo requires Python 2.7, or 3.3 or newer.

Use pip:

pip install soco

SoCo depends on the Requests HTTP library. If you use pip to install Soco, Requests will be installed automatically for you. If not, you can use:

pip install requests

Basic Usage

You can interact with a Sonos Zone Player through a SoCo object. If you know the IP address of a Zone Player, you can create a SoCo object directly:

>>> from soco import SoCo
>>> my_zone = SoCo('192.168.1.101')
>>> my_zone.player_name
Kitchen
>>> my_zone.status_light = True
>>> my_zone.volume = 6

But perhaps the easiest way is to use the module-level discover function. This will find all the Zone Players on your network, and return a python set containing them:

>>> import soco
>>> for zone in soco.discover():
...        print zone.player_name
Living Room
Kitchen

If you prefer a list to a set:

>>> zone_list = list(soco.discover())
>>> zone_list
[SoCo("192.168.1.101"), SoCo("192.168.1.102")]
>>> zone_list[0].mute = True

Of course, you can also play music!

#!/usr/bin/env python
from soco import SoCo

if __name__ == '__main__':
    sonos = SoCo('192.168.1.102') # Pass in the IP of your Sonos speaker
    # You could use the discover function instead, if you don't know the IP

    # Pass in a URI to a media file to have it streamed through the Sonos
    # speaker
    sonos.play_uri(
        'http://ia801402.us.archive.org/20/items/TenD2005-07-16.flac16/TenD2005-07-16t10Wonderboy.mp3')

    track = sonos.get_current_track_info()

    print track['title']

    sonos.pause()

    # Play a stopped or paused track
    sonos.play()

Support

If you need support for SoCo, feel free to post your question either on our Google Group or on the #soco IRC channel on freenode.

Example Applications

To show off what can be made with SoCo, a simple web application is included in the examples folder.

Screenshot of web app

Screenshot of web app

Features

SoCo supports the following controls amongst others:

  • Play

  • Pause

  • Stop

  • Next track

  • Previous track

  • Get current transport information(if speaker is playing,paused,stopped)

  • Get information about the currently playing track

    • Track title

    • Artist

    • Album

    • Album Art (if available)

    • Track length

    • Duration played (for example, 30 seconds into a 3 minute song)

    • Playlist position (for example, item 5 in the playlist)

    • Track URI

  • Mute (or unmute) the speaker

  • Get or set the speaker volume

  • Get or set the speaker’s bass EQ

  • Get or set the speaker’s treble EQ

  • Toggle the speaker’s loudness compensation

  • Toggle the speaker’s night mode

  • Toggle the speaker’s dialog mode

  • Turn on (or off) the white status light on the unit

  • Switch the speaker’s source to line-in or TV input (if the Zone Player supports it)

  • Get the speaker’s information

    • Zone Name

    • Zone Icon

    • UID (usually something like RINCON_XXXXXXXXXXXXXXXXX)

    • Serial Number

    • Software version

    • Hardware version

    • MAC Address

  • Set the speaker’s Zone Name

  • Find all the Sonos speakers in a network.

  • Put all Sonos speakers in a network into “party mode”.

  • “Unjoin” speakers from a group.

  • Manage the Sonos queue (get the items in it, add to it, clear it, play a specific song from it)

  • Get the saved favorite radio stations and shows (title and stream URI)

  • Search for and play item from your music library

  • Start a music library update and determine if one is in progress

SoCo also supports lower level access from Python to all Sonos services (eg Alarms)

Google Group

There is a Soco group over at Google Groups. Feel free to drop by for support, ideas or casual conversation related to SoCo.

License

SoCo is released under the MIT license.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

soco-0.13.tar.gz (659.5 kB view details)

Uploaded Source

Built Distribution

soco-0.13-py2.py3-none-any.whl (117.1 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file soco-0.13.tar.gz.

File metadata

  • Download URL: soco-0.13.tar.gz
  • Upload date:
  • Size: 659.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for soco-0.13.tar.gz
Algorithm Hash digest
SHA256 5ece1ffb0504b8fc8cb7216016e735ce7f05b9c8fef5ffe5b562426b16db34da
MD5 d60400a16a54c197331ca69faf9429a7
BLAKE2b-256 bf957ca9c73b17bebdd68b1994a663217cb6d63979f292559d04e3b5a5db5b2f

See more details on using hashes here.

File details

Details for the file soco-0.13-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for soco-0.13-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 d869894d204e4ce880359117bb52788e2e8db21cafe82fdd883d07eb2a3aaea7
MD5 35a035828d9f2a4de85bd537f2b49f28
BLAKE2b-256 c5b201baa25af5209fe0a6595ea6ffd735cf5d09f2d4de581b368fb44780f618

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page