Manage topology relationships

Add a device topology relationship

A gateway device can use this topic to send an upstream request to add a topology relationship between itself and a sub-device. The response lists the sub-devices for which the topology relationship was successfully added.

Upstream data.

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

Alink request data format:

{
  "id": "123",
  "version": "1.0",
  "sys":{
      "ack":0
  },
  "params": [
    {
      "deviceName": "deviceName1234",
      "productKey": "1234556554",
      "sign": "xxxxxx",
      "signmethod": "hmacSha1",
      "timestamp": "1524448722000",
      "clientId": "xxxxxx"
    }
  ],
  "method": "thing.topo.add"
}

Alink response data format:

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

Request parameters:

sign= hmac_md5(deviceSecret, clientId123deviceNametestproductKey123timestamp1524448722000)

Response parameters:

Error messages:

Delete a device topology relationship

A gateway device can use this topic to send an upstream request to delete the topology relationship between itself and a sub-device. The response lists the sub-devices for which the topology relationship was successfully deleted.

Upstream data.

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

Alink request data format:

{
  "id": "123",
  "version": "1.0",
  "sys":{
      "ack":0
  },
  "params": [
    {
      "deviceName": "deviceName1234",
      "productKey": "1234556554"
    }
  ],
  "method": "thing.topo.delete"
}

Data format for Alink responses:

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

Request parameters

Response Parameters:

Error messages:

Get a device topology relationship

Upstream data.

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

A gateway device can use this topic to retrieve the topology relationship between itself and its sub-devices.

Alink request data format:

{
  "id": "123",
  "version": "1.0",
  "sys":{
      "ack":0
  },
  "params": {},
  "method": "thing.topo.get"
}

Alink response data format:

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

Request parameters:

Response parameters:

Error messages:

Report a list of discovered devices

Upstream data.

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

In some scenarios, a gateway can discover newly connected sub-devices. After discovery, the gateway must report the information of these sub-devices to the cloud. The information can then be forwarded to a third-party application through data forwarding. The third-party application can then select which sub-devices to connect to the gateway.

Alink request data format:

{
  "id": "123",
  "version": "1.0",
  "sys":{
      "ack":0
  },
  "params": [
    {
      "deviceName": "deviceName1234",
      "productKey": "1234556554"
    }
  ],
  "method": "thing.list.found"
}

Alink response data format:

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

Request parameters:

Response parameters:

Error messages:

Notify a gateway to add a device topology relationship

Downstream data.

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

This topic notifies a gateway device to add a topology relationship for a sub-device. This feature can be used with the feature for reporting a list of discovered devices. You can retrieve the result returned by the device through data forwarding. The data forwarding topic is /${productKey}/${deviceName}/thing/downlink/reply/message.

Alink request data format:

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

Alink response data format:

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

Request parameters:

Response parameters:

Notify a gateway of a topology relationship change

This topic notifies the gateway about changes in the topology relationship.

Gateway subscription topic: /sys/${productKey}/${deviceName}/thing/topo/change

Downstream message Alink data format:

{
    "id":"123",
    "version":"1.0",
    "params":{
        "status":0,  // 0: Create, 1: Delete, 2: Resume from disabled, 8: Disable
        "subList":[{
            "productKey":"a1hRrzD****",
            "deviceName":"abcd"
        }]
    }, 
  "method":"thing.topo.change"  
}

Parameters:

Alink response data format:

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