TMX Insight™ 服务平台 2.6 用户指南

1 序言

本指南主要目的是使用户全面了解 TMX Insight™ 服务平台。文中 “平台” 均代指 TMX Insight™ 服务平台。

2 概述

平台能分析一些遥测数据并向您提供更有用的信息。一旦平台接收到设备数据,您就可以查看历史数据和统计数据。请参阅 TMX Access™ - 9.8 查看设备详细信息 以获取进一步信息。在当前版本中,平台提供了用于自定义数据可视化的仪表盘、用于数据计算的数据流和函数以及用于数据存储的 bucket。在数据流中,我们还提供了策略功能,用于进一步的数据监视和安全目的。

根据用户的需求,每个部署可以具有各种组件和功能。通过这些组件,平台提供以下功能:

  • Bucket
  • 仪表盘
  • 数据流
  • 函数
  • API 访问

3 浏览器兼容性

3.1 支持的浏览器

平台目前仅支持 Chrome 和 Firefox。

4 支持的设备

4.1 设备型号

物联网网关负责通过 TCP 或 TLS 进行设备通信。每个独特型号的设备的通信支持和应用不同的协议。物联网网关目前支持以下 ThingsMatrix 许可设备:

平台版本 设备型号 设备描述
1.x TMA01 物流追踪器 (2G,LTE)
TMA11 用于TMA01的可拆卸传感器集线器
TMX06 追踪器 (2G)
TMX07 追踪器 (LTE Cat-M)
TMM01 认证的第三方设备
2.x TMX08 追踪采集器 (Cat-M)
TMF01 广和通物联网模块 (NL668,MT910,等等)
TMY01 追踪器 (2G,Cat-M)
TMY02 追踪器 (2G,Cat-M,NB)
TMX09 追踪器 (2G)
TMY07 追踪器 (2G,Cat-M,NB)
TMY09 追踪器 (2G,Cat-M,NB)
TMY03 追踪器 (2G,Cat-M,NB)
TMY05 追踪器 (2G,Cat-M,NB)
TMX01 追踪器 (2G LTE Cat-M)
TMX02 追踪器 (2G LTE Cat-M)
TMX03 追踪器 (2G)
TMX04 追踪器 (2G LTE Cat-M)
TMX05 追踪器 (2G)
Custom MQTT 协议的第三方设备

5 服务启动

请确保您已经注册了 TMX 账户并且也已订阅 TMX Insight™ 服务。请参阅 控制台 2.6 用户指南 以获取进一步信息。

6 主页

用户成功登录后,将进入 TMX Insight™ 的 主页。您可以在此处查看描述数据活动的统计报表,如下所示:

image-20210326150356838

  • 数据流击中数

    所有数据流执行结果的状态和型号分布饼状图。

  • API 调用数

    在一段时间内(今天或最近 7/30 天)API 调用的数量。

  • Bucket Data Usage

    在一段时间内(今天或最近 7/30 天)bucket 存储条目的数量。

7 Bucket

Bucket 在数据存储上应用了存储策略,并统一了数据格式以简化处理。

image-20210326153724842

7.1 添加新 bucket

点击 + Add Bucket 按钮,Add Bucket 窗口会弹出。

image-20210326153947105

填写表单,然后点击 Add 按钮以创建新 bucket。关于 “存储时间” 字段,您可以定义数据收集的时间范围。例如,如果选择保留 60天,则 bucket 将存储生成的数据达60天。

image-20210326154412520

7.2 编辑 bucket

选择您要编辑的 bucket,点击 Edit 按钮,Edit Bucket 窗口会弹出。

image-20210326154451320

修改完成后,点击 Submit 按钮以保存改动。请注意:“存储时间” 字段无法被修改。

7.3 添加新 bucket 字段

选择一个 bucket,然后进入 字段管理 选项页。平台提供了一个预置的 bucket 字段 time,用以记录数据采集的时间。点击 Add 按钮以添加新的 bucket 字段。您可以输入字段名称、字段标题、字段值类型、字段值单位。您还可以根据需求输入字段值的最大值或最小值,以及字段的描述。如果要创建多个 bucket 字段,点击 Add 按钮以添加更多字段。所有已添加的字段将在下面的字段列表中列出。

image-20210326154639296

7.4 删除 bucket 字段

