Metadata-Version: 2.4 Name: asusrouter Version: 1.21.3 Summary: API wrapper for communication with ASUSWRT-powered routers using HTTP protocol Home-page: https://github.com/Vaskivskyi/asusrouter Author-email: Yevhenii Vaskivskyi License-Expression: Apache-2.0 Project-URL: Homepage, https://asusrouter.vaskivskyi.com/ Project-URL: Source Code, https://github.com/Vaskivskyi/asusrouter Project-URL: Bug Reports, https://github.com/Vaskivskyi/asusrouter/issues Classifier: Development Status :: 3 - Alpha Classifier: Intended Audience :: Developers Classifier: Operating System :: OS Independent Classifier: Programming Language :: Python :: 3.11 Classifier: Programming Language :: Python :: 3.12 Classifier: Programming Language :: Python :: 3.13 Classifier: Topic :: Software Development :: Libraries Requires-Python: >=3.11.0 Description-Content-Type: text/markdown License-File: LICENSE License-File: NOTICE Requires-Dist: aiohttp>=3.8.1 Requires-Dist: urllib3>=1.26.14 Requires-Dist: xmltodict>=0.12.0 Dynamic: license-file [![GitHub Release](https://img.shields.io/github/release/Vaskivskyi/asusrouter.svg?style=for-the-badge&color=blue)](https://github.com/Vaskivskyi/asusrouter/releases) [![License](https://img.shields.io/github/license/Vaskivskyi/asusrouter.svg?style=for-the-badge&color=yellow)](LICENSE)
![Downloads](https://img.shields.io/pypi/dm/asusrouter?style=for-the-badge&color=blue) ![Commit activity](https://img.shields.io/github/commit-activity/m/vaskivskyi/asusrouter.svg?style=for-the-badge&color=yellow)

## 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](https://github.com/Vaskivskyi/ha-asusrouter) 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`. ```python 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](https://asusrouter.vaskivskyi.com/devices/GT-BE19000.md) | 💛 Expected to work | | find it | | [GT-BE98](https://asusrouter.vaskivskyi.com/devices/GT-BE98.md) | 💚 Confirmed | Stock:

`102_34372`

| find it | | [GT-BE98 Pro](https://asusrouter.vaskivskyi.com/devices/GT-BE98Pro.md) | 💛 Expected to work | | find it | | [RT-BE58U](https://asusrouter.vaskivskyi.com/devices/RT-BE58U.md) | 💛 Expected to work | | find it | | [RT-BE88U](https://asusrouter.vaskivskyi.com/devices/RT-BE88U.md) | 💛 Expected to work | | find it | | [RT-BE92U](https://asusrouter.vaskivskyi.com/devices/RT-BE92U.md) | 💛 Expected to work | | find it | | [RT-BE96U](https://asusrouter.vaskivskyi.com/devices/RT-BE96U.md) | 💛 Expected to work | | find it | | [TUF-BE3600](https://asusrouter.vaskivskyi.com/devices/TUF-BE3600.md) | 💛 Expected to work | | find it | | [TUF-BE6500](https://asusrouter.vaskivskyi.com/devices/TUF-BE6500.md) | 💛 Expected to work | | find it | | [ZenWiFi BD4](https://asusrouter.vaskivskyi.com/devices/ZenWiFiBD4.md) | 💛 Expected to work | | find it | | [ZenWiFi BQ16](https://asusrouter.vaskivskyi.com/devices/ZenWiFiBQ16.md) | 💛 Expected to work | | find it | | [ZenWiFi BQ16 Pro](https://asusrouter.vaskivskyi.com/devices/ZenWiFiBQ16Pro.md) | 💛 Expected to work | | find it | | [ZenWiFi BT10](https://asusrouter.vaskivskyi.com/devices/ZenWiFiBT10.md) | 💛 Expected to work | | find it | ### WiFi 6e | 802.11axe | Model | Status | Tested firmware | Find it on Amazon[^amazon] | | ------------------------------------------------------------------------------- | ------------------- | --------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | | [GT-AXE11000](https://asusrouter.vaskivskyi.com/devices/GT-AXE11000.md) | 💛 Expected to work | | find it | | [GT-AXE16000](https://asusrouter.vaskivskyi.com/devices/GT-AXE16000.md) | 💚 Confirmed | Stock:

`388.21617`

Merlin:

`388.7_beta1_rog`

`388.7_0_rog`

`388_22068`

`388.23759`

`388.23013`

| find it | ### WiFi 6 | 802.11ax | Model | Status | Tested firmware | Find it on Amazon[^amazon] | | ---------------------------------------------------------------------------------------------- | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | | [DSL-AX82U](https://asusrouter.vaskivskyi.com/devices/DSL-AX82U.md) | 💚 Confirmed | Merlin:

`386.07_0-gnuton0_beta2`

`386.7_2`

`388.1_0`

`388.4_0`

`388.7_0_rog`

`388.24198`

Merlin:

`388.7_0_rog`

`388.7_beta1`

`386.69061`

`386.50410`

`386.52041`

`386.7_2`

`388.1_0`

`388.2_2`

`386.49674`

`388.22237`

Merlin:

`386.7_2`

`388.1_0`

`388.4_0`

`388.7.0`

`388.21732`

`386.48664`

`386.49674`

Merlin:

`388.8_4-gnuton1`

`386.46061`

`386.48260`

`386.49447`

`388.22525`

Merlin:

`386.7_2`

`386.46061`

`386.48260`

`386.49447`

`388.22525`

Merlin:

`386.7_2`

`388.4_0`

`388.7_beta1`

`388.23565`

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

`388.4_0`

`386.46061`

`388.23785`

`386.50224`

`388.21224`

`388.22525`

`388.23285`

`388.24121`

Merlin:

`388.4_0`

`388.32432`

`386.48706`

`388.23285`

Merlin:

`386.7_2-gnuton1`

`386.48790`

`386.49599`

`388.22127`

`388.23949`

`388.21380`

`388.21380`

`388_23285`

| find it | ### WiFi 5 | 802.11ac | Model | Status | Tested firmware | Find it on Amazon[^amazon] | | ----------------------------------------------------------------------------------------- | ------------------- | ----------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | | [4G-AC55U](https://asusrouter.vaskivskyi.com/devices/4G-AC55U.md) | 💚 Confirmed | Stock:

`380.8102`

`382_70348`

`386.47534`

`386.50117`

Merlin:

`386.4-gnuton2`

`386.7_2-gnuton1`

`380.8591`

`386.7_2`

`386.21649`

`380.70_0`

`386.51255`

`386.49703`

Merlin:

`386.5_2`

`386.7_0`

`382.52516`

`386.48260`

`386.49709`

Merlin:

`386.7_0`

`386.7_2`

`386.9_0`

`384.13_10`

`386.48260`

Merlin:

`386.5_0`

`386.7_beta1`

`386.12_2`

`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](https://asusrouter.vaskivskyi.com/devices/RT-N66U.md) | 💚 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](https://github.com/Vaskivskyi/asusrouter/issues). You are also welcome to submit [pull requests](https://github.com/Vaskivskyi/asusrouter/pulls) 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 (: