Blame view

海亮定制.md 19.2 KB
fac0c011   孙向锦   添加海亮定制
1
2
  # C200K
  
c8b510aa   孙向锦   海亮定制
3
4
  [TOC]
  
fac0c011   孙向锦   添加海亮定制
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
  # 1. 前言
  
    
  ## 1.1 背景
  
  方便客户基于C200K基站设备使用 通信基站数据接收及解析。
  
    
  ## 1.2 编写目的
  
  此说明书是为了说明协议内容,开发流程,方便基于此进行二次开发。
  
   
  ##  1.3 读者对象
  
  1. 相关研发人员
  2. 方案制定人员
  3. 决策人员
  
  
  # 2. 开发流程
  
  C200K基站,采用MQTT协议进行开发,基站接入MQTT服务器,应用从MQTT服务器下发指令和接收数据
  
  整个交互图如下:
  
  ![](img/mqtt_1.png)
  
    
  ## 2.1 MQTT服务器准备
  
  MQTT服务器要求:
  
  能够正常收发MQTT数据。
  
  服务器的性能参数由业务决定。
  
  域名:
  
  公网域名或ip或者基站所处局域网ip。
  
  MQTT服务器配置结果检查
  
57b8f891   孙向锦   海亮定制
48
  使用MQTT.FX客户端,配置域名,端口,用户名和密码信息,然后连接,如果提示连接成功,则表示MQTT服务器可用。基站clientid 是基站编号。
fac0c011   孙向锦   添加海亮定制
49
50
51
52
53
54
55
56
  
  ![](img/mqtt_2.png)
  
    
  ## 2.2 基站配置
  
  通过USB连接基站,打开基站服务器配置软件。
  
5391e692   孙向锦   海亮定制
57
  ![](img/mqtt_3.png)
fac0c011   孙向锦   添加海亮定制
58
59
60
61
62
63
64
65
66
67
68
69
70
  
  如果基站没有连接电脑,工具显示检测基站中,这时候读写无效。
  
  连接正常后,按照各个信息进行写入。
  
  设置基站服务器域名(ip)、端口,用户信息、密码信息,写入基站。
  
  如果MQTT服务器没有启用用户密码验证,用户密码信息可以随机设置。
  
  拔掉USB,连接网线,接入网络,查看网络是否连接正常。(基站上面的灯是否蓝色闪烁)
  
  基站说明
  
5391e692   孙向锦   海亮定制
71
  ![](img/mqtt_4.png)
fac0c011   孙向锦   添加海亮定制
72
73
74
75
76
77
  
    
  ## 2.3 应用开发
  
  整体开发流程图如下:
  
5391e692   孙向锦   海亮定制
78
  ![](img/mqtt_5.png)
fac0c011   孙向锦   添加海亮定制
79
80
81
82
83
84
85
86
87
88
89
90
  
  
  # 3. 功能清单
  
    
  ## 3.1 支持的功能清单
  
  | **功能** | **说明** |
  | --- | --- |
  | 授时 | 给基站校时 |
  | 基站上下线 | 基站上下线信息 |
  | 键盘上下线 | 键盘上下线信息 |
fac0c011   孙向锦   添加海亮定制
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
  | 单题 | 下发一题测验 |
  | 多级编号题 | 下发多题测验 |
  | 基站升级 | 基站固件升级 |
  | 键盘升级 | 键盘固件升级 |
  | 基站错误信息上报 | 基站错误信息上报 |
  
    
  ## 3.2 协议简介
  
      
  ### 3.2.1 MQTT
  
  关于MQTT说明,请参考 https://mqtt.org/
  
  ${clinetId} clinetId 是基站编号,为替换字符串。
  
        
  #### 3.2.1.1 应用程序发布的主题
  
  | 主题 | 功能 |
  | --- | --- |
  | /client/${clientId}/operate | 基站的设置,查询等指令 |
  | /lesson/class/${clinetId}/receive | 接收答题的指令 |
  
        
  #### 3.2.1.2 应用程序订阅的主题
  
  | 主题 | 功能 |
  | --- | --- |
  | /client/${clientId}/online | 基站上线通知。 |
  | /client/${clientId}/offline | 基站下线通知。 |
  | /client/${clientId}/card/online | 答题器上线通知。 |
  | /client/${clientId}/card/offline | 答题器离线通知。 |
fac0c011   孙向锦   添加海亮定制
124
  | /client/${clientId}/report | 基站主动上报状态,或者对设置指令的回应。 |
e16c5296   孙向锦   海亮定制
125
  | /lesson/class/${clinetId}/send | 基站对答题的反馈 |
fac0c011   孙向锦   添加海亮定制
126
127
128
129
130
  | /client/${clientId}/error | 基站错误信息上报 |
  
      
  ### 3.2.2 协议格式
  
5391e692   孙向锦   海亮定制
131
  ![](img/mqtt_6.png)
fac0c011   孙向锦   添加海亮定制
132
133
134
135
136
137
138
139
  
  协议采用json格式,数据中字段见属性介绍。
  
      
  ### 3.2.3 指令属性介绍
  
  | 名称 | 类型 | 说明 |
  | --- | --- | --- |