点击 Delete 按钮以删除一个特定的 bucket 字段。请注意:使用中的 bucket 字段和预置的 bucket 字段无法被删除。

image-20210326154649226

7.5 查看 bucket

它包括三个选项页,如下所示:

  • 字段管理

    它用于管理 bucket 数据字段。

    image-20210326154751304

  • 仪表盘

    它显示了在 仪表盘 中已配置并在 TMX Access™ - 设置 中已启用仪表盘的关于该 bucket 的所有图表。请参阅 8 仪表盘TMX Access™ 服务平台 2.6 用户指南14 设置 以获取进一步信息。

    image-20210326154811681

  • 数据列表

    它显示了 bucket 中配置和存储的所有数据。您可以通过明确设备序列号和选择时间范围以筛选数据。

    image-20210326154826326

    您还可以通过点击右侧 Export 按钮以导出 bucket 数据。Export 窗口会弹出,然后您可以选择以 ExcelCSV 格式导出记录。

    image-20210326154837489

7.6 删除 bucket

选择要删除的 bucket,点击 Delete 按钮以删除 bucket。请注意:使用中的 bucket 无法被删除。

image-20210326154505233

8 仪表盘

平台通过仪表盘提供数据可视化和可视数据的自主配置,以帮助您监视和分析数据。在 仪表盘 中,您可以根据实际需求配置图表,以监视单个设备的实时数据或历史数据变化轨迹。您还可以配置统计图以统计公司中设备的总数及其状态分布。配置图表时,您还可以配置图表显示的时间段并选择刷新间隔以定义其频率。

image-20210326155041536

8.1 添加新仪表盘

在添加新图表之前,您需要创建一个新的仪表盘。点击右上角 + Add Dashboard 按钮,Add Dashboard 窗口将弹出。输入仪表盘名称,然后点击 Add 按钮以添加新的仪表盘。

image-20210326155057539

8.2 查看仪表盘

点击仪表盘卡片以查看仪表盘详情。

image-20210326155156832

可以在仪表盘中设置几个快速配置,如下所示:

image-20210326155447222

请注意:此处的配置修改并不会保存配置到图表中,它仅仅作为图表的快速配置。

  • 通用设置:

    • 时间范围:

      选择数据收集的时间范围。

    • 刷新间隔:

      设置图表刷新频率。

  • 变量设置:

    • 设备组名称栏:

      快速生成特定设备组设备数据的图表。配置新的设备组后,无论它们之前是由哪个设备组配置的,仪表盘中的所有图表都将按特定的设备组进行配置。

    • 序列号栏:

      快速生成特定序列号设备数据的图表。配置新的序列号后,无论它们之前是由哪个序列号配置的,仪表盘中的所有图表都将按特定的序列号进行配置。

    • Bucket 名称栏:

      快速生成特定 bucket 设备数据的图表。配置新的 bucket 后,无论它们之前是由哪个 bucket 配置的,仪表盘中的所有图表都将按特定的 bucket 进行配置。

    • 字段标识符栏:

      快速生成特定数据字段的图表。配置新字段后,无论之前是由哪个字段配置的。仪表盘中的所有图表都将按特定的数据字段进行配置。

平台提供特定仪表盘的 全屏 视图。点击 ... 按钮,然后点击 Full Screen 按钮以进入 全屏 视图。

image-20210326155549168

例子如下所示:

image-20210326155606866

8.3 修改仪表盘

点击 Settings 按钮,您可以进入仪表盘设置页。在此页,您可以重命名仪表盘,并且可以决定在仪表盘详情页显示哪些快速配置的相关信息。

image-20210326155634464

关于 通用设置 的 "Hide Field",如果它处于开启状态,仪表盘详情页的快速配置部分将不会显示。

image-20210326155651424

关于 变量设置 的“设备组”、“序列号”、“bucket” 以及“数据字段”,Query 类表示您可以进行模糊查询,并且所有的选项都不可自定义;Custom 类表示您可以自定义选项;Text box 允许您输入任意值,此处可预先设置默认值。

image-20210326155729932

完成配置后,点击 < 按钮以回到仪表盘详情页。

image-20210326155745378

然后点击 Save Dashboard 按钮以保存改动。

8.4 插入新面板

在仪表盘详情页,通过点击 Add Panel 按钮,所有受支持的面板类型将显示,包括 折线图计量盘表格饼图统计以及地图

