8.3. REST-API-Schnittstelle
Module, Parameter und Services
Softwaremodule
(Abschnitt 6) des rc_visard heißen in der REST-API Nodes und vereinen jeweils be-
Die
stimmte algorithmische Funktionen. Über folgenden Befehl lassen sich alle Softwaremodule der REST-
API mit ihren jeweiligen Services und Parametern au isten:
curl -X GET http://<host>/api/v1/nodes
Informationen zu einem bestimmten Modul (z.B.
abrufen:
curl -X GET http://<host>/api/v1/nodes/rc _ stereocamera
Status: Während der Laufzeit stellt jedes Modul Informationen zu seinem aktuellen Status bereit. Dies
umfasst nicht nur den aktuellen Verarbeitungsstatus des Moduls (z.B.
dern die meisten Module melden auch Laufzeitstatistiken oder schreibgeschützte Parameter, so-
genannte Statuswerte. Die Statuswerte des
wie folgt abrufen:
curl -X GET http://<host>/api/v1/nodes/rc _ stereocamera/status
Bemerkung: Die zurückgegebenen Statuswerte sind modulspezi sch und werden im jeweili-
gen
Softwaremodul
Bemerkung: Statuswerte werden nur gemeldet, wenn sich das jeweilige Modul im Zustand
be ndet.
running
Parameter: Die meisten Module stellen Parameter über die REST-API des rc_visard zur Verfügung, da-
mit ihr Laufzeitverhalten an den Anwendungskontext oder die Anforderungen angepasst werden
kann. Die REST-API ermöglicht es, den Wert eines Parameters zu setzen und abzufragen. Darüber
hinaus stellt sie weitere Angaben, wie z.B. den jeweiligen Standardwert und zulässige Minimal-
bzw. Maximalwerte von Parametern, zur Verfügung.
rc _ stereomatching
Die
curl -X GET http://<host>/api/v1/nodes/rc _ stereomatching/parameters
Der
quality
-Parameter dieses Moduls könnte wie folgt auf den Wert
curl -X PUT http://<host>/api/v1/nodes/rc _ stereomatching/parameters?quality=Full
oder äquivalent
curl -X PUT --header
/api/v1/nodes/rc _ stereomatching/parameters/quality
Bemerkung: Laufzeitparameter sind modulspezi sch und werden in dem jeweiligen
modul
(Abschnitt 6) dokumentiert.
Bemerkung: Die meisten Parameter, die die Module über die REST-API anbieten, lassen sich
auch über die benutzerfreundliche
ten.
Bemerkung: Einige der Parameter, die über die REST-API des rc_visard bereitgestellt werden,
sind auch über die
lung dieser Parameter über die REST-API und die Web GUI ist verboten, solange ein GenICam-
Client verbunden ist.
Roboception GmbH
Handbuch: rc_visard
rc _ stereocamera
(Abschnitt 6) dokumentiert.
-Parameter lassen sich beispielsweise wie folgt abrufen:
'Content-Type: application/json'
Web GUI
GigE Vision 2.0/GenICam-Schnittstelle
206
) lassen sich mit folgendem Befehl
rc _ stereocamera
-Moduls lassen sich beispielsweise
-d
'{ "value": "Full" }'
(Abschnitt 8.1) des rc_visard erkunden und austes-
(Abschnitt 8.2) zugänglich. Die Einstel-
running
oder
stale
), son-
Full
gesetzt werden:
http://<host>
Software-
Rev: 21.01.1
Status: 30.01.2021