Utiliser Node-RED avec l'API Tulip

Utiliser Node-RED avec l'API Tulip

Si vous utilisez Node-RED sur votre propre appareil et que vous souhaitez envoyer des données à l'API de Tulip, Tulip fournit des nœuds Node-RED pour les points d'extrémité de l'API.

Ces nœuds sont préinstallés sur les appareils Tulip qui supportent Node-RED, mais si vous utilisez votre propre instance de Node-RED, vous pouvez toujours installer les nœuds en installant le paquet @tulip/node-red-tulip-api à partir de la bibliothèque Node-RED.

Dans cet article, vous apprendrez comment...

• ajouter des noeuds Tulip API à votre installation Node-RED
• utiliser l'API Tulip Machine Attribute pour envoyer des données à une machine Tulip
• utiliser le noeud Tulip Tables API pour lire, écrire et configurer les Tulip Tables

Conditions préalables :

• Node-RED est installé et fonctionne localement.

Exécuter Node-RED sur Tulip's Edge MC ? Voir ce guide de démarrage

Installation de Node-RED

1. Ajoutez @tulip/node-red-tulip-api à votre palette Node-RED

Ouvrez votre éditeur Node-RED et naviguez vers Menu → Gérer la palette

Cliquez sur l'onglet Installer et recherchez @tulip/node-red-tulip-api

Note : Vous pouvez également installer le paquet via la ligne de commande. Naviguez vers votre répertoire utilisateur Node-RED (i.e. cd ~/.node-red/) et exécutez npm install @tulip/node-red-tulip-api

2. Vérifier que l'installation a réussi

Si l'installation est réussie, les nœuds tulip-machine-attribute et tulip-tables seront visibles dans la palette (barre latérale gauche) sous la catégorie Tulip.

Utiliser le noeud Tulip Machine Attribute

Prérequis : vous avez lu Comment utiliser l'API des attributs de machine, vous avez un jeton API configuré avec les permissions attributes:write, et vous avez un attribut de machine spécifique auquel vous souhaitez envoyer des données.

1. Glissez et déposez un nœud Tulip Machine Attribute dans votre flux.

Remarque : dans la barre latérale droite, sélectionnez l' *onglet d'*aide pour afficher la documentation relative à l'utilisation du nœud.

2. Configurez le nœud pour qu'il corresponde à l'attribut de machine cible.

Nous utiliserons l'attribut de machine suivant à titre d'exemple. Notez que la source de données de la machine est l'API Tulip.

Attribut de machine entier pour la machine Tulip "Exemple de machine Tulip API".

Double-cliquez sur le nœud pour ouvrir son éditeur, puis configurez le nœud pour qu'il corresponde à cet attribut de machine. Par exemple, vous pouvez configurer votre nœud comme suit :

Configuration du nœud Tulip Machine Attribute.

Avec le nœud Tulip API Authentication configuré comme suit (remplissez vos informations d'authentification) :

Configuration de Tulip API Authentication pour le jeton API.

3. Testez l'envoi de données.

Créez le reste du flux pour envoyer des données au point de terminaison Machine Attribute.

Un simple flux de test pourrait consister à envoyer la valeur 0 à un point de terminaison Integer. Câblez l'entrée du nœud d'attribut de machine à un nœud d'injection configuré avec msg.payload=0 (voir ci-dessous). Câblez la sortie à un nœud de débogage qui imprime le msg complet.

Cliquez sur Déployer pour déployer le flux. Lorsque vous cliquez sur le nœud Inject, vous devriez voir un message de débogage avec un code d'état de 204.

Flux de test qui envoie la valeur entière 0 à un attribut de machine entier.

Les données devraient également apparaître sur votre instance Tulip sous l'attribut machine.

Utilisation du nœud API Tulip Tables

Prérequis : Vous avez lu How to Use the Table API, vous avez un API Token configuré avec les permissions tables:read et tables:write, et vous avez une table spécifique à laquelle vous souhaitez envoyer des données.

1. Glissez et déposez un nœud Tulip Tables dans votre flux.

Remarque : dans la barre latérale droite, sélectionnez l' onglet**Aide pour afficher la documentation relative à l'utilisation du nœud.

2. Configurez le nœud pour une requête API Tulip Tables spécifique.

Double-cliquez d'abord sur le nœud pour ouvrir son éditeur. Configurez le nœud de configuration Tulip API Authentication pour qu'il corresponde aux détails d'un jeton API avec les permissions tables:read et/ou tables:write (selon que la requête de table est une opération de lecture ou d'écriture) :

Configuration du jeton API Tables

Définissez le type de requête en fonction de la requête que vous souhaitez exécuter. Les autres options de la requête s'affichent alors en fonction du type.

Dans cet exemple, nous choisirons Lister les enregistrements pour lister les enregistrements de la table avec l'identifiant 9YHHckKcFTXHQpXEu avec le champ d'état "REVIEW".

Configuration du nœud de l'API Table

JSON développé du champ "Filtres" du nœud API Tables.

3. Testez l'envoi de données.

Créez le reste du flux pour envoyer des données au point de terminaison de l'API Tables.

Un exemple de flux de test pourrait relier un nœud Inject vide à l'entrée du nœud Tables API pour déclencher l'envoi de la requête API. Vous pouvez également ajouter un nœud de débogage qui imprime la charge utile msg.payload pour voir la réponse analysée.

Voir ci-dessous les résultats lorsque la requête API Tables configurée est envoyée à la table suivante sur votre-sous-domaine.tulip.co/tables/9YHHckKcFTXHQpXEu. Notez que la réponse renvoie les deux entrées de la table avec le champ Statut défini sur RÉVISION.

Table à interroger avec plusieurs enregistrements. Inclut un champ Status que nous pouvons filtrer.

Flux permettant d'envoyer la requête API "List Records" Tables à la table Tulip, ainsi que la charge utile de la réponse.

Pour en savoir plus

• README du paquet@tulip/node-red-tulip-api
• Comment utiliser l'API Table
• Comment utiliser l'API des attributs de machine