IoT Platform:Ajouter une fonctionnalité TSL

Prérequis

Un produit est créé. Pour plus d'informations, consultez Créer un produit.

Remarques sur l'utilisation

• Configurez les fonctionnalités TSL au sein de modules. La somme des modules par défaut et des modules personnalisés d'un même produit ne peut excéder 20.

• Si un produit est publié, son modèle TSL ne peut plus être modifié. Pour modifier un modèle TSL, annulez d'abord la publication du produit concerné.

• Vous pouvez modifier une version historique d'un modèle TSL afin de générer une nouvelle version.

• IoT Platform conserve les 10 versions les plus récentes d'un modèle TSL. Les versions antérieures sont écrasées.

• Après toute modification d'un modèle TSL, publiez-le pour que les mises à jour prennent effet.

Pour plus d'informations, consultez Limites.

Procédure

1. Connectez-vous à la console IoT Platform.

2. Dans le coin supérieur gauche de la console IoT Platform, sélectionnez la région où IoT Platform est activé.

3. Dans l'onglet All environment de la page Overview, recherchez l'instance à gérer, puis cliquez sur son ID ou sur son nom.

4. Dans le volet de navigation de gauche, choisissez Devices > Products. Dans la liste des produits, localisez le produit souhaité et cliquez sur View dans la colonne Actions.

5. Sur la page des détails du produit, cliquez sur l'onglet Define Feature, puis sur Edit Draft, et enfin sur Default Module ou Add Module.

6. Facultatif. Pour ajouter un module, configurez les paramètres requis et cliquez sur OK. Cliquez ensuite sur le nom du module ajouté. Le tableau suivant décrit ces paramètres.

   Parameter	Description
   Module Name	Le nom doit comporter entre 4 et 30 caractères. Il peut contenir des lettres, des chiffres et des traits de soulignement (_).
   Module Identifier	L'identifiant du module. Cet ID doit être unique au sein d'un produit. Il doit comporter entre 1 et 30 caractères et peut contenir des lettres, des chiffres ainsi que des traits de soulignement (_).
   Module Description	La description du module. Elle doit comporter entre 1 et 4096 caractères.

7. Facultatif. Sélectionnez une version dans la liste déroulante Version History, puis cliquez sur Roll Back. Vous pouvez alors modifier le modèle TSL en vous basant sur cette version historique.

