李外 / Protocol

Commit 2d3a4d686880c9d16f094429fb4f120ee795ee58

Authored by 孙向锦
1 parent 39607dee

海亮定制

Inline Side-by-side
Showing 1 changed file with 23 additions and 60 deletions
海亮定制.md
  View file @2d3a4d6
... ... @@ -178,7 +178,7 @@ ${clinetId} clinetId 是基站编号，为替换字符串。
178 178  
179 179 | 主题 | /client/${client}/operate | 备注 |
180 180 | --- | --- | --- |
181   -|``` { "i": 19, "t": 1634802943} ```:|:| t 当前时间轴 秒 |
  181 +||``` { "i": 19, "t": 1634802943} ```| t 当前时间轴 秒 |
182 182  
183 183  
184 184 ### 基站管理
... ... @@ -190,7 +190,7 @@ ${clinetId} clinetId 是基站编号，为替换字符串。
190 190  
191 191 | 主题 | /client/${clientId}/online | 备注 |
192 192 | --- | --- | --- |
193   -| { "i": 40} | 基站上线 |
  193 +| |``` { "i": 40} ``` | 基站上线 |
194 194  
195 195  
196 196 #### 基站下线
... ... @@ -199,7 +199,7 @@ ${clinetId} clinetId 是基站编号，为替换字符串。
199 199  
200 200 | 主题 | /client/${clientId}/offline | 备注 |
201 201 | --- | --- | --- |
202   -| { "i": 41} | 基站下线 |
  202 +| |``` { "i": 41} ``` | 基站下线 |
203 203  
204 204  
205 205 #### 基站信息设置与读取
... ... @@ -208,8 +208,7 @@ ${clinetId} clinetId 是基站编号，为替换字符串。
208 208  
209 209 | 主题 | /client/${client}/operate | 备注 |
210 210 | --- | --- | --- |
211   -| { "i": 20, "m": { "f": 0, "ap": 0, "rssi": 0, "khs": "on", "mm": 1, "pm": 0, "arti": 30, "mqtt\_ip": "edunew.sunvotecloud.cn", "mqtt\_port": 8443, "mqtt\_username": "admin", "mqtt\_password": "1223456789", "heartbeat":0, "keypad\_af":0, "keypad\_ap":0 }} | f 基站频点ap 考勤功率 rssi 答题器考勤的RSSI阈值 khs 键盘心跳开关 mm 基站配对模式arti 考勤上报时间间隔 pm 键盘关机模式 mqtt\_ip:连接服务器的IP(只能是IP，不能是域名) mqtt\_port：连接mqtt服务器的端口 mqtt\_username: 连接mqtt服务器的用户名 Mqtt\_password:连接mqtt服务器的密码 heartbeat: 心跳 0 关闭 1 开启 Keypad\_af:考勤频率（0-3） keypad\_ap:考勤功率（0-5）注意：如果没有该字段则不设置该值，保持原值下发对有需要修改的值设置完成后，基站信息会自动上报一次
212   - |
  211 +| |``` { "i": 20, "m": { "f": 0, "ap": 0, "rssi": 0, "khs": "on", "mm": 1, "pm": 0, "arti": 30, "mqtt\_ip": "edunew.sunvotecloud.cn", "mqtt\_port": 8443, "mqtt\_username": "admin", "mqtt\_password": "1223456789", "heartbeat":0, "keypad\_af":0, "keypad\_ap":0 }} ``` | f 基站频点ap 考勤功率 rssi 答题器考勤的RSSI阈值 khs 键盘心跳开关 mm 基站配对模式arti 考勤上报时间间隔 pm 键盘关机模式 mqtt\_ip:连接服务器的IP(只能是IP，不能是域名) mqtt\_port：连接mqtt服务器的端口 mqtt\_username: 连接mqtt服务器的用户名 Mqtt\_password:连接mqtt服务器的密码 heartbeat: 心跳 0 关闭 1 开启 Keypad\_af:考勤频率（0-3） keypad\_ap:考勤功率（0-5）注意：如果没有该字段则不设置该值，保持原值下发对有需要修改的值设置完成后，基站信息会自动上报一次 |
