Korzystanie z Node-RED z interfejsem API Tulip
Jeśli korzystasz z Node-RED na własnym urządzeniu i chcesz wysyłać dane do interfejsu API Tulip, Tulip udostępnia węzły Node-RED dla punktów końcowych API.
Węzły te są preinstalowane na urządzeniach Tulip obsługujących Node-RED, ale jeśli korzystasz z własnej instancji Node-RED, nadal możesz je zainstalować, pobierając pakiet @tulip/node-red-tulip-api z biblioteki Node-RED.
W tym artykule dowiesz się, jak…
- dodać węzły API Tulip do swojej instalacji Node-RED
- korzystać z interfejsu API atrybutów maszyn Tulip w celu wysyłania danych do maszyny Tulip
- korzystać z węzła Tulip Tables API do odczytu, zapisu i konfiguracji tabel Tulip
Wymagania wstępne:
- Masz zainstalowany i uruchomiony lokalnie Node-RED
Używasz Node-RED na Tulip Edge MC? Zapoznaj się z tym przewodnikiem dla początkujących
Instalacja
1. Dodaj @tulip/node-red-tulip-api do swojej palety Node-RED
Otwórz edytor Node-RED i przejdź do Menu → Zarządzaj paletą

Kliknij kartę „Zainstaluj”, a następnie wyszukaj @tulip/node-red-tulip-api

Uwaga: Pakiet można również zainstalować za pomocą wiersza poleceń. Przejdź do katalogu użytkownika Node-RED (np. cd ~/.node-red/) i uruchom polecenie npm install @tulip/node-red-tulip-api
2. Sprawdź, czy instalacja przebiegła pomyślnie
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.

Korzystanie z węzła Tulip Machine Attribute
Wymagania wstępne: Zapoznałeś się z artykułem „Jak korzystać z interfejsu API atrybutów maszyn”, masz skonfigurowane konto usługi API z uprawnieniami attributes:report oraz dysponujesz konkretnym atrybutem maszyny, do którego chcesz wysłać dane.
1. Przeciągnij i upuść węzeł „Tulip Machine Attribute” do swojego przepływu

Uwaga: Na prawym pasku bocznym wybierz zakładkępomocy, aby wyświetlić dokumentację dotyczącą korzystania z węzła.
2. Skonfiguruj węzeł tak, aby odpowiadał docelowemu atrybutowi maszyny.
Jako przykład wykorzystamy poniższy atrybut maszyny. Należy pamiętać, że źródłem danych maszyny jest interfejs API Tulip.

Atrybut maszyny typu całkowitego dla maszyny Tulip „Example Tulip API Machine”.
Kliknij dwukrotnie węzeł, aby otworzyć jego edytor, a następnie skonfiguruj węzeł tak, aby odpowiadał temu atrybutowi maszyny. Na przykład możesz skonfigurować węzeł w następujący sposób:

Konfiguracja węzła „Atrybut maszyny Tulip”.
Z węzłem uwierzytelniania API Tulip skonfigurowanym w następujący sposób (wpisz swoje dane uwierzytelniające):

Konfiguracja uwierzytelniania API Tulip dla konta usługowego.
3. Przetestuj wysyłanie danych.
Utwórz pozostałą część przepływu, aby wysłać dane do punktu końcowego „Machine Attribute”.
Prostym przepływem testowym może być wysłanie wartości 0 do punktu końcowego typu „Integer”. Podłącz wejście węzła atrybutów maszyny do węzła „Inject” skonfigurowanego z parametrem msg.payload=0 (jak pokazano poniżej). Podłącz wyjście do węzła debugowania, który wyświetla pełną treść msg.

Kliknij przycisk „Deploy”, aby wdrożyć przepływ. Po kliknięciu węzła „Inject” powinien pojawić się komunikat debugowania z kodem stanu 204.

Przepływ testowy wysyłający wartość całkowitą 0 do atrybutu maszyny typu integer.
Dane powinny również pojawić się w Twojej instancji Tulip w sekcji atrybutów maszyny.

Korzystanie z węzła Tulip Tables API
Wymagania wstępne: Zapoznałeś się z artykułem „Jak korzystać z Table API”, masz skonfigurowane konto usługi API z uprawnieniami „tables:read” i „tables:write” oraz dysponujesz konkretną tabelą, do której chcesz wysłać dane.
1. Przeciągnij i upuść węzeł „Tulip Tables” do swojego przepływu.

Uwaga: Na prawym pasku bocznym wybierz zakładkępomocy, aby wyświetlić dokumentację dotyczącą korzystania z węzła.
2. Skonfiguruj węzeł pod kątem konkretnego zapytania do interfejsu API Tulip Tables.
Najpierw kliknij dwukrotnie węzeł, aby otworzyć jego edytor. Skonfiguruj węzeł „Uwierzytelnianie API Tulip” zgodnie ze szczegółami konta usługi 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 konta usługowego API Tables
Ustaw typ zapytania na zapytanie, które chcesz wykonać. Pozostałe opcje zapytania pojawią się wówczas zgodnie z typem.
W tym przykładzie wybierzemy opcję „List records ”, aby wyświetlić rekordy w tabeli o identyfikatorze 9YHHckKcFTXHQpXEu, w której pole „Status” ma wartość „REVIEW”.

Konfiguracja węzła interfejsu API tabel

Rozwiń pole „Filters” w węźle API tabel.
3. Przetestuj wysyłanie danych.
Utwórz pozostałą część przepływu, aby wysłać dane do punktu końcowego Tables API.
Przykładowy przepływ testowy mógłby polegać na podłączeniu pustego węzła „Inject” do wejścia węzła Tables API w celu wywołania wysłania żądania API. Można również dodać węzeł debugowania, który wyświetla wartość `msg.payload`, aby zobaczyć przeanalizowaną odpowiedź.
Poniżej przedstawiono wyniki wysłania skonfigurowanego żądania do interfejsu API tabel do następującej tabeli pod adresem your-subdomain.tulip.co/tables/9YHHckKcFTXHQpXEu. Należy zauważyć, że odpowiedź zwraca dwa wpisy tabeli z polem Status ustawionym na REVIEW.

Tabela do zapytania zawierająca kilka rekordów. Zawiera pole „Status”, według którego możemy filtrować wyniki.

Schemat wysyłania żądania „List Records” do interfejsu API Tables w tabeli Tulip oraz treść odpowiedzi.
Więcej informacji
- Plik README pakietu
@tulip/node-red-tulip-api - Jak korzystać z interfejsu API tabeli
- Jak korzystać z interfejsu API atrybutów maszyn
