Transférer des données vers un broker MQTT

✓ EnergieID pour les entreprises

Avec le transfert de données MQTT, vous pouvez transférer automatiquement les données d'EnergieID vers un broker MQTT externe. Vous pouvez ainsi utiliser ces données dans votre propre environnement, par exemple dans des applications internes, des automatisations ou d'autres intégrations.

Consultez d'abord la brève introduction sur mqtt.org.

Vous souhaitez développer une intégration technique ? Vous recherchez la structure exacte de la charge utile (payload) et les définitions des API ? Consultez immédiatement le modèle de données et format de charge utile pour l'export MQTT.

Activer le transfert de données MQTT

  • Dans votre Espace de travail (Workspace), allez dans Configuration.
  • Ouvrez la fonction Transfert de données MQTT.
  • Ajoutez au moins un broker et remplissez les paramètres.
  • Cliquez sur Enregistrer.

Seuls les administrateurs de l'Espace de travail peuvent enregistrer cette configuration.

Configurer un broker MQTT

Vous pouvez ajouter un ou plusieurs brokers. Chaque broker possède ses propres données de connexion, sa sélection de données et sa structure de topics.

Données de connexion

Remplissez les informations de votre broker MQTT :

  • URL du broker : l'endpoint de votre broker, par exemple mqtt://broker.example.com:1883 ou mqtts://broker.example.com:8883.
  • Nom d'utilisateur : le nom d'utilisateur avec lequel EnergieID se connecte au broker.
  • Mot de passe : le mot de passe associé à ce nom d'utilisateur.
    • Pour un broker existant, vous pouvez laisser ce champ vide pour conserver le mot de passe enregistré.
    • Pour un nouveau broker, ce champ est obligatoire.

Choisir les données à transférer

Vous pouvez choisir par broker les données qu'EnergieID publie.

Valeurs de mesure traitées

Activez cette option pour transférer les valeurs de mesure traitées pour les dossiers de votre Espace de travail.

Les données sont publiées dès qu'elles sont traitées dans EnergieID. Par exemple, lorsqu'une intégration récupère et traite des données lors d'une synchronisation nocturne, celles-ci sont ensuite transférées automatiquement. Les intégrations qui fournissent des données en continu sont généralement traitées et publiées presque immédiatement.

Données d'appareils en temps réel

Activez cette option pour transférer les données d'appareils en temps réel.

Cette option s'applique uniquement aux intégrations qui fournissent elles-mêmes des données d'appareils en temps réel à EnergieID.

Attention : Vous devez activer au moins l'une des deux options. Si les deux options sont désactivées, vous ne pourrez pas enregistrer la configuration.

Définir la structure des topics MQTT

Vous définissez, pour chaque type de données, le topic MQTT vers lequel EnergieID publie les messages.

Structure du sujet (Topic Path) MQTT pour les valeurs de mesure

Par défaut :

energyid/workspace/{{workspaceId}}/record/{{recordNumber}}/meter/{{meterId}}
Structure du sujet (Topic Path) MQTT pour les données d'appareils

Par défaut :

energyid/workspace/{{workspaceId}}/record/{{recordNumber}}/device/{{twinId}}

Les espaces réservés (placeholders) sont automatiquement remplacés lorsqu'EnergieID publie un message. Vous trouverez tous les espaces réservés disponibles dans les modèles d'exemple. Vous n'êtes pas obligé d'utiliser des espaces réservés.

Confirmer la conformité au RGPD et la confidentialité

Pour chaque broker MQTT, vous devez confirmer qu'il existe une base légale valide pour le partage des données avec le ou les abonnés MQTT.

Sans cette confirmation, vous ne pouvez pas enregistrer la configuration du broker.

En pratique, cela signifie au minimum que votre traitement est conforme au RGPD (Règlement (UE) 2016/679), incluant notamment :

  • une base légale valide pour le traitement (RGPD, article 6),
  • un accord de traitement des données (DPA) lorsque l'exploitant du broker agit en tant que sous-traitant (RGPD, article 28),
  • la transparence envers les personnes concernées concernant la transmission à des tiers (RGPD, articles 13 et 14).

Selon votre configuration, des règles supplémentaires peuvent s'appliquer (par exemple, des obligations sectorielles ou des règles nationales de mise en œuvre au sein de l'UE/EEE).

Que se passe-t-il en cas d'échec de la publication vers un broker ?

Validation lors de l'enregistrement

En cas de configuration incomplète, vous recevrez un message de validation, par exemple lorsque :

  • aucun broker n'a été ajouté ;
  • un champ obligatoire est manquant ;
  • aucune donnée n'a été sélectionnée pour le transfert ;
  • la confirmation concernant la conformité au RGPD et la confidentialité est manquante.

Erreur de transfert de données

Lorsque les données ne peuvent pas être publiées vers un broker MQTT, un message Erreur de livraison apparaît à côté de ce broker.

Cliquez sur le message pour plus d'informations. Vous y verrez notamment :

  • l'heure de la dernière erreur en date ;
  • le message d'erreur technique de la connexion ou de la publication.

Les administrateurs de l'Espace de travail reçoivent également un message dans le centre de messagerie lors de la première erreur pour un broker.

Les modifications apportées aux paramètres MQTT peuvent prendre jusqu'15 minutes pour être effectives, car les paramètres du broker sont mis en cache. Si la publication échoue pendant cette période, EnergieID actualise la configuration du broker mise en cache et réessaie automatiquement.

Attention : lorsque vous réenregistrez les paramètres MQTT, le dernier message d'erreur connu est effacé. Pensez donc à vérifier les détails de l'erreur avant de réenregistrer la configuration.

Formats de données complets

Cette page décrit les paramètres et les messages d'erreur. La structure exacte des messages MQTT pour les valeurs de mesure et les données d'appareils, y compris des exemples de messages et la description des champs, se trouve sur une page technique séparée :

Modèle de données et format de charge utile pour le transfert de données MQTT

Foire aux questions (FAQ)

Puis-je configurer plusieurs brokers MQTT ?

Oui. Vous pouvez ajouter plusieurs brokers. Chaque broker possède ses propres données de connexion, ses données sélectionnées et sa structure de topics.

Dois-je saisir à nouveau mon mot de passe lorsque je modifie un broker ?

Non. Pour un broker existant, vous pouvez laisser le champ du mot de passe vide pour conserver le mot de passe actuel.

Pourquoi ne reçois-je aucun message ?

Vérifiez :

  • si le broker est correctement configuré ;
  • si au moins un type de données a été sélectionné ;
  • si l'URL du broker et les identifiants d'accès sont corrects ;
  • si l'utilisateur MQTT dispose de droits suffisants ;
  • si une Erreur de livraison s'affiche pour le broker.