Trigger_C_QuickSpin¶
Trigger_C_QuickSpin.c shows how to capture images with the trigger using the QuickSpin API. QuickSpin is a subset of the Spinnaker library that allows for simpler node access and control.
//=============================================================================
// Copyright (c) 2026 FLIR Integrated Imaging Solutions, Inc. All Rights Reserved.
//
// This software is the confidential and proprietary information of FLIR
// Integrated Imaging Solutions, Inc. ("Confidential Information"). You
// shall not disclose such Confidential Information and shall use it only in
// accordance with the terms of the license agreement you entered into
// with FLIR Integrated Imaging Solutions, Inc. (FLIR).
//
// FLIR MAKES NO REPRESENTATIONS OR WARRANTIES ABOUT THE SUITABILITY OF THE
// SOFTWARE, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
// PURPOSE, OR NON-INFRINGEMENT. FLIR SHALL NOT BE LIABLE FOR ANY DAMAGES
// SUFFERED BY LICENSEE AS A RESULT OF USING, MODIFYING OR DISTRIBUTING
// THIS SOFTWARE OR ITS DERIVATIVES.
//=============================================================================
/**
* @example Trigger_C_QuickSpin.c
*
* @brief Trigger_C_QuickSpin.c shows how to capture images with the
* trigger using the QuickSpin API. QuickSpin is a subset of the Spinnaker
* library that allows for simpler node access and control.
*
* This example demonstrates how to prepare, execute, and clean up the camera
* in regards to using both software and hardware triggers. Retrieving and
* setting node values using QuickSpin is the only portion of the example
* that differs from Trigger_C.
*
* A much wider range of topics is covered in the full Spinnaker examples than
* in the QuickSpin ones. There are only enough QuickSpin examples to
* demonstrate node access and to get started with the API; please see full
* Spinnaker examples for further or specific knowledge on a topic.
*
* Please leave us feedback at: https://www.surveymonkey.com/r/TDYMVAPI
* More source code examples at: https://github.com/Teledyne-MV/Spinnaker-Examples
* Need help? Check out our forum at: https://teledynevisionsolutions.zendesk.com/hc/en-us/community/topics
*/
#include "SpinnakerC.h"
#include "stdio.h"
#include "string.h"
// This macro helps with C-strings.
#define MAX_BUFF_LEN 256
// Use the following enum and global static variable to select whether a
// software or hardware trigger is used.
typedef enum _triggerType
{
SOFTWARE,
HARDWARE
} triggerType;
const triggerType chosenTrigger = SOFTWARE;
// This function helps to check if a node is readable
bool8_t IsReadable(spinNodeHandle hNode, char nodeName[])
{
spinError err = SPINNAKER_ERR_SUCCESS;
bool8_t pbReadable = False;
err = spinNodeIsReadable(hNode, &pbReadable);
if (err != SPINNAKER_ERR_SUCCESS)
{
printf("Unable to retrieve node readability (%s node), with error %d...\n\n", nodeName, err);
}
return pbReadable;
}
// This function configures the camera to use a trigger. First, trigger mode
// is set to off in order to select the trigger source. Trigger mode is
// then enabled, which has the camera capture only a single image upon the
// execution of the chosen trigger.
spinError ConfigureTrigger(quickSpin qs)
{
spinError err = SPINNAKER_ERR_SUCCESS;
printf("\n\n*** TRIGGER CONFIGURATION ***\n\n");
printf("Note that if the application / user software triggers faster than frame time, the trigger may be dropped / "
"skipped by the camera.\n");
printf("If several frames are needed per trigger, a more reliable alternative for such case, is to use the "
"multi-frame mode.\n\n");
if (chosenTrigger == SOFTWARE)
{
printf("Software trigger chosen...\n\n");
}
else if (chosenTrigger == HARDWARE)
{
printf("Hardware trigger chosen...\n\n");
}
//
// Ensure trigger mode off
//
// *** NOTES ***
// The trigger must be disabled in order to configure whether the source
// is software or hardware.
//
err = spinEnumerationSetEnumValue(qs.TriggerMode, TriggerMode_Off);
if (err != SPINNAKER_ERR_SUCCESS)
{
printf("Unable to disable trigger mode. Aborting with error %d...\n\n", err);
return err;
}
printf("Trigger mode disabled...\n");
//
// Set TriggerSelector to FrameStart
//
// *** NOTES ***
// For this example, the trigger selector should be set to frame start.
// This is the default for most cameras.
//
err = spinEnumerationSetEnumValue(qs.TriggerSelector, TriggerSelector_FrameStart);
if (err != SPINNAKER_ERR_SUCCESS)
{
printf("Unable to choose trigger selector. Aborting with error %d...\n\n", err);
return err;
}
printf("Trigger selector set to frame start...\n");
//
// Choose trigger source
//
// *** NOTES ***
// The trigger source must be set to hardware or software while trigger
// mode is off.
//
if (chosenTrigger == SOFTWARE)
{
// Set software source
err = spinEnumerationSetEnumValue(qs.TriggerSource, TriggerSource_Software);
if (err != SPINNAKER_ERR_SUCCESS)
{
printf("Unable to choose trigger source. Aborting with error %d...\n\n", err);
return err;
}
printf("Trigger source set to software...\n");
}
else if (chosenTrigger == HARDWARE)
{
// Set hardware source
err = spinEnumerationSetEnumValue(qs.TriggerSource, TriggerSource_Line0);
if (err != SPINNAKER_ERR_SUCCESS)
{
printf("Unable to choose trigger source. Aborting with error %d...\n\n", err);
return err;
}
printf("Trigger source set to line 0...\n");
}
//
// Turn trigger mode on
//
// *** LATER ***
// Once the appropriate trigger source has been set, turn trigger mode
// back on in order to retrieve images using the trigger.
//
err = spinEnumerationSetIntValue(qs.TriggerMode, TriggerMode_On);
if (err != SPINNAKER_ERR_SUCCESS)
{
printf("Unable to enable trigger mode. Aborting with error %d...\n\n", err);
return err;
}
printf("Trigger mode enabled...\n\n");
return err;
}
// This function retrieves a single image using the trigger. In this example,
// only a single image is captured and made available for acquisition - as such,
// attempting to acquire two images for a single trigger execution would cause
// the example to hang. This is different from other examples, whereby a
// constant stream of images are being captured and made available for image
// acquisition.
spinError GrabNextImageByTrigger(quickSpin qs)
{
spinError err = SPINNAKER_ERR_SUCCESS;
//
// Use trigger to capture image
//
// *** NOTES ***
// The software trigger only feigns being executed by the Enter key;
// what might not be immediately apparent is that there is no
// continuous stream of images being captured; in other examples that
// acquire images, the camera captures a continuous stream of images.
// When an image is then retrieved, it is plucked from the stream;
// there are many more images captured than retrieved. However, while
// trigger mode is activated, there is only a single image captured at
// the time that the trigger is activated.
//
if (chosenTrigger == SOFTWARE)
{
// Get user input
printf("Press the Enter key to initiate software trigger...\n");
getchar();
// Execute software trigger
err = spinCommandExecute(qs.TriggerSoftware);
if (err != SPINNAKER_ERR_SUCCESS)
{
printf("Unable to execute software trigger. Aborting with error %d...\n\n", err);
return err;
}
}
else if (chosenTrigger == HARDWARE)
{
// Execute hardware trigger
printf("Use the hardware to trigger image acquisition.\n");
}
return err;
}
// This function returns the camera to a normal state by turning off trigger
// mode.
spinError ResetTrigger(quickSpin qs)
{
spinError err = SPINNAKER_ERR_SUCCESS;
//
// Turn trigger mode back off
//
// *** NOTES ***
// Once all images have been captured, it is important to turn trigger
// mode back off to restore the camera to a clean state.
//
err = spinEnumerationSetIntValue(qs.TriggerMode, TriggerMode_Off);
if (err != SPINNAKER_ERR_SUCCESS)
{
printf("Unable to disable trigger mode. Aborting with error %d...\n\n", err);
return err;
}
printf("Trigger mode disabled...\n\n");
return err;
}
// This function prints the device information of the camera from the transport
// layer; please see NodeMapInfo_C example for more in-depth comments on
// printing device information from the nodemap.
spinError PrintDeviceInfo(spinCamera hCamera)
{
spinError err = SPINNAKER_ERR_SUCCESS;
unsigned int i = 0;
printf("\n*** DEVICE INFORMATION ***\n\n");
// Retrieve nodemap
spinNodeMapHandle hNodeMap = NULL;
err = spinCameraGetTLDeviceNodeMap(hCamera, &hNodeMap);
if (err != SPINNAKER_ERR_SUCCESS)
{
printf("Unable to retrieve nodemap. Non-fatal error %d...\n\n", err);
return err;
}
// Retrieve device information category node
spinNodeHandle hDeviceInformation = NULL;
err = spinNodeMapGetNode(hNodeMap, "DeviceInformation", &hDeviceInformation);
if (err != SPINNAKER_ERR_SUCCESS)
{
printf("Unable to retrieve node. Non-fatal error %d...\n\n", err);
return err;
}
// Retrieve number of nodes within device information node
size_t numFeatures = 0;
err = spinCategoryGetNumFeatures(hDeviceInformation, &numFeatures);
if (err != SPINNAKER_ERR_SUCCESS)
{
printf("Unable to retrieve number of nodes. Non-fatal error %d...\n\n", err);
return err;
}
// Iterate through nodes and print information
for (i = 0; i < numFeatures; i++)
{
spinNodeHandle hFeatureNode = NULL;
err = spinCategoryGetFeatureByIndex(hDeviceInformation, i, &hFeatureNode);
if (err != SPINNAKER_ERR_SUCCESS)
{
printf("Unable to retrieve node. Non-fatal error %d...\n\n", err);
continue;
}
spinNodeType featureType = UnknownNode;
char featureName[MAX_BUFF_LEN];
size_t lenFeatureName = MAX_BUFF_LEN;
err = spinNodeGetName(hFeatureNode, featureName, &lenFeatureName);
if (err != SPINNAKER_ERR_SUCCESS)
{
strcpy(featureName, "Unknown name");
}
if (IsReadable(hFeatureNode, featureName))
{
err = spinNodeGetType(hFeatureNode, &featureType);
if (err != SPINNAKER_ERR_SUCCESS)
{
printf("Unable to retrieve node type. Non-fatal error %d...\n\n", err);
continue;
}
}
else
{
printf("%s: Node not readable\n", featureName);
continue;
}
char featureValue[MAX_BUFF_LEN];
size_t lenFeatureValue = MAX_BUFF_LEN;
err = spinNodeToString(hFeatureNode, featureValue, &lenFeatureValue);
if (err != SPINNAKER_ERR_SUCCESS)
{
strcpy(featureValue, "Unknown value");
}
printf("%s: %s\n", featureName, featureValue);
}
printf("\n");
return err;
}
// This function acquires and saves 10 images from a device; please see
// Acquisition_C example for more in-depth comments on the acquisition of
// images.
spinError AcquireImages(spinCamera hCam, quickSpin qs, quickSpinTLDevice qsD)
{
spinError err = SPINNAKER_ERR_SUCCESS;
printf("\n*** IMAGE ACQUISITION ***\n\n");
// Set acquisition mode to continuous
err = spinEnumerationSetEnumValue(qs.AcquisitionMode, AcquisitionMode_Continuous);
if (err != SPINNAKER_ERR_SUCCESS)
{
printf("Unable to set acquisition mode to continuous. Aborting with error %d...\n\n", err);
return err;
}
printf("Acquisition mode set to continuous...\n");
// Begin acquiring images
err = spinCameraBeginAcquisition(hCam);
if (err != SPINNAKER_ERR_SUCCESS)
{
printf("Unable to begin image acquisition. Aborting with error %d...\n\n", err);
return err;
}
printf("Acquiring images...\n");
// Retrieve device serial number for filename
char deviceSerialNumber[MAX_BUFF_LEN];
size_t lenDeviceSerialNumber = MAX_BUFF_LEN;
err = spinStringGetValue(qsD.DeviceSerialNumber, deviceSerialNumber, &lenDeviceSerialNumber);
if (err != SPINNAKER_ERR_SUCCESS)
{
strcpy(deviceSerialNumber, "");
lenDeviceSerialNumber = 0;
}
else
{
printf("Device serial number retrieved as %s...\n", deviceSerialNumber);
}
printf("\n");
// Retrieve, convert, and save images
const unsigned int k_numImages = 10;
unsigned int imageCnt = 0;
//
// Create Image Processor context for post processing images
//
spinImageProcessor hImageProcessor = NULL;
err = spinImageProcessorCreate(&hImageProcessor);
if (err != SPINNAKER_ERR_SUCCESS)
{
printf("Unable to create image processor. Non-fatal error %d...\n\n", err);
}
//
// Set default image processor color processing method
//
// *** NOTES ***
// By default, if no specific color processing algorithm is set, the image
// processor will default to NEAREST_NEIGHBOR method.
//
err = spinImageProcessorSetColorProcessing(hImageProcessor, SPINNAKER_COLOR_PROCESSING_ALGORITHM_HQ_LINEAR);
if (err != SPINNAKER_ERR_SUCCESS)
{
printf("Unable to set image processor color processing method. Non-fatal error %d...\n\n", err);
}
for (imageCnt = 0; imageCnt < k_numImages; imageCnt++)
{
// Retrieve next image by trigger
spinImage hResultImage = NULL;
err = GrabNextImageByTrigger(qs);
if (err != SPINNAKER_ERR_SUCCESS)
{
return err;
}
// Retrieve next received image
err = spinCameraGetNextImageEx(hCam, 1000, &hResultImage);
if (err != SPINNAKER_ERR_SUCCESS)
{
printf("Unable to retrieve next image. Aborting with error %d...\n\n", err);
}
// Ensure image completion
bool8_t isIncomplete = False;
bool8_t hasFailed = False;
err = spinImageIsIncomplete(hResultImage, &isIncomplete);
if (err != SPINNAKER_ERR_SUCCESS)
{
printf("Unable to determine image completion. Non-fatal error %d...\n\n", err);
hasFailed = True;
}
if (isIncomplete)
{
spinImageStatus imageStatus = SPINNAKER_IMAGE_STATUS_NO_ERROR;
err = spinImageGetStatus(hResultImage, &imageStatus);
if (err != SPINNAKER_ERR_SUCCESS)
{
printf("Unable to retrieve image status. Non-fatal error %d...\n\n", err);
}
else
{
printf("Image incomplete with image status %d...\n", imageStatus);
}
hasFailed = True;
}
// Release incomplete or failed image
if (hasFailed)
{
err = spinImageRelease(hResultImage);
if (err != SPINNAKER_ERR_SUCCESS)
{
printf("Unable to release image. Non-fatal error %d...\n\n", err);
}
continue;
}
// Print image information
size_t width = 0;
size_t height = 0;
err = spinImageGetWidth(hResultImage, &width);
if (err != SPINNAKER_ERR_SUCCESS)
{
printf("Unable to retrieve image width. Non-fatal error %d...\n", err);
}
err = spinImageGetHeight(hResultImage, &height);
if (err != SPINNAKER_ERR_SUCCESS)
{
printf("Unable to retrieve image height. Non-fatal error %d...\n", err);
}
printf("Grabbed image %u, width = %u, height = %u\n", imageCnt, (unsigned int)width, (unsigned int)height);
// Convert image to mono 8
spinImage hConvertedImage = NULL;
err = spinImageCreateEmpty(&hConvertedImage);
if (err != SPINNAKER_ERR_SUCCESS)
{
printf("Unable to create image. Non-fatal error %d...\n\n", err);
hasFailed = True;
}
err = spinImageProcessorConvert(hImageProcessor, hResultImage, hConvertedImage, PixelFormat_Mono8);
if (err != SPINNAKER_ERR_SUCCESS)
{
printf("Unable to convert image. Non-fatal error %d...\n\n", err);
hasFailed = True;
}
// Create unique file name
char filename[MAX_BUFF_LEN];
if (lenDeviceSerialNumber == 0)
{
sprintf(filename, "Trigger-C-%d.jpg", imageCnt);
}
else
{
sprintf(filename, "Trigger-C-%s-%d.jpg", deviceSerialNumber, imageCnt);
}
// Save image
err = spinImageSave(hConvertedImage, filename, SPINNAKER_IMAGE_FILE_FORMAT_JPEG);
if (err != SPINNAKER_ERR_SUCCESS)
{
printf("Unable to save image. Non-fatal error %d...\n", err);
}
else
{
printf("Image saved at %s\n\n", filename);
}
// Destroy converted image
err = spinImageDestroy(hConvertedImage);
if (err != SPINNAKER_ERR_SUCCESS)
{
printf("Unable to destroy image. Non-fatal error %d...\n\n", err);
}
// Release complete image
err = spinImageRelease(hResultImage);
if (err != SPINNAKER_ERR_SUCCESS)
{
printf("Unable to release image. Non-fatal error %d...\n\n", err);
}
}
//
// Destroy Image Processor context
//
// *** NOTES ***
// Image processor context needs to be destroyed after all image processing
// are complete to avoid memory leaks.
//
err = spinImageProcessorDestroy(hImageProcessor);
if (err != SPINNAKER_ERR_SUCCESS)
{
printf("Unable to destroy image processor. Non-fatal error %d...\n\n", err);
}
// End Acquisition
err = spinCameraEndAcquisition(hCam);
if (err != SPINNAKER_ERR_SUCCESS)
{
printf("Unable to end acquisition. Non-fatal error %d...\n\n", err);
}
return err;
}
// This function acts as the body of the example; please see NodeMapInfo_C
// example for more in-depth comments on setting up cameras.
spinError RunSingleCamera(spinCamera hCam)
{
spinError err = SPINNAKER_ERR_SUCCESS;
// Print device information
err = PrintDeviceInfo(hCam);
// Initialize camera
err = spinCameraInit(hCam);
if (err != SPINNAKER_ERR_SUCCESS)
{
printf("Unable to initialize camera. Aborting with error %d...\n\n", err);
return err;
}
// Pre-fetch TL device nodes
quickSpinTLDevice qsD;
err = quickSpinTLDeviceInit(hCam, &qsD);
if (err != SPINNAKER_ERR_SUCCESS)
{
printf("Unable to pre-fetch TL device nodes. Aborting with error %d...\n\n", err);
return err;
}
// Pre-fetch GenICam nodes
quickSpin qs;
err = quickSpinInit(hCam, &qs);
if (err != SPINNAKER_ERR_SUCCESS)
{
printf("Unable to pre-fetch GenICam nodes. Aborting with error %d...\n\n", err);
return err;
}
// Configure trigger
err = ConfigureTrigger(qs);
if (err != SPINNAKER_ERR_SUCCESS)
{
return err;
}
// Acquire images
err = AcquireImages(hCam, qs, qsD);
if (err != SPINNAKER_ERR_SUCCESS)
{
return err;
}
// Reset trigger
err = ResetTrigger(qs);
if (err != SPINNAKER_ERR_SUCCESS)
{
return err;
}
// Deinitialize camera
err = spinCameraDeInit(hCam);
if (err != SPINNAKER_ERR_SUCCESS)
{
printf("Unable to deinitialize camera. Non-fatal error %d...\n\n", err);
}
return err;
}
// Example entry point; please see Enumeration_C example for more in-depth
// comments on preparing and cleaning up the system.
int main(/*int argc, char** argv*/)
{
spinError errReturn = SPINNAKER_ERR_SUCCESS;
spinError err = SPINNAKER_ERR_SUCCESS;
unsigned int i = 0;
// Print application build information
printf("Application build date: %s %s \n\n", __DATE__, __TIME__);
// Retrieve singleton reference to system object
spinSystem hSystem = NULL;
err = spinSystemGetInstance(&hSystem);
if (err != SPINNAKER_ERR_SUCCESS)
{
printf("Unable to retrieve system instance. Aborting with error %d...\n\n", err);
return err;
}
// Print out current library version
spinLibraryVersion hLibraryVersion;
spinSystemGetLibraryVersion(hSystem, &hLibraryVersion);
printf(
"Spinnaker library version: %d.%d.%d.%d\n\n",
hLibraryVersion.major,
hLibraryVersion.minor,
hLibraryVersion.type,
hLibraryVersion.build);
// Retrieve list of cameras from the system
spinCameraList hCameraList = NULL;
err = spinCameraListCreateEmpty(&hCameraList);
if (err != SPINNAKER_ERR_SUCCESS)
{
printf("Unable to create camera list. Aborting with error %d...\n\n", err);
return err;
}
err = spinSystemGetCameras(hSystem, hCameraList);
if (err != SPINNAKER_ERR_SUCCESS)
{
printf("Unable to retrieve camera list. Aborting with error %d...\n\n", err);
return err;
}
// Retrieve number of cameras
size_t numCameras = 0;
err = spinCameraListGetSize(hCameraList, &numCameras);
if (err != SPINNAKER_ERR_SUCCESS)
{
printf("Unable to retrieve number of cameras. Aborting with error %d...\n\n", err);
return err;
}
printf("Number of cameras detected: %u\n\n", (unsigned int)numCameras);
// Finish if there are no cameras
if (numCameras == 0)
{
// Clear and destroy camera list before releasing system
err = spinCameraListClear(hCameraList);
if (err != SPINNAKER_ERR_SUCCESS)
{
printf("Unable to clear camera list. Aborting with error %d...\n\n", err);
return err;
}
err = spinCameraListDestroy(hCameraList);
if (err != SPINNAKER_ERR_SUCCESS)
{
printf("Unable to destroy camera list. Aborting with error %d...\n\n", err);
return err;
}
// Release system
err = spinSystemReleaseInstance(hSystem);
if (err != SPINNAKER_ERR_SUCCESS)
{
printf("Unable to release system instance. Aborting with error %d...\n\n", err);
return err;
}
printf("Not enough cameras!\n");
printf("Done! Press Enter to exit...\n");
getchar();
return -1;
}
// Run example on each camera
for (i = 0; i < numCameras; i++)
{
printf("\nRunning example for camera %d...\n", i);
// Select camera
spinCamera hCamera = NULL;
err = spinCameraListGet(hCameraList, i, &hCamera);
if (err != SPINNAKER_ERR_SUCCESS)
{
printf("Unable to retrieve camera from list. Aborting with error %d...\n\n", err);
errReturn = err;
}
else
{
// Run example
err = RunSingleCamera(hCamera);
if (err != SPINNAKER_ERR_SUCCESS)
{
errReturn = err;
}
}
// Release camera
err = spinCameraRelease(hCamera);
if (err != SPINNAKER_ERR_SUCCESS)
{
errReturn = err;
}
printf("Camera %d example complete...\n\n", i);
}
// Clear and destroy camera list before releasing system
err = spinCameraListClear(hCameraList);
if (err != SPINNAKER_ERR_SUCCESS)
{
printf("Unable to clear camera list. Aborting with error %d...\n\n", err);
return err;
}
err = spinCameraListDestroy(hCameraList);
if (err != SPINNAKER_ERR_SUCCESS)
{
printf("Unable to destroy camera list. Aborting with error %d...\n\n", err);
return err;
}
// Release system
err = spinSystemReleaseInstance(hSystem);
if (err != SPINNAKER_ERR_SUCCESS)
{
printf("Unable to release system instance. Aborting with error %d...\n\n", err);
return err;
}
printf("\nDone! Press Enter to exit...\n");
getchar();
return errReturn;
}