Skip to content

调试工具 (playground)

Ivan, Yang Chi edited this page Jul 14, 2023 · 1 revision

目标

主要用于辅助开发者在基于 tio 的开发中,可以便捷地添加、查询、管理Thing,快速地对基本接口进行输入、输出验证,和模拟业务服务或Thing与 tio embeded mqtt broker 进行交互。

概览

为方便与所属tio集成,工具被设计为单页面应用形式,整个顶部状态栏、页面工作区和工具区构成,其中工作区可呈现为 Thing 列表页和 Thing 详情页,而 MQTT Clients 和 HTTP Logs 等位于工具区。如下图所示:

TIO Playground

工具区可折叠和最大化,如图所示:

折叠,初始状态 最大化

功能

添加 Thing

image

在列表页面点击右上角按钮,弹出添加窗口,输入 thingId 和密码提交即可。

查询已添加的 Thing

实际上查询的是 Shadow 信息,而不是 Thing 本身的信息。

TIO 支持查询 Shadow 时使用简单的 SQL 语句,为此工具提供了支持 SQL 语句提示的输入框,如下图所示:

image

同时,工具提供了一些常用的 SQL 语句用于选择和参考,如下所示:

image

工具以表格形式呈现查询结果:

标准表格 自定义字段

操作 Shadow

点击目标 Thing 所在行的 Thing Id 列(如果有的话),从列表页进入详情页。

image

Set Tags

点击 Shadow Tags 面板上右上角的 [ + Set Tags ] 按钮,即可弹出设置表单。

image

Set Desired

点击 Shadow Data 面板上右上角的 [ + Set Desired ] 按钮,即可弹出设置表单。

image

设置后详情页会自动刷新

image

Set Reported

与 Set Desired 不同,Set Reported 使用 MQTT 而不是 HTTP。

点击 Shadow Data 面板上右上角的 [ + Set Reported ] 按钮,如果已创建并连接相应的 MQTT 客户端,则会弹出设置表单,否则请安引导创建 MQTT 客户端或连接。

image

MQTT Client

打开位于工具区的 MQTT Clients 面板,即可进行 MQTT Client 的配置和调试

image

创建客户端

有 4 个入口可以打开如下 MQTT 连接配置界面:

image

分别是 MQTT Clients 面板列表栏右上角的常规按钮、MQTT Clients 面板详情栏为空时的引导按钮、Thing 详情页左侧的引导按钮(仅当 Thing 暂未关联客户端时)、以及 Set Reported 时触发的被动创建。

前 2 个入口打开通用创建,可以选择角色、输入和选择 Username,后两个为关联创建,已经绑定了角色、Username 和 Password。

不论哪种创建模式都可以配置高级选项和遗言。

连接、编辑、删除客户端

连接、编辑、删除客户端点击 MQTT Clients 面板详情栏右上角的对应按钮即可。其中编辑界面与创建界面一直,除了部分字段锁定以外。

订阅、发布

查看和管理订阅位于 MQTT Clients 面板详情栏右侧,为 1 个列表、1 个统计和 3 个按钮。

订阅列表中展示每一项的 Topic、Alias、订阅状态、专注状态(即仅查看本 topic 相关的消息)和删改按钮。

添加和修改订阅信息,如下下图所示:

image

MQTT 5.0 会展示更多配置项在表单,这里不再列出。

发布框位于 MQTT Clients 面板详情栏中下部,也是整个页面的中下部。表单提供一些基础配置,一个 topic 的输入和模板选择,以及 payload输入框。其中 Meta 配置只有在 Client 版本为 MQTT 5.0 时才会激活。

发布框之上是消息框。查看消息时,如果期望获得更大的视口,可以点击消息框右上角的全屏按钮进入阅读专注模式。如下图所示:

image

使用

请查看项目目录下的 web/README.md 文件。