- Saved searches
- Use saved searches to filter your results more quickly
- License
- Vaskivskyi/ha-asusrouter
- Name already in use
- Sign In Required
- Launching GitHub Desktop
- Launching GitHub Desktop
- Launching Xcode
- Launching Visual Studio Code
- Latest commit
- Git stats
- Files
- README.md
- Footnotes
- About
- ASUSWRT
- Category Presence Detection
- ASUSWRT
- Configuration
- Sensors Configuration
- Options
- Padavan custom firmware (The rt-n56u project)
- Help us to improve our documentation
Saved searches
Use saved searches to filter your results more quickly
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session.
Monitor and control your AsusWRT-powered router from Home Assistant
License
Vaskivskyi/ha-asusrouter
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Name already in use
A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Sign In Required
Please sign in to use Codespaces.
Launching GitHub Desktop
If nothing happens, download GitHub Desktop and try again.
Launching GitHub Desktop
If nothing happens, download GitHub Desktop and try again.
Launching Xcode
If nothing happens, download Xcode and try again.
Launching Visual Studio Code
Your codespace will open once ready.
There was a problem preparing your codespace, please try again.
Latest commit
Git stats
Files
Failed to load latest commit information.
README.md
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.
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!
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).
You can add this repository to your HACS: HACS -> Integrations -> Explore & Download Repositories -> AsusRouter
Copy content of the stable branch custom_components/asusrouter/ to custom_components/asusrouter/ in your Home Assistant folder.
After AsusRouter is installed, you can add your device from Home Assistant UI.
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.
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.
as well as the following HA platrorms:
and HA events and services.
AsusRouter supports virtually every AsusWRT-powered device.
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.
- Full support (#82)
- Per-device traffic monitoring (#220)
- Possibility to use DHCP `hostname` value for device tracking (#119)
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!
This integration is a free-time project. If you like it, you can support me by buying a coffee.
The initial codebase for this integration is highly based on Home Assistant core integration AsusWRT and ollo69/ha_asuswrt_custom.
Footnotes
About
Monitor and control your AsusWRT-powered router from Home Assistant
ASUSWRT
The asuswrt platform offers presence detection by looking at connected devices to a ASUSWRT based router.
This platform is NOT available for Microsoft Windows installations.
To use an ASUSWRT router in your installation, add the following to your configuration.yaml file:
# Example configuration.yaml entry device_tracker: - platform: asuswrt host: YOUR_ROUTER_IP username: YOUR_ADMIN_USERNAME
- host (Required): The IP address of your router, eg. 192.168.1.1 .
- username (Required: The username of an user with administrative privileges, usually admin .
- password (Optional): The password for your given admin account (use this if no SSH key is given).
- protocol (Optional): The protocol ( ssh or telnet ) to use. Defaults to ssh .
- port (Optional): SSH port to use. Defaults to 22 .
- mode (Optional): The operating mode of the router ( router or ap ). Defaults to router .
- ssh_key (Optional): The path to your SSH private key file associated with your given admin account (instead of password).
You need to enable telnet on your router if you choose to use protocol: telnet .
See the device tracker component page for instructions how to configure the people to be tracked.
Category Presence Detection
- ASUSWRT
- Actiontec
- Aruba
- Automatic
- BMW connected drive
- BT Home Hub 5
- Bbox
- Bluetooth LE Tracker
- Bluetooth Tracker
- Cisco IOS
- DD-WRT
- FRITZ!Box
- GPSLogger
- Geofency
- Hitron CODA Routers
- Huawei Router
- JSON MQTT Device Tracker
- Keenetic NDMS2 Routers
- Linksys Access Points
- Linksys Smart Wifi Router
- Locative
- MQTT Device Tracker
- MQTT Room Presence
- Meraki
- Mercedes me
- Mikrotik
- MySensors Device Tracker
- Netgear
- Nmap
- OpenWRT (luci)
- OpenWRT (ubus)
- OwnTracks (via HTTP)
- Owntracks
- Ping (ICMP)
- SNMP
- Sky Hub
- Swisscom Internet-Box
- TP-Link
- Tado
- Tesla
- Thomson
- Tile
- Tomato
- TrackR
- UPC ConnectBox
- Ubiquiti Unifi WAP
- Ubiquiti Unifi direct AP
- Volvo On Call
- Volvo On Call
- Xiaomi Router
- iCloud
Contact us at hello@home-assistant.io (no support!).
Website powered by Jekyll and the Oscalite theme.
Hosted by GitHub and served by CloudFlare.
home-assistant.io is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.
ASUSWRT
The ASUSWRT integration can connect Home Assistant to a ASUS router that runs on ASUSWRT firmware.
There is currently support for the following device types within Home Assistant:
- Presence Detection — The ASUSWRT platform offers presence detection by looking at connected devices to a ASUSWRT based router.
- Sensor — The ASUSWRT sensors platform allows you to get information from your ASUS router within Home Assistant.
Configuration
Adding ASUSWRT to your Home Assistant instance can be done via the user interface, by using this My button:
If the above My button doesn’t work, you can also perform the following steps manually:
- Browse to your Home Assistant instance.
- Go to Settings > Devices & Services.
- In the bottom right corner, select the Add Integration button.
- From the list, select ASUSWRT.
- Follow the instructions on screen to complete the setup.
You need to enable telnet on your router if you choose to use protocol: telnet .
Sensors Configuration
These sensors are automatically created and associated to the router device:
- Connected devices sensor
- Download sensor (unit_of_measurement: Gigabyte — Daily accumulation)
- Download Speed sensor (unit_of_measurement: Mbit/s)
- Upload sensor (unit_of_measurement: Gigabyte — Daily accumulation)
- Upload Speed sensor (unit_of_measurement: Mbit/s)
- Load average sensors (1min, 5min, 15min)
- Temperature sensors (2ghz, 5ghz, cpu). NB: only temperature sensors available on your router will be created
Only Connected devices sensor is created in status enabled, all other sensors are created in status disabled. To use them, simply enable on the devices page.
Options
Options for ASUSWRT can be set via the user interface, by taking the following steps:
- Browse to your Home Assistant instance.
- Go to Settings > Devices & Services.
- If multiple instances of ASUSWRT are configured, choose the instance you want to configure.
- Select the integration, then select Configure.
Number of seconds that must elapse before considering a disconnected device not at home .
Enable this option to track also devices that do not have a name. Name will be replaced by mac address.
The interface that you want statistics from (e.g. eth0,eth1 etc).
The location in the router of the dnsmasq.leases file.
If devices must have IP (this option is available only for access point mode).
If you don’t want to automatically track new detected device, disable the integration system option Enable new added entities
Padavan custom firmware (The rt-n56u project)
The rt-n56u project does not store dnsmasq.leases which is used to track devices at /var/lib/misc/ as asuswrt do. However this integration can still be used for the rt-n56u project by changing the dnsmasq location using the dnsmasq variable to dnsmasq: ‘/tmp’ Also, to get the statistics for the WAN port, specify interface: ‘eth3’ as this is the interface used in the rt-n56u project
Help us to improve our documentation
The ASUSWRT hub was introduced in Home Assistant 0.83, and it’s used by 1.2% of the active installations. Its IoT class is Local Polling.