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

Navigation

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for Vaskivskyi from gravatar.com Vaskivskyi

Unverified details

These details have not been verified by PyPI
Project links
Meta
Classifiers
Report project as malware

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 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]
Version 388.10 of AsusWRT-Merlin firmware is officially NOT supported due to the issues with HTTP daemon crashes. Use versions >=388.10_2 or <=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.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 Amazon[^amazon]
    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
    • Merlin:
  • 388.8_4-gnuton1
    		•  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 Amazon[^amazon]
    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 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

    Verified details

    These details have been verified by PyPI
    Project links
    GitHub Statistics
    Maintainers
    Avatar for Vaskivskyi from gravatar.com Vaskivskyi

    Unverified details

    These details have not been verified by PyPI
    Project links
    Meta
    Classifiers

    Release history Release notifications | RSS feed

    This version

    1.21.3

    1.21.2

    1.21.1

    1.21.0

    1.20.1

    1.20.0

    1.19.0

    1.18.2

    1.18.1

    1.18.0

    1.17.0

    1.16.0

    1.15.1

    1.15.0

    1.14.2

    1.14.1

    1.14.0

    1.13.1

    1.13.0

    1.12.2

    1.12.1

    1.12.0

    1.11.0

    1.10.0

    1.9.0

    1.8.0

    1.7.0

    1.6.1

    1.6.0

    1.5.0

    1.4.0

    1.3.0

    1.2.0

    1.1.2

    1.1.1

    1.1.0

    1.1.0b2 pre-release

    1.1.0b1 pre-release

    1.1.0b0 pre-release

    1.0.5

    1.0.4

    1.0.3

    1.0.2

    1.0.1

    1.0.0

    1.0.0b3 pre-release

    1.0.0b2 pre-release

    1.0.0b1 pre-release

    1.0.0b0 pre-release

    0.20.3

    0.20.2

    0.20.1

    0.20.0

    0.19.7

    0.19.6

    0.19.5

    0.19.4

    0.19.3

    0.19.2

    0.19.1

    0.19.0

    0.18.3

    0.18.2

    0.18.1

    0.18.0

    0.17.1

    0.17.0

    0.16.1

    0.16.0

    0.15.2

    0.15.1

    0.15.0

    0.14.0

    0.13.0

    0.12.1

    0.12.0

    0.11.0

    0.10.4

    0.10.3

    0.10.2

    0.10.1

    0.10.0

    0.9.5

    0.9.4

    0.9.3

    0.9.2

    0.9.1

    0.9.0

    0.8.0

    0.7.0

    0.6.3

    0.6.2

    0.6.1

    0.6.0

    0.5.1

    0.5.0

    0.4.4

    0.4.3

    0.4.2

    0.4.1

    0.4.0

    0.3.2

    0.3.1

    0.3.0

    0.2.11

    0.2.10

    0.2.9

    0.2.8

    0.2.7

    0.2.6

    0.2.6a0 pre-release

    0.2.5

    0.2.4

    0.2.3

    0.2.2

    0.2.1

    0.2.0

    0.1.0

    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.21.3.tar.gz (130.2 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.21.3-py3-none-any.whl (132.1 kB view details)

    Uploaded Python 3

    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

    Hashes for asusrouter-1.21.3.tar.gz
    Algorithm Hash digest
    SHA256 584063b48f2e2da2b0bb1f6bcf61abf4d77aa3450a8895ad64223babe6b21140
    MD5 f90754d28842a879054104d70f6790e2
    BLAKE2b-256 4bf6008706e00edb15697f3ac810f991d8791eeea21bd51deab4b41dc735326f

    See more details on using hashes here.

    Provenance

    The following attestation bundles were made for asusrouter-1.21.3.tar.gz:

    Publisher: release.yml on Vaskivskyi/asusrouter

    Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

    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

    Hashes for asusrouter-1.21.3-py3-none-any.whl
    Algorithm Hash digest
    SHA256 d08f302e64e9585a2c14ba1f7df06b730d8bd99a59663a0f36a16f5743f9d5f0
    MD5 36e92980d3aac9d7d343a92bfb782c46
    BLAKE2b-256 695064f14c7baa4b72bc8a01889a12d44f32a759f730ed460b48b6375dae5efa

    See more details on using hashes here.

    Provenance

    The following attestation bundles were made for asusrouter-1.21.3-py3-none-any.whl:

    Publisher: release.yml on Vaskivskyi/asusrouter

    Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

    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