TMX Access™ 服务平台 2.0 用户指南

服务平台描述

ThingsMatrix 服务平台采用模块化的设计和部署从而提供 IoT 解决方案。平台主要包含 4 个主要的功能块:物联网网关,资产管理平台,连接管理平台和控制管理中心。每部分功能可以按需进行独立部署。

物联网网关主要负责设备的通信和数据协议的解析。

资产管理平台主要负责设备和连接管理,数据采集,存储和汇总。

连接管理平台负责和运营商平台的集成,从而提供通用的 SIM 卡管理功能,包括 SIM 的状态和连接的管理,以及流量查询。

控制管理中心作为一个核心模块,提供了包括用户管理功能,核心业务的用户界面和接口服务。

基于客户的需求,每一个独立的部署可以有不同的模块和功能的选择。通过这些组件,整个系统提供了以下服务:

  • 用户管理服务
  • 资产管理服务
  • 数据管理服务
  • 连接管理服务

浏览器兼容性

支持的浏览器


ThingsMatrix 服务平台目前仅支持 Chrome and Firefox 。

支持设备

设备型号


物联网网关负责基于 TCP 或者 TLS 的设备通信,不同的设备型号通过指定的通信协议和对应的网关完成数据通信,以下是现有平台版本支持的设备列表:

版本 协议 设备型号 详细描述
1.x 私有协议 TMA01 物流跟踪器
私有协议 TMA11 拆卸式传感器
私有协议 TMX06 2G 网络追踪器
私有协议 TMX07 CatM 网络追踪器
MQTT TMM01 第三方设备
2.x 私有协议 TMX08 CatM 跟踪采集器
私有协议 TMF01 模块跟踪软件
私有协议 TMX09 2G 网络追踪器
私有协议 TMY01 CatM 跟踪采集器
私有协议 TMY02 CatM 跟踪采集器

设备数据字段


网关负责数据通信协议的解析,并将数据转换为 JSON 格式进行内部通信。不同的设备支持不同的数据列表定义在以下表格中:

字段名 字段描述 TMA01 TMA11 TMX06 TMX07 TMX08 TMF01 TMM01 TMX09 TMY01 TMY02
time Timestamp
lat Latitude
lng Longitude
gps GPS String
sn Serial Number
iccid SIM ICCID
imsi SIM IMSI
nmSn Network Module Serial Number
imei Device IMEI
deviceMcu Device CPU Usage (%)
deviceRam Device Memory Usage (%)
nmMcu Network Module CPU Usage (%)
nmRam Network Module Memory Usage (%)
cellId Cell Id
mcc Country Code
mnc Network Code
lac Area Code
singalStrength Cell Signal Strength
speed Speed (km/h)
altitude Altitude (m)
battery Battery (%)
voltage Battery Voltage (V)
ipAddress IP Address
net Mobile Network Type
firmware Device Firmware Version
ssn Sensor Hub Serial Number
temperature Temperature (C)
humidity Humidity (RH)
acceleration Acceleration
door Door Open (0: open/1: close)
gpsSpeed GPS Speed
direction Direction (0-359)
distance Ultrasonic Sensor (mm)
distance_1 Ultrasonic Sensor 1 (mm)
current Current Sensor (A)

控制管理中心

功能描述


控制管理中心为客户提供了一个用户界面,所有功能可以通过用户界面进行操作和管理,管理员可以对用户,设备和连接进行管理,控制管理中心还对外部提供应用程序接口服务。

在控制中心的用户界面上,所有功能可以划分为以下 4 类:

  • 用户管理服务
  • 资产管理服务
  • 数据管理服务
  • 连接管理服务

主界面


主界面包含三块:主菜单栏,顶部菜单栏和功能管理页面

每一项服务会在以下单独章节分别描述。

用户管理服务

服务平台为每个公司提供了一套用户管理机制。管理员可以在组织架构页面进行用户的创建和管理。基于用户信息,平台对静态配置数据采用了基于角色的访问控制,对设备采集数据采用了基于用户的访问控制。

