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.25.tar.gz (17.9 kB view details)

Uploaded Source

Built Distribution

roonapi-0.0.25-py3-none-any.whl (19.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for roonapi-0.0.25.tar.gz
Algorithm Hash digest
SHA256 8ee95fd7550c57fe37ce191ba0fa8a33862b8b547b4e939c339d94957a067aa4
MD5 df8c4f8f61cf019a52efa54853afc95b
BLAKE2b-256 9afc5efe37b6ffc660d9812a8bd6cd44985f42123446a0e618a8952b55a127ea

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for roonapi-0.0.25-py3-none-any.whl
Algorithm Hash digest
SHA256 68136cd4890c4de2817c58940ddb70d3770afb113b98d9b7c2c7345239b14785
MD5 9039e11f93127376e2be22c0a17d6abb
BLAKE2b-256 a9b6d180043a8414193c3e1ab3ec647f69b89e889fb4773d3054400e7b1c0a4b

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