Skip to main content

Provides a python interface to interact with Roon

Project description

python-roon

python library to interface with the Roon API (www.roonlabs.com)

Full documentation will follow asap See the tests folder for some more code examples.

Some example code:

from roonapi import RoonApi
appinfo = {
        "extension_id": "python_roon_test",
        "display_name": "Python library for Roon",
        "display_version": "1.0.0",
        "publisher": "marcelveldt",
        "email": "mygreat@emailaddress.com"
    }

# host can be None if you want to use discovery - but this sometimes returns the local machine, not the real roon server
host = "192.168.1.x"

# Can be None if you don't yet have a token
token = open('mytokenfile').read()

roonapi = RoonApi(appinfo, token)

# get all zones (as dict)
print(roonapi.zones)

# get all outputs (as dict)
print(roonapi.outputs)

# receive state updates in your callback
roonapi.register_state_callback(my_state_callback)


# save the token for next time
with open('mytokenfile', 'w') as f:
    f.write(roonapi.token)

Project details


Download files

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

Source Distribution

roonapi-0.0.29.tar.gz (18.2 kB view details)

Uploaded Source

Built Distribution

roonapi-0.0.29-py3-none-any.whl (19.4 kB view details)

Uploaded Python 3

File details

Details for the file roonapi-0.0.29.tar.gz.

File metadata

  • Download URL: roonapi-0.0.29.tar.gz
  • Upload date:
  • Size: 18.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.4 CPython/3.7.9 Linux/5.4.0-1032-azure

File hashes

Hashes for roonapi-0.0.29.tar.gz
Algorithm Hash digest
SHA256 e234b42ca26a755870bcb553ac2048804c3ff224239fa96bd7dbc0cee42d7de7
MD5 ac958cb2a9212e39036825ff46fc7bbd
BLAKE2b-256 d5c5cc3de17a8976878db8fe1265aa203681cd28ae696c51c772c542e32ea9bc

See more details on using hashes here.

File details

Details for the file roonapi-0.0.29-py3-none-any.whl.

File metadata

  • Download URL: roonapi-0.0.29-py3-none-any.whl
  • Upload date:
  • Size: 19.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.4 CPython/3.7.9 Linux/5.4.0-1032-azure

File hashes

Hashes for roonapi-0.0.29-py3-none-any.whl
Algorithm Hash digest
SHA256 3c2861c59f7b1876d8567c695191305a2f4927d8a456a3fd775e2fd81ea2a23c
MD5 be3c0f95d80182234192f52a3880a4c9
BLAKE2b-256 d0bf1f0fe74ac89f37cd033cb61015d1acf10fe5ff59e7c6eb959f2a571985a4

See more details on using hashes here.

Supported by

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