李外 / Protocol

Commit 6a7f2b78c7eef72b5f60dff0961429ef11704280

Authored by 刘琴
1 parent 73a82bc2

增加版本说明，外部版删除举手相关内容

Inline Side-by-side
Showing 2 changed files with 109 additions and 39 deletions
通讯协议-B200W-MQTT协议[内部].md
  View file @6a7f2b7
... ... @@ -14,9 +14,60 @@
14 14 }
15 15 </style>
16 16  
  17 +<br>
  18 +<br>
  19 +<br>
  20 +
  21 +<div style="text-align: center;font-size: 70px;">
  22 +SunVote B200W <br>MQTT通讯协议
  23 +</div>
  24 +<br>
  25 +<br>
  26 +<br>
  27 +<br>
  28 +<div style="text-align: center;font-size: 30px;">
  29 +Ver 1.0.1
  30 +</div>
  31 +<br>
  32 +<br>
  33 +<br>
  34 +<br>
  35 +<br>
  36 +<br>
  37 +
  38 +<div style="text-align: center;font-size: 30px;">
  39 +长沙中天电子设计开发有限公司
  40 +</div>
  41 +
  42 +<br>
  43 +
  44 +<div style="text-align: center;font-size: 30px;">
  45 +二〇二四年十月
  46 +</div>
  47 +
  48 +<br>
  49 +<br>
  50 +<br>
  51 +<br>
  52 +
  53 +文件控制：
  54 +
  55 +文件名：SunVote B200W MQTT通讯协议
  56 +
  57 +起草人：刘琴
  58 +
  59 +最新版本作者： 刘琴
  60 +<br>
  61 +| 文档版本 | 日期 | 作者 | 版本说明 |
  62 +|---|---|---|---|
  63 +|1.0.1| 2024年10月22日|刘琴|1. 初始版|
  64 +
  65 +<br>
  66 +<br>
  67 +
17 68 [TOC]
18 69  
19   -# SunVote B200W_MQTT 接口协议
  70 +# SunVote B200W MQTT通讯协议