9c6cde27   孙向锦   海亮定制
140
  | i | number | 消息指令类型(instruction),取值范围: 1-9999。 <br> i = 3 添加白名单 <br> i = 4 删除白名单 <br> i = 5 清除白名单 <br> i = 11 停止 <br> i = 12开启答题 <br> i = 13 接收答题数据 <br> i = 14 键盘上线 <br> i = 15 键盘下线 <br> i = 17 基站升级 <br> i = 18 升级报告 <br> i = 19 授时 <br>  i = 20 设置基站信息 <br> i = 21基站信息上报 <br> i = 22基站错误信息上报 <br> i = 28 键盘升级 <br> i = 29 键盘升级报告 <br> I= 30 读取白名单 <br> I= 31 白名单上传 <br> i = 40 基站上线 <br> i = 41 基站下线  <br> i = 60 下发姓名 <br> i = 61 下发姓名设置返回 <br> i = 62 文本预设 <br> i = 63 文本预设返回|
fac0c011   孙向锦   添加海亮定制
141
142
143
  | m | object | 答题消息的内容(message) 对象或数组 |
  | c | string | 答题器的序号(card) |
  | t | number | 时间戳(10位timestamp) |
e16c5296   孙向锦   海亮定制
144
  | qm | number | 模式(question model)取值范围:<br> 0:停止 <br> 1:单题  <br> 14:多级编号答题 |
57b8f891   孙向锦   海亮定制
145
146
  | qt | number | 题型(question type),取值范围: 0:字母单选 1:字母多选 2:数字题 3:判断题 4: 填空题 5:抢答 7:自判题判断题 |
  | qs | number | 该题型数量(question sum),单题为1,多题则为实际数量。 |
e16c5296   孙向锦   海亮定制
147
148
  | qn | number | 题目序号(question No),题目顺序号 |
  | dn | string | display no 显示编号,键盘上显示的题目编号|
fac0c011   孙向锦   添加海亮定制
149
150
  | a | string | 答案(answer)示例:字母单选:A字母多选:A|B文本题:hex: 标记是gbk编码的hex内容 |
  | en | string | 练习(考试)编号(exercise No)每次考试或者练习的唯一编号,用于确定提交的答案属于那次练习。 |
57b8f891   孙向锦   海亮定制
151
  | on | number | 单选和多选题的选项数量(option no) |
fac0c011   孙向锦   添加海亮定制
152
153
154
  | cid | string | 客户端ID(client Id) |
  | cm | string | 客户端型号(client Model) |
  | cv | string | 客户端版本(client Version)基站软件版本号 |
e16c5296   孙向锦   海亮定制
155
  | f | number | 信道频点(frequency) 基站频点取值:1-80 |
fac0c011   孙向锦   添加海亮定制
156
157
158
159
160
  | ap | number | 考勤功率(attend Power)取值:0-31,值约小,基站的接收能力约强。 |
  | rssi | number | 答题器考勤的RSSI阈值,软件实现的过滤。RSSI高于该值的答题器的该次考勤会丢弃。默认0,不过滤。 |
  | khs | string | 键盘心跳开关(keyboard Heartbeat Switch),on开启,off关闭 |
  | arti | number | 考勤上报时间间隔(attend Reoprt Time Interval),默认30秒 |
  | content | string | 题干内容(选项信息都包含在此),中文信息用hex进行传输。内容前面需要 hex:详见后面示例 |
57b8f891   孙向锦   海亮定制
161
  | at | number | auto test自动测试,at = 1 |
9c6cde27   孙向锦   海亮定制
162
163
164
165
  | sn | string | sn  序列号 |
  | mc | string | match code 基站配对码 |
  | el | number | electricity 键盘电量 百分比 0.75 75% |
  | pm | number | power mode 关机模式 pm = 0 在线不关机Pm = 1 在线超时关机 |
fac0c011   孙向锦   添加海亮定制
166
  | et | number | 错误类型et =1 基站频点冲突 |
57b8f891   孙向锦   海亮定制
167
  | em | string | 错误消息em = "3" 配合et使用,如et=1 em=3 表示3号频点冲突 |
e16c5296   孙向锦   海亮定制
168
  | success | number | 0 成功  -1 错误/失败 |
fac0c011   孙向锦   添加海亮定制
169
170
  
    
c8b510aa   孙向锦   海亮定制
171
  ## 3.3 功能说明
fac0c011   孙向锦   添加海亮定制
172
173
174
175
176
177
  
      
  ### 授时
  
  对客户端授时,发送指令即可,基站会完成校时。
  
36c06ee8   孙向锦   修改代码可复制
178
179
180
  主题 : /client/${client}/operate 
  
  ```
0a1ae1cf   孙向锦   表格中放入代码
181
182
183
184
  {
  	"i": 19,
  	"t": 1634802943
  }
36c06ee8   孙向锦   修改代码可复制
185
  ```
a41e0380   孙向锦   海亮定制
186
  
6c9b1262   孙向锦   海亮定制
187
  | 名词 | 备注 |
580adb3c   孙向锦   海亮定制
188
  | --- | --- | 
2e304a0b   孙向锦   海亮定制
189
  | i = 19 | 授时 |
580adb3c   孙向锦   海亮定制
190
191
  | t | 当前时间轴秒 |
  
fac0c011   孙向锦   添加海亮定制
192
193
194
195
196
  
      
  ### 基站管理
  
        
2e304a0b   孙向锦   海亮定制
197
  #### 基站上线(待完成-可能修改)
fac0c011   孙向锦   添加海亮定制
198
199
200
  
  由基站发给应用程序,应用需要订阅主题
  
6c9b1262   孙向锦   海亮定制
201
202
203
204
205
206
207
208
  主题 : /client/${clientId}/online 
  
  指令内容:
  ``` 
  {
  	"i": 40
  } 
  ``` 
