From b0429b7074e75abb296b8f86602ea25d496ef915 Mon Sep 17 00:00:00 2001 From: liuqin Date: Thu, 24 Apr 2025 15:09:59 +0800 Subject: [PATCH] 1. 修改fEvtKpOnlineMsg返回为数组形式 2. 增加内部指令stopBsUpdate、stopFontLibUpdate,返回状态增加 3 - 收到停止指令 --- 通讯协议-平台化-应用部分.md | 68 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++--------- 1 file changed, 59 insertions(+), 9 deletions(-) diff --git a/通讯协议-平台化-应用部分.md b/通讯协议-平台化-应用部分.md index 8ddd198..b608d57 100644 --- a/通讯协议-平台化-应用部分.md +++ b/通讯协议-平台化-应用部分.md @@ -32,7 +32,7 @@ SunVote 二次开发
通讯协议

-Ver 1.0.1 +Ver 1.0.2


@@ -48,7 +48,7 @@ Ver 1.0.1
-二〇二五年三月 +二〇二五年四月

@@ -66,7 +66,8 @@ Ver 1.0.1
| 文档版本 | 日期 | 作者 | 版本说明 | |---|---|---|---| -|1.0.1| 2025年3月24日|刘琴|1. 初始版
2. 修改fEvtKpOnlineMsg返回为数组形式| +|1.0.1| 2025年3月24日|刘琴|1. 建立版本| +|1.0.2| 2025年4月24日|刘琴|1. 修改fEvtKpOnlineMsg返回为数组形式
2. 增加内部指令stopBsUpdate、stopFontLibUpdate,返回状态增加 3 - 收到停止指令|

@@ -245,7 +246,9 @@ WebSocket方式应用与SDK或基站建立长连接后,通过WebSocket接口 ||基站断电复位|[resetBsPower](#resetbspower)|[sEvtStateCode](#sevtstatecode)
[sEvtBsConnectState](#sevtbsconnectstate)| ||基站自检(内)|[startBsSelfCheck](#startbsselfcheck)|[sEvtStateCode](#sevtstatecode)
[fEvtBsSelfCheck](#fevtbsselfcheck)| |基站升级|开启基站升级(内)|[startBsUpdate](#startbsupdate)|[sEvtStateCode](#sevtstatecode)
[fEvtBsUpateState](#fevtbsupatestate)
[fEvtBsUpdateProgress](#fevtbsupdateprogress)| -||下载字库(内)|[downloadFontLib](#downloadfontlib)|[sEvtStateCode](#sevtstatecode)
[fEvtBsFontLibState](#fevtbsfontlibstate)
[fEvtBsFontLibProgress](#fevtbsfontlibprogress)| +||停止基站升级(内)|[stopBsUpdate](#stopbsupdate)|[sEvtStateCode](#sevtstatecode)
[fEvtBsUpateState](#fevtbsupatestate)| +||下载字库(内)|[downloadFontLib](#downloadfontlib)|[sEvtStateCode](#sevtstatecode)
[fEvtBsFontLibState](#fevtbsfontlibstate)
[fEvtBsFontLibProgress](#fevtbsfontlibprogress)| +||停止基站字库升级(内)|[stopFontLibUpdate](#stopfontlibupdate)|[sEvtStateCode](#sevtstatecode)
[fEvtBsFontLibState](#fevtbsfontlibstate)| ### 键盘管理 |功能归类|功能|API指令|指令事件| |---|---|---|---| @@ -2496,7 +2499,7 @@ WebSocket方式应用与SDK或基站建立长连接后,通过WebSocket接口 |+port|int||是|端口,默认1883| |+userName|string||否|连接服务器的用户名,可不设置| |+password|string||否|连接服务器的密码,可不设置| -|+interval|int|>=10|否|基站连接服务器失败后重连的间隔时长,单位秒| +|+interval|int||否|基站连接服务器失败后重连的间隔时长,单位秒| - **示例代码** ```json @@ -2777,7 +2780,7 @@ WebSocket方式应用与SDK或基站建立长连接后,通过WebSocket接口 |baseSn|string||是|基站的出厂编码| |data|object|-|是|传送参数的对象| |+partition|int||是|存储区域
1-备份区 使用备份区固件的方法:打开基站盖子,按住SW1按钮,上电后松开按钮,这时基站固件就会更新成备份区的固件
2-更新区,实时升级基站固件| -|+url|string||是|待升级的固件地址,可访问的网络url| +|+url|string||是|待升级的固件地址,可访问的网络url
直连基站为本地的文件路径| |+version|string||是|待升级的基站固件版本| |+crc|uint||是|固件CRC校验码,10进制数字| + +- **示例代码** +```json +{ + "fun":"stopBsUpdate", + "dataTag":"1", + "baseSn":"2024061101" +} +``` + ##### downloadFontLib - **主题**:/manage/{baseSN}/send -- **功能描述**:下载更新基站字库文件 +- **功能描述**: 下载更新基站字库文件 - **参数说明** |参数名|类型|限制|是否必填|说明| @@ -2829,6 +2856,29 @@ WebSocket方式应用与SDK或基站建立长连接后,通过WebSocket接口 } } ``` +##### stopFontLibUpdate +- **主题**:/manage/{baseSN}/send +- **功能描述**: 停止基站字库升级 +- **参数说明** + +|参数名|类型|限制|是否必填|说明| +|---|---|---|---|---| +|fun|string|-|是|指令名称| +|dataTag|string|-|否|数据包标识,可为空字符串| +|baseSn|string||是|基站的出厂编码| +|data|object|-|是|传送参数的对象| + + +- **示例代码** +```json +{ + "fun":"stopFontLibUpdate", + "dataTag":"1", + "baseSn":"2024061101" +} +``` + #### 事件 ##### [sEvtStateCode](#sevtstatecode) @@ -2846,7 +2896,7 @@ WebSocket方式应用与SDK或基站建立长连接后,通过WebSocket接口 |dataTag|string|-|否|数据包标识,可为空字符串| |baseSn|string||是|基站的出厂编码| |data|object|-|是|传送参数的对象| -|+state|int||是|启动升级状态
0 - 准备升级
1 - 升级成功
2 - 升级失败 +|+state|int||是|启动升级状态
0 - 准备升级
1 - 升级成功
2 - 升级失败
3 - 已停止(接收到停止指令)| |+msg|string||否|返回的失败原因 - **示例代码** @@ -2898,7 +2948,7 @@ WebSocket方式应用与SDK或基站建立长连接后,通过WebSocket接口 |dataTag|string|-|否|数据包标识,可为空字符串| |baseSn|string||是|基站的出厂编码| |data|object|-|是|传送参数的对象| -|+state|int||是|启动升级状态
0 - 准备下载
1 - 下载完成
2 - 下载失败 +|+state|int||是|启动升级状态
0 - 准备下载
1 - 下载完成
2 - 下载失败
3 - 已停止(接收到停止指令)| |+msg|string||否|返回的失败原因 - **示例代码** -- libgit2 0.21.4