基于角色的访问控制


整个平台内部,基于现在版本,定义了以下两个缺省用户角色。缺省角色不可修改:

  • 管理员
  • 普通用户

管理员具有访问整个公司内所有对象配置信息的权限,比如新建或者删除设备。普通用户允许查看所有主设备和传感器列表。同时,公司管理员有权配置角色。根据业务需求,管理员可以新增角色,为其赋予操作权限,并指定到相应的用户。

用户访问控制


缺省情况,普通用户可以查看基础设备信息,但是不被允许查看设备数据。设备数据的查看权限由设备所在的组进行控制。只有被允许的用户才具备的设备数据查看权限。管理员自动拥有设备数据的查看权限。

公司注册及部署


每一个期望使用平台服务的客户,需要提供以下信息来完成公司的注册和部署:

  • 公司名称
  • 公司唯一代码(用于建立域名访问 URL)
  • 公司主联系人邮箱(唯一)
  • 公司邮箱域名地址(一个或者多个,缺省位主联系人邮箱域名)
  • 选择服务

一旦申请通过并签订服务合同,ThingsMatrix 负责在接受到以上信息之后创建公司,并提供客户的登入域名和发送管理员邀请邮件。

用户注册


在公司创建过程中,第一个邀请登入的用户为管理员用户。用户信息包含用户名,姓名,邮箱,电话,地址信息。

平台通过三种方式添加普通用户:

  • 管理员直接提供所有信息完成添加,临时密码通过邮件分享
  • 管理员发送邀请,用户接受邀请并完成注册
  • 用户通过登入界面发送邀请完成注册

用户注册为普通用户之后,可以完成登入。管理员可以提升用户角色为管理员。用户可以在个人账户中心修改密码,管理员也可以在管理界面重置用户密码。用户也可以在个人账户中心生成 API 密钥。

常用操作


公司创建之后,每个公司具有一个唯一的域名用来访问平台。用户需要提供用户名和密码来登入。

普通用户可以通过邮箱来启动注册流程。邮箱地址必须为有效的可以正常接收邮件的地址。邮箱地址的域名必须符合公司下的域名配置信息。

用户接受到邀请邮件之后,他能够使用邀请码来完成整个注册流程。

管理员可以通过组织架构页面访问用户列表,并新建用户。

管理员如果没有用户的所有信息来直接添加用户,他也可以发起用户邀请。

资产管理服务

功能描述


该服务提供了所有设备的管理功能,通常设备可以分为主设备和传感器。主设备包含主控制器,无线通信模块,定位模块以及整合在一起的传感器数据。传感器则为外部独立器件,可以附着在主设备之后,不带有独立通信功能,但是具备独立的序列号。在平台上,所有资产管理功能分别在两个子菜单上,设备管理菜单和主设备列表。用户可以查看所有主设备和传感器的配置信息,管理员可以对设备进行管理,并创建设备组和配置模版。

设备管理主要负责设备型号,设备组已经设备配置的分类和管理。主设备列表是所有主设备和传感器的展示,也提供对于主设备和传感器的快捷操作,方便操作员进行操作和查询。

常用操作流程


配置模版是每个设备型号的唯一配置文件,用于定义主设备或传感器的配置,版本和规则。在设备管理菜单下选择一个设备型号,点击模版面板下的"新建模版"按钮,成功填写必要字段则可添加配置模版。

新建或修改配置模版

在设备注册鉴权过程中,设备的配置文件会下载到物联网网关,并最终下发到设备侧。缺省当设备组未配置配置模版时,设备会采用本身缺省的配置。

设备组是一个包含一组相同类型设备的逻辑对象,用户可以通过它配置设备的一些共同属性。

新建或修改设备组

设备组包含一些必选的属性,包含组名称,组内设备型号和描述。

