Additionally to the parameters settings, the quick setting feature provides a way to quickly define the most commonly used parameters. These parameters use common known names, and the connector is expected to map them internally to the camera correspondent parameter.
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 SetQuickParameters |
| DeviceID | No | String | Device identification. |
| Width | Yes | Integer/String | Image width1 |
| PixelFormat | Yes | Integer/String | Pixel format1,2 |
| Height | Yes | Integer/String | Image Height1 |
| Gain | Yes | Float/Int/String | Gain1. The string Auto can be used to activate automatic gain. |
| ExposureTime | Yes | Float/Int/String | Exposure time in microseconds1. The string Auto can be used to activate automatic exposure. |
1 Camera dependent values, invalid values shall be informed on the returning error message. 2 Genicam standardized Pixel Format, according with the Genicam Naming Convention as described in section 4.35 GenICam_PFNC_2_4.pdf.
{
"TransactionID": "23456435",
"Action": "SetQuickParameters",
"DeviceID": "548451887",
"Width": 800,
"Height": 600,
"Gain": "Auto",
"PixelFormat": "Mono8",
"ExposureTime": 234.5
}
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 |
{
"TransactionID": "23456435",
"ReturnCode": 0,
"Message": "Paramters updated."
}