fac0c011   孙向锦   添加海亮定制
209
210
  
        
2e304a0b   孙向锦   海亮定制
211
  #### 基站下线(待完成-可能修改)
fac0c011   孙向锦   添加海亮定制
212
213
214
  
  由服务器发给应用程序,应用需要订阅主题
  
6c9b1262   孙向锦   海亮定制
215
216
217
218
219
220
221
  主题:/client/${clientId}/offline 
  指令内容:
  ```json 
  { 
  	"i": 41
  } 
  ``` 
fac0c011   孙向锦   添加海亮定制
222
223
224
225
226
227
  
        
  #### 基站信息设置与读取
  
  应用程序发送给基站
  
6c9b1262   孙向锦   海亮定制
228
  主题: /client/${client}/operate 
68f3ad33   孙向锦   海亮定制
229
  指令内容:
6c9b1262   孙向锦   海亮定制
230
231
232
233
  ```json 
  {
  	"i": 20,
  	"m": {
60a60b35   孙向锦   修改2处错误
234
  		"f": 1,
6c9b1262   孙向锦   海亮定制
235
236
237
  		"mqtt_ip": "edunew.sunvotecloud.cn",
  		"mqtt_port": 8443,
  		"mqtt_username": "admin",
2e304a0b   孙向锦   海亮定制
238
  		"mqtt_password": "1223456789"
6c9b1262   孙向锦   海亮定制
239
240
241
242
243
244
  	}
  }
  ```
  
  | 主题 | 备注 |
  | --- | --- |
e16c5296   孙向锦   海亮定制
245
  | f |基站频点 频点范围1-80|
60a60b35   孙向锦   修改2处错误
246
  | mqtt\_ip | 连接服务器的IP| 
edbfcbb6   孙向锦   海亮定制
247
248
  | mqtt\_port | 连接mqtt服务器的端口 |
  | mqtt\_username | 连接mqtt服务器的用户名 |
68f3ad33   孙向锦   海亮定制
249
  | mqtt\_password | 连接mqtt服务器的密码 | 
edbfcbb6   孙向锦   海亮定制
250
  | 注意 | 如果没有该字段则不设置该值,保持原值下发对有需要修改的值设置完成后,基站信息会自动上报一次 |
fac0c011   孙向锦   添加海亮定制
251
252
253
254
255
256
  
        
  #### 基站信息上报
  
  基站发送给应用程序
  
68f3ad33   孙向锦   海亮定制
257
258
259
260
261
262
263
264
  主题: /client/${client}/report
  指令内容:
  ```json
  {
  	"i": 21,
  	"cId": "2024010282",
  	"m": {
  		"f": 1,
68f3ad33   孙向锦   海亮定制
265
266
267
  		"mqtt_ip": "edunew.sunvotecloud.cn",
  		"mqtt_port": 8443,
  		"mqtt_username": "admin",
2e304a0b   孙向锦   海亮定制
268
  		"mqtt_password": "1223456789"
68f3ad33   孙向锦   海亮定制
269
270
271
272
273
274
  	}
  }
  ```
  | 名词 | 备注 |
  | --- | --- |
  | f |基站频点 |
60a60b35   孙向锦   修改2处错误
275
276
277
278
  | mqtt_ip | 连接服务器的IP | 
  | mqtt_port | 连接mqtt服务器的端口 |
  | mqtt_username | 连接mqtt服务器的用户名 |
  | mqtt_password | 连接mqtt服务器的密码 | 
fac0c011   孙向锦   添加海亮定制
279
280
  
        
2e304a0b   孙向锦   海亮定制
281
  #### 基站错误信息上报(待完成-可能修改)
fac0c011   孙向锦   添加海亮定制
282
283
  
  基站发送给应用程序
68f3ad33   孙向锦   海亮定制
284
285
286
287
288
289
290
291
292
293
294
295
296
  主题:/client/${client}/error
  指令内容:
  ```json
  {
  	"i": 22,
  	"m": {
  		"et": 1,
  		"em": "3"
  	}
  }
  ```
  | 名词 | 备注 |
  | --- | --- |
2e304a0b   孙向锦   海亮定制
297
  | i = 22 | 基站错误信息上报 |
68f3ad33   孙向锦   海亮定制
298
299
  | et |错误类型 et = 1 :基站频点冲突 |
  | em |错误消息 em=3 :3号频点示例 基站频点3冲突 |
94d3e689   孙向锦   海亮定制
300
  
fac0c011   孙向锦   添加海亮定制
301
  
68f3ad33   孙向锦   海亮定制
302
     
fac0c011   孙向锦   添加海亮定制
303
304
305
306
307
308
  ### 键盘管理
  
        
  #### 键盘上线
  
  由基站发给应用程序,应用需要订阅主题
5890e4c7   孙向锦   海亮定制
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
  主题: /client/${clientId}/card/online
  指令内容:
  ```json
  {
  	"i": 14,
  	"m": [{
  		"c": "12345",
  		"el": 0.75,
  		"t": 1626016299
  	}]
  }
  ```
  | 名词 | 备注 |
  | --- | --- |
  | i = 14 |键盘上线 |
9c6cde27   孙向锦   海亮定制
324
  | c |键盘sn号 |
5890e4c7   孙向锦   海亮定制
325
  | el |电量信息答题器编号和上线时间及电量信息 |
94d3e689   孙向锦   海亮定制
326
  
fac0c011   孙向锦   添加海亮定制
327
  