如需更改主设备或传感器的配置模版,这个操作必须在设备组上进行操作。管理员需进入"设备管理"菜单,选择该主设备或传感器所在的组,点击组的"修改"按钮,在组的设置面板中通过下拉菜单选择型号匹配的配置模版。如果配置模版发生变化,则该配置将应用于组内的所有主设备或传感器。若当前没有对应型号的配置模版,则可到设备型号面板下进行添加配置模版。

设备管理作为整个服务平台的一个主要功能,在客户收到设备之后,客户需要按照设备序列号将设备添加到指定的设备组内。在这个添加过程中,客户除了添加设备序列号,还可以指定与设备相关联的移动卡号和已经相关连的传感器序列号。客户可以在这些选项上留空,这意味的设备上报时候,可以按照设备上报的信息自动完成这些信息的捕获。当然,客户可以选择是否允许在设备再次注册时候,自动修改这些信息。如果一旦平台发现该信息发生变化,同时系统不允许自动更新,那么设备注册会发生报错。另外,客户可以根据自身需要来填写设备描述,设备标签以及自定义的设备属性。

新建或修改设备

每一个认证的设备类型会有一个全局唯一的序列号,但是序列号长度根据设备类型会有一些变化。

导入/导出设备或者传感器


TMX平台提供批量导入设备功能,支持导入Excel格式和CSV格式的表格,表格填写说明如下:

例子

SerialNumber Group Model Description Sim ICCID SensorSN Tags Attribute.Adress
861901268000009 TMX07_G2 TMX07 60s 89860437111890028017 661808008000092 San Antonio,Atlanta San Antonio,Atlanta
801046031116490 tmx08_0708 TMX08 Good 898607b2111730537722 661808008000093 302 San Antonio,Atlanta
801046031094416 tmx08_0708 TMX08 Good device 89011703278173974331 661808008000094 301

完成说明

<1>序列号,设备组,型号是必填字段,其他是可选字段;
<2>序列号:设备/传感器的唯一标识符。必须是 8-16 位字符,包括数字 0-9 和字母 A-Z;
<3>设备组:设备所属的组。组必须首先存在于系统中,并与模型具有对应关系;如果它不在系统中,请先将其添加到系统中;
<4>型号:设备型号;
<5>Sim ICCID:必须是 20 位数;
<6>传感器序列号:必须是 8-16 位字符,包括数字 0-9 和字母 A-Z;
<7>描述:字数必须为 0-200;
<8>标签:必须为 1-50 个字符,包括数字 0-9,字母 a-z 和 A-Z,字符 “-”,“.”,“_”,“@”,“$”和空格。设备的标签数量不超过20个,标签用“,”分隔;
<9>属性:属性由标题填充,例如“attribute:xx”,这意味着添加名称为xx的属性。必须是 1-50 个字符,包括数字 0-9,字母 a-z 和 A-Z,字符“-”,“.”,“_”,“@”,“$”和空格。

设备数据查看功能


在设备列表上,当用户单击以选择单个设备时,设备遥测数据将显示在页面底部。状态选项卡显示设备最新报告的数据。用户还可以查看每个设备的警报或事件。

管理员可自定义设备标签或参数,并设置为表头。

Device 或 Sensor 动态数据查看权限设置。可在 Group 面板中的"Share Data to"条目进行配置。配置后,该 Group 内选中的用户可通过界面或者接口查看组内的动态数据。

数据管理服务

功能描述


服务平台具备了数据分析和展示功能。一旦客户选择了数据存储服务,历史数据和统计数据会有相应的展示。

同时,平台也提供了策略和通道,从而进一步实现的数据监控和数据安全;以及仪表板和公式流功能,用于数据可视化自定义和数据的自定义配置。

历史统计数据


在每个设备和传感器的数据页面上,平台展现了设备历史记录和统计数据。

数据 仪表板


TMX平台可通过仪表板提供数据可视化和可视数据的自主配置,以帮助用户监视和分析数据信息。 在仪表板导航菜单中,用户可以根据实际需要配置图表,以监视单个设备的实时数据或历史数据更改轨迹。 用户还可以配置图表以统计公司中设备的总数及其状态分布。 用户配置统计图时,可以配置统计图显示的时间段,也可以选择“自动刷新”来定义统计图的数据内容。

