From fec773be52234682db51d266f0d06881883baa90 Mon Sep 17 00:00:00 2001 From: liuqin Date: Tue, 22 Apr 2025 09:32:59 +0800 Subject: [PATCH] 增加恢复键盘出厂设置接口，修改扫描返回事件为数组，增加下发的返回事件中状态-参数错误 --- 通讯协议-平台化-应用部分.md | 54 ++++++++++++++++++++++++++++++++++++++++-------------- 1 file changed, 40 insertions(+), 14 deletions(-) diff --git a/通讯协议-平台化-应用部分.md b/通讯协议-平台化-应用部分.md index 77cf09f..8ddd198 100644 --- a/通讯协议-平台化-应用部分.md +++ b/通讯协议-平台化-应用部分.md @@ -48,7 +48,7 @@ Ver 1.0.1
-二〇二五年二月 +二〇二五年三月

@@ -66,7 +66,7 @@ Ver 1.0.1
| 文档版本 | 日期 | 作者 | 版本说明 | |---|---|---|---| -|1.0.1| 2025年2月19日|刘琴|1. 初始版| +|1.0.1| 2025年3月24日|刘琴|1. 初始版
2. 修改fEvtKpOnlineMsg返回为数组形式|

@@ -260,7 +260,8 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 ||实时获取在线键盘列表|[rtGetKpOnlineList](#rtgetkponlinelist)|[sEvtBsKpOnlineList](#sevtbskponlinelist)| |维护功能 - 遥控功能|遥控键盘休眠|[remoteKpSleep](#remotekpsleep)|[sEvtStateCode](#sevtstatecode)| |维护功能 - 键盘升级|启动键盘无线升级(内)|[startKpFWUpdate](#startkpfwupdate)|[sEvtStateCode](#sevtstatecode)
[fEvtKpFWUpdateState](#fevtkpfwupdatestate)
[fEvtKpUpdateProgress](#fevtkpupdateprogress)
[sEvtBsKpOnlineMsg](#sevtbskponlinemsg)| -||停止键盘无线升级(内)|[stopKpFWUpdate](#stopkpfwupdate)|[sEvtStateCode](#sevtstatecode)
[fEvtKpFWUpdateState](#fevtkpfwupdatestate)| +||停止键盘无线升级(内)|[stopKpFWUpdate](#stopkpfwupdate)|[sEvtStateCode](#sevtstatecode)
[fEvtKpFWUpdateState](#fevtkpfwupdatestate)| +|维护功能 - 恢复出厂|恢复键盘出厂设置|[resetKpDefault](#resetkpdefault)|[sEvtStateCode](#sevtstatecode)| ### 绑定 |功能归类|功能|API指令|指令事件| |---|---|---|---| @@ -3248,7 +3249,7 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 |baseSn|string||是|基站的出厂编码| |data|array|-|是|传送参数的对象数组| |++keySn|string||是|设置提示语信息的键盘SN| -|++state|string||是|设置的提示语是否成功
0 - 成功
1 - 失败| +|++state|string||是|设置的提示语是否成功
0 - 成功
1 - 超时失败
2 - 参数错误| - **示例代码** @@ -3354,11 +3355,11 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 |fun|string|-|是|事件名称| |dataTag|string|-|否|数据包标识| |baseSn|string||是|基站的出厂编码| -|data|object|-|是|传送参数的对象| -|+keySn|string||是|键盘SN| -|+version|string||是|键盘固件版本| -|+model|int||是|键盘型号| -|+voltage|double||是|键盘电量（待键盘修改成百分比）| +|data|array|-|是|传送参数的对象数组| +|++keySn|string||是|键盘SN| +|++version|string||是|键盘固件版本| +|++model|int||是|键盘型号| +|++voltage|double||是|键盘电量（待键盘修改成百分比）| - **示例代码** ```json @@ -3366,12 +3367,17 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 "fun":"fEvtKpOnlineMsg", "dataTag":"1", "baseSn":"2024061101", - "data":{ + "data":[{ "keySn":"1234567890", "version":"1.0.0", "model":67, "voltage":2.8 - } + },{ + "keySn":"1234567891", + "version":"1.0.0", + "model":67, + "voltage":2.8 + }] } ``` @@ -3457,6 +3463,26 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 "baseSn":"2024061101" } ``` +##### resetKpDefault +- **主题**：/manage/{baseSN}/send +- **功能描述**:恢复键盘出厂设置 +- **参数说明** + +|参数名|类型|限制|是否必填|说明| +|---|---|---|---|---| +|fun|string|-|是|指令名称| +|dataTag|string|-|否|数据包标识,可为空字符串| +|data|object|-|是|传送参数的对象| + + +- **示例代码** +```json +{ + "fun":"resetKpDefault", + "dataTag":"1" +} +``` #### 事件 @@ -3595,7 +3621,7 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 |baseSn|string||是|基站的出厂编码| |data|array|-|否|传送参数的对象数组| |++keySn|string||是|需要设置绑定信息的键盘SN| -|++state|string||是|设置的绑定信息是否成功
0 - 成功
1 - 失败| +|++state|string||是|设置的绑定信息是否成功
0 - 成功
1 - 超时失败
2 - 参数错误| - **示例代码** @@ -4268,7 +4294,7 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 "baseSn":"2024061101", "data":{ "keySns":[], - "mode": 0, + "mode": 1, "allowModify":1 } } @@ -4400,7 +4426,7 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 |baseSn|string||是|基站的出厂编码| |data|array|-|否|传送参数的对象数组| |++keySn|string||是|键盘SN| -|++state|string||是|短信息是否成功发送
0 - 成功
1 - 失败| +|++state|string||是|短信息是否成功发送
0 - 成功
1 - 超时失败
2 - 参数错误 | - **示例代码** ```json -- libgit2 0.21.4