API MQTT pour la communication entre les différents composants du système Viginet.
Politique MQTT:
- QoS 0 pour toutes les publications et les abonnements
- retain actif uniquement pour certains statuts publiés par Viginet (/s/l, /s/a, /s/f) ainsi que pour le Last Will sur /s/l.
Adresse du broker MQTT
Port du broker MQTT
Canal de mise à jour des états des appareils (tous les équipements)
Demande de mise à jour des états (tous les équipements)
Available only on servers:
ID du device
Accepts the following message:
Message de demande de mise à jour
Trames sans payload JSON obligatoire.
{}
Canal de mise à jour des états des appareils (par groupe ou équipement unique)
Demande de mise à jour des états (destination group/device)
Available only on servers:
ID du device
Type de destination (g=group, d=device)
Identifiant de destination (groupId si destination=g, deviceId si destination=d)
Accepts the following message:
Message de demande de mise à jour
Trames sans payload JSON obligatoire.
{}
Canal d'exécution d'actions - activation (tous les équipements)
Demande d'activation d'action (tous les équipements)
Available only on servers:
ID du device émetteur
Accepts the following message:
Message de demande d'activation d'une action
Obligatoire. Paramètres d'activation d'action.
{
"i": 0,
"f": [
0
],
"r": 0,
"a": 0
}
Canal d'exécution d'actions - activation (par groupe ou équipement unique)
Demande d'activation d'action (destination group/device)
Available only on servers:
ID du device émetteur
Type de destination (g=group, d=device)
Identifiant de destination (groupId si destination=g, deviceId si destination=d)
Accepts the following message:
Message de demande d'activation d'une action
Obligatoire. Paramètres d'activation d'action.
{
"i": 0,
"f": [
0
],
"r": 0,
"a": 0
}
Canal d'exécution d'actions - désactivation (tous les équipements)
Demande de désactivation d'action (tous les équipements)
Available only on servers:
ID du device émetteur
Accepts the following message:
Message de demande de désactivation d'une action
Optionnel. Paramètres de désactivation d'action.
{
"i": 0
}
Canal d'exécution d'actions - désactivation (par groupe ou équipement unique)
Demande de désactivation d'action (destination group/device)
Available only on servers:
ID du device émetteur
Type de destination (g=group, d=device)
Identifiant de destination (groupId si destination=g, deviceId si destination=d)
Accepts the following message:
Message de demande de désactivation d'une action
Optionnel. Paramètres de désactivation d'action.
{
"i": 0
}
Canal d'exécution d'actions - test HP (tous les équipements)
Demande de test d'action (tous les équipements)
Available only on servers:
ID du device émetteur
Accepts the following message:
Message de demande de test d'une action
Trames sans payload JSON obligatoire.
{}
Canal d'exécution d'actions - test HP (par groupe ou équipement unique)
Demande de test d'action (destination group/device)
Available only on servers:
ID du device émetteur
Type de destination (g=group, d=device)
Identifiant de destination (groupId si destination=g, deviceId si destination=d)
Accepts the following message:
Message de demande de test d'une action
Trames sans payload JSON obligatoire.
{}
Canal de lecture des variables d'un device - Permet de demander les valeurs de variables spécifiques d'un ou plusieurs appareils (tous les équipements)
Demande de lecture des variables (tous les équipements)
Available only on servers:
ID du device émetteur de la requête
Liste des IDs de variables, séparées par des points-virgules
Accepts the following message:
Message de demande de lecture de données
Trames sans payload JSON obligatoire.
{}
Canal de lecture des variables d'un device - Permet de demander les valeurs de variables spécifiques d'un ou plusieurs appareils
Demande de lecture des variables (destination group/device)
Available only on servers:
ID du device émetteur de la requête
Type de destination (g=group, d=device)
Identifiant de destination (groupId si destination=g, deviceId si destination=d)
Liste des IDs de variables, séparées par des points-virgules
Accepts the following message:
Message de demande de lecture de données
Trames sans payload JSON obligatoire.
{}
Canal de statut de liaison
État de la liaison
Available only on servers:
ID du device
Accepts the following message:
État de la liaison entre devices
Obligatoire. État de liaison.
{
"c": false
}
Canal de statut d'action
État de l'action
Available only on servers:
ID du device
Accepts the following message:
État d'une action
Obligatoire. État d'action.
{
"e": false,
"t": 0
}
Canal de statut de défaut
État des défauts
Available only on servers:
ID du device
Accepts the following message:
État des défauts
La clé payload f contient les identifiants de défauts actifs. La correspondance des IDs par type d'équipement est définie dans api/mqtt-fault-catalog.yml (source : VIGINET-FAULTS.md).
Obligatoire. État des défauts.
{
"f": false,
"c1": 0,
"c2": 0
}
Canal de statut des variables
État des variables
Available only on servers:
ID du device
Liste des IDs de variables et de leur valeur (format variable:value), séparées par des points-virgules
Accepts the following message:
Valeurs des variables du système
Trames sans payload JSON obligatoire.
{}
Canal de masquage de défauts (tous les équipements)
Masquage de défauts (tous les équipements)
Available only on servers:
ID du device
Accepts the following message:
Demande de masquage de défauts
Obligatoire. Paramètres de la requête de masquage de défauts.
{
"i": [
0
],
"t": 1
}
Canal de masquage de défauts
Masquage de défauts (destination group/device)
Available only on servers:
ID du device
Type de destination (g=group, d=device)
Identifiant de destination (groupId si destination=g, deviceId si destination=d)
Accepts the following message:
Demande de masquage de défauts
Obligatoire. Paramètres de la requête de masquage de défauts.
{
"i": [
0
],
"t": 1
}
Message de demande de lecture de données
Trames sans payload JSON obligatoire.
Message de réponse à une demande de lecture de variables
Trames sans payload JSON obligatoire.
Message de demande de mise à jour
Trames sans payload JSON obligatoire.
Message de demande d'activation d'une action
Obligatoire. Paramètres d'activation d'action.
Message de demande de désactivation d'une action
Optionnel. Paramètres de désactivation d'action.
Message de demande de test d'une action
Trames sans payload JSON obligatoire.
État de la liaison entre devices
Obligatoire. État de liaison.
État d'une action
Obligatoire. État d'action.
État des défauts
La clé payload f contient les identifiants de défauts actifs. La correspondance des IDs par type d'équipement est définie dans api/mqtt-fault-catalog.yml (source : VIGINET-FAULTS.md).
Obligatoire. État des défauts.
Valeurs des variables du système
Trames sans payload JSON obligatoire.
Demande de masquage de défauts
Obligatoire. Paramètres de la requête de masquage de défauts.
Trames sans payload JSON obligatoire.
Trames sans payload JSON obligatoire.
Trames sans payload JSON obligatoire.
Obligatoire. Paramètres d'activation d'action.
Optionnel. Paramètres de désactivation d'action.
Trames sans payload JSON obligatoire.
Obligatoire. État de liaison.
Obligatoire. État d'action.
Obligatoire. État des défauts.
Trames sans payload JSON obligatoire.
Obligatoire. Paramètres de la requête de masquage de défauts.