[Custom component] AsusRouter integration

Vaskivskyi · November 23, 2023, 9:11pm

Beta release!

A small but important beta release for those having troubles with devices stuck in the home state. The new feature is enabled by default (but you can disable it in the options). Tested to work on RT-AC66U with 380.70 Merlin FW.

Stable release to come this weekend

0.25.0b0 Force clients update

2023-11-23

→ GitHub release ←

Features

Added force_clients possibility, which sends a separate request to update the client list
Added force_clients (boolean) and force_clients_waittime (float, in seconds) settings to the config flow

Other changes

Improved exceptions messages

Dependencies

Bumped asusrouter library to 1.2.0

Vaskivskyi · December 3, 2023, 7:37pm

Beta release!

0.25.0b1 Fixes

2023-12-03

→ GitHub release ←

Bug fixes

Fixed bug with integration failing to load with unknown VPN settings (Surfshark, L2PT, PP2P) via VPN Fusion (Stock FW 388+) (report #726)
Fixed bug with Guest WLAN switches (report #727, #731)
Fixed bug with 6 GHz WLAN being reported as 5 GHz-2 on some models (report #591)

Dependencies

Bumped asusrouter library to 1.3.0

Release delays

Hello, guys. Unfortunately, I currently have rather a limited amount of spare time until December 16. This might cause some delays in processing your reports and fixing bugs. I hope for your understanding.

Stable release

The stable release of 0.25.0 will be available after a couple of days if no new bugs are reported in beta.

In case of new bugs reported, the stable release might be delayed. Sorry for that.

Support AsusRouter

Monetary support:

Buy Me a Coffee
Buy a new Asus device via Amazon Associate links (usage of the associate links does not change the price of the items for you)

Non-monetary support:

Star AsusRouter integration repository
Star AsusRouter Python library repository
Know a person with an Asus device using Home Assistant but not AsusRouter? Let them know, AsusRouter is cool and has lots of useful features

automateitall · December 8, 2023, 9:24pm

Vaskivskyi:

@automateitall,

image792×144 4.07 KB

In your data put the following JSON:
{
    "entities": [
        "device_tracker.device_name"
    ],
    "state": "block"
}
or
{
    "entities": [
        "device_tracker.device_name"
    ],
    "state": "disable"
}
to block or disable internet access for device with an entity device_tracker.device_name.

You can also use MAC addresses and give a devicemap to the service.
{
    "devices": [
        {
            "mac": "01:23:45:67:89:01",
            "name": "Device/1"
        },
        {
            "mac": "01:23:45:67:89:02"
        },
        {
            "mac": "01:23:45:67:89:03",
            "name": "Device/3"
        }
    ],
    "state": "disable"
}
You don’t have to specify the name for each device, just mac. In case name is specified - it will be shown in parental control rules. If not - mac will be shown instead of the name.

Details on the service itself - in the docs. Just be careful, for Node-Red you need to properly format JSON (like in is shown in code snippets here).

This has stopped working after many months of it being rock solid. Nothing has changed about my node red flow, but I am now getting an API error when I try to call the service device_internet_access

“Call-service error. Service not found.”

Any idea what has changed?

Quacked · December 11, 2023, 9:02am

When I enable a disabled device_tracker the whole integration seems to reload. It’s triggering my automations notifying me of WAN IP changed etc. Perhaps not possible to do anything about that?

boheme61 · December 11, 2023, 10:07am

It most likely depends upon how that automation looks like
PS: Many Integrations needs to “reload” when one enables a disabled device/entity.

vijaykbhatia · December 12, 2023, 10:29pm

Hi all, I have updated to the new version and now I don’t have any service calls available. Also port forwarding and other switches aren’t available. I looked through the guide and it says you need to make sure device control is set to true but I can’t find this anywhere. Any help would be appreciated.

Vaskivskyi · December 15, 2023, 6:31am

@automateitall, @vijaykbhatia,

some services are missing after 0.23.0 due to breaking changes in the backend library. They will be added back before the New Year

@Quacked, enabling/disabling any entity triggers HA to reload the integration fully, which can cause troubles depending on how your automation is set up.

Unfortunately, I don’t know how to prevent it. If you know of any other integration which does not reload on entities enabling/disabling, let me know - I can check how this is made

o0larry0o · December 17, 2023, 10:20am

Hello Very nice integration, I’m just discovering it.
Quick question for @Vaskivskyi, where does the information for the device tracker come from ?
I own a RT AC86U which has a messed up network map that never shows correct data.
Do you import directly those data ? or do you fetch them from somewhere else ?
meaning are the info provided by the sensors and the connected devices reliable ?

Other question, is there somewhere here (coulnd not find it) nice example of charts ? like a network map for example, or anything that could be a start for a network map ?

Thx a lot and congrat for the job, this integration looks looks very great

Vaskivskyi · December 21, 2023, 5:58am

Hello, @o0larry0o,

The data on the connected devices is taken from the AiMesh onboarding (if available for the device) + directly from the network map. Also, it’s now possible for the integration to try forcing a router to recheck connected devices. Unfortunately, this is not the most stable part of the integration yet. Your device is not the only one having trouble with it and different devices for some users experience issues. This is still a work in progress and hopefully will be solved soon enough

o0larry0o · December 21, 2023, 6:42am

Hello.

Thx for your answer. I see.
Yes this composent from asus is crapy.
And I don’t have the strengh to rebuild it ^^

How can I force a recheck then ?

Have a good day

Vaskivskyi · December 21, 2023, 7:06am

@o0larry0o, now you can with the new stable version

0.25.0 Force clients update & more

2023-12-21

→ GitHub release ←

Features

Added force_clients possibility, which sends a separate request to update the client list
Added force_clients (boolean) and force_clients_waittime (float, in seconds) settings to the config flow

Bug fixes

Fixed bug with integration failing to load with unknown VPN settings (Surfshark, L2PT, PP2P) via VPN Fusion (Stock FW 388+) (report #726)
Fixed bug with Guest WLAN switches (report #727, #731)
Fixed bug with 6 GHz WLAN being reported as 5 GHz-2 on some models (report #591)
- All the models properly reporting 6 GHz as supported in the services
- RT-AXE95Q (ZenWiFi ET8)

Other changes

Improved exceptions messages

Dependencies

Bumped asusrouter library to 1.2.0, 1.3.0, 1.4.0

Support AsusRouter

Monetary support:

Buy Me a Coffee
Buy a new Asus device via Amazon Associate links (usage of the associate links does not change the price of the items for you)

Non-monetary support:

Star AsusRouter integration repository
Star AsusRouter Python library repository
Know a person with an Asus device using Home Assistant but not AsusRouter? Let them know, AsusRouter is cool and has lots of useful features

poudenes · December 21, 2023, 10:55am

Is this only working on certain routers? With my Asus GT AX 11000 Im not getting those new entities.

Vaskivskyi · December 21, 2023, 5:31pm

The new feature is available in the integration configuration:

It should be enabled by default, but you might need to adjust the wait time value for the best experience.

This feature allows sending an update request for the device, then waiting for the wait time and then only asking about the clients. So in some cases, it might require more time, especially if there are 100 clients connected.

At the same time, this feature might be not required for some devices that already update the list of clients properly.

Vaskivskyi · December 24, 2023, 1:03pm

Happy Holidays

0.26.0 Clients tracking & multiple instances improvements

2023-12-24

→ GitHub release ←

Features

Improved client status detection (partially fixes #570)

Bug fixes

Fixed issue with data mix in cache when multiple instances are used (report #690)

Dependencies

Bumped asusrouter library to 1.5.0

Support AsusRouter

Monetary support:

Buy Me a Coffee
Buy a new Asus device via Amazon Associate links (usage of the associate links does not change the price of the items for you)

Non-monetary support:

Star AsusRouter integration repository
Star AsusRouter Python library repository
Know a person with an Asus device using Home Assistant but not AsusRouter? Let them know, AsusRouter is cool and has lots of useful features

Vaskivskyi · December 31, 2023, 11:15am

Happy New Year

And a couple of announcements of what’s coming soon:

Aura support
AiMesh direct nodes control (through your main router and without a need to setup each node separately)
Support for SFPP and MoCA ports

… and many more

0.27.0 Parental control & clients stability

2023-12-31

→ GitHub release ←

Features

Added service device_internet_access to control the device internet access (via parental control rules)
Added block_internet switches for the devices with parental control rules (report #622)
Added possibility to create HA devices for clients when creating their entities (optional, disabled by default)
Added global block_internet switch to block internet access for all the devices
Added remove_trackers service to release old device_tracker entities and get a possibility to remove them (report #729)
Added support for services translation
Added support for ports speeds (LAN / WAN): 10 Mb/s, 5 Gb/s, 10 Gb/s
Added support for ports speeds (USB): 480 Mb/s, 5 Gb/s, 10 Gb/s, 20 Gb/s
Updated device model to correspond to the UI Model Name (name as shown in the Web UI) (report #578)

Bug fixes

Fixed extra sensors shown when they should not be available for the selected operation mode
Fixed issue on the client status detection when AiMesh is supported but no nodes assigned
Fixed issue with clients data mix
Fixed issue with session not available error for the last requests when restarting the integration

Translations

Added Ukrainian translation for device_internet_access and remove_trackers services

Dependencies

Bumped asusrouter library to 1.6.0, 1.6.1

Documentation

Confirmed support for the new device
- GT-AX11000 Pro / 388.24198
- RT-AX88U Pro / 388.4_0 (Merlin)
- Zen WiFi ET8 / 388.23759
- Zen WiFi Pro ET12 / 388.23013
Confirmed support for the new FW versions which were not reported before:
- 4G-AX55U / 380.8102
- GT-AX11000 / 388.4_0 (Merlin)
- RT-AC88U / 386.12_2
- RT-AX55 / 386.52041
- RT-AX56U / 388.1_0 (Merlin), 388.2_2 (Merlin)
- RT-AX58U / 388.4_0 (Merlin)
- RT-AX86U / 388.4_0 (Merlin)
- TUF-AX5400 / 388.23285, 388.4_0 (Merlin)

Images and some details

Device internet control

Please, welcome back a refreshed service for parental control rules. You can use the HA GUI to set rules for multiple entities (by selecting corresponding device trackers)

Using YAML mode, you can provide your own list of devices by their MAC addresses (and optionally names)

P.S. You can also now set rules for both entities and custom devices at the same time

P.P.S. Yes, you can set only a single state at once, but to many devices.

Internet block switches

New switches are now available for parental control rules - {device}_block_internet. And I hope that they are working the way you would expect - when set to On - block is set (so the device is blocked from the internet).

The new switches are much easier to use in UI or for automation so that you can save a bit on your automation YAML code. Moreover, you would now be able to watch the rule state directly instead of searching for the correct MAC address in the full list of rules.

If the rule is removed, the entity will become unavailable and you can remove it from HA. New entities will be created automatically when new rules are added.

Please, note, that if added/removed from HA service, entities should change state immediately. If done from the router itself (outside of HA), you would need to wait till the next sensors refresh (30 s as default)

Optional creation of devices for clients (when any entity is created for them)

Configurable / Default: disabled

Using a new option in the configurations (Configure / Connected devices / Create HA devices) you can allow integration to create client devices when creating any entities for them. This feature is disabled by default. If you would like to use it, enable it.

All the client devices can be removed from HA by the user. Please, keep in mind, that devices will be recreated if any new entity is created. This is a feature to remove devices with no available entities.

Support AsusRouter

Monetary support:

Buy Me a Coffee
Buy a new Asus device via Amazon Associate links (usage of the associate links does not change the price of the items for you)

Non-monetary support:

Star AsusRouter integration repository
Star AsusRouter Python library repository
Know a person with an Asus device using Home Assistant but not AsusRouter? Let them know, AsusRouter is cool and has lots of useful features

By the way, you might also be interested in:

Chroma integration for your Razer Chroma-compatible LEDs

poudenes · December 31, 2023, 12:01pm

I have a

switch.gt_ax11000_block_internet

Does this mean that I block ALL internet or do I enable the option to block internet for devices that had been added for blocking to internet?

Vaskivskyi · December 31, 2023, 12:18pm

@poudenes,

it will block internet connection for all the devices connected through this router. This is the full analogue to this switch in the Web UI

For separate clients (even if for all of them), you can either use per-client switch entities (e.g. combine them in a group) or the service call

Vaskivskyi · December 31, 2023, 7:36pm

0.27.1 Ignore wrong parental control rules

2023-12-31

→ GitHub release ←

Features

Added a check on parental control rules before adding them as entities (report #753)

Please, refer to the full release log for version `0.27.0` 3 messages up from here

automateitall · January 1, 2024, 5:08pm

I do not see any Asusrouter services in the dropdown when I go into Developer Tools/Services?

Are the switch entities for specific devices created when you create the parental control rule in HA GUI? If not, how are device specific switches created?

Vaskivskyi · January 1, 2024, 7:09pm

Hello, @automateitall,

The switch entities are directly linked to the parental control rules in the device settings. So if rules are set for the device, they will appear in HA. Also, if you use a service to add new rules directly in HA, they will be written to the device + switches in HA will be created.

As per the services, asusrouter.device_internet_access should be available if your device is configured as a Router.

In case, it does not work for you when configured as a router, please, open an issue.

It’s currently not available in other modes the same way as the other parental control features. In case, you would like to have it working, please, let me know. I don’t have direct access to any device set up as an Access Point or Media Bridge, so I don’t know which features can work for such devices. But I can work on it

In any case, you should see at least the service asusrouter.remove_trackers available for any HA configuration. If not, please, open an issue with details on your device and HA configs set for the integration

[Custom component] AsusRouter integration

Beta release!

Stable release to come this weekend

0.25.0b0 Force clients update

→ GitHub release ←

Features

Other changes

Dependencies

Beta release!

0.25.0b1 Fixes

→ GitHub release ←

Bug fixes

Dependencies

Release delays

Stable release

Support AsusRouter

0.25.0 Force clients update & more

→ GitHub release ←

Features

Bug fixes

Other changes

Dependencies

Support AsusRouter

Happy Holidays

0.26.0 Clients tracking & multiple instances improvements

→ GitHub release ←

Features

Bug fixes

Dependencies

Support AsusRouter

Happy New Year

0.27.0 Parental control & clients stability

→ GitHub release ←

Features

Bug fixes

Translations

Dependencies

Documentation

Images and some details

Device internet control

Internet block switches

Optional creation of devices for clients (when any entity is created for them)

Support AsusRouter

0.27.1 Ignore wrong parental control rules

→ GitHub release ←

Features

Please, refer to the full release log for version 0.27.0 3 messages up from here

Please, refer to the full release log for version `0.27.0` 3 messages up from here