Guides

Breeze uses the Breeze Runtime to control cameras and acquire hyperspectral data, and to apply the analysis tree workflow to the data. A third-party application can use the Breeze Runtime API to obtain new data acquired from the cameras or files and use the API to act on objects classified by Breeze and receive the output data from Breeze's algorithms. This article outlines how software developer can use the Runtime API.

Breeze Runtime reference guide

The external event server receives events such objects and errors

Breeze has built in diagnostics that can help troubleshoot performance issues with cameras or running workflows. Such issues can occur because of too complicated workflows, too slow computer hardware, too slow network, or too large volumes of data.

This page lists the code samples for creating your own application which communicates with the Breeze Runtime.

This page shows how Breeze Runtime can be run in the background as a Windows Service, and started and stopped like other services, including automatically when the PC starts. This is optional, and a good alternative to launch the Runtime process manually and control it from a third-party application.

The Runtime can record data to disk in real-time. This includes the full spectral images from the camera, but optionally also a RGB thumbnail visualization and output prediction data from the analysis tree.

Breeze Runtime Client is an application bundled with Breeze that can be used to control the Breeze Runtime and visualize data from workflows executing in real-time. It can be used as a companion to third party applications and has built-in diagnostics to troubleshoot workflows.

Breeze Runtime Demo is a sample application provided with Breeze that acts as a third-party client to the Breeze Runtime. Use it to get acquainted with the Runtime API. The app has a list of buttons that triggers corresponding Runtime API calls and console that shows the commands and their replies, as well as any objects identified by the workflow.