UPnP/IGD


The upnp integration enables you to collect network statistics from your router such as bytes in/out and packets in/out. 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:

  • Sensor - Allows to get the network statistics from your router such as bytes in/out and packets in/out.

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:

Configuration Variables

local_ip string (Optional)

The local IP address of the computer running Home Assistant.

Default:

Try to auto-detect IP of host.

Troubleshooting

If Home Assistant is not able to discover the UPnP device, it may be because the local IP address of the computer running Home Assistant was not auto-detected correctly. To prevent this, you may add the local_ip option to your UPnP configuration:

# Example configuration.yaml with local_ip set
upnp:
  local_ip: 192.168.1.2