diff --git a/通讯协议-平台化-应用部分[内部].md b/通讯协议-平台化-应用部分[内部].md index 5d8d859..13443f8 100644 --- a/通讯协议-平台化-应用部分[内部].md +++ b/通讯协议-平台化-应用部分[内部].md @@ -79,6 +79,7 @@ Ver 1.0.12 |1.0.10| 2025年7月24日|刘琴|1. 增加写键盘OEM型号名称| |1.0.11| 2025年7月30日|刘琴|1. 增加表决功能(暂只有三键表决)| |1.0.12| 2025年9月4日|刘琴|1. 增加白名单模式下的键盘登录信息,用作上线信息的补充
2. 增加答题反馈事件中的时间戳返回
3. 修改拍照反馈及返回事件的接口参数| +|1.0.13| 2025年9月8日|刘琴|1. 增加基站连接事件返回字库版本
2. 增加单独读取基站字库版本接口
3. 修改设置读取键盘自动休眠等级和返回事件为外部指令|

@@ -193,6 +194,7 @@ WebSocket方式应用与SDK建立长连接后,通过WebSocket接口发送接 |识别设置 - 出厂编码|设置基站出厂编码(内)|[setBsSN](#setbssn)|[fEvtBsSN](#fevtbssn)| |识别设置 - 基站型号|读取基站型号|[getBsModel](#getbsmodel)|[fEvtBsModel](#fevtbsmodel)| |识别设置 - 固件版本|获取基站固件版本|[getBsFWVersion](#getbsfwversion)|[fEvtBsFWVersion](#fevtbsfwversion)| +|识别设置 - 字库版本|获取基站字库版本|[getBsFontLibVersion](#getbsfontlibversion)|[fEvtBsFontLibVersion](#fevtbsfontlibversion)| |识别设置 - 品牌识别码|获取基站品牌识别码(内)|[getBsBIC](#getbsbic)|[fEvtBsBIC](#fevtbsbic)| ||设置基站品牌识别码(内)|[setBsBIC](#setbsbic)|[fEvtBsBIC](#fevtbsbic)| |组网设置 - 组网模式|获取基站组网模式|[getBsNetworkMode](#getbsnetworkmode)|[fEvtBsNetworkMode](#fevtbsnetworkmode)| @@ -223,8 +225,8 @@ WebSocket方式应用与SDK建立长连接后,通过WebSocket接口发送接 ||设置键盘登录菜单状态|[setBsKpLoginMenu](#setbskploginmenu)|[fEvtBsKpLoginMenu](#fevtbskploginmenu)||| |键盘统一设置 - 长距考勤|获取键盘长距考勤状态(内)|[getBsKpRFIDState](#getbskprfidstate)|[fEvtBsKpRFIDState](#fevtbskprfidstate)| ||设置键盘长距考勤状态(内)|[setBsKpRFIDState](#setbskprfidstate)|[fEvtBsKpRFIDState](#fevtbskprfidstate)| -|键盘统一设置 - 键盘休眠|设置键盘休眠等级(内)|[setBsKpSleepLevel](#setbskpsleeplevel)|[fEvtBsKpSleepLevel](#fevtbskpsleeplevel)| -||获取键盘休眠等级(内)|[getBsKpSleepLevel](#getbskpsleeplevel)|[fEvtBsKpSleepLevel](#fevtbskpsleeplevel)| +|键盘统一设置 - 键盘休眠|设置键盘休眠等级|[setBsKpSleepLevel](#setbskpsleeplevel)|[fEvtBsKpSleepLevel](#fevtbskpsleeplevel)| +||获取键盘休眠等级|[getBsKpSleepLevel](#getbskpsleeplevel)|[fEvtBsKpSleepLevel](#fevtbskpsleeplevel)| ||设置键盘暂停休眠状态(内)|[setBsKpPauseSleep](#setbskppausesleep)|[fEvtBsKpPauseSleep](#fevtbskppausesleep)| ||获取键盘暂停休眠状态(内)|[getBsKpPauseSleep](#getbskppausesleep)|[fEvtBsKpPauseSleep](#fevtbskppausesleep)| |配对模式 - 快速配对|启动基站快速配对|[startBsFastPair](#startbsfastpair)|[sEvtStateCode](#sevtstatecode)
[sEvtBsKpOnlineMsg](#sevtbskponlinemsg)| @@ -319,7 +321,7 @@ WebSocket方式应用与SDK建立长连接后,通过WebSocket接口发送接 ### 拍照反馈 |功能归类|功能|API指令|指令事件| |---|---|---|---| -|拍照反馈|启动拍照反馈|[startQAPhoto](#startqaphoto)|[sEvtStateCode](#sevtstatecode)
[fEvtPhotoFile](#fEvtphotofile)| +|拍照反馈|启动拍照反馈|[startQAPhoto](#startqaphoto)|[sEvtStateCode](#sevtstatecode)
[fEvtPhotoFile](#fevtphotofile)| ||停止拍照反馈|[stopKpVote](#stopkpvote)|[sEvtStateCode](#sevtstatecode)| ### 在线测验 |功能归类|功能|API指令|指令事件| @@ -501,6 +503,7 @@ WebSocket方式应用与SDK建立长连接后,通过WebSocket接口发送接 |+modelName|string||否|基站的型号名称| |+state|int||是|基站的连接状态
1-已连接
2-连接断开| |+version|string||否|基站固件版本| +|+fontLibVer|string||否|基站的字库版本| - **示例代码** ```json @@ -513,7 +516,8 @@ WebSocket方式应用与SDK建立长连接后,通过WebSocket接口发送接 "state":1, "baseModel":229, "modelName":"BS200", - "version":"1.0.3" + "version":"1.0.3", + "fontLibVer":"1.0.0" } } //连接断开 @@ -882,6 +886,7 @@ WebSocket方式应用与SDK建立长连接后,通过WebSocket接口发送接 |+baseModel|int||否|基站的型号码| |+modelName|string||否|基站的型号名称| |+version|string||否|基站固件版本| +|+fontLibVer|string||否|基站的字库版本| |+baseSN|string||否|基站SN| - **示例代码** @@ -895,6 +900,7 @@ WebSocket方式应用与SDK建立长连接后,通过WebSocket接口发送接 "baseModel":229, "modelName":"BS200", "version":"1.0.3", + "fontLibVer":"1.0.0", "baseSN":"2024041401" } } @@ -997,6 +1003,26 @@ WebSocket方式应用与SDK建立长连接后,通过WebSocket接口发送接 } ``` +##### getBsFontLibVersion +- **主题**:/client/{baseSN}/send +- **功能描述**:获取基站字库版本 +- **参数说明** + +|参数名|类型|限制|是否必填|说明| +|---|---|---|---|---| +|fun|string|-|是|指令名称| +|dataTag|string|-|否|数据包标识,可为空字符串| +|baseSn|string||是|基站的出厂编码| + +- **示例代码** +```json +{ + "fun":"getBsFontLibVersion", + "dataTag":"1", + "baseSn":"2024061101" +} +``` + ##### getBsBIC - **主题**:/manage/{baseSN}/send - **功能描述**:获取基站品牌识别码 @@ -1115,6 +1141,31 @@ WebSocket方式应用与SDK建立长连接后,通过WebSocket接口发送接 } ``` +##### fEvtBsFontLibVersion +- **主题**: /basestation/{baseSN}/receive +- **功能描述**:返回基站的字库版本 +- **参数说明** + +|参数名|类型|限制|是否必填|说明| +|---|---|---|---|---| +|fun|string|-|是|事件名称| +|dataTag|string|-|否|数据包标识| +|baseSn|string||是|基站的出厂编码| +|data|object|-|是|传送参数的对象| +|+value|string||是|基站的字库版本号| + +- **示例代码** +```json +{ + "fun":"fEvtBsFontLibVersion", + "dataTag":"1", + "baseSn":"2024061101", + "data":{ + "value":"1.0.0" + } +} +``` + ##### fEvtBsBIC - **主题**: /manage/{baseSN}/receive - **功能描述**:返回基站的品牌码 @@ -2035,7 +2086,7 @@ WebSocket方式应用与SDK建立长连接后,通过WebSocket接口发送接 ``` ##### getBsKpSleepLevel -- **主题**:/manage/{baseSN}/send +- **主题**:/client/{baseSN}/send - **功能描述**:获取键盘休眠时间等级 - **参数说明** @@ -2055,7 +2106,7 @@ WebSocket方式应用与SDK建立长连接后,通过WebSocket接口发送接 ``` ##### setBsKpSleepLevel -- **主题**:/manage/{baseSN}/send +- **主题**:/client/{baseSN}/send - **功能描述**:设置键盘休眠时间等级 - **参数说明** @@ -2226,7 +2277,7 @@ WebSocket方式应用与SDK建立长连接后,通过WebSocket接口发送接 ``` ##### fEvtBsKpSleepLevel -- **主题**: /manage/{baseSN}/receive +- **主题**: /basestation/{baseSN}/receive - **功能描述**:返回键盘休眠时间等级 - **参数说明**