Python wrapper for TP-Link Omada SDN Controller API (OC200/OC300/Software Controller)
Project description
What's this?
A basic Python client for calling the TP-Link Omada controller API.
Installation
pip install tplink-omada-client
Supported features
Only a subset of the controller's features are supported:
- Automatic Login/Re-login
- List Devices (APs, Gateways and Switches)
- Basic device information
- Port status and PoE configuraton for Switches (<-- What I actually needed)
Tested with OC200 firmware version 5.5.7. Other versions may not be fully compatible.
Future
The available API surface is quite large. More of this could be exposed in the future. There is an undocumented Websocket API which could potentially be used to get a stream of updates. However, I'm not sure how fully featured this subscription channel is on the controller. It seems to be rarely used, so probably doesn't include client connect/disconnect notifications.
Contributing
There is a VS Code development container, which sets up all of the requirements for running the package.
License
MIT Open Source license.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for tplink_omada_client-1.0.2.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 5b75893d84287cd7295b9032216de6b3a171436c96ce870bde7ad9182766fa09 |
|
| MD5 | d2825a9c7960fd6f1e84b4b0f780b9d5 |
|
| BLAKE2b-256 | 1f901f175534a736140dac096b7e8caa4a2aade3c5a9b0c71919991930f78949 |
Hashes for tplink_omada_client-1.0.2-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | f5f2823c7278ac238ab2ac293f7106758e51080facffb46973204467a533e880 |
|
| MD5 | c55b7abcd7fed428510f09c0464c9de0 |
|
| BLAKE2b-256 | 1e590fc362df20bf1377375cf8cb5c1c0971fffe68428a9f9e8b5916ad8f21f2 |
