李外 / Protocol

Commit e2e2d457df9cd790e44feba83d0cd6c1b349e2f7

Authored by DMchen
1 parent ad44b4cc

1.SDK应用部分，初版，已经内部核对一次。

Inline Side-by-side
Showing 2 changed files with 39 additions and 41 deletions
通讯协议-SDK应用部分.md
  View file @e2e2d45
... ... @@ -80,7 +80,7 @@ WSCmdApp程序中config.ini配置文件中可设置WebSocket的端口，见以
80 80  
81 81 应用程序和WSCmdApp之间采用Json数据通信，通信的基本格式如下：
82 82  
83   -下发：应用程序 - \> WSCmdApp
  83 +下发：应用程序 -> WSCmdApp
84 84  
85 85 ```json
86 86 {
... ... @@ -492,7 +492,7 @@ params：{}
492 492 | options | 固定值 | 固定值10|
493 493 | optionalN | 可选数字 | 1≤N≤10 (指定位数才需要设置, 10为0) |
494 494 | 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 |
495   -| tipTitle | 提示标题 | 16个字节 |
  495 +| tipTitle | 提示标题 | 字符串，长度最多不超过16个字节|
496 496  
497 497  
498 498 指令样例：
... ... @@ -601,11 +601,10 @@ params：{}
601 601 |optionsMode|选项类别|1:显示字母(默认值) </br>2:显示数字 |
602 602 |secrecyMode|保密模式|0:不保密(默认值)</br>1:保密 |
603 603 |modifyMode|修改模式|0:不可修改 </br>1:可以修改(默认值) |
604   -| modifyMode | 修改模式 | 0:不可修改</br>1:可以修改(默认值)|
605   -| lessMode | 迫选模式 | 0:可缺选(默认值) </br>1:不可缺选</br>2:允许重复输入</br>3:允许重复输入且不可缺选 |
606   -| options | 选项数目 | 1≤M≤10(默认值4) |
607   -| optionalN | 可选项数 | 1≤N≤M(默认值1) |
608   -| tipTitle | 提示标题 | 16个字节 |
  604 +|lessMode|迫选模式| 0:可缺选(默认值) </br>1:不可缺选</br>2:允许重复输入</br>3:允许重复输入且不可缺选 |
  605 +| options|选项数目|1≤M≤10(默认值4)|
  606 +| optionalN|可选项数|1≤N≤M(默认值1)|
  607 +| tipTitle|提示标题|字符串，长度最多不超过16个字节|
609 608  
610 609  
611 610 指令样例：
... ... @@ -733,7 +732,7 @@ params：{}
733 732 | optionsMode | 选项类别 | 1:True/False 对/错 </br>2:Yes/No 是/否</br> 3:√/×|
734 733 | secrecyMode | 保密模式 | 0:不保密(默认值) </br> 1:保密|
735 734 | modifyMode | 修改模式 | 0:不可修改</br>1:可以修改(默认值)|
736   -| tipTitle | 提示标题 | 16个字节|
  735 +| tipTitle | 提示标题 | 字符串，长度最多不超过16个字节|
737 736  
738 737  
739 738 指令样例：
... ... @@ -861,7 +860,7 @@ params：{}
861 860 |lessMode| 预留|0|
862 861 |questionNumber|题目个数|1\~10 (默认值10)|
863 862 |options|选项数目|1~10 (单选题有效, 默认值4)|
864   -|tipTitle|提示标题|16个字节|
  863 +|tipTitle|提示标题|字符串，长度最多不超过16个字节|
865 864  
866 865 指令样例：
867 866 ```json
... ... @@ -985,8 +984,7 @@ params：{}
985 984 |submitTimes|提交次数|0 (0：不限制, 默认值0)|
986 985 |recordingTimeLimit|预留|0|
987 986 |recordingFormat|预留|0:固定传0|
988   -|recordAudioFormat|音频格式|0:mp3<br>1:实时流(默认值1)|
989   -|tipTitle|提示标题|16个字节|
  987 +|recordAudioFormat|音频格式|0:mp3(默认值)<br>1:实时流|
990 988  
991 989  
992 990 指令样例：
... ... @@ -1147,8 +1145,8 @@ infos:{&quot;state&quot;:&quot;OK&quot;}//返回状态,成功为OK
1147 1145 接收：
1148 1146  
1149 1147 fun: "voicePacketLossInfo" //丢包信息
1150   -baseId:1 //1\~32,连接基站
1151   -infos:{} //
  1148 +baseId:1 //1~32,连接基站
  1149 +infos:{} //