213 212  
214 213  
215 214 #### 基站信息上报
... ... @@ -218,10 +217,7 @@ ${clinetId} clinetId 是基站编号，为替换字符串。
218 217  
219 218 | 主题 | /client/${client}/report | 备注 |
220 219 | --- | --- | --- |
221   -| { "i": 21,"cId":"2024010282" "m": { "f": 1, "ap": 1, "rssi": 1, "khs": "off", "mc": "AFCEABCD", "mm": 4, "sn": "32121234", "arti": 30, "pm": 1, "cm": "1.0.0", "cv": "1.0.0", "mqtt\_ip": "edunew.sunvotecloud.cn", "mqtt\_port": 8443, "mqtt\_username": "admin", "mqtt\_password": "1223456789", "heartbeat":0, "keypad\_af":0, "keypad\_ap":0
222   -
223   - }} | f 基站频点ap 考勤功率 rssi 答题器考勤的RSSI阈值 khs 键盘心跳开关 mc 基站配对码 mm 基站配对模式arti 考勤上报时间间隔 sn 基站sn号 cm 客户端设备型号 cv 客户端设备版本 pm 键盘关机模式读取时，会全部返回值 mqtt\_ip:连接服务器的IP mqtt\_port：连接mqtt服务器的端口 mqtt\_username: 连接mqtt服务器的用户名 Mqtt\_password:连接mqtt服务器的密码 heartbeat: 心跳 0 关闭 1 开启 Keypad\_af:考勤频率（0-3 0关闭） keypad\_ap:考勤功率（0-5） cId 基站编号
224   - |
  220 +| |{``` "i": 21,"cId":"2024010282" "m": { "f": 1, "ap": 1, "rssi": 1, "khs": "off", "mc": "AFCEABCD", "mm": 4, "sn": "32121234", "arti": 30, "pm": 1, "cm": "1.0.0", "cv": "1.0.0", "mqtt\_ip": "edunew.sunvotecloud.cn", "mqtt\_port": 8443, "mqtt\_username": "admin", "mqtt\_password": "1223456789", "heartbeat":0, "keypad\_af":0, "keypad\_ap":0 }} ```| f 基站频点ap 考勤功率 rssi 答题器考勤的RSSI阈值 khs 键盘心跳开关 mc 基站配对码 mm 基站配对模式arti 考勤上报时间间隔 sn 基站sn号 cm 客户端设备型号 cv 客户端设备版本 pm 键盘关机模式读取时，会全部返回值 mqtt\_ip:连接服务器的IP mqtt\_port：连接mqtt服务器的端口 mqtt\_username: 连接mqtt服务器的用户名 Mqtt\_password:连接mqtt服务器的密码 heartbeat: 心跳 0 关闭 1 开启 Keypad\_af:考勤频率（0-3 0关闭） keypad\_ap:考勤功率（0-5） cId 基站编号 |
225 221  
226 222  
227 223 #### 基站错误信息上报
... ... @@ -230,7 +226,7 @@ ${clinetId} clinetId 是基站编号，为替换字符串。
230 226  
231 227 | 主题 | /client/${client}/error | 备注 |
232 228 | --- | --- | --- |
233   -| { "i": 22, "m": { "et": 1, "em": "3" }} | et 错误类型 et = 1 ：基站频点冲突 em 错误消息 em=3 ：3号频点示例 基站频点3冲突 |
  229 +| |``` { "i": 22, "m": { "et": 1, "em": "3" }} ```| et 错误类型 et = 1 ：基站频点冲突 em 错误消息 em=3 ：3号频点示例 基站频点3冲突 |
234 230  
235 231  
236 232 ### 键盘管理
... ... @@ -242,7 +238,7 @@ ${clinetId} clinetId 是基站编号，为替换字符串。
242 238  
243 239 | 主题 | /client/${clientId}/card/online | 备注 |
244 240 | --- | --- | --- |
245   -| { "i":14, "m":[{ "c":"12345", "el":0.75, "t":1626016299 }]} | i = 14 键盘上线 el 电量信息答题器编号和上线时间及电量信息 |
  241 +| |``` { "i":14, "m":[{ "c":"12345", "el":0.75, "t":1626016299 }]} ``` | i = 14 键盘上线 el 电量信息答题器编号和上线时间及电量信息 |
246 242  
247 243  
248 244 #### 键盘下线
... ... @@ -251,42 +247,14 @@ ${clinetId} clinetId 是基站编号，为替换字符串。
251 247  
252 248 | 主题 | /client/${clientId}/card/offline | 备注 |
253 249 | --- | --- | --- |
254   -| { "i":15, "m":[{ "c":"12345", "t":1626016299 }]} | i = 15 键盘下线
255   -答题器编号和下线时间 |
  250 +| |``` { "i":15, "m":[{ "c":"12345", "t":1626016299 }]} ```| i = 15 键盘下线<br>答题器编号和下线时间 |
256 251  
257 252  
258 253 #### 键盘在线检测
259 254  
260 255 | 主题 | /lesson/class/${clinetId}/receive | 备注 |
261 256 | --- | --- | --- |
262   -| { "i":16} | i = 16应用主动通知键盘发送在线键盘信息。键盘上线参考"键盘上线3.3.3.1" |
263   -
264   -
265   -#### 键盘遥控指令
266   -
267   -应用程序发送给基站
268   -
269   -| 主题 | /lesson/class/${clinetId}/receive | 备注 |
270   -| --- | --- | --- |
271   -| { "i":52, "m"{ "cmd":"shutdown" }} | i = 52通知遥控指令 Cmd 不超过16个字符 Cmd = "shutdown"遥控关机Cmd="reset" 遥控重启 |
272   -
273   -
274   -#### 开启白名单
275   -
276   -应用程序发送给基站
277   -
278   -| 主题 | /lesson/class/${clinetId}/receive | 备注 |
279   -| --- | --- | --- |
280   -| { "i":1} | i = 1 开启白名单 |
281   -
282   -
283   -#### 关闭白名单
284   -
285   -应用程序发送给基站
286   -
287   -| 主题 | /lesson/class/${clinetId}/receive | 备注 |
288   -| --- | --- | --- |
289   -| { "i":2} | i = 2 关闭白名单 |
  257 +| |``` { "i":16} | i = 16应用主动通知键盘发送在线键盘信息。键盘上线参考"键盘上线3.3.3.1" ```||
290 258  
291 259  
292 260 #### 读取白名单
... ... @@ -295,13 +263,13 @@ ${clinetId} clinetId 是基站编号，为替换字符串。
295 263  
296 264 | 主题 | /lesson/class/${clinetId}/receive | 备注 |
297 265 | --- | --- | --- |
298   -| { "i":30,} | i = 30 读取白名单 |
  266 +| |``` { "i":30,} ```| i = 30 读取白名单 |
299 267  
300 268 基站发给应用程序
301 269  
302 270 | 主题 | /lesson/class/${clinetId}/receive | 备注 |
303 271 | --- | --- | --- |
304   -| { "i": 31, "total": 1, "current": 1, "m": ["2126932551"]} | i = 31 白名单上传 |
  272 +| |``` { "i": 31, "total": 1, "current": 1, "m": ["2126932551"]} ```| i = 31 白名单上传 |
305 273  
306 274  
307 275 #### 添加白名单
... ... @@ -310,8 +278,7 @@ ${clinetId} clinetId 是基站编号，为替换字符串。
310 278  
311 279 | 主题 | /lesson/class/${clinetId}/receive | 备注 |
312 280 | --- | --- | --- |
313   -| { "i":3, "m":["12345","56789"]
314   -} | i = 3 添加白名单m内包含白名单键盘按编号 |
  281 +| |``` { "i":3, "m":["12345","56789"]} ```| i = 3 添加白名单m内包含白名单键盘按编号 |
315 282  
316 283  
317 284 #### 删除白名单
... ... @@ -320,8 +287,7 @@ ${clinetId} clinetId 是基站编号，为替换字符串。
320 287  
321 288 | 主题 | /lesson/class/${clinetId}/receive | 备注 |
322 289 | --- | --- | --- |
323   -| { "i":4, "m":["12345","56789"]
324   -} | i = 4 删除白名单m内包含白名单键盘按编号 |
  290 +| |``` { "i":4, "m":["12345","56789"]} ```| i = 4 删除白名单m内包含白名单键盘按编号 |
325 291  
326 292  
327 293 #### 清空白名单
... ... @@ -330,7 +296,7 @@ ${clinetId} clinetId 是基站编号，为替换字符串。
330 296  
331 297 | 主题 | /lesson/class/${clinetId}/receive | 备注 |
332 298 | --- | --- | --- |
333   -| { "i":5} | i = 5 清空白名单 |
  299 +| |{ "i":5} | i = 5 清空白名单 |
334 300  
335 301  
336 302 ### 签到
... ... @@ -342,9 +308,7 @@ ${clinetId} clinetId 是基站编号，为替换字符串。
342 308  
343 309 | 主题 | /lesson/class/${clinetId}/receive | 备注 |
344 310 | --- | --- | --- |
345   -| { "i": 12, "en": "12340", "qm": 7, "m": { "tp":"pin", "content":"hex: c7ebbbd8b4f0cfc2c3e633b5c0cad4cce2" }} | qm= 7 签到 en 序号（事务）ID，每个任务需要变化 Tp 签到模式 pin表示pin签到 Ok 表示按ok键签到，默认按OK键签到
346   -
347   - |
  311 +| |{ "i": 12, "en": "12340", "qm": 7, "m": { "tp":"pin", "content":"hex: c7ebbbd8b4f0cfc2c3e633b5c0cad4cce2" }} | qm= 7 签到 en 序号（事务）ID，每个任务需要变化 Tp 签到模式 pin表示pin签到 Ok 表示按ok键签到，默认按OK键签到 |
348 312  
349 313  
350 314 #### 接收签到信息
... ... @@ -353,7 +317,7 @@ ${clinetId} clinetId 是基站编号，为替换字符串。
353 317  
354 318 | 主题 | /lesson/class/${clinetId}/send | 备注 |
355 319 | --- | --- | --- |
356   -| { "i":13, "en":"12340", "qm":7, "m":[{ "c":"12345", "a":"6542", "t":1626016299 }] } | qm = 7 签到 en 发起的序号ID c 键盘sn号 t 表示时间A 签到附带信息 |
  320 +| |{ "i":13, "en":"12340", "qm":7, "m":[{ "c":"12345", "a":"6542", "t":1626016299 }] } | qm = 7 签到 en 发起的序号ID c 键盘sn号 t 表示时间A 签到附带信息 |
357 321  
358 322  
359 323 #### 停止签到
... ... @@ -362,7 +326,7 @@ ${clinetId} clinetId 是基站编号，为替换字符串。
362 326  
363 327 | 主题 | /lesson/class/${clinetId}/receive | 备注 |
364 328 | --- | --- | --- |
365   -| { "i": 11, "en": "12340"} | 停止对序号12340的签到 |
  329 +| |{ "i": 11, "en": "12340"} | 停止对序号12340的签到 |
366 330  
367 331  
368 332 #### 签到结果下发
... ... @@ -371,7 +335,7 @@ ${clinetId} clinetId 是基站编号，为替换字符串。
371 335  
372 336 | 主题 | /lesson/class/${clinetId}/receive | 备注 |
373 337 | --- | --- | --- |
374   -| { "i": 62, "en": "12340" "sn":["1","2"], "m":{ "success":0 "text":"hex:shjdfhkjhkjfd" }} | Pin 签到的签到结果下发 Success 签到状态结果Text 签到信息（例如签到失败） |
  338 +| |{ "i": 62, "en": "12340" "sn":["1","2"], "m":{ "success":0 "text":"hex:shjdfhkjhkjfd" }} | Pin 签到的签到结果下发 Success 签到状态结果Text 签到信息（例如签到失败） |
375 339  
376 340  
377 341 ### 单题
... ... @@ -383,8 +347,8 @@ ${clinetId} clinetId 是基站编号，为替换字符串。
383 347  
384 348 | 主题 | /lesson/class/${clinetId}/receive | 备注 |
385 349 | --- | --- | --- |
386   -| { "i": 12, "en": "12340", "qm": 1, "m": { "qt": 0, "on": 4, "content":"hex: c7ebbbd8b4f0cfc2c3e633b5c0cad4cce2" }} | 示例为单题模式的字母单选。题目内容必须要转成GBK 16进制hex进行传输，并且在内容前面标记为hex: qm =1 单题模式 i=12 下发答题/签到指令 qt 字母单选on 选项数content 题目主干内容 |
387   -| { "i": 12, "en": "12340", "qm": 1, "at": 1, "m": { "qt": 0, "on": 4, "content":"hex: c7ebbbd8b4f0cfc2c3e633b5c0cad4cce2" }} | 添加 at = 1 自动测试，键盘固定答案上传 |
  350 +| |{ "i": 12, "en": "12340", "qm": 1, "m": { "qt": 0, "on": 4, "content":"hex: c7ebbbd8b4f0cfc2c3e633b5c0cad4cce2" }} | 示例为单题模式的字母单选。<br>题目内容必须要转成GBK 16进制hex进行传输，并且在内容前面标记为hex: <br> qm =1 单题模式 <br>i=12 下发答题/签到指令 <br> qt 字母单选<br> on 选项数<br> content 题目主干内容 |
  351 +
388 352  
389 353  
390 354 #### 接收答题数据
... ... @@ -393,7 +357,7 @@ ${clinetId} clinetId 是基站编号，为替换字符串。
393 357  
394 358 | 主题 | /lesson/class/${clinetId}/send | 备注 |
395 359 | --- | --- | --- |
396   -| { "i":13, "en":"12340", "qm":1, "c":"12345", "m":[{ "qn":1, "a":"A", "t":1626016299 }] } | 按照题号（qn）来上报答题数据，单题题号固定为1， t为提交答案时间文本题：hex: 标记是gbk编码的hex内容 I = 13 上报信息 qm 字母单选题 c 键盘编号 qn 第几题 单选固定是1t 答题时间 |
  360 +| |{ "i":13, "en":"12340", "qm":1, "c":"12345", "m":[{ "qn":1, "a":"A", "t":1626016299 }] } | 按照题号（qn）来上报答题数据，单题题号固定为1， t为提交答案时间文本题：hex: 标记是gbk编码的hex内容 I = 13 上报信息 qm 字母单选题 c 键盘编号 qn 第几题 单选固定是1t 答题时间 |
397 361  
398 362  
399 363 #### 停止答题
... ... @@ -402,7 +366,7 @@ ${clinetId} clinetId 是基站编号，为替换字符串。
402 366  
403 367 | 主题 | /lesson/class/${clinetId}/receive | 备注 |
404 368 | --- | --- | --- |
405   -| { "i": 11, "en": "12340"} | 停止对序号12340的测验 |
  369 +| |{ "i": 11, "en": "12340"} | 停止对序号12340的测验 |
406 370  
407 371  
408 372 ### 多题
... ... @@ -414,8 +378,7 @@ ${clinetId} clinetId 是基站编号，为替换字符串。
414 378  
415 379 | 主题 | /lesson/class/${clinetId}/receive | 备注 |
416 380 | --- | --- | --- |
417   -| "i":12, "en":"12341", "qm":2, "m":{ "qt":0, "on": 4, "qs":20, "content":"hex: c7ebbbd8b4f0cfc2c3e633b5c0cad4cce2" }} | 示例为多题模式不带内容的快速20道字母单选。 qm =2 多题模式 Qt 题目模式 qt = 0 字母单选 On 选项数量 Qs 题目数量
418   - |
  381 +| |{"i":12, "en":"12341", "qm":2, "m":{ "qt":0, "on": 4, "qs":20, "content":"hex: c7ebbbd8b4f0cfc2c3e633b5c0cad4cce2" }} | 示例为多题模式不带内容的快速20道字母单选。 qm =2 多题模式 Qt 题目模式 qt = 0 字母单选 On 选项数量 Qs 题目数量|
419 382  
420 383  
421 384 #### 接收答题数据
... ...