Eine Liste der Parameter wird auf Anfrage des Anwendungsbenutzers bereitgestellt. Um die Parameterliste anzufordern, muss der Benutzer die folgende Nachricht senden.
Nachrichtenumschlag für ZMQ-Nachricht
| Rahmen | Feld | Beschreibung | Typ |
|---|---|---|---|
| 1 | payload | Nutzlast der Methode | Binärer String (UTF-8) |
Nutzlast
| Feld | Optional | Typ | Beschreibung |
|---|---|---|---|
| Transaktions-ID | Ja | String | Identifizierung von Transaktionen. |
| Aktion | Nr. | String | Methode aufgerufen. Fester Wert GetParameters |
| Geräte-ID | Nr. | String | Geräte-Identifikation. |
| ParameterListe | Nr. | Array der Zeichenfolge | Die Liste der Parameter, die ausgelesen werden sollen. |
{
"TransactionID": "2345645",
"Action": "GetParameters",
"DeviceID": "548451887",
"ParameterList": [
"Width",
"Height"
]
}
Antwort
| Rahmen | Feld | Beschreibung | Typ |
|---|---|---|---|
| 1 | payload | Response-Objekt | Binärer String (UTF-8) |
Response-Objekt
| Feld | Optional | Typ | Beschreibung |
|---|---|---|---|
| Transaktions-ID | Ja | String | Identifizierung von Transaktionen. |
| Rückgabe-Code | Nr. | Integer | Meldungscode, der auf Meldungscodes](#message-codes) folgt [. |
| Meldung | Ja | String | Antwort-Nachricht |
| ParameterListe | Nr. | Parameter-Objekt-Array | Parameter-Objekt-Array, das die Parameterdetails enthält |
Parameter-Objekt
| Feld | Optional | Typ | Beschreibung |
|---|---|---|---|
| Name | Nr. | String | Eindeutiger Parametername. |
| Anzeigename | Ja | String | Anzeigbarer Name des Parameters für die Benutzeroberfläche. |
| Typ | Nr. | String | Parameterwerttyp. Mögliche Werte: String, Integer, Float, Enumeration, Boolean, Command |
| Wert | Ja | Zeichenfolge/Int/Float/Bool | Aktuell definierter Wert. Bei Enumerationen ist dies die definierte Zeichenfolge. Ist nicht verfügbar, wenn Typ auf Befehl oder Lesbar auf Wahr festgelegt ist. |
| IntWert | Ja | Integer | Bei Enumerationen ist es die definierte ganze Zahl. |
| Lesenswert | Nr. | Boolesch | Flag, das angibt, ob der Parameter gelesen werden kann. Beachten Sie, dass das lesbare Flag vom aktuellen Kamerastatus abhängt. |
| Schreibbar | Nr. | Boolesch | Flag, das angibt, ob der Parameter geschrieben werden kann. Beachten Sie, dass das beschreibbare Flag vom aktuellen Kamerastatus abhängt. |
| Minimum | Ja | Ein-/Ausweichtaste | Minimal zulässiger Wert für numerische Typparameter |
| Maximum | Ja | Ein-/Ausweichtaste | Maximal zulässiger Wert für numerische Typparameter |
| Zunahme | Ja | Ein-/Ausweichtaste | Zulässiges Inkrement für den Parameter. |
| Vertretung | Ja | String | Informationen darüber, wie dieser Parameter in einer Benutzeroberfläche dargestellt werden soll. Dies ist nur für Integer- und Float-Parameter verfügbar. Mögliche Werte: Linear, Logarithmisch, Reinzahl, Boolesch, HexZahl, IPV4Address, MACAddress |
| Alias | Ja | String | Name eines Alias-Parameters. Ein Alias-Parameter stellt die gleiche Funktionalität dar, aber in einer anderen Form (z. B. könnte ein float-Parameter einen Integer-Parameter als Alias haben). |
| Enumerationseinträge | Ja | Array für Enumerationseinträge | Array mit den für den Parameter verfügbaren Einträgen. Dies wird von Parametern verwendet, die Enumerationen verwenden. |
Enumerations-Einträge
| Feld | Optional | Typ | Beschreibung |
|---|---|---|---|
| Anzeigename | Ja | String | Dies stellt den Namen der Eigenschaft für den Benutzer dar |
| Wert | Nr. | String | Parameterwert, der zum Festlegen des Parameterwerts verwendet werden muss |
| IntWert | Nr. | Integer | Ganzzahliger Wert des Enumerationseintrags |
| Beschreibung | Ja | String | Beschreibung des Enum-Eintrags. |
{
"TransactionID": "2345645",
"ReturnCode": 0,
"Message": "Parameters read successfully",
"ParameterList": [
{
"Name": "Width",
"DisplayName": "Width",
"Type": "Integer",
"Value": 1024,
"Writable": true,
"Minimum": 1,
"Maximum": 4096,
"Increment": 1,
"Representation": "Linear",
"Alias": "ImageWidth"
},
{
"Name": "PixelFormat",
"DisplayName": "Pixel Format",
"Type": "Enumeration",
"Value": "Mono8",
"IntValue": 17301505,
"Writable": true,
"EnumEntries": [
{
"DisplayName": "Mono 8",
"Value": "Mono8",
"IntValue": 17301505,
"Description": "This enumeration value sets the pixel format to Mono 8."
},
{
"DisplayName": "Mono 10",
"Value": "Mono10",
"IntValue": 17825795,
"Description": "This enumeration value sets the pixel format to Mono 10."
},
{
"DisplayName": "Mono 12",
"Value": "Mono12",
"IntValue": 17825797,
"Description": "This enumeration value sets the pixel format to Mono 12."
},
{
"DisplayName": "Mono 16",
"Value": "Mono16",
"IntValue": 17825799,
"Description": "This enumeration value sets the pixel format to Mono 16."
}
]
}
]
}