5890e4c7   孙向锦   海亮定制
328
    
fac0c011   孙向锦   添加海亮定制
329
330
331
  #### 键盘下线
  
  由基站发给应用程序,应用需要订阅主题
5890e4c7   孙向锦   海亮定制
332
333
334
335
336
337
338
339
340
341
342
343
344
345
  主题: /client/${clientId}/card/offline
  指令内容:
  ```json
  {
  	"i": 15,
  	"m": [{
  		"c": "12345",
  		"t": 1626016299
  	}]
  }
  ```
  | 名词 | 备注 |
  | --- | --- |
  | i = 15 |键盘下线 |
9c6cde27   孙向锦   海亮定制
346
  | c |键盘sn号 |
5890e4c7   孙向锦   海亮定制
347
  | t |答题器编号和下线时间 |
94d3e689   孙向锦   海亮定制
348
  
fac0c011   孙向锦   添加海亮定制
349
350
351
352
        
  #### 读取白名单
  
  应用程序发送给基站
5890e4c7   孙向锦   海亮定制
353
354
355
356
357
358
359
360
361
362
  主题: /lesson/class/${clinetId}/receive
  指令内容:
  ```json
  {
  	"i": 30
  }
  ```
  | 名词 | 备注 |
  | --- | --- |
  | i = 30 |读取白名单 |
94d3e689   孙向锦   海亮定制
363
  
fac0c011   孙向锦   添加海亮定制
364
  
fac0c011   孙向锦   添加海亮定制
365
366
  
  基站发给应用程序
5890e4c7   孙向锦   海亮定制
367
368
369
370
371
372
373
374
375
376
377
378
379
  主题: /lesson/class/${clinetId}/receive
  指令内容:
  ```json
  {
  	"i": 31,
  	"total": 1,
  	"current": 1,
  	"m": ["2126932551"]
  }
  ```
  | 名词 | 备注 |
  | --- | --- |
  | i = 31 |白名单上传 |
9c6cde27   孙向锦   海亮定制
380
381
  | total |一共上传的数据包数 |
  | current |当前第几包 |
e16c5296   孙向锦   海亮定制
382
  | m |键盘序列号列表 |
94d3e689   孙向锦   海亮定制
383
  
fac0c011   孙向锦   添加海亮定制
384
  
fac0c011   孙向锦   添加海亮定制
385
386
387
388
389
  
        
  #### 添加白名单
  
  应用程序发送给基站
5890e4c7   孙向锦   海亮定制
390
391
392
393
394
  主题: /lesson/class/${clinetId}/receive
  指令内容:
  ```json
  {
  	"i": 3,
e16c5296   孙向锦   海亮定制
395
  	"m": ["2126833703", "2126833671"]
5890e4c7   孙向锦   海亮定制
396
397
398
399
400
  }
  ```
  | 名词 | 备注 |
  | --- | --- |
  | i = 3 |添加白名单m内包含白名单键盘按编号 |
e16c5296   孙向锦   海亮定制
401
  | m |键盘序列号列表 |
94d3e689   孙向锦   海亮定制
402
  
fac0c011   孙向锦   添加海亮定制
403
  
fac0c011   孙向锦   添加海亮定制
404
405
406
407
408
  
        
  #### 删除白名单
  
  应用程序发送给基站
5890e4c7   孙向锦   海亮定制
409
410
411
412
413
  主题: /lesson/class/${clinetId}/receive
  指令内容:
  ```json
  {
  	"i": 4,
e16c5296   孙向锦   海亮定制
414
  	"m": ["2126833703", "2126833671"]
5890e4c7   孙向锦   海亮定制
415
416
  }
  ```
fac0c011   孙向锦   添加海亮定制
417
  
5890e4c7   孙向锦   海亮定制
418
419
420
  | 名词 | 备注 |
  | --- | --- |
  | i = 4 |删除白名单m内包含白名单键盘按编号 |
e16c5296   孙向锦   海亮定制
421
  | m |键盘序列号列表 |
94d3e689   孙向锦   海亮定制
422
  
fac0c011   孙向锦   添加海亮定制
423
424
425
426
427
  
        
  #### 清空白名单
  
  应用程序发送给基站
5890e4c7   孙向锦   海亮定制
428
429
430
431
432
433
434
435
436
437
  主题: /lesson/class/${clinetId}/receive
  指令内容:
  ```json
  {
  	"i": 5
  }
  ```
  | 名词 | 备注 |
  | --- | --- |
  | i = 5 |清空白名单 |
94d3e689   孙向锦   海亮定制
438
  
fac0c011   孙向锦   添加海亮定制
439
440
  
      
fac0c011   孙向锦   添加海亮定制
441
  
fac0c011   孙向锦   添加海亮定制
442
443
444
445
446
447
448
449
  
      
  ### 单题
  
        
  #### 开启答题
  
  由应用程序发给基站,应用按照主题发送
5890e4c7   孙向锦   海亮定制
450
451
452
453
454
  主题: /lesson/class/${clinetId}/receive
  指令内容:
  ```json
  {
  	"i": 12,
358ce6fb   孙向锦   修改en序号不重复
455
  	"en": "1",
5890e4c7   孙向锦   海亮定制
456
457
458
459
  	"qm": 1,
  	"m": {
  		"qt": 0,
  		"on": 4,
9c6cde27   孙向锦   海亮定制
460
  		"content": "hex:c7ebbbd8b4f0cfc2c3e633b5c0cad4cce2"
5890e4c7   孙向锦   海亮定制
461
462
463
464
465
  	}
  }
  ```
  | 名词 | 备注 |
  | --- | --- |
