Basler Vision Connector Messaging: Recipe Enumeration#

Use the following messages to get a list of all recipe files that are currently stored in the Basler Vision Connector. To manage the files stored there, you can upload recipe files and remove recipes from the Basler Vision Connector.

JSON Payload#

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

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

Response Object#

Field	Optional	Type	Description
TransactionID	Yes	String	Transaction identification
ReturnCode	No	Integer	Message code following Message Codes
Message	No	String	Response message
RecipeList	No	Array of Recipe Objects	Array of recipe files

Recipe Object#

Field	Optional	Type	Description
FileName	No	String	File name of the recipe
FileSize	No	Integer	File size of the recipe (in bytes)

{
  "TransactionID": "123456",
  "ReturnCode": 0,
  "Message": "Recipes have been enumerated successfully.",
  "RecipeList": [
    {
      "FileName": "SomeRecipe.precipe",
      "FileSize": 23423
    },
    {
      "FileName": "AnotherRecipe.precipe",
      "FileSize": 5116
    }
  ]
}