Help Center> ROMA Connect> Developer Guide> Developer Guide for Device Integration> MQTT Topic Specifications> Gateway Login
View PDF

Gateway Login

The IoT platform supports the CONNECT message API using the MQTT protocol in the southbound direction to obtain the authentication information clientId, Username, and Password.

Parameter Description

Parameter

Mandatory/Optional

Type

Description

clientId

Mandatory

String(256)

The value of this parameter consists of the device or node ID, authentication type, password signature type, and timestamp, which are separated by underscores (_).

  • The authentication type is 1 byte long and can be set to one of the following values
    • 0: The device ID, which is unique for each device, is used for access
    • 2: The node ID, which is unique for each device, is used for access
  • The signature type is 1 byte long and can be set to one of the following values:
    • 0: The timestamp is not verified using the HMAC-SHA256 algorithm.
    • 1: The timestamp is verified using the HMAC-SHA256 algorithm.
  • The timestamp is the UTC time when the device was connected to the platform, in the format of YYYYMMDDHH. For example, if the UTC time is 2018/7/24 17:56:20, the timestamp is 2018072417.

For example, the client ID of the device ID is D39564861q3gDa_0_0_2018072417.

Username

Mandatory

String(256)

Username, which is unique for each device.

  • When the device accesses the platform using deviceId, set this parameter to the value of deviceId used when the device is registered successfully.
  • When the device accesses the platform using nodeId, set this parameter to the value of nodeId used when the device is registered successfully.

Password

Mandatory

String(256)

The value of this parameter is the value of the device secret encrypted by using the HMAC-SHA256 algorithm with the timestamp as the key.

The value of this parameter is the secret returned by the platform during device registration or is the secret of the device.