Close Camera Connection - 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)

To close the camera connection, releasing the exclusive access and stopping any running image streaming, releasing the camera.

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 CloseDevice
DeviceID No String Device identification.
{
    "TransactionID": "1232116",
    "Action": "CloseDevice",
    "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": "1232116",
    "ReturnCode": 0,
    "Message": "Camera closed."
}