Usando o Node-RED com a API Tulip

Uso do Node-RED com a API da Tulip

Se você estiver usando o Node-RED em seu próprio dispositivo e quiser enviar dados para a API da Tulip, a Tulip fornece nós do Node-RED para endpoints da API.

Esses nós são pré-instalados nos dispositivos Tulip que suportam o Node-RED, mas se você estiver executando sua própria instância do Node-RED, ainda poderá instalar os nós instalando o pacote @tulip/node-red-tulip-api da biblioteca do Node-RED.

Neste artigo, você aprenderá a...

• adicionar nós da API da Tulip à sua instalação do Node-RED
• usar a API de atributos da Tulip Machine para enviar dados a uma Tulip Machine
• usar o nó da API Tulip Tables para ler, gravar e configurar Tulip Tables

Pré-requisitos:

• Você tem o Node-RED instalado e em execução localmente

Está executando o Node-RED no Edge MC da Tulip? Consulte este guia de introdução

Instalação do Node-RED

1. Adicione @tulip/node-red-tulip-api à sua paleta do Node-RED

Abra o editor do Node-RED e navegue até Menu → Gerenciar paleta

Clique na guia Instalar e procure por @tulip/node-red-tulip-api

Observação: você também pode instalar o pacote por meio da linha de comando. Navegue até o diretório de usuário do Node-RED (ou seja, cd ~/.node-red/) e execute npm install @tulip/node-red-tulip-api

2. Verifique se a instalação foi bem-sucedida

Se a instalação for bem-sucedida, os nós tulip-machine-attribute e tulip-tables ficarão visíveis na paleta (barra lateral esquerda) sob a categoria Tulip.

Como usar o nó de atributo da máquina Tulip

Pré-requisitos: você leu How to use the Machine Attributes API (Como usar a API de atributos de máquina), tem um token de API configurado com permissões attributes:write (atributos: gravação ) e tem um atributo de máquina específico para o qual deseja enviar dados.

1. Arraste e solte um nó de Atributo de Máquina Tulip em seu fluxo

Observação: na barra lateral direita, selecione a guia**de ajuda para visualizar a documentação sobre como usar o nó.

2. Configure o nó para corresponder ao atributo de máquina de destino.

Usaremos o seguinte atributo de máquina como exemplo. Observe que a fonte de dados da máquina é a API da Tulip.

Atributo de máquina inteiro para a máquina Tulip "Exemplo de máquina da API da Tulip".

Clique duas vezes no nó para abrir seu editor e, em seguida, configure o nó para corresponder a esse atributo de máquina. Por exemplo, você pode configurar seu nó da seguinte forma:

Configuração do nó de atributo de máquina da Tulip.

Com o nó Tulip API Authentication configurado da seguinte forma (preencha suas credenciais de autenticação):

Configuração da autenticação da API da Tulip para o token da API.

3. Teste o envio de dados.

Crie o restante do fluxo para enviar dados para o endpoint Machine Attribute.

Um fluxo de teste simples pode ser o envio do valor 0 para um endpoint Integer. Conecte a entrada do nó de atributo de máquina a um nó Inject configurado com msg.payload=0 (mostrado abaixo). Conecte a saída a um nó de depuração que imprime a mensagem completa.

Clique em Deploy para implementar o fluxo. Ao clicar no nó Inject, você deverá ver uma mensagem de depuração com um código de status 204.

Fluxo de teste que envia o valor inteiro 0 para um atributo de máquina inteiro.

Os dados também devem aparecer em sua instância do Tulip sob o atributo de máquina.

Como usar o nó da API de tabelas do Tulip

Pré-requisitos: você leu How to Use the Table API, tem um token de API configurado com permissões tables:read e tables:write e tem uma tabela específica para a qual deseja enviar dados.

1. Arraste e solte um nó do Tulip Tables em seu fluxo.

Observação: na barra lateral direita, selecione a guia**de ajuda para visualizar a documentação sobre como usar o nó.

2. Configure o nó para uma consulta específica da API do Tulip Tables.

Primeiro, clique duas vezes no nó para abrir seu editor. Defina o nó de configuração Tulip API Authentication para corresponder aos detalhes de um token de API com permissões tables:read e/ou tables:write (dependendo do fato de a consulta de tabela ser uma operação de leitura ou gravação):

Configuração do token de API de tabelas

Defina o Query Type (Tipo de consulta) como a consulta que você gostaria de executar. O restante das opções de consulta aparecerá de acordo com o tipo.

Neste exemplo, escolheremos List records para listar os registros da tabela com o ID 9YHHckKcFTXHQpXEu com o campo Status "REVIEW".

Configuração do nó da API de tabelas

JSON expandido do campo "Filters" (Filtros) do nó da API Tables.

3. Teste o envio de dados.

Crie o restante do fluxo para enviar dados para o endpoint da API de tabelas.

Um exemplo de fluxo de teste poderia conectar um nó Inject vazio à entrada do nó Tables API para acionar o envio da solicitação de API. Você também pode adicionar um nó de depuração que imprime o msg.payload para ver a resposta analisada.

Veja abaixo os resultados quando a solicitação configurada da API Tables é enviada para a seguinte tabela em your-subdomain.tulip.co/tables/9YHHckKcFTXHQpXEu. Observe que a resposta retorna as duas entradas da tabela com o campo Status definido como REVIEW.

Tabela para consulta com vários registros. Inclui um campo Status pelo qual podemos filtrar.

Fluxo para enviar a solicitação da API de tabelas "List Records" para a tabela Tulip e o payload da resposta.

Leitura adicional

• README do pacote@tulip/node-red-tulip-api
• Como usar a API de tabelas
• Como usar a API de atributos de máquina