Thingsboard MQTT 设备 API 参考

2022-06-07 02:05:04

入门

MQTT基础

MQTT是一种轻量级的发布-订阅消息传递协议，可能使其最适合于各种IoT设备。您可以在此处找到有关MQTT的更多信息。

ThingsBoard服务器节点充当MQTT代理，该代理支持QoS级别0（最多一次）和1（至少一次）以及一组预定义的主题。

客户端库设置

您可以在网上找到大量的MQTT客户端库。本文中的示例将基于Mosquitto和MQTT.js。为了设置这些工具之一，您可以使用我们的《Hello World》指南中的说明。

MQTT连接

我们将在本文中使用访问令牌设备凭证，这些凭证稍后将称为$ ACCESS_TOKEN。应用程序需要使用包含$ ACCESS_TOKEN的用户名发送MQTT CONNECT消息。连接序列期间可能的返回码及其原因：

0x00已连接 -已成功连接到ThingsBoard MQTT服务器。
0x04连接被拒绝，用户名或密码错误 -用户名为空。
0x05连接被拒绝，未经授权 -用户名包含无效的$ ACCESS_TOKEN。

键值格式

默认情况下，ThingsBoard支持JSON中的键值内容。键始终是一个字符串，而值可以是字符串，布尔值，双精度或长整数。也可以使用自定义二进制格式或某些序列化框架。有关更多详细信息，请参见协议自定义。例如：

{"stringKey":"value1", "booleanKey":true, "doubleKey":42.0, "longKey":73}

遥测上传API

为了将遥测数据发布到ThingsBoard服务器节点，请将PUBLISH消息发送到以下主题：

v1/devices/me/telemetry

支持的最简单的数据格式是：

{"key1":"value1", "key2":"value2"}

要么

[{"key1":"value1"}, {"key2":"value2"}]

请注意，在这种情况下，服务器端时间戳将分配给上传的数据！

如果您的设备能够获得客户端时间戳，则可以使用以下格式：

{"ts":1451649600512, "values":{"key1":"value1", "key2":"value2"}}

在上面的示例中，我们假设“ 1451649600512”是具有毫秒精度的Unix时间戳。例如，值‘1451649600512‘对应于‘星期五，2016年1月1日12：00：00.512 GMT‘。

属性API

ThingsBoard属性API使设备能够

将客户端设备属性上载到服务器。
从服务器请求客户端和共享设备属性。
从服务器订阅共享的设备属性。
将属性更新发布到服务器

为了将客户端设备属性发布到ThingsBoard服务器节点，请将PUBLISH消息发送到以下主题：

v1/devices/me/attributes

从服务器请求属性值

为了向ThingsBoard服务器节点请求客户端或共享设备属性，请将PUBLISH消息发送到以下主题：

v1/devices/me/attributes/request/$request_id

其中$ request_id是您的整数请求标识符。在发送带有请求的PUBLISH消息之前，客户端需要订阅

v1/devices/me/attributes/response/+

从服务器订阅属性更新

为了订阅共享设备属性更改，请发送SUBSCRIBE消息到以下主题：

v1/devices/me/attributes

当服务器端组件之一（例如REST API或规则链）更改了共享属性时，客户端将收到以下更新：

{"key1":"value1"}

RPC API

服务器端RPC

为了从服务器订阅RPC命令，请将SUBSCRIBE消息发送到以下主题：

v1/devices/me/rpc/request/+

订阅后，客户端将以发布消息的形式接收到相应主题的各个命令：

v1/devices/me/rpc/request/$request_id
其中$ request_id是整数请求标识符。

客户应发布对以下主题的响应：

v1/devices/me/rpc/response/$request_id

客户端RPC

为了将RPC命令发送到服务器，请将PUBLISH消息发送到以下主题：

v1/devices/me/rpc/request/$request_id

其中$ request_id是整数请求标识符。来自服务器的响应将发布到以下主题：

v1/devices/me/rpc/response/$request_id

参考：https://thingsboard.io/docs/reference/mqtt-api/

交流：https://www.iotschool.com/topics/165

欢迎大家加入thingsboard 二次开发讨论群：121202538

码农公寓

入门