diff --git a/README.md b/README.md index f4d62c5..a8ca8c3 100644 --- a/README.md +++ b/README.md @@ -8,10 +8,18 @@ The integration uses the native HTTP(S) API (the same way as WebUI) and relies on direct communication with your device. -## Full documentation +## Documentation and tips You can find the full documentation on the [official webpage](https://asusrouter.vaskivskyi.com/). +### Use HTTPS connection + +It is recommended to use an HTTPS connection to your router (SSL). While both the SSL and non-SSL connections are fully supported, some devices might have issues with disconnects on HTTP. In order to use SSL, you need to enable it in the router settings: `Administration -> System -> Local Access Config -> Authentication Method`. Put it to `BOTH` (recommended) or `HTTPS`. Make note of the port number (default is `8443`). + +### Connected devices number + +The integration might show a different number of connected devices compared to the WebUI network map. In this case, refer to the number of devices shown in the `AiMesh` section of the WebUI. Those two are different regardless of the actual use of AiMesh. + ## :loudspeaker: Do you want to add AsusRouter to the default HA Core integrations? :+1: Vote for the feature request! @@ -20,7 +28,7 @@ You can find the full documentation on the [official webpage](https://asusrouter ## 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 versions `3.0.0.4.x` and `3.0.0.6.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` or `106.xxxxx` for the stock or `386.7` for Merlin FW. Firmware `5.x.x` (some DSL models) is **NOT supported** (not AsusWRT). @@ -49,7 +57,7 @@ To connect to the device you need to provide the following data: - 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. +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.](https://my.home-assistant.io/badges/integrations.svg)](https://my.home-assistant.io/redirect/integrations/) @@ -59,9 +67,9 @@ 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. +- guest WLAN, LED, OpenVPN, parental control, WLAN. - as well as the following HA platrorms: + as well as the following HA platforms: - `binary_sensor`, `button`, `device_tracker`, `light`, `sensor`, `switch`, `update` and HA events and services. @@ -70,15 +78,21 @@ and HA events and services. ## Supported devices -AsusRouter supports virtually every AsusWRT-powered device. +AsusRouter supports virtually every AsusWRT-powered device. This list is purely based on the reports from the users. Other devices with the compatible firmware should work as well. ### WiFi 7 | 802.11be |Model|Status|Tested firmware|Find it on Amazon[^amazon]| |---|---|---|---| |[GT-BE98](https://asusrouter.vaskivskyi.com/devices/GT-BE98.html)|💛 Expected to work||find it| |[GT-BE98 Pro](https://asusrouter.vaskivskyi.com/devices/GT-BE98Pro.html)|💛 Expected to work||find it| +|[RT-BE88U](https://asusrouter.vaskivskyi.com/devices/RT-BE88U.html)|💛 Expected to work||find it| |[RT-BE96U](https://asusrouter.vaskivskyi.com/devices/RT-BE96U.html)|💛 Expected to work||find it| +|[TUF-BE3600](https://asusrouter.vaskivskyi.com/devices/TUF-BE3600.html)|💛 Expected to work||find it| +|[TUF-BE6500](https://asusrouter.vaskivskyi.com/devices/TUF-BE6500.html)|💛 Expected to work||find it| +|[ZenWiFi BD4](https://asusrouter.vaskivskyi.com/devices/ZenWiFiBD4.html)|💛 Expected to work||find it| +|[ZenWiFi BQ16](https://asusrouter.vaskivskyi.com/devices/ZenWiFiBQ16.html)|💛 Expected to work||find it| |[ZenWiFi BQ16 Pro](https://asusrouter.vaskivskyi.com/devices/ZenWiFiBQ16Pro.html)|💛 Expected to work||find it| +|[ZenWiFi BT10](https://asusrouter.vaskivskyi.com/devices/ZenWiFiBT10.html)|💛 Expected to work||find it| ### WiFi 6e | 802.11axe |Model|Status|Tested firmware|Find it on Amazon[^amazon]| @@ -97,20 +111,23 @@ AsusRouter supports virtually every AsusWRT-powered device. |[GT-AX11000 Pro](https://asusrouter.vaskivskyi.com/devices/GT-AX11000Pro.html)|💚 Confirmed|Stock: