Basler Vision Connector Messaging: Creating a Recipe Instance#

To run a recipe, it must have been uploaded and the cameras you want to assign to the recipe must be open. You must then create an instance of the recipe. You can always choose to assign or change the camera assignments using the Connect Recipe command.

You can instantiate a recipe file multiple times and each time assign the pins of the vTools to other cameras. It's also possible to instantiate multiple recipe files and assign the pins to the same cameras. While instantiating a recipe, a unique recipe ID must be specified that will then be used during communication.

For recipe identification, you can use arbitrary strings, but only the following characters are allowed:

• Letters (A–Z or a–z)
• Digits (0–9)
• Hyphens (-)
• Underscores (_)
• Full stop (.)

If a camera is closed, all its pin assignments to recipe pins are automatically removed.

JSON Payload#

{
  "TransactionID": "234423465465",
  "Action": "cstm_OpenRecipe",
  "RecipeID": "MyRecipeID",
  "FileName": "MyRecipe.precipe",
  "PinConnections": {
    "MyFirstPinID": "MyDeviceID1",
    "MySecondPinID": "MyDeviceID2"
  }
}

Response Object#

{
  "TransactionID": "234423465465",
  "ReturnCode": 0,
  "Message": "Recipe opened."
}