diff --git a/通讯协议-SDK应用部分.md b/通讯协议-SDK应用部分.md index fd506b5..3dc7c49 100644 --- a/通讯协议-SDK应用部分.md +++ b/通讯协议-SDK应用部分.md @@ -8,7 +8,7 @@ WSCmdApp协议接口说明
-Ver5.1.8 +Ver5.1.9


@@ -50,6 +50,7 @@ Ver5.1.8 |5.1.6| 2024年02月19日|陈定敏|1. 增加keypadRemoteControl接口
2. 增加举手功能接口| |5.1.7| 2024年04月22日|陈定敏|1. 增加后台签到接口
2. 增加键盘最终提交状态接口| |5.1.8| 2024年07月01日|陈定敏|1. 投票反馈数据增加电池状态| +|5.1.9| 2024年07月19日|陈定敏|1. 增加获取SDK版本接口|
@@ -5308,7 +5309,24 @@ fun: "keypadHandUp" | B200-2.4G+S7 | 支持 | | #### 遥控键盘关机 +##### 遥控所有键盘关机 +写 +发送： +fun: "remoteKeyShutdown" //遥控键盘关机 +params：{}// +指令样例： + +```json +{ + "fun": "remoteKeyShutdown", + "baseId": 1, + "baseSn":"2023031402", + "params": [], + "packetTag": "1" +} +``` +##### 遥控指定键盘关机 写 发送： fun: "remoteKeyShutdown" //遥控键盘关机 @@ -5781,172 +5799,91 @@ params:{ ``` 接收： -fun: "keypadOnLine" //键盘在线状态 +fun: "answerKeyPadScan" //键盘在线状态 infos:{} //数组对象 | **基站+键盘** | **支持** | **备注** | | --- | --- | --- | |baseId|基站id|keySn键盘所在基站id| |keySn|键盘Sn|| -|keyVer|键盘版本|| -|Volt|键盘电量|T2百分比值，S6无效| -指令样例： -```json -{ - "fun": "keypadOnLine", - "baseId": 0, - "infos": [{ - "baseId": "1", - "keySn": "1837454011", - "ver": "1.0.6", - "hModel": "67", - "Volt": "100" - }, - { - "baseId": "1", - "keySn": "1837454012", - "ver": "1.0.6", - "hModel": "67", - "Volt": "30" - } - ], - "packetTag": "1" -} -``` - -支持设备说明 -| **基站+键盘** | **支持** | **备注** | -| --- | --- | --- | -| B100-2.4G+S6 | 支持 |键盘电量：无效| -| B200-2.4G+S6 | 支持 |键盘电量：无效| -| B200-5.8G+T2 | 支持 |键盘电量：百分比值| - -### 在线键盘扫描 - -#### 开始扫描 - -发送： - -fun: "startKeyPadScan" // -params：{} - -|**Json字段**|**字段含义**|**赋值及含义**| -|---|---|---| +指令样例： +扫描到的键盘信息指令[这个指令会有多条]： -指令样例： ```json { - "fun": "startKeyPadScan", - "baseId": 0, - "baseSn":"2023031402", - "params": {}, - "packetTag": "1" + "baseId": 1, + "fun": "answerKeyPadScan", + "infos": { + "keySn": "0112375918" + }, + "packetTag": "0" } ``` -接收： - -fun: "startKeyPadScan" // -baseId: "1"//接收到指令的基站ID -infos:{"state":"OK"}//返回状态,成功为OK - -指令样例： +接收扫描停止指令： ```json { - "fun": "startKeyPadScan", "baseId": 1, - "baseSn":"2023031402", + "fun": "stopgetKeypadOnLine", "infos": { "state": "OK" }, - "packetTag": "1" + "packetTag": "18" } ``` -#### 接收作答 - -接收： -fun: " answerKeyPadScan" -baseId: 1//基站ID -infos:{ "hModel": "67","keySn":"1479824643","ver":"1.0.0","keyBattery":"2.5"}//返回键盘反馈模式参数值 - -| **Json字段** | **字段含义** | **赋值及含义** | +支持设备说明 +| **基站+键盘** | **支持** | **备注** | | --- | --- | --- | -|hModel|键盘型号|67： S6-2.4G| -|keySn|键盘Sn|| -|keyVer|键盘版本|| -|keyBattery|键盘电量|T2百分比值，S6电压值| +| B100-2.4G+S6 | 支持 |键盘电量：无效| +| B200-2.4G+S6 | 支持 |键盘电量：无效| +| B200-5.8G+T2 | 支持 |键盘电量：无效| -指令样例： -```json -{ - "fun": "answerKeyPadScan", - "baseId": 1, - "baseSn":"2023031402", - "infos": { - "hModel": "67", - "keySn": "1479824643", - "ver": "1.0.0", - "keyBattery": "2.5" - }, - "packetTag": "0" -} -``` -#### 停止键盘扫描 +## 系统参数 +### 获取 WSCmdApp 版本 + 获取 WSCmdApp 当前版本 发送： +fun: "getSdkVer" // +params:{}//无该值 +packetTag:"1"// -fun: "stopKeyPadScan" //停止扫描 -params:{} //默认空 指令样例： ```json { - "fun": "stopKeyPadScan", - "baseId": 0, - "baseSn":"2023031402", + "fun": "getSdkVer", "packetTag": "1" } ``` -接收： +接收: + +fun: "getSdkVer" // +infos:{ + "value": "5.1.0.01" +} -fun: "stopKeyPadScan" // -baseId: "1"//收到的基站ID -infos:{"state":"OK"}//返回状态,成功为OK 指令样例： ```json { - "fun": "stopKeyPadScan", - "baseId": 1, - "baseSn":"2023031402", + "fun": "getSdkVer", "infos": { - "state": "OK" - }, + "value": "5.1.0.01" + } "packetTag": "1" } ``` - -#### 支持设备说明 - -|基站+键盘|支持/不支持|备注| -|---|---|---| -|B100-2.4G+S6|支持|| -|B200-2.4G+S6|支持|| - - -## 系统参数 - ### 退出WSCmdApp WSCmdApp,WSCmdApp回应后将结束WSCmdApp.exe进程。 diff --git a/通讯协议-SDK应用部分[内部].md b/通讯协议-SDK应用部分[内部].md index deb482a..949c71c 100644 --- a/通讯协议-SDK应用部分[内部].md +++ b/通讯协议-SDK应用部分[内部].md @@ -8,7 +8,7 @@ WSCmdApp协议接口说明
-Ver5.1.8 +Ver5.1.9


