Commit 86c254ec31f61396b48cb52cd1c51f4c2dc03fc2

Authored by 刘琴
2 parents 86c8097e 1aaad2f5

Merge branch 'master' of http://120.78.57.84/lee/Protocol

通讯协议-SDK应用部分.md
@@ -8,7 +8,7 @@ WSCmdApp协议接口说明 @@ -8,7 +8,7 @@ WSCmdApp协议接口说明
8 8
9 9
10 <div style="text-align: center;font-size: 30px;"> 10 <div style="text-align: center;font-size: 30px;">
11 -Ver5.1.8 11 +Ver5.1.9
12 </div> 12 </div>
13 <br> 13 <br>
14 <br> 14 <br>
@@ -50,6 +50,7 @@ Ver5.1.8 @@ -50,6 +50,7 @@ Ver5.1.8
50 |5.1.6| 2024年02月19日|陈定敏|1. 增加keypadRemoteControl接口<br>2. 增加举手功能接口| 50 |5.1.6| 2024年02月19日|陈定敏|1. 增加keypadRemoteControl接口<br>2. 增加举手功能接口|
51 |5.1.7| 2024年04月22日|陈定敏|1. 增加后台签到接口<br>2. 增加键盘最终提交状态接口| 51 |5.1.7| 2024年04月22日|陈定敏|1. 增加后台签到接口<br>2. 增加键盘最终提交状态接口|
52 |5.1.8| 2024年07月01日|陈定敏|1. 投票反馈数据增加电池状态| 52 |5.1.8| 2024年07月01日|陈定敏|1. 投票反馈数据增加电池状态|
  53 +|5.1.9| 2024年07月19日|陈定敏|1. 增加获取SDK版本接口|
53 54
54 <br> 55 <br>
55 56
@@ -5308,7 +5309,24 @@ fun: &quot;keypadHandUp&quot; @@ -5308,7 +5309,24 @@ fun: &quot;keypadHandUp&quot;
5308 | B200-2.4G+S7 | 支持 | | 5309 | B200-2.4G+S7 | 支持 | |
5309 5310
5310 #### 遥控键盘关机 5311 #### 遥控键盘关机
  5312 +##### 遥控所有键盘关机
  5313 +写
  5314 +发送:
  5315 +fun: "remoteKeyShutdown" //遥控键盘关机
  5316 +params:{}//
  5317 +指令样例:
  5318 +
  5319 +```json
  5320 +{
  5321 + "fun": "remoteKeyShutdown",
  5322 + "baseId": 1,
  5323 + "baseSn":"2023031402",
  5324 + "params": [],
  5325 + "packetTag": "1"
  5326 +}
  5327 +```
5311 5328
  5329 +##### 遥控指定键盘关机
