Skip to content

API wrapper for communication with ASUSWRT-powered routers using HTTP protocol

License

Notifications You must be signed in to change notification settings

Vaskivskyi/asusrouter

Repository files navigation

GitHub Release License
Downloads Commit activityBuy Me A Coffee

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. 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.

WiFi 7 | 802.11be

Model Status Tested firmware Find it on Amazon1
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 Amazon1
    GT-AXE11000 πŸ’› Expected to work find it
    GT-AXE16000 πŸ’š Confirmed Stock:
  • 388.21617
  • Merlin:
  • 388.7_beta1_rog
  • 388.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 Amazon1
    DSL-AX82U πŸ’š Confirmed Merlin:
  • 386.07_0-gnuton0_beta2
  • find it
    GT-AX11000 πŸ’š Confirmed Merlin:
  • 386.7_2
  • 388.1_0
  • 388.4_0
  • 388.7_0_rog
  • find it
    GT-AX11000 Pro πŸ’š Confirmed Stock:
  • 388.24198
  • Merlin:
  • 388.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.50410
  • 386.52041
  • find it
    RT-AX56U πŸ’š Confirmed Merlin:
  • 386.7_2
  • 388.1_0
  • 388.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.49674
  • 388.22237
  • Merlin:
  • 386.7_2
  • 388.1_0
  • 388.4_0
  • 388.7.0
  • find it
    RT-AX59U πŸ’› Expected to work find it
    RT-AX68U πŸ’š Confirmed Stock:
  • 388.21732
  • find it
    RT-AX82U πŸ’š Confirmed Stock:
  • 386.48664
  • 386.49674
  • find it
    RT-AX86S πŸ’š Confirmed Stock:
  • 386.46061
  • 386.48260
  • 386.49447
  • 388.22525
  • Merlin:
  • 386.7_2
  • find it
    RT-AX86U πŸ’š Confirmed Stock:
  • 386.46061
  • 386.48260
  • 386.49447
  • 388.22525
  • Merlin:
  • 386.7_2
  • 388.4_0
  • 388.7_beta1
  • find it
    RT-AX86U Pro πŸ’š Confirmed Stock:
  • 388.23565
  • find it
    RT-AX88U πŸ’š Confirmed Stock:
  • 386.45934
  • 386.48631
  • 388.24198
  • Merlin:
  • 386.5_2
  • 386.8_0
  • 388.1_0
  • 388.2_0
  • 388.4_0
  • 388.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.50224
  • 388.21224
  • 388.22525
  • 388.23285
  • 388.24121
  • Merlin:
  • 388.4_0
  • find it
    TUF-AX6000 πŸ’š Confirmed Stock:
  • 388.32432
  • find it
    ZenWiFi AX (XT8) πŸ’š Confirmed Stock:
  • 386.48706
  • 388.23285
  • Merlin:
  • 386.7_2-gnuton1
  • find it
    ZenWiFi AX Hybrid (XP4) πŸ’› Expected to work find it
    ZenWiFi AX Mini (XD4) πŸ’š Confirmed Stock:
  • 386.48790
  • 386.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 Amazon1
    4G-AC55U πŸ’š Confirmed Stock:
  • 380.8102
  • find it
    BRT-AC828 πŸ’š Confirmed Stock:
  • 382_70348
  • find it
    DSL-AC68U πŸ’š Confirmed Stock:
  • 386.47534
  • 386.50117
  • Merlin:
  • 386.4-gnuton2
  • 386.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.49703
  • Merlin:
  • 386.5_2
  • 386.7_0
  • find it
    RT-AC85P πŸ’š Confirmed Stock:
  • 382.52516
  • find it
    RT-AC86U πŸ’š Confirmed Stock:
  • 386.48260
  • 386.49709
  • Merlin:
  • 386.7_0
  • 386.7_2
  • 386.9_0
  • find it
    RT-AC87U πŸ’š Confirmed Merlin:
  • 384.13_10
  • find it
    RT-AC88U πŸ’š Confirmed Stock:
  • 386.48260
  • Merlin:
  • 386.5_0
  • 386.7_beta1
  • 386.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 Amazon1
    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.

    Buy Me A Coffee

    Footnotes

    1. As an Amazon Associate I earn from qualifying purchases. Not like I ever got anything yet (: ↩ ↩2 ↩3 ↩4 ↩5