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

-Ver 1.0.2 +Ver 1.0.3


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

@@ -68,6 +68,7 @@ Ver 1.0.2 |---|---|---|---| |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. 增加内置状态语下发可指定键盘|

@@ -85,20 +86,20 @@ Ver 1.0.2 /client/{baseSN}/send /client/multiBase/send - + 内部应用发布的主题，基站订阅 /manage/{baseSN}/send - + ### 订阅的主题 应用程序订阅的主题，基站发布 /basestation/\{baseSN}/receive /basestation/multiBase/receive - + 内部应用订阅的主题，基站发布 /manage/{baseSN}/receive - + ## Websocket方式 WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口发送接收数据即可。应用程序发送至基站约定为发送指令，基站返回数据约定为返回事件。 @@ -194,16 +195,18 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 |基站连接 - 主动获取状态|主动获取基站连接状态|[getBsConnectState](#getbsconnectstate)|[sEvtBsConnectState](#sevtbsconnectstate)|| |基站连接 - 自动获取状态|基站连接变化系统通知|-|[sEvtBsConnectState](#sevtbsconnectstate)|| |基站授时|对基站授时用于校准时间|[timeSync](#timesync)|[sEvtStateCode](#sevtstatecode)|| -|键盘上线通知|单个键盘上线系统通知|-|[sEvtBsKpOnlineMsg](#sevtbskponlinemsg)|| -|识别设置 - 出厂编码|设置基站出厂编码(内)|[setBsSN](#setbssn)|[fEvtBsSN](#fevtbssn)| +|键盘上线通知|单个键盘上线系统通知|-|[sEvtBsKpOnlineMsg](#sevtbskponlinemsg)|| +|识别设置 - 出厂编码|设置基站出厂编码(内)|[setBsSN](#setbssn)|[fEvtBsSN](#fevtbssn)| |识别设置 - 基站型号|读取基站型号|[getBsModel](#getbsmodel)|[fEvtBsModel](#fevtbsmodel)| -|识别设置 - 固件版本|获取基站固件版本|[getBsFWVersion](#getbsfwversion)|[fEvtBsFWVersion](#fevtbsfwversion)| +|识别设置 - 固件版本|获取基站固件版本|[getBsFWVersion](#getbsfwversion)|[fEvtBsFWVersion](#fevtbsfwversion)| |识别设置 - 品牌识别码|获取基站品牌识别码(内)|[getBsBIC](#getbsbic)|[fEvtBsBIC](#fevtbsbic)| -||设置基站品牌识别码(内)|[setBsBIC](#setbsbic)|[fEvtBsBIC](#fevtbsbic)| -|组网设置 - 组网模式|获取基站组网模式|[getBsNetworkMode](#getbsnetworkmode)|[fEvtBsNetworkMode](#fevtbsnetworkmode)| -||设置基站组网模式
(前期不开放，后期需要)|[setBsNetworkMode](#setbsnetworkmode)|[fEvtBsNetworkMode](#fevtbsnetworkmode)| -|组网设置 - 配对码|获取基站配对码|[getBsPairCode](#getbspaircode)|[fEvtBsPairCode](#fevtbspaircode)| -||设置基站配对码(内)|[setBsPairCode](#setbspaircode)|[fEvtBsPairCode](#fevtbspaircode)| +||设置基站品牌识别码(内)|[setBsBIC](#setbsbic)|[fEvtBsBIC](#fevtbsbic)| +|组网设置 - 组网模式|获取基站组网模式|[getBsNetworkMode](#getbsnetworkmode)|[fEvtBsNetworkMode](#fevtbsnetworkmode)| +||设置基站组网模式
(前期不开放，后期需要)|[setBsNetworkMode](#setbsnetworkmode)|[fEvtBsNetworkMode](#fevtbsnetworkmode)| +|组网设置 - 配对码|获取基站配对码|[getBsPairCode](#getbspaircode)|[fEvtBsPairCode](#fevtbspaircode)| +||设置基站配对码(内)|[setBsPairCode](#setbspaircode)|[fEvtBsPairCode](#fevtbspaircode)| +|组网设置 - 组呼开关|获取组呼开关状态(内)|[getBsGroupCall](#getbsgroupcall)|[fEvtBsGroupCall](#fevtbsgroupcall)| +||设置基站组呼开关|[setBsGroupCall](#setbsgroupcall)|[fEvtBsGroupCall](#fevtbsgroupcall)|| |组网设置 - 刷卡配对状态|获取刷卡配对状态|[getBsNfcLogin](#getbsnfclogin)|[fEvtBsNfcLogin](#fevtbsnfclogin)| ||设置刷卡配对状态|[setBsNfcLogin](#setbsnfclogin)|[fEvtBsNfcLogin](#fevtbsnfclogin)|| |组网设置 - 工作信道|获取基站工作信道|[getBsChannel](#getbschannel)|[fEvtBsChannel](#fevtbschannel)| @@ -217,16 +220,16 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 ||设置基站登录状态|[setBsLoginState](#setbsloginstate)|[fEvtBsLoginState](#fevtbsloginstate)|| |键盘统一设置 - 键盘语言|获取键盘语言|[getBsKpLanguage](#getbskplanguage)|[fEvtBsKpLanguage](#fevtbskplanguage)| ||设置键盘语言|[setBsKpLanguage](#setbskplanguage)|[fEvtBsKpLanguage](#fevtbskplanguage)|| -|键盘统一设置 - 状态语模式|获取状态语设置状态|[getBsKpStbMsgMode](#getbskpstbmsgmode)|[fEvtBsKpStbMsgMode](#fevtbskpstbmsgmode)| -||设置状态语工作状态|[setBsKpStbMsgMode](#setbskpstbmsgmode)|[fEvtBsKpStbMsgMode](#fevtbskpstbmsgmode)||| +|键盘统一设置 - 状态语模式|获取状态语设置状态(内)|[getBsKpStbMsgMode](#getbskpstbmsgmode)|[fEvtBsKpStbMsgMode](#fevtbskpstbmsgmode)| +||设置状态语工作状态(内)|[setBsKpStbMsgMode](#setbskpstbmsgmode)|[fEvtBsKpStbMsgMode](#fevtbskpstbmsgmode)||| |键盘统一设置 - 登录菜单|获取键盘登录菜单状态|[getBsKpLoginMenu](#getbskploginmenu)|[fEvtBsKpLoginMenu](#fevtbskploginmenu)| ||设置键盘登录菜单状态|[setBsKpLoginMenu](#setbskploginmenu)|[fEvtBsKpLoginMenu](#fevtbskploginmenu)||| -|键盘统一设置 - 长距考勤|获取键盘长距考勤状态|[getBsKpRFIDState](#getbskprfidstate)|[fEvtBsKpRFIDState](#fevtbskprfidstate)| -||设置键盘长距考勤状态|[setBsKpRFIDState](#setbskprfidstate)|[fEvtBsKpRFIDState](#fevtbskprfidstate)| +|键盘统一设置 - 长距考勤|获取键盘长距考勤状态(内)|[getBsKpRFIDState](#getbskprfidstate)|[fEvtBsKpRFIDState](#fevtbskprfidstate)| +||设置键盘长距考勤状态(内)|[setBsKpRFIDState](#setbskprfidstate)|[fEvtBsKpRFIDState](#fevtbskprfidstate)| |键盘统一设置 - 键盘休眠|设置键盘休眠等级(内)|[setBsKpSleepLevel](#setbskpsleeplevel)|[fEvtBsKpSleepLevel](#fevtbskpsleeplevel)| ||获取键盘休眠等级(内)|[getBsKpSleepLevel](#getbskpsleeplevel)|[fEvtBsKpSleepLevel](#fevtbskpsleeplevel)| ||设置键盘暂停休眠状态(内)|[setBsKpPauseSleep](#setbskppausesleep)|[fEvtBsKpPauseSleep](#fevtbskppausesleep)| -||获取键盘暂停休眠状态(内)|[getBsKpPauseSleep](#getbskppausesleep)|[fEvtBsKpPauseSleep](#fevtbskppausesleep)| +||获取键盘暂停休眠状态(内)|[getBsKpPauseSleep](#getbskppausesleep)|[fEvtBsKpPauseSleep](#fevtbskppausesleep)| |配对模式 - 快速配对|启动基站快速配对|[startBsFastPair](#startbsfastpair)|[sEvtStateCode](#sevtstatecode)
[sEvtBsKpOnlineMsg](#sevtbskponlinemsg)| ||停止基站快速配对|[stopBsFastPair](#stopbsfastpair)|[sEvtStateCode](#sevtstatecode)| |白名单模式 - 白名单管理|获取白名单|[getBsWhitelist](#getbswhitelist)|[fEvtBsWhitelist](#fevtbswhitelist)| @@ -239,7 +242,7 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 |网络设置 - TCP/IP参数|获取TCP/IP参数|[getBsTcpipParams](#getbstcpipparams)|[fEvtBsTcpipParams](#fevtbstcpipparams)| ||设置TCP/IP参数|[setBsTcpipParams](#setbstcpipparams)|[fEvtBsTcpipParams](#fevtbstcpipparams)|| |网络设置 - MQTT参数|获取MQTT参数|[getBsMqttParams](#getbsmqttparams)|[fEvtBsMqttParams](#fevtbsmqttparams)| -||设置MQTT参数|[setBsMqttParams](#setbsmqttparams)|[fEvtBsMqttParams](#fevtbsmqttparams)|| +||设置MQTT参数|[setBsMqttParams](#setbsmqttparams)|[fEvtBsMqttParams](#fevtbsmqttparams)|| |基站维护|获取基站日志信息(内)|[getBsLogInfo](#getbsloginfo)|[sEvtStateCode](#sevtstatecode)
[fEvtBsLogInfo](#fevtbsloginfo)| ||清空基站日志(内)|[clearBsLogInfo](#clearbsloginfo)|[sEvtStateCode](#sevtstatecode)| ||基站软复位|[resetBsSystem](#resetbssystem)|[sEvtStateCode](#sevtstatecode)
[sEvtBsConnectState](#sevtbsconnectstate)| @@ -248,23 +251,23 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 |基站升级|开启基站升级(内)|[startBsUpdate](#startbsupdate)|[sEvtStateCode](#sevtstatecode)
[fEvtBsUpateState](#fevtbsupatestate)
[fEvtBsUpdateProgress](#fevtbsupdateprogress)| ||停止基站升级(内)|[stopBsUpdate](#stopbsupdate)|[sEvtStateCode](#sevtstatecode)
[fEvtBsUpateState](#fevtbsupatestate)| ||下载字库(内)|[downloadFontLib](#downloadfontlib)|[sEvtStateCode](#sevtstatecode)
[fEvtBsFontLibState](#fevtbsfontlibstate)
[fEvtBsFontLibProgress](#fevtbsfontlibprogress)| -||停止基站字库升级(内)|[stopFontLibUpdate](#stopfontlibupdate)|[sEvtStateCode](#sevtstatecode)
[fEvtBsFontLibState](#fevtbsfontlibstate)| +||停止基站字库升级(内)|[stopFontLibUpdate](#stopfontlibupdate)|[sEvtStateCode](#sevtstatecode)
[fEvtBsFontLibState](#fevtbsfontlibstate)| ### 键盘管理 |功能归类|功能|API指令|指令事件| |---|---|---|---| -|交互设置 - 用户内置状态语|设置用户内置状态语|[setKpUserStbMsg](#setkpuserstbmsg)|[fEvtKpUserStbMsg](#fevtkpuserstbmsg)| -|交互设置 - 用户实时提示反馈信息|实时设置提示反馈信息|[rtSetKpUserPrompt](#rtsetkpuserprompt)|[sEvtStateCode](#sevtstatecode)
[fEvtSetKpUserPrompt](#fevtsetkpuserprompt)| +|交互设置 - 用户实时提示反馈信息|实时设置提示反馈信息|[rtSetKpUserPrompt](#rtsetkpuserprompt)|[sEvtStateCode](#sevtstatecode)
[fEvtSetKpUserPrompt](#fevtsetkpuserprompt)| +|交互设置 - 用户内置状态语|设置用户内置状态语(内)|[setKpUserStbMsg](#setkpuserstbmsg)|[fEvtKpUserStbMsg](#fevtkpuserstbmsg)| |识别设置 - 出厂编码(内)|设置键盘出厂编码(内)|[setKpSN](#setkpsn)|[fEvtSetKpSN](#fevtsetkpsn)
| |识别设置 - 键盘编号(内)|设置键盘编号(内)|[setKpID](#setkpid)|[fEvtSetKpID](#fevtsetkpid)| |识别设置 - 键盘信息(内)|开始获取键盘信息(内)|[startGetKpInfo](#setkpid)|[sEvtStateCode](#sevtstatecode)
[fEvtKpInfo](#fevtkpinfo)| -||停止获取键盘信息(内)|[stopGetKpInfo](#setkpid)|[sEvtStateCode](#sevtstatecode)| +||停止获取键盘信息(内)|[stopGetKpInfo](#setkpid)|[sEvtStateCode](#sevtstatecode)| |在线状态获取|开启扫描在线键盘|[startGetKpOnline](#startgetkponline)|[sEvtStateCode](#sevtstatecode)
[fEvtKpOnlineMsg](#fevtkponlinemsg)| ||停止扫描在线键盘|[stopGetKpOnline](#stopgetkponline)|[sEvtStateCode](#sevtstatecode)| ||实时获取在线键盘列表|[rtGetKpOnlineList](#rtgetkponlinelist)|[sEvtBsKpOnlineList](#sevtbskponlinelist)| -|维护功能 - 遥控功能|遥控键盘休眠|[remoteKpSleep](#remotekpsleep)|[sEvtStateCode](#sevtstatecode)| +|维护功能 - 遥控功能|遥控键盘休眠|[remoteKpSleep](#remotekpsleep)|[sEvtStateCode](#sevtstatecode)| |维护功能 - 键盘升级|启动键盘无线升级(内)|[startKpFWUpdate](#startkpfwupdate)|[sEvtStateCode](#sevtstatecode)
[fEvtKpFWUpdateState](#fevtkpfwupdatestate)
[fEvtKpUpdateProgress](#fevtkpupdateprogress)
[sEvtBsKpOnlineMsg](#sevtbskponlinemsg)| ||停止键盘无线升级(内)|[stopKpFWUpdate](#stopkpfwupdate)|[sEvtStateCode](#sevtstatecode)
[fEvtKpFWUpdateState](#fevtkpfwupdatestate)| -|维护功能 - 恢复出厂|恢复键盘出厂设置|[resetKpDefault](#resetkpdefault)|[sEvtStateCode](#sevtstatecode)| +|维护功能 - 恢复出厂|恢复键盘出厂设置|[resetKpDefault](#resetkpdefault)|[sEvtStateCode](#sevtstatecode)| ### 绑定 |功能归类|功能|API指令|指令事件| |---|---|---|---| @@ -298,8 +301,8 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 |功能归类|功能|API指令|指令事件| |---|---|---|---| |标准测验|启动标准测验|[startKpExam](#startkpexam)|[sEvtStateCode](#sevtstatecode)
[fEvtKpExam](#fevtkpexam)
[fEvtFinalSubmit](#fevtfinalsubmit)| -||停止标准测验|[stopKpVote](#stopkpvote)|[sEvtStateCode](#sevtstatecode)| -||刷新作答数据|[rtGetKpExamData](#rtgetkpexamdata)|[sEvtStateCode](#sevtstatecode)
[fEvtKpExam](#fevtkpexam)| +||停止标准测验|[stopKpVote](#stopkpvote)|[sEvtStateCode](#sevtstatecode)| +||刷新作答数据|[rtGetKpExamData](#rtgetkpexamdata)|[sEvtStateCode](#sevtstatecode)
[fEvtKpExam](#fevtkpexam)| ||允许键盘提交后退回修改|[rtAllowEdited](#rtkpallowedited)|[sEvtStateCode](#sevtstatecode)
[fEvtFinalSubmit](#fevtfinalsubmit)| |多科测验|启动多科测验|[startKpMultiExam](#startkpmultiexam)|[sEvtStateCode](#sevtstatecode)
[fEvtKpExam](#fevtkpexam)
[fEvtFinalSubmit](#fevtfinalsubmit)| ||停止标准测验|[stopKpVote](#stopkpvote)|[sEvtStateCode](#sevtstatecode)| @@ -876,7 +879,7 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 ### 识别设置 #### 方法 - + ##### setBsSN - **主题**：/manage/{baseSN}/send @@ -904,7 +907,7 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 } } ``` - + ##### getBsModel - **主题**：/client/{baseSN}/send @@ -945,7 +948,7 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 } ``` - + ##### getBsBIC - **主题**：/manage/{baseSN}/send @@ -992,7 +995,7 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 } } ``` - + #### 事件 ##### fEvtBsSN @@ -1067,7 +1070,7 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 } } ``` - + ##### fEvtBsBIC - **主题**: /manage/{baseSN}/receive @@ -1093,7 +1096,7 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 } } ``` - + ### 组网设置 #### 方法 @@ -1116,7 +1119,7 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 "baseSn":"2024061101", } ``` - + ##### setBsNetworkMode - **主题**：/client/{baseSN}/send @@ -1142,7 +1145,7 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 } } ``` - + ##### getBsPairCode - **主题**：/client/{baseSN}/send @@ -1163,7 +1166,7 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 "baseSn":"2024061101" } ``` - + ##### setBsPairCode - **主题**：/manage/{baseSN}/send @@ -1191,7 +1194,56 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 } } ``` - + + + +##### getBsGroupCall +- **主题**：/manage/{baseSN}/send +- **功能描述**：获取基站组呼开关状态 +- **参数说明** + +|参数名|类型|限制|是否必填|说明| +|---|---|---|---|---| +|fun|string|-|是|指令名称| +|dataTag|string|-|否|数据包标识,可为空字符串| +|baseSn|string||是|基站的出厂编码| + +- **示例代码** +```json +{ + "fun":"getBsGroupCall", + "dataTag":"1", + "baseSn":"2024061101" +} +``` + +##### setBsGroupCall +- **主题**：/manage/{baseSN}/send +- **功能描述**：设置基站组呼开关状态 +- **参数说明** + +|参数名|类型|限制|是否必填|说明| +|---|---|---|---|---| +|fun|string|-|是|指令名称| +|dataTag|string|-|否|数据包标识,可为空字符串| +|baseSn|string||是|基站的出厂编码| +|data|object|-|否|传送参数的对象| +|+value|string|-|否|设置的基站组呼开关状态
0-关闭组呼
1-开启组呼| + + +- **示例代码** +```json +{ + "fun":"setBsGroupCall", + "dataTag":"1", + "baseSn":"2024061101", + "data":{ + "value":"0" + } +} +``` + ##### getBsNfcLogin - **主题**：/client/{baseSN}/send @@ -1410,6 +1462,33 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 } ``` + +##### fEvtBsGroupCall +- **主题**: /manage/{baseSN}/receive +- **功能描述**：返回基站组呼开关状态 +- **参数说明** + +|参数名|类型|限制|非空|说明| +|---|---|---|---|---| +|fun|string|-|是|事件名称| +|dataTag|string|-|否|数据包标识，可传空字符串| +|baseSn|string||是|基站的出厂编码| +|data|object|-|是|传送参数的对象| +|+value|string||是|0-关闭 1-开启| + +- **示例代码** +```json +{ + "fun":"fEvtBsGroupCall", + "dataTag":"1", + "baseSn":"2024061101", + "data":{ + "value":"1" + } +} +``` + + ##### fEvtBsNfcLogin - **主题**: /basestation/{baseSN}/receive - **功能描述**：返回基站是否允许NFC刷卡 @@ -1696,8 +1775,10 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 } } ``` + + ##### getBsKpStbMsgMode -- **主题**：/client/{baseSN}/send +- **主题**：/manage/{baseSN}/send - **功能描述**：获取状态语设置状态 - **参数说明** @@ -1716,7 +1797,7 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 } ``` ##### setBsKpStbMsgMode -- **主题**：/client/{baseSN}/send +- **主题**：/manage/{baseSN}/send - **功能描述**：设置状态语工作状态 - **参数说明** @@ -1739,6 +1820,8 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 } } ``` + + ##### getBsKpLoginMenu - **主题**：/client/{baseSN}/send - **功能描述**：获取键盘登录菜单显示状态 @@ -1784,8 +1867,9 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 } ``` + ##### getBsKpRFIDState -- **主题**：/client/{baseSN}/send +- **主题**：/manage/{baseSN}/send - **功能描述**：获取键盘长距离考勤开启状态 - **参数说明** @@ -1804,7 +1888,7 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 } ``` ##### setBsKpRFIDState -- **主题**：/client/{baseSN}/send +- **主题**：/manage/{baseSN}/send - **功能描述**：设置键盘长距离考勤开启状态 - **参数说明** @@ -1827,7 +1911,6 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 } } ``` - ##### getBsKpSleepLevel - **主题**：/manage/{baseSN}/send @@ -1918,7 +2001,7 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 "baseSn":"2024061101" } ``` - + #### 事件 ##### fEvtBsKpLanguage @@ -1945,8 +2028,10 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 } } ``` + + ##### fEvtBsKpStbMsgMode -- **主题**: /basestation/{baseSN}/receive +- **主题**: /manage/{baseSN}/receive - **功能描述**：返回状态语工作状态 - **参数说明** @@ -1969,6 +2054,8 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 } } ``` + + ##### fEvtBsKpLoginMenu - **主题**: /basestation/{baseSN}/receive - **功能描述**：返回键盘登录菜单显示状态 @@ -1994,8 +2081,9 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 } ``` + ##### fEvtBsKpRFIDState -- **主题**: /basestation/{baseSN}/receive +- **主题**: /manage/{baseSN}/receive - **功能描述**：返回键盘长距离考勤开启状态 - **参数说明** @@ -2018,7 +2106,6 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 } } ``` - ##### fEvtBsKpSleepLevel - **主题**: /manage/{baseSN}/receive @@ -2069,7 +2156,7 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 } } ``` - + ### 配对模式 #### 方法 @@ -2586,7 +2673,7 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 } } ``` - + ### 基站维护 #### 方法 @@ -2887,7 +2974,7 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 ##### fEvtBsUpateState - **主题**: /manage/{baseSN}/receive -- **功能描述**：返回基站启动升级状态 +- **功能描述**：返回基站升级状态 - **参数说明** |参数名|类型|限制|非空|说明| @@ -2988,11 +3075,11 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 } } ``` - + ## 键盘管理 - + ### 识别设置 #### 方法 @@ -3179,40 +3266,10 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 } } ``` - + ### 交互设置 #### 方法 -##### setKpUserStbMsg -- **主题**：/client/{baseSN}/send -- **功能描述**：设置用户内置状态语 -- **参数说明** - -|参数名|类型|限制|是否必填|说明| -|---|---|---|---|---| -|fun|string|-|是|指令名称| -|dataTag|string|-|否|数据包标识,可为空字符串| -|baseSn|string||是|基站的出厂编码| -|data|object|-|是|传送参数的对象| -|+online|string||是|在线状态显示的待机语
空字符串清除| -|+offline|string||是|离线状态显示的待机语
空字符串清除| -|+submitting|string||是|提交中状态语
空字符串清除| -|+submitted|string||是|已提交状态语
空字符串清除| - -- **示例代码** -```json -{ - "fun":"setKpUserStbMsg", - "dataTag":"1", - "baseSn":"2024061101", - "data":{ - "online":"请认真听讲", - "offline":"离线", - "submitting":"提交中", - "submitted":"提交成功" - } -} -``` ##### rtSetKpUserPrompt - **主题**：/client/{baseSN}/send - **功能描述**：实时设置提示反馈信息 @@ -3259,12 +3316,64 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 ] } ``` + + +##### setKpUserStbMsg +- **主题**：/manage/{baseSN}/send +- **功能描述**：设置用户内置状态语 +- **参数说明** + +|参数名|类型|限制|是否必填|说明| +|---|---|---|---|---| +|fun|string|-|是|指令名称| +|dataTag|string|-|否|数据包标识,可为空字符串| +|baseSn|string||是|基站的出厂编码| +|data|object|-|是|传送参数的对象| +|+keySns|array||是|空数组表示所有在线键盘| +|+online|string||是|在线状态显示的待机语
空字符串清除| +|+offline|string||是|离线状态显示的待机语
空字符串清除| +|+submitting|string||是|提交中状态语
空字符串清除| +|+submitted|string||是|已提交状态语
空字符串清除| + +- **示例代码** +```json +{ + "fun":"setKpUserStbMsg", + "dataTag":"1", + "baseSn":"2024061101", + "data":{ + "keySns":["1234567890","1234567891"], + "online":"请认真听讲", + "offline":"离线", + "submitting":"提交中", + "submitted":"提交成功" + } +} + +//广播 +{ + "fun":"setKpUserStbMsg", + "dataTag":"1", + "baseSn":"2024061101", + "data":{ + "keySns":[], + "online":"请认真听讲", + "offline":"离线", + "submitting":"提交中", + "submitted":"提交成功" + } +} +``` + + #### 事件 ##### [sEvtStateCode](#sevtstatecode) 发送指令后返回接收状态 + + ##### fEvtKpUserStbMsg -- **主题**：/basestation/{baseSN}/receive +- **主题**：/manage/{baseSN}/receive - **功能描述**：返回设置状态语的状态 - **参数说明** @@ -3273,8 +3382,9 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 |fun|string|-|是|指令名称| |dataTag|string|-|否|数据包标识,可为空字符串| |baseSn|string||是|基站的出厂编码| -|data|object|-|否|传送参数的对象| -|+state|string||是|设置状态语是否成功
0 - 成功
1 - 失败| +|data|array|-|否|传送参数的对象数组| +|++keySn|string||是|键盘SN，广播下发则返回空字符串| +|++state|string||是|设置状态语是否成功
0 - 成功
1 - 失败| - **示例代码** ```json @@ -3282,11 +3392,17 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 "fun":"fEvtKpUserStbMsg", "dataTag":"1", "baseSn":"2024061101", - "data":{ + "data":[{ + "keySn":"1234567890", "state":"0" - } + },{ + "keySn":"1234567891", + "state":"0" + }] } ``` + + ##### fEvtSetKpUserPrompt - **主题**：/basestation/{baseSN}/receive - **功能描述**：返回实时设置提示语是否成功 @@ -3409,7 +3525,7 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 |++keySn|string||是|键盘SN| |++version|string||是|键盘固件版本| |++model|int||是|键盘型号| -|++voltage|double||是|键盘电量（待键盘修改成百分比）| +|++voltage|double||是|键盘电量（待键盘修改成百分比）| - **示例代码** ```json @@ -3457,7 +3573,7 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 } } ``` - + ##### startKpFWUpdate - **主题**：/manage/{baseSN}/send @@ -3533,12 +3649,12 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 "dataTag":"1" } ``` - + #### 事件 ##### [sEvtStateCode](#sevtstatecode) 返回指令的接收状态 - + 注意：升级指令的接收状态需从**主题: /manage/{baseSN}/receive** 返回 ##### fEvtKpFWUpdateState @@ -3591,7 +3707,7 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 } } ``` - + ## 绑定 ### 无线绑定 @@ -3731,11 +3847,11 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 |dataTag|string|-|否|数据包标识,可为空字符串| |baseSn|string||是|基站的出厂编码| |data|object|-|是|传递参数的对象| -|+mode|int|-|是|签到模式
1-按键签到，可指定按键
2-PIN码签到，可指定PIN码长度
3-指纹签到(暂不支持)| +|+mode|int|-|是|签到模式
1-按键签到，可指定按键
2-PIN码签到，可指定PIN码长度
3-指纹签到(暂不支持)| |+allowModify |int|-|是 | 修改模式
0-不可修改
1-可以修改(默认值)| |+pinLen |int|-|是| 可输入pin码的最大长度 1≤N≤14 | |+keyValue |int|-|是 | 指定按键键值
0: 未指定(OK键签到)
1-9: 按键1-9
10: 按键0
11: 上键
12: 下键
13: OK键
14: ESC键
15: Menu键 | -|+tipTitle |string|-|否| 提示标题,长度最多不超过16个字节| +|+tip|string|-|否| 提示标题,长度最多不超过16个字符| - **示例代码** ```json @@ -3805,7 +3921,7 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 |dataTag|string|-|否|数据包标识,可为空字符串| |baseSn|string||是|基站的出厂编码| |data|object|-|是|传递参数的对象| -|+mode|int|-|是|签到模式
1-按键签到，按OK键签到自动授权(暂不支持)
2-PIN码签到，输入pin码后由应用程序决定是否授权| +|+mode|int|-|是|签到模式
1-按键签到，按OK键签到自动授权(暂不支持)
2-PIN码签到，输入pin码后由应用程序决定是否授权| - **示例代码** @@ -3952,9 +4068,9 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 |+count|int||是|题目数量，1-16，>1多题快答| |+mode|int||是|1 - True/False 对/错
2 - Yes/No 是/否
3 - √/×| |+allowModify|int||是|0 - 不允许修改
1 - 允许修改| -|+tip|string||否|提示的标题，长度不超过16字符| +|+tip|string||否|提示的标题，长度不超过16字符| |+simParams|object||否|内部模拟测试参数设置对象| -|++answer|string||是|预设提交的按键值
1-对
2-错| +|++answer|string||是|预设提交的按键值
1-对
2-错| - **示例代码** @@ -4050,9 +4166,9 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 |+options|int||是|选项数量，1≤M≤10(默认值4)| |+optionalN|int||是|可选项个数，1≤N≤M(默认值1)| |+allowModify|int||是|修改模式
0 - 不允许修改
1 - 允许修改| -|+tip|string||否|提示的标题，长度不超过16字符| +|+tip|string||否|提示的标题，长度不超过16字符| |+simParams|object||否|内部模拟测试参数设置对象| -|++answer|string||是|预设提交的按键值| +|++answer|string||是|预设提交的按键值| - **示例代码** @@ -4148,9 +4264,9 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 |+numMin|int||是|可输入下限,mode=1有效，范围0-100| |+numMax|int||是|可输入上限,mode=1有效，范围0-100| |+allowModify|int||是|修改模式
0 - 不允许修改
1 - 允许修改| -|+tip|string||否|提示的标题，长度不超过16字符| +|+tip|string||否|提示的标题，长度不超过16字符| |+simParams|object||否|内部模拟测试参数设置对象| -|++answer|string||是|预设提交的按键值| +|++answer|string||是|预设提交的按键值| - **示例代码** @@ -4242,9 +4358,9 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 |+keySns|array||是|指定的键盘SN数组，空数组表示全部在线键盘| |+mode|int||是|模式
0:普通抢答| |+allowModify|int||是|修改模式
0 - 不允许修改
1 - 允许修改| -|+tip|string||否|提示的标题，长度不超过16字符| +|+tip|string||否|提示的标题，长度不超过16字符| |+simParams|object||否|内部模拟测试参数设置对象| -|++answer|string||是|预设提交的按键值| +|++answer|string||是|预设提交的按键值| - **示例代码** ```json @@ -4332,9 +4448,9 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 |data|object|-|是|传送参数的对象| |+keySns|array||是|指定的键盘SN数组，空数组表示全部在线键盘| |+mode|int||是|模式
1:自由输入，最多不超过144字符| -|+allowModify|int||是|修改模式
0 - 不允许修改
1 - 允许修改| +|+allowModify|int||是|修改模式
0 - 不允许修改
1 - 允许修改| |+simParams|object||否|内部模拟测试参数设置对象| -|++answer|string||是|预设提交的按键值| +|++answer|string||是|预设提交的按键值| - **示例代码** ```json @@ -4419,7 +4535,7 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 |++keySn|string||是|需要设置绑定信息的键盘SN
空字符串且只有一条信息时代表群发所有在线键盘| |++month|int||是|月份，范围1-12| |++day|int||是|日期,范围1-31| -|++info|string||是|信息内容| +|++info|string||是|信息内容，最多48字节| - **示例代码** ```json @@ -4634,9 +4750,9 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 |++quesType | int||是| 题目类型
1:单选
2:多选（排序）
3:数字
4:判断
5:自判题| |++option |int||是 |选项数目
quesType = 1 有效。
quesType = 2 有效。
此项缺省时 默认4;
范围：1-10。| |++startNo | string||是| 起始题号,可以为数字+“-”，单级的题号数字范围1-255，如“1”，“1-1”，“1-1-1”，最多只能输入三级
mode=0 时有效，mode=1或2时键盘按顺序显示题号| -|++count | int||是| 相同参数的连续题目数量, >0
注意：总题数最多支持200题 | +|++count | int||是| 相同参数的连续题目数量, >0
注意：总题数最多支持200题 | |+simParams|object||否|内部模拟测试参数设置对象| -|++answer|array||是|预设提交的按键值
格式为"单选题答案,多选题答案;
数字题答案;判断题答案(1对2错)"
如["A","ABCD","10","1"]| +|++answer|array||是|预设提交的按键值
格式为"单选题答案,多选题答案;
数字题答案;判断题答案(1对2错)"
如["A","ABCD","10","1"]| - **示例代码** @@ -4837,7 +4953,7 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 ##### [stopKpVote](#stopkpvote) 停止在线测验 - + ##### rtGetKpExamData - **主题**：/client/{baseSN}/send @@ -4863,7 +4979,7 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 } } ``` - + ##### rtKpAllowEdited - **主题**：/client/{baseSN}/send @@ -4981,9 +5097,9 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 |++quesType | int||是| 题目类型
1:单选
2:多选（排序）
3:数字
4:判断
5:自判题| |++option |int||是 |选项数目
quesType = 1 有效。
quesType = 2 有效。
此项缺省时 默认4;
范围：1-10。| |++startNo | string||是| 起始题号,可以为数字+“-”，单级的题号数字范围1-255，如“1”，“1-1”，最多支持两级题号
mode=0 时有效，mode=1或2时键盘按顺序显示题号| -|++count | int||是| 相同参数的连续题目数量, >0
注意：所有科目的总题数最多支持200题| +|++count | int||是| 相同参数的连续题目数量, >0
注意：所有科目的总题数最多支持200题| |+simParams|object||否|内部模拟测试参数设置对象| -|++answer|array||是|预设提交的按键值
格式为"单选题答案,多选题答案;
数字题答案;判断题答案(1对2错)"
如["A","ABCD","10","1"]| +|++answer|array||是|预设提交的按键值
格式为"单选题答案,多选题答案;
数字题答案;判断题答案(1对2错)"
如["A","ABCD","10","1"]| - **示例代码** ```json