本指南演示ThingsBoard常用功能的基本用法。您将学习如何:
- 将设备连接至ThingsBoard
- 从设备向ThingsBoard推送数据
- 构建实时仪表板
- 创建客户并与他们共享仪表板
- 定义阈值并触发告警
- 通过邮件、SMS、移动应用或第三方服务配置通知
为简化说明,我们将以温度传感器数据为例进行可视化。
更偏好视频学习?可观看分步视频教程。
前提条件
需有一台运行中的 ThingsBoard 服务器:
- ThingsBoard Cloud: 零配置快速开始。点击北美或欧洲地区区域(链接跳转至对应托管服务的「快速入门」指南)。
- 自托管安装: 也可参考 Windows (Docker) 或 Linux 与 MacOS (Docker) 指南手动安装 ThingsBoard。
步骤1. 配置设备
示例:添加一台向ThingsBoard平台发送以下数据的设备:设备名称及温度遥测读数。
按以下步骤添加新设备:
- 登录您的 ThingsBoard 实例,进入 实体 部分的 设备 页面。
- 默认情况下,您会进入设备组 全部。点击表格右上角的 "+" 图标,然后从下拉菜单中选择 添加新设备。
- 输入设备名称(例如 我的新设备),此时无需进行其他更改。点击 添加。
- 将打开用于检查设备连接的窗口——我们暂时跳过此步骤,下一步再返回进行连接检查。
- 恭喜,您已添加了第一个设备!当您添加更多设备时,它们将显示在表格顶部,因为表格会自动按创建时间对设备进行排序,最新创建的排在最前面。
添加设备时您也会收到通知。点击右上角 铃铛图标 可查看通知。
其他配置方式
步骤2. 连接设备
验证设备与ThingsBoard的连接:
- 点击您的设备,然后在 设备详情 窗口中点击 检查连接 按钮。
- 在打开的窗口中,选择消息协议和操作系统,安装所需的客户端工具并复制提供的命令。
- 在终端中执行复制的命令。遥测数据(例如温度读数)成功发布后,设备状态将从 "未激活" 变为 "激活",您将看到数据显示。此时可以关闭连接检查窗口。
查看ThingsBoard API参考,获取设备连接所支持协议的更详细说明。
步骤3. 创建仪表板
ThingsBoard中的仪表板用于可视化和监控从IoT设备采集的数据。
创建仪表板并添加三个部件,用于展示实体列表及其最新值,以及指定实体的告警信息。
步骤3.1创建空仪表板
按以下步骤创建新仪表板:
- 通过屏幕左侧的主菜单进入 仪表板 页面。默认情况下,您会进入仪表板组 全部。
- 点击屏幕右上角的 "+" 符号,然后从下拉菜单中选择 创建新仪表板。
- 在打开的对话框中输入仪表板标题,描述为可选项。点击 添加。
- 创建仪表板后,它将自动打开,您可以立即开始添加部件。要保存仪表板,点击右上角的 保存 按钮。
- 您的第一个仪表板已成功创建。继续添加新仪表板时,它们将显示在列表顶部。此默认排序基于创建时间戳。
步骤3.2添加实体表部件
「实体表」部件展示实体列表及其最新值。 实体列表对应所选设备或其他实体,支持全文搜索和分页过滤。
添加表格部件时需从部件库中选择。部件按部件包分组。 每个部件有数据源,用于确定要展示的数据。 为查看步骤2中发送的「temperature」数据最新值,需配置数据源。
添加第一个部件:
- 进入仪表板编辑模式。打开仪表板并点击屏幕右上角的 编辑模式 按钮。
- 点击屏幕顶部的 + 添加部件 按钮,或点击屏幕中央的大 + 添加新部件 图标(如果这是此仪表板上的第一个部件)。
- 找到 表格 部件包并点击。
- 选择 实体表格 部件。
- 将显示添加部件窗口。在 设备 字段中,指定之前创建的设备 我的新设备 作为数据源。name 键已添加到 列 部分,负责设备名称列。您需要添加另一列以显示 temperature 键的值。为此,点击 添加列 以添加新字段来输入数据键。
- 点击新出现的数据键输入字段。将打开可用数据键列表。选择 temperature 数据键。
- 点击部件右下角的 添加 按钮以完成部件添加。
- 要使部件稍大一些,只需拖动右下角。确认新大小后,别忘了点击 保存 以保存对仪表板的更改。
恭喜!您已添加第一个部件。
「实体表」部件包含两列。 第一列显示设备名称,第二列显示「temperature」键(设备遥测)的值。 每列对应一个添加的键。
现在可发送新的遥测读数(同步骤1),它会立即显示在表格中。
步骤3.3添加图表部件
图表部件用于展示时序数据,支持可定制的折线图和柱状图。
添加图表部件时需从部件库中选择。 图表部件显示同一数据键的多个历史值(本例为「temperature」)。 还需配置时间窗口以使用图表部件。
- 进入编辑模式并点击屏幕顶部的 添加新部件 按钮。
- 找到 图表 部件包并点击。
- 选择 时间序列图表 部件。
- 在 设备 字段中,指定之前创建的设备 我的新设备 作为数据源。在 系列 部分,指定数据键 temperature 以开始监控设备的温度值。然后点击 添加。
- 调整部件大小并应用更改。如同步骤 2 一样,多次发布不同的遥测值。注意:默认情况下部件仅显示一分钟的数据。点击 保存 以应用更改。
恭喜!您已添加图表部件。现在可发送新的遥测读数,它会立即显示在图表中。
还可调整部件中数据展示的时间间隔、修改聚合函数、指定分组间隔。 打开时间窗口并进行设置,然后点击「更新」按钮应用时间窗口配置。
步骤3.4添加告警表部件
告警表部件在指定时间窗口内显示与指定实体相关的告警。 通过指定实体为告警源并配置对应告警字段来配置告警部件。
- 进入编辑模式并点击屏幕顶部的 添加新部件 按钮。
- 找到 告警部件 包并点击。
- 选择 告警表格 部件。
- 在 设备 字段中指定之前创建的设备 我的新设备 作为数据源。接下来配置过滤器。所有告警都有特定的严重程度和状态,勾选您希望在部件中看到的选项。如未勾选任何项,将显示所有告警,无论其状态或严重程度。
- 恭喜!您已添加告警部件。默认情况下,新部件会自上而下堆叠添加。让我们整理一下部件布局。将 时间序列图表 部件拖到仪表板右上角,为 告警表格 部件腾出空间。
- 向下滚动,找到 告警表格 部件并将其拖到空白位置。根据需要调整其大小。完成后点击 保存 以保存仪表板。
接下来配置告警规则并触发告警。
说明:本文档以单个设备作为部件数据源。 若要以动态实体(如某类设备或某资产下的设备)为数据源,需使用alias。 Alias是部件中使用的单个实体或实体组的引用。 可在此了解不同类型alias。
步骤4. 配置告警规则
使用告警规则功能定义:当温度超过25°C时触发。
告警规则可在设备级别或目标设备使用的设备配置级别配置。
建议:若同一规则需应用于多台设备,请在设备配置级别创建。
便于集中管理告警逻辑、简化维护,并避免配置重复。
本示例中,我们将在设备「My New Device」上直接配置告警规则。
步骤4.1打开设备设置
- 进入 实体 下的 设备 页面。
- 点击 My New Device 打开详情。
- 切换到 告警规则 选项卡。
- 点击「+」并选择 创建新告警规则。
步骤4.2配置通用参数
在 通用 部分,填写 告警类型 —— 高温(或您喜欢的其他名称)—— 作为告警名称和唯一标识。
步骤4.3添加参数
定义告警触发条件前,需至少添加一个 参数 —— 规则使用的数据源。
在 参数 部分点击 添加参数 并填写:
- 实体类型:当前实体
- 参数类型:最新遥测
- 时序键:temperature
- 参数名:temperature
- 点击 添加。
这将创建告警规则条件中使用的 temperature 变量。
步骤4.4配置告警触发条件
在 触发条件 部分点击 添加触发条件。
- 严重程度:严重
- 条件
- 点击 添加条件。
- 在配置窗口中点击 添加参数过滤器 并设置:
- 通用 块:
- 参数:temperature(之前添加的参数)
- 值类型:数值
- 过滤器 块:
- 点击 添加
- 操作:大于
- 值来源:静态
- 值:25
- 点击 添加。
- 通用 块:
- 类型:简单
- 点击 保存。
配置完成后,温度超过 25°C 时将立即触发告警。
保存规则
点击 添加 保存新的告警创建规则。
保存后规则立即生效。
点击 我的新设备 打开其详情,并进入 告警规则 标签页。
点击 "+" 按钮,选择 创建新告警规则。
过滤器: 点击 添加;操作: 大于;值来源: 静态;值: 25。
点击 添加。
保存 条件。
建议参考告警规则配置示例。
步骤5. 创建告警
告警规则已生效(见步骤4),需从设备发送新的遥测数据(见步骤2)以触发告警。
注意:仅当温度值超过告警创建条件中定义的25°C阈值时,系统才会创建告警。
发送遥测后将发生什么
- 一旦新的 temperature 值超过阈值,仪表板上将出现新的活动告警。
- 您可以使用 告警表格 部件对告警进行 确认 和 清除。
- 告警创建后,您还会在 通知中心 收到通知。点击右上角的铃铛图标以查看最新通知。
步骤6. 告警通知
ThingsBoard通知中心可向最终用户发送与设备活动、环境变化或IoT生态事件相关的个性化通知。 通知可通过邮件、SMS或集成的第三方系统送达。
此外,ThingsBoard PE移动应用可直接向手机推送即时通知,帮助您随时了解关键事件。
按此指南安装ThingsBoard移动应用并配置通知。
欢迎继续探索ThingsBoard!
步骤7. 与客户共享仪表板
ThingsBoard的重要功能之一是为最终用户创建仪表板。 每位客户用户应仅能看到自己的设备,不能看到属于其他客户的设备或数据。
我们已创建设备(见步骤1)、创建仪表板并添加部件(见步骤3)。 接下来创建客户和客户用户,并确保他们能访问设备数据与仪表板。 租户管理员可通过以下两种方式向客户授予对实体(设备、仪表板、资产等)的访问权限:
步骤7.1创建客户
创建标题为「My New Customer」的客户,按以下说明操作:
- 进入 客户 页面。默认情况下,您会进入客户组 全部。点击 "+" 符号以添加新客户。
- 输入客户名称。此外,您可以输入客户的个人详情并分配主仪表板。要完成客户创建,可点击「添加」按钮。此时,新客户将创建并位于「全部」客户文件夹中。让我们为客户创建单独的组。为此,点击 下一步:所有者和分组 按钮。
- 如需,您可为此客户指定不同的所有者。我们将保持此选项不变。输入新组的名称并点击 创建新分组!。
- 点击 添加 以创建新客户组。
- 现在,点击 添加 以创建新客户。
- 客户已创建,位于 我的客户 组中。
步骤7.2更改设备所有者
将客户指定为设备所有者。同时创建设备组并将设备加入其中。
- 打开 设备 页面。点击您的设备以打开其详情。
- 点击 管理所有者和分组 按钮。
- 在 所有者 行中,开始输入客户名称然后选择该客户。
- 现在创建设备组。在 分组 行中输入所需的设备组名称。然后点击 创建新分组!。
- 在下一窗口中,点击 添加 按钮以创建设备组。
- 点击 更新 以添加到分组并更改设备的所有者。您随时可以将所有者改回租户。
- 默认情况下,设备列表会同时显示租户设备和客户的设备。禁用 包含客户实体 后,设备列表中仅显示租户设备。
- 您的设备列表现在应为空。
确认设备已分配给您的客户。
- 进入 客户 页面。在客户列表中找到您的客户,然后点击 管理客户设备 图标。
- 您的设备归客户所有,位于客户的设备组 我的设备 中。
可在创建设备时直接将客户设为所有者。按以下步骤操作:
- 打开 设备 页面。点击表格右上角的 "+" 图标,然后从下拉菜单中选择 添加新设备。
- 输入设备名称(例如 温控器),并在 所有者 字段中选择新所有者。然后点击 添加。
- 关闭连接检查窗口。
- 设备已创建,并立即属于您的客户。
步骤7.3共享仪表板
将仪表板共享给客户。 在ThingsBoard中不能直接共享单个仪表板,只能共享包含该仪表板的仪表板组。 默认情况下,仪表板位于「全部」组。 推荐做法是创建专用仪表板组并将仪表板移入其中;为简化说明,本指南使用已有的「全部」组。
- 打开 仪表板 页面并进入 分组 标签页。点击 全部 仪表板组旁的 共享 图标。
- 选择要共享仪表板的客户并设置权限级别。本例中选择「只读」,然后点击 共享。
也可在创建仪表板时即与客户共享:
- 在 仪表板 页面的 全部 标签页上,点击表格右上角的 "+" 图标,从下拉菜单中选择 创建新仪表板。
- 输入仪表板名称(例如 温控器)。在 所有者和分组 部分的 分组 字段中,选择现有组或输入新仪表板组的名称(例如 温控器组),然后点击 创建新分组!。
- 在打开的 添加实体组 窗口中,点击 下一步:共享实体组。
- 勾选 共享实体组 框,选择要共享仪表板的客户并设置其权限。然后点击 添加。
- 再次点击 添加 以确认仪表板创建。
- 新仪表板将自动打开——点击右上角的 保存。
- 您的仪表板已创建并放置在 温控器组 中。您可以通过点击分组名称快速访问。
步骤7.4创建客户用户
创建属于该客户且对仪表板与设备具有 只读 权限的用户。
可选择性配置用户登录平台Web界面后直接显示该仪表板。
- 进入 客户 页面。在客户列表中找到您的客户,然后点击 管理客户用户 图标;
- 进入 分组 标签页并选择 客户用户 组;
- 点击右上角的 "加号" 图标;
- 输入用户邮箱。此外,指定名字和姓氏。点击 添加。
- 复制激活链接并保存到安全位置。然后点击 "确定"。
- 点击已创建的用户以打开详情。点击 "铅笔" 图标进入编辑模式。
- 选择「我的新仪表板」作为默认仪表板并勾选 始终全屏。应用更改。
步骤7.5激活客户用户
最后,以客户用户身份登录ThingsBoard。
- 将之前复制的链接粘贴到新标签页并按「Enter」。输入两次密码并点击「创建密码」完成密码设置。
- 您现在已以客户用户身份登录。由于该用户仅有只读权限,可查看设备数据与告警,但无法确认或清除告警。
了解更多权限与基于角色的访问控制(RBAC),请点击此处。
下一步
-
安装指南 - 学习如何在各种操作系统上部署ThingsBoard。
-
连接设备 - 根据连接技术或方案学习如何连接设备。
-
数据可视化 - 配置ThingsBoard复杂仪表盘的说明。
-
数据处理与操作 - 学习使用ThingsBoard规则引擎。
-
IoT数据分析 - 学习使用规则引擎执行基本分析任务。
-
高级功能 - 了解ThingsBoard高级功能。