image-20210326155824878

image-20210326155838226

让我们以折线图为例。点击 Graph 按钮,即会创建一个空的折线图。

image-20210326155850168

8.5 修改面板

点击面板右上方的 ... 按钮,然后点击 Edit 按钮以进入面板详情页面。

image-20210326155903448

此页面有几个选项页显示相关信息,如下所示:

  • 数据

    数据源配置。

    image-20210326160257696

    请依据以下步骤以配置特定的数据源:

    1. 选择一种数据源类型,例如,Device Telemetry Data

  1. 输入特定设备的序列号。考虑到便捷性,您可以输入至少3个字符以模糊查询。

  2. 选择一个想要的数据字段,例如 Signal Strength

    image-20210326160400167

点击 + Add Data 按钮以添加更多的数据源。

image-20210326160428002

点击 Copy 按钮,将特定数据源的复制配置生成,您可以进行编辑。

image-20210326160437604

您也可以点击 **<u>Hide</u>** 以隐藏特定数据源。*请注意: 隐藏的数据将不会在面板详情页面以及面板视图页面显示。*

image-20210326160448740

点击 **<u>Delete</u>** 按钮以删除数据源。*请注意:如果仅存在一个数据源,它不能被删除。*

image-20210326160502787

  • 可视化

    图表可视化配置。可以自定义数据显示、坐标轴以及图例。

    image-20210326160519617

  • 通用

    通用设置,包括面板名称、数据范围以及刷新频率。

    image-20210326160557441

完成所有设置后,请点击 < 按钮以返回仪表盘详情页面,然后点击 Save Dashboard 按钮以保存所有改动。

image-20210326160611288

为了更舒服的可视化体验,可以通过拖拽面板的边界以修改它的尺寸。

image-20210326160712614

通过拖拽,面板也可以进行位置修改。在面板上空白处悬停鼠标,当光标显示拖拽图标时,您可以重新安排面板位置。

image-20210326160724801

8.6 查看面板

点击面板右上方的 ... 按钮,然后点击 View 按钮,它将进入面板视图页面。

image-20210326160749697

image-20210326160801153

在仪表盘详情页,您可以点击特定面板右上方的 ... 按钮,然后点击 Refresh 按钮以立即刷新数据。

image-20210326160813624

8.7 导入面板

点击面板右上方的 ... 按钮,然后点击 Import 按钮以导入面板。

image-20210326160827489

点击 Browser 按钮以上传 JSON 格式文件,然后点击 Import 按钮以导入面板。

8.8 导出面板

点击面板右上方的 ... 按钮,然后点击 Export 按钮以导出面板。

image-20210326160845344

8.9 删除面板

点击面板右上方的 ... 按钮,然后点击 Delete 按钮以删除面板。

image-20210326160908711

8.10 复制仪表盘

在仪表盘卡片页面,点击仪表盘卡片右上方的 ... 按钮,然后点击 Copy 按钮,将创建原始仪表盘的新副本。

image-20210326160924016

8.11 删除仪表盘

点击仪表盘卡片右上方的 ... 按钮,然后点击 Delete 按钮以删除仪表盘。请注意:仪表盘仅当在 ThingsMatrix Access™ - Settings 中没有被配置时可被删除。

image-20210326160933633

9 数据流

平台提供了一个基于浏览器的编辑器,可基于设备上报数据,轻松创建数据流以获得所需数据。不同型号的数据流之间是独立的。

image-20210326161130463

9.1 添加新数据流

选择一个型号,例如 TMX08,点击 + Add Flow 按钮,新的 Flow 块会出现。输入数据流名称,然后点击 Save 按钮以创建新数据流。

image-20210326161219090

9.2 重命名数据流

点击 ... 按钮然后点击 Edit 按钮,您可以重命名数据流。

image-20210326161305479

9.3 配置数据流组件

可以按如下所示以配置数据流的几个组件:

image-20210326161326160

