ollo69 c196e9a2b4
Add sensors for AsusWRT using http(s) library (#34511)
* Add sensors for AsusWRT using http(s) library

* Apply suggested chnages

* Change unit of measure for uptime sensor
2024-09-04 14:35:46 +02:00

3.2 KiB

title, description, ha_category, ha_release, ha_config_flow, ha_iot_class, ha_codeowners, ha_domain, ha_platforms, ha_integration_type
title description ha_category ha_release ha_config_flow ha_iot_class ha_codeowners ha_domain ha_platforms ha_integration_type
ASUSWRT Instructions on how to integrate ASUSWRT into Home Assistant.
Hub
Presence detection
Sensor
0.83 true Local Polling
@kennedyshead
@ollo69
asuswrt
device_tracker
diagnostics
sensor
hub

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.

{% include integrations/config_flow.md %}

{% important %} You need to enable telnet on your router if you choose to use protocol: telnet. {% endimportant %}

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 (2 GHz, 5 GHz, 6 GHz, CPU). Only temperature sensors available on your router will be created.

If the integration is configured to use the http(s) protocol, also the following sensors will be available:

  • CPU usage sensors (percentage for total and single core)
  • Memory usage sensor (percentage)
  • Free memory sensor (Megabyte)
  • Memory used sensor (Megabyte)
  • Last boot sensor (Timestamp)
  • Uptime sensor (HH:MM:SS)

Only Connected devices sensor and Last boot sensor are created in status enabled, all other sensors are created in status disabled. To use them, simply enable on the devices page.

{% include integrations/option_flow.md %} {% configuration_basic %} Consider home: description: Number of seconds that must elapse before considering a disconnected device not at home. Track unknown: description: Enable this option to track also devices that do not have a name. Name will be replaced by mac address. Interface: description: The interface that you want statistics from (e.g. eth0,eth1 etc). Dnsmasq: description: The location in the router of the dnsmasq.leases file. Require IP: description: If devices must have IP (this option is available only for access point mode). {% endconfiguration_basic %}

{% note %} If you don't want to automatically track new detected device, disable the integration system option Enable new added entities {% endnote %}

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