李外 / Protocol

Commit 7026ab5f10c1bf99842bf2da24196eb0eb34e6ff

Authored by 刘琴
1 parent f552a473

增加表决功能的相关接口，暂只有三键表决，适配M5

Inline Side-by-side
Showing 1 changed file with 84 additions and 1 deletions
通讯协议-平台化-应用部分[内部].md
  View file @7026ab5
... ... @@ -32,7 +32,7 @@ SunVote 二次开å‘<br>通讯åè®®
32 32 <br>
33 33 <br>
34 34 <div style="text-align: center;font-size: 30px;">
35   -Ver 1.0.10
  35 +Ver 1.0.11
36 36 </div>
37 37 <br>
38 38 <br>
... ... @@ -77,6 +77,7 @@ Ver 1.0.10
77 77 |1.0.8| 2025å¹´7月8æ—¥|刘ç´|1. 增加读写基站MAC地å€(内部)|
78 78 |1.0.9| 2025å¹´7月17æ—¥|刘ç´|1. 基站自检项增加字库检测<br>2. 键盘扫æ指令增加键盘id返回<br>3. 修改设置键盘ID和返回事件为外部指令|
79 79 |1.0.10| 2025å¹´7月24æ—¥|刘ç´|1. 增加写键盘OEMåž‹å·å称|
  80 +|1.0.11| 2025å¹´7月30æ—¥|刘ç´|1. 增加表决功能(æš‚åªæœ‰ä¸‰é”®è¡¨å†³)|