8. Ajoutez une fonctionnalité personnalisée.

   Cliquez sur Add Self-defined Feature. Vous pouvez ensuite ajouter une propriété, un service ou un événement au produit.

   • Ajout d'une propriété : dans la boîte de dialogue Add Self-defined Feature, sélectionnez Properties dans le champ Feature Type. Configurez les paramètres, puis cliquez sur OK.

     Le tableau suivant décrit ces paramètres.

     Parameter	Description
     Feature Name	Nom de la propriété. Exemple : consommation électrique. Ce nom doit être unique au sein du produit. Le nom doit comporter entre 1 et 30 caractères. Il peut contenir des lettres, des chiffres, des tirets (-), des traits de soulignement (_), des barres obliques (/) et des points (.). Il doit commencer par une lettre ou un chiffre.
     Identifier	Identifiant de la propriété. Cet ID doit être unique au sein du produit. Il correspond à la valeur du paramètre identifier au format Alink JSON. L'appareil utilise cet ID comme clé pour signaler les données de propriété. IoT Platform vérifie l'ID afin de déterminer s'il doit recevoir les données. L'identifiant doit comporter entre 1 et 50 caractères et peut contenir des lettres, des chiffres ainsi que des traits de soulignement (_). Exemple : PowerConsumption. Remarque Ce paramètre ne peut pas prendre l'une des valeurs réservées suivantes : set, get, post, property, event, time et value.
     Data type	int32 : entier 32 bits. Spécifiez une plage de valeurs, un pas et une unité. float : nombre à virgule flottante simple précision. Spécifiez une plage de valeurs, un pas et une unité. double : nombre à virgule flottante double précision. Spécifiez une plage de valeurs, un pas et une unité. enum : énumération. Attribuez une valeur et une description à chaque élément de l'énumération. Exemples : 1-mode chauffage et 2-mode refroidissement. bool : booléen. Utilisez 0 ou 1 pour définir une valeur booléenne. Exemples : 0 signifie désactivé et 1 signifie activé. text : chaîne de caractères. Spécifiez la longueur de la chaîne, qui doit être comprise entre 1 et 10 240 octets. date : horodatage. Horodatage UTC au format chaîne de caractères. Unité : millisecondes. struct : objet JSON. Définissez une structure JSON et ajoutez-y des paramètres JSON. Par exemple, vous pouvez définir la couleur d'une lampe comme une structure composée des paramètres suivants : Red, Green et Blue. Les structures imbriquées ne sont pas prises en charge. array : tableau. Spécifiez le type de données et le nombre d'éléments du tableau. Types d'éléments valides : int32, float, double, text et struct. Tous les éléments d'un tableau doivent être du même type. Le nombre d'éléments doit être compris entre 1 et 512. Remarque Ce paramètre n'est pas requis si le paramètre Gateway Connection Protocol du produit est défini sur Modbus.
     Value range	Si le paramètre Data Type est défini sur int32, float ou double, spécifiez une plage de valeurs pour la propriété.
     Step	Pas minimal de modification des valeurs de la propriété. Si le paramètre Data Type est défini sur int32, float ou double, spécifiez un pas selon vos besoins métier. Par exemple, pour ajouter une propriété de température à un produit thermomètre, définissez le paramètre Data Type sur int32, le paramètre Step sur 2, le paramètre Unit sur °C et le paramètre Value Range sur 0 à 100. Ainsi, chaque fois que la température varie de 2 °C, l'appareil signale une valeur telle que 0 °C, 2 °C, 4 °C, 6 °C ou 8 °C.
     Unité du prix de l'instance.	Sélectionnez None ou d'autres valeurs en fonction de votre scénario métier.
     Read/Write Type	Read/Write : les requêtes GET et SET sont prises en charge. Read-only : seules les requêtes GET sont prises en charge. Remarque Ce paramètre n'est pas requis si le paramètre Gateway Connection Protocol du produit est défini sur Modbus.
     Description	Description de la fonctionnalité. Elle ne doit pas dépasser 100 caractères.
     Extended Information	Les informations étendues définissent le mappage entre le protocole de connexion et le modèle TSL standard de l'appareil. Une fois ces paramètres configurés dans un modèle TSL, ils sont visibles sous l'onglet TSL Extension Information du modèle dans la console IoT Platform. Si le paramètre Gateway Connection Protocol d'un gateway sub-device est défini sur Custom, OPC UA ou Modbus, spécifiez des informations étendues. Si le paramètre Gateway Connection Protocol est défini sur Custom, fournissez une description au format JSON pour les configurations personnalisées. Cette description doit comporter entre 1 et 1 024 caractères. Si le paramètre Gateway Connection Protocol est défini sur OPC UA, saisissez un nom de nœud. Chaque nom de nœud spécifié pour une propriété doit être unique. Si le paramètre Gateway Connection Protocol est défini sur Modbus, configurez les paramètres suivants : Operation Type : ce paramètre peut prendre l'une des valeurs suivantes. Discrete Input (read-only, 0x02) Coil Status (read-only, 0x01) Coil Status (read and write, 0x01-read, 0x05-write) Coil Status (read and write, 0x01-read, 0x0F-write) Coil Status (write-only, 0x05) Coil Status (write-only, 0x0F) Holding Registers (read-only, 0x03) Holding Registers (read and write, 0x03-read, 0x06-write) Holding Registers (read and write, 0x03-read, 0x10-write) Holding Registers (write only, 0x06) Holding Registers (read-only, 0x10) Input Registers (read-only, 0x04) Register Address : spécifiez une valeur hexadécimale commençant par 0x. Valeurs valides : 0x0 to 0xFFFF. Exemple : 0xFE. Original Data Type : plusieurs types de données sont pris en charge. Valeurs valides : int16, uint16, int32, uint32, int64, uint64, float, double, string, bool et bits. Bit Position : ce paramètre est requis si le paramètre Original Data Type est défini sur bits. Sélectionnez la position du bit où les données sont stockées. Value Range : cette plage est obtenue après traitement des données brutes avec un facteur d'échelle spécifié. Les données dépassant cette plage sont ignorées. IoT Platform définit les plages de valeurs par défaut suivantes pour les types d'opérations ci-après : Coil Status : 0 à 1 Discrete Input : 0 à 1 Holding Registers : -2147483648 à 2147483647 Input Registers : -2147483648 à 2147483647 Switch High Byte and Low Byte in Register : indique s'il faut intervertir les 8 premiers bits et les 8 derniers bits de l'entier 16 bits dans le registre. Valeurs valides : true : le système intervertit les 8 premiers bits et les 8 derniers bits. false : le système n'effectue aucun échange de bits. Switch Register Bits Sequence : indique s'il faut intervertir les 16 premiers bits et les 16 derniers bits de l'entier 32 bits d'origine. Valeurs valides : true : le système intervertit les 16 premiers bits et les 16 derniers bits. false : le système n'effectue aucun échange de bits. Scale Factor : spécifie un nombre entier ou à virgule flottante. Valeur par défaut : 1. La valeur ne peut être ni nulle ni négative. Data Report : sélectionnez At Specific Time ou Report Changes.

   • Ajout d'un service : dans la boîte de dialogue Add Self-defined Feature, sélectionnez Services dans le champ Feature Type. Configurez les paramètres, puis cliquez sur OK.

     Remarque

     L'ajout de services n'est pas possible lorsque le paramètre Gateway Connection Protocol est défini sur Modbus.

     Le tableau suivant décrit ces paramètres.

     Parameter	Description
     Feature Name	Nom du service. Le nom doit comporter entre 1 et 30 caractères. Il peut contenir des lettres, des chiffres, des tirets (-), des traits de soulignement (_), des barres obliques (/) et des points (.). Il doit commencer par une lettre ou un chiffre.
     Identifier	Identifiant du service. Cet ID doit être unique au sein du produit. Il correspond à la valeur du paramètre identifier spécifié pour le service au format Alink JSON. L'identifiant doit comporter entre 1 et 50 caractères et peut contenir des lettres, des chiffres ainsi que des traits de soulignement (_). Remarque Ce paramètre ne peut pas prendre l'une des valeurs réservées suivantes : set, get, post, property, event, time et value.
     Invocation method	Asynchronous : IoT Platform renvoie le résultat après l'appel du service, sans attendre de réponse de l'appareil. Synchronous : IoT Platform attend une réponse de l'appareil. En l'absence de réponse, l'appel du service expire.
     Input Parameters	Facultatif. Paramètres d'entrée du service. Dans la boîte de dialogue qui s'affiche, cliquez sur + Add Parameter pour ajouter un paramètre d'entrée. Si le paramètre Gateway Connection Protocol est défini sur OPC UA, configurez un index de paramètre pour spécifier l'ordre des paramètres. Remarque Ce paramètre ne peut pas prendre l'une des valeurs réservées suivantes : set, get, post, property, event, time et value. Utilisez une propriété existante comme paramètre d'entrée ou configurez un paramètre personnalisé. Par exemple, lors de la définition du service Automatic Sprinkling, utilisez les propriétés prédéfinies Sprinkling Interval et Sprinkling Amount comme paramètres d'entrée. Lorsque IoT Platform appelle le service Automatic Sprinkling, l'arroseur se déclenche selon l'intervalle et le volume spécifiés. Chaque service peut comporter jusqu'à 20 paramètres d'entrée.
     Output Parameters	Facultatif. Paramètres de sortie du service. Dans la boîte de dialogue qui s'affiche, cliquez sur + Add Parameter pour ajouter un paramètre de sortie. Si le paramètre Gateway Connection Protocol est défini sur OPC UA, configurez un index de paramètre pour spécifier l'ordre des paramètres. Remarque Ce paramètre ne peut pas prendre l'une des valeurs réservées suivantes : set, get, post, property, event, time et value. Utilisez une propriété existante comme paramètre de sortie ou configurez un paramètre personnalisé. Par exemple, lors de la définition du service Automatic Sprinkling, utilisez la propriété prédéfinie Soil Humidity comme paramètre de sortie. Lorsque IoT Platform appelle le service Automatic Sprinkling, les données relatives à l'humidité du sol sont renvoyées. Chaque service peut comporter jusqu'à 20 paramètres de sortie.
     Extended Information	Les informations étendues définissent le mappage entre le protocole de connexion et le modèle TSL standard de l'appareil. Une fois ces paramètres configurés dans un modèle TSL, ils sont visibles sous l'onglet TSL Extension Information du modèle dans la console IoT Platform. Si le paramètre Gateway Connection Protocol d'un gateway sub-device est défini sur Custom ou OPC UA, spécifiez des informations étendues. Si le paramètre Gateway Connection Protocol est défini sur Custom, fournissez une description au format JSON pour les configurations personnalisées. Cette description doit comporter entre 1 et 1 024 caractères. Si le paramètre Gateway Connection Protocol est défini sur OPC UA, saisissez un nom de nœud. Chaque nom de nœud spécifié pour un service doit être unique.
     Description	Description du service. Elle doit comporter entre 1 et 100 caractères.

   • Ajout d'un événement : dans la boîte de dialogue Add Self-defined Feature, sélectionnez Events dans le champ Feature Type. Configurez les paramètres, puis cliquez sur OK.

     Remarque

     L'ajout d'événements n'est pas possible lorsque le paramètre Gateway Connection Protocol est défini sur Modbus.

     Le tableau suivant décrit ces paramètres.

     Parameter	Description
     Feature Name	Nom de l'événement. Le nom doit comporter entre 1 et 30 caractères. Il peut contenir des lettres, des chiffres, des tirets (-), des traits de soulignement (_), des barres obliques (/) et des points (.). Il doit commencer par une lettre ou un chiffre.
     Identifier	Identifiant de l'événement. Cet ID doit être unique au sein du produit. Il correspond à la valeur du paramètre identifier au format Alink JSON. L'appareil utilise cet ID comme clé pour signaler les données d'événement. Exemple : ErrorCode. L'identifiant doit comporter entre 1 et 50 caractères et peut contenir des lettres, des chiffres ainsi que des traits de soulignement (_). Remarque Ce paramètre ne peut pas prendre l'une des valeurs réservées suivantes : set, get, post, property, event, time et value.
     Type de l'événement.	Effectuez un traitement logique ou une analyse différenciée selon le type d'événement. Info : notifications courantes signalées par les appareils, telles qu'une notification de fin de tâche. Alert : urgences ou exceptions survenues pendant le fonctionnement de l'appareil. Ces événements ont une priorité élevée. Error : urgences ou exceptions survenues pendant le fonctionnement de l'appareil. Ces événements ont une priorité élevée.
     Output Parameters	Paramètres de sortie d'un événement. Dans la boîte de dialogue qui s'affiche, cliquez sur + Add Parameter pour ajouter un paramètre de sortie. Utilisez une propriété existante comme paramètre de sortie ou configurez un paramètre personnalisé. Par exemple, utilisez la propriété prédéfinie Voltage comme paramètre de sortie. Si un appareil signale une erreur liée à la tension, la valeur de tension est également transmise pour faciliter le dépannage. Si le paramètre Gateway Connection Protocol est défini sur OPC UA, configurez un index de paramètre pour spécifier l'ordre des paramètres. Remarque Ce paramètre ne peut pas prendre l'une des valeurs réservées suivantes : set, get, post, property, event, time et value. Un événement peut comporter jusqu'à 50 paramètres de sortie.
     Extended Information	Les informations étendues définissent le mappage entre le protocole de connexion et le modèle TSL standard de l'appareil. Une fois ces paramètres configurés dans un modèle TSL, ils sont visibles sous l'onglet TSL Extension Information du modèle dans la console IoT Platform. Si le paramètre Gateway Connection Protocol d'un gateway sub-device est défini sur Custom ou OPC UA, spécifiez des informations étendues. Si le paramètre Gateway Connection Protocol est défini sur Custom, fournissez une description au format JSON pour les configurations personnalisées. Cette description doit comporter entre 1 et 1 024 caractères. Si le paramètre Gateway Connection Protocol est défini sur OPC UA, saisissez un nom de nœud. Chaque nom de nœud spécifié pour un événement doit être unique.
     Description	Description de l'événement. Elle doit comporter entre 1 et 100 caractères.

