Add a topological relationship

Add topological relationships of sub-devices

Upstream​

• Request topic: /sys/{productKey}/{deviceName}/thing/topo/add
• Reply topic: sys/{productKey}/{deviceName}/thing/topo/add_reply

Request data format when using the Alink protocol

{
  "id": "123",
  "version": "1.0",
  "params": [
    {
      "deviceName": "deviceName1234",
      "productKey": "1234556554",
      "sign": "xxxxxx",
      "signmethod": "hmacSha1",
      "timestamp": "1524448722000",
      "clientId": "xxxxxx"
    }
  ]
}

Response data format when using the Alink protocol

{
  "id": "123",
  "code": 200,
  "data": {}
}

​Parameter description​

sign= hmac_md5(deviceSecret, clientId123deviceNametestproductKey123timestamp1524448722000)

Error messages

Delete topological relationships of sub-devices

A gateway can publish a message to this topic to request IoT Platform to delete the topological relationship between the gateway and a sub-device.

Upstream​

• Request topic: /sys/{productKey}/{deviceName}/thing/topo/delete
• Reply topic: /sys/{productKey}/{deviceName}/thing/topo/delete_reply

Request data format when using the Alink protocol

{
  "id": "123",
  "version": "1.0",
  "params": [
    {
      "deviceName": "deviceName1234",
      "productKey": "1234556554"
    }
  ]
}

Response data format when using the Alink protocol

{
  "id": "123",
  "code": 200,
  "data": {}
}

​Parameter description​

Error messages

Obtain topological relationships of sub-devices

Upstream​

• Request topic: /sys/{productKey}/{deviceName}/thing/topo/get
• Reply topic: /sys/{productKey}/{deviceName}/thing/topo/get_reply

A gateway can publish a message to this topic to obtain the topological relationships between the gateway and its connected sub-devices.

Request data format when using the Alink protocol

{
  "id": "123",
  "version": "1.0",
  "params": {}
}

Response data format when using the Alink protocol

{
  "id": "123",
  "code": 200,
  "data": [
    {
      "deviceName": "deviceName1234",
      "productKey": "1234556554"
    }
  ]
}

​Parameter description​

Error messages

Report new sub-devices

Upstream​

• Request topic: /sys/{productKey}/{deviceName}/thing/list/found
• Reply topic: /sys/{productKey}/{deviceName}/thing/list/found_reply

In some scenarios, the gateway can discover new sub-devices. The gateway reports information of a new sub-device to IoT Platform. IoT Platform forwards the sub-device information to third-party applications, and the third-party applications choose the sub-devices to connect to the gateway.

Request data format when using the Alink protocol

{
  "id": "123",
  "version": "1.0",
  "params": [
    {
      "deviceName": "deviceName1234",
      "productKey": "1234556554"
    }
  ]
}

Response data format when using the Alink protocol

{
  "id": "123",
  "code": 200,
  "data":{}
}

​Parameter description​

Error messages

Notify the gateway to add topological relationships of the connected sub-devices

Downstream

• Request topic: /sys/{productKey}/{deviceName}/thing/topo/add/notify
• Reply topic: /sys/{productKey}/{deviceName}/thing/topo/add/notify_reply

IoT Platform publishes a message to this topic to notify a gateway to add topological relationships of the connected sub-devices. You can use this topic together with the topic that reports new sub-devices to IoT Platform. IoT Platform can subscribe to a data exchange topic to receive the response from the gateway. The data exchange topic is /{productKey}/{deviceName}/thing/downlink/reply/message.

Request data format when using the Alink protocol

{
  "id": "123",
  "version": "1.0",
  "params": [
    {
      "deviceName": "deviceName1234",
      "productKey": "1234556554"
    }
  ],
  "method": "thing.topo.add.notify"
}

Response data format when using the Alink protocol

{
  "id": "123",
  "code": 200,
  "data": {}
}

​Parameter description​

Notify the gateway about topological relationship change

When you add, delete, disable, or enable sub-devices on IoT Platform, IoT Platform will change the topological relationships accordingly and will send notifications to the gateway.

The gateway subscribes to the topic: /sys/{productKey}/{deviceName}/thing/topo/change for topological relationship change notifications.

Message format when using the Alink protocol

{
    "id":"123",
    "version":"1.0",
    "params":{
        "status":0,  //0:create  1:delete 2-enable  8-disable
        "subList":[{
            "productKey":"a1hRrzD****",
            "deviceName":"abcd"
        }]
    }, 
  "method":"thing.topo.change"  
}

Response data format when using the Alink protocol

{
    "id":"123",
    "code":200,
    "message":"success",
    "data":{}
}