Usually, Genicam cameras demand the connection to be open before starting to set parameters and image streaming. This connection is an exclusive access, meaning that no other app can access the camera and change parameters or stream images.
A camera can be opened by specifying an identification string in the DeviceID field. The connector will then try to find a matching camera by searching for this identification string amongst the infos of the available cameras. The order in which it searches is the following:
- SerialNumber
- IPAddress
- UserDefinedName
- ModelName
- VendorName
- Interface
Example: An identification string is provided in the DeviceID field. Then the connector will first try to find a camera with a matching SerialNumber. If none was found it will try to find a camera with a matching IPAddress. It will continue until a matching camera can be found and try to open this camera.
If multiple cameras are found matching the same info then the connector will try to open the first one (it is up to the connector which camera is the first one).
If a camera was opened using a certain identification string then this identification string must be used in all DeviceID fields of all requests regarding this camera until it is closed again. A camera can't be opened with multiple identification strings at the same time.
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 OpenDevice |
| DeviceID | No | String | Device identification. |
{
"TransactionID": "1232156",
"Action": "OpenDevice",
"DeviceID": "548451887"
}
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": "123456",
"ReturnCode": 0,
"Message": "Camera open."
}