UPnP/IGD
The upnp integration enables you to collect network statistics from your router such as bytes in/out and packets in/out, uptime, WAN IP address, and WAN connectivity status. This information is provided by the UPnP/Internet Gateway Device (IGD) Protocol if enabled on your router.
There is currently support for the following device types within Home Assistant:
- Binary Sensor - If router is connected to the WAN.
- Sensor - Allows to get the network statistics from your router such as bytes in/out and packets in/out, uptime, status, and IP. Sensor for uptime will only be there if supported by the router.
Please note that UPnP or NAT-PMP needs to be enabled on your router for this integration to work.
Configuration
Adding UPnP/IGD to your Home Assistant instance can be done via the user interface, by using this My button:
UPnP/IGD can be auto-discovered by Home Assistant. If an instance was found, it will be shown as “Discovered”, which you can select to set it up right away.
If there wasn’t any discovered automatically, don’t worry! You can set up a manual integration entry:
-
Browse to your Home Assistant instance.
-
In the sidebar click on Settings.
-
From the configuration menu select: Devices & Services.
-
In the bottom right, click on the Add Integration button.
-
From the list, search and select “UPnP/IGD”.
-
Follow the instruction on screen to complete the set up.
Debugging integration
If you have problems with this integration you can add debug prints to the log.
logger:
default: info
logs:
homeassistant.components.upnp: debug
async_upnp_client: debug
async_upnp_client.traffic: error
When creating an issue, please include the (relevant) logging with the issue. Any sensitive information such as IPs can be obfuscated.