HW L3 Device Json Schema

Type: object

HW L3 Device Json Schema, Schema Version 1.0

root information
Type: object

Contains general information of the hardware json files for client load.

root information title
Type: string or null

Title of what the json file is using for.

root information contentVersion
Type: string

Version of content, most used for CDN control.

root information buildNumber
Type: string

The build number of the file. Set a unique higher value will force the client to download this version over the existing one.

root information schemaVersion
Type: string

Schema Version of this Json Schema. It should match the client compatibility.

Additional Properties of any type are allowed.

root information additionalProperties
Type: object

root hw
Type: object

Contains needed board information in order to identify a target device, and can only support a single target device.

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: [A-Z0-9_]+
root hw [A-Z0-9_]+
Type: object

root hw [A-Z0-9_]+ id
Type: string

special key used on the client to identify the target board. See the notes in the Hardware reference file on how to identify the hardware device ID.

root hw [A-Z0-9_]+ name
Type: string

The official name of the target board, which is shown in the SDK Manager GUI.

root hw [A-Z0-9_]+ singularName
Type: string

Singular version of the name field.

root hw [A-Z0-9_]+ shortName
Type: string

Short version of the name field.

root hw [A-Z0-9_]+ products
Type: array of string

Product names of the target devices.

 No Additional Items

Each item of this array must be:

root hw [A-Z0-9_]+ products products items
Type: string

Examples:

[
    "Jetson"
]

[
    "Jetson",
    "Holoscan"
]

root hw [A-Z0-9_]+ imagePath
Type: string

The path of hardware images.
Examples:

"https://"

"http://"

"file://"

"local directory absolute path that starts with /"

root hw [A-Z0-9_]+ storages
Type: array of object

The target device storage choices.

 No Additional Items

Each item of this array must be:

root hw [A-Z0-9_]+ storages storages items
Type: object

root hw [A-Z0-9_]+ storages storages items id
Type: string

The id of the storage type.

root hw [A-Z0-9_]+ storages storages items displayName
Type: string

Storage type display name on the client

root hw [A-Z0-9_]+ storages storages items flashOptions
Type: string

Additional options of flashing commands.

root hw [A-Z0-9_]+ storages storages items note
Type: string

The warning note user need to know for installing on this storage type.

Additional Properties of any type are allowed.

root hw [A-Z0-9_]+ storages storages items additionalProperties
Type: object

root hw [A-Z0-9_]+ deviceInstructions
Type: object

The instructions to flash or install for the device.

root hw [A-Z0-9_]+ deviceInstructions flash
Type: array of string

Contains the very general flashing instructions.

 No Additional Items

Each item of this array must be:

root hw [A-Z0-9_]+ deviceInstructions flash flash items
Type: string

root hw [A-Z0-9_]+ deviceInstructions recoveryAuto
Type: array of string

Contains instructions to put the board into recovery mode automatically.

 No Additional Items

Each item of this array must be:

root hw [A-Z0-9_]+ deviceInstructions recoveryAuto recoveryAuto items
Type: string

root hw [A-Z0-9_]+ deviceInstructions recoveryManual
Type: array of string

Contains instructions to put the board into recovery mode manually.

 No Additional Items

Each item of this array must be:

root hw [A-Z0-9_]+ deviceInstructions recoveryManual recoveryManual items
Type: string

root hw [A-Z0-9_]+ deviceInstructions targetAccess
Type: array of string

Contains the target device components install instructions.

 No Additional Items

Each item of this array must be:

root hw [A-Z0-9_]+ deviceInstructions targetAccess targetAccess items
Type: string

Additional Properties of any type are allowed.

root hw [A-Z0-9_]+ deviceInstructions additionalProperties
Type: object

root hw [A-Z0-9_]+ deviceIdentificationDetails
Type: object

The device identification details.

root hw [A-Z0-9_]+ deviceIdentificationDetails moduleNames
Type: array of string

The module/modules name supported on this target device. This is displayed in the SDK Manager GUI.

 No Additional Items

Each item of this array must be:

root hw [A-Z0-9_]+ deviceIdentificationDetails moduleNames moduleNames items
Type: string

root hw [A-Z0-9_]+ deviceIdentificationDetails moduleIds
Type: array of string

The module IDs of the target devices. This is used in SDK Manager for device detection and flash identification.

 No Additional Items

Each item of this array must be:

root hw [A-Z0-9_]+ deviceIdentificationDetails moduleIds moduleIds items
Type: string

root hw [A-Z0-9_]+ deviceIdentificationDetails moduleDescription
Type: string

Description for the module of the target device.

root hw [A-Z0-9_]+ deviceIdentificationDetails tegraRecoveryModeCodes
Type: array of string

The recovery mode code of the device in lsusb. This is used in SDK Manager for board detection and flash identification for Jetson devices.

 No Additional Items

Each item of this array must be:

root hw [A-Z0-9_]+ deviceIdentificationDetails tegraRecoveryModeCodes tegraRecoveryModeCodes items
Type: string

root hw [A-Z0-9_]+ deviceIdentificationDetails carrierIds
Type: array of string

The carrier IDs of the target devices. This is used in SDK Manager for board detection and flash identification.

 No Additional Items

Each item of this array must be:

root hw [A-Z0-9_]+ deviceIdentificationDetails carrierIds carrierIds items
Type: string

root hw [A-Z0-9_]+ deviceIdentificationDetails carrierDescription
Type: string

Description for the carrier of the target board.

root hw [A-Z0-9_]+ deviceIdentificationDetails bluefieldBoardIds
Type: array of string

The bluefield board Ids. This is used in SDK Manager for board detection and flash identification for DOCA devices.

 No Additional Items

Each item of this array must be:

root hw [A-Z0-9_]+ deviceIdentificationDetails bluefieldBoardIds bluefieldBoardIds items
Type: string

root hw [A-Z0-9_]+ deviceIdentificationDetails aurixPort
Type: string

The aurix port of the device. For example, '/dev/ttyUSB1'. This is used in SDK Manager for flash identification for DRIVE devices.

root hw [A-Z0-9_]+ deviceIdentificationDetails supportAerialUSB
Type: boolean

Whether the device supports Aerial USB. This is used in SDK Manager for flash identification for Aerial devices.

root hw [A-Z0-9_]+ deviceIdentificationDetails bootRomPreflashVerification
Type: boolean

Whether the device supports Tegra Bootrom Check. This is used in SDK Manager for flash identification for Tegra devices.

Additional Properties of any type are allowed.

root hw [A-Z0-9_]+ deviceIdentificationDetails additionalProperties
Type: object

Additional Properties of any type are allowed.

root hw [A-Z0-9_]+ additionalProperties
Type: object

Additional Properties of any type are allowed.

root additionalProperties
Type: object