Skip to content

Latest commit

 

History

History
192 lines (130 loc) · 33.3 KB

README.md

File metadata and controls

192 lines (130 loc) · 33.3 KB

GitHub Release LicenseBuild Status
HACS Default Community forum discussionBuy Me A Coffee
Installations

Monitor and control your AsusWRT-powered router from Home Assistant

AsusRouter is a custom integration for Home Assistant to monitor and control your AsusWRT (and AsusWRT-Merlin)-powered router using the AsusRouter python library.

The integration uses the native HTTP(S) API (the same way as WebUI) and relies on direct communication with your device.

Full documentation

You can find the full documentation on the official webpage.

Firmware limitations

Firmware versions 3.0.0.4.x are fully supported (older versions might have a limited amount of sensors available). When talking about the FW, 3.0.0.4 might be missed since it is the same all the time. Important is only the last part, e.g. 386.48631 for the stock or 386.7 for Merlin FW.

Firmware 5.x.x (some DSL models) is NOT supported (not AsusWRT).

More about firmware versions

Installation

HACS

You can add this repository to your HACS: HACS -> Integrations -> Explore & Download Repositories -> AsusRouter

Manual

Copy content of the stable branch custom_components/asusrouter/ to custom_components/asusrouter/ in your Home Assistant folder.

Usage

After AsusRouter is installed, you can add your device from Home Assistant UI.

Open your Home Assistant instance and start setting up a new integration.

To connect to the device you need to provide the following data:

  • IP address or hostname
  • Username (the one you use to log into the WebUI)
  • Password
  • Whether to use an SSL connection

Almost all the integration settings can be reconfigured later via the Configure button on the Integrations page without the need to remove your device and add it again.

Open your Home Assistant instance and show your integrations.

Features

AsusRouter supports 14+ groups of features, including monitoring of:

  • connected device, CPU, guest WLAN, LED, load average, network, OpenVPN, parental control, ports, RAM, temperature, WAN, WLAN.

and control of:

  • gues WLAN, LED, OpenVPN, parental control, WLAN.

as well as the following HA platrorms:

  • binary_sensor, button, device_tracker, light, sensor, switch, update

and HA events and services.

Full list of features

Supported devices

AsusRouter supports virtually every AsusWRT-powered device.

All the devices which were tested (also by the integration users) are explicitly marked as so, as well as the firmware type(s) / version(s).

Tested

802.11ax

Model Stock Merlin / GNUton Find it on Amazon*
DSL-AX82U 386.07_0-gnuton0_beta2
findGermany Spain Italy UK USA
GT-AX11000 386.7_2
findGermany Spain Italy UK USA
RT-AX55
findGermany Spain Italy UK USA
RT-AX56U 386.7_2
findGermany Spain Italy UK USA
RT-AX58U 386_49674 386.7_2
findGermany Spain Italy UK USA
RT-AX68U
findGermany Spain Italy UK USA
RT-AX82U 386_48664, 386.49674
findGermany Spain Italy UK USA
RT-AX86S 386_49447
findGermany Spain Italy UK USA
RT-AX86U 386_46061, 386_48260 386.7_2
findGermany Spain Italy UK USA
RT-AX88U (testing device) 386_45934, 386_48631 386.5_2
findGermany Spain Italy UK USA
RT-AX89X
findGermany Spain Italy UK USA
RT-AX92U 386_46061
findGermany Spain Italy UK USA
TUF-AX5400
findGermany Spain Italy UK USA
ZenWiFi AX (XT8) 386_48706 386.07_2-gnuton1
findGermany Spain Italy UK USA
ZenWiFi AX Mini (XD4) 386_48790, 386_49599
findGermany Spain Italy UK USA

*As an Amazon Associate I earn from qualifying purchases. Not like I ever got anything yet (:

802.11ac

Model Stock Merlin / GNUton Find it on Amazon*
4G-AC55U
findGermany Spain Italy UK USA
DSL-AC68U 386_47534 386.04-gnuton2
findGermany Spain Italy UK USA
RT-AC51U 380_8591
findGermany Spain Italy UK USA
RT-AC52U B1
findGermany Spain Italy UK USA
RT-AC5300 386.7_2
findGermany Spain Italy UK USA
RT-AC57U V3 386_21649
findGermany Spain Italy UK USA
RT-AC58U / RT-ACRH13
findGermany Spain Italy UK USA
RT-AC66R / RT-AC66U 380.70_0
findGermany Spain Italy UK USA
RT-AC66U B1
findGermany Spain Italy UK USA
RT-AC68U 386.5_2, 386.7_0
findGermany Spain Italy UK USA
RT-AC86U 386_48260 386.7_0, 386.7_2
findGermany Spain Italy UK USA
RT-AC87U 384.13_10
findGermany Spain Italy UK USA
RT-AC88U 386.7_beta1
findGermany Spain Italy UK USA
RT-ACRH17 382.52517
findGermany Spain Italy UK USA

*As an Amazon Associate I earn from qualifying purchases. Not like I ever got anything yet (:

802.11n

Model Stock Merlin / GNUton Find it on Amazon*
RT-N66U
findGermany Spain Italy UK USA

*As an Amazon Associate I earn from qualifying purchases. Not like I ever got anything yet (:

Else

Usage of AsusWRT-Merlin on non-Asus devices is ILLEGAL As stated by developers of Merlin (link)

Model Merlin / GNUton
Netgear R6300V2 380.70
Netgear R7000 386.2_4, 380.70_0-X7.9

New features development

Here is the list of features being in process of development or considered for the future development. If you cannot find the feature you would like to have in the integration, please, open a new feature request.

GroupFeatureStatus
Access Point mode
  1. Full support (#156)
on hold
(a device is required for development and testing)
AiMesh
  1. Full support (#16, #161, #203, #261)
on hold
(a device with AiMesh support is required for development and testing)
Aura RGB
  1. Full support (#82)
on hold
(a device with Aura RGB support is required for development and testing)
Connected device
  1. Per-device traffic monitoring (#220)
  2. Possibility to use DHCP `hostname` value for device tracking (#119)
considered
Port forwarding
  1. Full support (#136)
considered

Support the integration

Issues and Pull requests

If you have found an issue working with the integration 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!

Other support

This integration is a free-time project. If you like it, you can support me by buying a coffee.

Buy Me A Coffee

Thanks to

The initial codebase for this integration is highly based on Home Assistant core integration AsusWRT and ollo69/ha_asuswrt_custom.