Rest-Api-Schnittstelle; Allgemeine Struktur Der Programmierschnittstelle (Api) - Roboception rc visard Bedienungsanleitung

lässt sich der Tiefenfehler ��
�� =
������
Für nähere Informationen zu Disparitäts-, Fehler- und Konfidenzbildern siehe

7.2 REST-API-Schnittstelle

Neben der GenICam-Schnittstelle
Schnittstelle (REST-API), auf die jeder HTTP-Client und jede HTTP-Bibliothek zugreifen kann. Während die
meisten Parameter, Services und Funktionen auch über die benutzerfreundliche
gänglich sind, dient die REST-API eher als Maschine-Maschine-Schnittstelle für folgende programmgesteuerte
Aufgaben:
• Setzen und Abrufen der Laufzeitparameter der Softwaremodule, z. B. der Stereokamera, der Disparitätsbe-
rechnung und der visuellen Odometrie;
• Aufrufen von Services, z. B. zum Starten und Stoppen einzelner Softwaremodule, oder zum Nutzen spezi-
eller Funktionen, wie der Hand-Auge-Kalibrierung;
• Konfiguration von Datenströmen, die, wie in
dynamischen Zustandsschätzungen
• Abruf des aktuellen Systemstatus und des Status einzelner Softwaremodule; sowie
• Aktualisierung der Firmware des rc_visard oder seiner Lizenz.
Hinweis: In der REST-API des rc_visard bezeichnet der Begriff node ein Softwaremodul, das gewisse al-
gorithmische Funktionen bündelt und eine ganzheitliche Benutzeroberfläche (Parameter, Services, aktueller
Status) besitzt. Beispiele für solche Module sind das Stereo-Matching-Modul oder das Modul der visuellen
Odometrie.

7.2.1 Allgemeine Struktur der Programmierschnittstelle (API)

Der allgemeine Einstiegspunkt zur Programmierschnittstelle (API) des rc_visard ist
wobei entweder die IP-Adresse des Geräts ist oder sein dem jeweiligen DHCP-Server bekannter
<rcvisard>
Host-Name (siehe Netzwerkkonfiguration, Abschnitt 4.3). Greift der Benutzer über einen Webbrowser auf diese
Adresse zu, kann er die Programmierschnittstelle während der Laufzeit mithilfe der
erkunden und testen.
Für die eigentlichen HTTP-Anfragen wird dem Einstiegspunkt der Programmierschnittstelle die aktuelle Version
der Schnittstelle als Postfix angehangen, d. h.
API gesandt und von ihr empfangen werden, entsprechen dem JSON-Datenformat (JavaScript Object Notation).
Die Programmierschnittstelle ist so gestaltet, dass der Benutzer die in
schnitt 7.2.2) aufgelisteten sogenannten Ressourcen über die folgenden HTTP-Anforderungen anlegen, abrufen,
ändern und löschen kann.
Anfragetyp
GET
PUT
DELETE
POST
7.2. REST-API-Schnittstelle
(in Metern) mit den GenICam-Parametern wie folgt berechnen:
������
�� Scan3dCoordinateScale FocalLengthFactor �� Baseline
����
(�� Scan3dCoordinateScale)
����
(Abschnitt 7.1) bietet der rc_visard eine umfassende RESTful-Web-
Die rc_dynamics-Schnittstelle
(Abschnitt 6.3.2) des rc_visard bereitstellen;
http://<rcvisard>/api/v1
2
Stereo-Matching
Verfügbare Ressourcen und Anfragen
Beschreibung
Zugriff auf eine oder mehrere Res-
sourcen und Rückgabe des Ergeb-
nisses im JSON-Format
Änderung einer Ressource und
Rückgabe der modifizierten Res-
source im JSON-Format
Löschen einer Ressource
Upload einer Datei (z. B. einer Li-
zenz oder eines Firmware-Images)
.
(Abschnitt 6.2).
Web GUI (Abschnitt 4.5) zu-
(Abschnitt 7.3) beschrieben, die
http://<rcvisard>/api/
Swagger UI (Abschnitt 7.2.4)
. Alle Daten, die an die REST-
(Ab-
71