asusrouter 0.9.2

API wrapper for communication with ASUSWRT-powered routers

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
                    cert_check = True,                  #optional
                    cert_path = "",                     #optional
                    cache_time = 5,                     #optional
                    enable_monitor = True,              #optional
                    enable_control = False)             #optional

The module has the initialization method to load all the known data (all the monitors and methods from the next section, require enable_monitor to be True):

router.async_initialize()

Monitors and additional methods

Most of the values, obtained from the router are grouped in several monitor methods to decrease the amount of data sent between the library and the device. All of them require the enable_monitor parameter of AsusRouter to be set to True.

async_monitor_main()
async_monitor_nvram()
async_monitor_misc()
async_monitor_devices()

A detailed description of monitors and monitoring methods is available here (in work).

Commands

AsusRouter class supports sending commands to the device using the async_command method. Sending commands requires the enable_command parameter of AsusRrouter to be set to True.

For example, to reboot the device:

# This command will REBOOT your device if connected!
router.async_command(commands = {"rc_service": "reboot"}, action_mode = "apply")

Commands to the method should be sent as a dict of command: value. Please, refer to the Command List (in work) for a detailed explanation of the available commands.

Supported devices

This list provides only the models tested by me or other users.

Group	Devices	Firmware	Limitation
Full support	802.11ax: DSL-AX82U, GT-AX11000, RT-AX55, RT-AX58U, RT-AX68U, RT-AX82U, RT-AX86U, RT-AX86S (reported as RT-AX86U), RT-AX88U, RT-AX89X, RT-AX92U, TUF-AX5400, ZenWiFi AX (XT8), ZenWiFi AX Mini (XD4) 802.11ac: DSL-AC68U, RT-AC86U, RT-ACRH13	Stock: Any Merlin: Any
Limited support	802.11ac: RT-AC51U, RT-AC66U, RT-ACRH17 (reported as RT-AC82U) 802.11n: RT-N66U	Stock: Latest available Merlin: 380.70+	no LED control
Non-Asus devices	Netgear: R6300V2, R7000	Merlin: 380.70+
Not supported	DSL-AC68VG (non-compatible FW)

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.