Skip to content

Latest commit

 

History

History
193 lines (139 loc) · 18 KB

README.md

File metadata and controls

193 lines (139 loc) · 18 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.

📢 Do you want to add AsusRouter to the default HA Core integrations?

👍 Vote for the feature request!

Add AsusRouter integration to HA Core - Feature Requests - Home Assistant Community (home-assistant.io)

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.

WiFi 7 | 802.11be

Model Status Tested firmware Find it on Amazon1
GT-BE98 💛 Expected to work find it
RT-BE96U 💛 Expected to work find it

WiFi 6e | 802.11axe

Model Status Tested firmware Find it on Amazon1
GT-AXE11000 💛 Expected to work find it
GT-AXE16000 💚 Confirmed Stock:
  • 388.21617
  • find it
    RT-AXE7800 💛 Expected to work find it
    ZenWiFi ET8 💛 Expected to work find it
    ZenWiFi Pro ET12 💛 Expected to work find it

    WiFi 6 | 802.11ax

    Model Status Tested firmware Find it on Amazon1
    DSL-AX82U 💚 Confirmed Merlin:
  • 386.07_0-gnuton0_beta2
  • find it
    GT-AX11000 💚 Confirmed Merlin:
  • 386.7_2
  • 388.1_0
  • find it
    GT-AX11000 Pro 💛 Expected to work find it
    GT-AX6000 💛 Expected to work find it
    GT6 💛 Expected to work find it
    RT-AX55 💚 Confirmed Stock:
  • 386.50410
  • find it
    RT-AX56U 💚 Confirmed Merlin:
  • 386.7_2
  • find it
    RT-AX57 💛 Expected to work find it
    RT-AX58U 💚 Confirmed Stock:
  • 386.49674
  • 388.22237
  • Merlin:
  • 386.7_2
  • 388.1_0
  • find it
    RT-AX59U 💛 Expected to work find it
    RT-AX68U 💚 Confirmed Stock:
  • 388.21732
  • find it
    RT-AX82U 💚 Confirmed Stock:
  • 386.48664
  • 386.49674
  • find it
    RT-AX86S 💚 Confirmed Stock:
  • 386.46061
  • 386.48260
  • 386.49447
  • 388.22525
  • Merlin:
  • 386.7_2
  • find it
    RT-AX86U 💚 Confirmed Stock:
  • 386.46061
  • 386.48260
  • 386.49447
  • 388.22525
  • Merlin:
  • 386.7_2
  • find it
    RT-AX86U Pro 💛 Expected to work find it
    RT-AX88U 💚 Confirmed Stock:
  • 386.45934
  • 386.48631
  • Merlin:
  • 386.5_2
  • 386.8_0
  • 388.1_0
  • find it
    RT-AX88U Pro 💛 Expected to work find it
    RT-AX89X 💚 Confirmed find it
    RT-AX92U 💚 Confirmed Stock:
  • 386.46061
  • find it
    TUF-AX4200 💛 Expected to work find it
    TUF-AX5400 💚 Confirmed Stock:
  • 386.50224
  • 388.21224
  • 388_22525
  • find it
    TUF-AX6000 💛 Expected to work find it
    ZenWiFi AX (XT8) 💚 Confirmed Stock:
  • 386.48706
  • Merlin:
  • 386.7_2-gnuton1
  • find it
    ZenWiFi AX Hybrid (XP4) 💛 Expected to work find it
    ZenWiFi AX Mini (XD4) 💚 Confirmed Stock:
  • 386.48790
  • 386.49599
  • find it
    ZenWiFi Pro XT12 💚 Confirmed Stock:
  • 388.22127
  • find it
    ZenWiFi XD4 Plus 💛 Expected to work find it
    ZenWiFi XD4S 💛 Expected to work find it
    ZenWiFi XD5 💛 Expected to work find it
    ZenWiFi XD6 💚 Confirmed Stock:
  • 388.21380
  • find it
    ZenWiFi XD6S 💚 Confirmed Stock:
  • 388.21380
  • find it
    ZenWiFi XT9 💛 Expected to work find it

    WiFi 5 | 802.11ac

    Model Status Tested firmware Find it on Amazon1
    4G-AC55U 💚 Confirmed find it
    DSL-AC68U 💚 Confirmed Stock:
  • 386.47534
  • 386.50117
  • Merlin:
  • 386.4-gnuton2
  • 386.7_2-gnuton1
  • find it
    RT-AC51U 💚 Confirmed Stock:
  • 380.8591
  • find it
    RT-AC52U B1 💚 Confirmed find it
    RT-AC5300 💚 Confirmed Merlin:
  • 386.7_2
  • find it
    RT-AC57U V3 💚 Confirmed Stock:
  • 386.21649
  • find it
    RT-AC58U 💚 Confirmed find it
    RT-AC66U 💚 Confirmed Merlin:
  • 380.70_0
  • find it
    RT-AC66U B1 💚 Confirmed Stock:
  • 386.51255
  • find it
    RT-AC68U 💚 Confirmed Stock:
  • 386.49703
  • Merlin:
  • 386.5_2
  • 386.7_0
  • find it
    RT-AC85P 💚 Confirmed Stock:
  • 382.52516
  • find it
    RT-AC86U 💚 Confirmed Stock:
  • 386.48260
  • 386.49709
  • Merlin:
  • 386.7_0
  • 386.7_2
  • 386.9_0
  • find it
    RT-AC87U 💚 Confirmed Merlin:
  • 384.13_10
  • find it
    RT-AC88U 💚 Confirmed Stock:
  • 386.48260
  • Merlin:
  • 386.7_beta1
  • find it
    RT-ACRH17 💚 Confirmed Stock:
  • 382.52517
  • find it
    ZenWiFi AC Mini(CD6) 💛 Expected to work find it

    WiFi 4 | 802.11n

    Model Status Tested firmware Find it on Amazon1
    RT-N66U 💚 Confirmed find it

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

    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.

    Footnotes

    1. As an Amazon Associate I earn from qualifying purchases. Not like I ever got anything yet (: 2 3 4 5