ThingsBoard IoT Gateway快速入门

下面我们添加 MQTT connector，它将使用带内置数据生成器的演示 broker 订阅若干数据 topic，并将数据发送到网关。

配置演示 MQTT broker

我们将使用 docker 镜像作为演示 MQTT broker，可通过以下命令安装并运行：

1
docker run -it -p 1884:1884 thingsboard/tb-gw-mqtt-broker:latest

运行 docker 镜像后，终端会显示以下日志：

配置 connector

MQTT connector 将使用 anonymous 安全类型，在端口 1884 连接到 “host.docker.internal” 上名为 “Demo Broker” 的 broker。 它将包含 “data/” topic 的数据 mapping，指定 JSON converter，并为设备数据定义 attribute 和 time series mapping。 此外，它将处理传感器的 connect 和 disconnect 请求，通过表达式从 topic filter 中提取设备名称。

创建 connector 请按以下步骤操作：

• 在右侧面板点击”Connectors configuration（Connector 配置）“按钮；

• 点击”+ Add connector（添加 Connector）“按钮；

• 在下拉中选择”MQTT“connector 类型，填写”Name“字段，将”Logging level“设为 INFO，禁用”Fill configuration with default values“并点击”Add“按钮；

• Connector 已创建。

首先配置到演示 broker 的连接。从”Connection to broker（连接 Broker）“部分开始。 该部分提供详细连接配置选项，包含 host、port、MQTT version、client ID、security 等重要字段。 host 字段指定 broker 地址，port 字段指定通信端口，MQTT version 字段确保与所用协议版本兼容，client ID 唯一标识客户端，security 配置 client 在 MQTT Broker 的授权。

填写以下字段值：

接下来进入”Data mapping（数据映射）“部分。该部分包含网关连接 broker 后将订阅的 topic 数组，以及处理传入消息（converter）的配置。

按以下步骤配置数据映射：

• 点击”Add mapping“按钮
• 在打开窗口中，将”Topic filter“字段填为”data/“，将”QoS“选为”0 - At most once（最多一次）“，将”Payload type“选为 JSON。

• 滚动到”Data conversion（数据转换）“部分：
  • 对于”Device“子节使用以下选项/值：
    • 在”Name“行，在”Source“下拉中选择”Constant“，在”Value / Expression“中填写”Device Demo“。
    • 在”Profile name“行，在”Source“下拉中选择”Constant“，在”Value / Expression“中填写”default“。

• 点击”Attributes“子节旁的铅笔图标，在打开窗口中：
  • 点击”Add attribute“，在”Key“中填写”frequency“，在”Type“中选择”Integer“，在”Value“中填写”${frequency}“。
  • 再次点击”Add attribute“，在”Key“中填写”power“，在”Type“中选择”Integer“，在”Value“中填写”${power}“。
  • 点击”Apply“。

• 点击”Time series“子节旁的铅笔图标，在打开窗口中：
  • 点击”Add time series“，在”Key“中填写”temperature“，在”Type“中选择”Integer“，在”Value“中填写”${temperature}“。
  • 点击”Add time series“，在”Key“中填写”humidity“，在”Type“中选择”Integer“，在”Value“中填写”${humidity}“。
  • 点击”Apply“。
• 点击”Add“。数据映射已添加。

完成上述步骤后，网关将接收并应用新配置，并与远程服务器同步状态。可在”Configuration“列查看 connector 配置的同步状态，确认网关是否与远程设置一致。

此外，可查看 connector 日志以确认 connector 工作正常，操作如下：

• 在 connector 的”General“标签页中，开启”Enable remote logging“开关启用远程日志。在”Log level“下拉中选择”DEBUG“。点击”Save“应用更改；

• 点击日志图标打开 connector 日志页面；

• 可看到由”Created time“、”Status“和”Message“列组成的”Logs“表格。

至此，网关已可通过新建并配置的 MQTT connector 处理数据。

下面向上述配置中的 MQTT Broker 发布数据。可使用 mosquitto_pub 或您所用编程语言的 MQTT 客户端库。本例使用 mosquitto_pub 命令行工具。

1. 确保系统已安装 Mosquitto MQTT 客户端。通常可通过操作系统包管理器安装：
   • Ubuntu：

     1
     sudo apt-get install mosquitto-clients
     

• Windows：

  从官网下载 Mosquitto 客户端工具。

  安装后，将安装目录添加到系统 PATH。

• MacOS：

  1
  brew install mosquitto
  

