李外 / Protocol

Commit cbb226ff41418c9a5499056ae8f280735ef922b1

Authored by 刘琴
1 parent ae89f743

快速下发类键盘执行结果拆回具体的方法中，这样更直观一些，定义测验的examNo=0时，基站启动新的测验，>0时根据examNo决定是否继续答题

Inline Side-by-side
Showing 1 changed file with 131 additions and 48 deletions
通讯协议-B200W-MQTT协议[内部].md
  View file @cbb226f
... ... @@ -92,7 +92,7 @@
92 92 |<font color="red">识别设置 - 识别模式(内)|<font color="red">获取键盘识别模式(内)|[getKpIdentityMode](#getkpidentitymode)|[fEvtKpIdentityMode](#fevtkpidentitymode)|
93 93 ||<font color="red">设置键盘识别模式(内)|[setKpIdentityMode](#setkpidentitymode)|[fEvtKpIdentityMode](#fevtkpidentitymode)|
94 94 |交互设置 - 用户内置状态语|设置用户内置状态语|[setKpUserStbMsg](#setkpuserstbmsg)|[fEvtKpUserStbMsg](#fevtkpuserstbmsg)|
95   -|交互设置 - 用户实时提示信息|实时设置提示反馈信息|[rtSetKpUserPrompt](#rtsetkpuserprompt)|[sEvtStateCode](#sevtstatecode)<br>[sEvtKpExecState](#sevtkpexecstate)|
  95 +|交互设置 - 用户实时提示信息|实时设置提示反馈信息|[rtSetKpUserPrompt](#rtsetkpuserprompt)|[sEvtStateCode](#sevtstatecode)<br>[fEvtSetKpUserPrompt](#fevtsetkpuserprompt)|
96 96 |在线状态获取|开启扫描在线键盘|[startGetKpOnline](#startgetkponline)|[sEvtStateCode](#sevtstatecode)<br>[sEvtBsKpOnlineMsg](#sevtbskponlinemsg)|
97 97 ||停止扫描在线键盘|[stopGetKpOnline](#stopgetkponline)|[sEvtStateCode](#sevtstatecode)|
98 98 |维护功能 - 遥控功能|遥控键盘关机|[remoteKpPowerOff](#remotekppoweroff)|[fEvtRemoteKpPowerOff](#fevtremotekppoweroff)|
... ... @@ -101,14 +101,14 @@
101 101 ### 绑定
102 102 |功能归类|功能|API指令|指令事件|
103 103 |---|---|---|---|
104   -|无线绑定|设置绑定信息到键盘|[rtSetKpBindingInfo](#rtsetkpbindinginfo)|[sEvtStateCode](#sevtstatecode)<br>[sEvtKpExecState](#sevtkpexecstate)|
105   -||清除键盘绑定信息|[clearKpBindingInfo](#clearkpbindinginfo)|[sEvtStateCode](#sevtstatecode)<br>[sEvtKpExecState](#sevtkpexecstate)|
  104 +|无线绑定|设置绑定信息到键盘|[rtSetKpBindingInfo](#rtsetkpbindinginfo)|[sEvtStateCode](#sevtstatecode)<br>[fEvtKpBindingInfo](#fevtkpbindinginfo)|
  105 +||清除键盘绑定信息|[clearKpBindingInfo](#clearkpbindinginfo)|[sEvtStateCode](#sevtstatecode)<br>[fEvtClearKpBindingInfo](#fevtclearkpbindinginfo)|
106 106 ### 签到
107 107 |功能归类|功能|API指令|指令事件|
108 108 |---|---|---|---|
109 109 |随时签到|启动随时签到|[rtStartKpSignIn](#rtstartkpsignin)|[sEvtStateCode](#sevtstatecode)<br>[fEvtKpSignIn](#fevtkpsignin)|
110 110 ||停止随时签到|[rtStopKpSignIn](#rtstopkpsignin)|[sEvtStateCode](#sevtstatecode)|
111   -||实时PIN签到授权|[rtSetKpLoginAllowed](#rtsetkploginallowed)|[sEvtStateCode](#sevtstatecode)<br>[sEvtKpExecState](#sevtkpexecstate)|
  111 +||实时PIN签到授权|[rtSetKpLoginAllowed](#rtsetkploginallowed)|[sEvtStateCode](#sevtstatecode)<br>[fEvtKpLoginAllowed](#fevtkploginallowed)|
112 112 ### 按键反馈
113 113 |功能归类|功能|API指令|指令事件|
114 114 |---|---|---|---|
... ... @@ -126,7 +126,7 @@
126 126 |标准测验|启动标准测验|[startKpExam](#startkpexam)|[sEvtStateCode](#sevtstatecode)<br>[fEvtKpExam](#fevtkpexam)<br>[fEvtFinalSubmit](#fevtfinalsubmit)|
127 127 ||停止标准测验|[stopKpExam](#stopkpexam)|[sEvtStateCode](#sevtstatecode)|
128 128 ||刷新作答数据|[rtGetKpExamData](#rtgetkpexamdata)|[fEvtKpExam](#fevtkpexam)|
129   -||允许键盘提交后退回修改|[rtAllowEdited](#rtkpallowedited)|[sEvtStateCode](#sevtstatecode)<br>[sEvtKpExecState](#sevtkpexecstate)|
  129 +||允许键盘提交后退回修改|[rtAllowEdited](#rtkpallowedited)|[sEvtStateCode](#sevtstatecode)<br>[fEvtKpAllowEdited](#fevtkpallowedited)|
130 130  
131 131 ## 公共事件
132 132 ### sEvtBsConnectState
... ... @@ -279,39 +279,6 @@
279 279 }
280 280 }
281 281 ```
282   -
283   -### sEvtKpExecState
284   -- **主题**: /basestation/\${baseSN}/receive
285   -- **功能描述**：返回基站接收指令后对键盘设置的是否成功
286   -- **参数说明**
287   -
288   -|参数名|类型|限制|非空|说明|
289   -|---|---|---|---|---|
290   -|fun|string|-|是|事件名称|
291   -|dataTag|string|-|否|数据包标识|
292   -|data|object|-|是|传送参数的对象|
293   -|+funName|string||是|指令名称|
294   -|+states|array||是|返回键盘的执行结果|
295   -|++keySn|string||是|键盘sn|
296   -|++state|int||是|0-成功<br>1-失败|
297   -
298   -- **示例代码**
299   -```Json
300   -{
301   - "fun":"sEvtKpExecState",
302   - "dataTag":"1",
303   - "data":{
304   - "funName":"clearKpBindingInfo",
305   - "states":[
306   - {
307   - "keySn":"1234567890",
308   - "state":0
309   - }
310   - ]
311   - }
312   -}
313   -```
314   -
315 282 ## 基站管理
316 283 ### 基站连接
317 284 #### 方法
... ... @@ -1409,6 +1376,9 @@
1409 1376 }
1410 1377 ```
1411 1378 #### 事件
  1379 +##### [sEvtStateCode](#sevtstatecode)
  1380 +发送指令后返回接收状态
  1381 +
1412 1382 ##### fEvtKpUserStbMsg
1413 1383 - **主题**：/basestation/\${baseSN}/receive
1414 1384 - **功能描述**：返回设置状态语的状态
... ... @@ -1431,9 +1401,38 @@
1431 1401 }
1432 1402 }
1433 1403 ```
  1404 +##### fEvtSetKpUserPrompt
  1405 +- **主题**：/basestation/\${baseSN}/receive
  1406 +- **功能描述**：返回实时设置提示语是否成功
  1407 +- **参数说明**
1434 1408  
1435   -##### [sEvtKpExecState](#sevtkpsetstate)
1436   -
  1409 +|参数名|类型|限制|非空|说明|
  1410 +|---|---|---|---|---|
  1411 +|fun|string|-|是|指令名称|
  1412 +|dataTag|string|-|否|数据包标识,可为空字符串|
  1413 +|data|array|-|是|传送参数的对象数组|
  1414 +|++keySn|string||是|设置提示语信息的键盘SN|
  1415 +|++state|string||是|设置的提示语是否成功<br>0 - 成功<br>1 - 失败|
  1416 +```json
  1417 +{
  1418 + "fun": "fEvtSetKpUserPrompt",
  1419 + "dataTag":"1",
  1420 + "data": [
  1421 + {
  1422 + "keySn": "1479824643",
  1423 + "state": "0"
  1424 + },
  1425 + {
  1426 + "keySn": "1479824645",
  1427 + "state": "0"
  1428 + },
  1429 + {
  1430 + "keySn": "1479824644",
  1431 + "state": "1"
  1432 + }
  1433 + ]
  1434 +}
  1435 +```
1437 1436 ### 在线状态
1438 1437 #### 方法
1439 1438 ##### startGetKpOnline
... ... @@ -1700,9 +1699,54 @@
1700 1699 ##### [sEvtStateCode](#sevtstatecode)
1701 1700 发送指令后返回接收状态
1702 1701  
1703   -##### [sEvtKpExecState](#sevtkpexecstate)
1704   -返回键盘执行指令的结果
  1702 +##### fEvtKpBindingInfo
  1703 +- **主题**：/basestation/\${baseSN}/receive
  1704 +- **功能描述**：返回键盘实时设置绑定信息的状态是否成功
  1705 +- **参数说明**
  1706 +
  1707 +|参数名|类型|限制|非空|说明|
  1708 +|---|---|---|---|---|
  1709 +|fun|string|-|是|指令名称|
  1710 +|dataTag|string|-|否|数据包标识,可为空字符串|
  1711 +|data|array|-|否|传送参数的对象数组|
  1712 +|++keySn|string||是|需要设置绑定信息的键盘SN|
  1713 +|++state|string||是|设置的绑定信息是否成功<br>0 - 成功<br>1 - 失败|
  1714 +```json
  1715 +{
  1716 + "fun": "fEvtKpBindingInfo",
  1717 + "dataTag":"1",
  1718 + "data": [
  1719 + {
  1720 + "keySn": "1479824643",
  1721 + "state": "0"
  1722 + },
  1723 + {
  1724 + "keySn": "1479824644",
  1725 + "state": "1"
  1726 + }
  1727 + ]
  1728 +}
  1729 +```
  1730 +##### fEvtClearKpBindingInfo
  1731 +- **主题**：/basestation/\${baseSN}/receive
  1732 +- **功能描述**：返回清空绑定信息的指令状态是否成功
  1733 +- **参数说明**
1705 1734  
  1735 +|参数名|类型|限制|非空|说明|
  1736 +|---|---|---|---|---|
  1737 +|fun|string|-|是|指令名称|
  1738 +|dataTag|string|-|否|数据包标识,可为空字符串|
  1739 +|data|object|-|否|传送参数的对象|
  1740 +|+state|string||是|设置的绑定信息是否成功<br>0 - 成功<br>1 - 失败|
  1741 +```json
  1742 +{
  1743 + "fun": "fEvtSetKpBindingInfo",
  1744 + "dataTag":"1",
  1745 + "data": {
  1746 + "state": "0"
  1747 + }
  1748 +}
  1749 +```
1706 1750 ## 签到
1707 1751 ### 随时签到
1708 1752 #### 方法
... ... @@ -1767,9 +1811,6 @@
1767 1811 ##### [sEvtStateCode](#sevtstatecode)
1768 1812 发送指令后返回接收状态
1769 1813  
1770   -##### [sEvtKpExecState](#sevtkpexecstate)
1771   -返回键盘执行指令的结果
1772   -
1773 1814 ##### fEvtKpSignIn
1774 1815 - **主题**：/basestation/\${baseSN}/receive
1775 1816 - **功能描述**：返回键盘提交签到信息
... ... @@ -1800,6 +1841,28 @@
1800 1841 ]
1801 1842 }
1802 1843 ```
  1844 +##### fEvtKpLoginAllowed
  1845 +- **主题**：/basestation/\${baseSN}/receive
  1846 +- **功能描述**：返回键盘授权状态
  1847 +- **参数说明**
  1848 +
  1849 +|参数名|类型|限制|非空|说明|
  1850 +|---|---|---|---|---|
  1851 +|fun|string|-|是|指令名称|
  1852 +|dataTag|string|-|否|数据包标识,可为空字符串|
  1853 +|data|object|-|是|传送参数的对象|
  1854 +|+keySn|string||是|键盘SN|
  1855 +|+state|string||是|0-执行成功<br> 1-执行失败|
  1856 +```json
  1857 +{
  1858 + "fun": "fEvtKpLoginAllowed",
  1859 + "dataTag":"1",
  1860 + "data": {
  1861 + "keySn":"1479824643",
  1862 + "state":1
  1863 + }
  1864 +}
  1865 +```
1803 1866 ## 按键反馈
1804 1867 ### 判断题
1805 1868 #### 方法
... ... @@ -2140,7 +2203,7 @@
2140 2203 |dataTag|string|-|否|数据包标识,可为空字符串|
2141 2204 |data|object|-|是|传送参数的对象|
2142 2205 |+keySns|array||是|指定的键盘SN数组，可空表示全部在线键盘|
2143   -|+examNo|int||是|1-9999|
  2206 +|+examNo|int||是|0-9999<br>=0，新的测验<br>>0时,与上次启动卷号一致继续测验，不一致进入新的测验|
2144 2207 |+mode|int||是|显示模式<br>0-不显示开头<br>1-显示“Q”开头<br>2-显示“题”开头|
2145 2208 |+questions|array||是|题目详情|
2146 2209 |++symbol | string||是 | 题号前缀,可为空 |
... ... @@ -2344,5 +2407,25 @@
2344 2407 }]
2345 2408 }
2346 2409 ```
2347   -##### [sEvtKpExecState](#sevtkpexecstate)
2348   -返回键盘执行指令的结果
2349 2410 \ No newline at end of file
  2411 +##### fEvtKpAllowEdited
  2412 +- **主题**：/basestation/\${baseSN}/receive
  2413 +- **功能描述**：返回允许键盘修改答案状态
  2414 +- **参数说明**
  2415 +
  2416 +|参数名|类型|限制|非空|说明|
  2417 +|---|---|---|---|---|
  2418 +|fun|string|-|是|指令名称|
  2419 +|dataTag|string|-|否|数据包标识,可为空字符串|
  2420 +|data|object|-|是|传送参数的对象|
  2421 +|+keySn|string||是|键盘SN|
  2422 +|+state|int||是|0-成功<br>1-失败|
  2423 +```json
  2424 +{
  2425 + "fun": "fEvtKpAllowEdited",
  2426 + "dataTag":"1",
  2427 + "data": {
  2428 + "keySn": "1234567890",
  2429 + "state":0
  2430 + }
  2431 +}
  2432 +```
2350 2433 \ No newline at end of file
... ...