Publier un modèle TSL

1. Choisissez Define Feature > Edit Draft. Dans le coin inférieur gauche de la page affichée, cliquez sur Release online. La boîte de dialogue Release model online? s'affiche.

2. Facultatif. Cliquez sur +Add post notes, puis saisissez un numéro de version et une note.

   Parameter	Description
   Version Number	Numéro de version du modèle TSL. Ce numéro permet de gérer les différentes versions du modèle. Le numéro de version doit comporter entre 1 et 16 caractères. Il peut contenir des lettres, des chiffres et des points (.).
   note	Description du modèle TSL. Elle peut contenir des lettres, des chiffres et des caractères spéciaux, et doit comporter entre 1 et 100 caractères.

3. Si une version en ligne existe déjà, vérifiez les différences entre la version actuelle à publier et la version en ligne.

   Cliquez sur View Differences. Le panneau View Differences affiche les écarts entre les versions. Après vérification, cliquez sur Confirm. Dans la boîte de dialogue Release model online?, la case correspondante est automatiquement cochée.

   Si vous ne souhaitez pas consulter les différences, cochez la case « Make sure that you have verified the differences between the current version and the online version. »

4. Cliquez sur OK pour publier le modèle TSL.

Résultat de l'exécution

Une fois le modèle TSL publié, consultez-le dans la console IoT Platform. Sous l'onglet Define Feature de la page Product Details, effectuez les opérations suivantes :

• Cliquez sur TSL Model pour afficher le modèle TSL au format JSON.

Opérations API associées

Étapes suivantes

Par défaut, les données TSL soumises par les appareils d'un produit sont automatiquement écrites dans un espace de stockage de données chaudes. Selon vos besoins métier, désactivez ce service de stockage pour tout ou partie des modèles TSL.