UPnP/IGD
The UPnP/IGD integrationIntegrations connect and integrate Home Assistant with your devices, services, and more.
[Learn more] 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 integrationIntegrations connect and integrate Home Assistant with your devices, services, and more.
[Learn more] to work.
Configuration
To add the UPnP/IGD integration to your Home Assistant instance, use this My button:
UPnP/IGD can be auto-discovered by Home Assistant. If an instance was found, it will be shown as Discovered. You can then set it up right away.
If it wasn’t discovered automatically, don’t worry! You can set up a manual integration entry:
-
Browse to your Home Assistant instance.
-
In the bottom right corner, select the Add Integration button.
-
From the list, select UPnP/IGD.
-
Follow the instructions on screen to complete the setup.
Debugging integration
If you have problems with this integrationIntegrations connect and integrate Home Assistant with your devices, services, and more.
[Learn more] 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.