9c6cde27   孙向锦   海亮定制
466
467
  | i = 12 |下发答题  |
  | en |序号  |
5890e4c7   孙向锦   海亮定制
468
469
470
  | qm = 1 |单题模式 示例为单题模式的字母单选 |
  | qt  |字母单选 |
  | on  |选项数 |
9c6cde27   孙向锦   海亮定制
471
472
473
474
475
476
477
478
  | content = 1 |题目主干内容,hex: 为内容的GBK编码的hex内容 |
  
  ```java
  String content = "hex:" + bytesToHexString(title.getBytes("GBK"))
  
  public static String bytesToHexString(byte[] src) {
      StringBuilder stringBuilder = new StringBuilder("");
      if (src == null || src.length <= 0) {
107f06d8   孙向锦   海亮定制
479
          return "";
9c6cde27   孙向锦   海亮定制
480
481
482
483
484
485
486
487
488
489
490
491
492
      }
      for (int i = 0; i < src.length; i++) {
          int v = src[i] & 0xFF;
          String hv = Integer.toHexString(v);
          if (hv.length() < 2) {
              stringBuilder.append(0);
          }
          stringBuilder.append(hv);
          stringBuilder.append("");
      }
      return stringBuilder.toString();
  }
  ```
fac0c011   孙向锦   添加海亮定制
493
494
495
496
        
  #### 接收答题数据
  
  由基站发给应用程序,应用订阅主题
5890e4c7   孙向锦   海亮定制
497
498
499
500
501
  主题: /lesson/class/${clinetId}/send
  指令内容:
  ```json
  {
  	"i": 13,
358ce6fb   孙向锦   修改en序号不重复
502
  	"en": "1",
5890e4c7   孙向锦   海亮定制
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
  	"qm": 1,
  	"c": "12345",
  	"m": [{
  		"qn": 1,
  		"a": "A",
  		"t": 1626016299
  	}]
  }
  ```
  | 名词 | 备注 |
  | --- | --- |
  | i = 13 | 答题数据 |
  | qn = 1 |上报答题数据,单题题号固定为1 |
  | t  |提交答案时间 |
  | a  | 答题数据 |
94d3e689   孙向锦   海亮定制
518
  
fac0c011   孙向锦   添加海亮定制
519
520
        
  #### 停止答题
fac0c011   孙向锦   添加海亮定制
521
  由应用程序发给基站,应用按照主题发送
5890e4c7   孙向锦   海亮定制
522
523
524
525
526
  主题:/lesson/class/${clinetId}/receive 
  指令内容:
  ```json
  {
  	"i": 11,
358ce6fb   孙向锦   修改en序号不重复
527
  	"en": "1"
5890e4c7   孙向锦   海亮定制
528
529
530
531
532
  }
  ```
  | 名词 | 备注 |
  | --- | --- |
  | i = 11 | 停止答题 |
e16c5296   孙向锦   海亮定制
533
  | en |停止对序号1的测验 |
94d3e689   孙向锦   海亮定制
534
  
fac0c011   孙向锦   添加海亮定制
535
  
5890e4c7   孙向锦   海亮定制
536
  ### 抢答(待完成-可能修改)
fac0c011   孙向锦   添加海亮定制
537
        
2e304a0b   孙向锦   海亮定制
538
  #### 开启答题(待完成-可能修改)
fac0c011   孙向锦   添加海亮定制
539
540
  
  由应用程序发给基站,应用按照主题发送
5890e4c7   孙向锦   海亮定制
541
542
543
544
545
  主题:  /lesson/class/${clinetId}/receive
  指令内容:
  ```json
  {
  	"i": 12,
358ce6fb   孙向锦   修改en序号不重复
546
  	"en": "2",
5890e4c7   孙向锦   海亮定制
547
548
549
550
551
552
  	"qm": 4
  }
  ```
  | 名词 | 备注 |
  | --- | --- |
  | i = 12 | 开启答题 |
e16c5296   孙向锦   海亮定制
553
  | en |序号2的测验 |
5890e4c7   孙向锦   海亮定制
554
  | qm | qm =4 抢答题 |
94d3e689   孙向锦   海亮定制
555
  
fac0c011   孙向锦   添加海亮定制
556
557
  
        
2e304a0b   孙向锦   海亮定制
558
  #### 接收答题数据(待完成-可能修改)
fac0c011   孙向锦   添加海亮定制
559
560
  
  由基站发给应用程序,应用订阅主题
5890e4c7   孙向锦   海亮定制
561
562
563
564
565
  主题: /lesson/class/${clinetId}/send
  指令内容:
  ```json
  {
  	"i": 13,
358ce6fb   孙向锦   修改en序号不重复
566
  	"en": "2",
5890e4c7   孙向锦   海亮定制
567
568
569
570
571
572
573
574
575
  	"qm": 4,
  	"c": "12345",
  	"m": [{
  		"qn": 1,
  		"a": "A",
  		"t": 1626016299
  	}]
  }
  ```
fac0c011   孙向锦   添加海亮定制
576
  
5890e4c7   孙向锦   海亮定制
577
578
579
  | 名词 | 备注 |
  | --- | --- |
  | i = 12 | 开启答题 |
e16c5296   孙向锦   海亮定制
580
  | en |序号2的测验 |
