diff --git a/通讯协议-平台化-应用部分[内部].md b/通讯协议-平台化-应用部分[内部].md index 5d8d859..cf714de 100644 --- a/通讯协议-平台化-应用部分[内部].md +++ b/通讯协议-平台化-应用部分[内部].md @@ -32,7 +32,7 @@ SunVote 二次开发
通讯协议

-Ver 1.0.12 +Ver 1.0.13


@@ -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. 修改设置读取键盘自动休眠等级和返回事件为外部指令|

@@ -90,22 +91,22 @@ Ver 1.0.12 本文档约定了应用程序和基站之间进行通讯的数据格式和内容，供开发人员查阅。 ## MQTT方式主题说明 -{baseSN}为指定的基站的SN编码，不能为空，接收基站反馈数据需要订阅对应基站SN的接收主题。 +{baseSn}为指定的基站的SN编码，不能为空，接收基站反馈数据需要订阅对应基站SN的接收主题。 ### 发布的主题 应用程序发布的主题，基站订阅 -/client/{baseSN}/send +/client/{baseSn}/send /client/multiBase/send 内部应用发布的主题，基站订阅 - /manage/{baseSN}/send + /manage/{baseSn}/send ### 订阅的主题 应用程序订阅的主题，基站发布 -/basestation/\{baseSN}/receive +/basestation/\{baseSn}/receive /basestation/multiBase/receive 内部应用订阅的主题，基站发布 -/manage/{baseSN}/receive +/manage/{baseSn}/receive ## Websocket方式 WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接收数据即可。应用程序发送至SDK约定为发送指令，SDK返回数据约定为返回事件。 @@ -134,7 +135,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 { "fun":"xxx", "dataTag":"xxx", - "baseSn":"xxxxxxxxx", //MQTT方式连接时，主题中已有baseSN，此参数可不传 + "baseSn":"xxxxxxxxx", //MQTT方式连接时，主题中已有baseSn，此参数可不传 "data":{ //内容 } @@ -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指令|指令事件| @@ -468,7 +470,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ## 公共方法 ### stopKpVote -- **主题**: /client/{baseSN}/send +- **主题**: /client/{baseSn}/send - **功能描述**：通用停止键盘答题方法，可以停止如同步签到、按键反馈、在线测验中调用startXXX方法启动的业务 - **参数说明** @@ -487,7 +489,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ## 公共事件 ### sEvtBsConnectState -- **主题**: /basestation/{baseSN}/receive +- **主题**: /basestation/{baseSn}/receive - **功能描述**：基站连接成功时返回基站型号和基站SN,基站从已连接状态断开返回连接断开 - **参数说明** @@ -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" } } //连接断开 @@ -527,7 +531,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 } ``` ### sEvtBsChannelConflict -- **主题**: /basestation/{baseSN}/receive +- **主题**: /basestation/{baseSn}/receive - **功能描述**：基站信道冲突时主动上报，应用程序可根据实际业务修改基站信道 - **参数说明** @@ -551,7 +555,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 } ``` ### sEvtBsNfcResults -- **主题**: /basestation/{baseSN}/receive +- **主题**: /basestation/{baseSn}/receive - **功能描述**：键盘刷卡时主动上报，如果超出基站容量会上报失败 - **参数说明** @@ -580,7 +584,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` ### sEvtBsKpOnlineMsg -- **主题**: /basestation/{baseSN}/receive +- **主题**: /basestation/{baseSn}/receive - **功能描述**：键盘上线通知，主动上报,键盘升级成功后也会上报 - **参数说明** @@ -609,7 +613,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` ### sEvtBsKpLoginMsg -- **主题**: /basestation/{baseSN}/receive +- **主题**: /basestation/{baseSn}/receive - **功能描述**：键盘登入的通知信息，用作上线信息的补充 - **参数说明** @@ -638,7 +642,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` ### sEvtBsKpOfflineMsg -- **主题**: /basestation/{baseSN}/receive +- **主题**: /basestation/{baseSn}/receive - **功能描述**：单个键盘离线通知，主动上报 - **参数说明** @@ -663,7 +667,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` ### sEvtBsKpOnlineList -- **主题**: /basestation/{baseSN}/receive +- **主题**: /basestation/{baseSn}/receive - **功能描述**：键盘在线列表发生变化时主动上报 - **参数说明** @@ -698,7 +702,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 } ``` ### sEvtKpRtFeedback -- **主题**: /basestation/{baseSN}/receive +- **主题**: /basestation/{baseSn}/receive - **功能描述**：开启键盘实时反馈后，键盘按键时上报 - **参数说明** @@ -729,7 +733,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` ### sEvtKpHandUp -- **主题**: /basestation/{baseSN}/receive +- **主题**: /basestation/{baseSn}/receive - **功能描述**：开启键盘举手功能后，键盘按举手键时上报 - **参数说明** @@ -753,7 +757,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 } ``` ### sEvtKpRemoteControl -- **主题**: /basestation/{baseSN}/receive +- **主题**: /basestation/{baseSn}/receive - **功能描述**：遥控器按键实时上报 - **参数说明** @@ -779,7 +783,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 } ``` ### sEvtStateCode -- **主题**: /basestation/{baseSN}/receive +- **主题**: /basestation/{baseSn}/receive - **功能描述**：返回基站接收指令状态信息 - **参数说明** @@ -847,7 +851,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` ##### getBsConnectState -- **主题**：/client/{baseSN}/send +- **主题**：/client/{baseSn}/send - **功能描述**：主动获取基站连接状态 - **参数说明** @@ -882,7 +886,8 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 |+baseModel|int||否|基站的型号码| |+modelName|string||否|基站的型号名称| |+version|string||否|基站固件版本| -|+baseSN|string||否|基站SN| +|+fontLibVer|string||否|基站的字库版本| +|+baseSn|string||否|基站SN| - **示例代码** ```json @@ -895,7 +900,8 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 "baseModel":229, "modelName":"BS200", "version":"1.0.3", - "baseSN":"2024041401" + "fontLibVer":"1.0.0", + "baseSn":"2024041401" } } ``` @@ -903,7 +909,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ### 基站授时 #### 方法 ##### timeSync -- **主题**：/client/{baseSN}/send +- **主题**：/client/{baseSn}/send - **功能描述**：发送当前时间戳给基站进行校时 - **参数说明** @@ -934,7 +940,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 #### 方法 ##### setBsSN -- **主题**：/manage/{baseSN}/send +- **主题**：/manage/{baseSn}/send - **功能描述**：设置基站的SN，需预先订阅新SN的主题,以获取事件返回 - **参数说明** @@ -959,7 +965,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` ##### getBsModel -- **主题**：/client/{baseSN}/send +- **主题**：/client/{baseSn}/send - **功能描述**：获取基站型号 - **参数说明** @@ -978,7 +984,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 } ``` ##### getBsFWVersion -- **主题**：/client/{baseSN}/send +- **主题**：/client/{baseSn}/send - **功能描述**：获取基站固件版本 - **参数说明** @@ -997,8 +1003,28 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 } ``` +##### getBsFontLibVersion +- **主题**：/client/{baseSn}/send +- **功能描述**：获取基站字库版本 +- **参数说明** + +|参数名|类型|限制|是否必填|说明| +|---|---|---|---|---| +|fun|string|-|是|指令名称| +|dataTag|string|-|否|数据包标识,可为空字符串| +|baseSn|string||是|基站的出厂编码| + +- **示例代码** +```json +{ + "fun":"getBsFontLibVersion", + "dataTag":"1", + "baseSn":"2024061101" +} +``` + ##### getBsBIC -- **主题**：/manage/{baseSN}/send +- **主题**：/manage/{baseSn}/send - **功能描述**：获取基站品牌识别码 - **参数说明** @@ -1017,7 +1043,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 } ``` ##### setBsBIC -- **主题**：/manage/{baseSN}/send +- **主题**：/manage/{baseSn}/send - **功能描述**：设置基站品牌识别码 - **参数说明** @@ -1043,7 +1069,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 #### 事件 ##### fEvtBsSN -- **主题**: /basestation/{baseSN}/receive +- **主题**: /basestation/{baseSn}/receive - **功能描述**：返回基站的出厂编码 - **参数说明** @@ -1067,7 +1093,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 } ``` ##### fEvtBsModel -- **主题**: /basestation/{baseSN}/receive +- **主题**: /basestation/{baseSn}/receive - **功能描述**：返回基站的型号 - **参数说明** @@ -1091,7 +1117,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 } ``` ##### fEvtBsFWVersion -- **主题**: /basestation/{baseSN}/receive +- **主题**: /basestation/{baseSn}/receive - **功能描述**：返回基站的固件版本 - **参数说明** @@ -1115,8 +1141,33 @@ 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 +- **主题**: /manage/{baseSn}/receive - **功能描述**：返回基站的品牌码 - **参数说明** @@ -1143,7 +1194,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ### 组网设置 #### 方法 ##### getBsNetworkMode -- **主题**：/client/{baseSN}/send +- **主题**：/client/{baseSn}/send - **功能描述**：获取基站组网模式 - **参数说明** @@ -1163,7 +1214,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` ##### setBsNetworkMode -- **主题**：/client/{baseSN}/send +- **主题**：/client/{baseSn}/send - **功能描述**：设置基站组网模式 - **参数说明** @@ -1188,7 +1239,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` ##### getBsPairCode -- **主题**：/client/{baseSN}/send +- **主题**：/client/{baseSn}/send - **功能描述**：获取基站配对码 - **参数说明** @@ -1208,7 +1259,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` ##### setBsPairCode -- **主题**：/manage/{baseSN}/send +- **主题**：/manage/{baseSn}/send - **功能描述**：设置基站配对码 - **参数说明** @@ -1233,7 +1284,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` ##### getBsGroupCall -- **主题**：/manage/{baseSN}/send +- **主题**：/manage/{baseSn}/send - **功能描述**：获取基站组呼开关状态 - **参数说明** @@ -1253,7 +1304,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` ##### setBsGroupCall -- **主题**：/manage/{baseSN}/send +- **主题**：/manage/{baseSn}/send - **功能描述**：设置基站组呼开关状态 - **参数说明** @@ -1278,7 +1329,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` ##### getBsNfcLogin -- **主题**：/client/{baseSN}/send +- **主题**：/client/{baseSn}/send - **功能描述**：获取刷卡配对状态 - **参数说明** @@ -1297,7 +1348,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 } ``` ##### setBsNfcLogin -- **主题**：/client/{baseSN}/send +- **主题**：/client/{baseSn}/send - **功能描述**：设置基站刷卡配对状态 - **参数说明** @@ -1322,7 +1373,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` ##### getBsCapacity -- **主题**：/client/{baseSN}/send +- **主题**：/client/{baseSn}/send - **功能描述**：获取基站容量参数 - **参数说明** @@ -1341,7 +1392,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 } ``` ##### setBsCapacity -- **主题**：/client/{baseSN}/send +- **主题**：/client/{baseSn}/send - **功能描述**：设置基站容量 - **参数说明** @@ -1366,7 +1417,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` ##### getBsChannel -- **主题**：/client/{baseSN}/send +- **主题**：/client/{baseSn}/send - **功能描述**：获取基站信道 - **参数说明** @@ -1385,7 +1436,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 } ``` ##### setBsChannel -- **主题**：/client/{baseSN}/send +- **主题**：/client/{baseSn}/send - **功能描述**：设置基站信道 - **参数说明** @@ -1410,7 +1461,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` ##### getBsRFIChannel -- **主题**：/client/{baseSN}/send +- **主题**：/client/{baseSn}/send - **功能描述**：获取已被其他基站占用的信道 - **参数说明** @@ -1431,7 +1482,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 #### 事件 ##### fEvtBsNetworkMode -- **主题**: /basestation/{baseSN}/receive +- **主题**: /basestation/{baseSn}/receive - **功能描述**：返回基站组网模式 - **参数说明** @@ -1455,7 +1506,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 } ``` ##### fEvtBsPairCode -- **主题**: /basestation/{baseSN}/receive +- **主题**: /basestation/{baseSn}/receive - **功能描述**：返回基站配对码 - **参数说明** @@ -1480,7 +1531,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` ##### fEvtBsCapacity -- **主题**: /basestation/{baseSN}/receive +- **主题**: /basestation/{baseSn}/receive - **功能描述**：返回基站容量 - **参数说明** @@ -1505,7 +1556,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` ##### fEvtBsChannel -- **主题**: /basestation/{baseSN}/receive +- **主题**: /basestation/{baseSn}/receive - **功能描述**：返回基站信道 - **参数说明** @@ -1530,7 +1581,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` ##### fEvtBsRFIChannel -- **主题**: /basestation/{baseSN}/receive +- **主题**: /basestation/{baseSn}/receive - **功能描述**：返回其他基站已占用的信道，频点冲突时，可以根据返回结果修改基站信道避开干扰 - **参数说明** @@ -1565,7 +1616,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` ##### fEvtBsGroupCall -- **主题**: /manage/{baseSN}/receive +- **主题**: /manage/{baseSn}/receive - **功能描述**：返回基站组呼开关状态 - **参数说明** @@ -1590,7 +1641,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` ##### fEvtBsNfcLogin -- **主题**: /basestation/{baseSN}/receive +- **主题**: /basestation/{baseSn}/receive - **功能描述**：返回基站是否允许NFC刷卡 - **参数说明** @@ -1617,7 +1668,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 #### 方法 ##### getBsSSID 获取基站登录名称 -- **主题**：/client/{baseSN}/send +- **主题**：/client/{baseSn}/send - **功能描述**：获取基站登录名称 - **参数说明** @@ -1636,7 +1687,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 } ``` ##### setBsSSID -- **主题**：/client/{baseSN}/send +- **主题**：/client/{baseSn}/send - **功能描述**：设置基站登录名称 - **参数说明** @@ -1660,7 +1711,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 } ``` ##### getBsLoginPwd -- **主题**：/client/{baseSN}/send +- **主题**：/client/{baseSn}/send - **功能描述**：获取基站登录密码 - **参数说明** @@ -1679,7 +1730,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 } ``` ##### setBsLoginPwd -- **主题**：/client/{baseSN}/send +- **主题**：/client/{baseSn}/send - **功能描述**：设置基站登录密码 - **参数说明** @@ -1704,7 +1755,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` ##### getBsLoginState 获取基站登录名称 -- **主题**：/client/{baseSN}/send +- **主题**：/client/{baseSn}/send - **功能描述**：获取基站登录状态 - **参数说明** @@ -1723,7 +1774,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 } ``` ##### setBsLoginState -- **主题**：/client/{baseSN}/send +- **主题**：/client/{baseSn}/send - **功能描述**：设置基站登录状态 - **参数说明** @@ -1749,7 +1800,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 #### 事件 ##### fEvtBsSSID -- **主题**: /basestation/{baseSN}/receive +- **主题**: /basestation/{baseSn}/receive - **功能描述**：返回基站名称 - **参数说明** @@ -1773,7 +1824,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 } ``` ##### fEvtBsLoginPwd -- **主题**: /basestation/{baseSN}/receive +- **主题**: /basestation/{baseSn}/receive - **功能描述**：返回基站登录密码 - **参数说明** @@ -1807,7 +1858,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 } ``` ##### fEvtBsLoginState -- **主题**: /basestation/{baseSN}/receive +- **主题**: /basestation/{baseSn}/receive - **功能描述**：返回基站登录状态 - **参数说明** @@ -1833,7 +1884,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ### 键盘统一设置 #### 方法 ##### getBsKpLanguage -- **主题**：/client/{baseSN}/send +- **主题**：/client/{baseSn}/send - **功能描述**：获取键盘语言 - **参数说明** @@ -1852,7 +1903,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 } ``` ##### setBsKpLanguage -- **主题**：/client/{baseSN}/send +- **主题**：/client/{baseSn}/send - **功能描述**：设置键盘语言 - **参数说明** @@ -1877,7 +1928,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` ##### setBsKpFreeTitle -- **主题**：/client/{baseSN}/send +- **主题**：/client/{baseSn}/send - **功能描述**：设置键盘空闲时显示的标题 - **参数说明** @@ -1902,7 +1953,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` ##### getBsKpStbMsgMode -- **主题**：/manage/{baseSN}/send +- **主题**：/manage/{baseSn}/send - **功能描述**：获取状态语设置状态 - **参数说明** @@ -1921,7 +1972,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 } ``` ##### setBsKpStbMsgMode -- **主题**：/manage/{baseSN}/send +- **主题**：/manage/{baseSn}/send - **功能描述**：设置状态语工作状态 - **参数说明** @@ -1946,7 +1997,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` ##### getBsKpLoginMenu -- **主题**：/client/{baseSN}/send +- **主题**：/client/{baseSn}/send - **功能描述**：获取键盘登录菜单显示状态 - **参数说明** @@ -1966,7 +2017,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` ##### setBsKpLoginMenu -- **主题**：/client/{baseSN}/send +- **主题**：/client/{baseSn}/send - **功能描述**：设置键盘登录菜单显示状态 - **参数说明** @@ -1991,7 +2042,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` ##### getBsKpRFIDState -- **主题**：/manage/{baseSN}/send +- **主题**：/manage/{baseSn}/send - **功能描述**：获取键盘长距离考勤开启状态 - **参数说明** @@ -2010,7 +2061,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 } ``` ##### setBsKpRFIDState -- **主题**：/manage/{baseSN}/send +- **主题**：/manage/{baseSn}/send - **功能描述**：设置键盘长距离考勤开启状态 - **参数说明** @@ -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 - **功能描述**：设置键盘休眠时间等级 - **参数说明** @@ -2080,7 +2131,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` ##### setBsKpPauseSleep -- **主题**：/manage/{baseSN}/send +- **主题**：/manage/{baseSn}/send - **功能描述**：设置键盘暂停休眠是否开启
注意：请谨慎使用本功能，务必在相关测试或功能完成后关闭，否则可能会导致键盘异常耗电
设置单次生效，基站拔插后复位成关闭状态 - **参数说明** @@ -2105,7 +2156,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` ##### getBsKpPauseSleep -- **主题**：/manage/{baseSN}/send +- **主题**：/manage/{baseSn}/send - **功能描述**：获取键盘暂停休眠是否开启 - **参数说明** @@ -2126,7 +2177,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 #### 事件 ##### fEvtBsKpLanguage -- **主题**: /basestation/{baseSN}/receive +- **主题**: /basestation/{baseSn}/receive - **功能描述**：返回键盘语言 - **参数说明** @@ -2151,7 +2202,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` ##### fEvtBsKpStbMsgMode -- **主题**: /manage/{baseSN}/receive +- **主题**: /manage/{baseSn}/receive - **功能描述**：返回状态语工作状态 - **参数说明** @@ -2176,7 +2227,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` ##### fEvtBsKpLoginMenu -- **主题**: /basestation/{baseSN}/receive +- **主题**: /basestation/{baseSn}/receive - **功能描述**：返回键盘登录菜单显示状态 - **参数说明** @@ -2201,7 +2252,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` ##### fEvtBsKpRFIDState -- **主题**: /manage/{baseSN}/receive +- **主题**: /manage/{baseSn}/receive - **功能描述**：返回键盘长距离考勤开启状态 - **参数说明** @@ -2226,7 +2277,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` ##### fEvtBsKpSleepLevel -- **主题**: /manage/{baseSN}/receive +- **主题**: /basestation/{baseSn}/receive - **功能描述**：返回键盘休眠时间等级 - **参数说明** @@ -2251,7 +2302,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` ##### fEvtBsKpPauseSleep -- **主题**: /manage/{baseSN}/receive +- **主题**: /manage/{baseSn}/receive - **功能描述**：返回暂停键盘休眠开启状态 - **参数说明** @@ -2278,7 +2329,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ### 配对模式 #### 方法 ##### startBsFastPair -- **主题**：/client/{baseSN}/send +- **主题**：/client/{baseSn}/send - **功能描述**：启动快速配对,键盘配对成功返回键盘信息 [sEvtBsKpOnlineMsg](#sevtbskponlinemsg) - **参数说明** @@ -2297,7 +2348,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 } ``` ##### stopBsFastPair -- **主题**：/client/{baseSN}/send +- **主题**：/client/{baseSn}/send - **功能描述**：停止快速配对 - **参数说明** @@ -2325,7 +2376,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ### 白名单模式 #### 方法 ##### getBsWhitelist -- **主题**：/client/{baseSN}/send +- **主题**：/client/{baseSn}/send - **功能描述**：获取基站白名单列表 - **参数说明** @@ -2344,7 +2395,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 } ``` ##### setBsWhitelist -- **主题**：/client/{baseSN}/send +- **主题**：/client/{baseSn}/send - **功能描述**：设置基站白名单列表，将基站白名单替换为写入的键盘SN列表 - **参数说明** @@ -2368,7 +2419,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 } ``` ##### clearBsWhitelist -- **主题**：/client/{baseSN}/send +- **主题**：/client/{baseSn}/send - **功能描述**：清空基站白名单列表 - **参数说明** @@ -2387,7 +2438,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 } ``` ##### addBsWhitelist -- **主题**：/client/{baseSN}/send +- **主题**：/client/{baseSn}/send - **功能描述**：添加键盘至基站白名单列表 - **参数说明** @@ -2411,7 +2462,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 } ``` ##### delBsWhitelist -- **主题**：/client/{baseSN}/send +- **主题**：/client/{baseSn}/send - **功能描述**：从基站白名单列表中删除键盘 - **参数说明** @@ -2436,7 +2487,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` ##### lockBsWhitelistKp -- **主题**：/client/{baseSN}/send +- **主题**：/client/{baseSn}/send - **功能描述**：锁定指定的键盘SN，基站限制容量时，被锁定键盘SN不会被新刷卡加入的键盘挤出 - **参数说明** @@ -2460,7 +2511,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 } ``` ##### unlockBsWhitelistKp -- **主题**：/client/{baseSN}/send +- **主题**：/client/{baseSn}/send - **功能描述**：解锁键盘SN - **参数说明** @@ -2485,7 +2536,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` ##### getBsAutoClearWhitelist -- **主题**：/manage/{baseSN}/send +- **主题**：/manage/{baseSn}/send - **功能描述**：获取基站是否在断电或与软件断连一定时间后自动清除白名单 - **参数说明** @@ -2505,7 +2556,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` ##### setBsAutoClearWhitelist -- **主题**：/manage/{baseSN}/send +- **主题**：/manage/{baseSn}/send - **功能描述**：设置基站是否在断电或与软件断连一定时间后自动清除白名单 - **参数说明** @@ -2534,7 +2585,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 发送指令后返回此事件 ##### fEvtBsWhitelist -- **主题**：/basestation/{baseSN}/receive +- **主题**：/basestation/{baseSn}/receive - **功能描述**：返回基站白名单列表 - **参数说明** @@ -2559,7 +2610,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` ##### fEvtSetBsWhitelist -- **主题**：/basestation/{baseSN}/receive +- **主题**：/basestation/{baseSn}/receive - **功能描述**：返回设置白名单状态 - **参数说明** @@ -2589,7 +2640,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` ##### fEvtAddBsWhitelist -- **主题**：/basestation/{baseSN}/receive +- **主题**：/basestation/{baseSn}/receive - **功能描述**：返回增加键盘状态 - **参数说明** @@ -2619,7 +2670,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` ##### fEvtDelBsWhitelist -- **主题**：/basestation/{baseSN}/receive +- **主题**：/basestation/{baseSn}/receive - **功能描述**：返回删除键盘状态 - **参数说明** @@ -2649,7 +2700,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` ##### fEvtLockBsWhitelistKp -- **主题**：/basestation/{baseSN}/receive +- **主题**：/basestation/{baseSn}/receive - **功能描述**：返回键盘锁定状态 - **参数说明** @@ -2676,7 +2727,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` ##### fEvtBsAutoClearWhitelist -- **主题**：/manage/{baseSN}/receive +- **主题**：/manage/{baseSn}/receive - **功能描述**：返回基站是否在断电或与软件断连一定时间后自动清除白名单 - **参数说明** @@ -2703,7 +2754,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ### 网络参数设置 #### 方法 ##### getBsTcpipParams -- **主题**：/client/{baseSN}/send +- **主题**：/client/{baseSn}/send - **功能描述**：获取基站TCP/IP参数 - **参数说明** @@ -2722,7 +2773,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 } ``` ##### setBsTcpipParams -- **主题**：/client/{baseSN}/send +- **主题**：/client/{baseSn}/send - **功能描述**：设置基站TCP/IP参数 - **参数说明** @@ -2753,7 +2804,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` ##### getBsMac -- **主题**：/manage/{baseSN}/send +- **主题**：/manage/{baseSn}/send - **功能描述**：获取基站MAC地址 - **参数说明** @@ -2772,7 +2823,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 } ``` ##### setBsMac -- **主题**：/manage/{baseSN}/send +- **主题**：/manage/{baseSn}/send - **功能描述**：设置基站MAC地址 - **参数说明** @@ -2797,7 +2848,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` ##### getBsMqttParams -- **主题**：/client/{baseSN}/send +- **主题**：/client/{baseSn}/send - **功能描述**：获取基站MQTT参数 - **参数说明** @@ -2816,7 +2867,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 } ``` ##### setBsMqttParams -- **主题**：/client/{baseSN}/send +- **主题**：/client/{baseSn}/send - **功能描述**：设置基站MQTT参数 - **参数说明** @@ -2849,7 +2900,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` #### 事件 ##### fEvtBsTcpipParams -- **主题**: /basestation/{baseSN}/receive +- **主题**: /basestation/{baseSn}/receive - **功能描述**：返回基站TCP/IP参数 - **参数说明** @@ -2882,7 +2933,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` ##### fEvtBsMac -- **主题**: /manage/{baseSN}/receive +- **主题**: /manage/{baseSn}/receive - **功能描述**：返回基站TCP/IP参数 - **参数说明** @@ -2907,7 +2958,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` ##### fEvtBsMqttParams -- **主题**: /basestation/{baseSN}/receive +- **主题**: /basestation/{baseSn}/receive - **功能描述**：返回基站MQTT参数 - **参数说明** @@ -2941,7 +2992,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ### 基站加密 #### 方法 ##### getBsSoftwareKey -- **主题**：/client/{baseSN}/send +- **主题**：/client/{baseSn}/send - **功能描述**：获取基站软件狗密钥 - **参数说明** @@ -2960,7 +3011,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 } ``` ##### setBsSoftwareKey -- **主题**：/client/{baseSN}/send +- **主题**：/client/{baseSn}/send - **功能描述**：设置基站软件狗密钥 - **参数说明** @@ -2985,7 +3036,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` ##### getBsAES -- **主题**：/manage/{baseSN}/send +- **主题**：/manage/{baseSn}/send - **功能描述**：获取基站加密方式 - **参数说明** @@ -3004,7 +3055,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 } ``` ##### setBsAES -- **主题**：/manage/{baseSN}/send +- **主题**：/manage/{baseSn}/send - **功能描述**：设置基站加密方式 - **参数说明** @@ -3030,7 +3081,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 #### 事件 ##### fEvtBsSoftwareKey -- **主题**：/basestation/{baseSN}/receive +- **主题**：/basestation/{baseSn}/receive - **功能描述**：返回基站的软件狗密钥 - **参数说明** @@ -3055,7 +3106,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` ##### fEvtBsAES -- **主题**：/manage/{baseSN}/receive +- **主题**：/manage/{baseSn}/receive - **功能描述**：返回基站的无线加密模式 - **参数说明** @@ -3082,7 +3133,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ### 基站维护 #### 方法 ##### getBsLogInfo -- **主题**：/manage/{baseSN}/send +- **主题**：/manage/{baseSn}/send - **功能描述**：获取基站日志,用于出现故障需要排查问题时获取基站内部日志记录 - **参数说明** @@ -3102,7 +3153,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` ##### clearBsLogInfo -- **主题**：/manage/{baseSN}/send +- **主题**：/manage/{baseSn}/send - **功能描述**：清空基站内部日志记录 - **参数说明** @@ -3122,7 +3173,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` ##### resetBsSystem -- **主题**：/client/{baseSN}/send +- **主题**：/client/{baseSn}/send - **功能描述**：软复位基站（公共主题可用，但不体现在外部版本协议中） - **参数说明** @@ -3142,7 +3193,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` ##### resetBsPower -- **主题**：/client/{baseSN}/send +- **主题**：/client/{baseSn}/send - **功能描述**：断电复位基站（公共主题可用，但不体现在外部版本协议中） - **参数说明** @@ -3162,7 +3213,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` ##### startBsSelfCheck -- **主题**：/manage/{baseSN}/send +- **主题**：/manage/{baseSn}/send - **功能描述**：开始基站自检,基站自检状态中不接收其他指令，空闲状态中才进入自检 - **参数说明** @@ -3184,13 +3235,13 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 #### 事件 ##### [sEvtStateCode](#sevtstatecode) 返回指令的接收状态 -注意：内部指令的接收状态需从**主题: /manage/{baseSN}/receive** 返回 +注意：内部指令的接收状态需从**主题: /manage/{baseSn}/receive** 返回 ##### [sEvtBsConnectState](#sevtbsconnectstate) 复位基站后，基站重新连接成功后上报 ##### fEvtBsLogInfo -- **主题**: /manage/{baseSN}/receive +- **主题**: /manage/{baseSn}/receive - **功能描述**：返回基站存储的日志内容 - **参数说明** @@ -3217,7 +3268,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` ##### fEvtBsSelfCheck -- **主题**: /manage/{baseSN}/receive +- **主题**: /manage/{baseSn}/receive - **功能描述**：返回基站自检的结果 - **参数说明** @@ -3264,7 +3315,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ### 基站升级 #### 方法 ##### startBsUpdate -- **主题**：/manage/{baseSN}/send +- **主题**：/manage/{baseSn}/send - **功能描述**:基站固件升级 - **参数说明** @@ -3295,7 +3346,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` ##### stopBsUpdate -- **主题**：/manage/{baseSN}/send +- **主题**：/manage/{baseSn}/send - **功能描述**:停止基站固件升级 - **参数说明** @@ -3316,7 +3367,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` ##### downloadFontLib -- **主题**：/manage/{baseSN}/send +- **主题**：/manage/{baseSn}/send - **功能描述**: 下载更新基站字库文件 - **参数说明** @@ -3346,7 +3397,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 } ``` ##### stopFontLibUpdate -- **主题**：/manage/{baseSN}/send +- **主题**：/manage/{baseSn}/send - **功能描述**: 停止基站字库升级 - **参数说明** @@ -3369,10 +3420,10 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 #### 事件 ##### [sEvtStateCode](#sevtstatecode) 返回升级指令的接收状态 -注意：升级指令的接收状态需从**主题: /manage/{baseSN}/receive** 返回 +注意：升级指令的接收状态需从**主题: /manage/{baseSn}/receive** 返回 ##### fEvtBsUpateState -- **主题**: /manage/{baseSN}/receive +- **主题**: /manage/{baseSn}/receive - **功能描述**：返回基站升级状态 - **参数说明** @@ -3399,7 +3450,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` ##### fEvtBsUpdateProgress -- **主题**: /manage/{baseSN}/receive +- **主题**: /manage/{baseSn}/receive - **功能描述**：返回基站升级进度 - **参数说明** @@ -3424,7 +3475,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` ##### fEvtBsFontLibState -- **主题**: /manage/{baseSN}/receive +- **主题**: /manage/{baseSn}/receive - **功能描述**：返回基站下载字库状态 - **参数说明** @@ -3451,7 +3502,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` ##### fEvtBsFontLibProgress -- **主题**: /manage/{baseSN}/receive +- **主题**: /manage/{baseSn}/receive - **功能描述**：返回基站下载字库进度 - **参数说明** @@ -3479,7 +3530,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ### 识别设置 #### 方法 ##### setKpSN -- **主题**：/manage/{baseSN}/send +- **主题**：/manage/{baseSn}/send - **功能描述**:设置指定键盘的出厂编码 - **参数说明** @@ -3508,7 +3559,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` ##### setKpID -- **主题**：/client/{baseSN}/send +- **主题**：/client/{baseSn}/send - **功能描述**：设置键盘编号 - **参数说明** @@ -3534,7 +3585,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` ##### setKpOemModel -- **主题**：/manage/{baseSN}/send +- **主题**：/manage/{baseSn}/send - **功能描述**：设置键盘OEM定制型号名称 - **参数说明** @@ -3561,7 +3612,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` ##### startGetKpInfo -- **主题**：/manage/{baseSN}/send +- **主题**：/manage/{baseSn}/send - **功能描述**：开始获取键盘信息 - **参数说明** @@ -3582,7 +3633,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` ##### stopGetKpInfo -- **主题**：/manage/{baseSN}/send +- **主题**：/manage/{baseSn}/send - **功能描述**：停止获取键盘信息 - **参数说明** @@ -3607,7 +3658,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 发送指令后返回接收状态 ##### fEvtSetKpSN -- **主题**：/manage/{baseSN}/receive +- **主题**：/manage/{baseSn}/receive - **功能描述**：返回写键盘SN状态 - **参数说明** @@ -3634,7 +3685,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` ##### fEvtSetKpID -- **主题**：/basestation/{baseSN}/receive +- **主题**：/basestation/{baseSn}/receive - **功能描述**：返回键盘编号 - **参数说明** @@ -3661,7 +3712,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` ##### fEvtSetKpOemModel -- **主题**：/manage/{baseSN}/receive +- **主题**：/manage/{baseSn}/receive - **功能描述**：返回写键盘OEM型号名称的状态 - **参数说明** @@ -3698,7 +3749,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` ##### fEvtKpInfo -- **主题**：/manage/{baseSN}/receive +- **主题**：/manage/{baseSn}/receive - **功能描述**：返回键盘信息 - **参数说明** @@ -3731,7 +3782,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ### 交互设置 #### 方法 ##### rtSetKpUserPrompt -- **主题**：/client/{baseSN}/send +- **主题**：/client/{baseSn}/send - **功能描述**：实时设置提示反馈信息 - **参数说明** @@ -3778,7 +3829,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` ##### rtSetKpScoreInfo -- **主题**：/client/{baseSN}/send +- **主题**：/client/{baseSn}/send - **功能描述**：实时设置键盘显示分数 - **参数说明** @@ -3815,7 +3866,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` ##### clearKpScoreInfo -- **主题**：/client/{baseSN}/send +- **主题**：/client/{baseSn}/send - **功能描述**：清除键盘分数 - **参数说明** @@ -3841,7 +3892,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` ##### rtSetKpDevice -- **主题**：/client/{baseSN}/send +- **主题**：/client/{baseSn}/send - **功能描述**：实时设置键盘外设（灯光、蜂鸣、马达） - **参数说明** @@ -3912,7 +3963,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` ##### setKpUserStbMsg -- **主题**：/manage/{baseSN}/send +- **主题**：/manage/{baseSn}/send - **功能描述**：设置用户内置状态语 - **参数说明** @@ -3957,7 +4008,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 发送指令后返回接收状态 ##### fEvtKpUserStbMsg -- **主题**：/manage/{baseSN}/receive +- **主题**：/manage/{baseSn}/receive - **功能描述**：返回设置状态语的状态 - **参数说明** @@ -3987,7 +4038,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` ##### fEvtSetKpUserPrompt -- **主题**：/basestation/{baseSN}/receive +- **主题**：/basestation/{baseSn}/receive - **功能描述**：返回实时设置提示语是否成功 - **参数说明** @@ -4025,7 +4076,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` ##### fEvtKpScoreInfo -- **主题**：/basestation/{baseSN}/receive +- **主题**：/basestation/{baseSn}/receive - **功能描述**：返回键盘实时设置分数的状态是否成功 - **参数说明** @@ -4058,7 +4109,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 } ``` ##### fEvtClearKpScoreInfo -- **主题**：/basestation/{baseSN}/receive +- **主题**：/basestation/{baseSn}/receive - **功能描述**：返回清空分数的指令状态是否成功 - **参数说明** @@ -4086,7 +4137,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` ##### fEvtSetKpDevice -- **主题**：/basestation/{baseSN}/receive +- **主题**：/basestation/{baseSn}/receive - **功能描述**：返回实时设置键盘外设是否成功 - **参数说明** @@ -4126,7 +4177,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ### 在线状态 #### 方法 ##### startGetKpOnline -- **主题**：/client/{baseSN}/send +- **主题**：/client/{baseSn}/send - **功能描述**：开始获取键盘在线信息,键盘在线返回键盘信息 - **参数说明** @@ -4147,7 +4198,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` ##### stopGetKpOnline -- **主题**：/client/{baseSN}/send +- **主题**：/client/{baseSn}/send - **功能描述**：停止获取键盘在线信息 - **参数说明** @@ -4167,7 +4218,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 } ``` ##### rtGetKpOnlineList -- **主题**：/client/{baseSN}/send +- **主题**：/client/{baseSn}/send - **功能描述**：实时获取基站存储的键盘在线列表 - **参数说明** @@ -4195,7 +4246,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 实时获取基站存储的键盘在线列表时返回此事件 ##### fEvtKpOnlineMsg -- **主题**: /basestation/{baseSN}/receive +- **主题**: /basestation/{baseSn}/receive - **功能描述**：主动获取在线键盘时，在线键盘状态报告 - **参数说明** @@ -4239,7 +4290,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ### 维护功能 #### 方法 ##### remoteKpSleep -- **主题**：/client/{baseSN}/send +- **主题**：/client/{baseSn}/send - **功能描述**：遥控键盘休眠 - **参数说明** @@ -4264,7 +4315,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` ##### setKpPairCode -- **主题**：/manage/{baseSN}/send +- **主题**：/manage/{baseSn}/send - **功能描述**：设置键盘配对码，一般用于批量将键盘配对至其他基站 - **参数说明** @@ -4291,7 +4342,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` ##### setKpPowerOffLevel -- **主题**：/manage/{baseSN}/send +- **主题**：/manage/{baseSn}/send - **功能描述**：设置键盘离线后关机时间 - **参数说明** @@ -4318,7 +4369,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` ##### startKpFWUpdate -- **主题**：/manage/{baseSN}/send +- **主题**：/manage/{baseSn}/send - **功能描述**:键盘升级 - **参数说明** @@ -4349,7 +4400,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 } ``` ##### stopKpFWUpdate -- **主题**：/manage/{baseSN}/send +- **主题**：/manage/{baseSn}/send - **功能描述**:停止键盘升级 - **参数说明** @@ -4370,7 +4421,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` ##### exitKpSilentUpdate -- **主题**：/manage/{baseSN}/send +- **主题**：/manage/{baseSn}/send - **功能描述**: 退出键盘静默升级 - **参数说明** @@ -4390,7 +4441,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` ##### resetKpDefault -- **主题**：/manage/{baseSN}/send +- **主题**：/manage/{baseSn}/send - **功能描述**:恢复键盘出厂设置 - **参数说明** @@ -4413,10 +4464,10 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ##### [sEvtStateCode](#sevtstatecode) 返回指令的接收状态 -注意：管理指令的接收状态需从**主题: /manage/{baseSN}/receive** 返回 +注意：管理指令的接收状态需从**主题: /manage/{baseSn}/receive** 返回 ##### fEvtSetKpPairCode -- **主题**: /manage/{baseSN}/receive +- **主题**: /manage/{baseSn}/receive - **功能描述**：返回设置键盘配对码是否成功 - **参数说明** @@ -4454,7 +4505,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` ##### fEvtSetKpPowerOffLevel -- **主题**: /manage/{baseSN}/receive +- **主题**: /manage/{baseSn}/receive - **功能描述**：返回设置键盘离线后关机时间是否成功 - **参数说明** @@ -4492,7 +4543,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` ##### fEvtKpFWUpdateState -- **主题**: /manage/{baseSN}/receive +- **主题**: /manage/{baseSn}/receive - **功能描述**：返回键盘升级状态 - **参数说明** @@ -4518,7 +4569,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 } ``` ##### fEvtKpUpdateProgress -- **主题**: /manage/{baseSN}/receive +- **主题**: /manage/{baseSn}/receive - **功能描述**：返回键盘升级进度 - **参数说明** @@ -4546,7 +4597,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ### 无线绑定 #### 方法 ##### rtSetKpBindingInfo -- **主题**：/client/{baseSN}/send +- **主题**：/client/{baseSn}/send - **功能描述**：实时设置绑定信息到键盘 - **参数说明** @@ -4580,7 +4631,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` ##### clearKpBindingInfo -- **主题**：/client/{baseSN}/send +- **主题**：/client/{baseSn}/send - **功能描述**：清除键盘绑定信息 - **参数说明** @@ -4609,7 +4660,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 发送指令后返回接收状态 ##### fEvtKpBindingInfo -- **主题**：/basestation/{baseSN}/receive +- **主题**：/basestation/{baseSn}/receive - **功能描述**：返回键盘实时设置绑定信息的状态是否成功 - **参数说明** @@ -4642,7 +4693,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 } ``` ##### fEvtClearKpBindingInfo -- **主题**：/basestation/{baseSN}/receive +- **主题**：/basestation/{baseSn}/receive - **功能描述**：返回清空绑定信息的指令状态是否成功 - **参数说明** @@ -4672,7 +4723,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ### 同步签到 #### 方法 ##### startKpSignIn -- **主题**：/client/{baseSN}/send +- **主题**：/client/{baseSn}/send - **功能描述**：启动同步签到 - **参数说明** @@ -4730,7 +4781,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ### 随时签到 #### 方法 ##### rtStartKpSignIn -- **主题**：/client/{baseSN}/send +- **主题**：/client/{baseSn}/send - **功能描述**：启动随时签到绑定 - **参数说明** @@ -4755,7 +4806,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 } ``` ##### rtStopKpSignIn -- **主题**：/client/{baseSN}/send +- **主题**：/client/{baseSn}/send - **功能描述**：停止随时签到绑定 - **参数说明** @@ -4775,7 +4826,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 } ``` ##### rtSetKpLoginAllowed -- **主题**：/client/{baseSN}/send +- **主题**：/client/{baseSn}/send - **功能描述**：实时PIN绑定授权,可取消授权 - **参数说明** @@ -4806,7 +4857,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 发送指令后返回接收状态 ##### fEvtKpSignIn -- **主题**：/basestation/{baseSN}/receive +- **主题**：/basestation/{baseSn}/receive - **功能描述**：返回键盘提交签到信息 - **参数说明** @@ -4844,7 +4895,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 } ``` ##### fEvtKpLoginAllowed -- **主题**：/basestation/{baseSN}/receive +- **主题**：/basestation/{baseSn}/receive - **功能描述**：返回键盘授权状态 - **参数说明** @@ -4874,7 +4925,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ### 判断题 #### 方法 ##### startQATrueFalse -- **主题**：/client/{baseSN}/send +- **主题**：/client/{baseSn}/send - **功能描述**：启动判断题答题 - **参数说明** @@ -4917,7 +4968,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 发送指令后返回接收状态 ##### fEvtQATrueFalse -- **主题**：/basestation/{baseSN}/receive +- **主题**：/basestation/{baseSn}/receive - **功能描述**：返回键盘提交答题信息 - **参数说明** @@ -4952,7 +5003,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ### 选择题 #### 方法 ##### startQAChoice -- **主题**：/client/{baseSN}/send +- **主题**：/client/{baseSn}/send - **功能描述**：启动选择题答题 - **参数说明** @@ -5001,7 +5052,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 发送指令后返回接收状态 ##### fEvtQAChoice -- **主题**：/basestation/{baseSN}/receive +- **主题**：/basestation/{baseSn}/receive - **功能描述**：返回键盘提交答题信息 - **参数说明** @@ -5035,7 +5086,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ### 数字题 #### 方法 ##### startQANum -- **主题**：/client/{baseSN}/send +- **主题**：/client/{baseSn}/send - **功能描述**：启动数字题答题 - **参数说明** @@ -5082,7 +5133,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 发送指令后返回接收状态 ##### fEvtQANum -- **主题**：/basestation/{baseSN}/receive +- **主题**：/basestation/{baseSn}/receive - **功能描述**：返回键盘提交答题信息 - **参数说明** @@ -5116,7 +5167,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ### 抢答题 #### 方法 ##### startQAQuicker -- **主题**：/client/{baseSN}/send +- **主题**：/client/{baseSn}/send - **功能描述**：启动抢答题答题 - **参数说明** @@ -5156,7 +5207,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 发送指令后返回接收状态 ##### fEvtQAQuicker -- **主题**：/basestation/{baseSN}/receive +- **主题**：/basestation/{baseSn}/receive - **功能描述**：返回键盘提交答题信息 - **参数说明** @@ -5190,7 +5241,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ### 文本题 #### 方法 ##### startQAEText -- **主题**：/client/{baseSN}/send +- **主题**：/client/{baseSn}/send - **功能描述**：启动文本题答题 - **参数说明** @@ -5228,7 +5279,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 发送指令后返回接收状态 ##### fEvtQAEText -- **主题**：/basestation/{baseSN}/receive +- **主题**：/basestation/{baseSn}/receive - **功能描述**：返回键盘提交答题信息 - **参数说明** @@ -5260,7 +5311,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ### 短信息 #### 方法 ##### sendKpMsg -- **主题**：/client/{baseSN}/send +- **主题**：/client/{baseSn}/send - **功能描述**：指定键盘发送短信息 - **参数说明** @@ -5319,7 +5370,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 发送指令后返回接收状态 ##### fEvtKpMsg -- **主题**：/basestation/{baseSN}/receive +- **主题**：/basestation/{baseSn}/receive - **功能描述**：返回短信息是否成功发送至键盘 - **参数说明** @@ -5354,7 +5405,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ### 表决 #### 方法 ##### startQAVote -- **主题**：/client/{baseSN}/send +- **主题**：/client/{baseSn}/send - **功能描述**：启动表决 - **参数说明** @@ -5397,7 +5448,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 发送指令后返回接收状态 ##### fEvtQAVote -- **主题**：/basestation/{baseSN}/receive +- **主题**：/basestation/{baseSn}/receive - **功能描述**：返回键盘提交表决信息 - **参数说明** @@ -5433,7 +5484,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ### 待机实时反馈 #### 方法 ##### setKpStbResponse -- **主题**：/client/{baseSN}/send +- **主题**：/client/{baseSn}/send - **功能描述**：启动待机实时反馈 - **参数说明** @@ -5483,7 +5534,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` ##### getKpStbResponse -- **主题**：/client/{baseSN}/send +- **主题**：/client/{baseSn}/send - **功能描述**：获取实时反馈是否打开 - **参数说明** @@ -5514,7 +5565,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 发送指令后返回接收状态 ##### fEvtKpStbResponse -- **主题**：/basestation/{baseSN}/receive +- **主题**：/basestation/{baseSn}/receive - **功能描述**：返回当前待机按键反馈开启状态 - **参数说明** @@ -5555,7 +5606,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ### 方法 #### 单题语音评测 ##### startQAVoice -- **主题**：/client/{baseSN}/send +- **主题**：/client/{baseSn}/send - **功能描述**：启动单题语音评测 - **参数说明** @@ -5598,7 +5649,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 发送指令后返回接收状态 #### fEvtVoiceFile -- **主题**：/basestation/{baseSN}/receive +- **主题**：/basestation/{baseSn}/receive - **功能描述**：开启录音格式为录音文件方式时返回此事件 - **参数说明** @@ -5624,7 +5675,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 } ``` #### fEvtVoiceStream -- **主题**：/basestation/{baseSN}/receive +- **主题**：/basestation/{baseSn}/receive - **功能描述**：开启录音格式为实时流方式时返回此事件 - **参数说明** @@ -5662,7 +5713,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 } ``` #### fEvtVoicePacketLossInfo -- **主题**：/basestation/{baseSN}/receive +- **主题**：/basestation/{baseSn}/receive - **功能描述**：开启录音格式为实时流方式，录音结束时返回此次录音的丢包率信息 - **参数说明** @@ -5700,7 +5751,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ### 方法 #### 拍照反馈 ##### startQAPhoto -- **主题**：/client/{baseSN}/send +- **主题**：/client/{baseSn}/send - **功能描述**：启动单题拍照反馈 - **参数说明** @@ -5750,7 +5801,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 发送指令后返回接收状态 #### fEvtPhotoFile -- **主题**：/basestation/{baseSN}/receive +- **主题**：/basestation/{baseSn}/receive - **功能描述**：开启拍照格式为图片文件方式时返回此事件 - **参数说明** @@ -5782,7 +5833,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ### 标准测验 #### 方法 ##### startKpExam -- **主题**：/client/{baseSN}/send +- **主题**：/client/{baseSn}/send - **功能描述**：启动标准测验 - **参数说明** @@ -5984,7 +6035,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 停止在线测验 ##### rtKpAllowEdited -- **主题**：/client/{baseSN}/send +- **主题**：/client/{baseSn}/send - **功能描述**：键盘提交后，允许键盘修改答案 - **参数说明** @@ -6013,7 +6064,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 发送指令后返回接收状态 ##### fEvtKpExam -- **主题**：/basestation/{baseSN}/receive +- **主题**：/basestation/{baseSn}/receive - **功能描述**：返回键盘提交答题信息 - **参数说明** @@ -6054,7 +6105,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ### 多科测验 #### 方法 ##### startKpMultiExam -- **主题**：/client/{baseSN}/send +- **主题**：/client/{baseSn}/send - **功能描述**：启动多科测验 - **参数说明** @@ -6164,7 +6215,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ### 自主录分 #### 方法 ##### startKpScoreInput -- **主题**：/client/{baseSN}/send +- **主题**：/client/{baseSn}/send - **功能描述**：启动自主录分 - **参数说明** @@ -6216,7 +6267,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 发送指令后返回接收状态 ##### fEvtKpScore -- **主题**：/basestation/{baseSN}/receive +- **主题**：/basestation/{baseSn}/receive - **功能描述**：返回键盘提交录分信息 - **参数说明** @@ -6256,7 +6307,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ### 自定义测验题型标题 #### 方法 ##### setKpExamQuesTitle -- **主题**：/client/{baseSN}/send +- **主题**：/client/{baseSn}/send - **功能描述**：设置自定义测验题题型标题，键盘需在线才能接收成功。
设置完成后启动测验，对应的题型显示为设置的自定义标题。
题型标题相对固定，下发成功后键盘会保存标题，标题无变化时无需重复下发。
如果没有指定键盘进行下发，基站需要一段时间进行下发的操作，强烈建议将下发操作提前完成，以免影响正常的答题流程。 - **参数说明** @@ -6298,7 +6349,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` ##### clearKpExamQuesTitle -- **主题**：/client/{baseSN}/send +- **主题**：/client/{baseSn}/send - **功能描述**：清除键盘自定义测验题型标题 - **参数说明** @@ -6329,7 +6380,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 发送指令后返回接收状态 ##### fEvtKpExamQuesTitle -- **主题**：/basestation/{baseSN}/receive +- **主题**：/basestation/{baseSn}/receive - **功能描述**：返回键盘设置自定义题型标题的状态是否成功 - **参数说明** @@ -6375,7 +6426,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 } ``` ##### fEvtClearKpExamQuesTitle -- **主题**：/basestation/{baseSN}/receive +- **主题**：/basestation/{baseSn}/receive - **功能描述**：返回清空自定义题型标题的指令状态是否成功 - **参数说明** @@ -6404,7 +6455,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ### 自定义科目 #### 方法 ##### setKpExamSubject -- **主题**：/client/{baseSN}/send +- **主题**：/client/{baseSn}/send - **功能描述**：设置自定义科目名称，键盘需在线才能接收成功。
设置完成后启动多科测验，对应的科目显示为设置的自定义科目名称。
科目名称相对固定，下发成功后键盘会保存科目名称，无变化时无需重复下发。
如果没有指定键盘进行下发，基站需要一段时间进行下发的操作，强烈建议将下发操作提前完成，以免影响正常的答题流程。 - **参数说明** @@ -6446,7 +6497,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ``` ##### clearKpExamSubject -- **主题**：/client/{baseSN}/send +- **主题**：/client/{baseSn}/send - **功能描述**：清除键盘自定义科目名称 - **参数说明** @@ -6477,7 +6528,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 发送指令后返回接收状态 ##### fEvtKpExamSubject -- **主题**：/basestation/{baseSN}/receive +- **主题**：/basestation/{baseSn}/receive - **功能描述**：返回键盘设置自定义科目名称的状态是否成功 - **参数说明** @@ -6523,7 +6574,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 } ``` ##### fEvtClearKpExamSubject -- **主题**：/basestation/{baseSN}/receive +- **主题**：/basestation/{baseSn}/receive - **功能描述**：返回清空自定义科目名称的指令状态是否成功 - **参数说明**