Lorsqu'un appareil envoie un message au format personnalisé vers une rubrique personnalisée incluant la balise d'analyse ?_sn=default, IoT Platform exécute un script d'analyse des messages. Ce script convertit les données personnalisées en structure JSON, puis transfère ces données aux systèmes métier en aval. Cette rubrique explique comment soumettre un script d'analyse des messages dans la console IoT Platform pour analyser des données au format personnalisé.
Utilisation et limites
Seuls les appareils connectés via Message Queuing Telemetry Transport (MQTT) prennent en charge l'analyse des messages de rubriques personnalisées.
Le script analyse uniquement les données que les appareils envoient à IoT Platform. Il n'analyse pas les données envoyées depuis le cloud vers les appareils.
Le script analyse la charge utile d'un message ascendant et renvoie la charge utile analysée.
La rubrique du message reste inchangée après l'analyse. Par exemple, un message envoyé vers
/${productKey}/${deviceName}/user/updateconserve la même rubrique après analyse.
Balise d'analyse
Lors de la configuration de l'appareil, ajoutez la balise d'analyse ?_sn=default à la fin de la rubrique personnalisée utilisée pour la publication des messages.
IoT Platform analyse uniquement les messages publiés sur des rubriques contenant la balise d'analyse.
Par exemple, si un message envoyé à la rubrique /${productKey}/${deviceName}/user/update doit être analysé au format JSON, vous devez configurer la rubrique comme suit : /${productKey}/${deviceName}/user/update?_sn=default lors du développement de la logique côté appareil.
Lorsque vous créez une rubrique personnalisée dans la console IoT Platform, n'ajoutez pas la balise d'analyse à la définition de la rubrique.
Procédure
Connectez-vous à la console IoT Platform.
Sur la page Overview, localisez l'instance à gérer et cliquez sur son ID ou son nom.
Dans le volet de navigation de gauche, sélectionnez .
Sur la page Products, repérez le produit souhaité et cliquez sur View.
Sur la page Product Details, cliquez sur l'onglet Message Parsing.
-
Sélectionnez un langage de script. Ensuite, dans la section Edit Script, saisissez votre script dans l'éditeur de code.
Langages de script pris en charge
Fonction à définir
Exemple de code
JavaScript (ECMAScript 5)
transformPayload()
Python 2.7
transform_payload()
PHP 7.2
transformPayload()
RemarqueSi le Data Format du produit est défini sur Pass-through/Custom, vous devez également écrire un script pour analyser les messages du modèle Thing Specification Language (TSL). Pour plus d'informations, consultez la rubrique Soumettre un script d'analyse des messages du modèle TSL.
-
Testez le script.
Dans la section Input Simulation, définissez le paramètre Simulation Type sur Custom, puis sélectionnez un appareil et une rubrique.
Saisissez les données simulées rapportées par l'appareil et cliquez sur Execute.
Une fois que vous avez confirmé que le script fonctionne comme prévu, cliquez sur Submit pour valider le script sur IoT Platform.
Facultatif : Mettre à jour le script d'analyse des messages
Après avoir soumis un script d'analyse des messages, vous pouvez revenir à l'onglet Message Parsing pour modifier ou supprimer le script. Suivez les étapes de la section Procédure pour tester et soumettre vos modifications. Les changements prennent effet en environ une minute. Le script mis à jour s'applique à tous les appareils existants et nouveaux associés au produit.
Si vous modifiez et resoumettez le script, vous devez également mettre à jour la logique métier associée au service d'analyse des messages. Dans le cas contraire, vos services risquent d'être interrompus.
Si vous supprimez le script, le service d'analyse des messages pour les appareils associés au produit devient indisponible. Cela peut perturber vos services.
Agissez avec prudence.
Références
Pour en savoir plus sur les informations de base, telles que le flux d'analyse des messages, consultez la rubrique Qu'est-ce que l'analyse des messages ?.
Pour obtenir des informations sur l'analyse des données du modèle TSL au format Pass-through/Custom, consultez la rubrique Soumettre un script d'analyse des messages du modèle TSL.
Pour plus d'informations sur l'appel d'une API pour envoyer des messages à un appareil, consultez les rubriques API pour les modèles TSL et API pour la communication des messages.