修改基站和键盘升级的返回事件

刘琴
1 parent c22b3041
Showing 1 changed file with 20 additions and 40 deletions
通讯协议-B200W-MQTT协议[内部].md
@@ -81,7 +81,7 @@
 ||设置TCP/IP参数|[setBsTcpipParams](#setbstcpipparams)|[fEvtBsTcpipParams](#fevtbstcpipparams)||
 |MQTT参数|获取MQTT参数|[getBsMqttParams](#getbsmqttparams)|[fEvtBsMqttParams](#fevtbsmqttparams)|
 ||设置MQTT参数|[setBsMqttParams](#setbsmqttparams)|[fEvtBsMqttParams](#fevtbsmqttparams)||
-|基站升级|<font color="red">开启基站升级(内)|[startBsUpdate](#startbsupdate)|[fEvtStartBsUpate](#fevtstartbsupate)<br>[fEvtBsUpdateProgress](#fevtbsupdateprogress)|
+|基站升级|<font color="red">开启基站升级(内)|[startBsUpdate](#startbsupdate)|[sEvtStateCode](#sevtstatecode)<br>[fEvtBsUpateState](#fevtbsupatestate)<br>[fEvtBsUpdateProgress](#fevtbsupdateprogress)|
 ### 键盘管理
 |功能归类|功能|API指令|指令事件|
 |---|---|---|---|
@@ -91,8 +91,8 @@
 ||停止扫描在线键盘|[stopGetKpOnline](#stopgetkponline)|[sEvtStateCode](#sevtstatecode)|
 |维护功能 - 遥控功能|遥控键盘关机|[remoteKpPowerOff](#remotekppoweroff)|[sEvtStateCode](#sevtstatecode)|
 ||遥控键盘休眠|[remoteKpSleep](#remotekpsleep)|[sEvtStateCode](#sevtstatecode)|
-|维护功能 - 遥控功能|<font color="red">启动键盘无线升级(内)|[startKpFWUpdate](#startkpfwupdate)|[fEvtStartKpFWUpdate](#fevtstartkpfwupdate)<br>[fEvtKpUpdateProgress](#fevtkpupdateprogress)<br>[sEvtBsKpOnlineMsg](#sevtbskponlinemsg)|
-||<font color="red">停止键盘无线升级(内)|[stopKpFWUpdate](#stopkpfwupdate)|[fEvtStopKpFWUpdate](#fevtstopkpfwupdate)|
+|维护功能 - 键盘升级|<font color="red">启动键盘无线升级(内)|[startKpFWUpdate](#startkpfwupdate)|[sEvtStateCode](#sevtstatecode)<br>[fEvtKpFWUpdateState](#fevtkpfwupdatestate)<br>[fEvtKpUpdateProgress](#fevtkpupdateprogress)<br>[sEvtBsKpOnlineMsg](#sevtbskponlinemsg)|
+||<font color="red">停止键盘无线升级(内)|[stopKpFWUpdate](#stopkpfwupdate)|[sEvtStateCode](#sevtstatecode)<br>[fEvtKpFWUpdateState](#fevtkpfwupdatestate)|
 ### 绑定
 |功能归类|功能|API指令|指令事件|
 |---|---|---|---|
@@ -1094,7 +1094,11 @@
 }
 ```
 #### 事件
-##### fEvtStartBsUpate
+##### [sEvtStateCode](#sevtstatecode)
+返回升级指令的接收状态
+注意：升级指令的接收状态需从**主题: <sapn class="yellowFill">/manage/\${baseSN}/receive</span>** 返回
+
+##### fEvtBsUpateState
 - **主题**: <sapn class="yellowFill">/manage/\${baseSN}/receive</span>
 - **功能描述**：返回基站启动升级状态
 - **参数说明**
@@ -1104,7 +1108,7 @@
 |fun|string|-|是|指令名称|
 |dataTag|string|-|否|数据包标识,可为空字符串|
 |data|object|-|是|传送参数的对象|
-|+state|int||是|启动升级状态<br>0 - 成功<br>1 - 失败
+|+state|int||是|启动升级状态<br>0 - 准备升级<br>1 - 升级成功<br>2 - 升级失败
 |+msg|string||否|返回的失败原因
  
 - **示例代码**
@@ -1113,7 +1117,7 @@
   "fun":"fEvtStartBsUpate",
   "dataTag":"1",
   "data":{
-    "state":1,
+    "state":2,
     "msg":"error msg"
   }
 }
@@ -1130,7 +1134,6 @@
 |dataTag|string|-|否|数据包标识,可为空字符串|
 |data|object|-|是|传送参数的对象|
 |+progress|int||是|升级进度，百分比|
-|+status|int||是|升级状态<br>0 - 未开始<br>1 - 升级中<br>2 - 升级完成|
  
 - **示例代码**
 ```Json
@@ -1138,8 +1141,7 @@
   "fun":"fEvtBsUpdateProgress",
   "dataTag":"1",
   "data":{
-    "progress":20,
-    "status":1
+    "progress":20
   }
 }
 ```
@@ -1402,9 +1404,13 @@
 ```
  
 #### 事件
-##### fEvtStartKpFWUpdate
+##### [sEvtStateCode](#sevtstatecode)
+返回升级指令的接收状态
+注意：升级指令的接收状态需从**主题: <sapn class="yellowFill">/manage/\${baseSN}/receive</span>** 返回
+
+##### fEvtKpFWUpdateState
 - **主题**: <sapn class="yellowFill">/manage/\${baseSN}/receive</span>
-- **功能描述**：返回键盘启动升级状态
+- **功能描述**：返回键盘升级状态
 - **参数说明**
  
 |参数名|类型|限制|非空|说明|
@@ -1412,13 +1418,13 @@
 |fun|string|-|是|指令名称|
 |dataTag|string|-|否|数据包标识,可为空字符串|
 |data|object|-|是|传送参数的对象|
-|+state|int||是|启动升级状态<br>0 - 成功<br>1 - 失败
+|+state|int||是|升级状态<br>0 - 进入升级<br>1 - 升级成功 <br> 2 - 升级失败 <br> 3 - 已停止(接收到停止指令)
 |+msg|string||否|返回的失败原因
  
 - **示例代码**
 ```Json
 {
-  "fun":"fEvtStartKpFWUpdate",
+  "fun":"fEvtKpFWUpdateState",
   "dataTag":"1",
   "data":{
     "state":0,
@@ -1437,7 +1443,6 @@
 |dataTag|string|-|否|数据包标识,可为空字符串|
 |data|object|-|是|传送参数的对象|
 |+progress|int||是|升级进度，百分比|
-|+status|int||是|升级状态<br>0 - 未开始<br>1 - 升级中<br>2 - 升级完成|
  
 - **示例代码**
 ```Json
@@ -1445,32 +1450,7 @@
   "fun":"fEvtKpUpdateProgress",
   "dataTag":"1",
   "data":{
-    "progress":20,
-    "status":1
-  }
-}
-```
-##### fEvtStopKpFWUpdate
-- **主题**: <sapn class="yellowFill">/manage/\${baseSN}/receive</span>
-- **功能描述**：返回停止键盘升级指令接收状态
-- **参数说明**
-
-|参数名|类型|限制|非空|说明|
-|---|---|---|---|---|
-|fun|string|-|是|指令名称|
-|dataTag|string|-|否|数据包标识,可为空字符串|
-|data|object|-|是|传送参数的对象|
-|+state|int||是|停止升级状态<br>0 - 成功<br>1 - 失败
-|+msg|string||否|返回的失败原因
-
-- **示例代码**
-```Json
-{
-  "fun":"fEvtStopKpFWUpdate",
-  "dataTag":"1",
-  "data":{
-    "state":0,
-    "msg":""
+    "progress":20
   }
 }
 ```