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

DMchen
1 parent ad44b4cc
Showing 2 changed files with 39 additions and 41 deletions
通讯协议-SDK应用部分.md
通讯协议-SDK应用部分[内部].md
@@ -80,7 +80,7 @@ WSCmdApp程序中config.ini配置文件中可设置WebSocket的端口，见以
 应用程序和WSCmdApp之间采用Json数据通信，通信的基本格式如下：
-下发：应用程序 - \> WSCmdApp
+下发：应用程序 -> WSCmdApp
 ```json
 {
@@ -492,7 +492,7 @@ params：{}
 | options        | 固定值       | 固定值10|
 | optionalN      | 可选数字     | 1≤N≤10 (指定位数才需要设置, 10为0)  |
 | 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 |
-| tipTitle       | 提示标题     | 16个字节                            |
+| tipTitle       | 提示标题     | 字符串，长度最多不超过16个字节|
 指令样例：
@@ -601,11 +601,10 @@ params：{}
 |optionsMode|选项类别|1:显示字母(默认值) </br>2:显示数字 |
 |secrecyMode|保密模式|0:不保密(默认值)</br>1:保密 |
 |modifyMode|修改模式|0:不可修改  </br>1:可以修改(默认值) |
-| modifyMode      | 修改模式     | 0:不可修改</br>1:可以修改(默认值)|
-| lessMode        | 迫选模式     | 0:可缺选(默认值) </br>1:不可缺选</br>2:允许重复输入</br>3:允许重复输入且不可缺选 |
-| options         | 选项数目     | 1≤M≤10(默认值4)                     |
-| optionalN       | 可选项数     | 1≤N≤M(默认值1)                      |
-| tipTitle        | 提示标题     | 16个字节                            |
+|lessMode|迫选模式| 0:可缺选(默认值) </br>1:不可缺选</br>2:允许重复输入</br>3:允许重复输入且不可缺选 |
+| options|选项数目|1≤M≤10(默认值4)|
+| optionalN|可选项数|1≤N≤M(默认值1)|
+| tipTitle|提示标题|字符串，长度最多不超过16个字节|
 指令样例：
@@ -733,7 +732,7 @@ params：{}
 | optionsMode    | 选项类别     | 1:True/False 对/错 </br>2:Yes/No 是/否</br> 3:√/×|
 | secrecyMode    | 保密模式     | 0:不保密(默认值) </br> 1:保密|
 | modifyMode     | 修改模式     | 0:不可修改</br>1:可以修改(默认值)|
-| tipTitle       | 提示标题     | 16个字节|
+| tipTitle       | 提示标题     | 字符串，长度最多不超过16个字节|
 指令样例：
@@ -861,7 +860,7 @@ params：{}
 |lessMode| 预留|0|
 |questionNumber|题目个数|1\~10 (默认值10)|
 |options|选项数目|1~10 (单选题有效, 默认值4)|
-|tipTitle|提示标题|16个字节|
+|tipTitle|提示标题|字符串，长度最多不超过16个字节|
 指令样例：
 ```json
@@ -985,8 +984,7 @@ params：{}
 |submitTimes|提交次数|0 (0：不限制, 默认值0)|
 |recordingTimeLimit|预留|0|
 |recordingFormat|预留|0:固定传0|
-|recordAudioFormat|音频格式|0:mp3<br>1:实时流(默认值1)|
-|tipTitle|提示标题|16个字节|
+|recordAudioFormat|音频格式|0:mp3(默认值)<br>1:实时流|
 指令样例：
@@ -1147,8 +1145,8 @@ infos:{&quot;state&quot;:&quot;OK&quot;}//返回状态,成功为OK
 接收：
 fun: "voicePacketLossInfo" //丢包信息
-baseId:1 //1\~32,连接基站
-infos:{} //
+baseId:1 	//1~32,连接基站
+infos:{} 	//
 |Json字段|字段含义|赋值及含义|
 |---|---|---|
@@ -1254,7 +1252,7 @@ infos: {}
 	"infos": {
 		"time": "1.42",
 		"keySn": "1479824643",
-		"keyValue": "A"
+		"keyValue": "1"
 	},
 	"packetTag": "1"
 }
@@ -1318,9 +1316,9 @@ params：{}
 |modifyMode|修改模式|0:不可修改<br>1:可以修改(默认值)|
 |aswOption|按键模式|0:无规则 （S6最多16位，T2最多14位）<br>1:预留<br>2:预留<br>3:带小数位上下限（T2不支持）|
 |digits|小数位数|0:没有小数点<br>1:一位小数点<br>2:二位小数点|
-|numMin|下限|0-655.35|
-|numMax|上限|0-655.35|
-|tipTitle|提示标题|16个字节|
+|numMin|下限|digits=0 范围：0~65535 <br> digits=1 范围：0~6553 <br> digits=2 范围：0~655|
+|numMax|上限|digits=0 范围：0~65535 <br> digits=1 范围：0~6553 <br> digits=2 范围：0~655|
+|tipTitle|提示标题|字符串，长度最多不超过16个字节|
@@ -3592,7 +3590,8 @@ infos:{&quot;state&quot;:&quot;OK&quot;}//返回状态,成功为OK
 }
 ```
-##### 支持设备说明
+#####支持设备说明
+
 | **基站+键盘** | **支持** | **备注** |
 | --- | --- | --- |
 | B100-2.4G+S6  | 支持 || 
@@ -54,7 +54,7 @@ Ver5.1.1
 WSCmdApp
 无线反馈系统是由手持的键盘、通讯基站、WSCmdApp（控制台程序）、控制电脑组成的。控制电脑通过USB接口与基站连接。控制指令由控制电脑通过基站发送给键盘。
-WSCmdApp可以让用户开发的应用程序与无线反馈系统通讯。WSCmdApp控制台程序（下文用WSCmdApp代替）提供websocket通讯方式，使用JSON通信格式，来实现互动系统的管理及投票指令的发送和接收功能。调用结构图如下：![](img/image1.png)
+WSCmdApp可以让用户开发的应用程序与WSCmdApp无线反馈系统通讯。WSCmdApp控制台程序（下文用WSCmdApp代替）提供websocket通讯方式，使用JSON通信格式，来实现互动系统的管理及投票指令的发送和接收功能。调用结构图如下：![](img/image1.png)
 如果用户想开发互联网应用，可以参考如下设计：
@@ -80,7 +80,7 @@ WSCmdApp程序中config.ini配置文件中可设置WebSocket的端口，见以
 应用程序和WSCmdApp之间采用Json数据通信，通信的基本格式如下：
-下发：应用程序 - > WSCmdApp
+下发：应用程序 -> WSCmdApp
 ```json
 {
@@ -371,7 +371,7 @@ params:{} //无该值
 指令样例：
 ```json
-{ 
+{       
 	"keySnList": [{            
 		"keySn": "1837454011"        
 	}, {            
@@ -426,7 +426,7 @@ params:{} //为空
 指令样例：
 ```json
-{
+{       
 	"keySnList": [{            
 		"keySn": "1837454011"        
 	}, {            
@@ -492,7 +492,7 @@ params：{}
 | options        | 固定值       | 固定值10|
 | optionalN      | 可选数字     | 1≤N≤10 (指定位数才需要设置, 10为0)  |
 | 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 |
-| tipTitle       | 提示标题     | 16个字节                            |
+| tipTitle       | 提示标题     | 字符串，长度最多不超过16个字节|
 指令样例：
@@ -601,11 +601,10 @@ params：{}
 |optionsMode|选项类别|1:显示字母(默认值) </br>2:显示数字 |
 |secrecyMode|保密模式|0:不保密(默认值)</br>1:保密 |
 |modifyMode|修改模式|0:不可修改  </br>1:可以修改(默认值) |
-| modifyMode      | 修改模式     | 0:不可修改</br>1:可以修改(默认值)|
-| lessMode        | 迫选模式     | 0:可缺选(默认值) </br>1:不可缺选</br>2:允许重复输入</br>3:允许重复输入且不可缺选 |
-| options         | 选项数目     | 1≤M≤10(默认值4)                     |
-| optionalN       | 可选项数     | 1≤N≤M(默认值1)                      |
-| tipTitle        | 提示标题     | 16个字节                            |
+|lessMode|迫选模式| 0:可缺选(默认值) </br>1:不可缺选</br>2:允许重复输入</br>3:允许重复输入且不可缺选 |
+| options|选项数目|1≤M≤10(默认值4)|
+| optionalN|可选项数|1≤N≤M(默认值1)|
+| tipTitle|提示标题|字符串，长度最多不超过16个字节|
 指令样例：
@@ -733,7 +732,7 @@ params：{}
 | optionsMode    | 选项类别     | 1:True/False 对/错 </br>2:Yes/No 是/否</br> 3:√/×|
 | secrecyMode    | 保密模式     | 0:不保密(默认值) </br> 1:保密|
 | modifyMode     | 修改模式     | 0:不可修改</br>1:可以修改(默认值)|
-| tipTitle       | 提示标题     | 16个字节|
+| tipTitle       | 提示标题     | 字符串，长度最多不超过16个字节|
 指令样例：
@@ -861,7 +860,7 @@ params：{}
 |lessMode| 预留|0|
 |questionNumber|题目个数|1\~10 (默认值10)|
 |options|选项数目|1~10 (单选题有效, 默认值4)|
-|tipTitle|提示标题|16个字节|
+|tipTitle|提示标题|字符串，长度最多不超过16个字节|
 指令样例：
 ```json
@@ -985,8 +984,7 @@ params：{}
 |submitTimes|提交次数|0 (0：不限制, 默认值0)|
 |recordingTimeLimit|预留|0|
 |recordingFormat|预留|0:固定传0|
-|recordAudioFormat|音频格式|0:mp3<br>1:实时流(默认值1)|
-|tipTitle|提示标题|16个字节|
+|recordAudioFormat|音频格式|0:mp3(默认值)<br>1:实时流|
 指令样例：
@@ -1100,7 +1098,7 @@ infos: {}
 #### 回传分数
-收到语音后，可对评测分数回传给键盘，详见[自定义信息](\l)
+收到语音后，可对评测分数回传给键盘，详见[自定义信息]
 #### 停止作答
@@ -1147,8 +1145,8 @@ infos:{&quot;state&quot;:&quot;OK&quot;}//返回状态,成功为OK
 接收：
 fun: "voicePacketLossInfo" //丢包信息
-baseId:1 //1\~32,连接基站
-infos:{} //
+baseId:1 	//1~32,连接基站
+infos:{} 	//
 |Json字段|字段含义|赋值及含义|
 |---|---|---|
@@ -1254,7 +1252,7 @@ infos: {}
 	"infos": {
 		"time": "1.42",
 		"keySn": "1479824643",
-		"keyValue": "A"
+		"keyValue": "1"
 	},
 	"packetTag": "1"
 }
@@ -1318,9 +1316,9 @@ params：{}
 |modifyMode|修改模式|0:不可修改<br>1:可以修改(默认值)|
 |aswOption|按键模式|0:无规则 （S6最多16位，T2最多14位）<br>1:预留<br>2:预留<br>3:带小数位上下限（T2不支持）|
 |digits|小数位数|0:没有小数点<br>1:一位小数点<br>2:二位小数点|
-|numMin|下限|0-655.35|
-|numMax|上限|0-655.35|
-|tipTitle|提示标题|16个字节|
+|numMin|下限|digits=0 范围：0~65535 <br> digits=1 范围：0~6553 <br> digits=2 范围：0~655|
+|numMax|上限|digits=0 范围：0~65535 <br> digits=1 范围：0~6553 <br> digits=2 范围：0~655|
+|tipTitle|提示标题|字符串，长度最多不超过16个字节|
@@ -3958,7 +3956,8 @@ infos:{&quot;state&quot;:&quot;OK&quot;}//返回状态,成功为OK
 }
 ```
-##### 支持设备说明
+#####支持设备说明
+
 | **基站+键盘** | **支持** | **备注** |
 | --- | --- | --- |
 | B100-2.4G+S6  | 支持 || 
@@ -5361,7 +5360,7 @@ infos:{}//数组对象,同发送的
 ## 键盘显示设置
-注：返回指令中的\"baseId\":0, 可忽略不处理
+注：返回指令中的"baseId":0, 可忽略不处理
 ### 空闲标题