UPnP/IGD for Home Assistant (built-in integration)

About

UPnP/IGD is a built-in integration that reads status and traffic data from an internet gateway router over the local network. It adds a binary sensor for WAN status and sensors for data received and sent, download speed, packet speeds, packets received and sent, external IP address, and the number of IPv4 port mapping entries. Some speed sensors also come in a variant without rollover handling, which stands out for anyone comparing raw counter values. An option lets polling of all data be forced. Home Assistant can discover a compatible gateway on the network and offer to add it, and setup is done in the UI.

Automatic summary of Home Assistant's source code. Something wrong? Get in touch

Supports

Works locally Talks to your devices on your own network. No vendor cloud in between.
Set up in the UI Add it in Settings, Devices and services. Nothing to download.
Found by itself Home Assistant spots it on the network and offers to add it.
Updated with Home Assistant Ships and updates with every Home Assistant release.

Provides

Sensors

Setting it up

Home Assistant usually finds it on the network and offers to add it. It can also be added by hand under Settings, Devices and services.

Connect

Device

After setup

Force polling of all data

Texts from Home Assistant's source code, Apache License 2.0.

Entities

Binary sensorsWAN status
SensorsData received, Data sent, Download speed, Download speed (no rollover handling), External IP, Packet download speed, Packet download speed (no rollover handling), Packet upload speed, Packet upload speed (no rollover handling), Packets received, Packets sent, Number of port mapping entries (IPv4), and 4 more