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

huaziforever
2 parents 4d85e3c7 deff7695
Showing 4 changed files with 136 additions and 66 deletions
通讯协议-B200W-MQTT协议[内部].md
通讯协议-B200W-MQTT协议[外].md
通讯协议-SDK应用部分.md
通讯协议-SDK应用部分[内部].md
@@ -14,9 +14,60 @@
   }
 </style>
  
+<br>
+<br>
+<br>
+
+<div  style="text-align: center;font-size: 70px;">
+SunVote B200W <br>MQTT通讯协议
+</div>
+<br>
+<br>
+<br>
+<br>
+<div  style="text-align: center;font-size: 30px;">
+Ver 1.0.1
+</div>
+<br>
+<br>
+<br>
+<br>
+<br>
+<br>
+
+<div  style="text-align: center;font-size: 30px;">
+长沙中天电子设计开发有限公司
+</div>
+
+<br>
+
+<div  style="text-align: center;font-size: 30px;">
+二〇二四年十月
+</div>
+
+<br>
+<br>
+<br>
+<br>
+
+文件控制：
+
+文件名：SunVote B200W MQTT通讯协议
+
+起草人：刘琴
+
+最新版本作者： 刘琴
+<br>
+| 文档版本 | 日期 | 作者 | 版本说明 |
+|---|---|---|---|
+|1.0.1| 2024年10月22日|刘琴|1.  初始版|
+
+<br>
+<br>
+
 [TOC]
  
-# SunVote B200W_MQTT 接口协议
+# SunVote B200W MQTT通讯协议
  
 # 功能说明
  
