Interface Repository

OTA Device Version Query

IID: [1:{00010022}]

This interface serves as both a poll for new updates and a way for devices to report their current software versions.

> Type Definitions

Package IDType ID: 0

The identifier for the software package.

Encoding: 106
Length: 1024
Type: string
BucketType ID: 1

A bucket name. This is the data portion of an Object ID that representing a bucket.

Encoding: 106
Length: 1024
Type: string
FilenameType ID: 2

The name of a file.

Encoding: 106
Length: 1024
Type: string
Package Manifest VersionType ID: 3

The version of the manifest schema.

Encoding: 106
Length: 1024
Type: string
Package NameType ID: 4

The name or title of this update package.

Encoding: 106
Length: 1024
Type: string
VersionType ID: 5

The version of this update package.

Encoding: 106
Length: 1024
Type: string
DescriptionType ID: 6

The description of this update package.

Encoding: 106
Length: 16384
Type: string
LicenseType ID: 9

Short textual license name.

Encoding: 106
Length: 1024
Type: string
License URLType ID: 11

Link to the license.

Encoding: 106
Length: 1024
Type: string
CopyrightType ID: 13

The name of the manufacturer/owner of update package contents.

Encoding: 106
Length: 1024
Type: string
PackagerType ID: 16

The name of the packager providing the update package.

Encoding: 106
Length: 1024
Type: string
Content TypeType ID: 18

MIME type

Encoding: 106
Length: 1024
Type: string
Hash SHA256Type ID: 20

SHA256 of the signed and encrypted update, represented as a 64-character hexadecimal string

Encoding: 106
Length: 128
Type: string
SizeType ID: 8

The size in bytes of the update file.

MAX:
MIN:
Unit: bytes
Type: uint64
Callback IntervalType ID: 24

An callback interval in seconds.

MAX:
MIN:
Unit: seconds
Type: uint64
Release DateType ID: 17

The release (or publication) date/time of the update.

Type: datetime
Package IDsType ID: 22

An array of software package ids.

Min Length: 0
Length: 65535
Type: array ( 0 - Package ID ) PackagesType ID: 23

An array of software packages.

Min Length: 0
Length: 65535
Type: array ( 21 - Package ) PackageType ID: 21

The container for the software package details.

Type: structure { 0 - Package ID , 1 - Bucket , 2 - File Name , 3 - Package Manifest Version , 4 - Package Name , 5 - Version , 7 - Optional Description , 8 - Size , 10 - Optional License , 12 - License URL , 14 - Optional Copyright , 15 - Owner , 16 - Packager , 17 - Release Date , 19 - Content Type , 20 - hashSHA256 }
Optional DescriptionType ID: 7

The description of this update package. This may be null

Type: nullable ( Description ) Optional LicenseType ID: 10

Short textual license name. This may be null.

Type: nullable ( License ) Optional License URLType ID: 12

Link to the license. This may be null.

Type: nullable ( License URL ) Optional CopyrightType ID: 14

MIME type. This may be null.

Type: nullable ( Content Type )

Interface Options ▾

> Type Definitions

> Methods

Translation:
Language: