Ce plugin permet de monitorer et exécuter quelques actions sur un controleur UniFi Network et les équipements supportés par celui-ci.

Configuration du plugin

Après installation du plugin, il vous suffit de l’activer. Il faut ensuite rentrer les informations de votre controleur dans la configuration.

Controleur Unifi : Indiquez l’adresse ip et le port (normalement 8443 ou 443 si UDM) de votre controleur Unifi
Utilisateur Unifi : Indiquez l’utilisateur du controleur (Attention: pas celui du cloud ! Un utilisateur Local avec les droits Super Admin)
Mot de passe Unifi : Indiquez votre mot de passe controleur
Site Unifi : si vous avez plusieurs sites, indique lequel le plugin doit gérer (default par défaut). Le nom correspond au nom dans l’url du site controleur, exemple : https://ip:8443/manage/default/dashboard

Attention, beaucoup se trompent ici, il faut bien indiquer default et pas l’url du controleur !!!!
Bouton Rechercher les équipements Unifi : Permet de scanner les équipements sur le controleur
Pièce par défaut pour les Clients : Lors du scan, les nouveaux clients wifi/cablés peuvent être ajoutés par défaut à une pièce.
Bouton Ne plus ignorer les clients supprimés : Permet de montrer à nouveau les clients que vous auriez supprimés et ignorés dans la liste des équipements.
Relevé Site et WLAN (secondes) : Fréquence en secondes à laquelle le relevé des informations du Site et des WLANs doivent être fait. Les autres mises à jour sont envoyées par le controleur en temps réel, malheureusement pas les informations du site et des wlans. Le plugin doit donc les consulter régulièrement. Si les informations sont modifiées via le plugin (LED’s ou désactiver un WLAN), elles sont mises à jour instantanément, mais si vous modifiez ces informations via l’interface UniFi ou un autre moyen, c’est ici que cette consultation régulière rentre en jeu. (60 secondes par défaut). Pas besoin de relancer le démon après ce changement, il est directement pris en compte :)
Ignorer les évênements Last_Seen sur les Clients : le controleur envoi régulièrement des mises à jour des clients, surtout pour l’information Last_Seen (vu dernièrement). En ignorant cette information (si elle n’est pas importante pour vous), vous allégez les mises à jour des équipements clients activés, et donc vous allégez la charge de votre Jeedom. Pas besoin de relancer le démon après ce changement, il est directement pris en compte :)
Ignorer les évênements Satisfaction sur les Clients : le controleur envoi régulièrement des mises à jour des clients, surtout pour l’information Satisfaction. En ignorant cette information (si elle n’est pas importante pour vous), vous allégez les mises à jour des équipements clients activés, et donc vous allégez la charge de votre Jeedom. Pas besoin de relancer le démon après ce changement, il est directement pris en compte :)
Ignorer les évênements Uptime sur les Clients : le controleur envoi régulièrement des mises à jour des clients, surtout pour l’information Uptime. En ignorant cette information (si elle n’est pas importante pour vous), vous allégez les mises à jour des équipements clients activés, et donc vous allégez la charge de votre Jeedom. Pas besoin de relancer le démon après ce changement, il est directement pris en compte :)
Ignorer les évênements Up et Down sur les Clients : le controleur envoi régulièrement des mises à jour des clients, surtout pour les informations UP et DOWN. En ignorant cette information (si elle n’est pas importante pour vous), vous allégez les mises à jour des équipements clients activés, et donc vous allégez la charge de votre Jeedom. Pas besoin de relancer le démon après ce changement, il est directement pris en compte :)
Ignorer les évênements Signal sur les Clients : le controleur envoi régulièrement des mises à jour des clients, surtout pour l’information Signal. En ignorant cette information (si elle n’est pas importante pour vous), vous allégez les mises à jour des équipements clients activés, et donc vous allégez la charge de votre Jeedom. Pas besoin de relancer le démon après ce changement, il est directement pris en compte :)
Ignorer les évênements Powersave_Enabled sur les Clients : le controleur envoi régulièrement des mises à jour des clients, surtout pour l’information Powersave_Enabled. En ignorant cette information (si elle n’est pas importante pour vous), vous allégez les mises à jour des équipements clients activés, et donc vous allégez la charge de votre Jeedom. Pas besoin de relancer le démon après ce changement, il est directement pris en compte :)
Afficher les évènements bruts du controleur dans un log séparé (En Beta) : Permet d’envoyer tous les évènements reçus du controleur dans le log unifi_event (excepté les évènements Clients et Devices, il deviendrait illisible !). Cela vous permet de voir les évènements reçus (et connaitre leurs champs) pour les ajouter dans les Automatisation Evènements sur l’équipement Site. Pas besoin de relancer le démon après ce changement, il est directement pris en compte :)
Bouton Réparation de NodeJS : Ce bouton permet de réparer NodeJS sur votre système (désinstallation complête et réinstallation propre). Il n’est conseillé de le faire que sur conseil via le forum ou en dernier recours.

Configuration des équipements

La configuration des équipements Unifi est accessible à partir du menu plugins puis Monitoring. Vous retrouvez ici :

un bouton pour scanner votre controleur
un bouton pour afficher la configuration du plugin
un bouton qui vous donne une vue d’ensemble de tous vos équipements et leur état.
enfin en dessous vous retrouvez la liste de vos équipements par catégories
- A coté de chaque titre de catégories, vous pouvez lancer le scan sur ce type uniquement
- A coté du titre des Clients, vous pouvez cliquer sur la poubelle pour supprimer les Clients (uniquement dans jeedom) qui sont en non-actif (où la case Actif n’est pas cochée) et les ignorer lors des prochains scans (pour ne plus les ignorer, Configuration du plugin > Bouton “Ne plus ignorer les clients supprimés”)