点击数据流块进入数据流详情页。

  • 数据筛选:选择输入数据。

    您可以选择特定的设备组和 topic(仅限 MQTT 自定义型号)以将对应数据作为数据流输入。请注意:缺省情况下,所有设备的数据都会进入数据流。

    image-20210326161354711

    完成配置后,点击 Save 以保存改动。

  • 数据计算:配置数据流使用的函数。

    您可以选择该数据流所应用的特定函数。请注意:缺省情况下,数据流不应用任何函数。

    image-20210326161457072

    左侧为 公式库,右侧是 数据计算应用的的函数 列表。点击 Select 按钮,您可以从库中选择要在 数据计算 中使用的函数。请注意:您必须先在 数据 - 公式 中配置公式,然后才能从库中选择公式。公式库提供了一些预置公式供您使用。 要从 数据计算 中移除函数应用,请选择函数,然后点击 Delete 按钮。通过点击 Remove All 按钮,所有已选函数将从列表中移除。您也可以在搜索栏中搜索公式。在已选函数上悬停鼠标,当光标显示拖拽图标时,您可以修改执行函数的顺序。编辑 数据计算 后,点击 Save 按钮以保存设置。请参阅 10 函数 以获取进一步信息。一个选择 Ultrasonic Temperature Compensator 函数和 temp_minus 函数的例子如下所示:

    image-20210326162028477

  • 触发操作:决定经数据流处理后数据的操作。

    您可以选择该数据流所触发的特定操作。请注意:缺省情况下,数据流不触发任何操作。

    点击 + Add Action 按钮,一个新的空白的 Action 块会出现。选择一个操作类型然后为其输入名称。然后点击 + Add Condition 按钮以配置想要的触发条件。在右上方选择 Match AnyMatch All 以配置条件判断方式。

    image-20210326162240176

    平台提供若干触发操作类型,如下所示:

    • 事件生成:向 TMX Access™ - 设备事件 生成事件记录,包括事件代号和告警代号。请参阅 TMX Access™ 服务平台 2.6 用户指南12 设备事件 以获取进一步信息。

      平台提供三种事件触发类型,如下所示:

      • 当匹配条件时,每次都触发

        如果当前数据匹配条件,每次都触发设备事件。

        输入事件代号,例如 low_temperature_event,选择事件的级别并为其添加描述。

      • 当一直匹配条件时,仅在第一次触发

        如果一直匹配条件(上一次和这一次都匹配),仅在第一次触发设备事件。

        输入事件代号,例如 high_humidity_event,选择事件的级别并为其添加描述。

      • 当匹配条件状态发生改变时

        如果上一次不匹配条件,但当前匹配条件,或者第一次上报数据,将触发 on event 。并且,如果上一次匹配条件,但当前不匹配条件,将触发 off event

        输入告警代号,例如 low_battery_alarm,选择 on event 的级别并为其添加描述,同时也请选择 off event 的级别并且为其添加描述。

      点击 Save 按钮以保存改动。

      image-20210326162546366

    • Bucket 存储:将处理后数据存储到特定 bucket。请参阅 7 Bucket 以获取进一步信息。

      点击 + Add Data 按钮以在bucket 字段与数据流结果字段映射列表中添加一条配置。以 bucket 中 temperature 字段为例,如下所示:

      image-20210326162754355

      然后点击 Save 按钮以保存所有改动。

    • SMS 推送:向一个特定手机号码发送一条短信消息。

      输入短信消息的收信方电话号码和描述,然后点击 Save 按钮以保存所有改动。若数据匹配条件,目标用户会接收到一条短信,包括可以登录平台以查看短信内容的网址。

      image-20210326163202824

    • URL 推送:向一个特定网址发送处理后数据。

      输入网址,然后点击 Save 按钮以保存所有改动。

      image-20210326163404087

    • Email 推送:向(多个)特定电子邮件地址发送处理后数据。

      输入有效的电子邮件地址,然后点击 Save 按钮以保存所有改动。 请注意:通过按 Enter 键以应用一个电子邮件地址。仅应用的电子邮件地址能收到该邮件。若电子邮箱地址的字体颜色为红色,这表示它是非法的。

      image-20210326163506005

    • 命令下发:向 数据筛选 中的设备下发控制命令。

      选择一个命令类型,然后点击 Save 按钮以保存所有改动。请注意:若参数是必填的,请填写参数。

      image-20210326163722389

  • 调试日志:显示调试消息的记录。

    关于 Debug 开关,如果它处于开启的状态,最新的数据流处理日志会显示。

    image-20210326163739702

    点击 Refresh 按钮以刷新日志。

9.4 插入数据流

