diff --git a/通讯协议-B200W-MQTT协议[内部].md b/通讯协议-B200W-MQTT协议[内部].md index ffb940d..2dd99de 100644 --- a/通讯协议-B200W-MQTT协议[内部].md +++ b/通讯协议-B200W-MQTT协议[内部].md @@ -18,7 +18,6 @@ html: background-color: yellow; } - [TOC]

@@ -84,16 +83,20 @@ Ver 1.0.3 /client/{baseSN}/send /client/multiBase/send -内部应用发布的主题，基站订阅 -/manage/{baseSN}/send + + 内部应用发布的主题，基站订阅 + /manage/{baseSN}/send + ### 订阅的主题 应用程序订阅的主题，基站发布 /basestation/\{baseSN}/receive /basestation/multiBase/receive + 内部应用订阅的主题，基站发布 /manage/{baseSN}/receive + ## 指令说明 |指令功能标识 |说明 |约束| @@ -162,16 +165,16 @@ Ver 1.0.3 |基站连接 - 主动获取状态|主动获取基站连接状态|[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)| |组网设置 - 刷卡配对状态|获取刷卡配对状态|[getBsNfcLogin](#getbsnfclogin)|[fEvtBsNfcLogin](#fevtbsnfclogin)| ||设置刷卡配对状态|[setBsNfcLogin](#setbsnfclogin)|[fEvtBsNfcLogin](#fevtbsnfclogin)|| |组网设置 - 工作信道|获取基站工作信道|[getBsChannel](#getbschannel)|[fEvtBsChannel](#fevtbschannel)| @@ -190,11 +193,11 @@ Ver 1.0.3 |键盘统一设置 - 登录菜单|获取键盘登录菜单状态|[getBsKpLoginMenu](#getbskploginmenu)|[fEvtBsKpLoginMenu](#fevtbskploginmenu)| ||设置键盘登录菜单状态|[setBsKpLoginMenu](#setbskploginmenu)|[fEvtBsKpLoginMenu](#fevtbskploginmenu)||| |键盘统一设置 - 长距考勤|获取键盘长距考勤状态|[getBsKpRFIDState](#getbskprfidstate)|[fEvtBsKpRFIDState](#fevtbskprfidstate)| -||设置键盘长距考勤状态|[setBsKpRFIDState](#setbskprfidstate)|[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)| @@ -207,29 +210,29 @@ Ver 1.0.3 |网络设置 - 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)| ||基站断电复位|[resetBsPower](#resetbspower)|[sEvtStateCode](#sevtstatecode)
[sEvtBsConnectState](#sevtbsconnectstate)| ||基站自检(内)|[startBsSelfCheck](#startbsselfcheck)|[sEvtStateCode](#sevtstatecode)
[fEvtBsSelfCheck](#fevtbsselfcheck)| |基站升级|开启基站升级(内)|[startBsUpdate](#startbsupdate)|[sEvtStateCode](#sevtstatecode)
[fEvtBsUpateState](#fevtbsupatestate)
[fEvtBsUpdateProgress](#fevtbsupdateprogress)| -||下载字库(内)|[downloadFontLib](#downloadfontlib)|[sEvtStateCode](#sevtstatecode)
[fEvtBsFontLibState](#fevtbsfontlibstate)
[fEvtBsFontLibProgress](#fevtbsfontlibprogress)| +||下载字库(内)|[downloadFontLib](#downloadfontlib)|[sEvtStateCode](#sevtstatecode)
[fEvtBsFontLibState](#fevtbsfontlibstate)
[fEvtBsFontLibProgress](#fevtbsfontlibprogress)| ### 键盘管理 |功能归类|功能|API指令|指令事件| |---|---|---|---| +|交互设置 - 用户内置状态语|设置用户内置状态语|[setKpUserStbMsg](#setkpuserstbmsg)|[fEvtKpUserStbMsg](#fevtkpuserstbmsg)| +|交互设置 - 用户实时提示反馈信息|实时设置提示反馈信息|[rtSetKpUserPrompt](#rtsetkpuserprompt)|[sEvtStateCode](#sevtstatecode)
[fEvtSetKpUserPrompt](#fevtsetkpuserprompt)| |识别设置 - 出厂编码(内)|设置键盘出厂编码(内)|[setKpSN](#setkpsn)|[fEvtSetKpSN](#fevtsetkpsn)
| |识别设置 - 键盘编号(内)|设置键盘编号(内)|[setKpID](#setkpid)|[fEvtSetKpID](#fevtsetkpid)| |识别设置 - 键盘信息(内)|开始获取键盘信息(内)|[startGetKpInfo](#setkpid)|[sEvtStateCode](#sevtstatecode)
[fEvtKpInfo](#fevtkpinfo)| -||停止获取键盘信息(内)|[stopGetKpInfo](#setkpid)|[sEvtStateCode](#sevtstatecode)| -|交互设置 - 用户内置状态语|设置用户内置状态语|[setKpUserStbMsg](#setkpuserstbmsg)|[fEvtKpUserStbMsg](#fevtkpuserstbmsg)| -|交互设置 - 用户实时提示反馈信息|实时设置提示反馈信息|[rtSetKpUserPrompt](#rtsetkpuserprompt)|[sEvtStateCode](#sevtstatecode)
[fEvtSetKpUserPrompt](#fevtsetkpuserprompt)| +||停止获取键盘信息(内)|[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)| +||停止键盘无线升级(内)|[stopKpFWUpdate](#stopkpfwupdate)|[sEvtStateCode](#sevtstatecode)
[fEvtKpFWUpdateState](#fevtkpfwupdatestate)| ### 绑定 |功能归类|功能|API指令|指令事件| |---|---|---|---| @@ -263,8 +266,8 @@ Ver 1.0.3 |功能归类|功能|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)| @@ -682,6 +685,8 @@ Ver 1.0.3 ### 识别设置 #### 方法 + + ##### setBsSN - **主题**：/manage/{baseSN}/send - **功能描述**：设置基站的SN，需预先订阅新SN的主题,以获取事件返回 @@ -706,6 +711,8 @@ Ver 1.0.3 } } ``` + + ##### getBsModel - **主题**：/client/{baseSN}/send - **功能描述**：获取基站型号 @@ -739,7 +746,11 @@ Ver 1.0.3 "fun":"getBsFWVersion", "dataTag":"1" } + ``` + + + ##### getBsBIC - **主题**：/manage/{baseSN}/send - **功能描述**：获取基站品牌识别码 @@ -757,6 +768,7 @@ Ver 1.0.3 "dataTag":"1" } ``` + ##### setBsBIC - **主题**：/manage/{baseSN}/send - **功能描述**：设置基站品牌识别码 @@ -781,6 +793,8 @@ Ver 1.0.3 } } ``` + + #### 事件 ##### fEvtBsSN - **主题**: /basestation/{baseSN}/receive @@ -848,6 +862,8 @@ Ver 1.0.3 } } ``` + + ##### fEvtBsBIC - **主题**: /manage/{baseSN}/receive - **功能描述**：返回基站的品牌码 @@ -870,6 +886,8 @@ Ver 1.0.3 } } ``` + + ### 组网设置 #### 方法 ##### getBsNetworkMode @@ -889,6 +907,8 @@ Ver 1.0.3 "dataTag":"1" } ``` + + ##### setBsNetworkMode - **主题**：/client/{baseSN}/send - **功能描述**：设置基站组网模式 @@ -911,6 +931,8 @@ Ver 1.0.3 } } ``` + + ##### getBsPairCode - **主题**：/client/{baseSN}/send - **功能描述**：获取基站配对码 @@ -928,6 +950,8 @@ Ver 1.0.3 "dataTag":"1" } ``` + + ##### setBsPairCode - **主题**：/manage/{baseSN}/send - **功能描述**：设置基站配对码 @@ -952,6 +976,8 @@ Ver 1.0.3 } } ``` + + ##### getBsNfcLogin - **主题**：/client/{baseSN}/send - **功能描述**：获取刷卡配对状态 @@ -1530,6 +1556,7 @@ Ver 1.0.3 } } ``` + ##### getBsKpSleepLevel - **主题**：/manage/{baseSN}/send @@ -1612,6 +1639,7 @@ Ver 1.0.3 "dataTag":"1" } ``` + #### 事件 ##### fEvtBsKpLanguage @@ -1703,6 +1731,7 @@ Ver 1.0.3 } } ``` + ##### fEvtBsKpSleepLevel - **主题**: /manage/{baseSN}/receive @@ -1749,6 +1778,7 @@ Ver 1.0.3 } } ``` + ### 配对模式 #### 方法 @@ -2225,6 +2255,8 @@ Ver 1.0.3 } } ``` + + ### 基站维护 #### 方法 ##### getBsLogInfo @@ -2316,7 +2348,6 @@ Ver 1.0.3 "dataTag":"1" } ``` - #### 事件 ##### [sEvtStateCode](#sevtstatecode) 返回指令的接收状态 @@ -2388,7 +2419,6 @@ Ver 1.0.3 ] } ``` - ### 基站升级 #### 方法 ##### startBsUpdate @@ -2552,8 +2582,12 @@ Ver 1.0.3 } } ``` + ## 键盘管理 + + + ### 识别设置 #### 方法 ##### setKpSN @@ -2725,6 +2759,7 @@ Ver 1.0.3 } } ``` + ### 交互设置 #### 方法 @@ -2939,7 +2974,7 @@ Ver 1.0.3 |+keySn|string||是|键盘SN| |+version|string||是|键盘固件版本| |+model|int||是|键盘型号| -|+voltage|double||是|键盘电量（待键盘修改成百分比）| +|+voltage|double||是|键盘电量（待键盘修改成百分比）| - **示例代码** ```json @@ -2979,6 +3014,8 @@ Ver 1.0.3 } } ``` + + ##### startKpFWUpdate - **主题**：/manage/{baseSN}/send - **功能描述**:键盘升级 @@ -3029,10 +3066,12 @@ Ver 1.0.3 "dataTag":"1" } ``` + #### 事件 ##### [sEvtStateCode](#sevtstatecode) -返回升级指令的接收状态 +返回指令的接收状态 + 注意：升级指令的接收状态需从**主题: /manage/{baseSN}/receive** 返回 ##### fEvtKpFWUpdateState @@ -3081,6 +3120,8 @@ Ver 1.0.3 } } ``` + + ## 绑定 ### 无线绑定 #### 方法 @@ -3210,7 +3251,7 @@ Ver 1.0.3 |fun|string|-|是|指令名称| |dataTag|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键 | @@ -3281,7 +3322,7 @@ Ver 1.0.3 |fun|string|-|是|指令名称| |dataTag|string|-|否|数据包标识,可为空字符串| |data|object|-|是|传递参数的对象| -|+mode|int|-|是|签到模式
1-按键签到，按OK键签到自动授权(暂不支持)
2-PIN码签到，输入pin码后由应用程序决定是否授权| +|+mode|int|-|是|签到模式
1-按键签到，按OK键签到自动授权(暂不支持)
2-PIN码签到，输入pin码后由应用程序决定是否授权| - **示例代码** @@ -3793,7 +3834,7 @@ Ver 1.0.3 |dataTag|string|-|否|数据包标识,可为空字符串| |data|object|-|是|传送参数的对象| |+keySns|array||是|指定的键盘SN数组，空数组表示全部在线键盘| -|+mode|int||是|模式
0:自由输入| +|+mode|int||是|模式
1:自由输入字母，最多不超过144字符| |+allowModify|int||是|修改模式
0 - 不允许修改
1 - 允许修改| |+tip|string||否|提示的标题，长度不超过16字符| |+simParams|object||否|内部模拟测试参数设置对象| @@ -4298,6 +4339,8 @@ Ver 1.0.3 ##### [stopKpVote](#stopkpvote) 停止在线测验 + + ##### rtGetKpExamData - **主题**：/client/{baseSN}/send - **功能描述**：刷新作答数据 @@ -4320,6 +4363,8 @@ Ver 1.0.3 } } ``` + + ##### rtKpAllowEdited - **主题**：/client/{baseSN}/send - **功能描述**：键盘提交后，允许键盘修改答案 diff --git a/通讯协议-平台化-应用部分.md b/通讯协议-平台化-应用部分.md index 593cf13..e0a133c 100644 --- a/通讯协议-平台化-应用部分.md +++ b/通讯协议-平台化-应用部分.md @@ -84,16 +84,20 @@ Ver 1.0.1 /client/{baseSN}/send /client/multiBase/send -内部应用发布的主题，基站订阅 -/manage/{baseSN}/send + + 内部应用发布的主题，基站订阅 + /manage/{baseSN}/send + ### 订阅的主题 应用程序订阅的主题，基站发布 /basestation/\{baseSN}/receive /basestation/multiBase/receive + 内部应用订阅的主题，基站发布 /manage/{baseSN}/receive + ## Websocket方式 WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口发送接收数据即可。应用程序发送至基站约定为发送指令，基站返回数据约定为返回事件。 @@ -189,16 +193,16 @@ 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)| |组网设置 - 刷卡配对状态|获取刷卡配对状态|[getBsNfcLogin](#getbsnfclogin)|[fEvtBsNfcLogin](#fevtbsnfclogin)| ||设置刷卡配对状态|[setBsNfcLogin](#setbsnfclogin)|[fEvtBsNfcLogin](#fevtbsnfclogin)|| |组网设置 - 工作信道|获取基站工作信道|[getBsChannel](#getbschannel)|[fEvtBsChannel](#fevtbschannel)| @@ -217,11 +221,11 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 |键盘统一设置 - 登录菜单|获取键盘登录菜单状态|[getBsKpLoginMenu](#getbskploginmenu)|[fEvtBsKpLoginMenu](#fevtbskploginmenu)| ||设置键盘登录菜单状态|[setBsKpLoginMenu](#setbskploginmenu)|[fEvtBsKpLoginMenu](#fevtbskploginmenu)||| |键盘统一设置 - 长距考勤|获取键盘长距考勤状态|[getBsKpRFIDState](#getbskprfidstate)|[fEvtBsKpRFIDState](#fevtbskprfidstate)| -||设置键盘长距考勤状态|[setBsKpRFIDState](#setbskprfidstate)|[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)| @@ -234,29 +238,29 @@ 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)| ||基站断电复位|[resetBsPower](#resetbspower)|[sEvtStateCode](#sevtstatecode)
[sEvtBsConnectState](#sevtbsconnectstate)| ||基站自检(内)|[startBsSelfCheck](#startbsselfcheck)|[sEvtStateCode](#sevtstatecode)
[fEvtBsSelfCheck](#fevtbsselfcheck)| |基站升级|开启基站升级(内)|[startBsUpdate](#startbsupdate)|[sEvtStateCode](#sevtstatecode)
[fEvtBsUpateState](#fevtbsupatestate)
[fEvtBsUpdateProgress](#fevtbsupdateprogress)| -||下载字库(内)|[downloadFontLib](#downloadfontlib)|[sEvtStateCode](#sevtstatecode)
[fEvtBsFontLibState](#fevtbsfontlibstate)
[fEvtBsFontLibProgress](#fevtbsfontlibprogress)| +||下载字库(内)|[downloadFontLib](#downloadfontlib)|[sEvtStateCode](#sevtstatecode)
[fEvtBsFontLibState](#fevtbsfontlibstate)
[fEvtBsFontLibProgress](#fevtbsfontlibprogress)| ### 键盘管理 |功能归类|功能|API指令|指令事件| |---|---|---|---| +|交互设置 - 用户内置状态语|设置用户内置状态语|[setKpUserStbMsg](#setkpuserstbmsg)|[fEvtKpUserStbMsg](#fevtkpuserstbmsg)| +|交互设置 - 用户实时提示反馈信息|实时设置提示反馈信息|[rtSetKpUserPrompt](#rtsetkpuserprompt)|[sEvtStateCode](#sevtstatecode)
[fEvtSetKpUserPrompt](#fevtsetkpuserprompt)| |识别设置 - 出厂编码(内)|设置键盘出厂编码(内)|[setKpSN](#setkpsn)|[fEvtSetKpSN](#fevtsetkpsn)
| |识别设置 - 键盘编号(内)|设置键盘编号(内)|[setKpID](#setkpid)|[fEvtSetKpID](#fevtsetkpid)| |识别设置 - 键盘信息(内)|开始获取键盘信息(内)|[startGetKpInfo](#setkpid)|[sEvtStateCode](#sevtstatecode)
[fEvtKpInfo](#fevtkpinfo)| -||停止获取键盘信息(内)|[stopGetKpInfo](#setkpid)|[sEvtStateCode](#sevtstatecode)| -|交互设置 - 用户内置状态语|设置用户内置状态语|[setKpUserStbMsg](#setkpuserstbmsg)|[fEvtKpUserStbMsg](#fevtkpuserstbmsg)| -|交互设置 - 用户实时提示反馈信息|实时设置提示反馈信息|[rtSetKpUserPrompt](#rtsetkpuserprompt)|[sEvtStateCode](#sevtstatecode)
[fEvtSetKpUserPrompt](#fevtsetkpuserprompt)| +||停止获取键盘信息(内)|[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)| +||停止键盘无线升级(内)|[stopKpFWUpdate](#stopkpfwupdate)|[sEvtStateCode](#sevtstatecode)
[fEvtKpFWUpdateState](#fevtkpfwupdatestate)| ### 绑定 |功能归类|功能|API指令|指令事件| |---|---|---|---| @@ -290,8 +294,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)| @@ -868,6 +872,8 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 ### 识别设置 #### 方法 + + ##### setBsSN - **主题**：/manage/{baseSN}/send - **功能描述**：设置基站的SN，需预先订阅新SN的主题,以获取事件返回 @@ -894,6 +900,8 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 } } ``` + + ##### getBsModel - **主题**：/client/{baseSN}/send - **功能描述**：获取基站型号 @@ -932,6 +940,9 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 "baseSn":"2024061101" } ``` + + + ##### getBsBIC - **主题**：/manage/{baseSN}/send - **功能描述**：获取基站品牌识别码 @@ -977,6 +988,8 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 } } ``` + + #### 事件 ##### fEvtBsSN - **主题**: /basestation/{baseSN}/receive @@ -1050,6 +1063,8 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 } } ``` + + ##### fEvtBsBIC - **主题**: /manage/{baseSN}/receive - **功能描述**：返回基站的品牌码 @@ -1074,6 +1089,8 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 } } ``` + + ### 组网设置 #### 方法 ##### getBsNetworkMode @@ -1095,6 +1112,8 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 "baseSn":"2024061101", } ``` + + ##### setBsNetworkMode - **主题**：/client/{baseSN}/send - **功能描述**：设置基站组网模式 @@ -1119,6 +1138,8 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 } } ``` + + ##### getBsPairCode - **主题**：/client/{baseSN}/send - **功能描述**：获取基站配对码 @@ -1138,6 +1159,8 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 "baseSn":"2024061101" } ``` + + ##### setBsPairCode - **主题**：/manage/{baseSN}/send - **功能描述**：设置基站配对码 @@ -1164,6 +1187,8 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 } } ``` + + ##### getBsNfcLogin - **主题**：/client/{baseSN}/send - **功能描述**：获取刷卡配对状态 @@ -1798,6 +1823,7 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 } } ``` + ##### getBsKpSleepLevel - **主题**：/manage/{baseSN}/send @@ -1888,6 +1914,7 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 "baseSn":"2024061101" } ``` + #### 事件 ##### fEvtBsKpLanguage @@ -1987,6 +2014,7 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 } } ``` + ##### fEvtBsKpSleepLevel - **主题**: /manage/{baseSN}/receive @@ -2037,6 +2065,7 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 } } ``` + ### 配对模式 #### 方法 @@ -2553,6 +2582,8 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 } } ``` + + ### 基站维护 #### 方法 ##### getBsLogInfo @@ -2906,8 +2937,12 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 } } ``` + ## 键盘管理 + + + ### 识别设置 #### 方法 ##### setKpSN @@ -3093,6 +3128,7 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 } } ``` + ### 交互设置 #### 方法 @@ -3322,7 +3358,7 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 |+keySn|string||是|键盘SN| |+version|string||是|键盘固件版本| |+model|int||是|键盘型号| -|+voltage|double||是|键盘电量（待键盘修改成百分比）| +|+voltage|double||是|键盘电量（待键盘修改成百分比）| - **示例代码** ```json @@ -3365,6 +3401,8 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 } } ``` + + ##### startKpFWUpdate - **主题**：/manage/{baseSN}/send - **功能描述**:键盘升级 @@ -3377,7 +3415,7 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 |baseSn|string||是|基站的出厂编码| |data|object|-|是|传送参数的对象| |+partition|int||是|存储区域
1-备份区
2-更新区| -|+url|string||是|待升级的固件地址，可访问的网络url
直连基站可为本地的文件路径| +|+url|string||是|待升级的固件地址，可访问的网络url
直连基站为本地的文件路径| |+version|string||是|待升级的固件版本号| |+crc|uint||是|固件CRC校验码,10进制数字|