5890e4c7   孙向锦   海亮定制
581
582
583
584
585
  | qm | qm =4 抢答题 |
  | c | 键盘编号 |
  | qn |上报答题数据,单题题号固定为1 |
  | t  |提交答案时间 |
  | a  | 答题数据 |
94d3e689   孙向锦   海亮定制
586
  
fac0c011   孙向锦   添加海亮定制
587
588
  
        
2e304a0b   孙向锦   海亮定制
589
  #### 停止答题(待完成-可能修改)
fac0c011   孙向锦   添加海亮定制
590
  由应用程序发给基站,应用按照主题发送
5890e4c7   孙向锦   海亮定制
591
592
593
594
595
  主题:/lesson/class/${clinetId}/receive 
  指令内容:
  ```json
  {
  	"i": 11,
358ce6fb   孙向锦   修改en序号不重复
596
  	"en": "2"
5890e4c7   孙向锦   海亮定制
597
598
599
600
601
  }
  ```
  | 名词 | 备注 |
  | --- | --- |
  | i = 11 | 停止答题 |
e16c5296   孙向锦   海亮定制
602
  | en |停止对序号2的测验 |
94d3e689   孙向锦   海亮定制
603
  
fac0c011   孙向锦   添加海亮定制
604
  
fac0c011   孙向锦   添加海亮定制
605
  
fac0c011   孙向锦   添加海亮定制
606
607
  ### 多题题号多题
  
fac0c011   孙向锦   添加海亮定制
608
609
610
  #### 开启答题
  
  由应用程序发给基站,应用按照主题发送
5890e4c7   孙向锦   海亮定制
611
612
613
614
615
  主题: /lesson/class/${clinetId}/receive
  指令内容:
  ```json
  {
  	"i": 12,
358ce6fb   孙向锦   修改en序号不重复
616
  	"en": "3",
5890e4c7   孙向锦   海亮定制
617
  	"qm": 14,
9c6cde27   孙向锦   海亮定制
618
619
  	"total": 1,
      "current": 1,
5890e4c7   孙向锦   海亮定制
620
621
622
623
  	"qs": 3,
  	"m": [{
  		"qt": 0,
  		"on": 4,
e16c5296   孙向锦   海亮定制
624
  		"dn": "1-1-1"
5890e4c7   孙向锦   海亮定制
625
626
627
  	}, {
  		"qt": 0,
  		"on": 4,
e16c5296   孙向锦   海亮定制
628
  		"dn": "2-1"
5890e4c7   孙向锦   海亮定制
629
630
631
  	}, {
  		"qt": 0,
  		"on": 4,
e16c5296   孙向锦   海亮定制
632
  		"dn": "3"
5890e4c7   孙向锦   海亮定制
633
634
635
  	}]
  }
  ```
fac0c011   孙向锦   添加海亮定制
636
  
5890e4c7   孙向锦   海亮定制
637
638
639
  | 名词 | 备注 |
  | --- | --- |
  | i = 12 | 开启答题 |
9c6cde27   孙向锦   海亮定制
640
  | en |12341测验 |
5890e4c7   孙向锦   海亮定制
641
  | qm = 14 | 多题多级编号模式 |
9c6cde27   孙向锦   海亮定制
642
643
644
  | current |当前第几包数据 |
  | total |一共几包数据 |
  | qs | 题目总数 |
5890e4c7   孙向锦   海亮定制
645
646
  | qt = 0 | 字母单选 |
  | on | 选项数量 |
e16c5296   孙向锦   海亮定制
647
  | dn | 显示编号,题目最多3级数字编号,多级数字编号中间必须以“-”隔开,每级最大数200 |
94d3e689   孙向锦   海亮定制
648
  
fac0c011   孙向锦   添加海亮定制
649
650
651
652
        
  #### 接收答题数据
  
  由基站发给应用程序,应用订阅主题
5890e4c7   孙向锦   海亮定制
653
654
655
656
657
  主题: /lesson/class/${clinetId}/send
  指令内容:
  ```json
  {
  	"i": 13,
358ce6fb   孙向锦   修改en序号不重复
658
  	"en": "3",
5890e4c7   孙向锦   海亮定制
659
660
661
662
663
664
665
666
667
  	"qm": 14,
  	"c": "12345",
  	"m": [{
  		"qn": "1",
  		"a": "A",
  		"t": 1626016299
  	}]
  }
  ```
fac0c011   孙向锦   添加海亮定制
668
  
5890e4c7   孙向锦   海亮定制
669
670
671
  | 名词 | 备注 |
  | --- | --- |
  | i = 13 | 接收答题数据 |
9c6cde27   孙向锦   海亮定制
672
  | en |12341测验 |
5890e4c7   孙向锦   海亮定制
673
674
  | qm = 14 | 多题多级编号模式 |
  | c | 键盘编号 |
e16c5296   孙向锦   海亮定制
675
  | qn |顺序题号,不为显示编号,是上述题目的顺序号 |
5890e4c7   孙向锦   海亮定制
676
677
  | t  |提交答案时间 |
  | a  | 答题数据 |
94d3e689   孙向锦   海亮定制
678
  
fac0c011   孙向锦   添加海亮定制
679
680
681
  
        
  #### 停止答题
fac0c011   孙向锦   添加海亮定制
682
  由应用程序发给基站,应用按照主题发送
5890e4c7   孙向锦   海亮定制
683
684
685
686
687
  主题:/lesson/class/${clinetId}/receive 
  指令内容:
  ```json
  {
  	"i": 11,
358ce6fb   孙向锦   修改en序号不重复
688
  	"en": "3"
5890e4c7   孙向锦   海亮定制
689
690
691
692
693
694
  }
  ```
  | 名词 | 备注 |
  | --- | --- |
  | i = 11 | 停止答题 |
  | en |停止对序号12341的测验 |
