增加下载字库的内容

刘琴
1 parent f0ca17e7
Showing 1 changed file with 85 additions and 5 deletions
通讯协议-B200W-MQTT协议[内部].md
@@ -82,6 +82,7 @@
 |网络设置 - MQTT参数|获取MQTT参数|[getBsMqttParams](#getbsmqttparams)|[fEvtBsMqttParams](#fevtbsmqttparams)|
 ||设置MQTT参数|[setBsMqttParams](#setbsmqttparams)|[fEvtBsMqttParams](#fevtbsmqttparams)||
 |基站升级|<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)|
 ### 键盘管理
 |功能归类|功能|API指令|指令事件|
 |---|---|---|---|
@@ -1003,8 +1004,7 @@
     "port":1883,
     "userName":"",
     "password":"",
-    "interval":30,
-    "ipAllocation":1
+    "interval":30
   }
 }
 ```
@@ -1094,13 +1094,44 @@
   "fun":"startBsUpdate",
   "dataTag":"1",
   "data":{
-    "partition":1,
+    "partition":2,
     "url":"http://192.168.10.10/V1.0.3.bin",
     "version":"1.0.3",
-    "crc":""
+    "crc":"1429319861"
   }
 }
 ```
+##### downloadFontLib
+- **主题**：<sapn class="yellowFill">/manage/\${baseSN}/send</span>
+- **功能描述**:下载更新基站字库文件
+- **参数说明**
+
+|参数名|类型|限制|是否必填|说明|
+|---|---|---|---|---|
+|fun|string|-|是|指令名称|
+|dataTag|string|-|否|数据包标识,可为空字符串|
+|data|object|-|是|传送参数的对象|
+|+partition|int||是|存储区域<br> 1-备份区<br>2-更新区|
+|+url|string||是|待下载的字库地址，可访问的网络url|
+|+version|string||是|待升级的字库版本|
+|+crc|string||是|字库CRC校验码，10进制|
+|+time|string||是|时间，yyyyMMddHHmmss|
+|+verCode|string||是|内部主题校验码，时间+固定key加密|
+
+- **示例代码**
+```Json
+{
+  "fun":"downloadFontLib",
+  "dataTag":"1",
+  "data":{
+    "partition":2,
+    "url":"http://192.168.10.10/V1.0.3.txt",
+    "version":"1.0.3",
+    "crc":"1429319861"
+  }
+}
+```
+
 #### 事件
 ##### [sEvtStateCode](#sevtstatecode)
 返回升级指令的接收状态
@@ -1153,6 +1184,55 @@
   }
 }
 ```
+
+##### fEvtBsFontLibState
+- **主题**: <sapn class="yellowFill">/manage/\${baseSN}/receive</span>
+- **功能描述**：返回基站下载字库状态
+- **参数说明**
+
+|参数名|类型|限制|非空|说明|
+|---|---|---|---|---|
+|fun|string|-|是|指令名称|
+|dataTag|string|-|否|数据包标识,可为空字符串|
+|data|object|-|是|传送参数的对象|
+|+state|int||是|启动升级状态<br>0 - 准备下载<br>1 - 下载完成<br>2 - 下载失败
+|+msg|string||否|返回的失败原因
+
+- **示例代码**
+```Json
+{
+  "fun":"fEvtBsFontLibState",
+  "dataTag":"1",
+  "data":{
+    "state":2,
+    "msg":"error msg"
+  }
+}
+```
+
+##### fEvtBsFontLibProgress
+- **主题**: <sapn class="yellowFill">/manage/\${baseSN}/receive</span>
+- **功能描述**：返回基站下载字库进度
+- **参数说明**
+
+|参数名|类型|限制|非空|说明|
+|---|---|---|---|---|
+|fun|string|-|是|指令名称|
+|dataTag|string|-|否|数据包标识,可为空字符串|
+|data|object|-|是|传送参数的对象|
+|+progress|int||是|下载进度，百分比|
+
+- **示例代码**
+```Json
+{
+  "fun":"fEvtBsFontLibProgress",
+  "dataTag":"1",
+  "data":{
+    "progress":20
+  }
+}
+```
+
 ## 键盘管理
 ### 交互设置
 #### 方法
@@ -1391,7 +1471,7 @@
   "fun":"startKpFWUpdate",
   "dataTag":"1",
   "data":{
-    "partition":1,
+    "partition":2,
     "url":"http://192.168.10.10/V1.0.3.bin",
     "version":"1.0.3",
     "crc":""