API wrapper for communication with ASUSWRT-powered routers using HTTP protocol
Project description
AsusRouter
AsusRouter is an API wrapper for communication with ASUSWRT-powered routers using HTTP(S) protocols. The library supports both the stock AsusWRT firmware and AsusWRT-Merlin.
Up till now, it is mostly used for the custom AsusRouter Home Assistant integration and from recently by the core Home Assistant AsusWRT integration. But I am always open to making it suitable for any other use.
Installation
Installation of the latest release is available from PyPI:
pip install asusrouter
Usage
Once installed, you can import the AsusRouter class from the module. Example shows the default parameters except for host, username and password.
import aiohttp
import asyncio
from asusrouter import AsusRouter, AsusData
# Create a new event loop
loop = asyncio.new_event_loop()
# Create aiohttp session
session = aiohttp.ClientSession(loop=loop)
router = AsusRouter( #required - both IP and URL supported
hostname="router.my.address", #required
username="admin", #required
password="password", #required
use_ssl=True, #optional
session=session, #optional
)
# Connect to the router
loop.run_until_complete(router.async_connect())
# Now you can use the router object to call methods
data = loop.run_until_complete(router.async_get_data(AsusData.NETWORK))
print(data)
# Remember to disconnect and close the session when you're done
loop.run_until_complete(router.async_disconnect())
loop.run_until_complete(session.close())
Supported devices
AsusRouter supports virtually every AsusWRT-powered device.
[!TIP]
Version388.10of AsusWRT-Merlin firmware is officially NOT supported due to the issues with HTTP daemon crashes. Use versions>=388.10_2or<=388.9_2.
WiFi 7 | 802.11be
| Model | Status | Tested firmware | Find it on Amazon[^amazon] |
|---|---|---|---|
| GT-BE19000 | ๐ Expected to work | find it | |
| GT-BE98 | ๐ Confirmed | Stock:102_34372 |
find it |
| GT-BE98 Pro | ๐ Expected to work | find it | |
| RT-BE58U | ๐ Expected to work | find it | |
| RT-BE88U | ๐ Expected to work | find it | |
| RT-BE92U | ๐ Expected to work | find it | |
| RT-BE96U | ๐ Expected to work | find it | |
| TUF-BE3600 | ๐ Expected to work | find it | |
| TUF-BE6500 | ๐ Expected to work | find it | |
| ZenWiFi BD4 | ๐ Expected to work | find it | |
| ZenWiFi BQ16 | ๐ Expected to work | find it | |
| ZenWiFi BQ16 Pro | ๐ Expected to work | find it | |
| ZenWiFi BT10 | ๐ Expected to work | find it |
WiFi 6e | 802.11axe
| Model | Status | Tested firmware | Find it on Amazon[^amazon] |
|---|---|---|---|
| GT-AXE11000 | ๐ Expected to work | find it | |
| GT-AXE16000 | ๐ Confirmed | Stock:388.21617388.7_beta1_rog388.7_0_rog |
find it |
| RT-AXE7800 | ๐ Confirmed | Stock:388_22068 |
find it |
| ZenWiFi ET8 | ๐ Confirmed | Stock:388.23759 |
find it |
| ZenWiFi ET9 | ๐ Expected to work | find it | |
| ZenWiFi Pro ET12 | ๐ Confirmed | Stock:388.23013 |
find it |
WiFi 6 | 802.11ax
| Model | Status | Tested firmware | Find it on Amazon[^amazon] |
|---|---|---|---|
| DSL-AX82U | ๐ Confirmed | Merlin:386.07_0-gnuton0_beta2 |
find it |
| GT-AX11000 | ๐ Confirmed | Merlin:386.7_2388.1_0388.4_0388.7_0_rog |
find it |
| GT-AX11000 Pro | ๐ Confirmed | Stock:388.24198388.7_0_rog |
find it |
| GT-AX6000 | ๐ Expected to work | Merlin:388.7_beta1 |
find it |
| GT6 | ๐ Expected to work | find it | |
| RP-AX56 | ๐ Confirmed | find it | |
| RT-AX3000P | ๐ Expected to work | find it | |
| RT-AX52 | ๐ Expected to work | find it | |
| RT-AX53U | ๐ Confirmed | Stock:386.69061 |
find it |
| RT-AX5400 | ๐ Expected to work | find it | |
| RT-AX55 | ๐ Confirmed | Stock:386.50410386.52041 |
find it |
| RT-AX56U | ๐ Confirmed | Merlin:386.7_2388.1_0388.2_2 |
find it |
| RT-AX57 | ๐ Expected to work | find it | |
| RT-AX57 Go | ๐ Expected to work | find it | |
| RT-AX57M | ๐ Expected to work | find it | |
| RT-AX58U | ๐ Confirmed | Stock:386.49674388.22237386.7_2388.1_0388.4_0388.7.0 |
find it |
| RT-AX59U | ๐ Expected to work | find it | |
| RT-AX68U | ๐ Confirmed | Stock:388.21732 |
find it |
| RT-AX82U | ๐ Confirmed | Stock:386.48664386.49674388.8_4-gnuton1 |
find it |
| RT-AX86S | ๐ Confirmed | Stock:386.46061386.48260386.49447388.22525386.7_2 |
find it |
| RT-AX86U | ๐ Confirmed | Stock:386.46061386.48260386.49447388.22525386.7_2388.4_0388.7_beta1 |
find it |
| RT-AX86U Pro | ๐ Confirmed | Stock:388.23565 |
find it |
| RT-AX88U | ๐ Confirmed | Stock:386.45934386.48631388.24198386.5_2386.8_0388.1_0388.2_0388.4_0388.7_0 |
find it |
| RT-AX88U Pro | ๐ Confirmed | Merlin:388.4_0 |
find it |
| RT-AX89X | ๐ Confirmed | find it | |
| RT-AX92U | ๐ Confirmed | Stock:386.46061 |
find it |
| TUF-AX3000 V2 | ๐ Confirmed | Stock:388.23785 |
find it |
| TUF-AX4200 | ๐ Expected to work | find it | |
| TUF-AX5400 | ๐ Confirmed | Stock:386.50224388.21224388.22525388.23285388.24121388.4_0 |
find it |
| TUF-AX6000 | ๐ Confirmed | Stock:388.32432 |
find it |
| ZenWiFi AX (XT8) | ๐ Confirmed | Stock:386.48706388.23285386.7_2-gnuton1 |
find it |
| ZenWiFi AX Hybrid (XP4) | ๐ Expected to work | find it | |
| ZenWiFi AX Mini (XD4) | ๐ Confirmed | Stock:386.48790386.49599 |
find it |
| ZenWiFi Pro XT12 | ๐ Confirmed | Stock:388.22127 |
find it |
| ZenWiFi XD4 Plus | ๐ Expected to work | find it | |
| ZenWiFi XD4S | ๐ Expected to work | find it | |
| ZenWiFi XD5 | ๐ Confirmed | Stock:388.23949 |
find it |
| ZenWiFi XD6 | ๐ Confirmed | Stock:388.21380 |
find it |
| ZenWiFi XD6S | ๐ Confirmed | Stock:388.21380 |
find it |
| ZenWiFi XT9 | ๐ Confirmed | Stock:388_23285 |
find it |
WiFi 5 | 802.11ac
| Model | Status | Tested firmware | Find it on Amazon[^amazon] |
|---|---|---|---|
| 4G-AC55U | ๐ Confirmed | Stock:380.8102 |
find it |
| BRT-AC828 | ๐ Confirmed | Stock:382_70348 |
find it |
| DSL-AC68U | ๐ Confirmed | Stock:386.47534386.50117386.4-gnuton2386.7_2-gnuton1 |
find it |
| RT-AC51U | ๐ Confirmed | Stock:380.8591 |
find it |
| RT-AC52U B1 | ๐ Confirmed | find it | |
| RT-AC5300 | ๐ Confirmed | Merlin:386.7_2 |
find it |
| RT-AC57U V3 | ๐ Confirmed | Stock:386.21649 |
find it |
| RT-AC58U | ๐ Confirmed | find it | |
| RT-AC66U | ๐ Confirmed | Merlin:380.70_0 |
find it |
| RT-AC66U B1 | ๐ Confirmed | Stock:386.51255 |
find it |
| RT-AC68U | ๐ Confirmed | Stock:386.49703386.5_2386.7_0 |
find it |
| RT-AC85P | ๐ Confirmed | Stock:382.52516 |
find it |
| RT-AC86U | ๐ Confirmed | Stock:386.48260386.49709386.7_0386.7_2386.9_0 |
find it |
| RT-AC87U | ๐ Confirmed | Merlin:384.13_10 |
find it |
| RT-AC88U | ๐ Confirmed | Stock:386.48260386.5_0386.7_beta1386.12_2 |
find it |
| RT-ACRH17 | ๐ Confirmed | Stock:382.52517 |
find it |
| ZenWiFi AC Mini(CD6) | ๐ Expected to work | find it |
WiFi 4 | 802.11n
| Model | Status | Tested firmware | Find it on Amazon[^amazon] |
|---|---|---|---|
| RT-N66U | ๐ Confirmed | find it |
Support the library
Issues and Pull requests
If you have found an issue working with the library or just want to ask for a new feature, please fill in a new issue.
You are also welcome to submit pull requests to the repository!
Check it with your device
Testing the library with different devices would help a lot in the development process. Unfortunately, currently, I have only one device available, so your help would be much appreciated.
Other support
This library is a free-time project. If you like it, you can support me by buying a coffee.
[^amazon]: As an Amazon Associate I earn from qualifying purchases. Not like I ever got anything yet (:
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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file asusrouter-1.21.3.tar.gz.
File metadata
- Download URL: asusrouter-1.21.3.tar.gz
- Upload date:
- Size: 130.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
584063b48f2e2da2b0bb1f6bcf61abf4d77aa3450a8895ad64223babe6b21140
|
|
| MD5 |
f90754d28842a879054104d70f6790e2
|
|
| BLAKE2b-256 |
4bf6008706e00edb15697f3ac810f991d8791eeea21bd51deab4b41dc735326f
|
Provenance
The following attestation bundles were made for asusrouter-1.21.3.tar.gz:
Publisher:
release.yml on Vaskivskyi/asusrouter
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
asusrouter-1.21.3.tar.gz -
Subject digest:
584063b48f2e2da2b0bb1f6bcf61abf4d77aa3450a8895ad64223babe6b21140 - Sigstore transparency entry: 754860825
- Sigstore integration time:
-
Permalink:
Vaskivskyi/asusrouter@8de97bfa8ffe3efa2f6d1ec30bb95187d13ab37a -
Branch / Tag:
refs/tags/1.21.3 - Owner: https://github.com/Vaskivskyi
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@8de97bfa8ffe3efa2f6d1ec30bb95187d13ab37a -
Trigger Event:
release
-
Statement type:
File details
Details for the file asusrouter-1.21.3-py3-none-any.whl.
File metadata
- Download URL: asusrouter-1.21.3-py3-none-any.whl
- Upload date:
- Size: 132.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d08f302e64e9585a2c14ba1f7df06b730d8bd99a59663a0f36a16f5743f9d5f0
|
|
| MD5 |
36e92980d3aac9d7d343a92bfb782c46
|
|
| BLAKE2b-256 |
695064f14c7baa4b72bc8a01889a12d44f32a759f730ed460b48b6375dae5efa
|
Provenance
The following attestation bundles were made for asusrouter-1.21.3-py3-none-any.whl:
Publisher:
release.yml on Vaskivskyi/asusrouter
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
asusrouter-1.21.3-py3-none-any.whl -
Subject digest:
d08f302e64e9585a2c14ba1f7df06b730d8bd99a59663a0f36a16f5743f9d5f0 - Sigstore transparency entry: 754860873
- Sigstore integration time:
-
Permalink:
Vaskivskyi/asusrouter@8de97bfa8ffe3efa2f6d1ec30bb95187d13ab37a -
Branch / Tag:
refs/tags/1.21.3 - Owner: https://github.com/Vaskivskyi
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@8de97bfa8ffe3efa2f6d1ec30bb95187d13ab37a -
Trigger Event:
release
-
Statement type: