Descriptions and Samples for JSON Elements: Schema Version 13

• information - (object) contains information needed to support a specific SDK.

  • release - (object) contains release information needed to support a specific SDK.

    • releaseVersion - (string) the release version supported for this SDK.

    • releaseEdition - (string) the release edition supported for this SDK.

    • releaseRevision - (number) the release revision supported for this SDK.

• sw - (object) contains needed components’ information to change the components’ installation, and support multiple components.

  • key - (string) special key used in the client to identify the component. This key must already exist in sdkml3_<release>.json.

    This will override the original native component in SDK Manager’s l3 json with that key.

  • id - unique ID for the component. In general, this is the same as the key.

  • name - (string) the official name of the component, which will be shown in the SDK Manager GUI.

  • isVisible - (boolean) expose the component in the SDK Manager GUI.

  • estimateInstallDurationSeconds - (number) the estimated install duration in seconds.

  • versions - (array of objects)components can have different versions to upport different install files per targetIds and operatingSystems.

    • operatingSystems - (array of strings) the operating systems supported for this version.

    • installSizeMB - (number) the size in MB of the component after installation is complete.

    • targetIds - (array of strings) target series IDs of the target devices; available target series IDs can be found in ~/.nvsdkm/hwdata/HWDevices/ (see the Hardware reference file) ending with TARGETS.json or DEVKITS.json. For example:

      JETSON_AGX_XAVIER_TARGETS
          

  • prerequisites - (array of strings) The prerequisites string checks for the components, if needed. Available prerequisites in SDK Manager include:

    PREREQUISITE_APT_HOST, PREREQUISITE_DISK_SPACE_TARGET,
        

    PREREQUISITE_NETWORK_TARGET, PREREQUISITE_APT_TARGET
        

  • downloadFiles - (array of objects) This element contains information of the download files and installation methods.

    • url - (string) the URL of the download file.

    • fileName - (string) the file name of the download file.

    • size - (string) size of the download file in bytes.

    • checksum - (string) checksum of the download file.

    • checksumType - (string) the download file checksum type, Set to md5.

    • verifyChecksum - (string) yes / no to identify whether SDK Manager should verify the checksum.

    • installParameters - (object) the install parameters for the download file.

      • additionalParameters - (object) additional parameters for the download file.

      • installDir - (string) path where the installation will be executed.

      • installCommands - (array of objects) commands to run for the download file installation process. Some of the installation types can be automatically handled by SDK Manager, while others cannot.

      • installEngineQueue - (string) defines how the engine will queue the file in installation order. Available options are:

        default, parallel, sequential
            

  • installType - (string) installation type of the download file. Available options are:

    skip, archive, zip, tgz, deb, deb_repo, run, run_root, cmd, target_deb_repo, target_deb, rpm
        

  • installParameters - (object) the install parameters for the component.

    • installDir - (string) path of where the installation will be executed.

    • installCommands - (array of objects) commands to run for the download file installation process. Some of the install types can be automatically handled by SDK Manager, while others cannot.

    • installEngineQueue - (string) defines how the engine will queue the file in installation order. Available options are:

      default, parallel, sequential
          

  • preInstallCommands - (array of objects) commands to run before the component installation process.

  • postInstallCommands - (array of objects) commands to run after the component installation process.

  • installCommands - (array of objects) commands to run for the component installation process.

  • version - (string) the component exact version.

  • dependencies - (array of objects) the components or groups this component should be dependent on for the installation queue.

  • type - (string) type of the dependency. Available options are:

    optional, required
        

  • id - (string) ID of the dependency component or group.

  • ver - (string) version of the dependency component or group.

  • operator - (string) == or > or < or <= or >= for upper version.

  • licenseId - (string) the ID of the license for this component in SDK Manager.

  • isDetectableInstall - (boolean) Set whether the component installation status is detectable or not. Typically, the installation type with deb, deb_repo, target_deb_repo, target_deb, and rpm should be set to true. Others should be set to false.

  • isPartiallyDetectableInstall - (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.

• hw - (object) contains needed board information in order to identify a target device, and can only support a single target device.

• key - (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.

• name - (string) the official name of the target board, which is shown in the SDK Manager GUI.

• moduleNames - (array of strings) module/modules name supported on this target device. This is displayed in the SDK Manager GUI.

• hwDevices - (array of strings) used when there are multiple target devices in the devices group, not related to the extra configuration, should be kept empty as [].

• products - (array of strings) product names of the target devices. Supported products are: Jetson, Holoscan, DRIVE, DOCA, Switch.

• targetIds - (array of strings) target IDs of the target devices, usually uses the P + module ids for it.

• moduleIds - (array of strings) module IDs of the target devices. This is used in SDK Manager for board detection and flash identification.

• carrierIds - (array of strings) carrier IDs of the target devices. This is used in SDK Manager for board detection and flash identification.

• moduleDescription - (string) Description for the module of the target board.

• carrierDescription - (string) Description for the carrier of the target board.

• recoveryModeCodes - (array of strings) recovery mode code of the device in lsusb. This is used in SDK Manager for board detection and flash identification.

• aurixPort - (string) ttyUSB port used for DRIVE devices.

• deviceInstructions - (object) instructions to flash a board.

  • linux - (array of strings) used on DRIVE devices. Contains the DRIVE OS Linux flashing instructions.

  • qnx - (array of strings) used on DRIVE devices. Contains the DRIVE OS QNX flashing instructions.

  • recoveryManual - (array of strings) used on Jetson, Holoscan and Switch devices. Contains the manual flashing instructions.

• hwImagePath - (string) the path of hardware images, can be a URL starting with http://, https://, file:// or a local directory absolute path that starts with /.