李外 / Protocol

Commit 6a5aea756c3ec34f8f203721769135ed7db5459c

Authored by 孙向锦
1 parent 0f0b1d30

协议格式

Inline Side-by-side
Showing 1 changed file with 57 additions and 57 deletions
c200k基站mqtt协议文档对内版.md
  View file @6a5aea7
@@ -20,92 +20,92 @@ @@ -20,92 +20,92 @@
20 20
21 21
22 22
23 -[1. å‰è¨€ 4](#_Toc13718) 23 +[1. å‰è¨€ 4]
24 24
25 -[1.1. 背景 4](#_Toc718) 25 +[1.1. 背景 4]
26 26
27 -[1.2. 编写目的 4](#_Toc3440) 27 +[1.2. 编写目的 4]
28 28
29 -[1.3. 读者对象 4](#_Toc31450) 29 +[1.3. 读者对象 4]
30 30
31 -[2. å¼€å‘æµç¨‹ 4](#_Toc7713) 31 +[2. å¼€å‘æµç¨‹ 4]
32 32
33 -[2.1. MQTTæœåŠ¡å™¨å‡†å¤‡ 5](#_Toc30569) 33 +[2.1. MQTTæœåŠ¡å™¨å‡†å¤‡ 5]
34 34
35 -[2.2. 基站é…ç½® 5](#_Toc20774) 35 +[2.2. 基站é…ç½® 5]
36 36
37 -[2.3. åº”ç”¨å¼€å‘ 6](#_Toc18021) 37 +[2.3. åº”ç”¨å¼€å‘ 6]
38 38
39 -[3. åŠŸèƒ½æ¸…å• 7](#_Toc1458) 39 +[3. åŠŸèƒ½æ¸…å• 7]
40 40
41 -[3.1. 支æŒçš„åŠŸèƒ½æ¸…å• 7](#_Toc14170) 41 +[3.1. 支æŒçš„åŠŸèƒ½æ¸…å• 7]
42 42
43 -[3.2. å议简介 8](#_Toc23318) 43 +[3.2. å议简介 8]
44 44
45 -[3.2.1. MQTT 8](#_Toc19246) 45 +[3.2.1. MQTT 8]
46 46
47 -[3.2.2. åè®®æ ¼å¼ 9](#_Toc21885) 47 +[3.2.2. åè®®æ ¼å¼ 9]
48 48
49 -[3.2.3. æŒ‡ä»¤å±žæ€§ä»‹ç» 9](#_Toc7095) 49 +[3.2.3. æŒ‡ä»¤å±žæ€§ä»‹ç» 9]
50 50
51 -[3.3. 功能说明 12](#_Toc31431) 51 +[3.3. 功能说明 12]
52 52
53 -[3.3.1. 授时 12](#_Toc25808) 53 +[3.3.1. 授时 12]
54 54
55 -[3.3.2. åŸºç«™ç®¡ç† 12](#_Toc31670) 55 +[3.3.2. åŸºç«™ç®¡ç† 12]
56 56
57 -[3.3.3. é”®ç›˜ç®¡ç† 15](#_Toc14326) 57 +[3.3.3. é”®ç›˜ç®¡ç† 15]
58 58
59 -[3.3.4. 签到 17](#_Toc16527) 59 +[3.3.4. 签到 17]
60 60
61 -[3.3.5. å•é¢˜ 18](#_Toc28200) 61 +[3.3.5. å•é¢˜ 18]
62 62
63 -[3.3.6. 多题 20](#_Toc20704) 63 +[3.3.6. 多题 20]
64 64
65 -[3.3.7. 套å·å¸¦é¢˜å¹² 21](#_Toc24866) 65 +[3.3.7. 套å·å¸¦é¢˜å¹² 21]
66 66
67 -[3.3.8. 离线套å·å¸¦é¢˜å¹²ä¸‹è½½ 23](#_Toc22094) 67 +[3.3.8. 离线套å·å¸¦é¢˜å¹²ä¸‹è½½ 23]
68 68
69 -[3.3.9. 离线下载多题ä¸å¸¦é¢˜å¹² 25](#_Toc22371) 69 +[3.3.9. 离线下载多题ä¸å¸¦é¢˜å¹² 25]
70 70
71 -[3.3.10. 收å–离线文本 28](#_Toc31494) 71 +[3.3.10. 收å–离线文本 28]
72 72
73 -[3.3.11. 多题题å·å¤šé¢˜ 29](#_Toc362) 73 +[3.3.11. 多题题å·å¤šé¢˜ 29]
74 74
75 -[3.3.12. 下å‘姓å 30](#_Toc10374) 75 +[3.3.12. 下å‘姓å 30]
76 76
77 -[3.3.13. 基站å‡çº§ 31](#_Toc6604) 77 +[3.3.13. 基站å‡çº§ 31]
78 78
79 -[3.3.14. 键盘å‡çº§ 32](#_Toc4566) 79 +[3.3.14. 键盘å‡çº§ 32]
80 80
81 -[3.3.15. 刷å¡äº‹ä»¶ 33](#_Toc1814) 81 +[3.3.15. 刷å¡äº‹ä»¶ 33]
82 82
83 -[3.3.16. 指纹事件 33](#_Toc3181) 83 +[3.3.16. 指纹事件 33]
84 84
85 -[3.3.17. 考勤 34](#_Toc5523) 85 +[3.3.17. 考勤 34]
86 86
87 87
88 -## 1. å‰è¨€ 88 +# 1. å‰è¨€
89 89
90 90
91 -## 1.背景 91 +## 1.1 背景
92 92
93 方便客户基于C200K基站设备使用 通信基站数æ®æŽ¥æ”¶åŠè§£æžã€‚ 93 方便客户基于C200K基站设备使用 通信基站数æ®æŽ¥æ”¶åŠè§£æžã€‚
94 94
95 95
96 -## 1.编写目的 96 +## 1.2 编写目的
97 97
98 此说明书是为了说明å议内容，开å‘æµç¨‹ï¼Œæ–¹ä¾¿åŸºäºŽæ­¤è¿›è¡ŒäºŒæ¬¡å¼€å‘。 98 此说明书是为了说明å议内容，开å‘æµç¨‹ï¼Œæ–¹ä¾¿åŸºäºŽæ­¤è¿›è¡ŒäºŒæ¬¡å¼€å‘。
99 99
100 100
101 -## 1.读者对象 101 +## 1.3 读者对象
102 102
103 1. 相关研å‘人员 103 1. 相关研å‘人员
104 2. 方案制定人员 104 2. 方案制定人员
105 3. 决策人员 105 3. 决策人员
106 106
107 107
108 -## 1. å¼€å‘æµç¨‹ 108 +# 2. å¼€å‘æµç¨‹
109 109
110 C200K基站，采用MQTTå议进行开å‘，基站接入MQTTæœåŠ¡å™¨ï¼Œåº”用从MQTTæœåŠ¡å™¨ä¸‹å‘æŒ‡ä»¤å’ŒæŽ¥æ”¶æ•°æ® 110 C200K基站，采用MQTTå议进行开å‘，基站接入MQTTæœåŠ¡å™¨ï¼Œåº”用从MQTTæœåŠ¡å™¨ä¸‹å‘指令和接收数æ®
111 111
@@ -114,7 +114,7 @@ C200K基站，采用MQTTå议进行开å‘，基站接入MQTTæœåŠ¡å™¨ï¼Œåº”用ä @@ -114,7 +114,7 @@ C200K基站，采用MQTTå议进行开å‘，基站接入MQTTæœåŠ¡å™¨ï¼Œåº”用ä
114 ![](RackMultipart20240201-1-g1fo09_html_f478434017db65da.png) 114 ![](RackMultipart20240201-1-g1fo09_html_f478434017db65da.png)
115 115
116 116
117 -## 1. MQTTæœåŠ¡å™¨å‡†å¤‡ 117 +## 2.1 MQTTæœåŠ¡å™¨å‡†å¤‡
118 118
119 MQTTæœåŠ¡å™¨è¦æ±‚： 119 MQTTæœåŠ¡å™¨è¦æ±‚：
120 120
@@ -133,7 +133,7 @@ MQTTæœåŠ¡å™¨é…置结果检查 @@ -133,7 +133,7 @@ MQTTæœåŠ¡å™¨é…置结果检查
133 ![](RackMultipart20240201-1-g1fo09_html_fee7c61a6124a949.png) 133 ![](RackMultipart20240201-1-g1fo09_html_fee7c61a6124a949.png)
134 134
135 135
136 -## 1. 基站é…ç½® 136 +## 2.2 基站é…ç½®
137 137
138 通过USB连接基站，打开基站æœåŠ¡å™¨é…置软件。 138 通过USB连接基站，打开基站æœåŠ¡å™¨é…置软件。
139 139
@@ -154,17 +154,17 @@ MQTTæœåŠ¡å™¨é…置结果检查 @@ -154,17 +154,17 @@ MQTTæœåŠ¡å™¨é…置结果检查
154 ![](RackMultipart20240201-1-g1fo09_html_39a2e5f2d9f1e7b5.png) 154 ![](RackMultipart20240201-1-g1fo09_html_39a2e5f2d9f1e7b5.png)
155 155
156 156
157 -## 1. åº”ç”¨å¼€å‘ 157 +## 2.3 应用开å‘
158 158
159 整体开å‘æµç¨‹å›¾å¦‚下： 159 整体开å‘æµç¨‹å›¾å¦‚下：
160 160
161 ![](RackMultipart20240201-1-g1fo09_html_5eea82088a9bba36.png) 161 ![](RackMultipart20240201-1-g1fo09_html_5eea82088a9bba36.png)
162 162
163 163
164 -## 1. åŠŸèƒ½æ¸…å• 164 +# 3. 功能清å•
165 165
166 166
167 -## 1. 支æŒçš„åŠŸèƒ½æ¸…å• 167 +## 3.1 支æŒçš„功能清å•
168 168
169 | **功能** | **说明** | 169 | **功能** | **说明** |
170 | --- | --- | 170 | --- | --- |
@@ -182,17 +182,17 @@ MQTTæœåŠ¡å™¨é…置结果检查 @@ -182,17 +182,17 @@ MQTTæœåŠ¡å™¨é…置结果检查
182 | 基站错误信æ¯ä¸ŠæŠ¥ | 基站错误信æ¯ä¸ŠæŠ¥ | 182 | 基站错误信æ¯ä¸ŠæŠ¥ | 基站错误信æ¯ä¸ŠæŠ¥ |
183 183
184 184
185 -## 1. å议简介 185 +## 3.2 å议简介
186 186
187 187
188 -### 1. MQTT 188 +### 3.2.1 MQTT
189 189
190 关于MQTT说明，请å‚考 https://mqtt.org/ 190 关于MQTT说明，请å‚考 https://mqtt.org/
191 191
192 ${clinetId} clinetId 是基站编å·ï¼Œä¸ºæ›¿æ¢å­—符串。 192 ${clinetId} clinetId 是基站编å·ï¼Œä¸ºæ›¿æ¢å­—符串。
193 193
194 194
195 -#### 1. 应用程åºå‘布的主题 195 +#### 3.2.1.1 应用程åºå‘布的主题
196 196
197 | 主题 | 功能 | 197 | 主题 | 功能 |
198 | --- | --- | 198 | --- | --- |
@@ -200,7 +200,7 @@ ${clinetId} clinetId 是基站编å·ï¼Œä¸ºæ›¿æ¢å­—符串。 @@ -200,7 +200,7 @@ ${clinetId} clinetId 是基站编å·ï¼Œä¸ºæ›¿æ¢å­—符串。
200 | /lesson/class/${clinetId}/receive | 接收答题的指令 | 200 | /lesson/class/${clinetId}/receive | 接收答题的指令 |
201 201
202 202
203 -#### 1. 应用程åºè®¢é˜…的主题 203 +#### 3.2.1.2 应用程åºè®¢é˜…的主题
204 204
205 | 主题 | 功能 | 205 | 主题 | 功能 |
206 | --- | --- | 206 | --- | --- |
@@ -215,14 +215,14 @@ ${clinetId} clinetId 是基站编å·ï¼Œä¸ºæ›¿æ¢å­—符串。 @@ -215,14 +215,14 @@ ${clinetId} clinetId 是基站编å·ï¼Œä¸ºæ›¿æ¢å­—符串。
215 | /client/${clientId}/error | 基站错误信æ¯ä¸ŠæŠ¥ | 215 | /client/${clientId}/error | 基站错误信æ¯ä¸ŠæŠ¥ |
216 216
217 217
218 -### 1. åè®®æ ¼å¼ 218 +### 3.2.2 å议格å¼
219 219
220 ![](RackMultipart20240201-1-g1fo09_html_d43b4a7f2872481.png) 220 ![](RackMultipart20240201-1-g1fo09_html_d43b4a7f2872481.png)
221 221
222 å议采用jsonæ ¼å¼ï¼Œæ•°æ®ä¸­å­—段è§å±žæ€§ä»‹ç»ã€‚ 222 å议采用jsonæ ¼å¼ï¼Œæ•°æ®ä¸­å­—段è§å±žæ€§ä»‹ç»ã€‚
223 223
224 224
225 -### 1. æŒ‡ä»¤å±žæ€§ä»‹ç» 225 +### 3.2.3 指令属性介ç»
226 226
227 | å称 | 类型 | 说明 | 227 | å称 | 类型 | 说明 |
228 | --- | --- | --- | 228 | --- | --- | --- |
@@ -259,10 +259,10 @@ ${clinetId} clinetId 是基站编å·ï¼Œä¸ºæ›¿æ¢å­—符串。 @@ -259,10 +259,10 @@ ${clinetId} clinetId 是基站编å·ï¼Œä¸ºæ›¿æ¢å­—符串。
259 | success | number | 0 æˆåŠŸ éž0ï¼šé”™è¯¯ç  | 259 | success | number | 0 æˆåŠŸ éž0ï¼šé”™è¯¯ç  |
260 260
261 261
262 -## 1. 功能说明 262 +## 功能说明
263 263
264 264
265 -### 1. 授时 265 +### 授时
266 266
267 对客户端授时，å‘é€æŒ‡ä»¤å³å¯ï¼ŒåŸºç«™ä¼šå®Œæˆæ ¡æ—¶ã€‚ 267 对客户端授时，å‘é€æŒ‡ä»¤å³å¯ï¼ŒåŸºç«™ä¼šå®Œæˆæ ¡æ—¶ã€‚
268 268
@@ -271,10 +271,10 @@ ${clinetId} clinetId 是基站编å·ï¼Œä¸ºæ›¿æ¢å­—符串。 @@ -271,10 +271,10 @@ ${clinetId} clinetId 是基站编å·ï¼Œä¸ºæ›¿æ¢å­—符串。
271 | { "i": 19, "t": 1634802943} | t 当å‰æ—¶é—´è½´ 秒 | 271 | { "i": 19, "t": 1634802943} | t 当å‰æ—¶é—´è½´ 秒 |
272 272
273 273
274 -### 1.åŸºç«™ç®¡ç† 274 +### 基站管ç†
275 275
276 276
277 -#### 1. 基站上线 277 +#### 基站上线
278 278
279 由基站å‘给应用程åºï¼Œåº”用需è¦è®¢é˜…主题 279 由基站å‘给应用程åºï¼Œåº”用需è¦è®¢é˜…主题
280 280
@@ -283,7 +283,7 @@ ${clinetId} clinetId 是基站编å·ï¼Œä¸ºæ›¿æ¢å­—符串。 @@ -283,7 +283,7 @@ ${clinetId} clinetId 是基站编å·ï¼Œä¸ºæ›¿æ¢å­—符串。
283 | { "i": 40} | 基站上线 | 283 | { "i": 40} | 基站上线 |
284 284
285 285
286 -#### 2. 基站下线 286 +#### 基站下线
287 287
288 ç”±æœåŠ¡å™¨å‘给应用程åºï¼Œåº”用需è¦è®¢é˜…主题 288 ç”±æœåŠ¡å™¨å‘给应用程åºï¼Œåº”用需è¦è®¢é˜…主题
289 289
@@ -292,7 +292,7 @@ ${clinetId} clinetId 是基站编å·ï¼Œä¸ºæ›¿æ¢å­—符串。 @@ -292,7 +292,7 @@ ${clinetId} clinetId 是基站编å·ï¼Œä¸ºæ›¿æ¢å­—符串。
292 | { "i": 41} | 基站下线 | 292 | { "i": 41} | 基站下线 |
293 293
294 294
295 -#### 1. 基站信æ¯è®¾ç½®ä¸Žè¯»å– 295 +#### 基站信æ¯è®¾ç½®ä¸Žè¯»å–
296 296
297 应用程åºå‘é€ç»™åŸºç«™ 297 应用程åºå‘é€ç»™åŸºç«™
298 298
@@ -302,7 +302,7 @@ ${clinetId} clinetId 是基站编å·ï¼Œä¸ºæ›¿æ¢å­—符串。 @@ -302,7 +302,7 @@ ${clinetId} clinetId 是基站编å·ï¼Œä¸ºæ›¿æ¢å­—符串。
302 | 302 |
303 303
304 304
305 -#### 1. 基站信æ¯ä¸ŠæŠ¥ 305 +#### 基站信æ¯ä¸ŠæŠ¥
306 306
307 基站å‘é€ç»™åº”ç”¨ç¨‹åº 307 基站å‘é€ç»™åº”用程åº
308 308
@@ -314,7 +314,7 @@ ${clinetId} clinetId 是基站编å·ï¼Œä¸ºæ›¿æ¢å­—符串。 @@ -314,7 +314,7 @@ ${clinetId} clinetId 是基站编å·ï¼Œä¸ºæ›¿æ¢å­—符串。
314 | 314 |
315 315
316 316
317 -#### 1. 基站错误信æ¯ä¸ŠæŠ¥ 317 +#### 基站错误信æ¯ä¸ŠæŠ¥
318 318
319 基站å‘é€ç»™åº”ç”¨ç¨‹åº 319 基站å‘é€ç»™åº”用程åº
320 320
@@ -323,7 +323,7 @@ ${clinetId} clinetId 是基站编å·ï¼Œä¸ºæ›¿æ¢å­—符串。 @@ -323,7 +323,7 @@ ${clinetId} clinetId 是基站编å·ï¼Œä¸ºæ›¿æ¢å­—符串。
323 | { "i": 22, "m": { "et": 1, "em": "3" }} | et 错误类型 et = 1 ï¼šåŸºç«™é¢‘ç‚¹å†²çª em é”™è¯¯æ¶ˆæ¯ em=3 ：3å·é¢‘点示例 基站频点3å†²çª | 323 | { "i": 22, "m": { "et": 1, "em": "3" }} | et 错误类型 et = 1 ï¼šåŸºç«™é¢‘ç‚¹å†²çª em é”™è¯¯æ¶ˆæ¯ em=3 ：3å·é¢‘点示例 基站频点3å†²çª |
324 324
325 325
326 -### 1. é”®ç›˜ç®¡ç† 326 +### 键盘管ç†
327 327
328 328
329 #### 键盘上线 329 #### 键盘上线