Zivid::Firmware Namespace Reference

Interface for verifying and configuring firmware. More...

Typedefs
using	ProgressCallback = std::function<void(double, const std::string &)>
	A progress callback function type.

Functions
ZIVID_CORE_EXPORT bool	isUpToDate (const Camera &camera)
	Check if the firmware on the camera is of the version that is required by the API.
ZIVID_CORE_EXPORT void	update (Camera &camera, const ProgressCallback &progressCallback={})
	Update camera firmware.

Detailed Description

Interface for verifying and configuring firmware.

Typedef Documentation

ProgressCallback

using Zivid::Firmware::ProgressCallback = std::function<void(double, const std::string &)>

A progress callback function type.

Parameters

progressPercentage	The progress completion percentage (0 - 100%).
updateStageDescription	A textual description of the progress stage.

Function Documentation

isUpToDate()

ZIVID_CORE_EXPORT bool Zivid::Firmware::isUpToDate

(

const Camera &

camera

)

Check if the firmware on the camera is of the version that is required by the API.

Parameters

camera

A camera to check if firmware is up to date.

update()

ZIVID_CORE_EXPORT void Zivid::Firmware::update	(	Camera &	camera,
		const ProgressCallback &	progressCallback = {} )

Update camera firmware.

If the current API requires a different firmware than what is present on the camera, the firmware will be updated to this version. The function throws if the camera is connected, or if the camera is already up to date. Call isUpToDate first to check if the camera is up to date.

Parameters

camera	A disconnected camera with out of sync firmware.
progressCallback	A callback function to track progress of update.