1. 使用 mosquitto_pub 向指定 MQTT topic 发布数据。本例使用配置中定义的 “data/” topic：

   1
   mosquitto_pub -h localhost -p 1884 -t data/ -m '{"frequency": 50, "power": 100, "temperature": 25, "humidity": 60}'
   

其中：

• -h - 指定 MQTT broker 的 host 地址；
• -p - 指定 MQTT broker 的 port；
• -t - 指定要发布到的 MQTT topic（本例为 “data/”）；
• -m - 指定要发布的 payload 或消息。应为 JSON 格式，符合配置 mapping 部分中的结构。

请根据需要调整 payload 值。

下面我们添加 Modbus connector，它将从演示 slave 读取部分数据到已创建的网关。

配置演示服务器

我们将使用 docker 镜像作为演示仿真 slave，可通过以下命令安装并运行：

1
docker run -it -p 5021:5021 thingsboard/tb-gw-modbus-server:latest

运行 docker 镜像后，终端会显示以下日志：

配置 connector

此 Modbus connector 配置通过 TCP 与端口 5021 上 “host.docker.internal” 的 slave 设备通信。 配置包括字节序、字序、timeout、轮询周期等数据获取规格。 名为 “Demo Device” 的 slave 设备配置为处理 Modbus function code 4 请求。 为 frequency、power、humidity、temperature 等参数定义了 attribute 和 time series mapping。此外还提供连接尝试、重试及失败后等待时间的配置。

创建 connector 请按以下步骤操作：

• 在右侧面板点击”Connectors configuration“按钮；

• 点击”+ Add connector“按钮；

• 在下拉中选择”MODBUS“connector 类型，填写”Name“，将”Logging level“设为”INFO“，关闭”Fill configuration with default values“并点击”Add“；

• Connector 已创建。

首先添加新 slave 并配置到其的连接。从”Master Connections“标签页开始。 该部分提供 slave 添加及连接类型、host、port、unit ID、method 等详细连接配置。

• 进入”Master Connections“标签页，点击”Add Slave“；
• 按下列值填写字段：

接下来进入”Attributes“部分。本部分配置用于处理 Modbus 服务器数据，在ThingsBoard 中将被解释为设备 attribute。

按以下步骤配置 attribute 部分：

• 点击”Attributes“部分的”铅笔“图标；
• 在打开窗口中点击”Add attribute“；
• 填写字段：
  • 在”Key“中填写”frequency“；
  • 将”Type“选为”16int“；
  • 将”Function code“选为”03 - Read Multiple Holding Registers“；
  • 将”Objects count“设为”1“；
  • 将”Address“设为”3“。
  • 开启”Modifier“开关；
  • 在”Modifier“部分，将”Type“设为”divider“；
  • 在”Modifier“部分，将”Value“设为”10“。

添加另一 attribute：折叠刚添加的 “frequency” attribute，点击”Add attribute“，按相同步骤填写以下值：

完成”Attributes“配置后点击”Apply“。

完成”Attributes“部分后，进入”Time series“部分。本部分配置用于处理 Modbus 服务器数据，在ThingsBoard 中将被解释为设备 time series。

按以下步骤配置 time series 部分：

• 点击”Time series“部分的”铅笔“图标。
• 在打开窗口中点击”Add time series“；
• 填写字段：
  • 在”Key“中填写”humidity“；
  • 将”Type“选为”16int“；
  • 将”Function code“选为”03 - Read Multiple Holding Registers“；
  • 将”Objects count“设为”1“；
  • 将”Address“设为”1“。
  • 开启”Modifier“开关；
  • 在”Modifier“部分，将”Type“设为”divider“；
  • 在”Modifier“部分，将”Value“设为”10“。

添加另一 time series：折叠刚添加的”humidity“time series，点击”Add time series“，按相同步骤填写以下值：

配置完成后，connector 的最终效果如下。完成后点击”Add“。

最后，点击”Save“保存 Modbus 配置。

完成上述步骤后，网关将接收并应用新配置，并与远程服务器同步状态。 可在”Configuration“列查看 connector 配置的同步状态，确认网关是否与远程设置一致。

此外，可查看 connector 日志以确认 connector 工作正常：

• 在 connector 的”General“标签页中，开启”Enable remote logging“启用远程日志。在”Log level“下拉中选择”DEBUG“。点击”Save“应用更改；

• 点击”logs“图标打开 connector 日志页面；

• 可看到由”Created time“、”Status“和”Message“列组成的”Logs“表格。

至此，网关已可通过新建并配置的 Modbus connector 处理数据。

