Comment pouvons-nous aider ?

Print

Passerelle ACE-MQTT-4G : Fonctions du système

 

Dans le menu Passerelle > Configuration MQTT, vous pouvez définir certaines rubriques MQTT pour les fonctions du système.

Les 6 fonctions prédéfinies

  • Certificate_Update: Mise à jour à distance du certificat SSL/TLS
  • MQTT_Config_Update: Mise à jour à distance de la configuration MQTT
  • Firmware_Update: Mise à jour à distance du firmware
  • ACE_PLC_Update: Mise à jour à distance du programme ACE PLC avec le fichier généré par le logiciel vBuilder
  • GTW_Parameter_Update: Mise à jour à distance d’un paramètre MQTT
  • ACE_FTP_Upload: Télécharger un fichier du GTW vers un serveur FTP. Il s’agit ici du fichier de log.

Avant de procéder à une mise à jour à distance, il est fortement conseillé de tester localement avec la même configuration, sauf si votre passerelle est proche de votre lieu de travail !

Principe général de fonctionnement

  • Les nouveaux fichiers concernés par la mise à jour doivent être installés sur un serveur http distant
  • Le déclencheur de la mise à jour est un PUB MQTT provenant d’un client MQTT
  • Le Payload de ce PUB contient les éléments nécessaires pour permettre à la Gateway de se mettre à jour. Cela peut dépendre du type de mise à jour :
    • le lien http vers le serveur http
    • et/ou le mot de passe pour décompresser le fichier zip crypté
    • et/ou tous les paramètres nécessaires au traitement de la mise à jour

Processus de mise à jour : Suivez et lisez attentivement chaque étape !

Mise à jour du certificat

Mise à jour à distance du certificat SSL/TLS (fichier ca.crt)

Cette fonction du système vous permet de mettre à jour à distance le certificat SSL/TLS en remplaçant le certificat existant par un nouveau.

Un redémarrage du processus MQTT sera effectué après la mise à jour.

Il est important d’utiliser le même nom de fichier pour s’assurer qu’il correspond au nom de fichier défini dans les paramètres TLS de MQTT

  • MQTT_Topic_to_Sub_for_Parameter:
    • Celui que vous voulez. Exemple : update/ace-gtw-4g/certificat
    • Attention, le préfixe et le suffixe communs dans l’onglet [Sujets MQTT] pour les sujets Modbus ne sont pas ajoutés pour les sujets de fonctions système : Ajoutez-les si nécessaire.
  • Nom prédéfini de la fonction:
    • Doit être : Certificate_Update
  • Fichier de certificat
    • Le fichier ca.crt doit se trouver dans le répertoire HTTP distant
    • Le fichier ca.crt doit être zippé avec un mot de passe.
      • Vous pouvez utiliser le logiciel 7-Zip (voir « Comment utiliser le logiciel 7-Zip » en bas de page)
    • Le résultat doit être un fichier ca.crt.zip avec à l’intérieur votre fichier *.crt
    • A l’intérieur du fichier zip, le nom du fichier doit être le même que le nom du fichier défini dans la configuration du courtier MQTT (le chemin est toujours /etc/luci-uploads)
  • Chargement MQTT à envoyer par un autre client MQTT pour le démarrage udpate :
    • Lien HTTP vers le répertoire du fichier (pas vers le nom du fichier !)
      • Exemple : https://www.support.aceautomation.eu/gtw-mqtt-4g/mqtt-files
      • Pas de barre oblique  » /  » à la fin de l’URL
    • Espace ( )
    • Mot de passe entre guillemets simples (‘)
      • Exemple : '6UnJS%#n!3u632^cEs2mgvq'
    • Exemple complet :
      • https://www.support.aceautomation.eu/gtw-mqtt-4g/mqtt-files '6UnJS%#n!3u632^cEs2mgvq'

MQTT_Config_Update

Cette fonction système vous permet de mettre à jour à distance la configuration MQTT (fichier mqtt) en remplaçant le fichier existant par un nouveau.

Un redémarrage du processus MQTT sera effectué après la mise à jour.

Il est important de vérifier votre configuration pour s’assurer qu’elle correspond à tous les paramètres à distance. Vérifiez les points suivants :

  • L’identifiant du client MQTT doit certainement être le même
  • Chemin des fonctions Topics Modbus et Topics : Elles peuvent inclure l’ID du client MQTT.
  • Préfixe/suffixe de balise commun pour les PUBs et SUBs : Ils peuvent inclure l’ID du client MQTT.

Procéder à la mise à jour à distance de la configuration MQTT (fichier mqtt)

  • MQTT_Topic_to_Sub_for_Parameter:
    • Celui que vous souhaitez. Exemple : update/ace-gtw-4g/mqtt
    • Attention, le préfixe et le suffixe communs dans l’onglet [Sujets MQTT] pour les sujets Modbus ne sont pas ajoutés pour les sujets des fonctions système : Ajoutez-les si nécessaire.
  • Nom prédéfini de la fonction:
    • Doit être : MQTT_Config_Update
  • Fichier MQTT
    • Le fichier mqtt doit se trouver dans le répertoire HTTP distant
    • Le format doit être le même que dans le menu Gateway > MQTT Config File : Format texte.
    • Son nom doit toujours être mqtt (sans extension)
    • Le fichier mqtt doit être zippé avec un mot de passe.
      • Vous pouvez utiliser le logiciel 7-Zip (voir « Comment utiliser le logiciel 7-Zip » en bas de page)
    • Le résultat doit être un fichier mqtt.zip avec à l’intérieur un fichier mqtt
    • Son nom doit toujours être« mqtt« 
  • Payload MQTT à envoyer par un autre client MQTT pour démarrer udpate :
    • Lien HTTP vers le répertoire du fichier (pas vers le nom du fichier !)
      • Exemple : https://www.support.aceautomation.eu/gtw-mqtt-4g/mqtt-files
      • Pas de barre oblique  » /  » à la fin de l’URL
    • Espace ( )
    • Mot de passe entre guillemets simples (‘)
      • Exemple : '6UnJS%#n!3u632^cEs2mgvq'
    • Exemple complet :
      • https://www.support.aceautomation.eu/gtw-mqtt-4g/mqtt-files '6UnJS%#n!3u632^cEs2mgvq'

Mise à jour du micrologiciel

Traite la mise à jour à distance du micrologiciel de l’ACE-GTW-4G (fichiers firmware.bin et sha256sums)

  • MQTT_Topic_to_Sub_for_Parameter:
    • Celui que vous voulez. Exemple : update/ace-gtw-4g/firmware
    • Attention, le préfixe et le suffixe communs dans l’onglet [Sujets MQTT] pour les sujets Modbus ne sont pas ajoutés pour les sujets des fonctions système : Ajoutez-les si nécessaire.
  • Nom prédéfini de la fonction:
    • Doit être : Firmware_Update
  • Fichier du micrologiciel
    • Les fichiers firmware et sha256sums doivent se trouver dans le répertoire HTTP distant
    • Leurs noms doivent toujours être firmware.bin et sha256sums
    • firmware.bin doit être compatible avec la passerelle ACE-GTW-4G (testez-le avant la mise à jour à distance !)
    • sha256sums doit contenir ce texte :
      • serial-sha-256-key */tmp/firmware.bin
      • Example: d61eeb18eedbfe8ebe56991f3424a9c52c33b0bc0dd0f8e1e05556c3fc541ee1 */tmp/firmware.bin
      • Avec un retour chariot (CR) à la fin de la ligne ([Enter])
      • Le nombre de touches dépend du fichier du micrologiciel
      • Ce fichier est fourni avec le firmware (nous consulter si nécessaire)
    • Le résultat doit être les fichiers firmware.bin et sha256sums dans le répertoire HTTP distant (non zippé)
  • Charge utile MQTT à envoyer depuis un autre client MQTT pour le démarrage udpate :
    • Lien HTTP vers le répertoire du fichier (pas vers le nom du fichier !)
      • Exemple : https://www.support.aceautomation.eu/gtw-mqtt-4g/firmware-files
      • Pas de barre oblique  » /  » à la fin de l’URL

ACE_PLC_Update

Effectue la mise à jour à distance du programme de l’automate ACE (fichier aceprogram.vCompiled)

  • MQTT_Topic_to_Sub_for_Parameter:
    • Celui que vous souhaitez. Exemple : update/ace-gtw-4g/plc-program
    • Attention, le préfixe et le suffixe communs dans l’onglet [Sujets MQTT] pour les sujets Modbus ne sont pas ajoutés pour les sujets des fonctions système : Ajoutez-les si nécessaire.
  • Nom prédéfini de la fonction:
    • Doit être : ACE_PLC_Update
  • Fichier du programme ACE
    • Le fichier du programme ACE doit se trouver dans le répertoire HTTP distant
    • Le format doit être :
      • .vCompiled. Voir dans vBuilder, le menu Tools > Program To File
      • Son nom doit toujours être aceprogram.vCompiled
    • Le fichier « aceprogram.vCompiled » doit être zippé avec un mot de passe.
      • Vous pouvez utiliser le logiciel 7-Zip (voir « Comment utiliser le logiciel 7-Zip » en bas de page)
    • Le résultat doit toujours être un fichier aceprogram.zip avec à l’intérieur le fichier aceprogram.vCompiled
  • Payload MQTT à envoyer à partir d’un autre client MQTT pour démarrer udpate :
    • Lien HTTP vers le répertoire du fichier (pas vers le nom du fichier !)
      • Exemple : https://www.support.aceautomation.eu/gtw-mqtt-4g/ace-files
      • Pas de barre oblique  » /  » à la fin de l’URL
    • Espace ( )
    • Mot de passe entre guillemets simples (‘)
      • Exemple : '6UnJS%#n!3u632^cEs2mgvq'
    • Exemple complet :
      • https://www.support.aceautomation.eu/gtw-mqtt-4g/ace-files '6UnJS%#n!3u632^cEs2mgvq'

