Skip to main content

Python wrapper for the Adder API, for use with Adderlink KVM systems

Project description

adderlib

adderlib is an unofficial python implementation of the Adder API, for use with Adderlink KVM systems.

With adderlib, you can:

  • Log in or out as an existing KVM user
  • Query lists of transmitters, receivers, and channels available to the user
  • Access many properties of the KVM devices
  • Connect receivers to channels
  • Manage presets

...and so much more! Well, a little bit more.

Getting Started

The best way to get started is to check out the examples, and then the official documentation on ReadTheDocs. But in general, it's four easy steps:

from adderlib import adder

# Step 1: Create a handle to the API by passing the IP address or hostname of the AIM (the KVM server)
api = adder.AdderAPI("192.168.1.10")

# Step 2: Log in using an exising KVM account
api.login("username","password")

# Step 3: Do some stuff
for tx in api.getTransmitters():
  do_some_stuff(tx)
  
# Step 4: Don't forget to log out!
api.logout()

Customizable

Boy oh boy is this customizable! An UrlHandler abstract class is provided. Subclass this and override the api_call() method to communicate with the server however you wish! I sure spent a lot of time on the default RequestsHandler class, which uses the requests library but that's ok I'm sure you have your reasons.

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

adderlib-1.0.3.tar.gz (24.3 kB view details)

Uploaded Source

Built Distribution

adderlib-1.0.3-py3-none-any.whl (25.3 kB view details)

Uploaded Python 3

File details

Details for the file adderlib-1.0.3.tar.gz.

File metadata

  • Download URL: adderlib-1.0.3.tar.gz
  • Upload date:
  • Size: 24.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.13

File hashes

Hashes for adderlib-1.0.3.tar.gz
Algorithm Hash digest
SHA256 671489dd0900808ab060669fc5527f400eb5e935a321b29714e7373dc25e5637
MD5 1e72e9a15a153d5b5c3e3ac01b692a6a
BLAKE2b-256 fd45acc283d3a806a87986bdddadeec38b0f0220829916addb8a3776a2579b39

See more details on using hashes here.

File details

Details for the file adderlib-1.0.3-py3-none-any.whl.

File metadata

  • Download URL: adderlib-1.0.3-py3-none-any.whl
  • Upload date:
  • Size: 25.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.13

File hashes

Hashes for adderlib-1.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 3c12f78560c4523cfe9bd89b03ce297e7dda9836d7cd220263982355a3bc38bf
MD5 8a894095d0d041be2e8ef14062191378
BLAKE2b-256 20a1be1c69672711b80964f6588654d1c3d8e065c28d62034a1d4634bc61bccd

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