李外 / Protocol

Commit 5634cd4df62648f2bc8580c112f84049a155523b

Authored by DMchen
1 parent caf68b47

1.SDK应用部分，增加了相关的业务使用提示说明文字。 

2.增加 通讯协议-SDK应用使用说明.docx
Inline Side-by-side
Showing 3 changed files with 230 additions and 63 deletions
通讯协议-SDK应用使用说明.docx 0 → 100644
View file @5634cd4
No preview for this file type
通讯协议-SDK应用部分.md
  View file @5634cd4
... ... @@ -487,12 +487,11 @@ params：{}
487 487  
488 488 |**Json字段**| **字段含义** | **赋值及含义**|
489 489 | --- | --- | --- |
490   -|bindMode| 签到模式| 1:指定键签到 <br> 2:PIN码签到(默认值) |
491   -| lessMode | 预留| 0:(默认值）|
  490 +| bindMode | 签到模式| 1:指定键签到 <br> 2:PIN码签到(默认值) |
492 491 | modifyMode | 修改模式 | 0:不可修改 <br>1:可以修改(默认值)|
493   -| limitNumber | 指定位数 | 0:不指定位数(默认值) <br> 1:指定位数 |
494   -| options | 预留 | 10:(默认值）|
495   -| optionalN | 可选数字 | 1≤N≤14 (指定位数才需要设置) |
  492 +| lessMode | 预留| 0:(默认值）|
  493 +| options | 预留 | 10:(默认值）|
  494 +| optionalN | 可选位数 | 1≤N≤14 |
496 495 | keyValue | 指定按键键值 | 0:未指定[OK键签到] <br>1:1 <br>2:2 <br> 3:3 <br> 4:4 <br> 5:5 <br> 6:6 <br> 7:7 <br> 8:8 <br> 9:9 <br> 10:0 <br> 11:上键 <br> 12:下键 <br> 13:OK <br> 14:ESC <br> 15: Menu |
497 496 | tipTitle | 提示标题 | 字符串，长度最多不超过16个字节|
498 497  
... ... @@ -1189,6 +1188,7 @@ infos:{} //
1189 1188 |B200-5.8G+T2|支持|单次录音最长180秒|
1190 1189  
1191 1190 ### 抢答题
  1191 +
1192 1192 #### 开始作答
1193 1193  
1194 1194 发送：
... ... @@ -4799,60 +4799,6 @@ infos:{&quot;keySn&quot;:&quot;1837454011&quot;,&quot;state&quot;:&quot;OK&quot;}//遥控键盘关机
4799 4799 | B200-2.4G+S6 | 支持 ||
4800 4800 | B200-5.8G+T2 | 支持 ||
4801 4801  
4802   -#### 键盘暂停休眠
4803   -
4804   -写
4805   -
4806   -发送：
4807   -fun: "writeKeyboardPauseSleep" //键盘暂停休眠
4808   -params：{"value"} //
4809   -
4810   -| **Json字段** | **字段含义** | **赋值及含义** |
4811   -| --- | --- | --- |
4812   -|baseId|基站ID|0-32<br> 0:所有基站，默认值|
4813   -|value|预留|0 ：10秒有效（默认值）|
4814   -
4815   -
4816   -指令样例：
4817   -
4818   -```json
4819   -{
4820   - "fun": "writeKeyboardPauseSleep",
4821   - "baseId": 0,
4822   - "params": {
4823   - "value": "0"
4824   - },
4825   - "packetTag": "1"
4826   -}
4827   -```
4828   -
4829   -返回
4830   -
4831   -接收：
4832   -fun: "writeKeyboardPauseSleep"
4833   -baseId: 1//基站ID
4834   -infos:{"value":"0"}//10秒
4835   -
4836   -
4837   -指令样例：
4838   -
4839   -```json
4840   -{
4841   - "fun": "writeKeyboardPauseSleep",
4842   - "baseId": 1,
4843   - "infos": {
4844   - "value": "0"
4845   - },
4846   - "packetTag": "1"
4847   -}
4848   -```
4849   -
4850   -支持设备说明
4851   -
4852   -| **基站+键盘** | **支持** | **备注** |
4853   -| --- | --- | --- |
4854   -| B100-2.4G+S6 | 支持 ||
4855   -| B200-2.4G+S6 | 支持 ||
4856 4802  
4857 4803 #### 键盘短消息
4858 4804  
... ... @@ -5278,6 +5224,8 @@ infos:{} //数组对象
5278 5224  
5279 5225 应用程序在需要时，也可主动获取所有在线键盘信息。
5280 5226  
  5227 +<font color="#dd0000" size="5">注意：请不要在开启投票业务时使用。</font><br />
  5228 +
5281 5229 发送：
5282 5230 fun: "getKeypadOnLine" //获取键盘在线状态
5283 5231 params:{
... ...
通讯协议-SDK应用部分[内部].md
  View file @5634cd4
... ... @@ -1217,6 +1217,7 @@ infos:{} //
1217 1217 |B200-5.8G+T2|支持|单次录音最长180秒|
1218 1218  
1219 1219 ### 抢答题
  1220 +
1220 1221 #### 开始作答
1221 1222  
1222 1223 发送：
... ... @@ -3053,8 +3054,9 @@ infos:{&quot;state&quot;:&quot;OK&quot;}//返回状态,成功为OK
3053 3054 ```
3054 3055  
3055 3056 ### 自定义题型
  3057 +#### 标准题型
3056 3058  
3057   -#### 开始测试
  3059 +##### 开始测试
3058 3060  
3059 3061 发送：
3060 3062  
... ... @@ -3225,7 +3227,7 @@ infos:{&quot;state&quot;:&quot;OK&quot;}//返回状态,成功为OK
3225 3227 }
3226 3228 ```
3227 3229  
3228   -#### 接收作答
  3230 +##### 接收作答
3229 3231  
3230 3232 接收：
3231 3233  
... ... @@ -3259,7 +3261,222 @@ infos: {}
3259 3261 ```
3260 3262  
3261 3263  
3262   -#### 退出作答
  3264 +##### 退出作答
  3265 +
  3266 +发送：
  3267 +
  3268 +fun: "stopKeyPadCustomQuestions" //停止多题题型
  3269 +params:{} //默认空
  3270 +
  3271 +
  3272 +指令样例：
  3273 +```json
  3274 +{
  3275 + "fun": "stopKeyPadCustomQuestions",
  3276 + "baseId": 0,
  3277 + "packetTag": "1"
  3278 +}
  3279 +```
  3280 +
  3281 +
  3282 +接收：
  3283 +fun: "stopKeyPadCustomQuestions" //停止键盘测试
  3284 +baseId: "1"//收到的基站ID
  3285 +infos:{"state":"OK"}//返回状态,成功为OK
  3286 +
  3287 +
  3288 +指令样例：
  3289 +```json
  3290 +{
  3291 + "fun": "stopKeyPadCustomQuestions",
  3292 + "baseId": 1,
  3293 + "infos": {
  3294 + "state": "OK"
  3295 + },
  3296 + "packetTag": "1"
  3297 +}
  3298 +```
  3299 +
  3300 +
  3301 +##### 支持设备说明
  3302 +| **基站+键盘** | **支持** | **备注** |
  3303 +| --- | --- | --- |
  3304 +| B200-2.4G+M6 | 支持 |需要指定键盘支持|
  3305 +
  3306 +
  3307 +#### 数字选举题型
  3308 +
  3309 +##### 开始测试
  3310 +
  3311 +发送：
  3312 +
  3313 +fun: "startKeyPadDigitalElections" //开始
  3314 +params：{}
  3315 +
  3316 +| **Json字段** | **字段含义** | **赋值及含义** |
  3317 +| --- | --- | --- |
  3318 +|titleTable| 题目表 |数组[字符串]|
  3319 +|optionTable| 选项表 |数组<br>"预留 默认空"|
  3320 +|ruleTable| 规则表 |数组[内容请参考“规则字段解释”]|
  3321 +|permissionTable| 许可权限表 |数组|
  3322 +|configTable| 配置表 |数组|
  3323 +
  3324 +
  3325 +
  3326 +规则字段解释：
  3327 +
  3328 +规则类型2：
  3329 +
  3330 +| **Json字段** | **字段含义** | **赋值及含义** |
  3331 +| --- | --- | --- |
  3332 +|ruleType| 规则类型 |2 默认值2|
  3333 +|mode|模式|0:默认（选择）|
  3334 +|modifyMode|修改模式|0:不可修改<br> 1:可修改，默认|
  3335 +|secrecyMode|保密模式|0:不保密，默认<br> 1:保密|
  3336 +|lessMode|迫选模式|0:不迫选，默认<br> 1:迫选|
  3337 +|repeat|重复模式|0:不限制，默认<br>1:单个选项只能选一次|
  3338 +|sort|自动排序|0:保留输入顺序<br>1:选项自动排序，默认|
  3339 +|max|最大可选人数||
  3340 +|min|最小可选人数||
  3341 +|retain|保留数字|数组 范围000-999|
  3342 +|range|数字范围|数组|
  3343 +
  3344 +数字范围数据结构
  3345 +| **Json字段** | **字段含义** | **赋值及含义** |
  3346 +| --- | --- | --- |
  3347 +|rangeStart|数字范围开始|浮点数格式的字符串|
  3348 +|rangeEnd|数字范围结束|浮点数格式的字符串|
  3349 +
  3350 +
  3351 +许可权限表结构表说明
  3352 +| **Json字段** | **字段含义** | **赋值及含义** |
  3353 +| --- | --- | --- |
  3354 +|permission| 许可权限 |0:无[默认]<br>1: 允许<br>2: 禁止|
  3355 +|KeySnList| 键盘列表 |数组<br>"1479824643"<br>"1479824644"<br>"1479824645"<br>"1479824646"|
  3356 +
  3357 +
  3358 +配置表结构表说明
  3359 +| **Json字段** | **字段含义** | **赋值及含义** |
  3360 +| --- | --- | --- |
  3361 +|ruleType| 题编号 |1-200|
  3362 +|titleID|题目表ID|1-200|
  3363 +|optionID|选项表ID|1-200|
  3364 +|ruleID|规则表ID|1-200|
  3365 +|permissionID|许可权限表ID|1-200|
  3366 +
  3367 +
  3368 +指令样例：
  3369 +```json
  3370 +{
  3371 + "fun": "startKeyPadDigitalElections",
  3372 + "baseId": 0,
  3373 + "params": {
  3374 + "titleTable": ["数字选举1", "数字选举2", "数字选举3"],
  3375 + "optionTable": [
  3376 + ["1", "2", "3", "4"]
  3377 + ],
  3378 + "ruleTable": [{
  3379 + "ruleType": "2",
  3380 + "mode": "0",
  3381 + "modifyMode": "1",
  3382 + "secrecyMode": "0",
  3383 + "lessMode": "0",
  3384 + "repeat": "0",
  3385 + "sort": "1",
  3386 + "max": "4",
  3387 + "min": "1",
  3388 + "retain": ["777", "999"],
  3389 + "range": [{
  3390 + "rangeStart": "1",
  3391 + "rangeEnd": "999"
  3392 + }]
  3393 + }],
  3394 + "permissionTable": [{
  3395 + "permission": "0",
  3396 + "keySnList": []
  3397 + }],
  3398 + "configTable": [{
  3399 + "number": "1",
  3400 + "titleID": "1",
  3401 + "optionID": "1",
  3402 + "ruleID": "1",
  3403 + "permissionID": "0"
  3404 + },
  3405 +
  3406 + {
  3407 + "number": "2",
  3408 + "titleID": "2",
  3409 + "optionID": "1",
  3410 + "ruleID": "1",
  3411 + "permissionID": "0"
  3412 + },
  3413 + {
  3414 + "number": "3",
  3415 + "titleID": "3",
  3416 + "optionID": "1",
  3417 + "ruleID": "1",
  3418 + "permissionID": "0"
  3419 + }
  3420 + ]
  3421 + },
  3422 + "packetTag": "1"
  3423 +}
  3424 +```
  3425 +
  3426 +接收：
  3427 +
  3428 +fun: "startKeyPadCustomQuestions" //开始自定义题型
  3429 +baseId: "1"//接收到指令的基站ID
  3430 +infos:{"state":"OK"}//返回状态,成功为OK
  3431 +
  3432 +指令样例：
  3433 +
  3434 +```json
  3435 +{
  3436 + "baseId": 1,
  3437 + "fun": "startKeyPadCustomQuestions",
  3438 + "infos": {
  3439 + "state": "OK"
  3440 + },
  3441 + "packetTag": "59"
  3442 +}
  3443 +```
  3444 +
  3445 +##### 接收作答
  3446 +
  3447 +接收：
  3448 +
  3449 +fun: "answerKeyPadCustomQuestions" //自定义题型返回
  3450 +baseId: "1"//接收到指令的基站ID
  3451 +infos: {}
  3452 +
  3453 +数字范围数据结构
  3454 +| **Json字段** | **字段含义** | **赋值及含义** |
  3455 +| --- | --- | --- |
  3456 +|Time|答题时间|单位秒|
  3457 +|keySn|键盘Sn||
  3458 +|Seq|题序号||
  3459 +|keyValue|键值|键盘提交的值|
  3460 +
  3461 +
  3462 +
  3463 +指令样例：
  3464 +```json
  3465 +{
  3466 + "fun": "answerKeyPadCustomQuestions",
  3467 + "baseId": 1,
  3468 + "infos": {
  3469 + "time": "5.42",
  3470 + "keySn": "1479824643",
  3471 + "seq": "1",
  3472 + "keyValue": "12"
  3473 + },
  3474 + "packetTag": "1"
  3475 +}
  3476 +```
  3477 +
  3478 +
  3479 +##### 退出作答
3263 3480  
3264 3481 发送：
3265 3482  
... ... @@ -5458,7 +5675,7 @@ infos:{&quot;keySn&quot;:&quot;1837454011&quot;,&quot;state&quot;:&quot;OK&quot;}//遥控键盘关机
5458 5675 | B200-2.4G+S6 | 支持 ||
5459 5676 | B200-5.8G+T2 | 支持 ||
5460 5677  
5461   -#### 键盘暂停休眠
  5678 +#### 键盘暂停休眠[公司内部使用]
5462 5679  
5463 5680 写
5464 5681  
... ... @@ -6129,6 +6346,8 @@ infos:{} //数组对象
6129 6346  
6130 6347 应用程序在需要时，也可主动获取所有在线键盘信息。
6131 6348  
  6349 +<font color="#dd0000" size="5">注意：请不要在开启投票业务时使用。</font><br />
  6350 +
6132 6351 发送：
6133 6352 fun: "getKeypadOnLine" //获取键盘在线状态
6134 6353 params:{
... ...