修改BIC说明，增加基站自检功能

刘琴
1 parent f3310fd7
Showing 1 changed file with 91 additions and 16 deletions
通讯协议-B200W-MQTT协议[内部].md
@@ -105,7 +105,7 @@
 |识别设置 - 出厂编码|<font color="red">设置基站出厂编码(内)|[setBsSN](#setbssn)|[fEvtBsSN](#fevtbssn)|
 |识别设置 - 基站型号|读取基站型号|[getBsModel](#getbsmodel)|[fEvtBsModel](#fevtbsmodel)|
 |识别设置 - 固件版本|获取基站固件版本|[getBsFWVersion](#getbsfwversion)|[fEvtBsFWVersion](#fevtbsfwversion)|
-|识别设置 - 品牌识别码|获取基站品牌识别码|[getBsBIC](#getbsbic)|[fEvtBsBIC](#fevtbsbic)|
+|识别设置 - 品牌识别码|<font color="red">获取基站品牌识别码(内)</font>|[getBsBIC](#getbsbic)|[fEvtBsBIC](#fevtbsbic)|
 ||<font color="red">设置基站品牌识别码(内)|[setBsBIC](#setbsbic)|[fEvtBsBIC](#fevtbsbic)|
 |组网设置 - 组网模式|获取基站组网模式|[getBsNetworkMode](#getbsnetworkmode)|[fEvtBsNetworkMode](#fevtbsnetworkmode)|
 ||<font color="blue">设置基站组网模式<br>(前期不开放，后期需要)|[setBsNetworkMode](#setbsnetworkmode)|[fEvtBsNetworkMode](#fevtbsnetworkmode)|
@@ -148,6 +148,7 @@
 ||<font color="red">清空基站日志(内)</font>|[clearBsLogInfo](#clearbsloginfo)|[sEvtStateCode](#sevtstatecode)|
 ||基站软复位|[resetBsSystem](#resetbssystem)|[sEvtStateCode](#sevtstatecode)<br>[sEvtBsConnectState](#sevtbsconnectstate)|
 ||基站断电复位|[resetBsPower](#resetbspower)|[sEvtStateCode](#sevtstatecode)<br>[sEvtBsConnectState](#sevtbsconnectstate)|
+||基站自检|[startBsSelfCheck](#startbsselfcheck)|[sEvtStateCode](#sevtstatecode)<br>[fEvtBsSelfCheck](#fevtbsselfcheck)|
 |基站升级|<font color="red">开启基站升级(内)|[startBsUpdate](#startbsupdate)|[sEvtStateCode](#sevtstatecode)<br>[fEvtBsUpateState](#fevtbsupatestate)<br>[fEvtBsUpdateProgress](#fevtbsupdateprogress)|
 ||<font color="red">下载字库(内)|[downloadFontLib](#downloadfontlib)|[sEvtStateCode](#sevtstatecode)<br>[fEvtBsFontLibState](#fevtbsfontlibstate)<br>[fEvtBsFontLibProgress](#fevtbsfontlibprogress)|
 ### 键盘管理
@@ -343,19 +344,23 @@
 |---|---|---|---|---|
 |fun|string|-|是|事件名称|
 |dataTag|string|-|否|数据包标识|
-|data|object|-|是|传送参数的对象|
-|+keySn|string||是|键盘SN|
-|+keyValue|string||是|键盘提交的按键值|
+|data|array|-|是|传送参数的对象数组|
+|++keySn|string||是|键盘SN|
+|++keyValue|string||是|键盘提交的按键值|
+|++voltage|double||是|键盘电量|
+|++retryCount|int||是|键盘提交数据的重发次数|
  
 - **示例代码**
 ```json
 {
     "fun":"sEvtKpRtFeedback",
     "dataTag":"1",
-    "data":{ 
+    "data":[{ 
         "keySn":"1234567890",
-        "keyValue":"A"
-    }
+        "keyValue":"A",
+        "voltage":2.6,
+        "retryCount":1
+    }]
 }
 ```
 ### sEvtKpHandUp
@@ -409,6 +414,7 @@
 |20008|value参数错误|
 |30001|基站在答题中|
 |30002|基站忙(内存不足)|
+|30003|基站执行失败|
 |40001|升级功能只能支持一个基站|
 |50001|此功能必须指定基站|
 |60001|此功能必须指定键盘SN|
@@ -583,7 +589,7 @@
 }
 ```
 ##### getBsBIC
-- **主题**：/client/\${baseSN}/send
+- **主题**：<sapn class="yellowFill">/manage/\${baseSN}/send</span>
 - **功能描述**：获取基站品牌识别码
 - **参数说明**
  
@@ -619,7 +625,7 @@
   "fun":"setBsBIC",
   "dataTag":"1",
   "data":{
-    "value":"sunvote"
+    "value":"EA10"
   }
 }
 ```
@@ -691,7 +697,7 @@
 }
 ```
 ##### fEvtBsBIC
-- **主题**: /basestation/\${baseSN}/receive
+- **主题**: <sapn class="yellowFill">/manage/\${baseSN}/receive</span>
 - **功能描述**：返回基站的品牌码
 - **参数说明**
  
@@ -700,7 +706,7 @@
 |fun|string|-|是|事件名称|
 |dataTag|string|-|否|数据包标识|
 |data|object|-|是|传送参数的对象|
-|+value|string||是|基站的品牌码|
+|+value|string||是|基站的品牌码<br>EA10: 中天电子<br>B001: 科大讯飞<br>B002: 台湾网奕<br>B003: 德国Infowhyse<br>B004: 印度K12 Techno<br>B005: 印度UOLO |
  
 - **示例代码**
 ```json
@@ -708,7 +714,7 @@
     "fun":"fEvtBsBIC",
     "dataTag":"1",
     "data":{
-        "value":"sunvote"
+        "value":"EA10"
     }
 }
 ```
@@ -1800,7 +1806,7 @@
 |+port|int||是|端口，默认1883|
 |+userName|string||否|连接服务器的用户名，可不设置|
 |+password|string||否|连接服务器的密码，可不设置|
-|+interval|int|>=10|否|基站连接服务器失败后重连的间隔时长，单位秒|
+|+interval|int|>=60|否|基站连接服务器失败后重连的间隔时长，单位秒|
  
 - **示例代码**
 ```json
@@ -1812,7 +1818,7 @@
     "port":1883,
     "userName":"",
     "password":"",
-    "interval":30
+    "interval":60
   }
 }
 ```
@@ -2015,6 +2021,24 @@
 }
 ```
  
+##### startBsSelfCheck
+- **主题**：<sapn class="yellowFill">/manage/\${baseSN}/send</span>
+- **功能描述**：开始基站自检,基站自检状态中不接收其他指令，空闲状态中才进入自检
+- **参数说明**
+
+|参数名|类型|限制|是否必填|说明|
+|---|---|---|---|---|
+|fun|string|-|是|指令名称|
+|dataTag|string|-|否|数据包标识,可为空字符串|
+
+- **示例代码**
+```json
+{
+  "fun":"startBsSelfCheck",
+  "dataTag":"1"
+}
+```
+
 #### 事件
 ##### [sEvtStateCode](#sevtstatecode)
 返回指令的接收状态
@@ -2047,6 +2071,46 @@
   }
 }
 ```
+
+##### fEvtBsSelfCheck
+- **主题**: <sapn class="yellowFill">/manage/\${baseSN}/receive</span>
+- **功能描述**：返回基站自检的结果
+- **参数说明**
+
+|参数名|类型|限制|非空|说明|
+|---|---|---|---|---|
+|fun|string|-|是|指令名称|
+|dataTag|string|-|否|数据包标识,可为空字符串|
+|data|array|-|是|传送参数的对象数组|
+|++name|string||是|检测项名称：MCU、RF、FLASH、EEPROM|
+|++state|int||是|检测结果<br>0-功能异常<br>1-功能正常|
+
+- **示例代码**
+```json
+{
+  "fun":"fEvtBsSelfCheck",
+  "dataTag":"1",
+  "data":[
+    {
+      "name":"MCU",
+      "state":1
+    },
+    {
+      "name":"RF",
+      "state":1
+    },
+    {
+      "name":"FLASH",
+      "state":1
+    },
+    {
+      "name":"EEPROM",
+      "state":1
+    }
+  ]
+}
+```
+
 ### 基站升级
 #### 方法
 ##### startBsUpdate
@@ -3289,7 +3353,7 @@
 |++keySn|string||是|键盘SN|
 |++keyValue|string||是|键盘提交的按键值|
 |++keyTime|double||是|答题时间，从启动开始计算，单位秒|
-|++voltage|double||是|键盘电量</font>|
+|++voltage|double||是|键盘电量|
 |++retryCount|int||是|键盘提交数据的重发次数|
  
 - **示例代码**
@@ -3469,11 +3533,12 @@
 |fun|string|-|是|指令名称|
 |dataTag|string|-|否|数据包标识,可为空字符串|
 |data|array|-|是|传送参数的对象数组|
-|+state|int||是|启用待机实时反馈<br>0-不启用<br>1-启用|
+|+state|int||是|启用待机实时反馈<br>0-未启用<br>1-启用|
 |+mode|int||是|当前启动待机反馈类型，state=1时返回<br>0-举手<br>1-指定按键反馈|
  
 - **示例代码**
 ```json
+//当前启用待机实时反馈，模式为指定按键反馈
 {
   "fun":"fEvtKpStbResponse",
   "dataTag":"1",
@@ -3482,6 +3547,15 @@
     "mode": 1
   }
 }
+
+//当前未启用待机反馈
+{
+  "fun":"fEvtKpStbResponse",
+  "dataTag":"1",
+  "data": {
+    "state": 0
+  }
+}
 ```
  
 ##### [sEvtKpRtFeedback](#sevtkprtfeedback)
@@ -3489,6 +3563,7 @@
  
 ##### [sEvtKpHandup](#sevtkphandup)
 启动待机按键反馈类型为举手提问时返回此事件
+
 ## 在线测验
 ### 标准测验
 #### 方法