Skip to main content

Provides a python interface to interact with Roon

Project description

pyRoon Build status PyPi version PyPi downloads

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

Full documentation will follow asap

See the examples folder for some 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.32.tar.gz (17.6 kB view details)

Uploaded Source

Built Distribution

roonapi-0.0.32-py3-none-any.whl (19.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for roonapi-0.0.32.tar.gz
Algorithm Hash digest
SHA256 d21908f6ae202d050e8c546b2c5ec957750f3b2d7e51cc1003247975f4b6f2f2
MD5 01cfef1d6ff68fbbe150ae84d3d0aa97
BLAKE2b-256 fb95eac924649ebc209b343b4c95c79c9211ac3a1dfefcaf0493e8f4c3e9cfa4

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for roonapi-0.0.32-py3-none-any.whl
Algorithm Hash digest
SHA256 d931cd519c47664966160c9a5ba4fdeaa3bdb9e3c0db51e53041f16b6d8a1dc4
MD5 0734ff453dcb98029707aea1063fcedb
BLAKE2b-256 2c336431f5a6dfb10db5089a73c210b359b254e572e0e995cc9ba5e951094d3e

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