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 integrartion. 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 :yellow_heart: Expected to work find it
RT-BE96U :yellow_heart: Expected to work find it

WiFi 6e | 802.11axe

Model Status Tested firmware Find it on Amazon[^amazon]
GT-AXE11000 :yellow_heart: Expected to work find it
GT-AXE16000 :green_heart: Confirmed Stock:
  • 3.0.0.4.388_21617-g1288c22
  • find it
    RT-AXE7800 :yellow_heart: Expected to work find it
    ZenWiFi Pro ET12 :yellow_heart: Expected to work find it

    WiFi 6 | 802.11ax

    Model Status Tested firmware Find it on Amazon[^amazon]
    DSL-AX82U :green_heart: Confirmed Merlin:
  • 386.07_0-gnuton0_beta2
  • find it
    GT-AX11000 :green_heart: Confirmed Merlin:
  • 386.7_2
  • find it
    GT-AX11000 Pro :yellow_heart: Expected to work find it
    GT-AX6000 :yellow_heart: Expected to work find it
    GT6 :yellow_heart: Expected to work find it
    RT-AX55 :green_heart: Confirmed Stock:
  • 3.0.0.4.386_50410
  • find it
    RT-AX56U :green_heart: Confirmed Merlin:
  • 386.7_2
  • find it
    RT-AX57 :yellow_heart: Expected to work find it
    RT-AX58U :green_heart: Confirmed Stock:
  • 386_49674
  • Merlin:
  • 386.7_2
  • 388.1_0
  • find it
    RT-AX59U :yellow_heart: Expected to work find it
    RT-AX68U :green_heart: Confirmed find it
    RT-AX82U :green_heart: Confirmed Stock:
  • 386_48664
  • 386.49674
  • find it
    RT-AX86S :green_heart: Confirmed Stock:
  • 386_49447
  • find it
    RT-AX86U :green_heart: Confirmed Stock:
  • 386_46061
  • 386_48260
  • Merlin:
  • 386.7_2
  • find it
    RT-AX86U Pro :yellow_heart: Expected to work find it
    RT-AX88U :green_heart: Confirmed Stock:
  • 386_45934
  • 386_48631
  • Merlin:
  • 386.5_2
  • 386.8_0
  • 388.1_0
  • find it
    RT-AX88U Pro :yellow_heart: Expected to work find it
    RT-AX89X :green_heart: Confirmed find it
    RT-AX92U :green_heart: Confirmed Stock:
  • 386_46061
  • find it
    TUF-AX4200 :yellow_heart: Expected to work find it
    TUF-AX5400 :green_heart: Confirmed Stock:
  • 3.0.0.4.388_21224-g702a50f
  • find it
    TUF-AX6000 :yellow_heart: Expected to work find it
    ZenWiFi AX (XT8) :green_heart: Confirmed Stock:
  • 386_48706
  • Merlin:
  • 386.7_2-gnuton1
  • find it
    ZenWiFi AX Mini (XD4) :green_heart: Confirmed Stock:
  • 386_48790
  • 386_49599
  • find it
    ZenWiFi Pro XT12 :green_heart: Confirmed find it

    WiFi 5 | 802.11ac

    Model Status Tested firmware Find it on Amazon[^amazon]
    4G-AC55U :green_heart: Confirmed find it
    DSL-AC68U :green_heart: Confirmed Stock:
  • 386_47534
  • Merlin:
  • 386.4-gnuton2
  • 386.7_2-gnuton1
  • find it
    RT-AC51U :green_heart: Confirmed Stock:
  • 380_8591
  • find it
    RT-AC52U B1 :green_heart: Confirmed find it
    RT-AC5300 :green_heart: Confirmed Merlin:
  • 386.7_2
  • find it
    RT-AC57U V3 :green_heart: Confirmed Stock:
  • 386_21649
  • find it
    RT-AC58U :green_heart: Confirmed find it
    RT-AC66U :green_heart: Confirmed Merlin:
  • 380.70_0
  • find it
    RT-AC66U B1 :green_heart: Confirmed find it
    RT-AC68U :green_heart: Confirmed Stock:
  • 3.0.0.4.386_49703
  • Merlin:
  • 386.5_2
  • 386.7_0
  • find it
    RT-AC86U :green_heart: Confirmed Stock:
  • 386_48260
  • Merlin:
  • 386.7_0
  • 386.7_2
  • find it
    RT-AC87U :green_heart: Confirmed Merlin:
  • 384.13_10
  • find it
    RT-AC88U :green_heart: Confirmed Merlin:
  • 386.7_beta1
  • find it
    RT-ACRH17 :green_heart: Confirmed Stock:
  • 382.52517
  • find it

    WiFi 4 | 802.11n

    Model Status Tested firmware Find it on Amazon[^amazon]
    RT-N66U :green_heart: 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-0.18.3.tar.gz (41.6 kB view hashes)

    Uploaded Source

    Built Distribution

    asusrouter-0.18.3-py3-none-any.whl (42.2 kB view hashes)

    Uploaded Python 3

    Supported by

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