Users Manual

8.2.3 Data type definitions
The REST-API defines the following data models, which are used to access or modify the available resources
(Section 8.2.2) either as required attributes/parameters of the requests or as return types.
FirmwareInfo: Information about currently active and inactive firmware images, and what image is/will be
booted.
An object of type FirmwareInfo has the following properties:
• active_image (ImageInfo) - see description of ImageInfo
• fallback_booted (boolean) - true if desired image could not be booted and fallback boot to the previous
image occured
• inactive_image (ImageInfo) - see description of ImageInfo
• next_boot_image (string) - firmware image that will be booted next time (one of active
_
image,
inactive
_
image)
Template object
{
"active
_
image": {
"image
_
version": "string"
},
"fallback
_
booted": false,
"inactive
_
image": {
"image
_
version": "string"
},
"next
_
boot
_
image": "string"
}
FirmwareInfo objects are nested in SysInfo, and are used in the following requests:
• GET /system/rollback
• GET /system/update
ImageInfo: Information about specific firmware image.
An object of type ImageInfo has the following properties:
• image_version (string) - image version
Template object
{
"image
_
version": "string"
}
ImageInfo objects are nested in FirmwareInfo.
LicenseComponents: List of the licensing status of the individual software components. The respective flag is
true if the component is unlocked with the currently applied software license.
An object of type LicenseComponents has the following properties:
• calibration (boolean) - camera calibration component
• fusion (boolean) - stereo ins/fusion components
• hand_eye_calibration (boolean) - hand-eye calibration component
• rectification (boolean) - image rectification component
• self_calibration (boolean) - camera self-calibration component
• slam (boolean) - SLAM component
• stereo (boolean) - stereo matching component
8.2. REST-API interface 150