Load UserSet Configuration - Manual - Industrial Edge Platform - Industrial Edge - Industrial Edge - Documentation of the Industrial Edge Platform - IEM - Hub - Industrial - Device - IED - Edge - IEH

Industrial Edge Platform Operation - APIs & References

Portfolio
Industrial Edge
Product
Industrial Edge Platform
Edition
02/2025
Language
en-US (original)

To load a configured UserSet on the camera, the user can send the LoadUserSet 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 LoadUserSet
DeviceID No String Device identification.
UserSet No Int/String String according with the user setting enumeration or integer when using the integer value.
{
  "TransactionID": "23423423563456",
  "Action": "LoadUserSet",
  "DeviceID": "548451887",
  "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": "1232116", 
  "ReturnCode": 0,
  "Message": "Userset loaded."
}