Utiliser Node-RED avec l'API Tulip

Utilisation de 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 Tulip, Tulip fournit des nœuds Node-RED pour les points de terminaison API.

Ces noeuds 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 noeuds en installant le paquet @tulip/node-red-tulip-api 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 Tulip Machine
• utiliser le nœud Tulip Tables API pour lire, écrire et configurer les tables Tulip.

Conditions préalables :

• Node-RED est installé et fonctionne localement.

Vous exécutez Node-RED sur Tulip's Edge MC ? Voir ce guide de démarrage

Installation

1. Ajouter @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, puis 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érifiez 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.

Utilisation du nœud Tulip Machine Attribute

Conditions préalables : Vous avez lu Comment utiliser l'API des attributs de machine, vous avez un bot API configuré avec des permissions attributs: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 sur l'utilisation du nœud.

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

Nous allons utiliser 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 API Tulip".

Double-cliquez sur le nœud pour ouvrir son éditeur, puis configurez le nœud en fonction de cet attribut machine. Par exemple, vous pouvez configurer votre noeud comme suit :

Configuration du nœud Attribut de la machine Tulip.

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

Configuration de l'authentification API Tulip pour le bot API.

3. Testez l'envoi de données.

Créez le reste du flux pour envoyer des données au point de terminaison de l'attribut de la machine.

Un flux de test simple pourrait être d'envoyer la valeur 0 à un point de terminaison Integer. Connectez l'entrée du noeud attribut de la machine à un noeud Inject configuré avec msg.payload=0 (illustré ci-dessous). Connectez la sortie à un nœud de débogage qui imprime le msg complet.

Cliquez sur Deploy 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 entière.

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

Utilisation du nœud de l'API Tulip Tables

Conditions préalables : Vous avez lu Comment utiliser l'API Table, vous avez un API bot 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 d'*aide pour afficher la documentation sur l'utilisation du nœud.

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

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 bot API avec des 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 bot API Tables

Définissez le type de requête sur la requête que vous souhaitez exécuter. Le reste des options de la requête s'affiche alors en fonction du type.

Dans cet exemple, nous choisirons Lister les enregistrements pour répertorier les enregistrements de la table dont l'identifiant est 9YHHckKcFTXHQpXEu et dont le champ Statut est "REVIEW".

Configuration du nœud de l'API Table

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

3. Testez l'envoi des 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 connecter un nœud Inject vide à l'entrée du nœud de l'API Tables pour déclencher l'envoi de la requête API. Vous pouvez également ajouter un nœud de débogage qui imprime le msg.payload pour voir la réponse analysée.

Voyez ci-dessous les résultats lorsque la requête API Tables configurée est envoyée à la table suivante à l'adresse your-subdomain.tulip.co/tables/9YHHckKcFTXHQpXEu. Notez que la réponse renvoie les deux entrées de la table avec le champ Status défini sur REVIEW.

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

Flux pour envoyer une requête d'API pour la table "List Records" à la table Tulip, et le contenu de la réponse.

Autres lectures

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