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.

Value range for custom info messages: 0x00800000 … 0x008FFFFF.

Warning Message Codes#

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

Value range for custom warning messages: 0x01800000 … 0x018FFFFF.

Debug Message Codes#

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

Value range for custom debug messages: 0x02800000 … 0x028FFFFF.

Error Message Codes#

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

Value range for custom error messages: 0x03800000 … 0x038FFFFF.

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 ZeroMQ and for MQTT:

• In ZeroMQ, 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.

ZeroMQ 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 ZeroMQ and for MQTT:

• In ZeroMQ, 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.

ZeroMQ 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 standard events:

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

The following custom device specific events are defined:

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 standard 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
    }
}

Frame Info Events#

Frame info 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 info events:

Additional Data Object#

Example event Info:

{
    "Timestamp":"2014-01-09T13:35:34.000000000+0100",
    "Code": 8388608,
    "Level":"Info",
    "Message":"Streaming has been started on the device with ID 'myDevice'",
    "AdditionalData":
    {
      "DeviceID": "myDevice",
      "FrameCount": 1
    }
}

Parameter Changed Events#

Parameter changed events must contain additional data with the entries DeviceID and ParameterNames, which will provide the device ID that this event happened on and the names of the parameter that are affected.

List of all parameter changed events:

Additional Data Object#

Example event for a device connection loss:

{
    "Timestamp":"2014-01-09T13:35:34.000000000+0100",
    "Code": 8388611,
    "Level":"Info",
    "Message":"Parameters were changed for device with ID 'myDevice'",
    "AdditionalData":
    {
      "DeviceID": "myDevice",
      "ParameterNames": ["Width", "Height"]
    }
}

Protocol State Events#

Protocol state events must contain additional data with the entries Protocol and ProtocolState, which will provide the protocol affected and the new state of the protocol.

List of all protocol state events:

Additional Data Object#

Example event for connection state changed:

{
    "Timestamp": "2014-01-09T13:35:34.000000000+0100",
    "Code": 8388614,
    "Level": "Info",
    "Message": "The MQTT client is running.",
    "AdditionalData":
    {
      "Protocol": "MQTT",
      "ProtocolState": "Ready"
    }
}

Recipe File Specific Events#

Recipe file specific events must contain additional data with the entry FileName, which will provide the file name of the recipe this event happened on.

List of all recipe file specific events:

Additional Data Object#

Example event for a recipe upload:

{
    "Timestamp":"2014-01-09T13:35:34.000000000+0100",
    "Code": 8388617,
    "Level":"Info",
    "Message":"Recipe file uploaded successfully.",
    "AdditionalData":
    {
      "FileName": "myRecipe.precipe"
    }
}

Recipe Specific Events#

Recipe specific events must contain additional data with the entry RecipeID, which will provide the recipe ID that this event happened on.

List of all recipe specific events:

Additional Data Object#

Example event for an error while running a recipe:

{
    "Timestamp":"2014-01-09T13:35:34.000000000+0100",
    "Code": 58720257,
    "Level":"Error",
    "Message":"Error while running a recipe.",
    "AdditionalData":
    {
      "RecipeID": "myRecipe"
    }
}

Recipe and Device Specific Events#

Recipe and device specific events must contain additional data with the entries RecipeID and DeviceID, which will provide the IDs of the recipe and device that this event happened on.

List of all recipe specific events:

Additional Data Object#

Example event for an error while running a recipe:

{
    "Timestamp":"2014-01-09T13:35:34.000000000+0100",
    "Code": 25165824,
    "Level":"Warning",
    "Message":"Error while running a recipe.",
    "AdditionalData":
    {
      "RecipeID": "myRecipe",
      "DeviceID": "myDevice"
    }
}