mheath / tplink-omada-api

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

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.

About

License:MIT License


Languages

Language:Python 100.0%