tencent cloud

Feature overview

A gateway device can bind and unbind subdevices under it through data communication with the cloud. To implement this feature, the following two topics will be used:

• Data upstream topic (for publishing): $gateway/operation/${productid}/${devicename}
• Data downstream topic (for subscribing): $gateway/operation/result/${productid}/${devicename}

Binding device

The gateway device can request to add its topological relationship with the subdevice through the data upstream topic so as to bind the subdevice. After the request succeeds, the platform will return the binding information of the subdevice through the data downstream topic.

Data format of the subdevice binding request:

{
  "type": "bind",
  "payload": {
    "devices": [
      {
        "product_id": "CFCS****G7",
        "device_name": "****ev",
        "signature": "signature",
        "random": 121213,
        "timestamp": 1589786839,
        "signmethod": "hmacsha256",
        "authtype": "psk"
      }
    ]
  }
}

Request parameter description:

Data format of the subdevice binding response:

{
  "type": "bind",
  "payload": {
    "devices": [
      {
        "product_id": "CFCS****G7",
        "device_name": "****ev",
        "result": -1
      }
    ]
  }
}

Response parameter description:

Unbinding device

The gateway device can request to unbind its topological relationship with the subdevice through the data upstream topic. After the request succeeds, the platform will return the unbinding information of the subdevice through the data downstream topic.

Data format of the subdevice unbinding request:

{
  "type": "unbind",
  "payload": {
    "devices": [
      {
        "product_id": "CFCS****G7",
        "device_name": "****ev"
      }
    ]
  }
}

Request parameter description:

Data format of the subdevice unbinding response:

{
  "type": "bind",
  "payload": {
    "devices": [
      {
        "product_id": "CFCS****G7",
        "device_name": "****ev",
        "result": -1
      }
    ]
  }
}

Response parameter description:

Querying topological relationship

The gateway device can upstream a request to query the topological relationship of the subdevice through this topic.
Data upstream topic: $gateway/operation/${productid}/${devicename}
Data downstream topic: $gateway/operation/result/${productid}/${devicename}

Data format of the subdevice topological relationship query request:

{
    "type": "describe_sub_devices"
}

Request parameter description:

Data format of the subdevice topological relationship query response:

{
  "type": "describe_sub_devices",
  "payload": {
    "devices": [
      {
        "product_id": "XKFA****LX",
        "device_name": "2OGDy7Ws8mG****YUe"
      },
      {
        "product_id": "XKFA****LX",
        "device_name": "5gcEHg3Yuvm****2p8"
      },
      {
        "product_id": "XKFA****LX",
        "device_name": "hmIjq0gEFcf****F5X"
      },
      {
        "product_id": "XKFA****LX",
        "device_name": "x9pVpmdRmET****mkM"
      },
      {
        "product_id": "XKFA****LX",
        "device_name": "zmHv6o6n4G3****Bgh"
      }
    ]
  }
}

Response parameter description:

Changing topological relationship

The gateway device can subscribe to the topological relationship changes of the subdevice on the platform through this topic.
Data downstream topic: $gateway/operation/result/${productid}/${devicename}

When the subdevice is bound or unbound, the gateway will receive the change in the topological relationship of the subdevice. The data format is as follows:

{
  "type": "change",
  "payload": {
  "status": 0,  // 0: unbound, 1: bound
  "devices": [
      {
        "product_id": "CFCS****G7",
        "device_name": "****ev",
      }
    ]
  }
}

Request parameter description:

Data format of the gateway response:

{
  "type": "change",
  "result": 0
}

Response parameter description:

Error codes