A list of parameters shall be provided when requested by the application user. To request the parameter list, the user shall send the following message.
Message Envelope For ZMQ Message
| Frame | Field | Description | Type |
|---|---|---|---|
| 1 | payload | Method payload | Binary String (UTF-8) |
payload
| Field | Optional | Type | Description |
|---|---|---|---|
| TransactionID | Yes | String | Transaction identification. |
| Action | No | String | Method called. Fixed value GetParameters |
| DeviceID | No | String | Device identification. |
| ParameterList | No | Array of String | The list of parameters that shall be read. |
{
"TransactionID": "2345645",
"Action": "GetParameters",
"DeviceID": "548451887",
"ParameterList": [
"Width",
"Height"
]
}
Response
| Frame | Field | Description | Type |
|---|---|---|---|
| 1 | payload | Response object | Binary String (UTF-8) |
Response Object
| Field | Optional | Type | Description |
|---|---|---|---|
| TransactionID | Yes | String | Transaction identification. |
| ReturnCode | No | Integer | Message code following Message Codes. |
| Message | Yes | String | Response message |
| ParameterList | No | Parameter Object Array | Parameter Object Array containing the parameters details |
Parameter Object
| Field | Optional | Type | Description |
|---|---|---|---|
| Name | No | String | Unique parameter name. |
| DisplayName | Yes | String | Displayable name of the parameter for user interface. |
| Type | No | String | Parameter value type. Possible values: String, Integer, Float, Enumeration, Boolean |
| Value | Yes | String/Int/Float/Bool | Current defined value. On enumerations, it is the string defined. |
| IntValue | Yes | Int | On enumerations, it is the integer defined. |
| Readable | No | Boolean | Flag indicating if the parameter can be read. Be aware that the readable flag depends of the current camera state. |
| Writable | No | Boolean | Flag indicating if the parameter can be written. Be aware that the writable flag depends of the current camera state. |
| Minimum | Yes | Int/Float | Minimum allowed value for numeric type parameters |
| Maximum | Yes | Int/Float | Maximum allowed value for numeric type parameters |
| Increment | Yes | Int/Float | Allowed increment for the parameter. |
| EnumEntries | Yes | Enum Entries Array | Array containing the entries available for the parameter. This is used by parameters that use enumerations. |
Enum Entries
| Field | Optional | Type | Description |
|---|---|---|---|
| DisplayName | Yes | String | This represents the name of the property to the user |
| Value | No | String | Parameter value that needs to be used to set the parameter value |
| IntValue | No | Int | Integer value of the enum entry |
| Description | Yes | String | Enum entry description. |
{
"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
},
{
"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."
}
]
}
]
}