Aller au contenu principal

Intégration UPnP / IGD pour Gladys Assistant

Intégration UPnP / IGD pour Gladys Assistant

Exposez l'état du lien WAN et les compteurs de trafic de votre box via UPnP/IGD.

Voir sur GitHubToutes les intégrations externes

Présentation​

Cette intégration connecte Gladys Assistant à votre box internet / routeur via le protocole UPnP-IGD (Internet Gateway Device) exposé par presque toutes les box domestiques sur le réseau local. Elle transforme votre box en un appareil Gladys dont les fonctionnalités, en lecture seule, permettent de grapher le trafic, de suivre l'état de la ligne et de déclencher des scènes sur l'état du lien WAN (par exemple être prévenu quand la connexion tombe).

Découverte​

L'intégration trouve votre box automatiquement grâce à un scan réseau SSDP lancé par le cœur de Gladys. Ouvrez l'écran Découverte de Gladys : votre box apparaît — ajoutez-la, et elle commence à remonter ses informations.

Si la découverte automatique ne trouve rien (certaines box désactivent l'UPnP, ou le scan ne peut pas les atteindre), renseignez le paramètre optionnel URL de description de la box avec l'URL de description UPnP de votre box (du type http://192.168.1.1:5000/rootDesc.xml) puis relancez la Découverte.

Fonctionnalités​

Chaque box expose ces fonctionnalités en lecture seule :

  • État de la connexion — le lien WAN est actif ou non ;
  • IP externe — votre adresse IP publique ;
  • Durée de connexion — depuis combien de temps la connexion est active (secondes) ;
  • Octets envoyés / Octets reçus — compteurs de trafic total ;
  • Paquets envoyés / Paquets reçus — compteurs de paquets total.

Remarques​

  • Les compteurs d'octets et de paquets proviennent directement du service IGD de la box. Sur beaucoup de box, ces compteurs sont codés sur 32 bits et reviennent à zéro vers ~4 Go — la valeur brute est remontée telle quelle, attendez-vous donc à voir le graphe se réinitialiser régulièrement sur ces box.
  • Rien n'est pilotable : une box n'expose que des statistiques via IGD, toutes les fonctionnalités sont donc en lecture seule.
  • L'UPnP/IGD doit être activé sur votre box (c'est généralement le cas par défaut).

Paramètres de configuration​

Voici les paramètres demandés par UPnP / IGD dans son écran de configuration dans Gladys.

ParamètreTypeObligatoireDescription
URL de description de la box (optionnel)stringNonNécessaire uniquement si la découverte automatique ne trouve rien : l'URL de description UPnP de votre box.

Comment installer UPnP / IGD dans Gladys​

  1. Dans Gladys, ouvrez Intégrations : UPnP / IGD apparaît dans le catalogue, aux côtés des intégrations natives, avec un badge communautaire.
  2. Cliquez sur Installer. Gladys télécharge l'image Docker (ghcr.io/callemand/gladys-upnp-igd:1.0.0), la démarre dans un bac à sable isolé du cœur, et génère l'interface de l'intégration (appareils, découverte et configuration).
  3. Ouvrez l'écran Configuration de l'intégration, remplissez les paramètres, puis enregistrez.
  4. Vous pouvez aussi l'installer directement depuis l'URL de son dépôt : https://github.com/callemand/gladys-upnp-igd.

UPnP / IGD nécessite Gladys >=4.84.0. Le catalogue dans Gladys se rafraîchit toutes les heures : une nouvelle version est donc disponible au plus tard une heure après sa sortie.

Vous n'utilisez pas encore Gladys ? C'est gratuit et open source : suivez le guide d'installation pour démarrer.

À propos des intégrations externes​

UPnP / IGD est une intégration externe : une intégration communautaire empaquetée dans un conteneur Docker et publiée sur GitHub, que Gladys installe en un clic et exécute dans un bac à sable isolé de son cœur. Elle est publiée et maintenue par callemand, et non par l'équipe cœur de Gladys.

Inscrivez-vous à la newsletter Gladys Assistant

Quelques emails par mois sur les nouveautés et l'actualité du projet. Envoyés par Pierre-Gilles Leymarie, le fondateur du projet. Désinscription possible à tout moment 🙂
Dernière mise à jour le