94d3e689   孙向锦   海亮定制
695
  
fac0c011   孙向锦   添加海亮定制
696
697
698
  
      
  ### 下发姓名
fac0c011   孙向锦   添加海亮定制
699
700
        
  #### 姓名下发
5890e4c7   孙向锦   海亮定制
701
702
703
704
705
706
707
  主题: /lesson/class/${clinetId}/receive
  指令内容:
  ```json
  {
  	"i": 60,
  	"total": 1,
  	"current": 1,
358ce6fb   孙向锦   修改en序号不重复
708
  	"en": "4",
5890e4c7   孙向锦   海亮定制
709
710
  	"qs": 2,
  	"m": [{
e16c5296   孙向锦   海亮定制
711
712
  		"sn": "2126833671",
  		"name": "hex:5f204e09"
5890e4c7   孙向锦   海亮定制
713
  	}, {
e16c5296   孙向锦   海亮定制
714
715
  		"sn": "2126833703",
  		"name": "hex:674e56db"
5890e4c7   孙向锦   海亮定制
716
717
718
719
720
721
  	}]
  }
  ```
  | 名词 | 备注 |
  | --- | --- |
  | i = 60 | 姓名下发 |
358ce6fb   孙向锦   修改en序号不重复
722
  | en |序号4 |
5890e4c7   孙向锦   海亮定制
723
724
725
726
727
  | current |当前第几包数据 |
  | total |一共几包数据 |
  | qs |总数 |
  | sn |键盘sn号 |
  | name |姓名 |
94d3e689   孙向锦   海亮定制
728
  
fac0c011   孙向锦   添加海亮定制
729
730
  
        
2e304a0b   孙向锦   海亮定制
731
  #### 姓名下发成功失败返回 (待完成-可能修改)
5890e4c7   孙向锦   海亮定制
732
733
734
735
  主题:/lesson/class/${clinetId}/send
  指令内容:
  ```json
  {
2e304a0b   孙向锦   海亮定制
736
  	"i": 61,
5890e4c7   孙向锦   海亮定制
737
738
739
  	"total": 1,
  	"current": 1,
  	"m": [{
e16c5296   孙向锦   海亮定制
740
  		"sn": "2126833703",
5890e4c7   孙向锦   海亮定制
741
742
  		"success": 0
  	}, {
e16c5296   孙向锦   海亮定制
743
  		"sn": "2126833671",
5890e4c7   孙向锦   海亮定制
744
745
746
747
748
749
  		"success": 0
  	}]
  }
  ```
  | 名词 | 备注 |
  | --- | --- |
e16c5296   孙向锦   海亮定制
750
  | i = 61 | 姓名下发 |
358ce6fb   孙向锦   修改en序号不重复
751
  | en |序号4 |
5890e4c7   孙向锦   海亮定制
752
753
754
755
756
  | current |当前第几包数据 |
  | total |一共几包数据 |
  | qs |总数 |
  | sn |键盘sn号 |
  | name |姓名 |
94d3e689   孙向锦   海亮定制
757
  
fac0c011   孙向锦   添加海亮定制
758
  
fac0c011   孙向锦   添加海亮定制
759
760
761
762
  
      
  ### 基站升级
  
fac0c011   孙向锦   添加海亮定制
763
  #### 开始升级
84dcab21   孙向锦   海亮定制
764
765
766
767
768
  主题: /client/${client}/operate
  指令内容:
  ```json
  {
  	"i": 17,
358ce6fb   孙向锦   修改en序号不重复
769
  	"en": "5",
84dcab21   孙向锦   海亮定制
770
771
772
773
774
775
776
777
778
779
  	"m": {
  		"url": "",
  		"version": "",
  		"CRC": ""
  	}
  }
  ```
  | 名词 | 备注 |
  | --- | --- |
  | i = 17 | 基站升级 |
358ce6fb   孙向锦   修改en序号不重复
780
  | en |序号5 |
84dcab21   孙向锦   海亮定制
781
782
783
  | url |固件包地址,基站能访问到的路径 |
  | version |新固件的版本 |
  | CRC |新关键计算的CRC |
94d3e689   孙向锦   海亮定制
784
  
fac0c011   孙向锦   添加海亮定制
785
786
787
  
        
  #### 升级进度报告
84dcab21   孙向锦   海亮定制
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
  主题: /client/${client}/report
  指令内容:
  ```json
  {
  	"i": 18,
  	"m": {
  		"cId": "123456",
  		"percent": 0,
  		"status": 0
  	}
  }
  ```
  | 名词 | 备注 |
  | --- | --- |
  | i = 18 | 升级进度报告 |
  | cId |基站编号 |
  | percent |升级百分比 |
  | status |升级状态信息。 <br> 0:未开始<br> 1:升级中<br> 2:升级成功<br> 4固件版本号错误<br> 5:不在升级名单内<br> 6:升级指令错误<br> \>127:升级中的错误码。 |
94d3e689   孙向锦   海亮定制
806
  
fac0c011   孙向锦   添加海亮定制
807
808
      
  ### 键盘升级
fac0c011   孙向锦   添加海亮定制
809
810
        
  #### 开始升级
