Use o Node-RED com a API da Tulip

Prev Next

Usando o 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 pontos de extremidade da API.

Esses nós vêm pré-instalados nos dispositivos Tulip compatíveis com o Node-RED, mas, se você estiver executando sua própria instância do Node-RED, ainda poderá instalá-los instalando o pacote @tulip/node-red-tulip-api da biblioteca do Node-RED.

Neste artigo, você aprenderá como…

  • adicionar nós da API do Tulip à sua instalação do Node-RED
  • usar a API de Atributos de Máquina do Tulip para enviar dados a uma Máquina Tulip
  • usar o nó da API de Tabelas do Tulip para ler, gravar e configurar Tabelas do Tulip

Pré-requisitos:

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

Instalação

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

Abra seu editor do Node-RED e acesse Menu → Gerenciar paleta

Clique na aba “Instalar” e, em seguida, procure por @tulip/node-red-tulip-api

Observação: você também pode instalar o pacote pela linha de comando. Navegue até o diretório de usuário do Node-RED (por exemplo, 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) na categoria Tulip`.

Usando o nó de atributos de máquina do Tulip

Pré-requisitos: você leu “Como usar a API de atributos de máquina ”, possui uma conta de serviço da API configurada com permissões para `attributes:report ` e tem um atributo de máquina específico para o qual deseja enviar dados.

1. Arraste e solte um nó “Tulip Machine Attribute” em seu fluxo

Observação: na barra lateral direita, selecione a guia*“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 do Tulip.

Atributo de máquina do tipo inteiro para a máquina Tulip “Exemplo de máquina da API Tulip”.

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

Configuração do nó “Atributo da máquina Tulip”.

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

Configuração de autenticação da API do Tulip para conta de serviço.

3. Teste o envio de dados.

Crie o restante do fluxo para enviar dados ao endpoint “Atributo da Máquina”.

Um fluxo de teste simples pode ser enviar o valor 0 para um endpoint do tipo Integer. Conecte a entrada do nó “Machine Attribute” a um nó “Inject” configurado com msg.payload=0 (conforme mostrado abaixo). Conecte a saída a um nó de depuração que exiba a mensagem completa.

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

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

Os dados também devem aparecer na sua instância do Tulip no atributo de máquina.

Usando o nó da API de tabelas do Tulip

Pré-requisitos: você leu “Como usar a API de tabelas ”, possui uma conta de serviço de API configurada com as 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ó “Tulip Tables” em seu fluxo.

Observação: na barra lateral direita, selecione a guia*“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 a configuração de autenticação da API do Tulip para que corresponda aos detalhes de uma conta de serviço da API com permissões tables:read e/ou tables:write (dependendo se a consulta à tabela é uma operação de leitura ou gravação):

Configuração da conta de serviço da API do Tables

Defina o “Tipo de consulta” como a consulta que você deseja executar. As demais “Opções de consulta ” serão exibidas de acordo com o tipo.

Neste exemplo, escolheremos “Listar registros ” para listar os registros da tabela com o ID 9YHHckKcFTXHQpXEu cujo campo “Status” seja “REVIEW”.

Configuração do nó da API de Tabelas

JSON expandido do campo “Filtros” do nó da API de tabelas.

3. Teste o envio de dados.

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

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

Veja abaixo os resultados quando a solicitação configurada da API de Tabelas é 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 a ser consultada com vários registros. Inclui um campo Status pelo qual podemos filtrar.

Fluxo para enviar a solicitação “List Records” da API de Tabelas à tabela do Tulip e a carga útil da resposta.

Leitura complementar