Software Trigger Image Acquisition - Manual - Industrial Edge - Industrial Edge - Industrial Edge - Documentation of Industrial Edge APIs - CLI tools - Industrial Edge - References - APIs

Industrial Edge Platform Operation - APIs & References

Product
Industrial Edge
Edition
12/2024
Language
en-US (original)

This command is used when the camera is in software trigger operation. Upon execution, it triggers image acquisition as configured on the camera. Images will be published on the image streaming topic (refer to Topic Structure).

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 SoftwareTrigger
DeviceID No String Device identification.
{
    "TransactionID": "2342546345",
    "Action": "SoftwareTrigger",
    "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": "2342546345",
    "ReturnCode": 0,
    "Message": "Trigger sent."
}