From c0adcca74347bbd17a66ac0bdd8b5c9c3b036a32 Mon Sep 17 00:00:00 2001 From: liuqin Date: Tue, 17 Jun 2025 16:19:21 +0800 Subject: [PATCH] 删除拍照反馈事件的按键时间，修改设置配对码可为0-9A-F，屏蔽即时反馈模式的菜单模式，删除反馈按键内容下发相关的接口 --- 通讯协议-平台化-应用部分[内部].md | 155 +++++------------------------------------------------------------------------------------------------------------------------------------------------------ 1 file changed, 5 insertions(+), 150 deletions(-) diff --git a/通讯协议-平台化-应用部分[内部].md b/通讯协议-平台化-应用部分[内部].md index 1f04a31..082dcf9 100644 --- a/通讯协议-平台化-应用部分[内部].md +++ b/通讯协议-平台化-应用部分[内部].md @@ -69,7 +69,7 @@ Ver 1.0.5 |1.0.1| 2025年3月24日|刘琴|1. 建立版本| |1.0.2| 2025年4月24日|刘琴|1. 修改fEvtKpOnlineMsg返回为数组形式
2. 增加内部指令stopBsUpdate、stopFontLibUpdate，返回状态增加 3: 收到停止指令| |1.0.3| 2025年5月20日|刘琴|1. 增加内部指令组呼开关读取和设置
2. 增加内置状态语下发可指定键盘| -|1.0.4| 2025年5月26日|刘琴|1. 增加待机实时反馈的反馈类型
2. 增加待机实时反馈的按键内容自定义和清除
3. 增加自定义测验题型名称的主观题录分类型
4. 增加键盘离线关机时间等级设置(内部指令)
5. 键盘升级增加静默升级选项，增加退出静默升级指令(内部指令)| +|1.0.4| 2025年5月26日|刘琴|1. 增加待机实时反馈的反馈类型
2. 增加自定义测验题型名称的主观题录分类型
3. 增加键盘离线关机时间等级设置(内部指令)
4. 键盘升级增加静默升级选项，增加退出静默升级指令(内部指令)| |1.0.5| 2025年6月5日|刘琴|1. 增加语音题接口
2. 增加拍照反馈接口
3. 增加锁定解锁白名单
4. 增加基站容量、基站加密(内部指令)|
@@ -290,8 +290,6 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 |短消息|发送短消息|[sendKpMsg](#sendkpmsg)|[sEvtStateCode](#sevtstatecode)
[fEvtKpMsg](#fevtkpmsg)| |待机实时反馈|设置待机实时反馈状态|[setKpStbResponse](#setkpstbresponse)|[fEvtKpStbResponse](#fevtkpstbresponse)
[sEvtKpRtFeedback](#sevtkprtfeedback)
[sEvtKpHandUp](#sevtkphandup)| ||获取待机实时反馈状态|[getKpStbResponse](#getkpstbresponse)|[fEvtKpStbResponse](#fevtkpstbresponse)| -||自定义反馈按键内容|[setKpStbKeyInfo](#setkpstbkeyinfo)|[sEvtStateCode](#sevtstatecode)
[fEvtKpStbKeyInfo](#fevtkpstbkeyinfo)| -||清除自定义反馈按键内容|[clearKpStbKeyInfo](#clearkpstbkeyinfo)|[sEvtStateCode](#sevtstatecode)
[fEvtClearKpStbKeyInfo](#fevtclearkpstbkeyinfo)| ### 语音反馈 |功能归类|功能|API指令|指令事件| |---|---|---|---| @@ -1170,7 +1168,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 |dataTag|string|-|否|数据包标识,可为空字符串| |baseSn|string||是|基站的出厂编码| |data|object|-|否|传送参数的对象| -|+value|string|-|否|设置的基站配对码，8位数字| +|+value|string|-|否|设置的基站配对码，8位，可设置范围0-9A-F| - **示例代码** ```json @@ -4776,7 +4774,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 |baseSn|string||是|基站的出厂编码| |data|object|-|是|传送参数的对象| |+state|int||是|启用待机实时反馈
0-不启用
1-启用| -|+mode|int||是|启动待机反馈类型，state=1时有效
0- 举手
1- 指定按键反馈
2- 字母模式
3- 数字模式
4- 菜单模式| +|+mode|int||是|启动待机反馈类型，state=1时有效
0- 举手
1- 指定按键反馈
2- 字母模式
3- 数字模式| |+keys|int||是|有效按键数量，state=1且mode=1时有效, 范围1-10| - **示例代码** @@ -4835,75 +4833,6 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 } ``` -##### setKpStbKeyInfo -- **主题**：/client/{baseSN}/send -- **功能描述**：设置自定义按键内容，键盘需在线才能接收成功。
设置完成后实时反馈按键显示自定义的内容。
按键内容无变化时无需重复下发 -- **参数说明** - -|参数名|类型|限制|是否必填|说明| -|---|---|---|---|---| -|fun|string|-|是|指令名称| -|dataTag|string|-|否|数据包标识,可为空字符串| -|baseSn|string||是|基站的出厂编码| -|data|object|-|是|传送参数的对象数组，不可为空| -|+keySns|array||是|需要设置标题的键盘SN数组，为空代表全部在线键盘
注意：指定键盘下发才有单个键盘下发是否成功的事件，全部在线键盘下发只有统一回复事件| -|+key|int||是|需设置自定义内容的按键，可设置1-10, 1-9代表键盘1-9键, 10代表 J/0 键| -|+info|string||是|设置的自定义内容，长度不大于15个字符| - -- **示例代码** -```json -//指定下发 -{ - "fun":"setKpStbKeyInfo", - "dataTag":"1", - "baseSn":"2024061101", - "data": { - "keySns": ["1234567890","1234567891"], - "key":1, - "info": "听懂了" - } -} - -//统一下发 -{ - "fun":"setKpStbKeyInfo", - "dataTag":"1", - "baseSn":"2024061101", - "data": { - "keySns": [], - "key":2, - "info": "不太懂" - } -} -``` - -##### clearKpStbKeyInfo -- **主题**：/client/{baseSN}/send -- **功能描述**：清除键盘待机实时反馈中的自定义按键内容 -- **参数说明** - -|参数名|类型|限制|是否必填|说明| -|---|---|---|---|---| -|fun|string|-|是|指令名称| -|dataTag|string|-|否|数据包标识,可为空字符串| -|baseSn|string||是|基站的出厂编码| -|data|object|-|是|传送参数的对象数组| -|+key|int||是|需清除自定义内容的按键
0 : 所有按键自定义内容
1-10 : 1-9代表键盘1-9键, 10代表 J/0 键| -|+keySns|array||否|需要清除自定义按键内容的键盘SN数组，
空数组表示清空所有键盘| - -- **示例代码** -```json -{ - "fun":"clearKpStbKeyInfo", - "dataTag":"1", - "baseSn":"2024061101", - "data": { - "key":0, - "keySns":[] - } -} -``` - #### 事件 ##### [sEvtKpRtFeedback](#sevtkprtfeedback) 返回待机时键盘返回的按键值 @@ -4926,7 +4855,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 |baseSn|string||是|基站的出厂编码| |data|array|-|是|传送参数的对象数组| |+state|int||是|启用待机实时反馈
0-未启用
1-启用| -|+mode|int||是|当前启动待机反馈类型，state=1时返回
0-举手
1-指定按键反馈
2- 字母模式
3- 数字模式
4- 菜单模式| +|+mode|int||是|当前启动待机反馈类型，state=1时返回
0-举手
1-指定按键反馈
2- 字母模式
3- 数字模式| - **示例代码** ```json @@ -4952,78 +4881,6 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 } ``` -##### fEvtKpStbKeyInfo -- **主题**：/basestation/{baseSN}/receive -- **功能描述**：返回键盘设置自定义按键含义是否成功 -- **参数说明** - -|参数名|类型|限制|非空|说明| -|---|---|---|---|---| -|fun|string|-|是|指令名称| -|dataTag|string|-|否|数据包标识,可为空字符串| -|baseSn|string||是|基站的出厂编码| -|data|array|-|否|返回的对象数组| -|++keySn|string||是|设置自定义题型的SN，如果未指定键盘，则keySn为空字符串| -|++state|string||是|设置的自定义信息是否成功
0 - 成功
1 - 失败
2 - 参数错误| - -- **示例代码** -```json -//指定下发 -{ - "fun":"fEvtKpStbKeyInfo", - "dataTag":"1", - "baseSn":"2024061101", - "data": [ - { - "keySn":"1234567890", - "state": "0" - }, - { - "keySn":"1234567891", - "state": "0" - } - ] -} - -//统一下发 -{ - "fun":"fEvtKpStbKeyInfo", - "dataTag":"1", - "baseSn":"2024061101", - "data": [ - { - "keySn":"", - "state": "0" - } - ] -} -``` - -##### fEvtClearKpStbKeyInfo -- **主题**：/basestation/{baseSN}/receive -- **功能描述**：返回清空自定义按键含义的指令状态是否成功 -- **参数说明** - -|参数名|类型|限制|非空|说明| -|---|---|---|---|---| -|fun|string|-|是|指令名称| -|dataTag|string|-|否|数据包标识,可为空字符串| -|baseSn|string||是|基站的出厂编码| -|data|object|-|否|传送参数的对象| -|+state|string||是|清空自定义按键含义是否成功
0 - 成功
1 - 失败
2 - 参数错误| - -- **示例代码** -```json -{ - "fun":"fEvtClearKpStbKeyInfo", - "dataTag":"1", - "baseSn":"2024061101", - "data": { - "state": "0" - } -} -``` - ## 语音反馈 ### 方法 #### 单题语音评测 @@ -5227,7 +5084,6 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 |data|array|-|是|传送参数的对象数组| |++keySn|string||是|键盘SN| |++filePath|string||是|键盘提交图片文件的路径| -|++keyTime|double||是|答题时间，从启动开始计算，单位秒| - **示例代码** ```json @@ -5237,8 +5093,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 "baseSn":"2024061101", "data": [{ "keySn": "1479824643", - "filePath":"D:\\SunVoteSDK\\photo\\20250502\\photo_1479824643_1635832534000.jpg", - "keyTime":3.2 + "filePath":"D:\\SunVoteSDK\\photo\\20250502\\photo_1479824643_1635832534000.jpg" }] } ``` -- libgit2 0.21.4