Documentation

Mistake on this page? Email us

Firmware Manifest FirmwareManifest

Hierarchy

Index

Constructors

constructor

Properties

createdAt

createdAt: Date

The timestamp when the object was created The time the entity was created.

example

2017-05-22T12:37:55.576563Z

created_at

created_at: Date

The time the object was created

datafile

datafile: string

The URL of the firmware manifest binary

datafileSize

datafileSize: number

Size of the datafile (in bytes) The size of the firmware manifest in bytes.

datafileUrl

datafileUrl: string

The URL of the ASN.1 DER-encoded firmware manifest binary.

example

http://bucket.com/mymanifest.manifest

datafile_size

datafile_size: number

Size of the datafile in bytes

deliveredPayloadDigest

deliveredPayloadDigest: string

Digest (SHA256, hex-encoded) of the payload to deliver to the device.

example

c520fc771c0482ad39e983d27cf725a7c724fe58c616129a34a420d1941068bc

deliveredPayloadSize

deliveredPayloadSize: number

The size in bytes of the payload to deliver to the device.

deliveredPayloadType

Type of the payload to deliver to the device (full or delta image).

deliveredPayloadUrl

deliveredPayloadUrl: string

The URL of the payload to deliver to the device.

example

http://bucket.com/myimage.elf

description

description: string

The description of the firmware manifest The description of the firmware manifest.

deviceClass

deviceClass: string

The class of device The device class ID.

example

42c4d8de-704d-546e-b9d3-1ce1eb316167

deviceVendor

deviceVendor: string

The device vendor ID.

example

5d645eae-c231-5a89-9764-2e655cd94fa8

device_class

device_class: string

The class of the device

etag

etag: Date

The entity instance signature

id

id: string

The firmware manifest ID The ID of the firmware manifest

keyTableUrl

keyTableUrl: string

The URL of the key table used to encrypt the firmware The key table of pre-shared keys for devices.

example

http://example.com/key-table

key_table

key_table: string

The key table of pre-shared keys for devices

manifestSchemaVersion

manifestSchemaVersion: FirmwareManifestSchemaVersion

Version of the manifest schema (1 or 3).

name

name: string

The name of the object The name of the manifest.

example

manifest_name

object

object: string

The API resource entity

parsedRawManifest

parsedRawManifest: any

Raw manifest in JSON format, parsed from ASN.1 DER encoding. Fields may change. Backwards compatibility is not guaranteed. Recommended for debugging only.

precursorPayloadDigest

precursorPayloadDigest: string

Digest (SHA256, hex-encoded) of the currently installed payload.

example

54d640fcd687c9b13420b9be66a265494899002aad1b7370cfb3dbfd7fbec42f

timestamp

timestamp: Date

The firmware manifest version as a timestamp The version of the firmware manifest (as a timestamp) The firmware manifest version as a timestamp.

example

2017-05-22T12:37:55.576563Z

updatePriority

updatePriority: number

Update priority, passed to the application callback when an update is performed. Allows the application to make application-specific decisions.

updatedAt

updatedAt: Date

The timestamp the object was updated The time the entity was updated.

example

2017-05-22T12:37:55.576563Z

updated_at

updated_at: Date

The time the object was updated

url

url: string

The URL of the firmware manifest

Methods

delete

  • delete(): Promise<void>
  • Delete the firmware manifest

    Returns Promise<void>

    Promise containing any error

  • Delete the firmware manifest

    Parameters

    • callback: CallbackFn<void>

      A function that is passed any error

    Returns void