Le processus MQTT est arrêté pendant la mise à jour du programme ACE, puis l’ensemble redémarre (processus MQTT et programme PLC ACE)

GTW_Parameter_Update (Mise à jour des paramètres)

Cette fonction système permet de mettre à jour à distance un paramètre de la configuration MQTT (fichier mqtt) en remplaçant le paramètre existant par un nouveau.

Un redémarrage du processus MQTT sera effectué après la mise à jour.

Il est important de vérifier le paramètre que vous souhaitez mettre à jour. Sinon, avec un mauvais paramètre, vous ne pouvez plus avoir accès à votre passerelle

Processus de mise à jour à distance d’un paramètre MQTT (fichier mqtt)

  • MQTT_Topic_to_Sub_for_Parameter:
    • Celui que vous voulez. Exemple : update/ace-gtw-4g/parameter
  • Nom prédéfini de la fonction:
    • Doit être : GTW_Parameter_Update
  • Vous devez savoir :
    • ( 1 ) le nom de la section (mqttconfig ou topics ou systopics ou..)
    • L’index de cette section qui commence à 0.
    • ( 2 ) le nom de l’option concernée (projectname)
    • ( 3 ) la nouvelle valeur souhaitée pour ce paramètre
  • Charge utile MQTT à envoyer à partir d’un autre client MQTT pour le démarrage udpate :
    • Le Payload pour le système Topics sera composé avec :
      • mqtt.@section[index].option ‘value‘
      • Exemple :
        • mqtt.@mqttconfig[0].projectname 'Nom de mon nouveau projet'
    • Pour plusieurs sections (topics ou systopics ou..) avec le même nom, vous devez spécifier le bon index, ce qui signifie que vous devez connaître sa position dans le fichier MQTT.
      • Exemple pour modifier le slaveid du 2ème topic, de 1 à 5 :
        • mqtt.@topics[1].slaveid '5'

ACE_FTP_Upload

Télécharger un fichier du GTW vers un serveur FTP. Il s’agit ici du fichier journal.

  • MQTT_Topic_to_Sub_for_Parameter:
    • Celui que vous voulez. Exemple : update/ace-gtw-4g/ftp-log
    • Attention, le préfixe et le suffixe communs dans l’onglet [Sujets MQTT] pour les sujets Modbus ne sont pas ajoutés pour les sujets des fonctions système : Ajoutez-les si nécessaire.
  • Nom prédéfini de la fonction:
    • Doit être : ACE_FTP_Upload
  • Serveur FTP

    • Vous devez installer ou avoir déjà un serveur FTP disponible, avec ses
      • adresse ftp
      • login de l’utilisateur ftp
      • le mot de passe de l’utilisateur FTP
  • Charge utile MQTT à envoyer par un autre client MQTT pour recevoir les fichiers journaux sur votre serveur FTP
    • log FTP_file_directory « nom_utilisateur:mot_de_passe »

      • Exemple : log ftp://ftp.myftplink.eu/ "mylogin:mypassword"
        • A chaque PUBlication, le GTW envoie son fichier log au serveur FTP
        • log, signifie fichier journal. D’autres noms de fichiers seront disponibles ultérieurement.

Aide à la résolution des problèmes rencontrés

  • Si vous avez des espaces dans votre lien http, ajoutez des guillemets et/ou remplacez les espaces par
    • 'https://www.support.aceautomation.eu/gtw-mqtt-4g/ace files' '6UnJS%#n!3u632^cEs2mgvq'
    • Le guillemet doit être comme dans l’exemple ci-dessus, et non comme ‘ ou  » (les copier/coller modifient souvent le type de guillemet)
  • Veillez à ajouter le lien complet avec http://www… ou https://www…
  • Les noms des fichiers sont imposés
    • Pour le fichier .zip
    • et les fichiers à l’intérieur du fichier zip
  • Vérifiez la synthèse du nom de votre sujet lorsque vous envoyez la charge utile depuis votre client MQTT
    • Lepréfixe et le suffixe de l’étiquette commune ne sont pas ajoutés pour les fonctions de ce système
  • Les fichiers doivent être installés sur un serveur HTTP ou HTTPS
  • Toujours utiliser un mot de passe pour les fichiers zip
  • Pas de barre oblique  » /  » à la fin de l’URL (si elle existe)

Comment utiliser le logiciel 7-Zip

  • Format de l’archive : zip avec le bon nom de fichier
  • Entrer un mot de passe