20 71  
21 72 # 功能说明
22 73  
... ... @@ -192,7 +243,7 @@
192 243 |抢答题|启动抢答题答题|[startQAQuicker](#startqaquicker)|[sEvtStateCode](#sevtstatecode)<br>[fEvtQAQuicker](#fevtqaquicker)|
193 244 ||停止抢答题答题|[stopKpVote](#stopkpvote)|[sEvtStateCode](#sevtstatecode)|
194 245 |待机实时反馈|设置待机实时反馈状态|[setKpStbResponse](#setkpstbresponse)|[fEvtKpStbResponse](#fevtkpstbresponse)<br>[sEvtKpRtFeedback](#sevtkprtfeedback)<br>[sEvtKpHandUp](#sevtkphandup)|
195   -||设置待机实时反馈状态|[getKpStbResponse](#getkpstbresponse)|[fEvtKpStbResponse](#fevtkpstbresponse)|
  246 +||获取待机实时反馈状态|[getKpStbResponse](#getkpstbresponse)|[fEvtKpStbResponse](#fevtkpstbresponse)|
196 247 ### 在线测验
197 248 |功能归类|功能|API指令|指令事件|
198 249 |---|---|---|---|
... ... @@ -3578,7 +3629,7 @@
3578 3629  
3579 3630 - **示例代码**
3580 3631 ```json
3581   -//启用举手反馈
  3632 +//获取实时反馈状态
3582 3633 {
3583 3634 "fun":"getKpStbResponse",
3584 3635 "dataTag":"1"
... ...
通讯协议-B200W-MQTT协议[外].md
  View file @6a7f2b7
... ... @@ -14,6 +14,57 @@
14 14 }
15 15 </style>
16 16  
  17 +<br>
  18 +<br>
  19 +<br>
  20 +
  21 +<div style="text-align: center;font-size: 70px;">
  22 +SunVote B200W <br>MQTT通讯协议
  23 +</div>
  24 +<br>
  25 +<br>
  26 +<br>
  27 +<br>
  28 +<div style="text-align: center;font-size: 30px;">
  29 +Ver 1.0.1
  30 +</div>
  31 +<br>
  32 +<br>
  33 +<br>
  34 +<br>
  35 +<br>
  36 +<br>
  37 +
  38 +<div style="text-align: center;font-size: 30px;">
  39 +长沙中天电子设计开发有限公司
  40 +</div>
  41 +
  42 +<br>
  43 +
  44 +<div style="text-align: center;font-size: 30px;">
  45 +二〇二四年十月
  46 +</div>
  47 +
  48 +<br>
  49 +<br>
  50 +<br>
  51 +<br>
  52 +
  53 +文件控制：
  54 +
  55 +文件名：SunVote B200W MQTT通讯协议
  56 +
  57 +起草人：刘琴
  58 +
  59 +最新版本作者： 刘琴
  60 +<br>
  61 +| 文档版本 | 日期 | 作者 | 版本说明 |
  62 +|---|---|---|---|
  63 +|1.0.1| 2024年10月22日|刘琴|1. 初始版|
  64 +
  65 +<br>
  66 +<br>
  67 +
17 68 [TOC]
18 69  
19 70 # SunVote B200W MQTT通讯协议
... ... @@ -86,7 +137,6 @@
86 137 |公共事件|键盘上线通知|-|[sEvtBsKpOnlineMsg](#sevtbskponlinemsg)|
87 138 |公共事件|键盘刷卡事件|-|[sEvtBsNfcResults](#sevtbsnfcresults)|
88 139 |公共事件|键盘待机实时按键反馈|-|[sEvtKpRtFeedback](#sevtkprtfeedback)|
89   -|公共事件|键盘举手键实时按键反馈|-|[sEvtKpHandUp](#sevtkphandup)|
90 140  
91 141 ### 基站管理
92 142 |功能归类|功能|API指令|指令/系统事件|
... ... @@ -155,8 +205,8 @@
155 205 ||停止数字题答题|[stopKpVote](#stopkpvote)|[sEvtStateCode](#sevtstatecode)|
156 206 |抢答题|启动抢答题答题|[startQAQuicker](#startqaquicker)|[sEvtStateCode](#sevtstatecode)<br>[fEvtQAQuicker](#fevtqaquicker)|
157 207 ||停止抢答题答题|[stopKpVote](#stopkpvote)|[sEvtStateCode](#sevtstatecode)|
158   -|待机实时反馈|设置待机实时反馈状态|[setKpStbResponse](#setkpstbresponse)|[fEvtKpStbResponse](#fevtkpstbresponse)<br>[sEvtKpRtFeedback](#sevtkprtfeedback)<br>[sEvtKpHandUp](#sevtkphandup)|
159   -||设置待机实时反馈状态|[getKpStbResponse](#getkpstbresponse)|[fEvtKpStbResponse](#fevtkpstbresponse)|
  208 +|待机实时反馈|设置待机实时反馈状态|[setKpStbResponse](#setkpstbresponse)|[fEvtKpStbResponse](#fevtkpstbresponse)<br>[sEvtKpRtFeedback](#sevtkprtfeedback)|
  209 +||获取待机实时反馈状态|[getKpStbResponse](#getkpstbresponse)|[fEvtKpStbResponse](#fevtkpstbresponse)|
160 210 ### 在线测验
161 211 |功能归类|功能|API指令|指令事件|
162 212 |---|---|---|---|
... ... @@ -328,28 +378,6 @@
328 378 }]
329 379 }
330 380 ```
331   -### sEvtKpHandUp
332   -- **主题**: /basestation/\${baseSN}/receive
333   -- **功能描述**：开启键盘举手功能后，键盘按举手键时上报
334   -- **参数说明**
335   -
336   -|参数名|类型|限制|非空|说明|
337   -|---|---|---|---|---|
338   -|fun|string|-|是|事件名称|
339   -|dataTag|string|-|否|数据包标识|
340   -|data|object|-|是|传送参数的对象|
341   -|+keySn|string||是|举手的键盘SN|
342   -
343   -- **示例代码**
344   -```json
345   -{
346   - "fun":"sEvtKpHandUp",
347   - "dataTag":"1",
348   - "data":{
349   - "keySn":"1234567890"
350   - }
351   -}
352   -```
353 381 ### sEvtStateCode
354 382 - **主题**: /basestation/\${baseSN}/receive
355 383 - **功能描述**：返回基站接收指令状态信息
... ... @@ -2468,20 +2496,11 @@
2468 2496 |dataTag|string|-|否|数据包标识,可为空字符串|
2469 2497 |data|object|-|是|传送参数的对象|
2470 2498 |+state|int||是|启用待机实时反馈<br>0-不启用<br>1-启用|
2471   -|+mode|int||是|启动待机反馈类型，state=1时有效<br>0-举手<br>1-指定按键反馈|
  2499 +|+mode|int||是|启动待机反馈类型，state=1时有效<br>1 - 指定按键反馈|
2472 2500 |+keys|int||是|有效按键数量，state=1且mode=1时有效, 范围1-10|
2473 2501  
2474 2502 - **示例代码**
2475 2503 ```json
2476   -//启用举手反馈
2477   -{
2478   - "fun":"setKpStbResponse",
2479   - "dataTag":"1",
2480   - "data":{
2481   - "state":1,
2482   - "mode":0
2483   - }
2484   -}
2485 2504 //启用待机按键反馈
2486 2505 {
2487 2506 "fun":"setKpStbResponse",
... ... @@ -2514,7 +2533,7 @@
2514 2533  
2515 2534 - **示例代码**
2516 2535 ```json
2517   -//启用举手反馈
  2536 +//获取实时反馈状态
2518 2537 {
2519 2538 "fun":"getKpStbResponse",
2520 2539 "dataTag":"1"
... ...