Commit 4e55ae70b460ed492015bc5dbd75ffab9732f7f2

Authored by 刘琴
1 parent c22b3041

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

通讯协议-B200W-MQTT协议[内部].md
@@ -81,7 +81,7 @@ @@ -81,7 +81,7 @@
81 ||设置TCP/IP参数|[setBsTcpipParams](#setbstcpipparams)|[fEvtBsTcpipParams](#fevtbstcpipparams)|| 81 ||设置TCP/IP参数|[setBsTcpipParams](#setbstcpipparams)|[fEvtBsTcpipParams](#fevtbstcpipparams)||
82 |MQTT参数|获取MQTT参数|[getBsMqttParams](#getbsmqttparams)|[fEvtBsMqttParams](#fevtbsmqttparams)| 82 |MQTT参数|获取MQTT参数|[getBsMqttParams](#getbsmqttparams)|[fEvtBsMqttParams](#fevtbsmqttparams)|
83 ||设置MQTT参数|[setBsMqttParams](#setbsmqttparams)|[fEvtBsMqttParams](#fevtbsmqttparams)|| 83 ||设置MQTT参数|[setBsMqttParams](#setbsmqttparams)|[fEvtBsMqttParams](#fevtbsmqttparams)||
84 -|基站升级|<font color="red">开启基站升级(内)|[startBsUpdate](#startbsupdate)|[fEvtStartBsUpate](#fevtstartbsupate)<br>[fEvtBsUpdateProgress](#fevtbsupdateprogress)| 84 +|基站升级|<font color="red">开启基站升级(内)|[startBsUpdate](#startbsupdate)|[sEvtStateCode](#sevtstatecode)<br>[fEvtBsUpateState](#fevtbsupatestate)<br>[fEvtBsUpdateProgress](#fevtbsupdateprogress)|
85 ### 键盘管理 85 ### 键盘管理
86 |功能归类|功能|API指令|指令事件| 86 |功能归类|功能|API指令|指令事件|
87 |---|---|---|---| 87 |---|---|---|---|
@@ -91,8 +91,8 @@ @@ -91,8 +91,8 @@
91 ||停止扫描在线键盘|[stopGetKpOnline](#stopgetkponline)|[sEvtStateCode](#sevtstatecode)| 91 ||停止扫描在线键盘|[stopGetKpOnline](#stopgetkponline)|[sEvtStateCode](#sevtstatecode)|
92 |维护功能 - 遥控功能|遥控键盘关机|[remoteKpPowerOff](#remotekppoweroff)|[sEvtStateCode](#sevtstatecode)| 92 |维护功能 - 遥控功能|遥控键盘关机|[remoteKpPowerOff](#remotekppoweroff)|[sEvtStateCode](#sevtstatecode)|
93 ||遥控键盘休眠|[remoteKpSleep](#remotekpsleep)|[sEvtStateCode](#sevtstatecode)| 93 ||遥控键盘休眠|[remoteKpSleep](#remotekpsleep)|[sEvtStateCode](#sevtstatecode)|
94 -|维护功能 - 遥控功能|<font color="red">启动键盘无线升级(内)|[startKpFWUpdate](#startkpfwupdate)|[fEvtStartKpFWUpdate](#fevtstartkpfwupdate)<br>[fEvtKpUpdateProgress](#fevtkpupdateprogress)<br>[sEvtBsKpOnlineMsg](#sevtbskponlinemsg)|  
95 -||<font color="red">停止键盘无线升级(内)|[stopKpFWUpdate](#stopkpfwupdate)|[fEvtStopKpFWUpdate](#fevtstopkpfwupdate)| 94 +|维护功能 - 键盘升级|<font color="red">启动键盘无线升级(内)|[startKpFWUpdate](#startkpfwupdate)|[sEvtStateCode](#sevtstatecode)<br>[fEvtKpFWUpdateState](#fevtkpfwupdatestate)<br>[fEvtKpUpdateProgress](#fevtkpupdateprogress)<br>[sEvtBsKpOnlineMsg](#sevtbskponlinemsg)|
  95 +||<font color="red">停止键盘无线升级(内)|[stopKpFWUpdate](#stopkpfwupdate)|[sEvtStateCode](#sevtstatecode)<br>[fEvtKpFWUpdateState](#fevtkpfwupdatestate)|
96 ### 绑定 96 ### 绑定
97 |功能归类|功能|API指令|指令事件| 97 |功能归类|功能|API指令|指令事件|
98 |---|---|---|---| 98 |---|---|---|---|
@@ -1094,7 +1094,11 @@ @@ -1094,7 +1094,11 @@
1094 } 1094 }
1095 ``` 1095 ```
1096 #### 事件 1096 #### 事件
1097 -##### fEvtStartBsUpate 1097 +##### [sEvtStateCode](#sevtstatecode)
  1098 +返回升级指令的接收状态
  1099 +注意:升级指令的接收状态需从**主题: <sapn class="yellowFill">/manage/\${baseSN}/receive</span>** 返回
  1100 +
  1101 +##### fEvtBsUpateState
1098 - **主题**: <sapn class="yellowFill">/manage/\${baseSN}/receive</span> 1102 - **主题**: <sapn class="yellowFill">/manage/\${baseSN}/receive</span>
1099 - **功能描述**:返回基站启动升级状态 1103 - **功能描述**:返回基站启动升级状态
1100 - **参数说明** 1104 - **参数说明**
@@ -1104,7 +1108,7 @@ @@ -1104,7 +1108,7 @@
1104 |fun|string|-|是|指令名称| 1108 |fun|string|-|是|指令名称|
1105 |dataTag|string|-|否|数据包标识,可为空字符串| 1109 |dataTag|string|-|否|数据包标识,可为空字符串|
1106 |data|object|-|是|传送参数的对象| 1110 |data|object|-|是|传送参数的对象|
1107 -|+state|int||是|启动升级状态<br>0 - 成功<br>1 - 失败 1111 +|+state|int||是|启动升级状态<br>0 - 准备升级<br>1 - 升级成功<br>2 - 升级失败
1108 |+msg|string||否|返回的失败原因 1112 |+msg|string||否|返回的失败原因
1109 1113
1110 - **示例代码** 1114 - **示例代码**
@@ -1113,7 +1117,7 @@ @@ -1113,7 +1117,7 @@
1113 "fun":"fEvtStartBsUpate", 1117 "fun":"fEvtStartBsUpate",
1114 "dataTag":"1", 1118 "dataTag":"1",
1115 "data":{ 1119 "data":{
1116 - "state":1, 1120 + "state":2,
1117 "msg":"error msg" 1121 "msg":"error msg"
1118 } 1122 }
1119 } 1123 }
@@ -1130,7 +1134,6 @@ @@ -1130,7 +1134,6 @@
1130 |dataTag|string|-|否|数据包标识,可为空字符串| 1134 |dataTag|string|-|否|数据包标识,可为空字符串|
1131 |data|object|-|是|传送参数的对象| 1135 |data|object|-|是|传送参数的对象|
1132 |+progress|int||是|升级进度,百分比| 1136 |+progress|int||是|升级进度,百分比|
1133 -|+status|int||是|升级状态<br>0 - 未开始<br>1 - 升级中<br>2 - 升级完成|  
1134 1137
1135 - **示例代码** 1138 - **示例代码**
1136 ```Json 1139 ```Json
@@ -1138,8 +1141,7 @@ @@ -1138,8 +1141,7 @@
1138 "fun":"fEvtBsUpdateProgress", 1141 "fun":"fEvtBsUpdateProgress",
1139 "dataTag":"1", 1142 "dataTag":"1",
1140 "data":{ 1143 "data":{
1141 - "progress":20,  
1142 - "status":1 1144 + "progress":20
1143 } 1145 }
1144 } 1146 }
1145 ``` 1147 ```
@@ -1402,9 +1404,13 @@ @@ -1402,9 +1404,13 @@
1402 ``` 1404 ```
1403 1405
1404 #### 事件 1406 #### 事件
1405 -##### fEvtStartKpFWUpdate 1407 +##### [sEvtStateCode](#sevtstatecode)
  1408 +返回升级指令的接收状态
  1409 +注意:升级指令的接收状态需从**主题: <sapn class="yellowFill">/manage/\${baseSN}/receive</span>** 返回
  1410 +
  1411 +##### fEvtKpFWUpdateState
1406 - **主题**: <sapn class="yellowFill">/manage/\${baseSN}/receive</span> 1412 - **主题**: <sapn class="yellowFill">/manage/\${baseSN}/receive</span>
1407 -- **功能描述**:返回键盘启动升级状态 1413 +- **功能描述**:返回键盘升级状态
1408 - **参数说明** 1414 - **参数说明**
1409 1415
1410 |参数名|类型|限制|非空|说明| 1416 |参数名|类型|限制|非空|说明|
@@ -1412,13 +1418,13 @@ @@ -1412,13 +1418,13 @@
1412 |fun|string|-|是|指令名称| 1418 |fun|string|-|是|指令名称|
1413 |dataTag|string|-|否|数据包标识,可为空字符串| 1419 |dataTag|string|-|否|数据包标识,可为空字符串|
1414 |data|object|-|是|传送参数的对象| 1420 |data|object|-|是|传送参数的对象|
1415 -|+state|int||是|启动升级状态<br>0 - 成功<br>1 - 失败 1421 +|+state|int||是|升级状态<br>0 - 进入升级<br>1 - 升级成功 <br> 2 - 升级失败 <br> 3 - 已停止(接收到停止指令)
1416 |+msg|string||否|返回的失败原因 1422 |+msg|string||否|返回的失败原因
1417 1423
1418 - **示例代码** 1424 - **示例代码**
1419 ```Json 1425 ```Json
1420 { 1426 {
1421 - "fun":"fEvtStartKpFWUpdate", 1427 + "fun":"fEvtKpFWUpdateState",
1422 "dataTag":"1", 1428 "dataTag":"1",
1423 "data":{ 1429 "data":{
1424 "state":0, 1430 "state":0,
@@ -1437,7 +1443,6 @@ @@ -1437,7 +1443,6 @@
1437 |dataTag|string|-|否|数据包标识,可为空字符串| 1443 |dataTag|string|-|否|数据包标识,可为空字符串|
1438 |data|object|-|是|传送参数的对象| 1444 |data|object|-|是|传送参数的对象|
1439 |+progress|int||是|升级进度,百分比| 1445 |+progress|int||是|升级进度,百分比|
1440 -|+status|int||是|升级状态<br>0 - 未开始<br>1 - 升级中<br>2 - 升级完成|  
1441 1446
1442 - **示例代码** 1447 - **示例代码**
1443 ```Json 1448 ```Json
@@ -1445,32 +1450,7 @@ @@ -1445,32 +1450,7 @@
1445 "fun":"fEvtKpUpdateProgress", 1450 "fun":"fEvtKpUpdateProgress",
1446 "dataTag":"1", 1451 "dataTag":"1",
1447 "data":{ 1452 "data":{
1448 - "progress":20,  
1449 - "status":1  
1450 - }  
1451 -}  
1452 -```  
1453 -##### fEvtStopKpFWUpdate  
1454 -- **主题**: <sapn class="yellowFill">/manage/\${baseSN}/receive</span>  
1455 -- **功能描述**:返回停止键盘升级指令接收状态  
1456 -- **参数说明**  
1457 -  
1458 -|参数名|类型|限制|非空|说明|  
1459 -|---|---|---|---|---|  
1460 -|fun|string|-|是|指令名称|  
1461 -|dataTag|string|-|否|数据包标识,可为空字符串|  
1462 -|data|object|-|是|传送参数的对象|  
1463 -|+state|int||是|停止升级状态<br>0 - 成功<br>1 - 失败  
1464 -|+msg|string||否|返回的失败原因  
1465 -  
1466 -- **示例代码**  
1467 -```Json  
1468 -{  
1469 - "fun":"fEvtStopKpFWUpdate",  
1470 - "dataTag":"1",  
1471 - "data":{  
1472 - "state":0,  
1473 - "msg":"" 1453 + "progress":20
1474 } 1454 }
1475 } 1455 }
1476 ``` 1456 ```