Saving Configuration - 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)

After the camera is parametrized, the parameter set can be saved on the camera on user sets. To perform the storage, the user can send the SaveUserSet message.

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 SaveUserSet
DeviceID No String Device identification.
UserSet No Int/String String according with the user setting enumeration or integer when using the integer value.
{
  "TransactionID": "489494",
  "Action": "SaveUserSet",
  "DeviceID": "548451842342387",
  "UserSet": "UserSet2"
}

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": "489494",
  "ReturnCode": 0,
  "Message": "User set updated."
}