Extra config file Json Schema

Type: object

Extra config file Json Schema, hw Schema Version 1.0, sw Schema Version 22.0

 No Additional Properties

root information
Type: object

Contains information needed to support a specific SDK.

root information release
Type: object

Contains release information needed to support a specific SDK.

root information release releaseVersion
Type: string

The release version supported for this SDK.

root information release releaseEdition
Type: string

The release edition supported for this SDK.

root information release releaseRevision
Type: number

The release revision supported for this SDK.

root sw
Type: object

Contains needed components’ information for this SDK.

 No Additional Properties

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

Property name regular expression: [A-Z0-9_]+
root sw [A-Z0-9_]+
Type: object
No Additional Properties

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

The official name of the component, which will be shown in the SDK Manager GUI.

root sw [A-Z0-9_]+ isVisible
Type: boolean

Expose the component in the SDK Manager GUI.

root sw [A-Z0-9_]+ estimateInstallDurationSeconds
Type: integer

The estimated install duration in seconds.

root sw [A-Z0-9_]+ timeoutSeconds
Type: integer

If a component installation takes a lot longer than expected, a dialog will pop up to notice user. You can specify the exact time in seconds here, otherwise it's' calculated in the client based on package size.

root sw [A-Z0-9_]+ platforms
Type: array of object

Components can have different platforms to support different install files per supportedHardware and operatingSystems.

 No Additional Items

Each item of this array must be:

root sw [A-Z0-9_]+ platforms platforms items
Type: object
No Additional Properties

root sw [A-Z0-9_]+ platforms platforms items operatingSystems
Type: array of string

The operating systems supported this version.

 No Additional Items

Each item of this array must be:

root sw [A-Z0-9_]+ platforms platforms items operatingSystems operatingSystems items
Type: string

root sw [A-Z0-9_]+ platforms platforms items componentInstallParameters
Type: object
No Additional Properties

root sw [A-Z0-9_]+ platforms platforms items componentInstallParameters installDir
Type: string

Path where the installation/uninstallation will be executed.

root sw [A-Z0-9_]+ platforms platforms items componentInstallParameters installEngineQueue
Type: enum (of string)

Defines how the engine will queue the file in installation/uninstallation order.

Must be one of:

  • "default"
  • "parallel"
  • "sequential"

root sw [A-Z0-9_]+ platforms platforms items componentInstallParameters executionCommands
Type: array of object

The commands that need to be executed during the process.

 No Additional Items

Each item of this array must be:

root sw [A-Z0-9_]+ platforms platforms items componentInstallParameters executionCommands executionCommands items
Type: object

root sw [A-Z0-9_]+ platforms platforms items componentInstallParameters executionCommands executionCommands items commandSequence
Type: enum (of string)

The sequence stage of when/how the commands should be executed.

Must be one of:

  • "query"
  • "pre_install"
  • "install"
  • "post_install"
  • "pre_uninstall"
  • "uninstall"
  • "post_uninstall"

root sw [A-Z0-9_]+ platforms platforms items componentInstallParameters executionCommands executionCommands items executionType
Type: enum (of string)

The type of where the commands should be executed.

Must be one of:

  • "exec_bash"
  • "remote_exec_bash"

root sw [A-Z0-9_]+ platforms platforms items componentInstallParameters variables
Type: object

Environment variables during the installation/uninstallation process.

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

Property name regular expression: [a-zA-Z0-9_]+
root sw [A-Z0-9_]+ platforms platforms items componentInstallParameters variables [a-zA-Z0-9_]+
Type: string

Key is the environment variable name, and value is the environment variable value.

root sw [A-Z0-9_]+ platforms platforms items downloadFiles
Type: array of object

This element contains information of the download files and installation methods.

 No Additional Items

Each item of this array must be:

root sw [A-Z0-9_]+ platforms platforms items downloadFiles downloadFiles items
Type: object
No Additional Properties

root sw [A-Z0-9_]+ platforms platforms items downloadFiles downloadFiles items url
Type: string

The URL of the download file.

root sw [A-Z0-9_]+ platforms platforms items downloadFiles downloadFiles items fileName
Type: string

The file name of the download file.

root sw [A-Z0-9_]+ platforms platforms items downloadFiles downloadFiles items size
Type: number

Size of the download file in bytes.

root sw [A-Z0-9_]+ platforms platforms items downloadFiles downloadFiles items checksum
Type: string

Checksum of the download file.

root sw [A-Z0-9_]+ platforms platforms items downloadFiles downloadFiles items checksumType
Type: string

The download file checksum type, Set to md5.

root sw [A-Z0-9_]+ platforms platforms items downloadFiles downloadFiles items verifyChecksum
Type: string

The yes / no to identify whether SDK Manager should verify the checksum.

root sw [A-Z0-9_]+ platforms platforms items downloadFiles downloadFiles items packageInstallParameters
Type: object

The install parameters for the download file.

 No Additional Properties

root sw [A-Z0-9_]+ platforms platforms items downloadFiles downloadFiles items packageInstallParameters additionalParameters
Type: object

Additional parameters for the download file.

 No Additional Properties

root sw [A-Z0-9_]+ platforms platforms items downloadFiles downloadFiles items packageInstallParameters additionalParameters repoPackageInfo
Type: object

Repo package info. This is only used when there is a specific key file need to be added for the repo but is not a *.pub in the repo.

root sw [A-Z0-9_]+ platforms platforms items downloadFiles downloadFiles items packageInstallParameters additionalParameters repoPackageInfo keyFile
Type: string

Public key file name within this repo file. The key file is then added with 'sudo apt-key add <keyFile>' command. Example: GPGKEY. If not provided, it searches *.pub in the repo and use this file.

root sw [A-Z0-9_]+ platforms platforms items downloadFiles downloadFiles items packageInstallParameters additionalParameters installCommandArguments
Type: string

It is used to pass additional parameters to .run file. Example: '--nox11 --noprogress -- -noprompt'. It is not used for other file type at the moment.

root sw [A-Z0-9_]+ platforms platforms items downloadFiles downloadFiles items packageInstallParameters executionCommands
Type: array of object

The commands that need to be executed during the process.

 No Additional Items

Each item of this array must be:

root sw [A-Z0-9_]+ platforms platforms items downloadFiles downloadFiles items packageInstallParameters executionCommands executionCommands items
Type: object

root sw [A-Z0-9_]+ platforms platforms items downloadFiles downloadFiles items packageInstallParameters executionCommands executionCommands items commandSequence
Type: enum (of string)

The sequence stage of when/how the commands should be executed.

Must be one of:

  • "query"
  • "pre_install"
  • "install"
  • "post_install"
  • "pre_uninstall"
  • "uninstall"
  • "post_uninstall"

root sw [A-Z0-9_]+ platforms platforms items downloadFiles downloadFiles items packageInstallParameters executionCommands executionCommands items executionType
Type: enum (of string)

The type of where the commands should be executed.

Must be one of:

  • "exec_bash"
  • "remote_exec_bash"

root sw [A-Z0-9_]+ platforms platforms items downloadFiles downloadFiles items packageInstallParameters variables
Type: object

Environment variables during the installation/uninstallation process.

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

Property name regular expression: [a-zA-Z0-9_]+
root sw [A-Z0-9_]+ platforms platforms items downloadFiles downloadFiles items packageInstallParameters variables [a-zA-Z0-9_]+
Type: string

Key is the environment variable name, and value is the environment variable value.

root sw [A-Z0-9_]+ platforms platforms items downloadFiles downloadFiles items packageInstallParameters installDir
Type: string

Path where the installation will be executed.

root sw [A-Z0-9_]+ platforms platforms items downloadFiles downloadFiles items packageInstallParameters installEngineQueue
Type: enum (of string)

Defines how the engine will queue the file in installation order.

Must be one of:

  • "default"
  • "parallel"
  • "sequential"

root sw [A-Z0-9_]+ platforms platforms items downloadFiles downloadFiles items packageInstallParameters installType
Type: string

Installation type of the download file.
Examples:

"skip"

"archive"

"zip"

"tgz"

"deb"

"deb_repo"

"run"

"run_root"

"cmd"

"target_deb_repo"

"target_deb"

"rpm"

root sw [A-Z0-9_]+ platforms platforms items dependencies
Type: array of object

The components or groups this component should be dependent on for the installation queue.

 No Additional Items

Each item of this array must be:

root sw [A-Z0-9_]+ platforms platforms items dependencies dependencies items
Type: object
No Additional Properties

root sw [A-Z0-9_]+ platforms platforms items dependencies dependencies items type
Type: string

Type of the dependency.
Examples:

"optional"

"required"

root sw [A-Z0-9_]+ platforms platforms items dependencies dependencies items id
Type: string

ID of the dependency component or group.

root sw [A-Z0-9_]+ platforms platforms items architectures
Type: array of string

Define what kind of architectures this component supports.

 No Additional Items

Each item of this array must be:

root sw [A-Z0-9_]+ platforms platforms items architectures architectures items
Type: string

Examples:

[
    "x86_64"
]

[
    "aarch64",
    "x86_64"
]

root sw [A-Z0-9_]+ platforms platforms items supportedHardware
Type: object

Supported hardware information.

 No Additional Properties

root sw [A-Z0-9_]+ platforms platforms items supportedHardware seriesIds
Type: array of string

Series Ids this release support. Available series Ids can be found in ~/.nvsdkm/hwdata/families/<product>/series/ (see Hardware reference file).

 No Additional Items

Each item of this array must be:

root sw [A-Z0-9_]+ platforms platforms items supportedHardware seriesIds seriesIds items
Type: string

Example:

[
    "JETSON_AGX_ORIN_TARGETS"
]

root sw [A-Z0-9_]+ platforms platforms items supportedHardware deviceIds
Type: array of string

Device Ids this release support. Available device Ids can be found in ~/.nvsdkm/hwdata/families/<product>/devices/ (see Hardware reference file).

 No Additional Items

Each item of this array must be:

root sw [A-Z0-9_]+ platforms platforms items supportedHardware deviceIds deviceIds items
Type: string

Example:

[
    "JETSON_AGX_ORIN_64GB"
]

root sw [A-Z0-9_]+ platforms platforms items supportedHardware excludedDeviceIds
Type: array of string

Device Ids that should be excluded from the series, it can either have a unique install method, or should not be included in the release. Available device Ids can be found in ~/.nvsdkm/hwdata/families/<product>/devices/ (see Hardware reference file).

 No Additional Items

Each item of this array must be:

root sw [A-Z0-9_]+ platforms platforms items supportedHardware excludedDeviceIds excludedDeviceIds items
Type: string

Example:

[
    "JETSON_AGX_ORIN_64GB"
]

root sw [A-Z0-9_]+ platforms platforms items installSizeMB
Type: number

The size in MB of the component after installed.

root sw [A-Z0-9_]+ platforms platforms items prerequisites
Type: array of object

The prerequisites string checks for the components, if needed. Available prerequisites in SDK Manager include.

 No Additional Items

Each item of this array must be:

root sw [A-Z0-9_]+ platforms platforms items prerequisites prerequisites items
Type: object
No Additional Properties

root sw [A-Z0-9_]+ platforms platforms items prerequisites prerequisites items prerequisiteID
Type: enum (of string)

The IDs of the prerequisite.

Must be one of:

  • "PREREQUISITE_APT_HOST"
  • "PREREQUISITE_APT_TARGET"
  • "PREREQUISITE_DISK_SPACE_TARGET"
  • "PREREQUISITE_NETWORK_TARGET"
  • "PREREQUISITE_RHEL_REPO_CODEREADY_HOST"
  • "PREREQUISITE_LINUX_KERNEL"
  • "PREREQUISITE_LINUX_KERNEL_TARGET"
  • "PREREQUISITE_DEVICE_IMAGE_VERSION_TARGET"

root sw [A-Z0-9_]+ platforms platforms items prerequisites prerequisites items parameters
Type: array of object

Parameters of the prerequisite

 No Additional Items

Each item of this array must be:

root sw [A-Z0-9_]+ platforms platforms items prerequisites prerequisites items parameters parameters items
Type: object

root sw [A-Z0-9_]+ platforms platforms items prerequisites prerequisites items parameters parameters items operatingSystems
Type: array of string

The operating systems need to use this prerequisite.

 No Additional Items

Each item of this array must be:

root sw [A-Z0-9_]+ platforms platforms items prerequisites prerequisites items parameters parameters items operatingSystems operatingSystems items
Type: string

root sw [A-Z0-9_]+ platforms platforms items prerequisites prerequisites items parameters parameters items architectures
Type: array of string

Define what kind of architectures need to use this prerequisite.

 No Additional Items

Each item of this array must be:

root sw [A-Z0-9_]+ platforms platforms items prerequisites prerequisites items parameters parameters items architectures architectures items
Type: string

Examples:

[
    "x86_64"
]

[
    "aarch64",
    "x86_64"
]

root sw [A-Z0-9_]+ platforms platforms items prerequisites prerequisites items parameters parameters items kernelVersion
Type: string

What kernel version need to use. Only if prerequisite is related to a kernel(id includes KERNEL).

root sw [A-Z0-9_]+ platforms platforms items prerequisites prerequisites items parameters parameters items informationUri
Type: string

Information uri of this prerequisite related topic.

root sw [A-Z0-9_]+ platforms platforms items prerequisites prerequisites items parameters parameters items deviceImageVersion
Type: string

What device image version need to use. Only if prerequisite is related to device image version(id includes DEVICEIMAGEVERSION).

root sw [A-Z0-9_]+ platforms platforms items modals
Type: array of string

Contains the modalIDs defined in this L3 Json need to be used in this platform.

 No Additional Items

Each item of this array must be:

root sw [A-Z0-9_]+ platforms platforms items modals modals items
Type: string

root sw [A-Z0-9_]+ version
Type: string

The component exact version.

root sw [A-Z0-9_]+ licenseIds
Type: array of string

The IDs of the licenses for this component are used in SDK Manager.

 No Additional Items

Each item of this array must be:

root sw [A-Z0-9_]+ licenseIds licenseIds items
Type: string

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

ID, Used in the client to identify the component.

root sw [A-Z0-9_]+ isDetectableInstall
Type: boolean

Set whether the component installation status is detectable or not. Typically, the installation type with deb, debrepo, targetdebrepo, targetdeb, and rpm should be set to true. Others should be set to false.

root sw [A-Z0-9_]+ isPartiallyDetectableInstall
Type: boolean

Set whether the component installation status is detectable. Should be set to true when a component has both detectable methods and undetectable methods in it.

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