84dcab21   孙向锦   海亮定制
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
  主题: /client/${client}/operate
  指令内容:
  ```json
  {
  	"i": 28,
  	"m": {
  		"url": "",
  		"version": "",
  		"CRC": ""
  	}
  }
  ```
  | 名词 | 备注 |
  | --- | --- |
  | i = 28 | 键盘升级 |
  | url |固件包地址,基站能访问到的路径 |
  | version |新固件的版本号 |
  | CRC |新关键计算的CRC |
94d3e689   孙向锦   海亮定制
829
  
fac0c011   孙向锦   添加海亮定制
830
831
        
  #### 升级进度报告
84dcab21   孙向锦   海亮定制
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
  主题: /client/${client}/report
  指令内容:
  ```json
  {
  	"i": 29,
  	"m": {
  		"cId": "123456",
  		"percent": 0,
  		"status": 0
  	}
  }
  ```
  | 名词 | 备注 |
  | --- | --- |
  | i = 18 | 升级进度报告 |
  | cId |基站编号 |
  | percent |升级百分比 |
  | status |升级状态信息。 <br> 0:未开始<br> 1:升级中<br> 2:升级成功<br> 4固件版本号错误<br> 5:不在升级名单内<br> 6:升级指令错误<br> \>127:升级中的错误码。 |
94d3e689   孙向锦   海亮定制
850
  
fac0c011   孙向锦   添加海亮定制
851
  
fac0c011   孙向锦   添加海亮定制
852
853
  ### 文本预设
  
fac0c011   孙向锦   添加海亮定制
854
  #### 文本设置
84dcab21   孙向锦   海亮定制
855
856
857
858
  主题: /client/${client}/operate
  指令内容:
  ```json
  {
2e304a0b   孙向锦   海亮定制
859
  	"i": 62,
358ce6fb   孙向锦   修改en序号不重复
860
  	"en": "6",
e16c5296   孙向锦   海亮定制
861
  	"sn": ["2126956007", "2126956008"],
84dcab21   孙向锦   海亮定制
862
863
864
865
866
867
868
869
  	"m": [{
  		"cmd": 81,
  		"text": "hex:"
  	}]
  }
  ```
  | 名词 | 备注 |
  | --- | --- |
e16c5296   孙向锦   海亮定制
870
  | i = 62 | 文本设置 |
84dcab21   孙向锦   海亮定制
871
872
873
  | sn |键盘列表 |
  | cmd |下发的命令 <br> 4  第二行文本 <br> 81 单选 <br> 82 多选 <br> 83 数字 <br> 84 判断 <br> 85 自判题判断  <br> 87 清除 |
  | text |标题信息,以hex:开头添加的内容 内容为GBK的hex编码 |
94d3e689   孙向锦   海亮定制
874
  
84dcab21   孙向锦   海亮定制
875
876
877
878
879
  
  ```java
   public static String bytesToHexString(byte[] src) {
  	StringBuilder stringBuilder = new StringBuilder("");
  	if (src == null || src.length <= 0) {
107f06d8   孙向锦   海亮定制
880
  		return "";
84dcab21   孙向锦   海亮定制
881
882
883
884
885
886
887
888
889
890
891
892
893
  	}
  	for (int i = 0; i < src.length; i++) {
  		int v = src[i] & 0xFF;
  		String hv = Integer.toHexString(v);
  		if (hv.length() < 2) {
  			stringBuilder.append(0);
  		}
  		stringBuilder.append(hv);
  		stringBuilder.append("");
  	}
  	return stringBuilder.toString();
  }
  ```
fac0c011   孙向锦   添加海亮定制
894
  
fac0c011   孙向锦   添加海亮定制
895
896
  
        
2e304a0b   孙向锦   海亮定制
897
  #### 设置返回(待完成-可能修改)
84dcab21   孙向锦   海亮定制
898
899
900
901
  主题: /client/${client}/report
  指令内容:
  ```json
  {
2e304a0b   孙向锦   海亮定制
902
  	"i": 63,
358ce6fb   孙向锦   修改en序号不重复
903
  	"en": "6",
e16c5296   孙向锦   海亮定制
904
  	"sn": ["2126956007", "2126956008"],
84dcab21   孙向锦   海亮定制
905
906
907
908
909
910
911
912
  	"m": [{
  		"cmd": 81,
  		"success": 0
  	}]
  }
  ```
  | 名词 | 备注 |
  | --- | --- |
e16c5296   孙向锦   海亮定制
913
  | i = 63 | 设置返回 |
84dcab21   孙向锦   海亮定制
914
915
  | sn |键盘列表 |
  | cmd |下发的命令 <br> 4  第二行文本 <br> 81 单选 <br> 82 多选 <br> 83 数字 <br> 84 判断 <br> 85 自判题判断  <br> 87 清除 |
e16c5296   孙向锦   海亮定制
916
  | success | 是否成功。<br> 0 表示成功 <br> -1 失败 |
94d3e689   孙向锦   海亮定制
917
  
e16c5296   孙向锦   海亮定制
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
  ### 学生卡信息上报
  卡初始化组网的时候会上报一次
  主题:/client/${client}/report
  指令内容:
  ```json
  {
      "i":32,
      "m":[
          {
              "c":"1873373905",
              "cv":"0.2.2",
              "hw":"67.0",
              "t":1638865040
          }
      ]
  }
  ```
  | 名词 | 备注 |
  | --- | --- |
  | i = 32 | 学生卡信息上报 |
  | c |键盘编号 |
  | cv |固件版本号 |
  | hw |硬件版本号 |
  | t | 时间戳 |