So verwenden Sie die API für Maschinenattribute

Wie man die API für Maschinenattribute verwendet

Erstellen Sie eine Tulip-Maschine mit Daten von Node-RED, Python oder anderen Diensten.

:::(Info) (HINWEIS) Fortgeschrittener Artikel - setzt Erfahrung mit REST-APIs voraus. :::

Zusammenfassung

Mit der Maschinen-Attribute-API können Sie Daten an ein bestimmtes Attribut einer Maschine über eine RESTful-API mit dem Endpunkt /attributes/report senden. Dies ermöglicht viele flexible Optionen zur Integration mit Tulip aus Node-RED, Python oder anderen Sprachen und Diensten.

Einrichten der Maschinen-API

Hinweis: Wenn Sie bereits eine Tulip Table API eingerichtet haben, können Sie diesen API-Schlüssel und das Geheimnis verwenden

1. Navigieren Sie zu Ihren Einstellungen > API Token
2. Klicken Sie auf API Token erstellen in der oberen rechten Ecke Ihres Bildschirms
3. Benennen Sie Ihr API Token und wählen Sie attributes:write für den Geltungsbereich:

1. Ein Modal mit Ihrem API-Schlüssel, Geheimnis und Auth Header wird angezeigt. Bitte speichern Sie diese Informationen, da sie nicht mehr abgerufen werden können!

Herzlichen Glückwunsch - Sie haben Ihre Maschinen-API offiziell eingerichtet!

Einrichten einer neuen Maschine

Sobald Sie Ihre Maschinen-API eingerichtet haben, wird eine neue Maschinendatenquelle in Ihrer Instanz angezeigt. Um diese Datenquelle zu sehen, klicken Sie auf Shop Floor > Maschinen und navigieren Sie zu Maschinendatenquellen:

Sie müssen eine neue Maschine erstellen, die mit dieser Datenquelle verknüpft ist. Um eine neue Maschine zu erstellen, navigieren Sie zu Maschinenbibliothek und klicken Sie auf Maschine erstellen.

Das folgende Modal wird angezeigt:

1. Maschinenname (erforderlich): Name der Maschine
2. Maschinen-Datenquelle (Erforderlich): Wählen Sie Tulip API
3. Station (Optional)
4. Typ (Erforderlich): Wenn kein Typ verfügbar ist, erstellen Sie zuerst einen Typ, in diesem Beispiel heißt der erstellte Typ Standard

Nun, da Ihre Maschine erstellt ist, müssen Sie ein Attribut hinzufügen. Klicken Sie auf Bearbeiten oben rechts auf Ihrem Bildschirm. Klicken Sie dann auf die Schaltfläche + oben rechts auf Ihrem Bildschirm:

Da noch keine Maschinenattribute erstellt wurden, klicken Sie auf den blauen Maschinentyp, in diesem Fall auf Standard.

Dadurch gelangen Sie zu dem Maschinentyp, der der Maschine zugeordnet ist. Drücken Sie auf die Schaltfläche Bearbeiten in der oberen rechten Ecke des Bildschirms.

Drücken Sie dann auf die Schaltfläche + neben Maschinenattribute in der unteren linken Ecke.

Drücken Sie nun auf + Maschinenattribut erstellen in der rechten unteren Ecke

In diesem Beispiel werden wir ein Zähler-Attribut vom Typ Integer erstellen.

Sobald Ihr Attribut erstellt ist, klicken Sie auf das Zählerattribut in der Liste der Maschinenattribute und drücken Sie dann auf die Schaltfläche Speichern in der oberen rechten Ecke

Gehen Sie zurück zu Ihrer Maschinenseite.

Nun, da Ihr Maschinenattribut erstellt ist, können Sie es zu Ihrer Maschine hinzufügen. Klicken Sie auf die Schaltfläche Bearbeiten in der rechten oberen Ecke. Klicken Sie dann auf die Schaltfläche + in der rechten oberen Ecke und wählen Sie das soeben erstellte Zählerattribut aus:

Klicken Sie bitte auf Speichern in der oberen rechten Ecke.

Ihre Tulip-Instanz ist jetzt mit der Maschinen-API, einer Maschine und einem Maschinen-Attribut eingerichtet - jetzt können Sie von überall aus Daten an eine Tulip-Maschine senden!

Von hier aus können Sie die attributeId und machineID für das Attribut Zähler sehen. Diese Informationen können durch Anklicken des Symbols kopiert werden und werden dann im Body der http-Anfrage verwendet.

Um dies zu tun, müssen Sie mit REST-APIs vertraut sein. Eine vollständige Dokumentation über die Verwendung des Endpunkts /attributes/report, einschließlich der Abfrageparameter und des Body-Formats, finden Sie unter your-company.tulip.co/apidocs oder indem Sie dem Link auf der Seite API Token folgen...

... und in den Docs gibt es einen Abschnitt für Machine Monitoring

Weitere Lektüre

Schauen Sie sich diesen Artikel an, wenn Sie die API weiter ausbauen und sehen möchten, wie sie mit Edge MC und Node-RED verwendet werden kann!