1152 1150  
1153 1151 |Json字段|字段含义|赋值及含义|
1154 1152 |---|---|---|
... ... @@ -1254,7 +1252,7 @@ infos: {}
1254 1252 "infos": {
1255 1253 "time": "1.42",
1256 1254 "keySn": "1479824643",
1257   - "keyValue": "A"
  1255 + "keyValue": "1"
1258 1256 },
1259 1257 "packetTag": "1"
1260 1258 }
... ... @@ -1318,9 +1316,9 @@ params：{}
1318 1316 |modifyMode|修改模式|0:不可修改<br>1:可以修改(默认值)|
1319 1317 |aswOption|按键模式|0:无规则 （S6最多16位，T2最多14位）<br>1:预留<br>2:预留<br>3:带小数位上下限（T2不支持）|
1320 1318 |digits|小数位数|0:没有小数点<br>1:一位小数点<br>2:二位小数点|
1321   -|numMin|下限|0-655.35|
1322   -|numMax|上限|0-655.35|
1323   -|tipTitle|提示标题|16个字节|
  1319 +|numMin|下限|digits=0 范围：0~65535 <br> digits=1 范围：0~6553 <br> digits=2 范围：0~655|
  1320 +|numMax|上限|digits=0 范围：0~65535 <br> digits=1 范围：0~6553 <br> digits=2 范围：0~655|
  1321 +|tipTitle|提示标题|字符串，长度最多不超过16个字节|
1324 1322  
1325 1323  
1326 1324  
... ... @@ -3592,7 +3590,8 @@ infos:{&quot;state&quot;:&quot;OK&quot;}//返回状态,成功为OK
3592 3590 }
3593 3591 ```
3594 3592  
3595   -##### 支持设备说明
  3593 +#####支持设备说明
  3594 +
3596 3595 | **基站+键盘** | **支持** | **备注** |
3597 3596 | --- | --- | --- |
3598 3597 | B100-2.4G+S6 | 支持 ||
... ...
通讯协议-SDK应用部分[内部].md
  View file @e2e2d45
... ... @@ -54,7 +54,7 @@ Ver5.1.1
54 54 WSCmdApp
55 55 无线反馈系统是由手持的键盘、通讯基站、WSCmdApp（控制台程序）、控制电脑组成的。控制电脑通过USB接口与基站连接。控制指令由控制电脑通过基站发送给键盘。
56 56  
57   -WSCmdApp可以让用户开发的应用程序与无线反馈系统通讯。WSCmdApp控制台程序（下文用WSCmdApp代替）提供websocket通讯方式，使用JSON通信格式，来实现互动系统的管理及投票指令的发送和接收功能。调用结构图如下：![](img/image1.png)
  57 +WSCmdApp可以让用户开发的应用程序与WSCmdApp无线反馈系统通讯。WSCmdApp控制台程序（下文用WSCmdApp代替）提供websocket通讯方式，使用JSON通信格式，来实现互动系统的管理及投票指令的发送和接收功能。调用结构图如下：![](img/image1.png)
58 58  
59 59 如果用户想开发互联网应用，可以参考如下设计：
60 60  
... ... @@ -80,7 +80,7 @@ WSCmdApp程序中config.ini配置文件中可设置WebSocket的端口，见以
80 80  
81 81 应用程序和WSCmdApp之间采用Json数据通信，通信的基本格式如下：
82 82  
83   -下发：应用程序 - > WSCmdApp
  83 +下发：应用程序 -> WSCmdApp
84 84  
85 85 ```json
86 86 {
... ... @@ -371,7 +371,7 @@ params:{} //无该值
371 371 指令样例：
372 372  
373 373 ```json
374   -{ 
  374 +{       
375 375 "keySnList": [{            
376 376 "keySn": "1837454011"        
377 377 }, {            
... ... @@ -426,7 +426,7 @@ params:{} //为空
426 426 指令样例：
427 427  
428 428 ```json
429   -{
  429 +{       
430 430 "keySnList": [{            
431 431 "keySn": "1837454011"        
432 432 }, {            
... ... @@ -492,7 +492,7 @@ params：{}
492 492 | options | 固定值 | 固定值10|
493 493 | optionalN | 可选数字 | 1≤N≤10 (指定位数才需要设置, 10为0) |
494 494 | 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 |
495   -| tipTitle | 提示标题 | 16个字节 |
  495 +| tipTitle | 提示标题 | 字符串，长度最多不超过16个字节|
496 496  
497 497  
498 498 指令样例：
... ... @@ -601,11 +601,10 @@ params：{}
601 601 |optionsMode|选项类别|1:显示字母(默认值) </br>2:显示数字 |
602 602 |secrecyMode|保密模式|0:不保密(默认值)</br>1:保密 |
603 603 |modifyMode|修改模式|0:不可修改 </br>1:可以修改(默认值) |
604   -| modifyMode | 修改模式 | 0:不可修改</br>1:可以修改(默认值)|
605   -| lessMode | 迫选模式 | 0:可缺选(默认值) </br>1:不可缺选</br>2:允许重复输入</br>3:允许重复输入且不可缺选 |
606   -| options | 选项数目 | 1≤M≤10(默认值4) |
607   -| optionalN | 可选项数 | 1≤N≤M(默认值1) |
608   -| tipTitle | 提示标题 | 16个字节 |
  604 +|lessMode|迫选模式| 0:可缺选(默认值) </br>1:不可缺选</br>2:允许重复输入</br>3:允许重复输入且不可缺选 |
  605 +| options|选项数目|1≤M≤10(默认值4)|
  606 +| optionalN|可选项数|1≤N≤M(默认值1)|
  607 +| tipTitle|提示标题|字符串，长度最多不超过16个字节|
609 608  
610 609  
611 610 指令样例：
... ... @@ -733,7 +732,7 @@ params：{}
733 732 | optionsMode | 选项类别 | 1:True/False 对/错 </br>2:Yes/No 是/否</br> 3:√/×|
734 733 | secrecyMode | 保密模式 | 0:不保密(默认值) </br> 1:保密|
735 734 | modifyMode | 修改模式 | 0:不可修改</br>1:可以修改(默认值)|
736   -| tipTitle | 提示标题 | 16个字节|
  735 +| tipTitle | 提示标题 | 字符串，长度最多不超过16个字节|
737 736  
738 737  
739 738 指令样例：
... ... @@ -861,7 +860,7 @@ params：{}
861 860 |lessMode| 预留|0|
862 861 |questionNumber|题目个数|1\~10 (默认值10)|
863 862 |options|选项数目|1~10 (单选题有效, 默认值4)|
864   -|tipTitle|提示标题|16个字节|
  863 +|tipTitle|提示标题|字符串，长度最多不超过16个字节|
865 864  
866 865 指令样例：
867 866 ```json
... ... @@ -985,8 +984,7 @@ params：{}
985 984 |submitTimes|提交次数|0 (0：不限制, 默认值0)|
986 985 |recordingTimeLimit|预留|0|
987 986 |recordingFormat|预留|0:固定传0|
988   -|recordAudioFormat|音频格式|0:mp3<br>1:实时流(默认值1)|
989   -|tipTitle|提示标题|16个字节|
  987 +|recordAudioFormat|音频格式|0:mp3(默认值)<br>1:实时流|
990 988  
991 989  
992 990 指令样例：
... ... @@ -1100,7 +1098,7 @@ infos: {}
1100 1098  
1101 1099 #### 回传分数
1102 1100  
1103   -收到语音后，可对评测分数回传给键盘，详见[自定义信息](\l)
  1101 +收到语音后，可对评测分数回传给键盘，详见[自定义信息]
1104 1102  
1105 1103 #### 停止作答
1106 1104  
... ... @@ -1147,8 +1145,8 @@ infos:{&quot;state&quot;:&quot;OK&quot;}//返回状态,成功为OK
1147 1145 接收：
1148 1146  
1149 1147 fun: "voicePacketLossInfo" //丢包信息
1150   -baseId:1 //1\~32,连接基站
1151   -infos:{} //
  1148 +baseId:1 //1~32,连接基站
  1149 +infos:{} //
1152 1150  
1153 1151 |Json字段|字段含义|赋值及含义|
1154 1152 |---|---|---|
... ... @@ -1254,7 +1252,7 @@ infos: {}
1254 1252 "infos": {
1255 1253 "time": "1.42",
1256 1254 "keySn": "1479824643",
1257   - "keyValue": "A"
  1255 + "keyValue": "1"
1258 1256 },
1259 1257 "packetTag": "1"
1260 1258 }
... ... @@ -1318,9 +1316,9 @@ params：{}
1318 1316 |modifyMode|修改模式|0:不可修改<br>1:可以修改(默认值)|
1319 1317 |aswOption|按键模式|0:无规则 （S6最多16位，T2最多14位）<br>1:预留<br>2:预留<br>3:带小数位上下限（T2不支持）|
1320 1318 |digits|小数位数|0:没有小数点<br>1:一位小数点<br>2:二位小数点|
1321   -|numMin|下限|0-655.35|
1322   -|numMax|上限|0-655.35|
1323   -|tipTitle|提示标题|16个字节|
  1319 +|numMin|下限|digits=0 范围：0~65535 <br> digits=1 范围：0~6553 <br> digits=2 范围：0~655|
  1320 +|numMax|上限|digits=0 范围：0~65535 <br> digits=1 范围：0~6553 <br> digits=2 范围：0~655|
  1321 +|tipTitle|提示标题|字符串，长度最多不超过16个字节|
1324 1322  
1325 1323  
1326 1324  
... ... @@ -3958,7 +3956,8 @@ infos:{&quot;state&quot;:&quot;OK&quot;}//返回状态,成功为OK
3958 3956 }
3959 3957 ```
3960 3958  
3961   -##### 支持设备说明
  3959 +#####支持设备说明
  3960 +
3962 3961 | **基站+键盘** | **支持** | **备注** |
3963 3962 | --- | --- | --- |
3964 3963 | B100-2.4G+S6 | 支持 ||
... ... @@ -5361,7 +5360,7 @@ infos:{}//数组对象,同发送的
5361 5360  
5362 5361 ## 键盘显示设置
5363 5362  
5364   -注：返回指令中的\"baseId\":0, 可忽略不处理
  5363 +注：返回指令中的"baseId":0, 可忽略不处理
5365 5364  
5366 5365 ### 空闲标题
5367 5366  
... ...