Updated at: 2022-02-24 GMT+08:00

IotaDeviceInfo Class

Parameter

Mandatory or Optional

Type

Description

nodeId

Mandatory

String

Uniquely identifies a device managed by the gateway connected to the IoT platform. This parameter is a key parameter determined by the device.

name

Optional

String

Specifies the name of a device.

description

Optional

String

Specifies the description of a device.

manufacturerId

Mandatory

String

Identifies a manufacturer.

manufacturerName

Optional

String

Specifies the name of a manufacturer.

mac

Optional

String

Specifies the MAC address of a device.

location

Optional

String

Specifies the location of a device.

deviceType

Mandatory

String

Specifies the type of a device.

model

Mandatory

String

Specifies the model of a device.

  • If a directly connected device is used, the value must be the same as the model defined in the profile.
  • If a Z-Wave device is used, the model is in the hexadecimal format of ProductType + ProductId (padded with zeros if required), for example, 001A-0A12.

swVersion

Optional

String

Specifies the software version.

In Z-Wave, the format is major version.minor version, for example, 1.1.

fwVersion

Optional

String

Specifies the firmware version.

hwVersion

Optional

String

Specifies the hardware version.

protocolType

Mandatory

String

Specifies the protocol type (Z-Wave).

bridgeId

Optional

String

Specifies the bridge through which devices connect to the IoT platform.

status

Optional

String

Specifies the status of a device. The value is ONLINE or OFFLINE.

  • ONLINE: The device is online.
  • OFFLINE: The device is offline.

statusDetail

Optional

String

Specifies the details about the device status. If pcStatus is specified, this parameter is mandatory.

Value:

  • NONE
  • CONFIGURATION_PENDING
  • COMMUNICATION_ERROR
  • CONFIGURATION_ERROR
  • BRIDGE_OFFLINE
  • FIRMWARE_UPDATING
  • DUTY_CYCLE
  • NOT_ACTIVE

mute

Optional

String

Specifies whether a device is screened.

  • TRUE
  • FALSE
close