Inhaltsverzeichnis
Werbung
Verfügbare Sprachen
Verfügbare Sprachen
BNI PNT-508-105-Z067 / BNI PNT-508-105-Z077 / BNI PNT-502-102-Z078
Netzwerkschnittstelle
4
WebUI / Webinterface (Fortsetzung)
4.7
Benachrichtigungen
Über die Navigationsleiste gelangt man mit Klick auf das
entsprechende Icon (siehe Kapitel 4.2 auf Seite 26) zu
den Benachrichtigungen (Beispiel siehe Bild 4-39).
Bild 4-39: Benachrichtigung: Aufforderung zur Passwortänderung
Mit a
kann der Benachrichtigungsverlauf
lle löSchen
gelöscht werden.
4.8
REST API
Über die REST-API-Schnittstelle können Identifikationsda-
ten, Prozessdaten und Konfigurationseinstellungen des
IO-Link-Masters und weiteren angeschlossenen Geräten
abgefragt und modifiziert werden. Die REST API-Schnitt-
stelle wird auch von der Benutzeroberfläche des Web-
Interfaces zur Kommunikation mit dem Modul verwendet.
Die Spezifikation der im Modul implementierten REST API
ist in YAML-Dateien im Gerät hinterlegt und kann herunter-
geladen (i
> l
d
nfO
OKale
OKumente
Editor angezeigt werden (http://editor.swagger.io/).
Das vorliegende Modul unterstützt folgende REST APIs:
–
Generische REST API für Balluff-Geräte und Applikati-
onen. Base-Path der REST API im Modul:
http://[ip-address]/api/balluff/v1/
–
Die von der IO-Link Community standardisierte
REST API (JSON for IO-Link).
Link zur offiziellen Dokumentation (JSON for IO-Link) im
allgemeinen Downloadbereich der IO-Link-Community:
https://io-link.com/de/Download/Download.php >
Bereich IO-Link Integration > JSON Integration for
IO-Link (ZIP-Datei)
Base-Path der REST API im Modul:
http://[ip-address]/iolink/v1/
Die JSON for IO-Link REST API spezifiziert auch
die Möglichkeit, einen MQTT-Publisher zu konfigu-
rieren. Diese Funktion ist in der aktuellen Version
dieses Moduls nicht implementiert.
Die Spezifikation JSON for IO-Link REST API
beschreibt eine weitere Funktionalität für Prozess-
daten und Parametern, welche IODD-Unterstüt-
zung benötigt. Auch diese Funktionalität ist in der
aktuellen Version nicht vollständig implementiert.
Das Modul unterstützt nur das Hochladen von
IODDs. Das Schreiben/Lesen von Prozessdaten
oder Parametern mit deren Namen wird nicht
unterstützt.
42
deutsch
) und z. B. im Swagger-
Im Folgenden wird an einigen Beispielen erläutert, wie die
REST-API angewendet wird.
–
GET-Anfragen (Kapitel 4.8.2 bis 4.8.4) können ohne
Login ausgeführt werden, da keine systemseitigen
Änderungen oder Modifizierungen vorgenommen
werden.
–
POST-Methoden (Kapitel 4.8.5 und 4.8.6) setzen die
Verwendung eines Login voraus.
4.8.1
Anmeldung
Eine Anmeldung ist möglich über folgende Adresseingabe:
http://[ip-address]/api/balluff/v1/users/login
Dabei wird ein JSON-Objekt mitgegeben, in dem wie im
folgenden Beispiel ein Benutzername und ein Passwort
(siehe dazu auch Kapitel 4.3.5 auf Seite 28) spezifiziert
sind:
{
"username": "[username]",
"password": "[password]",
}
Wenn der Login erfolgreich war, erhält
man ein Token in Form einer JSESSIONID,
wie z.B.:
{
"JSESSIONID": " 7euh07tdfawjej"
}
Dieses Token kann nun im Folgenden für die Durchführung
von POST-Methoden genutzt werden. Dafür kann eine
entsprechende Anfrage mit dem Header Authoriza-
tion: Bearer 7euh07tdfawjej ausgestattet wer-
den.
4.8.2
Abfrage der Geräteidentifikation des Moduls
Die Geräteidentifikationsdaten eines IO-Link-Masters
können über folgende Adressen abgefragt werden:
–
http://[ip-address]/api/balluff/v1/identification
–
http://[ip-address]/iolink/v1/masters/1/identification
Im Fall einer erfolgreichen Abfrage wird eine Antwort in
Form eines JSON-Objekts mit Eigenschaften wie der
vendorID, der serialNumber oder der firmwareRevision des
jeweiligen IO-Link-Masters geliefert.
Bild 4-40: Abfrage der Geräteidentifikation
Werbung
Inhaltsverzeichnis
