Help Center > > API Reference> AgentLite API Reference (C)> Common Data Structures> ST_IOTA_DEVICE_INFO Structure

ST_IOTA_DEVICE_INFO Structure

Updated at: Aug 28, 2019 GMT+08:00

Parameter

Mandatory or Optional

Type

Description

pcNodeId

Mandatory

String

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

pcName

Optional

String

Specifies the name of a device.

pcDescription

Optional

String

Specifies the device description.

pcManufacturerId

Mandatory

String

Identifies a manufacturer.

pcManufacturerName

Optional

String

Specifies the name of a manufacturer.

pcMac

Optional

String

Specifies the MAC address of a device.

pcLocation

Optional

String

Specifies the location of a device.

pcDeviceType

Mandatory

String

Specifies the type of a device.

pcModel

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 Z-Wave is used, the model is a hexadecimal number in the format of ProductType + ProductId (padded with zeros if required), for example, 001A-0A12.

pcSwVersion

Optional

String

Specifies the software version.

When Z-Wave is used, the software version is in the format of major version.minor version, for example, 1.1.

pcFwVersion

Optional

String

Specifies the firmware version.

pcHwVersion

Optional

String

Specifies the hardware version.

pcProtocolType

Mandatory

String

Specifies the protocol type (Z-Wave).

pcBridgeId

Optional

String

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

pcStatus

Optional

String

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

  • ONLINE: indicates that the device is online.
  • OFFLINE: indicates that 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

pcMute

Optional

String

Specifies whether a device is screened.

  • TRUE: indicates that the device is screened.
  • FALSE: indicates that the device is not screened.

Did you find this page helpful?

Submit successfully!

Thank you for your feedback. Your feedback helps make our documentation better.

Failed to submit the feedback. Please try again later.

Which of the following issues have you encountered?







Please complete at least one feedback item.

Content most length 200 character

Content is empty.

OK Cancel