As the initial step to establish communication, it is necessary to check the available cameras on the connector. To achieve this, the connector shall be capable of discovering cameras (e.g., GigE cameras) and listing them for the user.
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 EnumerateDevices |
{
"TransactionID": "123456",
"Action": "EnumerateDevices"
}
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 |
| DeviceList | No | Array of Camera Devices | Array of camera devices. |
Camera Object
| Field | Optional | Type | Description |
|---|---|---|---|
| SerialNumber1 | Yes | string | Camera identification |
| UserDefinedName1 | Yes | String | Camera User-defined name |
| ModelName | No | String | Camera model |
| VendorName | No | String | Camera vendor |
| Interface | No | String | Camera interface U3V (USB3 Vision), CXP (CoaXPress), GEV (GigEVision), CamEmu (Emulation) |
| IPAddress | Yes | String | Camera IP address |
| {addtional identification fields}1 | Yes | String | Addtional device identification offered by the connector application. |
1 Device identification, must be informed on the documentation if they can be used as device identification or if there is additional fields that can be used.
{
"TransactionID": "123456",
"ReturnCode": 0,
"Message": "Cameras found.",
"DeviceList": [
{
"SerialNumber": "548451887",
"UserDefinedName": "MyCam1",
"ModelName": "Camera Model 1234",
"VendorName": "The camera Factory",
"Interface": "GEV",
"IPAddress": "192.168.0.1"
}
]
}