Commit 8740e863d057f68d5ffdb626d3e60ed3c7365fd7

Authored by 刘琴
1 parent 4068adab

增加dataTag数据长度约定,修改日志上传事件参数内容

通讯协议-B200W-MQTT协议[内部].md
... ... @@ -52,6 +52,24 @@
52 52 |sEvtXXX|系统事件 |自动返回|
53 53 |fEvtXXX|指令事件 |调用对应指令后返回|
54 54  
  55 +## 数据格式约定
  56 +- 数据格式统一为**Json**格式,MQTT发送接收消息编码统一为**UTF-8**
  57 +- Json通用格式如下:
  58 +```json
  59 + {
  60 + "fun":"xxx",
  61 + "dataTag":"xxx",
  62 + "data":{
  63 + //内容
  64 + }
  65 + }
  66 +```
  67 +|参数 |说明 |约束|
  68 +|---|---|---|
  69 +|fun| 指令或事件名称||
  70 +|dataTag| 数据标签,用于对应收发数据|长度不超过4,可为0-9a-zA-Z的组合|
  71 +|data| 数据内容|对象或者数组,可为空|
  72 +
55 73 ## 功能速查一览表
56 74 ### 基站管理
57 75 |功能归类|功能|API指令|指令/系统事件|
... ... @@ -135,7 +153,7 @@
135 153 |参数名|类型|限制|非空|说明|
136 154 |-----|-----|-----|-----|-----|
137 155 |fun|string|-|是|事件类型|
138   -|dataTag|string|-|否|数据包标识,不需要时可传空字符串|
  156 +|dataTag|string||否|数据包标识,不需要时可传空字符串|
139 157 |data|object|-|是|传送参数的对象|
140 158 |+baseModel|int||否|基站的型号码|
141 159 |+modelName|string||否|基站的型号名称|
... ... @@ -1132,8 +1150,7 @@
1132 1150 |fun|string|-|是|指令名称|
1133 1151 |dataTag|string|-|否|数据包标识,可为空字符串|
1134 1152 |data|object|-|是|传送参数的对象|
1135   -|+total|int||是|总共多少包|
1136   -|+current|int||是|当前第几包|
  1153 +|+index|int||是|数据包序号,从1开始,传0代表日志已传完|
1137 1154 |+info|string||是|日志内容|
1138 1155  
1139 1156 - **示例代码**
... ... @@ -1142,8 +1159,7 @@
1142 1159 "fun":"fEvtBsLogInfo",
1143 1160 "dataTag":"1",
1144 1161 "data":{
1145   - "total":10,
1146   - "current":1,
  1162 + "index":1,
1147 1163 "info":"XXXXXXXXXXXXX"
1148 1164 }
1149 1165 }
... ...
通讯协议-B200W-MQTT协议[外].md
... ... @@ -46,6 +46,25 @@
46 46 |sEvtXXX|系统事件 |自动返回|
47 47 |fEvtXXX|指令事件 |调用对应指令后返回|
48 48  
  49 +## 数据格式约定
  50 +- 数据格式统一为**Json**格式,MQTT发送接收消息编码统一为**UTF-8**
  51 +- Json通用格式如下:
  52 +```json
  53 + {
  54 + "fun":"xxx",
  55 + "dataTag":"xxx",
  56 + "data":{
  57 + //内容
  58 + }
  59 + }
  60 +```
  61 +|参数 |说明 |约束|
  62 +|---|---|---|
  63 +|fun| 指令或事件名称||
  64 +|dataTag| 数据标签,用于对应收发数据|长度不超过4,可为0-9a-zA-Z的组合|
  65 +|data| 数据内容|对象或者数组,可为空|
  66 +
  67 +
49 68 ## 功能速查一览表
50 69 ### 基站管理
51 70 |功能归类|功能|API指令|指令/系统事件|
... ...