API wrapper for communication with ASUSWRT-powered routers
Project description
AsusRouter
AsusRouter is an API wrapper for communication with ASUSWRT-powered routers using the HTTP or HTTPS protocols.
Supported features
- Monitoring data when
enable_monitor
parameter ofAsusRrouter
is set toTrue
(default) - Sending commands to the device when
enable_control
is set toTrue
(default isFalse
) - SSL server certificates on the device side (including certificate check on connection from Trusted Root Certificates or your own specified certificate file)s
Installation
Installation of the latest release is available from PyPI:
pip install asusrouter
Usage
Once installed, you can import AsusRouter
class from the module. Example shows the default parameters except for host
, username
and password
.
from asusrouter.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
AsusRouter
class has 3 monitors to load large part of useful data from the device. All of them require enable_monitor
parameter of AsusRrouter
to be set to True
. The following methods can be used:
router.async_monitor_main()
router.async_monitor_nvram()
router.async_monitor_misc()
Moreover, some additional methods are also available (that could partially rely on one of the monitors):
router.async_find_interfaces()
The 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 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 the detailed explanation on the available commands.
Supported devices and firmware
Currently, AsusRouter is tested on my only router model. If you wish to help me making it better, feel free to open a Pull Request with your model name and firmware (if everything works well). Chances are much higher that some problems may occur on other devices, so Issues are waiting for a new one.
Devices
Model | Support level |
---|---|
RT-AC66U | Complete |
Firmware
Version | Build | Extended | Support level |
---|---|---|---|
3.0.0.4 | 382 | 52287-g798e87f | Complete |
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.2.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | befbfdf2f7b6e1bd9d7a1747f3334653cb0e86969800532b0f1bd00b1f11b361 |
|
MD5 | d9c4ed682c20c71fc79ba27e4c157f6c |
|
BLAKE2b-256 | b97e952a4630c0724143643aef18c125391a66e18635a30c3fde975c10864a3f |