仪表板当前提供可配置的图表类型,包括折线图,直方图,饼图,仪表板等,用户可根据实际需求选择图表展示数据。

数据 转换器


TMX平台提供了基于浏览器的编辑器,可轻松地从转换器面板创建公式流以生成所需的数据。

用户在转换器面板中添加一个公式节点,然后在公式里填充或编辑JavaScript函数。正确创建JavaScript函数后公式流即会生效。

编码参考

转换器代码采用Javascript。你可以通过输入参数访问设备静态配置,设备属性或者设备动态数据。

例如:

device.sn, device.group

device.attributes.zipcode

payload.distance , payload.temperature

你不需要定义返回命令,所有输出参数直接由全局变量定义并和输出列表相对应。任何错误或者异常会导致输出为空值。

代码样例,输出值为 temperature_f :

var temperature_f = payload.temperature

if (device.attributes.country === 'US') {

  temperature_f = payload.temperature * 9 / 5 + 32;

}

输出

输出数据是由公式流生成的新数据。新生成的输出数据可以在设备列表页面的额外数据面板中看到。

原始数据

设备出厂时的缺省数据。

输出数据

输出数据是由公式流生成的新数据。

数据策略


首先,在该版本,我们要区分设备侧的规则策略和平台侧的策略。设备侧的数据监控策略是通过设备配置文件来实现,在设备的配置模版中通过各个参数的调整来完成, 注意不是所有的设备类型都支持设备侧的数据监控。如果设备发现告警,设备会通过告警消息自动通知平台。另一方面,平台侧的数据监控是由平台侧的策略配置来实现。两者的配置格式不完全一致,而且告警消息也是相互独立的。

在完成策略添加和配置之后,管理员可以把策略添加到指定相同类型的设备组之下,同一个个设备组可以同时挂载多个策略,相互之间是独立的。

现有版本下,平台侧的数据监控策略分为两个类型:基础策略和地址围栏策略。地址围栏通过指定的地图中心点和半径来限定围栏范围,一旦上报的数据有触发进出围栏事件,则会触发相应的告警信息。该策略适用于设备组内设备位置相对集中的情况。基础策略可以针对某项数据值进行高低门限的判定,一旦有越界行为发生,则触发告警事件。

数据通道


在现有版本,数据通道是一个逻辑对象用来控制数据分享。管理员可以根据设备类型所定义的数据字段,进行数据项的黑白名单控制。数据通道挂载在指定的设备组下,同一个设备组可以同时有多个数据通道,这些通道可以有不同的用途并且过滤不同的数据。通过设备和设备组,用户可以访问设备的原始数据,但是通过通道,用户只能访问过滤之后的数据。

连接管理服务

功能描述


连接管理服务用于管理运营商发行的移动卡。平台将卡分为两类,一类为客户自行管理的 SIM 卡,另外一类为 ThingsMatrix 提供的 SIM 卡。

对于客户自行管理的 SIM 卡,该服务仅提供库存管理功能。对于 ThingsMatrix 提供的 SIM 卡,平台和合作运营商的服务对接,提供 SIM 卡的状态管理,流量统计信息和实时连接信息。并提供公司级别的汇总信息。在现在的版本,ThingsMatrix 仅提供 AT&T 的 SIM 卡。

常用操作


导入 SIM 卡

为了导入 SIM 卡,管理员需要收集 SIM 卡的 ICCID 和 IMSI 信息

设置

功能描述


用户在设置面板中可选择合适的语言、时区、数据统计单位、地图显示类型。也可点击恢复缺省按钮回到初始状态。管理员可预设一个通用的公司设置模板,应用于全公司。

应用程序接口服务

控制中心为外部用户和程序提供一组应用程序接口服务,关于详细信息,请参考 ThingsMatrix 服务平台 API 文档。

Last updated: 2021/4/23 下午5:34:46