diff --git a/通讯协议-B200W-MQTT协议[内部].md b/通讯协议-B200W-MQTT协议[内部].md index ee713a8..220869d 100644 --- a/通讯协议-B200W-MQTT协议[内部].md +++ b/通讯协议-B200W-MQTT协议[内部].md @@ -14,6 +14,7 @@ } +[TOC]


@@ -26,7 +27,7 @@ SunVote B200W
MQTT通讯协议

-Ver 1.0.1 +Ver 1.0.2


@@ -42,7 +43,7 @@ Ver 1.0.1
-二〇二四年十月 +二〇二四年十二月

@@ -61,33 +62,32 @@ Ver 1.0.1 | 文档版本 | 日期 | 作者 | 版本说明 | |---|---|---|---| |1.0.1| 2024年10月22日|刘琴|1. 初始版| +|1.0.2| 2024年12月27日|刘琴|1. 增加测验题中自判题题型
2. 多科测验的科目数量为从9增加至11
3. 增加测验自定义题型标题下发和清除
4. 增加自定义tag,可自定义最长128位的数据包标签
注:(基站版本需高于0.0.10)|

-[TOC] - # SunVote B200W 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 ## 指令说明 |指令功能标识 |说明 |约束| @@ -112,6 +112,7 @@ Ver 1.0.1 { "fun":"xxx", "dataTag":"xxx", + "tag":"", //此字段非必需 "data":{ //内容 } @@ -121,7 +122,8 @@ Ver 1.0.1 |参数 |说明 |约束| |---|---|---| |fun| 指令或事件名称|| -|dataTag| 数据标签,用于对应收发数据|长度不超过4,可为0-9a-zA-Z的组合| +|dataTag| 数据标签,用于对应收发数据|长度不超过4个字符,可为字母数字的组合,区分大小写| +|tag| 自定义标签|长度不超过128个字符,可以为字母数字下划线"_"的组合,区分大小写,非必填,可不传本字段| |data| 数据内容|对象或者数组,可为空| 注意:基站接收指令数据单次不超过2K长度,在指定键盘发送指令时,如果指令长度超出限制,建议将指令进行拆分,分次发送,如果是所有键盘执行的指令,可将keySns设为空数组不使用指定键盘的模式 @@ -255,10 +257,12 @@ Ver 1.0.1 ||停止标准测验|[stopKpVote](#stopkpvote)|[sEvtStateCode](#sevtstatecode)| |自主录分|启动自主录分|[startKpScoreInput](#startkpscoreinput)|[sEvtStateCode](#sevtstatecode)
[fEvtKpScore](#fevtkpscore)
[fEvtFinalSubmit](#fevtfinalsubmit)| ||停止自主录分|[stopKpVote](#stopkpvote)|[sEvtStateCode](#sevtstatecode)| +|自定义测验题型标题|自定义测验题型标题内容|[setKpExamQuesTitle](#setKpexamquestitle)|[sEvtStateCode](#sevtstatecode)
[fEvtKpExamQuesTitle](#fevtkpexamquestitle)| +||清除自定义测验题型标题内容|[clearKpExamQuesTitle](#clearkpexamquestitle)|[sEvtStateCode](#sevtstatecode)
[fEvtClearKpExamQuesTitle](#fevtclearkpexamquestitle)| ## 公共方法 ### stopKpVote -- **主题**: /client/\${baseSN}/send +- **主题**: /client/{baseSN}/send - **功能描述**:通用停止键盘答题方法,可以停止如同步签到、按键反馈、在线测验中调用startXXX方法启动的业务 - **参数说明** @@ -277,7 +281,7 @@ Ver 1.0.1 ## 公共事件 ### sEvtBsConnectState -- **主题**: /basestation/\${baseSN}/receive +- **主题**: /basestation/{baseSN}/receive - **功能描述**:基站连接成功时返回基站型号和基站SN,基站从已连接状态断开返回连接断开 - **参数说明** @@ -314,7 +318,7 @@ Ver 1.0.1 } ``` ### sEvtBsChannelConflict -- **主题**: /basestation/\${baseSN}/receive +- **主题**: /basestation/{baseSN}/receive - **功能描述**:基站信道冲突时主动上报,应用程序可根据实际业务修改基站信道 - **参数说明** @@ -336,7 +340,7 @@ Ver 1.0.1 } ``` ### sEvtBsNfcResults -- **主题**: /basestation/\${baseSN}/receive +- **主题**: /basestation/{baseSN}/receive - **功能描述**:键盘刷卡时主动上报,如果超出基站容量会上报失败 - **参数说明** @@ -363,7 +367,7 @@ Ver 1.0.1 ``` ### sEvtBsKpOnlineMsg -- **主题**: /basestation/\${baseSN}/receive +- **主题**: /basestation/{baseSN}/receive - **功能描述**:键盘上线通知,主动上报,键盘升级成功后也会上报 - **参数说明** @@ -389,7 +393,7 @@ Ver 1.0.1 } ``` ### sEvtKpRtFeedback -- **主题**: /basestation/\${baseSN}/receive +- **主题**: /basestation/{baseSN}/receive - **功能描述**:开启键盘实时反馈后,键盘按键时上报 - **参数说明** @@ -417,7 +421,7 @@ Ver 1.0.1 } ``` ### sEvtKpHandUp -- **主题**: /basestation/\${baseSN}/receive +- **主题**: /basestation/{baseSN}/receive - **功能描述**:开启键盘举手功能后,键盘按举手键时上报 - **参数说明** @@ -439,7 +443,7 @@ Ver 1.0.1 } ``` ### sEvtStateCode -- **主题**: /basestation/\${baseSN}/receive +- **主题**: /basestation/{baseSN}/receive - **功能描述**:返回基站接收指令状态信息 - **参数说明** @@ -505,7 +509,7 @@ Ver 1.0.1 ``` ##### getBsConnectState -- **主题**:/client/\${baseSN}/send +- **主题**:/client/{baseSN}/send - **功能描述**:主动获取基站连接状态 - **参数说明** @@ -553,10 +557,11 @@ Ver 1.0.1 } } ``` + ### 基站授时 #### 方法 ##### timeSync -- **主题**:/client/\${baseSN}/send +- **主题**:/client/{baseSN}/send - **功能描述**:发送当前时间戳给基站进行校时 - **参数说明** @@ -584,7 +589,7 @@ Ver 1.0.1 ### 识别设置 #### 方法 ##### setBsSN -- **主题**:/manage/\${baseSN}/send +- **主题**:/manage/{baseSN}/send - **功能描述**:设置基站的SN,需预先订阅新SN的主题,以获取事件返回 - **参数说明** @@ -608,7 +613,7 @@ Ver 1.0.1 } ``` ##### getBsModel -- **主题**:/client/\${baseSN}/send +- **主题**:/client/{baseSN}/send - **功能描述**:获取基站型号 - **参数说明** @@ -625,7 +630,7 @@ Ver 1.0.1 } ``` ##### getBsFWVersion -- **主题**:/client/\${baseSN}/send +- **主题**:/client/{baseSN}/send - **功能描述**:获取基站固件版本 - **参数说明** @@ -642,7 +647,7 @@ Ver 1.0.1 } ``` ##### getBsBIC -- **主题**:/manage/\${baseSN}/send +- **主题**:/manage/{baseSN}/send - **功能描述**:获取基站品牌识别码 - **参数说明** @@ -659,7 +664,7 @@ Ver 1.0.1 } ``` ##### setBsBIC -- **主题**:/manage/\${baseSN}/send +- **主题**:/manage/{baseSN}/send - **功能描述**:设置基站品牌识别码 - **参数说明** @@ -684,7 +689,7 @@ Ver 1.0.1 ``` #### 事件 ##### fEvtBsSN -- **主题**: /basestation/\${baseSN}/receive +- **主题**: /basestation/{baseSN}/receive - **功能描述**:返回基站的出厂编码 - **参数说明** @@ -706,7 +711,7 @@ Ver 1.0.1 } ``` ##### fEvtBsModel -- **主题**: /basestation/\${baseSN}/receive +- **主题**: /basestation/{baseSN}/receive - **功能描述**:返回基站的型号 - **参数说明** @@ -728,7 +733,7 @@ Ver 1.0.1 } ``` ##### fEvtBsFWVersion -- **主题**: /basestation/\${baseSN}/receive +- **主题**: /basestation/{baseSN}/receive - **功能描述**:返回基站的固件版本 - **参数说明** @@ -750,7 +755,7 @@ Ver 1.0.1 } ``` ##### fEvtBsBIC -- **主题**: /manage/\${baseSN}/receive +- **主题**: /manage/{baseSN}/receive - **功能描述**:返回基站的品牌码 - **参数说明** @@ -774,7 +779,7 @@ Ver 1.0.1 ### 组网设置 #### 方法 ##### getBsNetworkMode -- **主题**:/client/\${baseSN}/send +- **主题**:/client/{baseSN}/send - **功能描述**:获取基站组网模式 - **参数说明** @@ -791,7 +796,7 @@ Ver 1.0.1 } ``` ##### setBsNetworkMode -- **主题**:/client/\${baseSN}/send +- **主题**:/client/{baseSN}/send - **功能描述**:设置基站组网模式 - **参数说明** @@ -813,7 +818,7 @@ Ver 1.0.1 } ``` ##### getBsPairCode -- **主题**:/client/\${baseSN}/send +- **主题**:/client/{baseSN}/send - **功能描述**:获取基站配对码 - **参数说明** @@ -830,7 +835,7 @@ Ver 1.0.1 } ``` ##### setBsPairCode -- **主题**:/manage/\${baseSN}/send +- **主题**:/manage/{baseSN}/send - **功能描述**:设置基站配对码 - **参数说明** @@ -854,7 +859,7 @@ Ver 1.0.1 } ``` ##### getBsNfcLogin -- **主题**:/client/\${baseSN}/send +- **主题**:/client/{baseSN}/send - **功能描述**:获取刷卡配对状态 - **参数说明** @@ -871,7 +876,7 @@ Ver 1.0.1 } ``` ##### setBsNfcLogin -- **主题**:/client/\${baseSN}/send +- **主题**:/client/{baseSN}/send - **功能描述**:设置基站刷卡配对状态 - **参数说明** @@ -893,7 +898,7 @@ Ver 1.0.1 } ``` ##### getBsChannel -- **主题**:/client/\${baseSN}/send +- **主题**:/client/{baseSN}/send - **功能描述**:获取基站信道 - **参数说明** @@ -910,7 +915,7 @@ Ver 1.0.1 } ``` ##### setBsChannel -- **主题**:/client/\${baseSN}/send +- **主题**:/client/{baseSN}/send - **功能描述**:设置基站信道 - **参数说明** @@ -933,7 +938,7 @@ Ver 1.0.1 ``` ##### getBsRFIChannel -- **主题**:/client/\${baseSN}/send +- **主题**:/client/{baseSN}/send - **功能描述**:获取已被其他基站占用的信道 - **参数说明** @@ -952,7 +957,7 @@ Ver 1.0.1 #### 事件 ##### fEvtBsNetworkMode -- **主题**: /basestation/\${baseSN}/receive +- **主题**: /basestation/{baseSN}/receive - **功能描述**:返回基站组网模式 - **参数说明** @@ -974,7 +979,7 @@ Ver 1.0.1 } ``` ##### fEvtBsPairCode -- **主题**: /basestation/\${baseSN}/receive +- **主题**: /basestation/{baseSN}/receive - **功能描述**:返回基站配对码 - **参数说明** @@ -997,7 +1002,7 @@ Ver 1.0.1 ``` ##### fEvtBsChannel -- **主题**: /basestation/\${baseSN}/receive +- **主题**: /basestation/{baseSN}/receive - **功能描述**:返回基站信道 - **参数说明** @@ -1020,7 +1025,7 @@ Ver 1.0.1 ``` ##### fEvtBsRFIChannel -- **主题**: /basestation/\${baseSN}/receive +- **主题**: /basestation/{baseSN}/receive - **功能描述**:返回其他基站已占用的信道,频点冲突时,可以根据返回结果修改基站信道避开干扰 - **参数说明** @@ -1052,7 +1057,7 @@ Ver 1.0.1 ``` ##### fEvtBsNfcLogin -- **主题**: /basestation/\${baseSN}/receive +- **主题**: /basestation/{baseSN}/receive - **功能描述**:返回基站是否允许NFC刷卡 - **参数说明** @@ -1077,7 +1082,7 @@ Ver 1.0.1 #### 方法 ##### getBsSSID 获取基站登录名称 -- **主题**:/client/\${baseSN}/send +- **主题**:/client/{baseSN}/send - **功能描述**:获取基站登录名称 - **参数说明** @@ -1094,7 +1099,7 @@ Ver 1.0.1 } ``` ##### setBsSSID -- **主题**:/client/\${baseSN}/send +- **主题**:/client/{baseSN}/send - **功能描述**:设置基站登录名称 - **参数说明** @@ -1116,7 +1121,7 @@ Ver 1.0.1 } ``` ##### getBsLoginPwd -- **主题**:/client/\${baseSN}/send +- **主题**:/client/{baseSN}/send - **功能描述**:获取基站登录密码 - **参数说明** @@ -1133,7 +1138,7 @@ Ver 1.0.1 } ``` ##### setBsLoginPwd -- **主题**:/client/\${baseSN}/send +- **主题**:/client/{baseSN}/send - **功能描述**:设置基站登录密码 - **参数说明** @@ -1156,7 +1161,7 @@ Ver 1.0.1 ``` ##### getBsLoginState 获取基站登录名称 -- **主题**:/client/\${baseSN}/send +- **主题**:/client/{baseSN}/send - **功能描述**:获取基站登录状态 - **参数说明** @@ -1173,7 +1178,7 @@ Ver 1.0.1 } ``` ##### setBsLoginState -- **主题**:/client/\${baseSN}/send +- **主题**:/client/{baseSN}/send - **功能描述**:设置基站登录状态 - **参数说明** @@ -1197,7 +1202,7 @@ Ver 1.0.1 #### 事件 ##### fEvtBsSSID -- **主题**: /basestation/\${baseSN}/receive +- **主题**: /basestation/{baseSN}/receive - **功能描述**:返回基站名称 - **参数说明** @@ -1219,7 +1224,7 @@ Ver 1.0.1 } ``` ##### fEvtBsLoginPwd -- **主题**: /basestation/\${baseSN}/receive +- **主题**: /basestation/{baseSN}/receive - **功能描述**:返回基站登录密码 - **参数说明** @@ -1250,7 +1255,7 @@ Ver 1.0.1 } ``` ##### fEvtBsLoginState -- **主题**: /basestation/\${baseSN}/receive +- **主题**: /basestation/{baseSN}/receive - **功能描述**:返回基站登录状态 - **参数说明** @@ -1274,7 +1279,7 @@ Ver 1.0.1 ### 键盘统一设置 #### 方法 ##### getBsKpLanguage -- **主题**:/client/\${baseSN}/send +- **主题**:/client/{baseSN}/send - **功能描述**:获取键盘语言 - **参数说明** @@ -1291,7 +1296,7 @@ Ver 1.0.1 } ``` ##### setBsKpLanguage -- **主题**:/client/\${baseSN}/send +- **主题**:/client/{baseSN}/send - **功能描述**:设置键盘语言 - **参数说明** @@ -1313,7 +1318,7 @@ Ver 1.0.1 } ``` ##### getBsKpStbMsgMode -- **主题**:/client/\${baseSN}/send +- **主题**:/client/{baseSN}/send - **功能描述**:获取状态语设置状态 - **参数说明** @@ -1330,7 +1335,7 @@ Ver 1.0.1 } ``` ##### setBsKpStbMsgMode -- **主题**:/client/\${baseSN}/send +- **主题**:/client/{baseSN}/send - **功能描述**:设置状态语工作状态 - **参数说明** @@ -1352,7 +1357,7 @@ Ver 1.0.1 } ``` ##### getBsKpLoginMenu -- **主题**:/client/\${baseSN}/send +- **主题**:/client/{baseSN}/send - **功能描述**:获取键盘登录菜单显示状态 - **参数说明** @@ -1370,7 +1375,7 @@ Ver 1.0.1 ``` ##### setBsKpLoginMenu -- **主题**:/client/\${baseSN}/send +- **主题**:/client/{baseSN}/send - **功能描述**:设置键盘登录菜单显示状态 - **参数说明** @@ -1392,7 +1397,7 @@ Ver 1.0.1 } ``` ##### getBsKpSleepLevel -- **主题**:/manage/\${baseSN}/send +- **主题**:/manage/{baseSN}/send - **功能描述**:获取键盘休眠时间等级 - **参数说明** @@ -1410,7 +1415,7 @@ Ver 1.0.1 ``` ##### setBsKpSleepLevel -- **主题**:/manage/\${baseSN}/send +- **主题**:/manage/{baseSN}/send - **功能描述**:设置键盘休眠时间等级 - **参数说明** @@ -1433,7 +1438,7 @@ Ver 1.0.1 ``` ##### setBsKpPauseSleep -- **主题**:/manage/\${baseSN}/send +- **主题**:/manage/{baseSN}/send - **功能描述**:设置键盘暂停休眠是否开启
注意:请谨慎使用本功能,务必在相关测试或功能完成后关闭,否则可能会导致键盘异常耗电
设置单次生效,基站拔插后复位成关闭状态
- **参数说明** @@ -1456,7 +1461,7 @@ Ver 1.0.1 ``` ##### getBsKpPauseSleep -- **主题**:/manage/\${baseSN}/send +- **主题**:/manage/{baseSN}/send - **功能描述**:获取键盘暂停休眠是否开启 - **参数说明** @@ -1475,7 +1480,7 @@ Ver 1.0.1 #### 事件 ##### fEvtBsKpLanguage -- **主题**: /basestation/\${baseSN}/receive +- **主题**: /basestation/{baseSN}/receive - **功能描述**:返回键盘语言 - **参数说明** @@ -1497,7 +1502,7 @@ Ver 1.0.1 } ``` ##### fEvtBsKpStbMsgMode -- **主题**: /basestation/\${baseSN}/receive +- **主题**: /basestation/{baseSN}/receive - **功能描述**:返回状态语工作状态 - **参数说明** @@ -1519,7 +1524,7 @@ Ver 1.0.1 } ``` ##### fEvtBsKpLoginMenu -- **主题**: /basestation/\${baseSN}/receive +- **主题**: /basestation/{baseSN}/receive - **功能描述**:返回键盘登录菜单显示状态 - **参数说明** @@ -1541,7 +1546,7 @@ Ver 1.0.1 } ``` ##### fEvtBsKpSleepLevel -- **主题**: /manage/\${baseSN}/receive +- **主题**: /manage/{baseSN}/receive - **功能描述**:返回键盘休眠时间等级 - **参数说明** @@ -1564,7 +1569,7 @@ Ver 1.0.1 ``` ##### fEvtBsKpPauseSleep -- **主题**: /manage/\${baseSN}/receive +- **主题**: /manage/{baseSN}/receive - **功能描述**:返回暂停键盘休眠开启状态 - **参数说明** @@ -1589,7 +1594,7 @@ Ver 1.0.1 ### 配对模式 #### 方法 ##### startBsFastPair -- **主题**:/client/\${baseSN}/send +- **主题**:/client/{baseSN}/send - **功能描述**:启动快速配对,键盘配对成功返回键盘信息 [sEvtBsKpOnlineMsg](#sevtbskponlinemsg) - **参数说明** @@ -1606,7 +1611,7 @@ Ver 1.0.1 } ``` ##### stopBsFastPair -- **主题**:/client/\${baseSN}/send +- **主题**:/client/{baseSN}/send - **功能描述**:停止快速配对 - **参数说明** @@ -1632,7 +1637,7 @@ Ver 1.0.1 ### 白名单模式 #### 方法 ##### getBsWhitelist -- **主题**:/client/\${baseSN}/send +- **主题**:/client/{baseSN}/send - **功能描述**:获取基站白名单列表 - **参数说明** @@ -1649,7 +1654,7 @@ Ver 1.0.1 } ``` ##### setBsWhitelist -- **主题**:/client/\${baseSN}/send +- **主题**:/client/{baseSN}/send - **功能描述**:设置基站白名单列表,将基站白名单替换为写入的键盘SN列表 - **参数说明** @@ -1671,7 +1676,7 @@ Ver 1.0.1 } ``` ##### clearBsWhitelist -- **主题**:/client/\${baseSN}/send +- **主题**:/client/{baseSN}/send - **功能描述**:清空基站白名单列表 - **参数说明** @@ -1688,7 +1693,7 @@ Ver 1.0.1 } ``` ##### addBsWhitelist -- **主题**:/client/\${baseSN}/send +- **主题**:/client/{baseSN}/send - **功能描述**:添加键盘至基站白名单列表 - **参数说明** @@ -1710,7 +1715,7 @@ Ver 1.0.1 } ``` ##### delBsWhitelist -- **主题**:/client/\${baseSN}/send +- **主题**:/client/{baseSN}/send - **功能描述**:从基站白名单列表中删除键盘 - **参数说明** @@ -1736,7 +1741,7 @@ Ver 1.0.1 发送指令后返回此事件 ##### fEvtBsWhitelist -- **主题**:/basestation/\${baseSN}/receive +- **主题**:/basestation/{baseSN}/receive - **功能描述**:返回基站白名单列表 - **参数说明** @@ -1759,7 +1764,7 @@ Ver 1.0.1 ``` ##### fEvtSetBsWhitelist -- **主题**:/basestation/\${baseSN}/receive +- **主题**:/basestation/{baseSN}/receive - **功能描述**:返回设置白名单状态 - **参数说明** @@ -1787,7 +1792,7 @@ Ver 1.0.1 ``` ##### fEvtAddBsWhitelist -- **主题**:/basestation/\${baseSN}/receive +- **主题**:/basestation/{baseSN}/receive - **功能描述**:返回增加键盘状态 - **参数说明** @@ -1815,7 +1820,7 @@ Ver 1.0.1 ``` ##### fEvtDelBsWhitelist -- **主题**:/basestation/\${baseSN}/receive +- **主题**:/basestation/{baseSN}/receive - **功能描述**:返回删除键盘状态 - **参数说明** @@ -1845,7 +1850,7 @@ Ver 1.0.1 ### 网络参数设置 #### 方法 ##### getBsTcpipParams -- **主题**:/client/\${baseSN}/send +- **主题**:/client/{baseSN}/send - **功能描述**:获取基站TCP/IP参数 - **参数说明** @@ -1862,7 +1867,7 @@ Ver 1.0.1 } ``` ##### setBsTcpipParams -- **主题**:/client/\${baseSN}/send +- **主题**:/client/{baseSN}/send - **功能描述**:设置基站TCP/IP参数 - **参数说明** @@ -1890,7 +1895,7 @@ Ver 1.0.1 } ``` ##### getBsMqttParams -- **主题**:/client/\${baseSN}/send +- **主题**:/client/{baseSN}/send - **功能描述**:获取基站MQTT参数 - **参数说明** @@ -1907,7 +1912,7 @@ Ver 1.0.1 } ``` ##### setBsMqttParams -- **主题**:/client/\${baseSN}/send +- **主题**:/client/{baseSN}/send - **功能描述**:设置基站MQTT参数 - **参数说明** @@ -1938,7 +1943,7 @@ Ver 1.0.1 ``` #### 事件 ##### fEvtBsTcpipParams -- **主题**: /basestation/\${baseSN}/receive +- **主题**: /basestation/{baseSN}/receive - **功能描述**:返回基站TCP/IP参数 - **参数说明** @@ -1968,7 +1973,7 @@ Ver 1.0.1 } ``` ##### fEvtBsMqttParams -- **主题**: /basestation/\${baseSN}/receive +- **主题**: /basestation/{baseSN}/receive - **功能描述**:返回基站MQTT参数 - **参数说明** @@ -2000,7 +2005,7 @@ Ver 1.0.1 ### 基站加密 #### 方法 ##### getBsSoftwareKey -- **主题**:/client/\${baseSN}/send +- **主题**:/client/{baseSN}/send - **功能描述**:获取基站软件狗密钥 - **参数说明** @@ -2017,7 +2022,7 @@ Ver 1.0.1 } ``` ##### setBsSoftwareKey -- **主题**:/client/\${baseSN}/send +- **主题**:/client/{baseSN}/send - **功能描述**:设置基站软件狗密钥 - **参数说明** @@ -2040,7 +2045,7 @@ Ver 1.0.1 ``` #### 事件 ##### fEvtBsSoftwareKey -- **主题**:/basestation/\${baseSN}/receive +- **主题**:/basestation/{baseSN}/receive - **功能描述**:返回基站的软件狗密钥 - **参数说明** @@ -2064,7 +2069,7 @@ Ver 1.0.1 ### 基站维护 #### 方法 ##### getBsLogInfo -- **主题**:/manage/\${baseSN}/send +- **主题**:/manage/{baseSN}/send - **功能描述**:获取基站日志,用于出现故障需要排查问题时获取基站内部日志记录 - **参数说明** @@ -2082,7 +2087,7 @@ Ver 1.0.1 ``` ##### clearBsLogInfo -- **主题**:/manage/\${baseSN}/send +- **主题**:/manage/{baseSN}/send - **功能描述**:清空基站内部日志记录 - **参数说明** @@ -2100,7 +2105,7 @@ Ver 1.0.1 ``` ##### resetBsSystem -- **主题**:/client/\${baseSN}/send +- **主题**:/client/{baseSN}/send - **功能描述**:软复位基站(公共主题可用,但不体现在外部版本协议中) - **参数说明** @@ -2118,7 +2123,7 @@ Ver 1.0.1 ``` ##### resetBsPower -- **主题**:/client/\${baseSN}/send +- **主题**:/client/{baseSN}/send - **功能描述**:断电复位基站(公共主题可用,但不体现在外部版本协议中) - **参数说明** @@ -2136,7 +2141,7 @@ Ver 1.0.1 ``` ##### startBsSelfCheck -- **主题**:/manage/\${baseSN}/send +- **主题**:/manage/{baseSN}/send - **功能描述**:开始基站自检,基站自检状态中不接收其他指令,空闲状态中才进入自检 - **参数说明** @@ -2156,13 +2161,13 @@ Ver 1.0.1 #### 事件 ##### [sEvtStateCode](#sevtstatecode) 返回指令的接收状态 -注意:内部指令的接收状态需从**主题: /manage/\${baseSN}/receive** 返回 +注意:内部指令的接收状态需从**主题: /manage/{baseSN}/receive** 返回 ##### [sEvtBsConnectState](#sevtbsconnectstate) 复位基站后,基站重新连接成功后上报 ##### fEvtBsLogInfo -- **主题**: /manage/\${baseSN}/receive +- **主题**: /manage/{baseSN}/receive - **功能描述**:返回基站存储的日志内容 - **参数说明** @@ -2187,7 +2192,7 @@ Ver 1.0.1 ``` ##### fEvtBsSelfCheck -- **主题**: /manage/\${baseSN}/receive +- **主题**: /manage/{baseSN}/receive - **功能描述**:返回基站自检的结果 - **参数说明** @@ -2228,7 +2233,7 @@ Ver 1.0.1 ### 基站升级 #### 方法 ##### startBsUpdate -- **主题**:/manage/\${baseSN}/send +- **主题**:/manage/{baseSN}/send - **功能描述**:基站固件升级 - **参数说明** @@ -2237,7 +2242,7 @@ Ver 1.0.1 |fun|string|-|是|指令名称| |dataTag|string|-|否|数据包标识,可为空字符串| |data|object|-|是|传送参数的对象| -|+partition|int||是|存储区域
1-备份区 使用备份区固件的方法:打开基站盖子,按住SW1按钮,然后上电,这时基站固件就会更新成备份区的固件
2-更新区,实时升级基站固件| +|+partition|int||是|存储区域
1-备份区 使用备份区固件的方法:打开基站盖子,按住SW1按钮,上电后松开按钮,这时基站固件就会更新成备份区的固件
2-更新区,实时升级基站固件| |+url|string||是|待升级的固件地址,可访问的网络url| |+version|string||是|待升级的基站固件版本| |+crc|uint||是|固件CRC校验码,10进制数字| @@ -2258,7 +2263,7 @@ Ver 1.0.1 } ``` ##### downloadFontLib -- **主题**:/manage/\${baseSN}/send +- **主题**:/manage/{baseSN}/send - **功能描述**:下载更新基站字库文件 - **参数说明** @@ -2291,10 +2296,10 @@ Ver 1.0.1 #### 事件 ##### [sEvtStateCode](#sevtstatecode) 返回升级指令的接收状态 -注意:升级指令的接收状态需从**主题: /manage/\${baseSN}/receive** 返回 +注意:升级指令的接收状态需从**主题: /manage/{baseSN}/receive** 返回 ##### fEvtBsUpateState -- **主题**: /manage/\${baseSN}/receive +- **主题**: /manage/{baseSN}/receive - **功能描述**:返回基站启动升级状态 - **参数说明** @@ -2319,7 +2324,7 @@ Ver 1.0.1 ``` ##### fEvtBsUpdateProgress -- **主题**: /manage/\${baseSN}/receive +- **主题**: /manage/{baseSN}/receive - **功能描述**:返回基站升级进度 - **参数说明** @@ -2342,7 +2347,7 @@ Ver 1.0.1 ``` ##### fEvtBsFontLibState -- **主题**: /manage/\${baseSN}/receive +- **主题**: /manage/{baseSN}/receive - **功能描述**:返回基站下载字库状态 - **参数说明** @@ -2367,7 +2372,7 @@ Ver 1.0.1 ``` ##### fEvtBsFontLibProgress -- **主题**: /manage/\${baseSN}/receive +- **主题**: /manage/{baseSN}/receive - **功能描述**:返回基站下载字库进度 - **参数说明** @@ -2393,7 +2398,7 @@ Ver 1.0.1 ### 识别设置 #### 方法 ##### setKpSN -- **主题**:/manage/\${baseSN}/send +- **主题**:/manage/{baseSN}/send - **功能描述**:设置指定键盘的出厂编码 - **参数说明** @@ -2420,7 +2425,7 @@ Ver 1.0.1 ``` ##### setKpID -- **主题**:/manage/\${baseSN}/send +- **主题**:/manage/{baseSN}/send - **功能描述**:设置键盘编号 - **参数说明** @@ -2444,7 +2449,7 @@ Ver 1.0.1 ``` ##### startGetKpInfo -- **主题**:/manage/\${baseSN}/send +- **主题**:/manage/{baseSN}/send - **功能描述**:开始获取键盘信息 - **参数说明** @@ -2463,7 +2468,7 @@ Ver 1.0.1 ``` ##### stopGetKpInfo -- **主题**:/manage/\${baseSN}/send +- **主题**:/manage/{baseSN}/send - **功能描述**:停止获取键盘信息 - **参数说明** @@ -2486,7 +2491,7 @@ Ver 1.0.1 发送指令后返回接收状态 ##### fEvtSetKpSN -- **主题**:/manage/\${baseSN}/receive +- **主题**:/manage/{baseSN}/receive - **功能描述**:返回写键盘SN状态 - **参数说明** @@ -2510,7 +2515,7 @@ Ver 1.0.1 } ``` ##### fEvtSetKpID -- **主题**:/manage/\${baseSN}/receive +- **主题**:/manage/{baseSN}/receive - **功能描述**:返回键盘编号 - **参数说明** @@ -2534,7 +2539,7 @@ Ver 1.0.1 } ``` ##### fEvtKpInfo -- **主题**:/manage/\${baseSN}/receive +- **主题**:/manage/{baseSN}/receive - **功能描述**:返回键盘信息 - **参数说明** @@ -2565,7 +2570,7 @@ Ver 1.0.1 ### 交互设置 #### 方法 ##### setKpUserStbMsg -- **主题**:/client/\${baseSN}/send +- **主题**:/client/{baseSN}/send - **功能描述**:设置用户内置状态语 - **参数说明** @@ -2593,7 +2598,7 @@ Ver 1.0.1 } ``` ##### rtSetKpUserPrompt -- **主题**:/client/\${baseSN}/send +- **主题**:/client/{baseSN}/send - **功能描述**:实时设置提示反馈信息 - **参数说明** @@ -2606,6 +2611,7 @@ Ver 1.0.1 |++info|string||否|设置的反馈信息
不同键盘可设置不同反馈信息| - **示例代码** + ```json //分别提示 { @@ -2639,7 +2645,7 @@ Ver 1.0.1 发送指令后返回接收状态 ##### fEvtKpUserStbMsg -- **主题**:/basestation/\${baseSN}/receive +- **主题**:/basestation/{baseSN}/receive - **功能描述**:返回设置状态语的状态 - **参数说明** @@ -2661,7 +2667,7 @@ Ver 1.0.1 } ``` ##### fEvtSetKpUserPrompt -- **主题**:/basestation/\${baseSN}/receive +- **主题**:/basestation/{baseSN}/receive - **功能描述**:返回实时设置提示语是否成功 - **参数说明** @@ -2698,7 +2704,7 @@ Ver 1.0.1 ### 在线状态 #### 方法 ##### startGetKpOnline -- **主题**:/client/\${baseSN}/send +- **主题**:/client/{baseSN}/send - **功能描述**:开始获取键盘在线信息,键盘在线返回键盘信息 - **参数说明** @@ -2708,6 +2714,7 @@ Ver 1.0.1 |dataTag|string|-|否|数据包标识,可为空字符串| - **示例代码** + ```json { "fun":"startGetKpOnline", @@ -2716,7 +2723,7 @@ Ver 1.0.1 ``` ##### stopGetKpOnline -- **主题**:/client/\${baseSN}/send +- **主题**:/client/{baseSN}/send - **功能描述**:停止获取键盘在线信息 - **参数说明** @@ -2726,6 +2733,7 @@ Ver 1.0.1 |dataTag|string|-|否|数据包标识,可为空字符串| - **示例代码** + ```json { "fun":"stopGetKpOnline", @@ -2737,7 +2745,7 @@ Ver 1.0.1 发送指令后返回此事件 ##### fEvtKpOnlineMsg -- **主题**: /basestation/\${baseSN}/receive +- **主题**: /basestation/{baseSN}/receive - **功能描述**:主动获取在线键盘时,在线键盘状态报告 - **参数说明** @@ -2768,7 +2776,7 @@ Ver 1.0.1 ### 维护功能 #### 方法 ##### remoteKpSleep -- **主题**:/client/\${baseSN}/send +- **主题**:/client/{baseSN}/send - **功能描述**:遥控键盘休眠 - **参数说明** @@ -2790,7 +2798,7 @@ Ver 1.0.1 } ``` ##### startKpFWUpdate -- **主题**:/manage/\${baseSN}/send +- **主题**:/manage/{baseSN}/send - **功能描述**:键盘升级 - **参数说明** @@ -2820,7 +2828,7 @@ Ver 1.0.1 } ``` ##### stopKpFWUpdate -- **主题**:/manage/\${baseSN}/send +- **主题**:/manage/{baseSN}/send - **功能描述**:停止键盘升级 - **参数说明** @@ -2843,10 +2851,10 @@ Ver 1.0.1 #### 事件 ##### [sEvtStateCode](#sevtstatecode) 返回升级指令的接收状态 -注意:升级指令的接收状态需从**主题: /manage/\${baseSN}/receive** 返回 +注意:升级指令的接收状态需从**主题: /manage/{baseSN}/receive** 返回 ##### fEvtKpFWUpdateState -- **主题**: /manage/\${baseSN}/receive +- **主题**: /manage/{baseSN}/receive - **功能描述**:返回键盘升级状态 - **参数说明** @@ -2870,7 +2878,7 @@ Ver 1.0.1 } ``` ##### fEvtKpUpdateProgress -- **主题**: /manage/\${baseSN}/receive +- **主题**: /manage/{baseSN}/receive - **功能描述**:返回键盘升级进度 - **参数说明** @@ -2895,7 +2903,7 @@ Ver 1.0.1 ### 无线绑定 #### 方法 ##### rtSetKpBindingInfo -- **主题**:/client/\${baseSN}/send +- **主题**:/client/{baseSN}/send - **功能描述**:实时设置绑定信息到键盘 - **参数说明** @@ -2908,6 +2916,7 @@ Ver 1.0.1 |++info|string||是|设置的绑定信息,一般为学生姓名
最长48个字符,显示在键盘左上角| - **示例代码** + ```json { "fun":"rtSetKpBindingInfo", @@ -2926,7 +2935,7 @@ Ver 1.0.1 ``` ##### clearKpBindingInfo -- **主题**:/client/\${baseSN}/send +- **主题**:/client/{baseSN}/send - **功能描述**:清除键盘绑定信息 - **参数说明** @@ -2938,6 +2947,7 @@ Ver 1.0.1 |+keySns|array||否|需要清除绑定信息键盘SN数组,
空数组表示清空所有键盘| - **示例代码** + ```json { "fun":"clearKpBindingInfo", @@ -2952,7 +2962,7 @@ Ver 1.0.1 发送指令后返回接收状态 ##### fEvtKpBindingInfo -- **主题**:/basestation/\${baseSN}/receive +- **主题**:/basestation/{baseSN}/receive - **功能描述**:返回键盘实时设置绑定信息的状态是否成功 - **参数说明** @@ -2965,6 +2975,7 @@ Ver 1.0.1 |++state|string||是|设置的绑定信息是否成功
0 - 成功
1 - 失败| - **示例代码** + ```json { "fun":"fEvtKpBindingInfo", @@ -2982,7 +2993,7 @@ Ver 1.0.1 } ``` ##### fEvtClearKpBindingInfo -- **主题**:/basestation/\${baseSN}/receive +- **主题**:/basestation/{baseSN}/receive - **功能描述**:返回清空绑定信息的指令状态是否成功 - **参数说明** @@ -2994,6 +3005,7 @@ Ver 1.0.1 |+state|string||是|设置的绑定信息是否成功
0 - 成功
1 - 失败| - **示例代码** + ```json { "fun":"fEvtClearKpBindingInfo", @@ -3007,7 +3019,7 @@ Ver 1.0.1 ### 同步签到 #### 方法 ##### startKpSignIn -- **主题**:/client/\${baseSN}/send +- **主题**:/client/{baseSN}/send - **功能描述**:启动同步签到 - **参数说明** @@ -3049,7 +3061,7 @@ Ver 1.0.1 } ```