Używanie Node-RED z Tulip API

Używanie Node-RED z Tulip API

Jeśli używasz Node-RED na własnym urządzeniu i chciałbyś wysyłać dane do API Tulipa, Tulip dostarcza węzły Node-RED dla punktów końcowych API.

Węzły te są preinstalowane na urządzeniach Tulip, które obsługują Node-RED, ale jeśli uruchamiasz własną instancję Node-RED, nadal możesz zainstalować węzły, instalując pakiet @tulip/node-red-tulip-api z biblioteki Node-RED.

W tym artykule dowiesz się, jak...

• dodać węzły Tulip API do swojej instalacji Node-RED
• używać Tulip Machine Attribute API do wysyłania danych do Tulip Machine
• używać węzła Tulip Tables API do odczytu, zapisu i konfiguracji Tulip Tables

Wymagania wstępne:

• Masz zainstalowany i uruchom iony lokalnie Node-RED

Uruchomić Node-RED na Tulip's Edge MC? Zobacz ten przewodnik jak zacząć

Instalacja

1. Dodaj @tulip/node-red-tulip-api do swojej palety Node-RED

Otwórz swój edytor Node-RED i przejdź do Menu → Zarządzaj paletą

Kliknij na zakładkę Install, a następnie wyszukaj @tulip/node-red-tulip-api

Uwaga: Możesz również zainstalować pakiet poprzez linię poleceń. Przejdź do swojego katalogu użytkownika Node-RED (np. cd ~/.node-red/) i uruchom npm install @tulip/node-red-tulip-api

2. Sprawdź, czy instalacja zakończyła się sukcesem

Jeśli instalacja przebiegła pomyślnie, węzły tulip-machine-attribute i tulip-tables będą widoczne w palecie (lewy pasek boczny) w kategorii Tulip.

Używanie węzła atrybutów maszyny Tulipa

Wymagania wstępne: Przeczytałeś Jak używać API atrybutów maszynowych Masz bota API skonfigurowanego z uprawnieniami attributes:write, i masz określony atrybut maszyny, do którego chcesz wysłać dane.

1. Przeciągnij i upuść węzeł Tulip Machine Attribute do swojego przepływu.

Uwaga: W prawym pasku bocznym, wybierz zakładkę**pomocy, aby zobaczyć dokumentację na temat korzystania z węzła.

2. Skonfiguruj węzeł, aby pasował do docelowego atrybutu maszyny.

Użyjemy następującego atrybutu maszyny jako przykładu. Zauważ, że źródłem danych maszyny jest Tulip API.

Integer atrybut maszyny dla Tulip Machine "Przykładowa maszyna Tulip API".

Kliknij dwukrotnie na węzeł, aby otworzyć jego edytor, a następnie skonfiguruj węzeł, aby dopasować go do tego atrybutu maszyny. Na przykład, możesz skonfigurować węzeł w następujący sposób:

Konfiguracja węzła Tulip Machine Attribute.

Z węzłem Tulip API Authentication skonfigurowanym w następujący sposób (wypełnij swoje dane uwierzytelniające):

Konfiguracja Tulip API Authentication dla bota API.

3. Przetestuj wysyłanie danych.

Utwórz resztę przepływu, aby wysłać dane do punktu końcowego Machine Attribute.

Prosty przepływ testowy może polegać na wysłaniu wartości 0 do punktu końcowego Integer. Podłącz wejście węzła atrybutu maszyny do węzła Inject skonfigurowanego z msg.payload=0 (pokazane poniżej). Podłącz wyjście do węzła debugowania, który wypisuje pełny komunikat.

Kliknij przycisk Wdrożenie, aby wdrożyć przepływ. Po kliknięciu węzła Inject, powinieneś zobaczyć komunikat debugowania z kodem stanu 204.

Przepływ testowy, który wysyła wartość całkowitą 0 do atrybutu maszyny integer.

Dane powinny również pojawić się na twojej instancji Tulipa pod atrybutem maszyny.

Używanie węzła API Tulip Tables

Wymagania wstępne: Przeczytałeś Jak używać API tabel, masz bota API skonfigurowanego z uprawnieniami tables:read i tables:write, oraz masz określoną tabelę, do której chcesz wysłać dane.

1. Przeciągnij i upuść węzeł Tulip Tables do swojego przepływu.

Uwaga: W prawym pasku bocznym wybierz zakładkę**pomoc, aby zobaczyć dokumentację na temat używania węzła.

2. Skonfiguruj węzeł dla konkretnego zapytania API Tulip Tables.

Najpierw kliknij dwukrotnie na węzeł, aby otworzyć jego edytor. Ustaw węzeł konfiguracji Tulip API Authentication, aby dopasować szczegóły bota API z uprawnieniami tables:read i/lub tables:write (w zależności od tego, czy zapytanie do tabeli jest operacją odczytu czy zapisu):

Konfiguracja bota API Tables

Ustaw typ zapytania na zapytanie, które chcesz wykonać. Reszta opcji Query Options pojawi się wtedy zgodnie z typem.

W tym przykładzie wybierzemy List records, aby wylistować rekordy tabeli o id 9YHHckKcFTXHQpXEu z polem Status "REVIEW".

Konfiguracja węzła API Tabele

Rozwinięty JSON z pola "Filtry" węzła API Tabeli.

3. Przetestuj wysyłanie danych.

Utwórz resztę przepływu, aby wysłać dane do punktu końcowego Tables API.

Przykładowy przepływ testowy mógłby podłączyć pusty węzeł Inject do wejścia węzła Tables API, aby uruchomić wysyłanie żądania API. Można również dodać węzeł debugowania, który drukuje msg.payload, aby zobaczyć sparsowaną odpowiedź.

Zobacz poniżej wyniki, gdy skonfigurowane żądanie Tables API jest wysyłane do następującej tabeli w your-subdomain.tulip.co/tables/9YHHckKcFTXHQpXEu. Zauważ, że odpowiedź zwraca dwa wpisy tabeli z polem Status ustawionym na REVIEW.

Tabela do zapytania z kilkoma rekordami. Zawiera pole Status, po którym możemy filtrować.

Przepływ do wysyłania żądania API "List Records" Tables do Tulip Table, oraz ładunek odpowiedzi.

Dalsze czytanie

• @tulip/node-red-tulip-api pakiet README
• Jak korzystać z API tabel
• Jak korzystać z API atrybutów maszyn