5312 5330
5313 发送: 5331 发送:
5314 fun: "remoteKeyShutdown" //遥控键盘关机 5332 fun: "remoteKeyShutdown" //遥控键盘关机
@@ -5781,172 +5799,91 @@ params:{ @@ -5781,172 +5799,91 @@ params:{
5781 ``` 5799 ```
5782 5800
5783 接收: 5801 接收:
5784 -fun: "keypadOnLine" //键盘在线状态 5802 +fun: "answerKeyPadScan" //键盘在线状态
5785 infos:{} //数组对象 5803 infos:{} //数组对象
5786 5804
5787 | **基站+键盘** | **支持** | **备注** | 5805 | **基站+键盘** | **支持** | **备注** |
5788 | --- | --- | --- | 5806 | --- | --- | --- |
5789 |baseId|基站id|keySn键盘所在基站id| 5807 |baseId|基站id|keySn键盘所在基站id|
5790 |keySn|键盘Sn|| 5808 |keySn|键盘Sn||
5791 -|keyVer|键盘版本||  
5792 -|Volt|键盘电量|T2百分比值,S6无效|  
5793 5809
5794 5810
5795 -指令样例:  
5796 5811
5797 -```json  
5798 -{  
5799 - "fun": "keypadOnLine",  
5800 - "baseId": 0,  
5801 - "infos": [{  
5802 - "baseId": "1",  
5803 - "keySn": "1837454011",  
5804 - "ver": "1.0.6",  
5805 - "hModel": "67",  
5806 - "Volt": "100"  
5807 - },  
5808 - {  
5809 - "baseId": "1",  
5810 - "keySn": "1837454012",  
5811 - "ver": "1.0.6",  
5812 - "hModel": "67",  
5813 - "Volt": "30"  
5814 - }  
5815 - ],  
5816 - "packetTag": "1"  
5817 -}  
5818 -```  
5819 -  
5820 -支持设备说明  
5821 -| **基站+键盘** | **支持** | **备注** |  
5822 -| --- | --- | --- |  
5823 -| B100-2.4G+S6 | 支持 |键盘电量:无效|  
5824 -| B200-2.4G+S6 | 支持 |键盘电量:无效|  
5825 -| B200-5.8G+T2 | 支持 |键盘电量:百分比值|  
5826 -  
5827 -### 在线键盘扫描  
5828 -  
5829 -#### 开始扫描  
5830 -  
5831 -发送:  
5832 -  
5833 -fun: "startKeyPadScan" //  
5834 -params:{}  
5835 -  
5836 -|**Json字段**|**字段含义**|**赋值及含义**|  
5837 -|---|---|---| 5812 +指令样例:
5838 5813
  5814 +扫描到的键盘信息指令[这个指令会有多条]:
5839 5815
5840 -指令样例:  
5841 ```json 5816 ```json
5842 { 5817 {
5843 - "fun": "startKeyPadScan",  
5844 - "baseId": 0,  
5845 - "baseSn":"2023031402",  
5846 - "params": {},  
5847 - "packetTag": "1" 5818 + "baseId": 1,
  5819 + "fun": "answerKeyPadScan",
  5820 + "infos": {
  5821 + "keySn": "0112375918"
  5822 + },
  5823 + "packetTag": "0"
5848 } 5824 }
5849 ``` 5825 ```
5850 5826
5851 -接收:  
5852 -  
5853 -fun: "startKeyPadScan" //  
5854 -baseId: "1"//接收到指令的基站ID  
5855 -infos:{"state":"OK"}//返回状态,成功为OK  
5856 -  
5857 -指令样例: 5827 +接收扫描停止指令:
5858 5828
5859 ```json 5829 ```json
5860 { 5830 {
5861 - "fun": "startKeyPadScan",  
5862 "baseId": 1, 5831 "baseId": 1,
5863 - "baseSn":"2023031402", 5832 + "fun": "stopgetKeypadOnLine",
5864 "infos": { 5833 "infos": {
5865 "state": "OK" 5834 "state": "OK"
5866 }, 5835 },
5867 - "packetTag": "1" 5836 + "packetTag": "18"
5868 } 5837 }
5869 ``` 5838 ```
5870 5839
5871 -#### 接收作答  
5872 -  
5873 -接收:  
5874 -fun: " answerKeyPadScan"  
5875 -baseId: 1//基站ID  
5876 -infos:{ "hModel": "67","keySn":"1479824643","ver":"1.0.0","keyBattery":"2.5"}//返回键盘反馈模式参数值  
5877 -  
5878 -| **Json字段** | **字段含义** | **赋值及含义** | 5840 +支持设备说明
  5841 +| **基站+键盘** | **支持** | **备注** |
5879 | --- | --- | --- | 5842 | --- | --- | --- |
5880 -|hModel|键盘型号|67: S6-2.4G|  
5881 -|keySn|键盘Sn||  
5882 -|keyVer|键盘版本||  
5883 -|keyBattery|键盘电量|T2百分比值,S6电压值| 5843 +| B100-2.4G+S6 | 支持 |键盘电量:无效|
  5844 +| B200-2.4G+S6 | 支持 |键盘电量:无效|
  5845 +| B200-5.8G+T2 | 支持 |键盘电量:无效|
5884 5846
5885 -指令样例:  
5886 5847
5887 -```json  
5888 -{  
5889 - "fun": "answerKeyPadScan",  
5890 - "baseId": 1,  
5891 - "baseSn":"2023031402",  
5892 - "infos": {  
5893 - "hModel": "67",  
5894 - "keySn": "1479824643",  
5895 - "ver": "1.0.0",  
5896 - "keyBattery": "2.5"  
5897 - },  
5898 - "packetTag": "0"  
5899 -}  
5900 -```  
5901 5848
5902 -#### 停止键盘扫描  
5903 5849
  5850 +## 系统参数
  5851 +### 获取 WSCmdApp 版本
  5852 + 获取 WSCmdApp 当前版本
5904 发送: 5853 发送:
  5854 +fun: "getSdkVer" //
  5855 +params:{}//无该值
  5856 +packetTag:"1"//
5905 5857
5906 -fun: "stopKeyPadScan" //停止扫描  
5907 -params:{} //默认空  
5908 5858
5909 指令样例: 5859 指令样例:
5910 5860
5911 ```json 5861 ```json
5912 { 5862 {
5913 - "fun": "stopKeyPadScan",  
5914 - "baseId": 0,  
5915 - "baseSn":"2023031402", 5863 + "fun": "getSdkVer",
5916 "packetTag": "1" 5864 "packetTag": "1"
5917 } 5865 }
5918 ``` 5866 ```
5919 5867
5920 -接收: 5868 +接收:
  5869 +
  5870 +fun: "getSdkVer" //
  5871 +infos:{
  5872 + "value": "5.1.0.01"
  5873 +}
5921 5874
5922 -fun: "stopKeyPadScan" //  
5923 -baseId: "1"//收到的基站ID  
5924 -infos:{"state":"OK"}//返回状态,成功为OK  
5925 5875
5926 指令样例: 5876 指令样例:
5927 5877
5928 ```json 5878 ```json
5929 { 5879 {
5930 - "fun": "stopKeyPadScan",  
5931 - "baseId": 1,  
5932 - "baseSn":"2023031402", 5880 + "fun": "getSdkVer",
5933 "infos": { 5881 "infos": {
5934 - "state": "OK"  
5935 - }, 5882 + "value": "5.1.0.01"
  5883 + }
5936 "packetTag": "1" 5884 "packetTag": "1"
5937 } 5885 }
5938 ``` 5886 ```
5939 -  
5940 -#### 支持设备说明  
5941 -  
5942 -|基站+键盘|支持/不支持|备注|  
5943 -|---|---|---|  
5944 -|B100-2.4G+S6|支持||  
5945 -|B200-2.4G+S6|支持||  
5946 -  
5947 -  
5948 -## 系统参数  
5949 -  
5950 ### 退出WSCmdApp 5887 ### 退出WSCmdApp
5951 5888
5952 WSCmdApp,WSCmdApp回应后将结束WSCmdApp.exe进程。 5889 WSCmdApp,WSCmdApp回应后将结束WSCmdApp.exe进程。
通讯协议-SDK应用部分[内部].md
@@ -8,7 +8,7 @@ WSCmdApp协议接口说明 @@ -8,7 +8,7 @@ WSCmdApp协议接口说明
8 8
9 9
10 <div style="text-align: center;font-size: 30px;"> 10 <div style="text-align: center;font-size: 30px;">
11 -Ver5.1.8 11 +Ver5.1.9
12 </div> 12 </div>
13 <br> 13 <br>
14 <br> 14 <br>
@@ -50,6 +50,7 @@ Ver5.1.8 @@ -50,6 +50,7 @@ Ver5.1.8
50 |5.1.6| 2024年02月19日|陈定敏|1. 增加keypadRemoteControl接口<br>2. 增加举手功能接口| 50 |5.1.6| 2024年02月19日|陈定敏|1. 增加keypadRemoteControl接口<br>2. 增加举手功能接口|
51 |5.1.7| 2024年04月22日|陈定敏|1. 增加后台签到接口<br>2. 增加键盘最终提交状态接口| 51 |5.1.7| 2024年04月22日|陈定敏|1. 增加后台签到接口<br>2. 增加键盘最终提交状态接口|
52 |5.1.8| 2024年07月01日|陈定敏|1. 投票反馈数据增加电池状态| 52 |5.1.8| 2024年07月01日|陈定敏|1. 投票反馈数据增加电池状态|
  53 +|5.1.9| 2024年07月19日|陈定敏|1. 增加获取SDK版本接口|
53 54
54 <br> 55 <br>
55 56
@@ -3088,6 +3089,68 @@ infos:{&quot;keySn&quot;: &quot;0112402128&quot;}//返回状态 @@ -3088,6 +3089,68 @@ infos:{&quot;keySn&quot;: &quot;0112402128&quot;}//返回状态
3088 } 3089 }
3089 ``` 3090 ```
3090 3091
  3092 +#### 题目类型名称预设[内部使用]
  3093 +发送:
  3094 +
  3095 +fun: "setQuestionTypeName" //
  3096 +baseId: "1"//收到的基站ID
  3097 +params:{} //默认空
  3098 +
  3099 +| **Json字段** | **字段含义** | **赋值及含义** |
  3100 +| --- | --- | --- |
  3101 +| baseId | 基站ID | 1-32 |
  3102 +| id | 科目id | 0:清除所有题目类型名称预设<br>1:题目类型名称1<br>2:题目类型名称2<br>3:题目类型名称3<br>4:题目类型名称4<br>5:题目类型名称5<br>6:题目类型名称6|
  3103 +| name | 科目名称 | 最长10字节 |
  3104 +
  3105 +清除所有预设指令样例:
  3106 +```json
  3107 +{
  3108 + "fun": "setQuestionTypeName",
  3109 + "baseId": 0,
  3110 + "baseSn":"2023031402",
  3111 + "params": {
  3112 + "id": "0",
  3113 + "name":""
  3114 + },
  3115 + "packetTag": "20"
  3116 +}
  3117 +```
  3118 +
  3119 +题目类型名称1为“单选题”指令样例:
  3120 +```json
  3121 +{
  3122 + "fun": "setQuestionTypeName",
  3123 + "baseId": 0,
  3124 + "baseSn":"2023031402",
  3125 + "params": {
  3126 + "id": "1",
  3127 + "name":"单选题"
  3128 + },
  3129 + "packetTag": "20"
  3130 +}
  3131 +```
  3132 +
  3133 +接收:
  3134 +
  3135 +fun: "setQuestionTypeName" //
  3136 +baseId: "1"//收到的基站ID
  3137 +infos:{"keySn": "0112402128"}//返回状态
  3138 +
  3139 +指令样例:
  3140 +```json
  3141 +{
  3142 + "fun": "setQuestionTypeName",
  3143 + "baseId": 1,
  3144 + "baseSn":"2023031402",
  3145 + "infos": {
  3146 + "keySn": "0112402128",
  3147 + "state": "OK"
  3148 + },
  3149 + "packetTag": "20"
  3150 +}
  3151 +```
  3152 +
  3153 +