80 81  
81 82 <br>
82 83 <br>
... ... @@ -304,6 +305,8 @@ WebSocketæ–¹å¼åº”用与SDK建立长连接åŽï¼Œé€šè¿‡WebSocket接å£å‘é€æŽ¥æ”
304 305 |文本题|å¯åŠ¨æ–‡æœ¬é¢˜ç­”题|[startQAEText](#startqaetext)|[sEvtStateCode](#sevtstatecode)<br>[fEvtQAEText](#fevtqaetext)|
305 306 ||åœæ­¢æ–‡æœ¬é¢˜ç­”题|[stopKpVote](#stopkpvote)|[sEvtStateCode](#sevtstatecode)|
306 307 |短消æ¯|å‘é€çŸ­æ¶ˆæ¯|[sendKpMsg](#sendkpmsg)|[sEvtStateCode](#sevtstatecode)<br>[fEvtKpMsg](#fevtkpmsg)|
  308 +|表决|å¯åŠ¨è¡¨å†³|[startQAVote](#startqavote)|[sEvtStateCode](#sevtstatecode)<br>[fEvtQAVote](#fevtqavote)|
  309 +||åœæ­¢è¡¨å†³|[stopKpVote](#stopkpvote)|[sEvtStateCode](#sevtstatecode)|
307 310 |待机实时å馈|设置待机实时å馈状æ€|[setKpStbResponse](#setkpstbresponse)|[fEvtKpStbResponse](#fevtkpstbresponse)<br>[sEvtKpRtFeedback](#sevtkprtfeedback)<br>[sEvtKpHandUp](#sevtkphandup)|
308 311 ||获å–待机实时å馈状æ€|[getKpStbResponse](#getkpstbresponse)|[fEvtKpStbResponse](#fevtkpstbresponse)|
309 312 ### 语音å馈
... ... @@ -1445,6 +1448,7 @@ WebSocketæ–¹å¼åº”用与SDK建立长连接åŽï¼Œé€šè¿‡WebSocket接å£å‘é€æŽ¥æ”
1445 1448 }
1446 1449 }
1447 1450 ```
  1451 +
1448 1452 ##### fEvtBsCapacity
1449 1453 - **主题**: /basestation/{baseSN}/receive
1450 1454 - **功能æè¿°**：返回基站容é‡
... ... @@ -1469,6 +1473,7 @@ WebSocketæ–¹å¼åº”用与SDK建立长连接åŽï¼Œé€šè¿‡WebSocket接å£å‘é€æŽ¥æ”
1469 1473 }
1470 1474 }
1471 1475 ```
  1476 +
1472 1477 ##### fEvtBsChannel
1473 1478 - **主题**: /basestation/{baseSN}/receive
1474 1479 - **功能æè¿°**：返回基站信é“
... ... @@ -5310,6 +5315,84 @@ WebSocketæ–¹å¼åº”用与SDK建立长连接åŽï¼Œé€šè¿‡WebSocket接å£å‘é€æŽ¥æ”
5310 5315 }
5311 5316 ```
5312 5317  
  5318 +### 表决
  5319 +#### 方法
  5320 +##### startQAVote
  5321 +- **主题**：/client/{baseSN}/send
  5322 +- **功能æè¿°**：å¯åŠ¨è¡¨å†³
  5323 +- **å‚数说明**
  5324 +
  5325 +|å‚æ•°å|类型|é™åˆ¶|是å¦å¿…å¡«|说明|
  5326 +|---|---|---|---|---|
  5327 +|fun|string|-|是|指令å称|
  5328 +|dataTag|string|-|å¦|æ•°æ®åŒ…标识,å¯ä¸ºç©ºå­—符串|
  5329 +|baseSn|string||是|基站的出厂编ç |
  5330 +|data|object|-|是|ä¼ é€å‚数的对象|
  5331 +|+keySns|array||是|指定的键盘SN数组，空数组表示全部在线键盘|
  5332 +|+mode|int||是|1 - 赞æˆ/å对/弃æƒ|
  5333 +|+allowModify|int||是|0 - ä¸å…许修改<br>1 - å…许修改|
  5334 +|+isSecrecy|int||是|0 - ä¸ä¿å¯†<br>1 - ä¿å¯†|
  5335 +|+tip|string||å¦|æ示的标题，长度ä¸è¶…过16字符|
  5336 +|+simParams|object||å¦|内部模拟测试å‚数设置对象|
  5337 +|++answer|string||是|预设æ交的按键值<br>1-对 <br>2-é”™|
  5338 +
  5339 +- **示例代ç **
  5340 +
  5341 +```json
  5342 +{
  5343 + "fun":"startQAVote",
  5344 + "dataTag":"1",
  5345 + "baseSn":"2024061101",
  5346 + "data":{
  5347 + "keySns":[],
  5348 + "mode":1,
  5349 + "allowModify":1,
  5350 + "isSecrecy":0,
  5351 + "tip":"请按键表决"
  5352 + }
  5353 +}
  5354 +```
  5355 +
  5356 +##### [stopKpVote](#stopkpvote)
  5357 +åœæ­¢åˆ¤æ–­é¢˜ç­”题
  5358 +
  5359 +#### 事件
  5360 +##### [sEvtStateCode](#sevtstatecode)
  5361 +å‘é€æŒ‡ä»¤åŽè¿”回接收状æ€
  5362 +
  5363 +##### fEvtQAVote
  5364 +- **主题**：/basestation/{baseSN}/receive
  5365 +- **功能æè¿°**：返回键盘æ交表决信æ¯
  5366 +- **å‚数说明**
  5367 +
  5368 +|å‚æ•°å|类型|é™åˆ¶|éžç©º|说明|
  5369 +|---|---|---|---|---|
  5370 +|fun|string|-|是|指令å称|
  5371 +|dataTag|string|-|å¦|æ•°æ®åŒ…标识,å¯ä¸ºç©ºå­—符串|
  5372 +|baseSn|string||是|基站的出厂编ç |
  5373 +|data|array|-|是|ä¼ é€å‚数的对象数组|
  5374 +|++keySn|string||是|键盘SN|
  5375 +|++keyValue|string||是|键盘æ交的按键值<br>1-赞æˆ<br>2-å对<br>3-弃æƒ|
  5376 +|++keyTime|double||是|答题时间，从å¯åŠ¨å¼€å§‹è®¡ç®—，å•ä½æ¯«ç§’|
  5377 +|++voltage|double||是|键盘电é‡|
  5378 +|++retryCount|int||是|键盘æ交数æ®çš„é‡å‘次数|
  5379 +
  5380 +- **示例代ç **
  5381 +
  5382 +```json
  5383 +{
  5384 + "fun":"fEvtQAVote",
  5385 + "dataTag":"1",
  5386 + "baseSn":"2024061101",
  5387 + "data": [{
  5388 + "keySn": "1234567890",
  5389 + "keyValue":"1",
  5390 + "keyTime":2300
  5391 + }
  5392 + ]
  5393 +}
  5394 +```
  5395 +
5313 5396 ### 待机实时å馈
5314 5397 #### 方法
5315 5398 ##### setKpStbResponse
... ...