Basler Vision Connector Messaging: Application Feedback#

Message Codes#

The following message codes are sent as responses.

Message codes are 32-bit integers that are encoded in the following way:

Info Message Codes#

Value range for standard info messages: 0x00000000 … 0x000FFFFF

Warning Message Codes#

Value range for standard warning messages: 0x01000000 … 0x010FFFFF

Debug Message Codes#

Value range for standard debug messages: 0x02000000 … 0x020FFFFF

Error Message Codes#

Value range for standard error messages: 0x03000000 … 0x030FFFFF

Application Logging#

The application log is published in the logging topic. In this log, you find any general application log information that is no direct response to any given command, such as application unhandled errors, camera error messages and camera connectivity issues. The purpose of this log is to provide a human-readable application feedback that isn't intended for interpretation by any software.

There are different structures to receive logging messages for ZMQ and for MQTT:

• In ZMQ, subscribe to the app/logging topic on the PUB/SUB port to receive application feedback.
• In MQTT, subscribe to the {mqttRoot}/app/logging topic to receive application feedback.

ZMQ Response on PUB/SUB Channel#

MQTT Reponse#

In MQTT, the JSON messages are written directly into the payload of the MQTT message. No specific envelop is required.

JSON Response Object#

{
    "Timestamp":"2014-01-09T13:35:34.000000000+0100",
    "Code": 50331650,
    "Level":"Error",
    "Message":"Lost connection with myCam1"
}

Application Events#

The application events are expected to be published on the event topic. The application events contain general application events which aren't direct responses to any given command, such as application unhandled errors, camera error messages, and camera connectivity issues. In contrast to the application log, the purpose of these events is to provide notifications that can be interpreted by software. Certain message types may carry additional data. However, this is only required for the message codes listed below.

There are different structures to receive logging messages for ZMQ and for MQTT:

• In ZMQ, subscribe to the app/events topic on the PUB/SUB port to receive application feedback.
• In MQTT, subscribe to the {mqttRoot}/app/events topic to receive application feedback.

ZMQ Response on PUB/SUB Channel#

MQTT Response#

In MQTT, the JSON messages are written directly into the payload of the MQTT message. No specific envelop is required.

JSON Response Object#

{
    "Timestamp":"2014-01-09T13:35:34.000000000+0100",
    "Code": 2,
    "Level":"Info",
    "Message":"The vision connector is offline now."
}

Device-Specific Events#

Device-specific events must contain additional data that contains the entry DeviceID of the device on which this event occurred.

List of all device-specific events:

• 0x00000003: Streaming of a device is stopped
• 0x03000002: An opened device was removed

Additional Data Object#

Example event for a connection loss of a device:

{
    "Timestamp":"2014-01-09T13:35:34.000000000+0100",
    "Code": 50331650,
    "Level":"Error",
    "Message":"Lost connection with myCam1",
    "AdditionalData":
    {
      "DeviceID": "myCam1"
    }
}

Frame Warning Events#

Frame warning events must contain additional data that contains the entry DeviceID of the device on which this event occurred. If more than 1 frame is affected, you must add a FrameCount.

List of all frame warning events:

• 0x01000001: One or multiple corrupt frames were received.
• 0x01000002: One or multiple dropped frames were detected.

Additional Data Object#

Example event for dropped frames:

{
    "Timestamp":"2014-01-09T13:35:34.000000000+0100",
    "Code": 16777218,
    "Level":"Warning",
    "Message":"3 dropped frames have been detected on myCam1",
    "AdditionalData":
    {
      "DeviceID": "myCam1",
      "FrameCount": 3
    }
}