@@ -50,6 +50,7 @@ Ver5.1.8 |5.1.6| 2024年02月19日|陈定敏|1. 增加keypadRemoteControl接口
2. 增加举手功能接口| |5.1.7| 2024年04月22日|陈定敏|1. 增加后台签到接口
2. 增加键盘最终提交状态接口| |5.1.8| 2024年07月01日|陈定敏|1. 投票反馈数据增加电池状态| +|5.1.9| 2024年07月19日|陈定敏|1. 增加获取SDK版本接口|
@@ -3088,6 +3089,68 @@ infos:{"keySn": "0112402128"}//返回状态 } ``` +#### 题目类型名称预设[内部使用] +发送： + +fun: "setQuestionTypeName" // +baseId: "1"//收到的基站ID +params:{} //默认空 + +| **Json字段** | **字段含义** | **赋值及含义** | +| --- | --- | --- | +| baseId | 基站ID | 1-32 | +| id | 科目id | 0:清除所有题目类型名称预设
1:题目类型名称1
2:题目类型名称2
3:题目类型名称3
4:题目类型名称4
5:题目类型名称5
6:题目类型名称6| +| name | 科目名称 | 最长10字节 | + +清除所有预设指令样例： +```json +{ + "fun": "setQuestionTypeName", + "baseId": 0, + "baseSn":"2023031402", + "params": { + "id": "0", + "name":"" + }, + "packetTag": "20" +} +``` + +题目类型名称1为“单选题”指令样例： +```json +{ + "fun": "setQuestionTypeName", + "baseId": 0, + "baseSn":"2023031402", + "params": { + "id": "1", + "name":"单选题" + }, + "packetTag": "20" +} +``` + +接收： + +fun: "setQuestionTypeName" // +baseId: "1"//收到的基站ID +infos:{"keySn": "0112402128"}//返回状态 + +指令样例： +```json +{ + "fun": "setQuestionTypeName", + "baseId": 1, + "baseSn":"2023031402", + "infos": { + "keySn": "0112402128", + "state": "OK" + }, + "packetTag": "20" +} +``` + + #### 支持设备说明 | **基站+键盘** | **支持** | **备注** | @@ -6420,7 +6483,24 @@ fun: "keypadHandUp" | B200-2.4G+S7 | 支持 | | #### 遥控键盘关机 +##### 遥控所有键盘关机 +写 +发送： +fun: "remoteKeyShutdown" //遥控键盘关机 +params：{}// +指令样例： +```json +{ + "fun": "remoteKeyShutdown", + "baseId": 1, + "baseSn":"2023031402", + "params": [], + "packetTag": "1" +} +``` + +##### 遥控指定键盘关机 写 发送： fun: "remoteKeyShutdown" //遥控键盘关机 @@ -7075,6 +7155,7 @@ infos:{"state":"OK"}//返回状态,成功为OK | B200-2.4G+S6 | 支持 || + ## 键盘在线信息 ### 自动返回在线信息 @@ -7102,12 +7183,12 @@ infos:{} //数组对象 "infos": [{ "baseId": "1", "keySn": "1837454011", - "ver": "1.0.6" + "keyVer": "1.0.6" }, { "baseId": "1", "keySn": "1837454012", - "ver": "1.0.6" + "keyVer": "1.0.6" } ], "packetTag": "1" @@ -7133,7 +7214,6 @@ params:{ "times":1 //基站扫描键盘时长，单位秒 范围1-10秒 } // - 指令样例： ```json @@ -7149,39 +7229,41 @@ params:{ ``` 接收： -fun: "keypadOnLine" //键盘在线状态 +fun: "answerKeyPadScan" //键盘在线状态 infos:{} //数组对象 | **基站+键盘** | **支持** | **备注** | | --- | --- | --- | |baseId|基站id|keySn键盘所在基站id| |keySn|键盘Sn|| -|keyVer|键盘版本|| -|Volt|键盘电量|T2百分比值，S6无效| + 指令样例： +扫描到的键盘信息指令[这个指令会有多条]： + ```json { - "fun": "keypadOnLine", - "baseId": 0, - "infos": [{ - "baseId": "1", - "keySn": "1837454011", - "ver": "1.0.6", - "hModel": "67", - "Volt": "100" - }, - { - "baseId": "1", - "keySn": "1837454012", - "ver": "1.0.6", - "hModel": "67", - "Volt": "30" - } - ], - "packetTag": "1" + "baseId": 1, + "fun": "answerKeyPadScan", + "infos": { + "keySn": "0112375918" + }, + "packetTag": "0" +} +``` + +接收扫描停止指令： + +```json +{ + "baseId": 1, + "fun": "stopgetKeypadOnLine", + "infos": { + "state": "OK" + }, + "packetTag": "18" } ``` @@ -7190,9 +7272,9 @@ infos:{} //数组对象 | --- | --- | --- | | B100-2.4G+S6 | 支持 |键盘电量：无效| | B200-2.4G+S6 | 支持 |键盘电量：无效| -| B200-5.8G+T2 | 支持 |键盘电量：百分比值| +| B200-5.8G+T2 | 支持 |键盘电量：无效| -### 在线键盘扫描 +### 在线键盘扫描[内部] #### 开始扫描 @@ -7260,7 +7342,7 @@ infos:{ "hModel": "67","keySn":"1479824643","ver":"1.0.0","keyBattery":"2.5"}// "infos": { "hModel": "67", "keySn": "1479824643", - "ver": "1.0.0", + "keyVer": "1.0.0", "keyBattery": "2.5" }, "packetTag": "0" @@ -7314,7 +7396,42 @@ infos:{"state":"OK"}//返回状态,成功为OK ## 系统参数 +### 获取 WSCmdApp 版本 + 获取 WSCmdApp 当前版本 +发送： +fun: "getSdkVer" // +params:{}//无该值 +packetTag:"1"// + +指令样例： + +```json +{ + "fun": "getSdkVer", + "packetTag": "1" +} +``` + +接收: + +fun: "getSdkVer" // +infos:{ + "value": "5.1.0.01" +} + + +指令样例： + +```json +{ + "fun": "getSdkVer", + "infos": { + "value": "5.1.0.01" + } + "packetTag": "1" +} +``` ### 退出WSCmdApp WSCmdApp,WSCmdApp回应后将结束WSCmdApp.exe进程。