Skip to main content

UPnP / IGD integration for Gladys Assistant

UPnP / IGD integration for Gladys Assistant

Expose your internet box WAN link state and traffic counters over UPnP/IGD.

View on GitHubAll external integrations

Overview​

This integration connects Gladys Assistant to your internet box / router through the UPnP-IGD (Internet Gateway Device) protocol that almost every home box exposes on the local network. It turns your box into a Gladys device whose read-only features let you graph its traffic, chart your line and trigger scenes on the WAN link state (for example, be notified when your connection drops).

Discovery​

The integration finds your box automatically using an SSDP network scan run by the Gladys core. Open the Gladys Discovery screen and your box appears — add it, and it starts reporting.

If auto-discovery finds nothing (some boxes disable UPnP, or the scan cannot reach them), you can fill in the optional Box description URL setting with your box's UPnP device description URL (something like http://192.168.1.1:5000/rootDesc.xml) and run Discovery again.

Features​

Each box exposes these read-only features:

  • Connection status — whether the WAN link is up or down;
  • External IP — your public internet IP address;
  • Uptime — how long the internet connection has been up (seconds);
  • Bytes sent / Bytes received — total traffic counters;
  • Packets sent / Packets received — total packet counters.

Notes​

  • The byte and packet counters come straight from the box's IGD service. On many boxes these counters are 32-bit and wrap back to zero at ~4 GB — the raw value is reported as-is, so expect the graph to reset periodically on those boxes.
  • Nothing is controllable: a box exposes only statistics over IGD, so every feature is read-only.
  • UPnP/IGD must be enabled on your box (it usually is by default).

Configuration settings​

These are the settings UPnP / IGD asks for in its configuration screen in Gladys.

SettingTypeRequiredDescription
Box description URL (optional)stringNoOnly needed if automatic discovery finds nothing: the UPnP device description URL of your box.

How to install UPnP / IGD in Gladys​

  1. In Gladys, open Integrations: UPnP / IGD appears in the catalog, next to the native integrations, with a community badge.
  2. Click Install. Gladys pulls the Docker image (ghcr.io/callemand/gladys-upnp-igd:1.0.0), starts it in a sandbox isolated from the core, and generates the integration's interface (devices, discovery and configuration).
  3. Open the Configuration screen of the integration, fill in the settings, and save.
  4. You can also install it directly from its repository URL: https://github.com/callemand/gladys-upnp-igd.

UPnP / IGD requires Gladys >=4.84.0. The catalog inside Gladys refreshes every hour, so a new version becomes available at most one hour after its release.

Not running Gladys yet? It is free and open source: follow the installation guide to get started.

About external integrations​

UPnP / IGD is an external integration: a community integration packaged as a Docker container and published on GitHub, that Gladys installs in one click and runs in a sandbox isolated from its core. It is published and maintained by callemand, not by the Gladys core team.

Subscribe to the Gladys Assistant newsletter

A few emails per month about new releases and project news. Sent by Pierre-Gilles Leymarie, founder of the project. Unsubscribe anytime 🙂
Last updated on