Skip to main content

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

Project description

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

from asusrouter import AsusRouter

router = AsusRouter(host = "router.my.address",         #required - both IP and URL supported
                    username = "admin",                 #required
                    password = "password",              #required
                    port = None,                        #optional - default port would be selected based on use_ssl parameter
                    use_ssl = False,                    #optional
                    cache_time = 5)                     #optional

Supported devices

AsusRouter supports virtually every AsusWRT-powered device.

WiFi 7 | 802.11be

Model Status Tested firmware Find it on Amazon[^amazon]
GT-BE98 ๐Ÿ’› Expected to work find it
RT-BE96U ๐Ÿ’› 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.21617
  • find it
    RT-AXE7800 ๐Ÿ’š Confirmed Stock:
  • 388_22068
  • find it
    ZenWiFi ET8 ๐Ÿ’› Expected to work find it
    ZenWiFi Pro ET12 ๐Ÿ’› Expected to work 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_2
  • 388.1_0
  • find it
    GT-AX11000 Pro ๐Ÿ’› Expected to work find it
    GT-AX6000 ๐Ÿ’› Expected to work find it
    GT6 ๐Ÿ’› Expected to work find it
    RT-AX55 ๐Ÿ’š Confirmed Stock:
  • 386.50410
  • find it
    RT-AX56U ๐Ÿ’š Confirmed Merlin:
  • 386.7_2
  • find it
    RT-AX57 ๐Ÿ’› Expected to work find it
    RT-AX58U ๐Ÿ’š Confirmed Stock:
  • 386.49674
  • 388.22237
  • Merlin:
  • 386.7_2
  • 388.1_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
  • 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
  • find it
    RT-AX88U Pro ๐Ÿ’› Expected to work 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
  • 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 ๐Ÿ’› Expected to work 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 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
  • 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.

    Buy Me 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

    asusrouter-1.1.0b2.tar.gz (63.0 kB view details)

    Uploaded Source

    Built Distribution

    If you're not sure about the file name format, learn more about wheel file names.

    asusrouter-1.1.0b2-py3-none-any.whl (81.9 kB view details)

    Uploaded Python 3

    File details

    Details for the file asusrouter-1.1.0b2.tar.gz.

    File metadata

    • Download URL: asusrouter-1.1.0b2.tar.gz
    • Upload date:
    • Size: 63.0 kB
    • Tags: Source
    • Uploaded using Trusted Publishing? No
    • Uploaded via: twine/4.0.2 CPython/3.11.6

    File hashes

    Hashes for asusrouter-1.1.0b2.tar.gz
    Algorithm Hash digest
    SHA256 830f4b887e94ecde82d5bfe5c85655ccd3cc74f974fe42ac94b4596effe7d7fa
    MD5 a4e97fc61044ed6e223d7a7e3b25c6ed
    BLAKE2b-256 8d4db16e78750bd0bd733bb115dd777d58d61add5395d8400edc932a1708d8b3

    See more details on using hashes here.

    File details

    Details for the file asusrouter-1.1.0b2-py3-none-any.whl.

    File metadata

    • Download URL: asusrouter-1.1.0b2-py3-none-any.whl
    • Upload date:
    • Size: 81.9 kB
    • Tags: Python 3
    • Uploaded using Trusted Publishing? No
    • Uploaded via: twine/4.0.2 CPython/3.11.6

    File hashes

    Hashes for asusrouter-1.1.0b2-py3-none-any.whl
    Algorithm Hash digest
    SHA256 99b9cd307b218e4983b87103ab008726048ac052ecd75e441acd43f54f696bdd
    MD5 cc7995d89519ce6a870b362421608f89
    BLAKE2b-256 20587836aeb4a96acd2f630e86f2a04e198479ca71aafbad14cc916c3fd5d359

    See more details on using hashes here.

    Supported by

    AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page