Basler Vision Connector Messaging: Camera Operation#

Camera operations are handled by sending JSON strings via MQTT or ZMQ according to the Topic Structure.

If a requested command or argument isn't supported by the Basler Vision Connector (e.g., the command in the given action field of the command is unknown), the Basler Vision Connector replies the return code 0x03000003. See also Error message codes.

Getting List of Supported Commands#

To get the full list of commands that are currently supported by the Basler Vision Connector, the client can send the following command:

JSON Payload#

Field	Optional	Type	Description
TransactionID	Yes	String	Transaction identification
Action	No	String	Method called. Fixed value: `GetSupportedCommands`

{
    "TransactionID": "123456",
    "Action": "GetSupportedCommands"
}

Response Object#

Field	Optional	Type	Description
TransactionID	Yes	String	Transaction identification
ReturnCode	No	Integer	Message code following Message Codes
Message	Yes	String	Response message
SupportedCommandList	No	Array of strings	Array of commands: the possible values for the Action field

{
    "TransactionID": "123456",
    "ReturnCode": 0,
    "Message": "Supported commands retrieved.",
    "SupportedCommandList":
    [
      "EnumerateDevices",
      "GetStatus",
      "OpenDevice",
      "CloseDevice",
      "StartStreaming",
      "StopStreaming",
      "GetParameterNames",
      "GetParameters",
      "SetParameters",
      "SetQuickParameters",
      "SoftwareTrigger",
      "GetUserSets",
      "LoadUserSet",
      "SaveUserSet",
      "SetDefaultUserSet",
      "SetDeviceConfig",
      "GetDeviceConfig",
      "GetSupportedCommands"
    ]
}