diff --git a/通讯协议-SDK应用使用说明.docx b/通讯协议-SDK应用使用说明.docx new file mode 100644 index 0000000..907267d --- /dev/null +++ b/通讯协议-SDK应用使用说明.docx diff --git a/通讯协议-SDK应用部分.md b/通讯协议-SDK应用部分.md index 57278dc..d8c41f9 100644 --- a/通讯协议-SDK应用部分.md +++ b/通讯协议-SDK应用部分.md @@ -487,12 +487,11 @@ params：{} |**Json字段**| **字段含义** | **赋值及含义**| | --- | --- | --- | -|bindMode| 签到模式| 1:指定键签到
2:PIN码签到(默认值) | -| lessMode | 预留| 0:(默认值）| +| bindMode | 签到模式| 1:指定键签到
2:PIN码签到(默认值) | | modifyMode | 修改模式 | 0:不可修改
1:可以修改(默认值)| -| limitNumber | 指定位数 | 0:不指定位数(默认值)
1:指定位数 | -| options | 预留 | 10:(默认值）| -| optionalN | 可选数字 | 1≤N≤14 (指定位数才需要设置) | +| lessMode | 预留| 0:(默认值）| +| options | 预留 | 10:(默认值）| +| optionalN | 可选位数 | 1≤N≤14 | | keyValue | 指定按键键值 | 0:未指定[OK键签到]
1:1
2:2
3:3
4:4
5:5
6:6
7:7
8:8
9:9
10:0
11:上键
12:下键
13:OK
14:ESC
15: Menu | | tipTitle | 提示标题 | 字符串，长度最多不超过16个字节| @@ -1189,6 +1188,7 @@ infos:{} // |B200-5.8G+T2|支持|单次录音最长180秒| ### 抢答题 + #### 开始作答 发送： @@ -4799,60 +4799,6 @@ infos:{"keySn":"1837454011","state":"OK"}//遥控键盘关机 | B200-2.4G+S6 | 支持 || | B200-5.8G+T2 | 支持 || -#### 键盘暂停休眠 - -写 - -发送： -fun: "writeKeyboardPauseSleep" //键盘暂停休眠 -params：{"value"} // - -| **Json字段** | **字段含义** | **赋值及含义** | -| --- | --- | --- | -|baseId|基站ID|0-32
0:所有基站，默认值| -|value|预留|0 ：10秒有效（默认值）| - - -指令样例： - -```json -{ - "fun": "writeKeyboardPauseSleep", - "baseId": 0, - "params": { - "value": "0" - }, - "packetTag": "1" -} -``` - -返回 - -接收： -fun: "writeKeyboardPauseSleep" -baseId: 1//基站ID -infos:{"value":"0"}//10秒 - - -指令样例： - -```json -{ - "fun": "writeKeyboardPauseSleep", - "baseId": 1, - "infos": { - "value": "0" - }, - "packetTag": "1" -} -``` - -支持设备说明 - -| **基站+键盘** | **支持** | **备注** | -| --- | --- | --- | -| B100-2.4G+S6 | 支持 || -| B200-2.4G+S6 | 支持 || #### 键盘短消息 @@ -5278,6 +5224,8 @@ infos:{} //数组对象 应用程序在需要时，也可主动获取所有在线键盘信息。 +注意：请不要在开启投票业务时使用。
+ 发送： fun: "getKeypadOnLine" //获取键盘在线状态 params:{ diff --git a/通讯协议-SDK应用部分[内部].md b/通讯协议-SDK应用部分[内部].md index c56f043..1f2f417 100644 --- a/通讯协议-SDK应用部分[内部].md +++ b/通讯协议-SDK应用部分[内部].md @@ -1217,6 +1217,7 @@ infos:{} // |B200-5.8G+T2|支持|单次录音最长180秒| ### 抢答题 + #### 开始作答 发送： @@ -3053,8 +3054,9 @@ infos:{"state":"OK"}//返回状态,成功为OK ``` ### 自定义题型 +#### 标准题型 -#### 开始测试 +##### 开始测试 发送： @@ -3225,7 +3227,7 @@ infos:{"state":"OK"}//返回状态,成功为OK } ``` -#### 接收作答 +##### 接收作答 接收： @@ -3259,7 +3261,222 @@ infos: {} ``` -#### 退出作答 +##### 退出作答 + +发送： + +fun: "stopKeyPadCustomQuestions" //停止多题题型 +params:{} //默认空 + + +指令样例： +```json +{ + "fun": "stopKeyPadCustomQuestions", + "baseId": 0, + "packetTag": "1" +} +``` + + +接收： +fun: "stopKeyPadCustomQuestions" //停止键盘测试 +baseId: "1"//收到的基站ID +infos:{"state":"OK"}//返回状态,成功为OK + + +指令样例： +```json +{ + "fun": "stopKeyPadCustomQuestions", + "baseId": 1, + "infos": { + "state": "OK" + }, + "packetTag": "1" +} +``` + + +##### 支持设备说明 +| **基站+键盘** | **支持** | **备注** | +| --- | --- | --- | +| B200-2.4G+M6 | 支持 |需要指定键盘支持| + + +#### 数字选举题型 + +##### 开始测试 + +发送： + +fun: "startKeyPadDigitalElections" //开始 +params：{} + +| **Json字段** | **字段含义** | **赋值及含义** | +| --- | --- | --- | +|titleTable| 题目表 |数组[字符串]| +|optionTable| 选项表 |数组
"预留 默认空"| +|ruleTable| 规则表 |数组[内容请参考“规则字段解释”]| +|permissionTable| 许可权限表 |数组| +|configTable| 配置表 |数组| + + + +规则字段解释： + +规则类型2： + +| **Json字段** | **字段含义** | **赋值及含义** | +| --- | --- | --- | +|ruleType| 规则类型 |2 默认值2| +|mode|模式|0:默认（选择）| +|modifyMode|修改模式|0:不可修改
1:可修改，默认| +|secrecyMode|保密模式|0:不保密，默认
1:保密| +|lessMode|迫选模式|0:不迫选，默认
1:迫选| +|repeat|重复模式|0:不限制，默认
1:单个选项只能选一次| +|sort|自动排序|0:保留输入顺序
1:选项自动排序，默认| +|max|最大可选人数|| +|min|最小可选人数|| +|retain|保留数字|数组 范围000-999| +|range|数字范围|数组| + +数字范围数据结构 +| **Json字段** | **字段含义** | **赋值及含义** | +| --- | --- | --- | +|rangeStart|数字范围开始|浮点数格式的字符串| +|rangeEnd|数字范围结束|浮点数格式的字符串| + + +许可权限表结构表说明 +| **Json字段** | **字段含义** | **赋值及含义** | +| --- | --- | --- | +|permission| 许可权限 |0:无[默认]
1: 允许
2: 禁止| +|KeySnList| 键盘列表 |数组
"1479824643"
"1479824644"
"1479824645"
"1479824646"| + + +配置表结构表说明 +| **Json字段** | **字段含义** | **赋值及含义** | +| --- | --- | --- | +|ruleType| 题编号 |1-200| +|titleID|题目表ID|1-200| +|optionID|选项表ID|1-200| +|ruleID|规则表ID|1-200| +|permissionID|许可权限表ID|1-200| + + +指令样例： +```json +{ + "fun": "startKeyPadDigitalElections", + "baseId": 0, + "params": { + "titleTable": ["数字选举1", "数字选举2", "数字选举3"], + "optionTable": [ + ["1", "2", "3", "4"] + ], + "ruleTable": [{ + "ruleType": "2", + "mode": "0", + "modifyMode": "1", + "secrecyMode": "0", + "lessMode": "0", + "repeat": "0", + "sort": "1", + "max": "4", + "min": "1", + "retain": ["777", "999"], + "range": [{ + "rangeStart": "1", + "rangeEnd": "999" + }] + }], + "permissionTable": [{ + "permission": "0", + "keySnList": [] + }], + "configTable": [{ + "number": "1", + "titleID": "1", + "optionID": "1", + "ruleID": "1", + "permissionID": "0" + }, + + { + "number": "2", + "titleID": "2", + "optionID": "1", + "ruleID": "1", + "permissionID": "0" + }, + { + "number": "3", + "titleID": "3", + "optionID": "1", + "ruleID": "1", + "permissionID": "0" + } + ] + }, + "packetTag": "1" +} +``` + +接收： + +fun: "startKeyPadCustomQuestions" //开始自定义题型 +baseId: "1"//接收到指令的基站ID +infos:{"state":"OK"}//返回状态,成功为OK + +指令样例： + +```json +{ + "baseId": 1, + "fun": "startKeyPadCustomQuestions", + "infos": { + "state": "OK" + }, + "packetTag": "59" +} +``` + +##### 接收作答 + +接收： + +fun: "answerKeyPadCustomQuestions" //自定义题型返回 +baseId: "1"//接收到指令的基站ID +infos: {} + +数字范围数据结构 +| **Json字段** | **字段含义** | **赋值及含义** | +| --- | --- | --- | +|Time|答题时间|单位秒| +|keySn|键盘Sn|| +|Seq|题序号|| +|keyValue|键值|键盘提交的值| + + + +指令样例： +```json +{ + "fun": "answerKeyPadCustomQuestions", + "baseId": 1, + "infos": { + "time": "5.42", + "keySn": "1479824643", + "seq": "1", + "keyValue": "12" + }, + "packetTag": "1" +} +``` + + +##### 退出作答 发送： @@ -5458,7 +5675,7 @@ infos:{"keySn":"1837454011","state":"OK"}//遥控键盘关机 | B200-2.4G+S6 | 支持 || | B200-5.8G+T2 | 支持 || -#### 键盘暂停休眠 +#### 键盘暂停休眠[公司内部使用] 写 @@ -6129,6 +6346,8 @@ infos:{} //数组对象 应用程序在需要时，也可主动获取所有在线键盘信息。 +注意：请不要在开启投票业务时使用。
+ 发送： fun: "getKeypadOnLine" //获取键盘在线状态 params:{