点击 ... 按钮然后点击 Insert Flow 按钮以插入新数据流。输入数据流名称,然后点击 Save 按钮,将在下面插入新的数据流。

image-20210326164159191

9.5 运行数据流

当数据流运行时,它将在每次数据输入时进行计算。要运行数据流,您只需将 Flow 开关拨到 Run 位。请注意:运行中的数据流无法被修改。然而,调试开关是仍然可用的。

image-20210326164234391

您还可以通过点击 Run All 按钮以批量运行所有数据流。

image-20210326164253396

9.6 停止数据流

当数据流停止时,它会停止计算。要停止运行中的数据流,您只需将 Flow 开关拨到 Stop 位。请注意:如果想要修改数据流,您需要先将其停止。

image-20210326164304692

您还可以通过点击 Stop All 按钮以批量停止所有的数据流。

image-20210326164316373

9.7 导入数据流

点击 ... 按钮,然后点击 Import 按钮,Import Flow 窗口会弹出。

image-20210326164333333

您就可以在当前数据流的上方(选择 Import Above)或者下方(选择 Import Below)批量导入新的数据流。

点击 Browser 按钮以选择 JSON 文件,然后点击 Import 按钮以导入数据流。

image-20210326164439222

9.8 导出数据流

点击 ... 按钮,然后点击 Export 按钮,将会请求下载一个包含当前数据流信息的 JSON 文件。

image-20210326164451462

您还可以通过点击 Export All 按钮以批量导出所有的数据流。将会请求下载一个包含所有数据流信息的 JSON 文件。

image-20210326164502088

9.9 替换所有数据流

要导入新的数据流并全量替换所有原有的数据流,只需点击 Replace All 按钮。Replace All 窗口会弹出。

image-20210326164511958

点击 Upload File 按钮以选择 JSON 文件,然后点击 Import 按钮以全量替换数据流。

image-20210326164523987

9.10 删除数据流

点击 ... 按钮,然后点击 Delete 按钮以删除数据流。请注意:只有停止的数据流才能被删除。

image-20210326164536564

10 函数

函数是数据流的一个用于计算数据组件。平台在公式库中预置了一些函数,如下所示:

image-20210326165415750

运行中的数据流所应用的函数是被使用中的,相关数据在左上角显示。

image-20210326165628215

10.1 添加新函数

点击 + Add Function 按钮,Add Function 窗口会弹出。

image-20210326165637381

您可以输入函数的标题、填写描述并完成一些代码编写。右侧有参考说明,平台提供了语法解释器,以帮助您编写代码。代码编辑模块内,编程语言是 JavaScript。请注意:您无需编写 return 语句。时间戳的单位是毫秒(13位数),并且合法的时间字符串格式是 “yyyy-MM-dd HH:mm:ss.SSS”。 填写完表单和代码模块后,点击 Add 按钮以创建新函数。温度补偿函数的一个例子如下所示:

image-20210326165919956

10.2 修改函数

点击函数卡片或 Detail 按钮以编辑函数。

image-20210326165951621

修改完成后,点击 Save 按钮以保存改动。请注意:使用中的函数和预置函数无法被编辑。

10.3 复制函数

点击 Copy 按钮,Copy Function 窗口会弹出。根据需求修改完成后,点击 Copy 按钮以复制函数。

image-20210326170009996

10.4 删除函数

点击 Delete 按钮以删除函数。请注意:使用中的函数和预置函数无法被删除。

image-20210326170211555

11 API 访问

平台为外部用户和系统提供北向 API 服务。请参阅 TMX Insight™ 服务平台 2.6 API 指南 以获取更详细的技术信息。请参阅 控制台 2.6 用户指南 - 10 API 应用程序 以获取有关 API 访问控制的进一步信息。

12 通知中心

平台提供通知中心以展示通知和消息,例如,服务升级计划和超频或超限 SMS、URL、Email 的警告。右上角的 Ring 按钮旁若有一个红点,表示通知中心存在数条未读消息。

image-20210325214947134

点击 Ring 按钮,Notification Board 会弹出,它显示所有的通知和消息。您可以通过选择一个想要的通知类型以筛选通知。

image-20210325215005838

点击未读消息以阅读详细内容。请注意:带红点的消息表示未读。

点击 Confirm 按钮以确认接收消息。

image-20210326120700549

Last updated: 2021/5/17 下午3:26:04