API wrapper for communication with ASUSWRT-powered routers
Project description
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: | Stock: Any Merlin: Any | |
Limited support |
802.11ac: | Stock: Latest available Merlin: 380.70+ | no LED control |
Non-Asus devices |
Netgear: | Merlin: 380.70+ | |
Not supported |
|
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.
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
Built Distribution
Hashes for asusrouter-0.10.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f87003badaae205819587c394ddb7b3e263bb28c2a7f15742fbb97d04122e685 |
|
MD5 | 0c6722ce5fad7a4132912ffc840a787a |
|
BLAKE2b-256 | 7b064ad7d59d222f46da79625e00000eb93e73b5c5a61da31f6bf205a6e94493 |