Documentation du module Sofrel

Télécharger le module

Veuillez cliquer ici afin de télécharger la version 1.0.6 du module Sofrel.

Qu'est ce que le module Sofrel ?

Le module Sofrel est un module Ignition embarquant un driver de communication utilisant les protocoles LACBUS-RTU et LACBUS-PC.
Le protocole LACBUS-RTU permet la communication direct entre les Postes Locaux et les Postes Centraux.
Le protocole LACBUS-PC permet la communication entre les Data Loggers, Postes Locaux et les Postes Centraux au travers de Frontaux.

Ce module vous permet une gestion accrue de vos équipements.
Voici une liste non exhaustive des fonctionnalités :

1. Auto découverte des voies d'un équipement,
2. Gestion des calendriers,
3. Récupération des historiques de données,
4. Récupération du journal d'alarmes,
5. Envoi de commandes,
6. Synchronisation régulière avec vos équipements...

De plus, le module a suivi une recette de la part de Lacroix Environment certifiant le produit.

Mettre en place l'historisation des données

Afin d'activer l'historisation des données de vos équipements, vous devez :

1. Vous rendre dans la page Config - Sofrel - Réglages de votre gateway Ignition,
2. Dans l'onglet Général, cocher la case Historisation,
3. Puis venir sélectionner une connexion de base de données pour le champ BDD Historique.

Si aucun choix n'apparait dans le champ BDD Historique, veuillez vous rendre sur la page Config - DATABASES - Connections afin d'y enregistrer de nouvelles connexions de base de données.

Activer la récupération du journal d'alarme

Requiert : Mettre en place l'historisation des données

Afin d'activer la récupération du journal d'alarme, vous devez :

1. Vous rendre dans la page Config - Sofrel - Réglages de votre gateway Ignition,
2. Dans l'onglet Général, sélectionner un journal d'alarmes pour le champ Alarm Journal.

Seules les alarmes de type 1 et 2 sont acceptées. Respectivement "Apparition d'une alarme" et "Disparition d'une alarme".

Si aucun choix n'apparait dans le champ Alarm Journal, veuillez vous rendre sur la page Config - ALARMING - Journal afin d'y enregistrer de nouveaux journaux d'alarmes.

Établir les serveurs d'écoute pour le report d'alarme

Afin d'activer l'écoute des appels entrants de vos postes locaux, vous devez :

1. Vous rendre dans la page Config - Sofrel - Réglages de votre gateway Ignition,
2. Rendez-vous en bas de la page, cocher "Show advanced properties" pour laisser apparaître la catégorie Serveur,
3. Veuillez cocher la case du champ Actif,
4. Puis renseignez les interfaces utilisées pour la réception des appels non sécurisés et sécurisés.

Les champs Interface et Interface sécurisée doivent être configurés de la manière suivante : AdresseIPdel'interface:Port soit 0.0.0.0:502.

Le port 502 correspond au port utilisé par défaut par le protocole TCP.
Le port 802 correspond au port utilisé par défaut par le protocole TCP sécurisé.

Pour que les demandes de rappel fonctionnent correctement, assurez-vous que le "numPL" est correct lorsque vous instanciez votre poste local dans Ignition.

Il est également nécessaire que l'adresse IP du "destinataire d'appel automatique" configuré dans votre poste local soit identique à celle donnée pour le serveur d'écoute.

Configurer les connexions sécurisées

Utiliser OpenSSL

OpenSSL est un logiciel permettant d'accéder à des fonctions cryptographiques.
Celui-ci vous permettra de générer toutes les ressources nécessaires à vos connexions sécurisées.
Vous pouvez télécharger OpenSSL ici.

Nos conseils afin de se procurer OpenSSL :
Windows : L'installer via Chocolatey.(choco install openssl )

N'oubliez pas d'ajouter OpenSSL à vos variables d'environnement afin de pouvoir l'utiliser à partir de votre invite de commande.
Vous pouvez également y accéder en ouvrant votre cmd dans le dossier bin d'OpenSSL.

Générer une clé privée

Depuis un invité de commandes (Powershell...), veuillez exécuter les instructions suivantes :

