1. Aprus 报文规范
1.1. 概述
1.1.1. 文档说明
报文分上行报文和下行报文，上行报文为APRUS->MixIOT，下行报文为MixIOT->APRUS。上下行报文格式为Json，即{"KEY":"VALUE","KEY":"VALUE",…}；上行报文主题和QoS要明确；所有上行报文和下行报文交互的前提为APRUS成功连接MixIOT服务器。
文档中会对每个报文做详细解释，包括r、n、i、d报文，r报文APRUS采集对象的数据及相关信息，不同的r报文上报规律不同；n报文APRUS固有属性，自身信息，一定存在且按一定规律上报；i报文是数据终端在冷启动、热启动、复位需要上报的报文；d报文是采集终端的诊断信息，当每次收到diagnose指令之后，采集终端会对自身进行自我检测，检测之后把检测结果上报；e报文是采集终端异常检测程序检测到的确定的异常。
目的为指导开发者规范上行与下行报文，明确规定物联网数据在APRUS MixIOT的交互过程；为使用者提供异常排查信息。
1.1.2. 适用对象
本文档的目的读者是MixIOT体系的所有人员。
1.1.3. 术语和缩略词
| 序号 | 术语名称 | 其它名称 | 术语说明 |
|---|---|---|---|
| 1 | MixIOT | Mixlinker Internet Of Things | 深圳市智物联网络有限公司物联网系统 |
| 2 | API | Application Programming Interface | 应用编程接口 |
| 3 | GARDS | Generic Asynchronous Remote Data Service | 通用异步远程数据服务 |
| 4 | MQTT | Message Queuing Telemetry Transport Protocol | 消息队列遥感传输协议 |
| 5 | JSON | JavaScript Object Notation | JS 对象标记 |
| 6 | APRUS | Advanced Programmable Remote Utility Server | 高级可编程远程数据适配终端 |
| 7 | APIECO | Advanced Programmable Industrial Edge Controller | 高级可编程工业边缘控制器 |
1.1.4. 参考资料
[1].《MIX.IOT.2012.C.11.11-Connecting to GARDS》
1.2. 报文介绍
1.2.1. r报文
r报文的内容包括两部分。
1.数据终端采集的，被采集对象的数据或相关文本信息，如状态、事件、故障、报警、设定，报文规则如：
- STA(状态)类数据，按固定周期(5s，10s，15s，20s，30s，60s，300s);
- EVENT(事件)类数据，采集到事件发生时；
- FLT(故障)类数据，当采集到故障发生时；
- ALT(报警)类数据，当采集到报警发生时；
- SET(设定)类数据，当数据采集终端初始化时，以及设定值变化时。
1.2.1.1. DATA
设备数据，数据包括状态(STA)、报警(ALT)、故障(FLT)、事件(EVENT附加报文)、设备运行状态(Z)。
格式:
{"Lx_x_x":value,"Ex_x_x":value,"Z":value}
举例:
{"L1_3_0":123.20,"E1_3_6":0,"Z":1}
说明:
2.数据采集终端自身的状态数据，如信号强度、位置信息、L99、升级、数据采集终端运行状态。
1.2.1.2. CSQ
数据采集终端信号强度，数据采集终端信号强度范围为0~31，可以划分5个等级1~4，等级1为信号最差，等级4为信号最强。
| 等级 | 信号强度 | 说明 |
|---|---|---|
| 1 | 0-10 | 无法联网 |
| 2 | 11-15 | 网络不稳定，掉网率高 |
| 3 | 15-24 | 网络稳定，掉网率低 |
| 4 | 25-31 | 网络稳定，不会掉网 |
格式:
{"csq":value}
举例:
{"csq":25}
说明:
1.2.1.3. GPS & BASE
位置信息包括GPS定位信息及基站定位信息，GPS定位信息为主要位置信息，基站定位信息为辅助位置信息，GPS无法定位是通过基站定位进行辅助定位，基站定位位置不准。
格式:
{"gps":"value"}
{"base":"value"}
举例:
{"gps":"22.57970,113.92177"}
{"base":"2866,1089"}
说明:
1.2.1.4. L99
每小时与每天KEY，给统计程序触发，L99_1为每个整点一刻上报一次；L99_24为每天的零点一刻上报一次，上报的数据关注KEY无需关注VALUE。
格式:
{"L99_1":hour}
{"L99_24":0}
举例:
{"L99_1":3}
{"L99_24":0}
说明:
1.2.1.5. Upgrade
升级进度报文，远程升级时显示升级进度，如果升级失败显示失败详情；明确当前升级情况。
格式:
{"upgrade":"value","download":"value"}`
举例:
{"upgrade":"remosu","download":"10%"}
说明:
1.2.1.6. MCSTA
智物联采集器状态，采集器自身运行状态检测，自身运行状态正常每隔1小时上报一次value为run报文，自身运行状态不正常每隔1个小时上报value为error报文同时上报一次异常报文(i)。
格式:
{"mcsta":"value"}
举例:
{"mcsta":"run"}
说明:
1.2.2. n报文
n报文是数据终端自身的信息，如数据采集终端标识、硬件版本号、MCU版本号、通讯模块版本号、LUA脚本版本号、位置信息、SIM卡标识等。n报文的上报规则为是数据采集终端上电初始化一定上报或者按照固定周期上报，固定周期上报规则为当LUA版本号为V0时每隔2分钟上报一次，目的为时数据采集终端自动更新脚本为客户所需最新脚本；当LUA版本号为非V0时，说明数据采集终端中已经存在有脚本，每隔4小时上报一次，目的为说明数据采集终端正常运行及触发更新最新LUA脚本。
1.2.2.1. DEV
采集终端标识，数据采集终端对接的设备(对象)，根据客户的实际使用的设备设定，最好是控制器类型加型号，如西门子S7-200为SIMENSS7-200，采集终端标识为客户填写，应在脚本端开放接口。
格式:
{"dev":"value"}
举例:
{"dev":"SIMENSS7-200"}
说明:
1.2.2.2. ICCID
SIM卡标识，SIM卡的ID，每张SIM卡有唯一的标识，此标识可以查看SIM卡的状态，SIM卡的流量等等关于SIM卡的信息，如何数据采集终端出现掉网首先应查看SIM卡的状态。
格式:
{"iccid":"value"}
举例:
{"iccid":"898602B5191650139849"}
说明:
1.2.2.3. GPS & BASE
位置信息包括GPS定位信息及基站定位信息，GPS定位信息为主要位置信息，基站定位信息为辅助位置信息，GPS无法定位是通过基站定位进行辅助定位，基站定位位置不准。
格式:
{"gps":"value"}
{"base":"value"}
举例:
{"gps":"22.57970,113.92177"}
{"base":"2866,1089"}
说明:
1.2.2.4. VER
版本信息，版本信息包括硬件版本信息，MCU版本信息，通讯模块版本信息，LUA脚本版本信息。LUA、MCU、REMOSU版本号规则如下：
格式:
举例:
{"LUA":"MA4207.L.V221.R","MCU":"MA4207.M.V225.R","HW":"MB:A2-026161724 CB:A2-08xx21709"}
说明:
1.2.3. i报文
i报文是数据终端在冷启动、热启动、复位需要上报的报文，此报文内容为数据终端启动检测结果报文，只有结果没有其他。
单元模块：
检测结果：DiagnosisPassed/DiagnosisFailed/DiagnosisUnkown
上报格式为：
{"HW":"DiagnosisPassed","LUA":"DiagnosisPassed","MCU":"DiagnosisFailed","SYS":"DiagnosisFailed","COLL":"DiagnosisFailed","GPS":"DiagnosisPassed"}
说明:
1.2.4. e报文
采集终端异常检测程序检测到的确定的异常，由于会出现断网异常无法上报的情况，因此区分运行异常(RUN)与重连异常(RECONN)，运行异常为联网运行过程中产生的异常，重连异常为在断网时产生的异常，如断开服务器了报文此时无法上报，保存报文在重新成功连接服务器之后将此报文上报。
状态分类：CONN(出现异常时网络正常)，RECONN(出现异常时网络断开)。
异常模块：
上报格式：
{"Sta":"value","Uint":"value","Err":"value"}
说明:
表1
表2
1.2.5. d报文
采集终端的诊断信息，当每次收到diagnose指令之后，采集终端会对自身进行自我检测，检测之后把检测结果上报，如果检测完全通过(采集终端无异常)则只有检测结果信息，如果检测不通过(采集终端有异常)则上报检测结果，同时附加异常模块的调试信息。
单元模块：
检测结果：DiagnosisPassed/DiagnosisFailed/DiagnosisUnkown
上报格式：
{"Uint":"MCU","Result":"DiagnosisFailed","Info":"lua task stk over"}
{"Uint":"HW","Result":"DiagnosisUnkown"}
{"Uint":"SYS","Result":" DiagnosisPassed ","Info":"Remosu task stop"}
说明：
1.2.6. p2p收文
p2p收文是数据采集终端从MixIOT可能收到的消息，对这些消息进行解析，并执行相应的动作。
收文的格式统一为:{"Act":"value","Key":"value"}，Act是动作类型；而{"Key":"value"}为动作的相关参数。在MIXLINKER物联网体系中，有且仅有如下类型：
1.2.6.1. Reboot
数据采集终端重启，通过下发次指令可以让数据采集终端进行一次重新复位。
指令:
{"Act":"Reboot"}
1.2.6.2. Upgrade
数据终端升级，通过此指令可是更新数据终端的软件，尤其在对LUA脚本进行更新时。
指令：
{"Act":"Upgrade","Unit":"MCU","IP":"1.2.3.4","Port":21,"User":"user","Pwd":"userpwd","Path":"/Mcu_Test/","File":"MA4207.M.V224.R.bin"}
1.2.6.3. AXUpgrade
数据终端新升级接口，通过此指令可是更新数据终端的软件，尤其在对LUA脚本进行更新时。
{"Act":"AXUpgrade","Unit":"Packet","URL":"ftp://1.2.3.4/MCU/AX/AX-010318.bin","User":"user","Pwd":"userpwd"}
1.2.6.4. Control
反向操作数据采集终端连接的设备，包括控制设备与设定设备的数据；数据采集终端收到报文之后，只需要按规则去执行，无需做任何其他响应，也无需上报执行结果。
指令:
{"Act":"Control","Key":"Value"}
举例:
{"Act":"Control","L1_2_345":"100"}
说明:
1.2.6.5. Diag
数据采集终端自检启动，通过下发次指令适配器采集终端对自身自身进行一次自检，将自检结果上报通知。
指令:
{"Act":"Diag"}
