Roboception rc visard Montage- Und Betriebsanleitung Seite 235

8.3. REST-API-Schnittstelle
Parameter: Darstellung der Laufzeitparameter eines Moduls: Der Datentyp des Werts („value") eines
Parameters (und damit der Datentyp der Felder „min", „max" und „default") lässt sich vom Feld
„type" ableiten und kann ein primitiver Datentyp sein.
Ein Objekt des Typs Parameter besitzt folgende Eigenschaften:
• default (Typ nicht de niert): ab Werk voreingestellter Wert des Parameters.
• description (string): Beschreibung des Parameters.
• max (Typ nicht de niert): Höchstwert, der diesem Parameter zugewiesen werden kann.
• min (Typ nicht de niert): Mindestwert, der diesem Parameter zugewiesen werden kann.
• name (string): Name des Parameters.
• type (string): als Zeichenfolge dargestellter primitiver Datentyp des Parameters (mögliche
Werte: bool , int8
string ).
• value (Typ nicht de niert): aktueller Wert des Parameters.
Musterobjekt
{
"default": {},
"description": "string",
"max": {},
"min": {},
"name": "string",
"type": "string",
"value": {}
}
Parameter-Objekte werden in folgenden Anfragen verwendet:
• GET /nodes/{node}/parameters
•
PUT /nodes/{node}/parameters
• GET /nodes/{node}/parameters/{param}
•
PUT /nodes/{node}/parameters/{param}
ParameterNameValue: Parametername und -wert. Der Typ des Parameterwerts (Felder ‚value' und
‚min', ‚max', ‚default') ist durch das Feld ‚type' angegeben und kann einer der eingebauten primiti-
ven Datentypen sein.
Ein Objekt des Typs ParameterNameValue besitzt folgende Eigenschaften:
• name (string): Name des Parameters.
• value (Typ nicht de niert): aktueller Wert des Parameters.
Musterobjekt
{
"name": "string",
"value": {}
}
ParameterNameValue-Objekte werden in folgenden Anfragen verwendet:
•
PUT /nodes/{node}/parameters
ParameterValue: Parameterwert. Der Typ des Parameterwerts (Felder ‚value' und ‚min', ‚max',
‚default') ist durch das Feld ‚type' angegeben und kann einer der eingebauten primitiven Datenty-
pen sein.
Ein Objekt des Typs ParameterValue besitzt folgende Eigenschaften:
Roboception GmbH
Handbuch: rc_visard
, uint8 , int16 , uint16 , int32
234
, uint32 , int64 , uint64 , float32 , float64 oder
Rev: 21.01.1
Status: 30.01.2021