API to some budget TP-Link routers
Project description
tplink-wr-api
Python API to some budget TP-Link routers.
Supported devices
This library designed for budget models with firmware without API. Library interacts with router management interface like user (scrape HTML UI) so it may not work with others versions of firmware.
Tested with TL-WR840N v2 with firmware version 3.16.9.
Features
Currently only read operations are available:
- general status info
- WLAN clients
- DHCP leases
Usage
>>> from tplink_wr import RouterSession, fetchers
>>>
>>> rt = RouterSession("192.168.0.1", "admin", "admin")
>>>
>>> general = fetchers.status.GeneralStatus.fetch(rt)
>>> print(general.lan)
LANStatus(mac='12-34-56-78-90-AB', ip='192.168.0.1', mask='255.255.255.0')
>>> stats = fetchers.wlan.WLANStats.fetch(rt)
>>> leases = fetchers.dhcp.DHCPLeases.fetch(rt)
>>>
>>> import pprint
>>> pp = pprint.PrettyPrinter(indent=2)
>>> pp.pprint(general.dict())
{ 'device_type': <RouterType.WAN: 1>,
'firmware': '3.16.9 Build 150929 Rel.37860n ',
'hardware': 'WR840N v2 00000000',
'lan': { 'ip': '192.168.0.1',
'mac': '12-34-56-78-90-AB',
'mask': '255.255.255.0'},
'mode_3g': False,
'rx_bytes': 3330853277,
'rx_packets': 8909427,
'tx_bytes': 550131568,
'tx_packets': 2593047,
'uptime': 99788,
'wan': [ { 'dns': '1.2.3.0 , 1.2.3.1',
'gateway': '1.2.10.1',
'ip': '1.2.10.15',
'link_status': <WANLinkStatus.LINK_UP: 4>,
'mac': '12-34-56-78-90-AC',
'mask': '255.255.224.0',
'type': <WANType.DYNAMIC: 1>}],
'wireless': True,
'wlan': { 'channel_auto': 6,
'channel_manual': None,
'channel_width': <WLANChannelWidth.AUTO: 2>,
'enabled': True,
'ip': '192.168.0.1',
'mac': '12-34-56-78-90-AB',
'name': 'TP-LINK_90AB',
'type': <WLANType.BGN_MIXED: 6>,
'wds_status': <WDSStatus.DISABLE: 6>}}
>>> pp.pprint(stats.dict())
{ 'clients': [ {'mac': '81-69-01-93-77-49', 'rx': 341, 'tx': 217},
{'mac': 'C4-49-F0-84-00-52', 'rx': 179, 'tx': 90}],
'mac_filter_enabled': False,
'mac_filter_whitelist': False,
'ssid': ['TP-LINK_90AB']}
>>> pp.pprint(leases.dict())
{ 'leases': [ { 'expire': 6701,
'ip': '192.168.0.110',
'mac': '65-CD-44-29-F2-0A',
'name': 'DESKTOP-ABCDEFG'},
{ 'expire': 6973,
'ip': '192.168.0.100',
'mac': '81-69-01-93-77-49',
'name': 'OnePlus-9R'},
{ 'expire': 7186,
'ip': '192.168.0.102',
'mac': 'C4-49-F0-84-00-52',
'name': 'arch'}]}
Project details
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
tplink-wr-api-0.2.1.tar.gz
(9.4 kB
view hashes)
Built Distribution
Close
Hashes for tplink_wr_api-0.2.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7a45cc8a664f470410a79b1857b3fcabd0720c69ff7dcf586a84e663191caa2e |
|
MD5 | 7d50d823e303521967fe692e50445a8c |
|
BLAKE2b-256 | b31332311b2be70c28a94fac68ed77eceab50c58cdd215b8037359c7fa68fb79 |