Uso de Node-RED con la API Tulip

Uso de Node-RED con la API de Tulip

Si estás utilizando Node-RED en tu propio dispositivo y deseas enviar datos a la API de Tulip, Tulip proporciona nodos Node-RED para los puntos finales de la API.

Estos nodos están preinstalados en los dispositivos Tulip que soportan Node-RED, pero si estás ejecutando tu propia instancia de Node-RED, puedes instalar los nodos instalando el paquete @tulip/node-red-tulip-api de la librería Node-RED.

En este artículo, aprenderás cómo...

• añadir nodos Tulip API a tu instalación Node-RED
• utilizar el Tulip Machine Attribute API para enviar datos a un Tulip Machine
• utilizar el nodo Tulip Tables API para leer, escribir y configurar Tulip Tables

Requisitos previos:

• Tienes Node-RED instalado y funcionando localmente

¿Estás ejecutando Node-RED en Tulip's Edge MC? Consulta esta guía de inicio

Instalación

1. Añade @tulip/node-red-tulip-api a tu paleta Node-RED

Abre tu editor Node-RED y navega hasta Menú → Gestionar paleta.

Haz clic en la pestaña Instalar y luego busca @tulip/node-red-tulip-api

Nota: También puedes instalar el paquete a través de la línea de comandos. Navega a tu directorio de usuario de Node-RED (es decir, cd ~/.node-red/) y ejecuta npm install @tulip/node-red-tulip-api

2. Comprueba que la instalación se ha realizado correctamente

Si la instalación se ha realizado correctamente, los nodos tulip-machine-attribute y tulip-tables estarán visibles en la paleta (barra lateral izquierda) bajo la categoría Tulip.

Uso del nodo Tulip Machine Attribute

Prerrequisitos: Has leido Como usar la API de Atributos de Maquina tienes un Token de API configurado con permisos attributes:write, y tienes un atributo de maquina especifico al que deseas enviar datos.

1. Arrastra y suelta un nodo Tulip Machine Attribute en tu flujo

Nota: En la barra lateral derecha, selecciona la pestaña de**ayuda para ver la documentación sobre cómo utilizar el nodo.

2. 2. Configure el nodo para que coincida con el atributo de máquina de destino.

Utilizaremos el siguiente atributo de máquina como ejemplo. Tenga en cuenta que la fuente de datos de la máquina es la API de Tulip.

Atributo de máquina entero para Tulip Machine "Example Tulip API Machine".

Haz doble click en el nodo para abrir su editor, y luego configura el nodo para que coincida con este atributo de máquina. Por ejemplo, puedes configurar el nodo de la siguiente manera:

Configuración del nodo Tulip Machine Attribute.

Con el nodo Tulip API Authentication configurado como sigue (rellena tus credenciales de autenticación):

Configuración de Tulip API Authentication para API Token.

3. Prueba de envío de datos.

Crea el resto del flujo para enviar datos al endpoint Machine Attribute.

Un flujo de prueba simple podría ser enviar el valor 0 a un endpoint Integer. Conecte la entrada del nodo de atributo de máquina a un nodo Inject configurado con msg.payload=0 (mostrado abajo). Conecte la salida a un nodo de depuración que imprima el mensaje completo.

Haga clic en Deploy para desplegar el flujo. Cuando haga clic en el nodo Inject, debería ver un mensaje de depuración con un código de estado de 204.

Flujo de prueba que envía el valor entero 0 a un atributo entero de la máquina.

Los datos también deberían aparecer en tu instancia de Tulip bajo el atributo de máquina.

Uso del Nodo API de Tulip Tables

Prerrequisitos: Has leído Cómo Usar la API de Tablas, tienes un Token de API configurado con permisos tables :read y tables:write, y tienes una tabla específica a la que deseas enviar datos.

1. Arrastra y suelta un nodo Tulip Tables en tu flujo.

Nota: En la barra lateral derecha, selecciona la pestaña de**ayuda para ver la documentación sobre cómo utilizar el nodo.

2. 2. Configure el nodo para una consulta específica de la API de Tulip Tables.

Primero haga doble clic en el nodo para abrir su editor. Configura el nodo Tulip API Authentication para que coincida con los detalles de un API Token con permisos tables :read y/o tables:write (dependiendo de si la consulta de tablas es una operación de lectura o escritura):

Configuración del token de API de tablas

Establezca el Tipo de consulta en la consulta que desea ejecutar. El resto de las Opciones de Consulta aparecerán de acuerdo al tipo.

En este ejemplo, elegiremos Listar registros para listar los registros de la tabla con id 9YHHckKcFTXHQpXEu con el campo de Estado "REVISIÓN".

Configuración del nodo API de tablas

JSON expandido del campo "Filtros" del nodo API de tablas.

3. Pruebe el envío de datos.

Cree el resto del flujo para enviar datos al punto final de la API de tablas.

Un ejemplo de flujo de prueba podría cablear un nodo Inject vacío a la entrada del nodo Tables API para activar el envío de la solicitud API. También puede añadir un nodo debug que imprima el msg.payload para ver la respuesta analizada.

Vea a continuación los resultados cuando la solicitud configurada de la API de tablas se envía a la siguiente tabla en su-subdominio.tulip.co/tables/9YHHckKcFTXHQpXEu. Observe que la respuesta devuelve las dos entradas de la tabla con el campo Estado configurado como REVISADO.

Tabla a consultar con varios registros. Incluye un campo Estado por el que podemos filtrar.

Flujo para enviar la petición API "List Records" de Tables a Tulip Table, y la carga útil de la respuesta.

Lecturas Adicionales

• README del paquete@tulip/node-red-tulip-api
• Cómo utilizar la API de tablas
• Cómo usar la API de Atributos de Máquina