1. openssl genrsa -out "{privateKeyFullFileName}.pk8" -aes256 -passout pass:"{privateKeyFilePassword}" {keyLength}"
2. openssl pkey -in "{privateKeyFullFileName}.pk8" -out "{privateKeyFullFileName}.key" -passin pass:"{privateKeyFilePassword}"

Exemple :
openssl genrsa -out XXX.pk8 -aes256 -passout pass:"XXXXXXXX" 4096
openssl pkey -in XXX.pk8 -out XXX.key -passin pass:"XXXXXXXX"

Générer un pre-certificat

Depuis un invité de commandes (Powershell...), veuillez exécuter les instructions suivantes :

1. openssl req -key "{privateKeyFullFileName}" -new -sha256 -out "{csrFullFileName}" -passin pass:"{privateKeyFilePassword}" -subj / "{distinguishedNameCnPart}"

Le common name (CN) doit commencer par "scada." ou "pc.scada." pour les frontaux.

Exemple :
openssl req -key XXX.key -new -sha256 -out XXX.csr -passin pass:"XXXXXXXX" -subj /"CN=scada.axone-io"

Importer les certificats

Afin d'importer les différents certificats, vous devez :

1. Vous rendre dans la page Config - Sofrel - Réglages de votre gateway Ignition,
2. Dans l'onglet Certificats, cliquez sur "Create new Certificat",
3. Vous pouvez renseigner maintenant les informations relatives à l'un de vos certificats,
4. Veuillez répéter cette action pour tous les certificats suivants :
   1. Certificat CA, le certificat fourni par l'autorité de confiance (.crt),
   2. Certificat client, le certificat fourni par l'autorité de confiance, généré à partir de votre pré-certificat (.crt),
   3. Clé privée, la clé privée correspondant à votre certificat client (.pk8),
   4. CRL, la liste de révocation de certificats (.crl)(optionnel),

Configurer la partie TLS

Afin d'activer les communications TLS avec vos équipements, vous devez :

1. Vous rendre dans la page Config - Sofrel - Réglages de votre gateway Ignition,
2. Dans l'onglet Général, sélectionner les différents certificats :
   1. Certificat d'autorité (CA) (.crt),
   2. Certificat Client (.crt),
   3. Clé privée du client (.pk8).