3091 #### 支持设备说明 3154 #### 支持设备说明
3092 3155
3093 | **基站+键盘** | **支持** | **备注** | 3156 | **基站+键盘** | **支持** | **备注** |
@@ -6420,7 +6483,24 @@ fun: &quot;keypadHandUp&quot; @@ -6420,7 +6483,24 @@ fun: &quot;keypadHandUp&quot;
6420 | B200-2.4G+S7 | 支持 | | 6483 | B200-2.4G+S7 | 支持 | |
6421 6484
6422 #### 遥控键盘关机 6485 #### 遥控键盘关机
  6486 +##### 遥控所有键盘关机
  6487 +写
  6488 +发送:
  6489 +fun: "remoteKeyShutdown" //遥控键盘关机
  6490 +params:{}//
  6491 +指令样例:
6423 6492
  6493 +```json
  6494 +{
  6495 + "fun": "remoteKeyShutdown",
  6496 + "baseId": 1,
  6497 + "baseSn":"2023031402",
  6498 + "params": [],
  6499 + "packetTag": "1"
  6500 +}
  6501 +```
  6502 +
  6503 +##### 遥控指定键盘关机
6424 6504
6425 发送: 6505 发送:
6426 fun: "remoteKeyShutdown" //遥控键盘关机 6506 fun: "remoteKeyShutdown" //遥控键盘关机
@@ -7075,6 +7155,7 @@ infos:{&quot;state&quot;:&quot;OK&quot;}//返回状态,成功为OK @@ -7075,6 +7155,7 @@ infos:{&quot;state&quot;:&quot;OK&quot;}//返回状态,成功为OK
7075 | B200-2.4G+S6 | 支持 || 7155 | B200-2.4G+S6 | 支持 ||
7076 7156
7077 7157
  7158 +
7078 ## 键盘在线信息 7159 ## 键盘在线信息
7079 7160
7080 ### 自动返回在线信息 7161 ### 自动返回在线信息
@@ -7102,12 +7183,12 @@ infos:{} //数组对象 @@ -7102,12 +7183,12 @@ infos:{} //数组对象
7102 "infos": [{ 7183 "infos": [{
7103 "baseId": "1", 7184 "baseId": "1",
7104 "keySn": "1837454011", 7185 "keySn": "1837454011",
7105 - "ver": "1.0.6" 7186 + "keyVer": "1.0.6"
7106 }, 7187 },
7107 { 7188 {
7108 "baseId": "1", 7189 "baseId": "1",
7109 "keySn": "1837454012", 7190 "keySn": "1837454012",
7110 - "ver": "1.0.6" 7191 + "keyVer": "1.0.6"
7111 } 7192 }
7112 ], 7193 ],
7113 "packetTag": "1" 7194 "packetTag": "1"
@@ -7133,7 +7214,6 @@ params:{ @@ -7133,7 +7214,6 @@ params:{
7133 "times":1 //基站扫描键盘时长,单位秒 范围1-10秒 7214 "times":1 //基站扫描键盘时长,单位秒 范围1-10秒
7134 } // 7215 } //
7135 7216
7136 -  
7137 指令样例: 7217 指令样例:
7138 7218
7139 ```json 7219 ```json
@@ -7149,39 +7229,41 @@ params:{ @@ -7149,39 +7229,41 @@ params:{
7149 ``` 7229 ```
7150 7230
7151 接收: 7231 接收:
7152 -fun: "keypadOnLine" //键盘在线状态 7232 +fun: "answerKeyPadScan" //键盘在线状态
7153 infos:{} //数组对象 7233 infos:{} //数组对象
7154 7234
7155 | **基站+键盘** | **支持** | **备注** | 7235 | **基站+键盘** | **支持** | **备注** |
7156 | --- | --- | --- | 7236 | --- | --- | --- |
7157 |baseId|基站id|keySn键盘所在基站id| 7237 |baseId|基站id|keySn键盘所在基站id|
7158 |keySn|键盘Sn|| 7238 |keySn|键盘Sn||
7159 -|keyVer|键盘版本||  
7160 -|Volt|键盘电量|T2百分比值,S6无效| 7239 +
7161 7240
7162 7241
7163 指令样例: 7242 指令样例:
7164 7243
  7244 +扫描到的键盘信息指令[这个指令会有多条]:
  7245 +
7165 ```json 7246 ```json
7166 { 7247 {
7167 - "fun": "keypadOnLine",  
7168 - "baseId": 0,  
7169 - "infos": [{  
7170 - "baseId": "1",  
7171 - "keySn": "1837454011",  
7172 - "ver": "1.0.6",  
7173 - "hModel": "67",  
7174 - "Volt": "100"  
7175 - },  
7176 - {  
7177 - "baseId": "1",  
7178 - "keySn": "1837454012",  
7179 - "ver": "1.0.6",  
7180 - "hModel": "67",  
7181 - "Volt": "30"  
7182 - }  
7183 - ],  
7184 - "packetTag": "1" 7248 + "baseId": 1,
  7249 + "fun": "answerKeyPadScan",
  7250 + "infos": {
  7251 + "keySn": "0112375918"
  7252 + },
  7253 + "packetTag": "0"
  7254 +}
  7255 +```
  7256 +
  7257 +接收扫描停止指令:
  7258 +
  7259 +```json
  7260 +{
  7261 + "baseId": 1,
  7262 + "fun": "stopgetKeypadOnLine",
  7263 + "infos": {
  7264 + "state": "OK"
  7265 + },
  7266 + "packetTag": "18"
7185 } 7267 }
7186 ``` 7268 ```
7187 7269
@@ -7190,9 +7272,9 @@ infos:{} //数组对象 @@ -7190,9 +7272,9 @@ infos:{} //数组对象
7190 | --- | --- | --- | 7272 | --- | --- | --- |
7191 | B100-2.4G+S6 | 支持 |键盘电量:无效| 7273 | B100-2.4G+S6 | 支持 |键盘电量:无效|
7192 | B200-2.4G+S6 | 支持 |键盘电量:无效| 7274 | B200-2.4G+S6 | 支持 |键盘电量:无效|
7193 -| B200-5.8G+T2 | 支持 |键盘电量:百分比值| 7275 +| B200-5.8G+T2 | 支持 |键盘电量:无效|
7194 7276
7195 -### 在线键盘扫描 7277 +### 在线键盘扫描[内部]
7196 7278
7197 #### 开始扫描 7279 #### 开始扫描
7198 7280
@@ -7260,7 +7342,7 @@ infos:{ &quot;hModel&quot;: &quot;67&quot;,&quot;keySn&quot;:&quot;1479824643&quot;,&quot;ver&quot;:&quot;1.0.0&quot;,&quot;keyBattery&quot;:&quot;2.5&quot;}// @@ -7260,7 +7342,7 @@ infos:{ &quot;hModel&quot;: &quot;67&quot;,&quot;keySn&quot;:&quot;1479824643&quot;,&quot;ver&quot;:&quot;1.0.0&quot;,&quot;keyBattery&quot;:&quot;2.5&quot;}//
7260 "infos": { 7342 "infos": {
7261 "hModel": "67", 7343 "hModel": "67",
7262 "keySn": "1479824643", 7344 "keySn": "1479824643",
7263 - "ver": "1.0.0", 7345 + "keyVer": "1.0.0",
7264 "keyBattery": "2.5" 7346 "keyBattery": "2.5"
7265 }, 7347 },
7266 "packetTag": "0" 7348 "packetTag": "0"
@@ -7314,7 +7396,42 @@ infos:{&quot;state&quot;:&quot;OK&quot;}//返回状态,成功为OK @@ -7314,7 +7396,42 @@ infos:{&quot;state&quot;:&quot;OK&quot;}//返回状态,成功为OK
7314 7396
7315 7397
7316 ## 系统参数 7398 ## 系统参数
  7399 +### 获取 WSCmdApp 版本
  7400 + 获取 WSCmdApp 当前版本
  7401 +发送:
  7402 +fun: "getSdkVer" //
  7403 +params:{}//无该值
  7404 +packetTag:"1"//
7317 7405
  7406 +
  7407 +指令样例:
  7408 +
  7409 +```json
  7410 +{
  7411 + "fun": "getSdkVer",
  7412 + "packetTag": "1"
  7413 +}
  7414 +```
  7415 +
  7416 +接收:
  7417 +
  7418 +fun: "getSdkVer" //
  7419 +infos:{
  7420 + "value": "5.1.0.01"
  7421 +}
  7422 +
  7423 +
  7424 +指令样例:
  7425 +
  7426 +```json
  7427 +{
  7428 + "fun": "getSdkVer",
  7429 + "infos": {
  7430 + "value": "5.1.0.01"
  7431 + }
  7432 + "packetTag": "1"
  7433 +}
  7434 +```
7318 ### 退出WSCmdApp 7435 ### 退出WSCmdApp
7319 7436
7320 WSCmdApp,WSCmdApp回应后将结束WSCmdApp.exe进程。 7437 WSCmdApp,WSCmdApp回应后将结束WSCmdApp.exe进程。