- Wydrukować
Jak korzystać z API atrybutów maszyn
Jak używać API atrybutów maszyny
Utwórz Tulip Machine używając danych z Node-RED, Python lub innych usług.
Artykuł zaawansowany - zakłada wcześniejsze doświadczenie z REST API
Podsumowanie
API atrybutów maszyn pozwala na wysyłanie danych do konkretnego atrybutu maszyny poprzez RESTful API używając punktu końcowego /attributes/report
. Umożliwia to wiele elastycznych opcji integracji z Tulipanem z Node-RED, Pythona lub innych języków i usług.
Konfiguracja API maszyny
Uwaga: Jeśli masz już skonfigurowane API Tulip Table, możesz użyć tego klucza i sekretu API
- Przejdź do swoich ustawień > Boty
- Kliknij " Stwórz bota" w prawym górnym rogu ekranu.
- Nazwij swojego bota, i wybierz
atrybuty:write
dla jego zakresu:
- Pojawi się modal z Twoim kluczem API, sekretem i nagłówkiem autoryzacji. Proszę zapisać te informacje, ponieważ nie będą one dostępne ponownie!
Gratulacje - oficjalnie skonfigurowałeś swój Machine API!
Konfiguracja nowej maszyny
Po skonfigurowaniu Machine API, na twojej instancji pojawi się nowe źródło danych maszyny. Aby zobaczyć to źródło danych, kliknij w Shop Floor > Machines i przejdź do Machine Data Sources:
Będziesz musiał stworzyć nową maszynę powiązaną z tym źródłem danych. Aby utworzyć nową maszynę przejdź do Biblioteki maszyn i kliknij Utwórz maszynę.
Pojawi się następujący modal:
- Nazwa maszyny (wymagane): Nazwa maszyny
- Źródło danych maszyny (wymagane): Wybierz Tulip API
- Stacja (opcjonalnie)
- Typ (Wymagane): Jeśli żaden typ nie jest dostępny utwórz najpierw typ, w tym przykładzie utworzony typ nazywa się default
Teraz, gdy twoja maszyna jest utworzona, musisz dodać atrybut. Kliknij na Edit w prawym górnym rogu ekranu. Następnie kliknij na przycisk + w prawym górnym rogu ekranu:
Ponieważ żadne atrybuty maszyny nie zostały jeszcze utworzone naciśnij Typ maszyny na niebiesko, w tym przypadku jest to Domyślny.
Spowoduje to przejście do Typu maszyny związanego z maszyną. Naciśnij przycisk Edytuj w prawym górnym rogu ekranu.
Następnie naciśnij przycisk + obok atrybutów maszyny w lewym dolnym rogu.
Teraz naciśnij + Utwórz atryb ut maszyny w prawym dolnym rogu.
Dla tego przykładu, będziemy tworzyć atrybut Counter typu Integer.
Po utworzeniu atrybutu, kliknij atrybut Counter na liście atrybutów maszyny, a następnie naciśnij przycisk Zapisz w prawym górnym rogu.
Wróć do strony swojej maszyny.
Teraz, gdy twój atrybut maszyny jest utworzony, możesz dodać go do swojej maszyny. Naciśnij przycisk Edytuj w prawym górnym rogu. Następnie kliknij przycisk + w prawym górnym rogu i wybierz atrybut Counter, który właśnie stworzyłeś:
Proszę kliknąć Zapisz w prawym górnym rogu.
Twoja instancja Tulipa jest teraz skonfigurowana z API maszyny, maszyną i atrybutem maszyny - teraz możesz wysyłać dane do maszyny Tulipa z dowolnego miejsca!
Stąd możesz zobaczyć attributeId
i machineID
dla atrybutu Counter. Te informacje mogą być skopiowane przez kliknięcie ikony i będą użyte w treści żądania http.
Aby to zrobić, będziesz musiał być zaznajomiony z interfejsami API REST. Pełną dokumentację dotyczącą korzystania z punktu końcowego /attributes/report
, w tym parametrów zapytania i formatu ciała, można znaleźć na stronie your-company.tulip.co/apidocs lub podążając za linkiem na stronie Boty...
... a w dokumentach znajduje się sekcja dotycząca monitorowania maszyn
Dalsze czytanie
Sprawdź ten artykuł, jeśli chcesz rozwinąć API i zobaczyć, jak można go użyć z Edge MC i Node-RED!