Equipement

En cliquant sur un de vos équipements vous arrivez sur la page configuration de votre équipement comprenant 2 onglets, équipement et commandes.

Onglet Equipement

Nom de l’équipement : nom de votre équipement
Objet parent : indique l’objet parent auquel appartient l’équipement
Activer : permet de rendre votre équipement actif
Visible : le rend visible sur le dashboard
Catégorie : catégorie (couleur) de l’équipement sur le dashboard
Commentaire : permet d’écrire un commentaire sur l’équipement.
Informations diverses : plusieurs informations sur l’équipement sont affichées.

Onglet Commandes

Il existe de nombreuses commandes, elles sont différentes en fonction du type d’équipement. Toutes ne sont pas affichées par défaut. Vous pouvez les renommer, les afficher ou non et les réorganiser.
La valeur des commandes est maintenant affiché et modifié en temps réel sur cette page Vous pouvez aussi attribuer un widget au choix. Tout est standard.

Automatisations Évènements (En Beta)

Il s’agit d’une nouvelle fonctionnalité qui vous permet de traiter vous-même les évènements bruts reçus du controleur. Il faut vous rendre dans l’équipement Site, onglet Automatisations Évènements.

Grâce au log unifi_event activable dans la configuration du plugin (voir plus haut), vous pouvez voir par exemple cet évènement :

evt_wg_connected :
{
    "guest": "ab:cd:ef:ab:cd:ef",
    "ssid": "Guest",
    "ap": "bb:cc:dd:ee:ff:aa",
    "radio": "ng",
    "channel": "11",
    "ap_model": "U7PG2",
    "ap_name": "APRez",
    "ap_displayName": "APRez",
    "key": "EVT_WG_Connected",
    "subsystem": "wlan",
    "is_negative": false,
    "site_id": "153457853a5b2542257785c2",
    "time": "1704652201104",
    "datetime": "2023-01-15T13:15:04Z",
    "msg": "Guest[ab:cd:ef:ab:cd:ef] has connected to AP[bb:cc:dd:ee:ff:aa] with SSID \"Guest\" on \"channel 11(ng)\"",
    "_id": "554c142be4b7bd788697c2a5"
}

C’est un évènement w = wifi, g = guest qui se connecte à votre réseau.

TIPS : Première lettre est la source : l = lan ou w = wifi / seconde lettre est le type : g = guest, u = user ou c = client. Vous pouvez aussi y trouver ad = interface admin, hs = hotspot, gw = gateway, sw = switch et ap = access point. (il y en a peut-être d’autres ?)

Le plugin vous permet d’utiliser chaque champ de premier niveau comme un tag dans une commande ou à envoyer à un scénario. Ici donc vous pourriez utiliser #guest# pour l’adresse mac de l’invité, #ap_name# pour le nom du point d’accès où il se connecte ou encore #time# pour recevoir le datetime unix de la connexion (et tous les autres champs ! Attention cependant à msg qui contient des guillemets qui peuvent être mal interpretées parfois…). Le plugin vous permet également d’envoyer tout l’évènement en json avec le tag #event#.

Ce tag #event# est aussi utile pour les évènements de type Device ou Client, car ils ont plusieurs niveaux dans le json, il est donc impossible de faire des tags qui dépassent le premier niveau pour ces évènements !.

Les évènements “Device” ou “Client” ne font pas partie du log unifi_event car il y en a beaucoup et souvent et ça le rendrait illisible, vous pouvez les voir si vous passez le log en debug dans le log unifi_deamon après le démarrage du démon.

Les évènements “Client : Mise à jour” font augmenter la charge de jeedom, car à partir du moment où vous l’ajoutez, le démon va envoyer tous les changements client à jeedom (donc dès qu’une vitesse change ou un last_seen !!). Et ce, même si vous avez décoché ces commandes dans la configuration du plugin!!! Préfèrez-lui l’évènement “Client Activé dans Jeedom : Mise à jour (sync.generic)” qui n’enverra que les évènements des clients activés dans Jeedom et prendra en compte les commandes ignorées de la configuration du plugin.

Exemple

Pour le champ msg, vous pouvez passer par une variable qui supporte beaucoup mieux le contenu JSON et les guillemets

Astuces & FAQ

Pour lancer un scan dans un scénario, via un bloc code, vous pouvez lancer : unifi::syncUnifi();
Pour la gestion des présences, assurez vous d’avoir coché ceci dans le contrôleur :

Evidemment le websocket doit aussi être activé :

Vérifiez que ceci est bien en Always (mieux) ou en Automatique (Mais du coup si congestion réseau, vous n’aurez plus de mises à jour des périphériques, mieux ou moins bien, à vous de voir)

Eviter les noms en doublon du coté du controleur Unifi :

Pensez à avoir des noms d’équipements différents sinon vous pourriez rencontrer une erreur du type “[MySQL] Error code : 23000 (1062). Duplicate entry ‘[NOM DE L EQUIPEMENT EN DOUBLE]’ for key ‘unique’ : …” dans Jeedom lorsque vous faites un scan des équipements.

Ce cas, peut être également rencontré lorsque vous avez un équipement qui peut etre connecté de plusieurs façons différentes à votre réseau. Par exemple avec un PC portable a généralement une inerface réseau filaire (ethernet) et une autre sans-fil (wifi). Par défaut, ce dernier peut apparaitre avec le même nom dans le controleur Unifi et causer l’erreur décrite ci-dessus dans Jeedom. Dans le controleur Unifi, ajoutez un suffixe afin de les différencier (ex: ethernet ou wifi) et relancer un scan coté Jeedom.