Documentation

Mistake on this page? Email us

Hierarchy

Index

Properties

alias

alias: string

The alias of the device

bootstrapCertificateExpiration

bootstrapCertificateExpiration: Date

Expiration date of the certificate used to connect to bootstrap server

bootstrappedTimestamp

bootstrappedTimestamp: Date

The date and time the device was bootstrapped

certificateFingerprint

certificateFingerprint: string

This is not part of the certificate but rather the SH-256 hash of the certificate.

certificateIssuerId

certificateIssuerId: string

This is the value of the CN field (in the Subject) of the Issuer of the certificate.

connectorCertificateExpiration

connectorCertificateExpiration: Date

Expiration date of the certificate used to connect to connector server

customAttributes

customAttributes: object

Up to 5 custom JSON attributes

Type declaration

  • [key: string]: string

description

description: string

The description of the device

deviceClass

deviceClass: string

The device class

deviceExecutionMode

deviceExecutionMode: number

The device execution mode

deviceType

deviceType: string

The type of the device - e.g. if the device is a gateway.

firmwareChecksum

firmwareChecksum: string

The SHA256 checksum of the current firmware image

hostGateway

hostGateway: string

The device name of the host gateway, if appropriate.

mechanism

mechanism: MechanismEnum

The ID of the channel used to communicate with the device

mechanismUrl

mechanismUrl: string

The address of the connector to use

name

name: string

The name of the device

serialNumber

serialNumber: string

The serial number of the device

state

The current state of the device

vendorId

vendorId: string

The device vendor ID