@@ -192,7 +243,7 @@
 |抢答题|启动抢答题答题|[startQAQuicker](#startqaquicker)|[sEvtStateCode](#sevtstatecode)<br>[fEvtQAQuicker](#fevtqaquicker)|
 ||停止抢答题答题|[stopKpVote](#stopkpvote)|[sEvtStateCode](#sevtstatecode)|
 |待机实时反馈|设置待机实时反馈状态|[setKpStbResponse](#setkpstbresponse)|[fEvtKpStbResponse](#fevtkpstbresponse)<br>[sEvtKpRtFeedback](#sevtkprtfeedback)<br>[sEvtKpHandUp](#sevtkphandup)|
-||设置待机实时反馈状态|[getKpStbResponse](#getkpstbresponse)|[fEvtKpStbResponse](#fevtkpstbresponse)|
+||获取待机实时反馈状态|[getKpStbResponse](#getkpstbresponse)|[fEvtKpStbResponse](#fevtkpstbresponse)|
 ### 在线测验
 |功能归类|功能|API指令|指令事件|
 |---|---|---|---|
@@ -1869,7 +1920,7 @@
 |+port|int||是|端口，默认1883|
 |+userName|string||否|连接服务器的用户名，可不设置|
 |+password|string||否|连接服务器的密码，可不设置|
-|+interval|int|>=60|否|基站连接服务器失败后重连的间隔时长，单位秒|
+|+interval|int|>=30|否|基站连接服务器失败后重连的间隔时长，单位秒|
  
 - **示例代码**
 ```json
@@ -1881,7 +1932,7 @@
     "port":1883,
     "userName":"",
     "password":"",
-    "interval":60
+    "interval":30
   }
 }
 ```
@@ -2146,7 +2197,7 @@
 |dataTag|string|-|否|数据包标识,可为空字符串|
 |data|array|-|是|传送参数的对象数组|
 |++name|string||是|检测项名称：MCU、RF、FLASH、EEPROM|
-|++state|int||是|检测结果<br>0-功能异常<br>1-功能正常|
+|++state|int||是|检测结果<br>0-功能正常<br>1-功能异常|
  
 - **示例代码**
 ```json
@@ -2156,19 +2207,19 @@
   "data":[
     {
       "name":"MCU",
-      "state":1
+      "state":0
     },
     {
       "name":"RF",
-      "state":1
+      "state":0
     },
     {
       "name":"FLASH",
-      "state":1
+      "state":0
     },
     {
       "name":"EEPROM",
-      "state":1
+      "state":0
     }
   ]
 }
@@ -3578,7 +3629,7 @@
  
 - **示例代码**
 ```json
-//启用举手反馈
+//获取实时反馈状态
 {
   "fun":"getKpStbResponse",
   "dataTag":"1"
@@ -3645,7 +3696,7 @@
 |+questions|array||是|题目详情|
 |++quesType | int||是| 题目类型<br>1:单选<br>2:多选（排序）<br>3:数字<br>4:判断 |
 |++option |int||是 |选项数目<br> quesType = 1 有效。<br>quesType = 2 有效。<br>此项缺省时  默认4;<br>范围：1-10。|
-|++startNo | string||是| 题号起始题号,可以为数字+“-”，单级的题号数字范围1-255，如“1”，“1-1”，“1-1-1”，最多只能输入三级<br>mode=0 时有效，mode=1或2时键盘按顺序显示题号|
+|++startNo | string||是| 起始题号,可以为数字+“-”，单级的题号数字范围1-255，如“1”，“1-1”，“1-1-1”，最多只能输入三级<br>mode=0 时有效，mode=1或2时键盘按顺序显示题号|
 |++count | int||是| 相同参数的连续题目数量, >0 <br>注意：总题数最多支持200题 |
 |+simParams|object||否|内部模拟测试参数设置对象|
 |++answer|array||是|预设提交的按键值<br>格式为"单选题答案,多选题答案;<br>数字题答案;判断题答案(1对2错)"<br>如["A","ABCD","10","1"]|
@@ -3987,7 +4038,7 @@
 |++subject | int||是 | 科目序号,1-9,对应键盘中内置的科目1-9<br>键盘答题时可选择科目切换答题|
 |++quesType | int||是| 题目类型<br>1:单选<br>2:多选（排序）<br>3:数字<br>4:判断 |
 |++option |int||是 |选项数目<br> quesType = 1 有效。<br>quesType = 2 有效。<br>此项缺省时  默认4;<br>范围：1-10。|
-|++startNo | string||是| 题号起始题号,可以为数字+“-”，单级的题号数字范围1-255，如“1”，“1-1”，最多支持两级题号<br>mode=0 时有效，mode=1或2时键盘按顺序显示题号|
+|++startNo | string||是| 起始题号,可以为数字+“-”，单级的题号数字范围1-255，如“1”，“1-1”，最多支持两级题号<br>mode=0 时有效，mode=1或2时键盘按顺序显示题号|
 |++count | int||是| 相同参数的连续题目数量, >0 <br>注意：所有科目的总题数最多支持200题|
 |+simParams|object||否|内部模拟测试参数设置对象|
 |++answer|array||是|预设提交的按键值<br>格式为"单选题答案,多选题答案;<br>数字题答案;判断题答案(1对2错)"<br>如["A","ABCD","10","1"]|
@@ -4108,7 +4159,7 @@
 #### 方法
 ##### startKpScoreInput
 - **主题**：/client/\${baseSN}/send
-- **功能描述**：启动标准测验
+- **功能描述**：启动自主录分
 - **参数说明**
  
 |参数名|类型|限制|是否必填|说明|
@@ -4121,7 +4172,7 @@
 |+questions|array||是|题目详情|
 |++max |int||是|可输入的最大值，<=100|
 |++digits|int||是|可输入的小数位数，范围0-2|
-|++startNo | string||是| 起始题号(暂不支持自定义题号，只能按顺序显示)|
+|++startNo | string||是| 起始题号，暂只支持一级题号，范围1-255|
 |++count | int||是| 相同参数的题目数量，>0<br>注意：总题数最多支持200题|
  
 - **示例代码**
@@ -14,6 +14,57 @@
   }
 </style>
  
+<br>
+<br>
+<br>
+
+<div  style="text-align: center;font-size: 70px;">
+SunVote B200W <br>MQTT通讯协议
+</div>
+<br>
+<br>
+<br>
+<br>
+<div  style="text-align: center;font-size: 30px;">
+Ver 1.0.1
+</div>
+<br>
+<br>
+<br>
+<br>
+<br>
+<br>
+
+<div  style="text-align: center;font-size: 30px;">
+长沙中天电子设计开发有限公司
+</div>
+
+<br>
+
+<div  style="text-align: center;font-size: 30px;">
+二〇二四年十月
+</div>
+
+<br>
+<br>
+<br>
+<br>
+
+文件控制：
+
+文件名：SunVote B200W MQTT通讯协议
+
+起草人：刘琴
+
+最新版本作者： 刘琴
+<br>
+| 文档版本 | 日期 | 作者 | 版本说明 |
+|---|---|---|---|
+|1.0.1| 2024年10月22日|刘琴|1.  初始版|
+
+<br>
+<br>
+
 [TOC]
  
 # SunVote B200W MQTT通讯协议
@@ -86,7 +137,6 @@
 |公共事件|键盘上线通知|-|[sEvtBsKpOnlineMsg](#sevtbskponlinemsg)|
 |公共事件|键盘刷卡事件|-|[sEvtBsNfcResults](#sevtbsnfcresults)|
 |公共事件|键盘待机实时按键反馈|-|[sEvtKpRtFeedback](#sevtkprtfeedback)|
-|公共事件|键盘举手键实时按键反馈|-|[sEvtKpHandUp](#sevtkphandup)|
  
 ### 基站管理
 |功能归类|功能|API指令|指令/系统事件|
@@ -155,8 +205,8 @@
 ||停止数字题答题|[stopKpVote](#stopkpvote)|[sEvtStateCode](#sevtstatecode)|
 |抢答题|启动抢答题答题|[startQAQuicker](#startqaquicker)|[sEvtStateCode](#sevtstatecode)<br>[fEvtQAQuicker](#fevtqaquicker)|
 ||停止抢答题答题|[stopKpVote](#stopkpvote)|[sEvtStateCode](#sevtstatecode)|
-|待机实时反馈|设置待机实时反馈状态|[setKpStbResponse](#setkpstbresponse)|[fEvtKpStbResponse](#fevtkpstbresponse)<br>[sEvtKpRtFeedback](#sevtkprtfeedback)<br>[sEvtKpHandUp](#sevtkphandup)|
-||设置待机实时反馈状态|[getKpStbResponse](#getkpstbresponse)|[fEvtKpStbResponse](#fevtkpstbresponse)|
+|待机实时反馈|设置待机实时反馈状态|[setKpStbResponse](#setkpstbresponse)|[fEvtKpStbResponse](#fevtkpstbresponse)<br>[sEvtKpRtFeedback](#sevtkprtfeedback)|
+||获取待机实时反馈状态|[getKpStbResponse](#getkpstbresponse)|[fEvtKpStbResponse](#fevtkpstbresponse)|
 ### 在线测验
 |功能归类|功能|API指令|指令事件|
 |---|---|---|---|
@@ -328,28 +378,6 @@
     }]
 }
 ```
-### sEvtKpHandUp
-- **主题**: /basestation/\${baseSN}/receive
-- **功能描述**：开启键盘举手功能后，键盘按举手键时上报
-- **参数说明**
-
-|参数名|类型|限制|非空|说明|
-|---|---|---|---|---|
-|fun|string|-|是|事件名称|
-|dataTag|string|-|否|数据包标识|
-|data|object|-|是|传送参数的对象|
-|+keySn|string||是|举手的键盘SN|
-
-- **示例代码**
-```json
-{
-    "fun":"sEvtKpHandUp",
-    "dataTag":"1",
-    "data":{ 
-        "keySn":"1234567890"
-    }
-}
-```
 ### sEvtStateCode
 - **主题**: /basestation/\${baseSN}/receive
 - **功能描述**：返回基站接收指令状态信息
@@ -1449,7 +1477,7 @@
 |+port|int||是|端口，默认1883|
 |+userName|string||否|连接服务器的用户名，可不设置|
 |+password|string||否|连接服务器的密码，可不设置|
-|+interval|int|>=60|否|基站连接服务器失败后重连的间隔时长，单位秒|
+|+interval|int|>=30|否|基站连接服务器失败后重连的间隔时长，单位秒|
  
 - **示例代码**
 ```json
@@ -1461,7 +1489,7 @@
     "port":1883,
     "userName":"",
     "password":"",
-    "interval":60
+    "interval":30
   }
 }
 ```
@@ -2468,20 +2496,11 @@
 |dataTag|string|-|否|数据包标识,可为空字符串|
 |data|object|-|是|传送参数的对象|
 |+state|int||是|启用待机实时反馈<br>0-不启用<br>1-启用|
-|+mode|int||是|启动待机反馈类型，state=1时有效<br>0-举手<br>1-指定按键反馈|
+|+mode|int||是|启动待机反馈类型，state=1时有效<br>1 - 指定按键反馈|
 |+keys|int||是|有效按键数量，state=1且mode=1时有效, 范围1-10|
  
 - **示例代码**
 ```json
-//启用举手反馈
-{
-  "fun":"setKpStbResponse",
-  "dataTag":"1",
-  "data":{
-    "state":1,
-    "mode":0
-  }
-}
 //启用待机按键反馈
 {
   "fun":"setKpStbResponse",
@@ -2514,7 +2533,7 @@
  
 - **示例代码**
 ```json
-//启用举手反馈
+//获取实时反馈状态
 {
   "fun":"getKpStbResponse",
   "dataTag":"1"
@@ -2997,7 +3016,7 @@
 #### 方法
 ##### startKpScoreInput
 - **主题**：/client/\${baseSN}/send
-- **功能描述**：启动标准测验
+- **功能描述**：启动自主录分
 - **参数说明**
  
 |参数名|类型|限制|是否必填|说明|
@@ -3010,7 +3029,7 @@
 |+questions|array||是|题目详情|
 |++max |int||是|可输入的最大值，<=100|
 |++digits|int||是|可输入的小数位数，范围0-2|
-|++startNo | string||是| 起始题号(暂不支持自定义题号，只能按顺序显示)|
+|++startNo | string||是| 起始题号，暂只支持一级题号，范围1-255|
 |++count | int||是| 相同参数的题目数量，>0<br>注意：总题数最多支持200题|
  
 - **示例代码**
@@ -53,6 +53,7 @@ Ver5.1.11
 |5.1.9| 2024年07月19日|陈定敏|1.  增加获取SDK版本接口|
 |5.1.10| 2024年09月03日|陈定敏|1.  移去主动获取在线信息接口|
 |5.1.11| 2024年10月17日|刘琴|1.  增加设置基站容量的接口|
+|5.1.12| 2024年11月01日|刘琴|1.  修改writeKeyMessage接口中keySnList说明|
  
 <br>
  
@@ -707,6 +708,7 @@ infos:{}
  
 fun: "keyPadAuthorize" //
 baseId: "1"//收到的基站ID
+keySnList:[{"keySn": "0112540402"}]  //指定键盘SN，不可为空
 params:{} //默认空
  
 | **Json字段** | **字段含义** | **赋值及含义** |
@@ -4630,7 +4632,7 @@ params:{} //数组对象，指定键盘需填
 发送：
 fun: "addWhiteList" //追加键盘
 params:{} //键盘sn 
-keySnList:[ "keySn":"2111120140"]	//列表不能为空
+keySnList:[ {"keySn":"2111120140"} ]	//列表不能为空
  
 指令样例：
  
@@ -4679,8 +4681,7 @@ infos:{}//
 发送：
 fun: "delWhiteList" //踢出键盘,删除键盘
 params:{} //键盘sn 
-keySnList:[ "keySn":"2111120140"]	//列表不能为空
-
+keySnList:[ {"keySn":"2111120140"} ]	//列表不能为空
  
 指令样例：
  
@@ -4918,13 +4919,13 @@ infos:{ }//返回基站
 写
  
 fun: "writeKeypadDevice" //写键盘外设,由led灯、蜂鸣器、马达组合
+keySnList:[{"keySn":"0007899478"}]  //指定键盘SN列表，为空表示所有在线键盘
 params：{} //
  
 数组对象,对象中的默认值为空字符串，各类(led、beep、motor)外设字段都不设置,表示该类不设置
  
 | **Json字段** | **字段含义** | **赋值及含义** |
 | --- | --- | --- |
-| keySn | 键盘SN |空字符串，为所有在线键盘|
 | ledTimes | Led灯闪烁次数 | 0~255 (0是马上灭，255是长亮)|
 | ledOnTime | Led灯每次开时间 |0~255 (单位0.1s)|
 | ledOffTime | Led灯每次关时间 |0~255 (单位0.1s，为0就是连续亮)|
@@ -5427,11 +5428,11 @@ infos:{&quot;keySn&quot;:&quot;1837454011&quot;,&quot;state&quot;:&quot;OK&quot;}//遥控键盘关机
  
 写
 fun: "writeKeyMessage" //写键盘短消息
+keySnList:[{"keySn":"0007899478"}]  //指定键盘SN列表，为空表示所有在线键盘
 params：{} // 数组对象,对象中的默认值为空字符串
  
 | **Json字段** | **字段含义** | **赋值及含义** |
 | --- | --- | --- |
-|keySn|键盘SN|空字符串，为所有在线键盘|
 |txt|短消息内容|字符串最长40字节[20汉字]|
  
  
@@ -5552,7 +5553,6 @@ infos:{}//
  
 | **Json字段** | **字段含义** | **赋值及含义** |
 | --- | --- | --- |
-|keySn|键盘SN||
 |state|返回信息|OK(成功)|
  
  
@@ -53,6 +53,7 @@ Ver5.1.11
 |5.1.9| 2024年07月19日|陈定敏|1.  增加获取SDK版本接口|
 |5.1.10| 2024年09月03日|陈定敏|1.  外部版移去主动获取在线信息接口，版本号更新|
 |5.1.11| 2024年10月17日|刘琴|1.  增加设置基站容量的接口|
+|5.1.12| 2024年11月01日|刘琴|1.  修改writeKeyMessage接口中keySnList说明|
  
 <br>
  
@@ -707,6 +708,7 @@ infos:{}
  
 fun: "keyPadAuthorize" //
 baseId: "1"//收到的基站ID
+keySnList:[{"keySn": "0112540402"}]  //指定键盘SN，不可为空
 params:{} //默认空
  
 | **Json字段** | **字段含义** | **赋值及含义** |
@@ -5566,7 +5568,7 @@ params:{} //数组对象，指定键盘需填
 发送：
 fun: "addWhiteList" //追加键盘
 params:{} //键盘sn 
-keySnList:[ "keySn":"2111120140"]	//列表不能为空
+keySnList:[ {"keySn":"2111120140"} ]	//列表不能为空
  
 指令样例：
  
@@ -5615,8 +5617,7 @@ infos:{}//
 发送：
 fun: "delWhiteList" //踢出键盘,删除键盘
 params:{} //键盘sn 
-keySnList:[ "keySn":"2111120140"]	//列表不能为空
-
+keySnList:[ {"keySn":"2111120140"} ]	//列表不能为空
  
 指令样例：
  
@@ -6092,13 +6093,13 @@ infos:{&quot;bic&quot;:&quot;A455&quot;, &quot;pid&quot;: &quot;EA10&quot;}//
 写
  
 fun: "writeKeypadDevice" //写键盘外设,由led灯、蜂鸣器、马达组合
+keySnList:[{"keySn":"0007899478"}]  //指定键盘SN列表，为空表示所有在线键盘
 params：{} //
  
 数组对象,对象中的默认值为空字符串，各类(led、beep、motor)外设字段都不设置,表示该类不设置
  
 | **Json字段** | **字段含义** | **赋值及含义** |
 | --- | --- | --- |
-| keySn | 键盘SN |空字符串，为所有在线键盘|
 | ledTimes | Led灯闪烁次数 | 0~255 (0是马上灭，255是长亮)|
 | ledOnTime | Led灯每次开时间 |0~255 (单位0.1s)|
 | ledOffTime | Led灯每次关时间 |0~255 (单位0.1s，为0就是连续亮)|
@@ -6657,11 +6658,11 @@ infos:{&quot;value&quot;:&quot;0&quot;}//10秒
  
 写
 fun: "writeKeyMessage" //写键盘短消息
+keySnList:[{"keySn":"0007899478"}]  //指定键盘SN列表，为空表示所有在线键盘
 params：{} // 数组对象,对象中的默认值为空字符串
  
 | **Json字段** | **字段含义** | **赋值及含义** |
 | --- | --- | --- |
-|keySn|键盘SN|空字符串，为所有在线键盘|
 |txt|短消息内容|字符串最长40字节[20汉字]|
  
  
@@ -6917,7 +6918,6 @@ infos:{}//
  
 | **Json字段** | **字段含义** | **赋值及含义** |
 | --- | --- | --- |
-|keySn|键盘SN||
 |state|返回信息|OK(成功)|