下面我们添加 OPC-UA connector，它将从演示服务器读取部分数据到已创建的网关。

配置演示服务器

我们将使用 docker 镜像作为演示仿真服务器，可通过以下命令安装并运行：

1
docker run -it -p 4840:4840 thingsboard/tb-gw-opcua-server:latest

运行 docker 镜像后，终端会显示以下日志：

配置 connector

此 OPC-UA connector 配置在 “opc.tcp://host.docker.internal:4840/freeopcua/server/” 连接到名为 “OPC-UA Demo Server” 的服务器。 配置指定了 timeout、scan period、security 机制（如 anonymous 身份的 “Basic128Rsa15”）等。

mapping 部分定义 OPC-UA 节点如何映射到设备及其 attribute 和 time series。本例中将名为 “Demo Device”、类型为 “default” 的设备映射到 “Root\.Objects\.MyObject“ 下的节点。 frequency 和 power 等 attribute，以及 temperature 和 humidity 等 time series，映射到 OPC-UA 服务器中的特定 path。 此外，配置支持 RPC 方法和 attribute update。

创建 connector 请按以下步骤操作：

• 在右侧面板点击”Connectors configuration“按钮；

• 点击”+ Add connector“按钮；

• 在下拉中选择”OPCUA“connector 类型，填写”Name“，将”Logging level“设为”INFO“，关闭”Fill configuration with default values“并点击”Add“；

• Connector 已创建。

首先配置到演示 OPC-UA 服务器的连接。从”Server“标签页开始。 该部分提供 server endpoint url、security、scan period、poll period、subscriptions 等详细连接配置选项。

• 进入”Server“标签页，按下列值填写字段：

接下来进入”Data mapping“部分。该部分包含网关连接 OPC-UA 服务器后将订阅的节点列表，以及处理这些节点数据的配置。

按以下步骤添加新节点：

• 进入”Data mapping“标签页，点击”Add mapping“。
• 在打开窗口中，将”Device node“类型设为”Path“，值设为”Root\.Objects\.MyObject“；
• 对于”Device“子节使用以下选项/值：
  • “Name“行：在”Source“下拉中选择”Constant“，在”Value / Expression“中填写”Device Demo“；
  • “Profile name“行：在”Source“下拉中选择”Constant“，在”Value / Expression“中填写”default“。

进入”Attributes“部分添加 “frequency” 和 “power” attribute。本部分配置用于处理 OPC-UA 服务器数据，在ThingsBoard 中将被解释为设备 attribute。我们使用 path 查找对应节点。

Path 类型指 OPC-UA 服务器命名空间中的层级地址，用于定位服务器中的特定节点。attribute/time series 的 path 可为绝对或相对（本例为相对）。

按以下步骤配置 attribute 部分：

• 点击”Attributes“部分的”铅笔“图标；
• 在打开窗口中点击”Add attribute“；
• 在”Key“中填写”frequency“，将”Type“选为”Path“，在”Value“中填写”${Frequency}“。

添加另一个 attribute：折叠刚添加的 “frequency” attribute，点击”Add attribute“，按相同步骤填写以下值：

完成配置后点击”Apply“。

完成”Attributes“部分后，进入”Time series“部分。本部分配置用于处理 OPC-UA 服务器数据，在ThingsBoard 中将被解释为设备 time series。

按以下步骤配置 time series 部分：

• 点击”Time series“部分的”铅笔“图标；
• 在打开窗口中点击”Add time series“；
• 填写字段：
  • 在”Key“中填写”temperature“；
  • 将”Type“选为”Path“；
  • 在”Value“中填写”${Temperature}“。

添加另一 time series：折叠刚添加的”temperature“time series，点击”Add time series“，按相同步骤填写以下值：

配置完成后，connector 的最终效果如下。完成后点击”Add“。

最后，点击”Save“保存 OPC-UA 配置。

完成上述步骤后，网关将接收并应用新配置，并与远程服务器同步状态。 可在”Configuration“列查看 connector 配置的同步状态，确认网关是否与远程设置一致。

此外，可查看 connector 日志以确认 connector 工作正常：

• 在 connector 的”General“标签页中，开启”Enable remote logging“启用远程日志。在”Log level“下拉中选择”DEBUG“。点击”Save“应用更改；

• 点击日志图标打开 connector 日志页面；

• 可看到由”Created time“、”Status“和”Message“列组成的”Logs“表格。

至此，网关已可通过新建并配置的 OPC-UA connector 处理数据。