3. Puis renseignez le mot de passe de la clé privée (s'il y en a un),
4. Pour terminer, il est possible de renseigner une liste de révocations de certificats.

Utiliser les fonctions scripts

Le raccourci CTRL + ESPACE est disponible depuis tous les interfaces de script.

Ajouter un poste local dans Ignition

Types d'authentification :
system.sofrel.AUTH_NONE (0), communications non sécurisées,
system.sofrel.AUTH_PASSWORD (1), communications sécurisées par mot de passe,
system.sofrel.AUTH_ENCRYPTION (2), communications sécurisées par certificats TLS.

Suite à l'ajout d'un poste local, une auto découverte de ses voies s'effectue automatiquement.

Certaines règles de nommage de vos voies sont très fortement conseillées :

Le premier caractère doit être l'un des suivants :
- Une lettre, (spécifiquement, une lettre reconnue par la catégorie Lettre (L) d'Unicode)
- Un nombre,
- Un underscore, "_".

Le second caractère, et tous les suivants peuvent être :
- Une lettre,
- Un nombre,
- Un underscore,
- Un espace,
- Ou l'un de ces characters spéciaux : ' - : ( )

Supprimer un poste local de Ignition

Supprimer un poste local ne supprime pas son arborescence de tag ainsi que ses données. (Vous pouvez toutefois le faire manuellement)

Celle-ci a uniquement pour but de désinscrire le poste local du module.

Récupérer la liste des rtus

Récupérer la liste des postes locaux

Récupérer la liste des dataloggers

Récupérer la liste des frontaux

Récupérer la liste des voies d'un rtu

Concernant les équipements liés à un Frontal, la synthax du "nameRTU" doit être la suivant : "FR/nameFR/PL/namePL"

Récupérer la nombre maximum d'équipements de la licence.

Importer des voies dans un rtu depuis un fichier txt

Requiert : Ajouter un poste local dans Ignition
Requiert : Ajouter un RTU à un Frontal

Concernant les équipements liés à un Frontal, la synthax du "nameRTU" doit être la suivant : "FR/nameFR/PL/namePL"

Ajouter un frontal dans Ignition

Lors de l'ajout de votre frontal dans Igntion, un dossier de tag répertoriants ses informations est créé. Le dossier porte le nom du frontal et se trouve au chemin suivant "FR/nameFR".

Supprimer un frontal de Ignition

Supprimer un frontal ne supprime pas son arborescence de tag ainsi que ses données. (Vous pouvez toutefois le faire manuellement)

Celle-ci a uniquement pour but de désinscrire le frontal et ses RTU du module.

Ajouter un RTU à un Frontal

Lors de la déclaration de votre RTU dans votre frontal, un dossier de tag répertoriants ses informations est créé. Le dossier porte le nom du RTU et se trouve au chemin suivant "FR/nameFR/PL/namePL" ou "FR/nameFR/DL/nameDL".

Supprimer un RTU d'un Frontal

Supprimer un poste local ne supprime pas son arborescence de tag ainsi que ses données. (Vous pouvez toutefois le faire manuellement)

Celle-ci a uniquement pour but de désinscrire le poste local du module.

Types de RTU :
system.sofrel.EQUIPMENT_TYPE_PL (0), poste local,
system.sofrel.EQUIPMENT_TYPE_DL (1), data logger,

Contrôler vos équipements depuis le designer

Les tags de contrôle

1. "Connexion" permet de se connecter à l'équipement.

   Lors d'une connexion les commandes en attentes sont envoyées.

   Une auto-déconnexion s'effectue au bout de 20 secondes si aucune action n'a été émise.

2. "Decouverte" permet de découvrir les informations de votre équipement.

   Cela a pour effet de traduire chaque voie en tag.

3. "Envoie commandes immediat" initie une connexion et un envoi des commandes dès la modification d'une valeur.

   Une commande correspond à une modification de valeur et/ou modification du verrouillage d'une voie.

4. "Realtime" synchronise l'équipement en temps réel.

   Le taux de rafraichissement est configuré dans la page Config - Sofrel - Réglages catégorie Other, propriété Rafraichissement Temps réel.
   Cette synchronisation inclut la récupération des valeurs instantanés et des paramètres d'exploitation.

5. "Recuperation des historiques" permet de récupérer l'historique de données.

6. "Reset des commandes" permet de réinitialiser les commandes en attentes.

   Il est très conseillé de faire une synchronisation après avoir effacé les commandes en attentes.

7. "Sync cron expression".

   Programme une synchronisation de façon Cron.
   Particularité, c'est un cron à la seconde.

8. "Synchronise" effectue une synchronisation de l'équipement.

   Cette synchronisation inclut la récupération des valeurs instantanées et des paramètres d'exploitation.

9. Timeout connexion.
10. Timeout protocol.

11. "AutoReconnexion" permet à l'équipement de se reconnecter automatiquement suite à une coupure de communication.

    Une tentative de reconnexion est envoyé toutes les 60 secondes.

12. "Shutdown" permet de lancer la procédure d'arrêt de l'équipement.

13. "Demande interrogation" permet de demander une interrogation de l'équipement. L'équipement renvoi par la suite les états instantanées de ses voies.

14. "Envoyer les commandes" permet d'envoyer les commandes d'écritures de voies en attentes vers le RTU.

Changelog

1. 1.0.0 :
   1. first commercial release
2. 1.0.1 : 2021-02-22
   
   1. Add use standard type parameter for modole settings
3. 1.0.2 : 2021-03-23
   
   1. TLS authentication and bilateral encryption
4. 1.0.3 : 2021-10-22
   
   1. Certificate error management
   2. Improvement of the whole log
5. 1.0.4 : 2021-12-09
   
   1. Improvement and correction of multiple features
   2. Version validated by SOFREL
6. 1.0.5 : 2022-11-22
   
   1. Implementation of the LACBUS-PC protocol
   2. Version validated by SOFREL
7. 1.0.6 : 2023-03-01
   
   1. Optimization of the communication flows with the automats
   2. Fixed bug related to "dérogations" and timeout connections
   3. Improvement of loggers, traceability of events
   4. Expansion of the spectrum of usable private keys
   5. Bugfix special characters voie name (b2023040514)
   6. Bugfix communication sequence (b2023041209)
   7. Bugfix redundancy management (b5)