Comment créer une Passerelle MQTT ?

Cet article explique comment créer une passerelle MQTT.

La passerelle MQTT permet l'acquisition de données directement depuis une Box Tower/Bridge vers votre broker MQTT. Les broker MQTT possibles incluent AWS, Azure, IBM ou un broker personnalisé.
 

Configuration de la passerelle MQTT

CONDITIONS REQUISES POUR CONNECTER VOTRE BOX À VOTRE BROKER MQTT

Vous aurez besoin des informations de connexion de votre broker MQTT :

1. Adresse du broker
2. Port MQTT (1883,8883, etc.)
3. Client ID
4. Informations d'authentification (si nécessaire)
5. Certificat (si requis)

Ces informations devraient être disponibles dans la configuration de votre Broker, sinon veuillez contacter votre fournisseur Broker.
Tout d'abord, vous devrez créer une nouvelle passerelle MQTT (Onglet Configuration / Passerelles / Créer une nouvelle passerelle)

Remplissez les champs obligatoires avec les paramètres de votre broker MQTT.

AUTHENTIFICATION

Si votre broker MQTT nécessite une authentification avec nom d'utilisateur et mot de passe, cliquez sur le bouton Authentification et remplissez les champs.

CERTIFICAT TLS :

 

INFORMATIONS IMPORTANTES SUR LA SÉCURITÉ DANS MQTT SSL/TLS : Le port par défaut pour la connexion MQTT TLS est : 8883 Cela implique une connexion utilisant des certificats. Les certificats sont des fichiers de sécurité qui vous permettent de vous authentifier auprès de votre broker. Si vous utilisez une authentification sécurisée TLS, assurez-vous d'avoir chargé votre certificat CA.

 

CONSEILS Il peut arriver que votre broker n'utilise pas un certificat CA personnalisé mais un certificat public. Dans ce cas, vous devrez quand même les charger dans la Box. Parce que nous ne les stockons pas par défaut.

Sachant cela, vous pouvez désormais cliquer sur la case TLS si vous devez spécifier tout type de certificats.

ONGLET AVANCÉ

Dans cet onglet avancé, le champ le plus important est le nom du Slug
Un Slug est le champ qui permettra d'identifier une propriété lorsque vous la recevrez chez votre broker.

TOPICS :

Le topic d'uplink et le topic de downlink sont de simples chaînes conformes à un ou plusieurs niveaux de topic. Par exemple, les topics sont sensibles à la casse.
Chaque topic est structuré avec un slash comme délimiteur. Le slash seul est un topic valide.
Le broker utilise les topics pour filtrer les messages pour chaque client abonné au topic.

UPLINK TOPICS

Une nouvelle fonctionnalité (disponible depuis le firmware APPS 6.1.3) permet de personnaliser le format Uplink Topic (par équipement ou par propriété) afin de publier les données vers un logiciel de surveillance/contrôle.
La structure des uplinks topics MQTT peut être définie en fonction de vos besoins, à l'aide de variables et de chaînes. Cette structure générera des topics MQTT pour chaque propriété redirigée.

Les variables suivantes peuvent être combinées dans la structure du topic d'uplink :

1. nom de l'équipement
2. ID d'équipement
3. nom de la propriété
4. ID de propriété
5. ID de passerelle

Cette fonctionnalité a été ajoutée afin d'éviter d'utiliser des slugs pour regrouper les données. Lorsque vous utilisiez des slugs, vous deviez disposer d'un script dans votre courtier MQTT pour analyser le message et accéder au slug, puis agréger les données.

Ainsi, vous pouvez construire la structure du topic à votre convenance en mélangeant textes simples / ID Equipements / ID Propriétés…

DOWNLINK TOPICS

Depuis la version du firmware APPS 6.1.3, vous pouvez ajouter un caractère générique (#) dans les paramètres de downlink topic. Ce caractère générique à plusieurs niveaux (#) couvre plusieurs niveaux de sujet et doit être placé à la fin du format du topic.

Lorsqu'un topic downlink se termine par /#, elle reçoit tous les messages commençant par le texte précédant le caractère générique. Si le sujet est uniquement "#", le client reçoit tous les messages.

Exemple : Si le format du topic downlink est

Pièce1 / Capteur1 / #

Messages envoyés au broker MQTT :

FORMAT

Voici le format des données que vous recevrez :

Uplink Topic Format :

[{"propertyId": "Nom du slug", "timestamp": 1608652394220.0, "value": 12}, 
 {"propertyId": "Nom du slug", "timestamp": 1608652394222.0, "value": 123456}]

Voici le format que votre broker MQTT doit respecter pour envoyer une commande :
Downlink Topic Format :

{"propertyId": "Nom du slug", "requestType": "write", "value": XX}

Il définira quelle sera la valeur du champ PropertyId de chacune de vos futures propriétés de passerelle.
Par défaut, ce sera Protocol et Property Slug

Exemple :
Si nous avons un capteur Lorawan avec une propriété de température, le Slug serait :
"propertyId" : "Lorawan-MyUniqueSlug1234"

NOTE Property Slug est l'ID unique d'une variable, vous le trouverez dans la configuration de la propriété elle-même Veuillez noter que vos modifications seront appliquées à TOUTES les propriétés de la passerelle.

 

Configuration des propriétés de la passerelle MQTT

Pour ajouter des propriétés à votre passerelle, sélectionnez le bouton Propriétés :

Ajoutez ensuite la propriété :

Sur la vue suivante vous aurez le choix entre toutes les propriétés disponibles, sélectionnez celle que vous souhaitez rediriger vers votre broker MQTT et cliquez sur Enregistrer

 

Une fois les propriétés sélectionnées, vous aurez ce genre de fenêtre :

 

Cliquez sur "Enregistrer les modifications" pour appliquer les modifications.

Assurez-vous que le type d'accès reste comme LOCAL dans cette configuration.

 

Si vous avez besoin d'informations complémentaires, veuillez nous contacter : ici