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.

Manual configuration steps

Manual configuration

Alternatively, you can use YAML by adding the following section to your configuration.yaml file:

# Example configuration.yaml entry
upnp: