修改部分MD格式，增加单条指令长度不超过2K的限制

刘琴
1 parent 8a9adc3e
Showing 1 changed file with 168 additions and 41 deletions
通讯协议-B200W-MQTT协议[外].md
@@ -36,12 +36,12 @@ MQTT服务器配置结果检查
 \${baseSN}为指定的基站的SN编码，不能为空，接收基站反馈数据需要订阅对应基站SN的接收主题。
 ### 发布的主题
 应用程序发布的主题，基站订阅
-/client/\${baseSN}/send
+/client/\${baseSN}/send <br>
 /client/multiBase/send
 ### 订阅的主题
 应用程序订阅的主题，基站发布
-/basestation/\\${baseSN}/receive
+/basestation/\\${baseSN}/receive <br>
 /basestation/multiBase/receive 
 ## 指令说明
@@ -60,8 +60,8 @@ MQTT服务器配置结果检查
 |fEvtXXX|指令事件	|调用对应指令后返回|
 ## 数据格式约定
-- 数据格式统一为**Json**格式，MQTT发送接收消息编码统一为**UTF-8**
-- Json通用格式如下：
+- 数据格式统一为**json**格式，MQTT发送接收消息编码统一为**UTF-8**
+- json通用格式如下：
 ```json
   {
     "fun":"xxx", 
@@ -71,12 +71,15 @@ MQTT服务器配置结果检查
     }
   }
 ```
+
 |参数	|说明	|约束|
 |---|---|---|
 |fun|	指令或事件名称||
 |dataTag|	数据标签，用于对应收发数据|长度不超过4，可为0-9a-zA-Z的组合|
 |data|	数据内容|对象或者数组，可为空|
+<font color="red">注意：基站接收指令数据单次不超过2K长度，在指定键盘发送指令时，如果指令长度超出限制，建议将指令进行拆分，分次发送，如果是所有键盘执行的指令，可将keySns设为空数组不使用指定键盘的模式</font>
+
 ## 功能速查一览表
 ### 基站管理
@@ -156,7 +159,7 @@ MQTT服务器配置结果检查
 |+version|string||否|基站固件版本|
 - **示例代码**
-```Json
+```json
 //连接成功
 {
     "fun":"sEvtBsConnectState",
@@ -177,6 +180,7 @@ MQTT服务器配置结果检查
     }
 }
 ```
+
 ### sEvtBsChannelConflict
 - **主题**: /basestation/\${baseSN}/receive
 - **功能描述**：基站信道冲突时主动上报，应用程序可根据实际业务修改基站信道
@@ -190,7 +194,7 @@ MQTT服务器配置结果检查
 |+value|int||是|有冲突的信道|
 - **示例代码**
-```Json
+```json
 {
     "fun":"sEvtBsChannelConflict",
     "dataTag":"1",
@@ -199,6 +203,7 @@ MQTT服务器配置结果检查
     }
 }
 ```
+
 ### sEvtBsNfcResults
 - **主题**: /basestation/\${baseSN}/receive
 - **功能描述**：键盘刷卡时主动上报，如果超出基站容量会上报失败
@@ -213,7 +218,7 @@ MQTT服务器配置结果检查
 |+value|int||是|刷卡的状态<br>1-成功<br>2-失败|
 - **示例代码**
-```Json
+```json
 {
     "fun":"sEvtBsNfcResults",
     "dataTag":"1",  //不需要时可传空字符串
@@ -240,7 +245,7 @@ MQTT服务器配置结果检查
 |+voltage|double||是|键盘电压|
 - **示例代码**
-```Json
+```json
 {
     "fun":"sEvtBsKpOnlineMsg",
     "dataTag":"1",
@@ -252,6 +257,7 @@ MQTT服务器配置结果检查
     }
 }
 ```
+
 ### sEvtStateCode
 - **主题**: /basestation/\${baseSN}/receive
 - **功能描述**：返回基站接收指令状态信息
@@ -280,7 +286,7 @@ MQTT服务器配置结果检查
 |60001|此功能必须指定键盘SN|
 - **示例代码**
-```Json
+```json
 {
     "fun":"sEvtStateCode",
     "dataTag":"1",
@@ -290,9 +296,13 @@ MQTT服务器配置结果检查
     }
 }
 ```
+
 ## 基站管理
+
 ### 基站连接
+
 #### 方法
+
 ##### getBsOnlineState
 - **主题**：<span class="yellowFill">/client/multiBase/send</span>
 - **功能描述**：主动获取所有在线基站信息,在线基站回复
@@ -303,7 +313,7 @@ MQTT服务器配置结果检查
 |fun|string|-|是|固定指令名称|
 |dataTag|string|-|否|数据包标识|
 - **示例代码**
-```Json
+```json
 {
   "fun":"getBsOnlineState",
   "dataTag":"1"
@@ -320,13 +330,15 @@ MQTT服务器配置结果检查
 |fun|string|-|是|固定指令名称|
 |dataTag|string|-|否|数据包标识|
 - **示例代码**
-```Json
+```json
 {
   "fun":"getBsConnectState",
   "dataTag":"1"
 }
 ```
+
 #### 事件
+
 ##### [sEvtBsConnectState](#sevtbsconnectstate)
 参见基站连接变化系统通知
@@ -346,7 +358,7 @@ MQTT服务器配置结果检查
 |+baseSN|string||否|基站SN|
 - **示例代码**
-```Json
+```json
 //连接成功
 {
     "fun":"fEvtBsOnlineState",
@@ -375,7 +387,7 @@ MQTT服务器配置结果检查
 |+timeStamp|long ||否|当前时间的时间戳|
 - **示例代码**
-```Json
+```json
 {
   "fun":"timeSync",
   "dataTag":"1",
@@ -384,6 +396,7 @@ MQTT服务器配置结果检查
   }
 }
 ```
+
 #### 事件
 ##### [sEvtStateCode](#sevtstatecode)
 返回指令的接收状态
@@ -401,12 +414,13 @@ MQTT服务器配置结果检查
 |dataTag|string|-|否|数据包标识,可为空字符串|
 - **示例代码**
-```Json
+```json
 {
   "fun":"getBsModel",
   "dataTag":"1"
 }
 ```
+
 ##### getBsFWVersion
 - **主题**：/client/\${baseSN}/send
 - **功能描述**：获取基站固件版本
@@ -418,12 +432,13 @@ MQTT服务器配置结果检查
 |dataTag|string|-|否|数据包标识,可为空字符串|
 - **示例代码**
-```Json
+```json
 {
   "fun":"getBsFWVersion",
   "dataTag":"1"
 }
 ```
+
 #### 事件
 ##### fEvtBsSN
 - **主题**: /basestation/\${baseSN}/receive
@@ -438,7 +453,7 @@ MQTT服务器配置结果检查
 |+value|string|-|是|基站的出厂编码|
 - **示例代码**
-```Json
+```json
 {
     "fun":"fEvtBsSN",
     "dataTag":"1",
@@ -447,6 +462,7 @@ MQTT服务器配置结果检查
     }
 }
 ```
+
 ##### fEvtBsModel
 - **主题**: /basestation/\${baseSN}/receive
 - **功能描述**：返回基站的型号
@@ -460,7 +476,8 @@ MQTT服务器配置结果检查
 |+value|string|-|是|基站的型号名称|
 - **示例代码**
-```Json
+
+```json
 {
     "fun":"fEvtBsModel",
     "dataTag":"1",
@@ -469,6 +486,7 @@ MQTT服务器配置结果检查
     }
 }
 ```
+
 ##### fEvtBsFWVersion
 - **主题**: /basestation/\${baseSN}/receive
 - **功能描述**：返回基站的固件版本
@@ -482,7 +500,8 @@ MQTT服务器配置结果检查
 |+value|string||是|基站的固件版本号|
 - **示例代码**
-```Json
+
+```json
 {
     "fun":"fEvtBsFWVersion",
     "dataTag":"1",
@@ -491,6 +510,7 @@ MQTT服务器配置结果检查
     }
 }
 ```
+
 ### 组网设置
 #### 方法
 ##### getBsPairCode
@@ -504,12 +524,13 @@ MQTT服务器配置结果检查
 |dataTag|string|-|否|数据包标识,可为空字符串|
 - **示例代码**
-```Json
+```json
 {
   "fun":"getBsPairCode",
   "dataTag":"1"
 }
 ```
+
 ##### getBsNfcLogin
 - **主题**：/client/\${baseSN}/send
 - **功能描述**：获取刷卡配对状态
@@ -521,12 +542,13 @@ MQTT服务器配置结果检查
 |dataTag|string|-|否|数据包标识,可为空字符串|
 - **示例代码**
-```Json
+```json
 {
   "fun":"getBsNfcLogin",
   "dataTag":"1"
 }
 ```
+
 ##### setBsNfcLogin
 - **主题**：/client/\${baseSN}/send
 - **功能描述**：设置基站刷卡配对状态
@@ -540,7 +562,7 @@ MQTT服务器配置结果检查
 |+value|string|-|是|设置的基站刷卡配对状态<br>0-关闭刷卡配对<br>1-开启刷卡配对|
 - **示例代码**
-```Json
+```json
 {
   "fun":"setBsNfcLogin",
   "dataTag":"1",
@@ -549,6 +571,7 @@ MQTT服务器配置结果检查
   }
 }
 ```
+
 ##### getBsChannel
 - **主题**：/client/\${baseSN}/send
 - **功能描述**：获取基站信道
@@ -560,12 +583,13 @@ MQTT服务器配置结果检查
 |dataTag|string|-|否|数据包标识,可为空字符串|
 - **示例代码**
-```Json
+```json
 {
   "fun":"getBsChannel",
   "dataTag":"1"
 }
 ```
+
 ##### setBsChannel
 - **主题**：/client/\${baseSN}/send
 - **功能描述**：设置基站信道
@@ -579,7 +603,7 @@ MQTT服务器配置结果检查
 |+value|string|-|是|设置的基站信道，可设范围：1-80|
 - **示例代码**
-```Json
+```json
 {
   "fun":"setBsChannel",
   "dataTag":"1",
@@ -588,6 +612,7 @@ MQTT服务器配置结果检查
   }
 }
 ```
+
 #### 事件
 ##### fEvtBsPairCode
 - **主题**: /basestation/\${baseSN}/receive
@@ -602,7 +627,7 @@ MQTT服务器配置结果检查
 |+value|string||是|基站的配对码|
 - **示例代码**
-```Json
+```json
 {
     "fun":"fEvtBsPairCode",
     "dataTag":"1",
@@ -625,7 +650,7 @@ MQTT服务器配置结果检查
 |+value|string||是|基站信道|
 - **示例代码**
-```Json
+```json
 {
     "fun":"fEvtBsChannel",
     "dataTag":"1",
@@ -634,6 +659,7 @@ MQTT服务器配置结果检查
     }
 }
 ```
+
 ##### fEvtBsNfcLogin
 - **主题**: /basestation/\${baseSN}/receive
 - **功能描述**：返回基站是否允许NFC刷卡
@@ -647,7 +673,7 @@ MQTT服务器配置结果检查
 |+value|string||是|0-关闭  1-开启|
 - **示例代码**
-```Json
+```json
 {
     "fun":"fEvtBsNfcLogin",
     "dataTag":"1",
@@ -656,6 +682,7 @@ MQTT服务器配置结果检查
     }
 }
 ```
+
 ### 登录设置
 #### 方法
 ##### getBsSSID
@@ -670,12 +697,13 @@ MQTT服务器配置结果检查
 |dataTag|string|-|否|数据包标识|
 - **示例代码**
-```Json
+```json
 {
   "fun":"getBsSSID",
   "dataTag":"1"
 }
 ```
+
 ##### setBsSSID
 - **主题**：/client/\${baseSN}/send
 - **功能描述**：设置基站登录名称
@@ -689,7 +717,7 @@ MQTT服务器配置结果检查
 |+value|string||是|设置的基站SSID，最长12字符|
 - **示例代码**
-```Json
+```json
 {
   "fun":"setBsSSID",
   "dataTag":"1",
@@ -698,6 +726,7 @@ MQTT服务器配置结果检查
   }
 }
 ```
+
 #### 事件
 ##### fEvtBsSSID
 - **主题**: /basestation/\${baseSN}/receive
@@ -712,7 +741,7 @@ MQTT服务器配置结果检查
 |+value|string||是|基站名称|
 - **示例代码**
-```Json
+```json
 {
     "fun":"fEvtBsSSID",
     "dataTag":"1",
@@ -721,6 +750,7 @@ MQTT服务器配置结果检查
     }
 }
 ```
+
 ### 键盘统一设置
 #### 方法
 ##### getBsKpLanguage
@@ -734,12 +764,13 @@ MQTT服务器配置结果检查
 |dataTag|string|-|否|数据包标识,可为空字符串|
 - **示例代码**
-```Json
+```json
 {
   "fun":"getBsKpLanguage",
   "dataTag":"1"
 }
 ```
+
 ##### setBsKpLanguage
 - **主题**：/client/\${baseSN}/send
 - **功能描述**：设置键盘语言
@@ -753,7 +784,7 @@ MQTT服务器配置结果检查
 |+value|string||是|设置键盘显示的语言<br>1-简体中文<br>2-英文|
 - **示例代码**
-```Json
+```json
 {
   "fun":"setBsKpLanguage",
   "dataTag":"1",
@@ -762,6 +793,7 @@ MQTT服务器配置结果检查
   }
 }
 ```
+
 #### 事件
 ##### fEvtBsKpLanguage
 - **主题**: /basestation/\${baseSN}/receive
@@ -776,7 +808,7 @@ MQTT服务器配置结果检查
 |+value|string||是|设置键盘显示的语言<br>1-简体中文<br>2-英文|
 - **示例代码**
-```Json
+```json
 {
   "fun":"fEvtBsKpLanguage",
   "dataTag":"1",
@@ -785,6 +817,7 @@ MQTT服务器配置结果检查
   }
 }
 ```
+
 ### 网络参数设置
 #### 方法
 ##### getBsTcpipParams
@@ -798,12 +831,13 @@ MQTT服务器配置结果检查
 |dataTag|string|-|否|数据包标识,可为空字符串|
 - **示例代码**
-```Json
+```json
 {
   "fun":"getBsTcpipParams",
   "dataTag":"1"
 }
 ```
+
 ##### setBsTcpipParams
 - **主题**：/client/\${baseSN}/send
 - **功能描述**：设置基站TCP/IP参数
@@ -820,7 +854,7 @@ MQTT服务器配置结果检查
 |+ipAllocation|int||否|基站IP获取方式<br>0 - 手动指定<br>1 - DHCP获取|
 - **示例代码**
-```Json
+```json
 {
   "fun":"setBsTcpipParams",
   "dataTag":"1",
@@ -832,6 +866,7 @@ MQTT服务器配置结果检查
   }
 }
 ```
+
 ##### getBsMqttParams
 - **主题**：/client/\${baseSN}/send
 - **功能描述**：获取基站MQTT参数
@@ -843,12 +878,13 @@ MQTT服务器配置结果检查
 |dataTag|string|-|否|数据包标识,可为空字符串|
 - **示例代码**
-```Json
+```json
 {
   "fun":"getBsMqttParams",
   "dataTag":"1"
 }
 ```
+
 ##### setBsMqttParams
 - **主题**：/client/\${baseSN}/send
 - **功能描述**：设置基站MQTT参数
@@ -866,7 +902,7 @@ MQTT服务器配置结果检查
 |+interval|int|>=10|否|基站连接服务器失败后重连的间隔时长，单位秒|
 - **示例代码**
-```Json
+```json
 {
   "fun":"setBsMqttParams",
   "dataTag":"1",
@@ -879,6 +915,7 @@ MQTT服务器配置结果检查
   }
 }
 ```
+
 #### 事件
 ##### fEvtBsTcpipParams
 - **主题**: /basestation/\${baseSN}/receive
@@ -897,7 +934,7 @@ MQTT服务器配置结果检查
 |+ipAllocation|int||否|基站IP获取方式<br>0 - 手动指定<br>1 - DHCP获取|
 - **示例代码**
-```Json
+```json
 {
   "fun":"fEvtBsTcpipParams",
   "dataTag":"1",
@@ -910,6 +947,7 @@ MQTT服务器配置结果检查
   }
 }
 ```
+
 ##### fEvtBsMqttParams
 - **主题**: /basestation/\${baseSN}/receive
 - **功能描述**：返回基站MQTT参数
@@ -927,7 +965,7 @@ MQTT服务器配置结果检查
 |+interval|int|>=10|否|基站连接服务器失败后重连的间隔时长，单位秒|
 - **示例代码**
-```Json
+```json
 {
   "fun":"fEvtBsMqttParams",
   "dataTag":"1",
@@ -940,6 +978,7 @@ MQTT服务器配置结果检查
   }
 }
 ```
+
 ### 基站维护
 #### 方法
 ##### getBsLogInfo
@@ -953,7 +992,7 @@ MQTT服务器配置结果检查
 |dataTag|string|-|否|数据包标识,可为空字符串|
 - **示例代码**
-```Json
+```json
 {
   "fun":"getBsLogInfo",
   "dataTag":"1"
@@ -979,6 +1018,8 @@ MQTT服务器配置结果检查
 |data|array|-|否|传送参数的对象数组|
 |++keySns|array||是|指定的键盘SN数组，空数组表示全部在线键盘<br><font color="red">注意：不允许空数组和指定SN数组混合使用<br>包含空数组默认为全部在线键盘，其他指定键盘无效</font>|
 |++info|string||否|设置的反馈信息<br>不同键盘可设置不同反馈信息|
+
+- **示例代码**
 ```json
 //分别提示
 {
@@ -1007,6 +1048,7 @@ MQTT服务器配置结果检查
   ]
 }
 ```
+
 #### 事件
 ##### [sEvtStateCode](#sevtstatecode)
 发送指令后返回接收状态
@@ -1023,6 +1065,8 @@ MQTT服务器配置结果检查
 |data|array|-|是|传送参数的对象数组|
 |++keySn|string||是|设置提示语信息的键盘SN|
 |++state|string||是|设置的提示语是否成功<br>0 - 成功<br>1 - 失败|
+
+- **示例代码**
 ```json
 {
   "fun": "fEvtSetKpUserPrompt",
@@ -1043,6 +1087,7 @@ MQTT服务器配置结果检查
   ]
 }
 ```
+
 ### 在线状态
 #### 方法
 ##### startGetKpOnline
@@ -1054,6 +1099,8 @@ MQTT服务器配置结果检查
 |---|---|---|---|---|
 |fun|string|-|是|指令名称|
 |dataTag|string|-|否|数据包标识,可为空字符串|
+
+- **示例代码**
 ```json
 {
   "fun": "startGetKpOnline",
@@ -1070,12 +1117,15 @@ MQTT服务器配置结果检查
 |---|---|---|---|---|
 |fun|string|-|是|指令名称|
 |dataTag|string|-|否|数据包标识,可为空字符串|
+
+- **示例代码**
 ```json
 {
   "fun": "stopGetKpOnline",
   "dataTag":"1"
 }
 ```
+
 #### 事件
 ##### [sEvtStateCode](#sevtstatecode)
 发送指令后返回此事件
@@ -1098,7 +1148,7 @@ MQTT服务器配置结果检查
 |+keySns|array||否|需要执行指令的键盘SN数组，空数组表示所有键盘|
 - **示例代码**
-```Json
+```json
 {
   "fun":"remoteKpSleep",
   "dataTag":"1",
@@ -1107,6 +1157,7 @@ MQTT服务器配置结果检查
   }
 }
 ```
+
 #### 事件
 ##### [sEvtStateCode](#sevtstatecode)
 返回指令的接收状态
@@ -1126,6 +1177,8 @@ MQTT服务器配置结果检查
 |data|array|-|是|传送参数的对象数组，不可为空|
 |++keySn|string||是|需要设置绑定信息的键盘SN|
 |++info|string||是|设置的绑定信息，一般为学生姓名<br>最长48个字符，显示在键盘左上角|
+
+- **示例代码**
 ```json
 {
   "fun": "rtSetKpBindingInfo",
@@ -1154,6 +1207,8 @@ MQTT服务器配置结果检查
 |dataTag|string|-|否|数据包标识,可为空字符串|
 |data|object|-|是|传送参数的对象数组|
 |+keySns|array||否|需要清除绑定信息键盘SN数组，<br>空数组表示清空所有键盘|
+
+- **示例代码**
 ```json
 {
   "fun": "clearKpBindingInfo",
@@ -1163,6 +1218,7 @@ MQTT服务器配置结果检查
   }
 }
 ```
+
 #### 事件
 ##### [sEvtStateCode](#sevtstatecode)
 发送指令后返回接收状态
@@ -1179,6 +1235,8 @@ MQTT服务器配置结果检查
 |data|array|-|否|传送参数的对象数组|
 |++keySn|string||是|需要设置绑定信息的键盘SN|
 |++state|string||是|设置的绑定信息是否成功<br>0 - 成功<br>1 - 失败|
+
+- **示例代码**
 ```json
 {
   "fun": "fEvtKpBindingInfo",
@@ -1195,6 +1253,7 @@ MQTT服务器配置结果检查
   ]
 }
 ```
+
 ##### fEvtClearKpBindingInfo
 - **主题**：/basestation/\${baseSN}/receive
 - **功能描述**：返回清空绑定信息的指令状态是否成功
@@ -1206,6 +1265,8 @@ MQTT服务器配置结果检查
 |dataTag|string|-|否|数据包标识,可为空字符串|
 |data|object|-|否|传送参数的对象|
 |+state|string||是|设置的绑定信息是否成功<br>0 - 成功<br>1 - 失败|
+
+- **示例代码**
 ```json
 {
   "fun": "fEvtClearKpBindingInfo",
@@ -1215,6 +1276,7 @@ MQTT服务器配置结果检查
   }
 }
 ```
+
 ## 签到
 ### 随时签到
 #### 方法
@@ -1229,6 +1291,8 @@ MQTT服务器配置结果检查
 |dataTag|string|-|否|数据包标识,可为空字符串|
 |data|object|-|是|传递参数的对象|
 |+mode|int|-|是|签到模式<br>2-PIN码签到，输入pin码后由应用程序决定是否授权|
+
+- **示例代码**
 ```json
 {
   "fun": "rtStartKpSignIn",
@@ -1238,6 +1302,7 @@ MQTT服务器配置结果检查
   }
 }
 ```
+
 ##### rtStopKpSignIn
 - **主题**：/client/\${baseSN}/send
 - **功能描述**：停止签到绑定
@@ -1247,12 +1312,15 @@ MQTT服务器配置结果检查
 |---|---|---|---|---|
 |fun|string|-|是|指令名称|
 |dataTag|string|-|否|数据包标识,可为空字符串|
+
+- **示例代码**
 ```json
 {
   "fun": "rtStopKpSignIn",
   "dataTag":"1"
 }
 ```
+
 ##### rtSetKpLoginAllowed
 - **主题**：/client/\${baseSN}/send
 - **功能描述**：实时PIN绑定授权,可取消授权
@@ -1265,6 +1333,8 @@ MQTT服务器配置结果检查
 |data|object|-|是|传递参数的对象|
 |+keySn|string|-|是|键盘SN|
 |+state|int|-|是|1-授权成功<br>2-授权失败<br>3-解除已授权|
+
+- **示例代码**
 ```json
 {
   "fun": "rtSetKpLoginAllowed",
@@ -1275,6 +1345,7 @@ MQTT服务器配置结果检查
   }
 }
 ```
+
 #### 事件
 ##### [sEvtStateCode](#sevtstatecode)
 发送指令后返回接收状态
@@ -1292,6 +1363,8 @@ MQTT服务器配置结果检查
 |++keySn|string||是|键盘SN|
 |++keyValue|string||是|键盘提交的按键值|
 |++keyTime|double||是|答题时间，从启动开始计算，单位秒|
+
+- **示例代码**
 ```json
 {
   "fun": "fEvtKpSignIn",
@@ -1309,6 +1382,7 @@ MQTT服务器配置结果检查
   ]
 }
 ```
+
 ##### fEvtKpLoginAllowed
 - **主题**：/basestation/\${baseSN}/receive
 - **功能描述**：返回键盘授权状态
@@ -1321,6 +1395,8 @@ MQTT服务器配置结果检查
 |data|object|-|是|传送参数的对象|
 |+keySn|string||是|键盘SN|
 |+state|string||是|0-执行成功<br> 1-执行失败|
+
+- **示例代码**
 ```json
 {
   "fun": "fEvtKpLoginAllowed",
@@ -1331,6 +1407,7 @@ MQTT服务器配置结果检查
     }
 }
 ```
+
 ## 按键反馈
 ### 判断题
 #### 方法
@@ -1348,6 +1425,8 @@ MQTT服务器配置结果检查
 |+mode|int||是|1 - True/False 对/错 <br>2 - Yes/No 是/否<br> 3 - √/×|
 |+allowModify|int||是|0 - 不允许修改<br>1 - 允许修改|
 |+tip|string||否|提示的标题，长度不超过16字符|
+
+- **示例代码**
 ```json
 {
   "fun": "startQATrueFalse",
@@ -1360,6 +1439,7 @@ MQTT服务器配置结果检查
   }
 }
 ```
+
 ##### stopQATrueFalse
 - **主题**：/client/\${baseSN}/send
 - **功能描述**：停止判断题答题
@@ -1369,12 +1449,15 @@ MQTT服务器配置结果检查
 |---|---|---|---|---|
 |fun|string|-|是|指令名称|
 |dataTag|string|-|否|数据包标识,可为空字符串|
+
+- **示例代码**
 ```json
 {
   "fun": "stopQATrueFalse",
   "dataTag":"1"
 }
 ```
+
 #### 事件
 ##### [sEvtStateCode](#sevtstatecode)
 发送指令后返回接收状态
@@ -1392,6 +1475,8 @@ MQTT服务器配置结果检查
 |++keySn|string||是|键盘SN|
 |++keyValue|string||是|键盘提交的按键值<br>1-对<br>2-错|
 |++keyTime|double||是|答题时间，从启动开始计算，单位秒|
+
+- **示例代码**
 ```json
 {
   "fun": "fEvtQATrueFalse",
@@ -1404,6 +1489,7 @@ MQTT服务器配置结果检查
   ]
 }
 ```
+
 ### 选择题
 #### 方法
 ##### startQAChoice
@@ -1423,6 +1509,8 @@ MQTT服务器配置结果检查
 |+optionalN|int||是|可选项个数，1≤N≤M(默认值1)|
 |+allowModify|int||是|修改模式<br>0 - 不允许修改<br>1 - 允许修改|
 |+tip|string||否|提示的标题，长度不超过16字符|
+
+- **示例代码**
 ```json
 {
   "fun": "startQAChoice",
@@ -1438,6 +1526,7 @@ MQTT服务器配置结果检查
   }
 }
 ```
+
 ##### stopQAChoice
 - **主题**：/client/\${baseSN}/send
 - **功能描述**：停止选择题答题
@@ -1447,12 +1536,15 @@ MQTT服务器配置结果检查
 |---|---|---|---|---|
 |fun|string|-|是|指令名称|
 |dataTag|string|-|否|数据包标识,可为空字符串|
+
+- **示例代码**
 ```json
 {
   "fun": "stopQAChoice",
   "dataTag":"1"
 }
 ```
+
 #### 事件
 ##### [sEvtStateCode](#sevtstatecode)
 发送指令后返回接收状态
@@ -1470,6 +1562,8 @@ MQTT服务器配置结果检查
 |++keySn|string||是|键盘SN|
 |++keyValue|string||是|键盘提交的按键值|
 |++keyTime|double||是|答题时间，从启动开始计算，单位秒|
+
+- **示例代码**
 ```json
 {
   "fun": "fEvtQAChoice",
@@ -1481,6 +1575,7 @@ MQTT服务器配置结果检查
     }]
 }
 ```
+
 ### 数字题
 #### 方法
 ##### startQANum
@@ -1500,6 +1595,8 @@ MQTT服务器配置结果检查
 |+numMax|int||是|可输入上限,mode=1有效，范围0-100|
 |+allowModify|int||是|修改模式<br>0 - 不允许修改<br>1 - 允许修改|
 |+tip|string||否|提示的标题，长度不超过16字符|
+
+- **示例代码**
 ```json
 {
   "fun": "startQANum",
@@ -1515,6 +1612,7 @@ MQTT服务器配置结果检查
   }
 }
 ```
+
 ##### stopQANum
 - **主题**：/client/\${baseSN}/send
 - **功能描述**：停止数字题答题
@@ -1524,12 +1622,15 @@ MQTT服务器配置结果检查
 |---|---|---|---|---|
 |fun|string|-|是|指令名称|
 |dataTag|string|-|否|数据包标识,可为空字符串|
+
+- **示例代码**
 ```json
 {
   "fun": "stopQANum",
   "dataTag":"1"
 }
 ```
+
 #### 事件
 ##### [sEvtStateCode](#sevtstatecode)
 发送指令后返回接收状态
@@ -1547,6 +1648,8 @@ MQTT服务器配置结果检查
 |++keySn|string||是|键盘SN|
 |++keyValue|string||是|键盘提交的按键值|
 |++keyTime|double||是|答题时间，从启动开始计算，单位秒|
+
+- **示例代码**
 ```json
 {
   "fun": "fEvtQANum",
@@ -1558,6 +1661,7 @@ MQTT服务器配置结果检查
     }
 }
 ```
+
 ### 抢答题
 #### 方法
 ##### startQAQuicker
@@ -1574,6 +1678,8 @@ MQTT服务器配置结果检查
 |+mode|int||是|模式<br>0:普通抢答|
 |+allowModify|int||是|修改模式<br>0 - 不允许修改<br>1 - 允许修改|
 |+tip|string||否|提示的标题，长度不超过16字符|
+
+- **示例代码**
 ```json
 {
   "fun": "startQAQuicker",
@@ -1586,6 +1692,7 @@ MQTT服务器配置结果检查
   }
 }
 ```
+
 ##### stopQAQuicker
 - **主题**：/client/\${baseSN}/send
 - **功能描述**：停止抢答答题
@@ -1595,12 +1702,15 @@ MQTT服务器配置结果检查
 |---|---|---|---|---|
 |fun|string|-|是|指令名称|
 |dataTag|string|-|否|数据包标识,可为空字符串|
+
+- **示例代码**
 ```json
 {
   "fun": "stopQAQuicker",
   "dataTag":"1"
 }
 ```
+
 #### 事件
 ##### [sEvtStateCode](#sevtstatecode)
 发送指令后返回接收状态
@@ -1618,6 +1728,8 @@ MQTT服务器配置结果检查
 |++keySn|string||是|键盘SN|
 |++keyValue|string||是|键盘提交的按键值|
 |++keyTime|double||是|答题时间，从启动开始计算，单位秒|
+
+- **示例代码**
 ```json
 {
   "fun": "fEvtQAQuicker",
@@ -1629,6 +1741,7 @@ MQTT服务器配置结果检查
     }]
 }
 ```
+
 ## 在线测验
 ### 标准测验
 #### 方法
@@ -1650,6 +1763,8 @@ MQTT服务器配置结果检查
 |++option |int||是 |选项数目<br> quesType = 1 有效。<br>quesType = 2 有效。<br>此项缺省时  默认4;<br>范围：1-10。|
 |++startNo | int||是| 起始题号 |
 |++count | int||是| 题目数量 |
+
+- **示例代码**
 ```json
 //自定义题号
 {
@@ -1721,6 +1836,7 @@ MQTT服务器配置结果检查
   }
 }
 ```
+
 ##### stopKpExam
 - **主题**：/client/\${baseSN}/send
 - **功能描述**：停止标准测验
@@ -1730,12 +1846,15 @@ MQTT服务器配置结果检查
 |---|---|---|---|---|
 |fun|string|-|是|指令名称|
 |dataTag|string|-|否|数据包标识,可为空字符串|
+
+- **示例代码**
 ```json
 {
   "fun": "stopKpExam",
   "dataTag":"1"
 }
 ```
+
 ##### rtKpAllowEdited
 - **主题**：/client/\${baseSN}/send
 - **功能描述**：键盘键盘后，允许键盘修改答案
@@ -1747,6 +1866,8 @@ MQTT服务器配置结果检查
 |dataTag|string|-|否|数据包标识,可为空字符串|
 |data|object|-|是|传送参数的对象|
 |+keySns|array||是|指定的键盘SN数组，空数组表示全部在线键盘|
+
+- **示例代码**
 ```json
 {
   "fun": "rtKpAllowEdited",
@@ -1756,6 +1877,7 @@ MQTT服务器配置结果检查
   }
 }
 ```
+
 #### 事件
 ##### [sEvtStateCode](#sevtstatecode)
 发送指令后返回接收状态
@@ -1773,6 +1895,8 @@ MQTT服务器配置结果检查
 |++keySn|string||是|键盘SN|
 |++keyValue|string||是|键盘提交的按键值,1:A;2:B表示第1题提交A，第二题提交B|
 |++keyTime|double||是|答题时间，从启动开始计算，单位秒|
+
+- **示例代码**
 ```json
 {
   "fun": "fEvtKpExam",
@@ -1790,6 +1914,7 @@ MQTT服务器配置结果检查
   ]
 }
 ```
+
 ##### fEvtFinalSubmit
 - **主题**：/basestation/\${baseSN}/receive
 - **功能描述**：返回键盘手动交卷标识
@@ -1803,6 +1928,8 @@ MQTT服务器配置结果检查
 |++keySn|string||是|键盘SN|
 |++keyValue|string||是|0 - 未提交(修改键盘运行提交时上报)<br>1 - 已交卷|
 |++keyTime|double||是|提交时间，从启动开始计算，单位秒|
+
+- **示例代码**
 ```json
 {
   "fun": "fEvtFinalSubmit",
@@ -1813,4 +1940,4 @@ MQTT服务器配置结果检查
       "keyTime":3.2
     }]
 }
-```
 \ No newline at end of file
+```