Partager et exposer les variables

1- Réseau de modules

Le partage de variables permet aux modules 2PIO d’un même réseau ModLink d’échanger des informations et de coordonner leurs automatismes, sans câblage supplémentaire entre les équipements concernés.

Pour partager les variables d'un module avec les autres modules du réseau :

• Dans le menu "I/O", sélectionner le mode "Distant" 
• Cliquer sur "ajouter"

Ajouter manuellement un module (si vous connaissez son identifiant)

• dans "nom de l'appareil" saisissez l'identifiant du module vers lequel vous souhaitez partager les variables 
  2pio_ _ _ _  (4 caractères)
  
• Cliquer sur "ajouter l'appareil" pour confirmer votre choix

ou bien scanner le réseau pour afficher directement les modules du réseau :

• cliquez sur "scanner en mDNS"
• sélectionnez les appareils vers lesquels vous souhaitez partager les variables
• cliquer sur "importer la sélection"

• une nouvelle fenêtre "gestion des appareils" s'affiche, cliquez sur "sauvegarder" pour enregistrer la configuration

Configuration de l'exposition d'une variable

• Ouvrez le menu "I/O"
• Sélectionnez la variable à partager
• Cliquez sur l'icône "Modifier" (pinceau) pour accéder à sa configuration
• Cochez les options d'exposition souhaitées :
  • exposition Modbus
  • exposition OPC UA
  • exposition Home Assistant
• Enregistrez la configuration

• La variable devient alors accessible via les protocoles et services sélectionnés.
  Pour plus d'information, vous pouvez consulter Configurer une variable

2- API publique des variables

L’API publique des variables permet à un système tiers de lire ou d’écrire certaines variables d'un module.

2.1- Le principe en trois étapes

1. Autoriser la variable
   coche l’exposition « Non sécurisé » pour la variable concernée. Voir Options d'exposition des variables
2. Récupérer le lien
   L’interface génère un lien de lecture ou d’écriture. Ce lien contient déjà la clé externe de la carte, lorsque le compte connecté est autorisé à la consulter.
3. Appeler le lien depuis le système externe
   Une requête HTTP GET suffit. Aucun compte utilisateur ni mot de passe n’est nécessaire : la clé contenue dans le lien sert d’autorisation.

GET https://<appareil>/api/public/variable?scenario_id=<scénario>&variable_name=<variable>&key=<clé_externe>

2.2- Ce que l’utilisateur contrôle

• Les variables accessibles : seules celles qui sont marquées « Non sécurisé »
• Les personnes ou systèmes autorisés : seuls ceux qui disposent de la clé externe
• La durée d’accès : la régénération de la clé externe révoque immédiatement tous les liens déjà communiqués

2.3- Ce que l’API publique ne permet pas

• Elle ne donne pas accès aux variables qui n’ont pas été autorisées. La carte répond alors avec le code HTTP 403.
• Elle ne permet pas de modifier la configuration, les scénarios, le réseau ou les utilisateurs de la carte.
• Une variable en lecture seule ne peut pas être écrite, même si elle est exposée.
• Une variable dont la valeur provient d’une autre carte ne peut pas être écrite depuis la carte qui la reçoit. L’écriture doit être effectuée sur la carte qui possède cette variable.

2.4- Quelle API utiliser selon le besoin ?

Seules les routes publiques et celles de Home Assistant sont destinées aux systèmes externes. Les autres routes sont internes et peuvent évoluer sans préavis.

2.5- Format de l’API

L’API publique est volontairement simple : les échanges utilisent des requêtes HTTP GET avec des paramètres dans l’URL, y compris pour l’écriture. Il est ainsi possible d’utiliser directement un lien dans un navigateur, un raccourci ou un bouton d’automatisation.