集成

网关是ThingsBoard中的一种特殊类型的设备，能够充当连接到不同外部设备和ThingsBoard之间的桥梁。
网关API提供了使用单个MQTT连接在多个设备和平台之间交换数据的功能。
网关还充当ThingsBoard设备，并且可以利用现有的MQTT设备API来报告统计信息，接收配置更新等等。
以下列出的API由ThingsBoard开源IoT网关使用。

基础MQTT API

请参考通用MQTT设备API以获取有关数据格式，身份验证选项等的信息

设备连接API

通知ThingsBoard设备已连接到网关需要发布以下消息：

  1. Topic: v1/gateway/connect
  2. Message: {"device":"Device A"}

Device A 代表你的设备名称。
收到后ThingsBoard将查找或创建具有指定名称的设备。
ThingsBoard还将向该网关发布有关特定设备的新属性更新和RPC命令的消息。

设备断开API

为了通知ThingsBoard设备已与网关断开连接，需要发布以下消息：

  1. Topic: v1/gateway/disconnect
  2. Message: {"device":"Device A"}

Device A 代表你的设备名称。
一旦收到ThingsBoard将不再将此特定设备的更新发布到此网关。

属性API

ThingsBoard属性API能够使设备具备如下功能

  • 将客户端设备属性上载到服务器
  • 从服务器请求客户端和共享设备属性
  • 从服务器订阅 共享设备属性
    将属性更新发布到服务器
    为了将客户端设备属性发布到ThingsBoard服务器节点，请将PUBLISH消息发送到以下主题：
    1. Topic: v1/gateway/attributes
    2. Message: {"Device A":{"attribute1":"value1", "attribute2": 42}, "Device B":{"attribute1":"value1", "attribute2": 42}}
    其中Device A和Device B是你的设备名称，attribute1和attribute2是属性键。
    从服务器请求属性值
    为了向ThingsBoard服务器节点请求客户端或共享设备属性，请将PUBLISH消息发送到以下主题：
    1. Topic: v1/gateway/attributes/request
    2. Message: {"id": $request_id, "device": "Device A", "client": true, "key": "attribute1"}
    其中 $request_id 是您的整数请求标识符，Device A是你的设备名称，client标识客户端或共享属性范围，而key是属性键。
    在发送带有请求的PUBLISH消息之前，客户端需要订阅
    1. Topic: v1/gateway/attributes/response
    消息结果格式如下：
    1. Message: {"id": $request_id, "device": "Device A", "value": "value1"}
    从服务器订阅属性更新
    为了订阅共享设备属性更改，请发送SUBSCRIBE消息到以下主题
    1. v1/gateway/attributes
    消息结果格式如下：
    1. Message: {"device": "Device A", "data": {"attribute1": "value1", "attribute2": 42}}

    遥测上传API

    为了将设备遥测发布到ThingsBoard服务器节点，请将PUBLISH消息发送到以下主题：
    1. Topic: v1/gateway/telemetry
    消息结构:
    1. {
    2. "Device A": [
    3.   {
    4.     "ts": 1483228800000,
    5.     "values": {
    6.       "temperature": 42,
    7.       "humidity": 80
    8.     }
    9.   },
    10.   {
    11.     "ts": 1483228801000,
    12.     "values": {
    13.       "temperature": 43,
    14.       "humidity": 82
    15.     }
    16.   }
    17. ],
    18. "Device B": [
    19.   {
    20.     "ts": 1483228800000,
    21.     "values": {
    22.       "temperature": 42,
    23.       "humidity": 80
    24.     }
    25.   }
    26. ]
    27. }
    其中Device A和Device B是你的设备名称，“temperature和humidity”是遥测键，ts是unix时间戳（以毫秒为单位）。

    RPC API

    服务器端RPC

    为了从服务器订阅RPC命令，请将SUBSCRIBE消息发送到以下主题：
    1. v1/gateway/rpc
    使用以下带有单个命令的消息格式：
    1. {"device": "Device A", "data": {"id": $request_id, "method": "toggle_gpio", "params": {"pin":1}}}
    设备处理完命令后，网关可以使用以下格式将命令发送回：
    1. {"device": "Device A", "id": $request_id, "data": {"success": true}}
    $request_id是你的整数请求标识符，Device A是你的设备名称，方法是您的RPC方法method。

    声明设备API

    请参阅相应的文章以获取有关声明设备功能的更多信息。
    为了启动声明设备，请向以下主题发送PUBLISH消息：
    1. Topic: v1/gateway/claim
    消息结构:
    1. {
    2. "Device A": {
    3.   "secretKey": "value_A",
    4.   "durationMs": 60000
    5. },
    6. "Device B": {
    7.   "secretKey": "value_B",
    8.   "durationMs": 60000
    9. }
    10. }
    Device A 和 Device B是设备名称 secretKey 和 durationMs是可选密钥。
    secretKey 使用空字符串作为默认值，device.claim.duration 毫秒未指定时系统参数 device.claim.duration 被使用（在文件 /etc/thingsboard/conf/thingsboard.yml ）。

    自定义协议

    通过更改相应的模块可以针对特定用例完全定制MQTT传输。