Commit 86f5a9ef657a8095984c89ab40de88e529b2c42d
1 parent
4def48f9
完善一期全部需要完成功能的协议,修改停止答题为公共的停止答题方法
Showing
1 changed file
with
1120 additions
and
219 deletions
通讯协议-B200W-MQTT协议[内部].md
| ... | ... | @@ -76,6 +76,24 @@ |
| 76 | 76 | |
| 77 | 77 | |
| 78 | 78 | ## 功能速查一览表 |
| 79 | +### 公共方法 | |
| 80 | +可以在多种业务中调用的通用方法 | |
| 81 | +|功能归类|功能|API指令|指令/系统事件| | |
| 82 | +|---|---|---|---| | |
| 83 | +|停止投票|可停止通过调用startXXX启动的答题业务|[stopKpVote](#stopkpvote)|[sEvtStateCode](#sevtstatecode)|| | |
| 84 | + | |
| 85 | +### 公共事件 | |
| 86 | +无需调用指令,自动返回的事件 | |
| 87 | +|功能归类|功能|API指令|指令/系统事件| | |
| 88 | +|---|---|---|---| | |
| 89 | +|公共事件|指令接收状态|-|[sEvtStateCode](#sevtstatecode)| | |
| 90 | +|公共事件|基站连接状态变化|-|[sEvtBsConnectState](#sevtbsconnectstate)| | |
| 91 | +|公共事件|基站信道冲突|-|[sEvtBsChannelConflict](#sevtbschannelconflict)| | |
| 92 | +|公共事件|键盘上线通知|-|[sEvtBsKpOnlineMsg](#sevtbskponlinemsg)| | |
| 93 | +|公共事件|键盘刷卡事件|-|[sEvtBsNfcResults](#sevtbsnfcresults)| | |
| 94 | +|公共事件|键盘待机实时按键反馈|-|[sEvtKpRtFeedback](#sevtkprtfeedback)| | |
| 95 | +|公共事件|键盘举手键实时按键反馈|-|[sEvtKpHandUp](#sevtkphandup)| | |
| 96 | + | |
| 79 | 97 | ### 基站管理 |
| 80 | 98 | |功能归类|功能|API指令|指令/系统事件| |
| 81 | 99 | |---|---|---|---| |
| ... | ... | @@ -99,8 +117,16 @@ |
| 99 | 117 | ||设置基站工作信道|[setBsChannel](#setbschannel)|[fEvtBsChannel](#fevtbschannel)|| |
| 100 | 118 | |登录设置 - 登录名称|获取基站登录名称|[getBsSSID](#getbsssid)|[fEvtBsSSID](#fevtbsssid)| |
| 101 | 119 | ||设置基站登录名称|[setBsSSID](#setbsssid)|[fEvtBsSSID](#fevtbsssid)|| |
| 120 | +|登录设置 - 登录密码|获取基站登录密码|[getBsLoginPwd](#getbsloginpwd)|[fEvtBsLoginPwd](#fevtbsloginpwd)| | |
| 121 | +||设置基站登录密码|[setBsLoginPwd](#setbsloginpwd)|[fEvtBsLoginPwd](#fevtbsloginpwd)|| | |
| 122 | +|登录设置 - 基站登录状态|获取基站登录状态|[getBsLoginState](#getbsloginstate)|[fEvtBsLoginState](#fevtbsloginstate)| | |
| 123 | +||设置基站登录状态|[setBsLoginState](#setbsloginstate)|[fEvtBsLoginState](#fevtbsloginstate)|| | |
| 102 | 124 | |键盘统一设置 - 键盘语言|获取键盘语言|[getBsKpLanguage](#getbskplanguage)|[fEvtBsKpLanguage](#fevtbskplanguage)| |
| 103 | 125 | ||设置键盘语言|[setBsKpLanguage](#setbskplanguage)|[fEvtBsKpLanguage](#fevtbskplanguage)|| |
| 126 | +|键盘统一设置 - 状态语模式|获取状态语设置状态|[getBsKpStbMsgMode](#getbskpstbmsgmode)|[fEvtBsKpStbMsgMode](#fevtbskpstbmsgmode)| | |
| 127 | +||设置状态语工作状态|[setBsKpStbMsgMode](#setbskpstbmsgmode)|[fEvtBsKpStbMsgMode](#fevtbskpstbmsgmode)||| | |
| 128 | +|键盘统一设置 - 登录菜单|获取键盘登录菜单状态|[getBsKpLoginMenu](#getbskploginmenu)|[fEvtBsKpLoginMenu](#fevtbskploginmenu)| | |
| 129 | +||设置键盘登录菜单状态|[setBsKpLoginMenu](#setbskploginmenu)|[fEvtBsKpLoginMenu](#fevtbskploginmenu)||| | |
| 104 | 130 | |键盘统一设置 - 键盘休眠|<font color="red">设置键盘休眠等级(内)</font>|[setBsKpSleepLevel](#setbskpsleeplevel)|[fEvtBsKpSleepLevel](#fevtbskpsleeplevel)| |
| 105 | 131 | ||<font color="red">获取键盘休眠等级(内)</font>|[getBsKpSleepLevel](#getbskpsleeplevel)|[fEvtBsKpSleepLevel](#fevtbskpsleeplevel)| |
| 106 | 132 | ||<font color="red">设置键盘暂停休眠状态(内)</font>|[setBsKpPauseSleep](#setbskppausesleep)|[fEvtBsKpPauseSleep](#fevtbskppausesleep)| |
| ... | ... | @@ -111,6 +137,8 @@ |
| 111 | 137 | ||清空白名单|[clearBsWhitelist](#clearbswhitelist)|[sEvtStateCode](#sevtstatecode)<br>[fEvtBsWhitelist](#fevtbswhitelist)| |
| 112 | 138 | ||增加白名单|[addBsWhitelist](#addbswhitelist)|[sEvtStateCode](#sevtstatecode)<br>[fEvtAddBsWhitelist](#fevtaddbswhitelist)<br>[fEvtBsWhitelist](#fevtbswhitelist)| |
| 113 | 139 | ||删除白名单|[delBsWhitelist](#delbswhitelist)|[sEvtStateCode](#sevtstatecode)<br>[fEvtDelBsWhitelist](#fevtdelbswhitelist)<br>[fEvtBsWhitelist](#fevtbswhitelist)| |
| 140 | +|基站加密 - 软件狗|获取基站软件狗|[getBsSoftwareKey](#getbssoftwarekey)|[fEvtBsSoftwareKey](#fevtbssoftwarekey)| | |
| 141 | +||设置基站软件狗|[setBsSoftwareKey](#setbssoftwarekey)|[fEvtBsSoftwareKey](#fevtbssoftwarekey)| | |
| 114 | 142 | |网络设置 - TCP/IP参数|获取TCP/IP参数|[getBsTcpipParams](#getbstcpipparams)|[fEvtBsTcpipParams](#fevtbstcpipparams)| |
| 115 | 143 | ||设置TCP/IP参数|[setBsTcpipParams](#setbstcpipparams)|[fEvtBsTcpipParams](#fevtbstcpipparams)|| |
| 116 | 144 | |网络设置 - MQTT参数|获取MQTT参数|[getBsMqttParams](#getbsmqttparams)|[fEvtBsMqttParams](#fevtbsmqttparams)| |
| ... | ... | @@ -123,6 +151,13 @@ |
| 123 | 151 | ### 键盘管理 |
| 124 | 152 | |功能归类|功能|API指令|指令事件| |
| 125 | 153 | |---|---|---|---| |
| 154 | +|<font color="red">识别设置 - 出厂编码(内)|<font color="red">设置键盘出厂编码(内)|[setKpSN](#setkpsn)|[fEvtKpSN](#fevtkpsn)| | |
| 155 | +|识别设置 - 键盘编号|获取键盘编号|[getKpID](#getkpid)|[fEvtKpID](#fevtkpid)| | |
| 156 | +|<font color="red">识别设置 - 键盘编号(内)|<font color="red">设置键盘编号(内)|[setKpID](#setkpid)|[fEvtKpID](#fevtkpid)| | |
| 157 | +|识别设置 - 键盘型号|获取键盘型号|[getKpModel](#getkpmodel)|[fEvtKpModel](#fevtkpmodel)| | |
| 158 | +|识别设置 - 键盘固件版本|获取键盘固件版本|[getKpFWVersion](#getKpfwversion)|[fEvtKpFWVersion](#fevtkpfwversion)| | |
| 159 | +|<font color="red">识别设置 - 识别模式(内)|<font color="red">获取键盘识别模式(内)|[getKpIdentityMode](#getkpidentitymode)|[fEvtKpIdentityMode](#fevtkpidentitymode)| | |
| 160 | +||<font color="red">设置键盘识别模式(内)|[setKpIdentityMode](#setkpidentitymode)|[fEvtKpIdentityMode](#fevtkpidentitymode)| | |
| 126 | 161 | |交互设置 - 用户内置状态语|设置用户内置状态语|[setKpUserStbMsg](#setkpuserstbmsg)|[fEvtKpUserStbMsg](#fevtkpuserstbmsg)| |
| 127 | 162 | |交互设置 - 用户实时提示反馈信息|实时设置提示反馈信息|[rtSetKpUserPrompt](#rtsetkpuserprompt)|[sEvtStateCode](#sevtstatecode)<br>[fEvtSetKpUserPrompt](#fevtsetkpuserprompt)| |
| 128 | 163 | |在线状态获取|开启扫描在线键盘|[startGetKpOnline](#startgetkponline)|[sEvtStateCode](#sevtstatecode)<br>[fEvtKpOnlineMsg](#fevtkponlinemsg)| |
| ... | ... | @@ -140,7 +175,7 @@ |
| 140 | 175 | |功能归类|功能|API指令|指令事件| |
| 141 | 176 | |---|---|---|---| |
| 142 | 177 | |同步签到|启动同步签到|[startKpSignIn](#startkpsignin)|[sEvtStateCode](#sevtstatecode)<br>[fEvtKpSignIn](#fevtkpsignin)| |
| 143 | -||停止同步签到|[stopKpSignIn](#stopkpsignin)|[sEvtStateCode](#sevtstatecode)| | |
| 178 | +||停止同步签到|[stopKpVote](#stopkpvote)|[sEvtStateCode](#sevtstatecode)| | |
| 144 | 179 | |随时签到|启动随时签到|[rtStartKpSignIn](#rtstartkpsignin)|[sEvtStateCode](#sevtstatecode)<br>[fEvtKpSignIn](#fevtkpsignin)| |
| 145 | 180 | ||停止随时签到|[rtStopKpSignIn](#rtstopkpsignin)|[sEvtStateCode](#sevtstatecode)| |
| 146 | 181 | ||实时PIN签到授权|[rtSetKpLoginAllowed](#rtsetkploginallowed)|[sEvtStateCode](#sevtstatecode)<br>[fEvtKpLoginAllowed](#fevtkploginallowed)| |
| ... | ... | @@ -148,22 +183,44 @@ |
| 148 | 183 | |功能归类|功能|API指令|指令事件| |
| 149 | 184 | |---|---|---|---| |
| 150 | 185 | |判断题|启动判断题答题|[startQATrueFalse](#startqatruefalse)|[sEvtStateCode](#sevtstatecode)<br>[fEvtQATrueFalse](#fevtqatruefalse)| |
| 151 | -||停止判断题答题|[stopQATrueFalse](#stopqatruefalse)|[sEvtStateCode](#sevtstatecode)| | |
| 186 | +||停止判断题答题|[stopKpVote](#stopkpvote)|[sEvtStateCode](#sevtstatecode)| | |
| 152 | 187 | |选择题|启动选择题答题|[startQAChoice](#startqachoice)|[sEvtStateCode](#sevtstatecode)<br>[fEvtQAChoice](#fevtqachoice)| |
| 153 | -||停止选择题答题|[stopQAChoice](#stopqachoice)|[sEvtStateCode](#sevtstatecode)| | |
| 188 | +||停止选择题答题|[stopKpVote](#stopkpvote)|[sEvtStateCode](#sevtstatecode)| | |
| 154 | 189 | |数字题|启动数字题答题|[startQANum](#startqanum)|[sEvtStateCode](#sevtstatecode)<br>[fEvtQANum](#fevtqanum)| |
| 155 | -||停止数字题答题|[stopQANum](#stopqanum)|[sEvtStateCode](#sevtstatecode)| | |
| 190 | +||停止数字题答题|[stopKpVote](#stopkpvote)|[sEvtStateCode](#sevtstatecode)| | |
| 156 | 191 | |抢答题|启动抢答题答题|[startQAQuicker](#startqaquicker)|[sEvtStateCode](#sevtstatecode)<br>[fEvtQAQuicker](#fevtqaquicker)| |
| 157 | -||停止抢答题答题|[stopQAQuicker](#stopqaquicker)|[sEvtStateCode](#sevtstatecode)| | |
| 192 | +||停止抢答题答题|[stopKpVote](#stopkpvote)|[sEvtStateCode](#sevtstatecode)| | |
| 193 | +|待机实时反馈|设置待机实时反馈状态|[setKpStbResponse](#setkpstbresponse)|[fEvtKpStbResponse](#fevtkpstbresponse)<br>[sEvtKpRtFeedback](#sevtkprtfeedback)<br>[sEvtKpHandUp](#sevtkphandup)| | |
| 158 | 194 | ### 在线测验 |
| 159 | 195 | |功能归类|功能|API指令|指令事件| |
| 160 | 196 | |---|---|---|---| |
| 161 | 197 | |标准测验|启动标准测验|[startKpExam](#startkpexam)|[sEvtStateCode](#sevtstatecode)<br>[fEvtKpExam](#fevtkpexam)<br>[fEvtFinalSubmit](#fevtfinalsubmit)| |
| 162 | -||停止标准测验|[stopKpExam](#stopkpexam)|[sEvtStateCode](#sevtstatecode)| | |
| 163 | -||刷新作答数据|[rtGetKpExamData](#rtgetkpexamdata)|[fEvtKpExam](#fevtkpexam)| | |
| 198 | +||停止标准测验|[stopKpVote](#stopkpvote)|[sEvtStateCode](#sevtstatecode)| | |
| 199 | +||刷新作答数据|[rtGetKpExamData](#rtgetkpexamdata)|[sEvtStateCode](#sevtstatecode)<br>[fEvtKpExam](#fevtkpexam)| | |
| 164 | 200 | ||允许键盘提交后退回修改|[rtAllowEdited](#rtkpallowedited)|[sEvtStateCode](#sevtstatecode)<br>[fEvtFinalSubmit](#fevtfinalsubmit)| |
| 165 | 201 | |多科测验|启动多科测验|[startKpMultiExam](#startkpmultiexam)|[sEvtStateCode](#sevtstatecode)<br>[fEvtKpExam](#fevtkpexam)<br>[fEvtFinalSubmit](#fevtfinalsubmit)| |
| 166 | -||停止标准测验|[stopKpMultiExam](#stopkpmultiexam)|[sEvtStateCode](#sevtstatecode)| | |
| 202 | +||停止标准测验|[stopKpVote](#stopkpvote)|[sEvtStateCode](#sevtstatecode)| | |
| 203 | +|自主录分|启动自主录分|[startKpScoreInput](#startkpscoreinput)|[sEvtStateCode](#sevtstatecode)<br>[fEvtKpScore](#fevtkpscore)<br>[fEvtFinalSubmit](#fevtfinalsubmit)| | |
| 204 | +||停止自主录分|[stopKpVote](#stopkpvote)|[sEvtStateCode](#sevtstatecode)| | |
| 205 | + | |
| 206 | +## 公共方法 | |
| 207 | +### stopKpVote | |
| 208 | +- **主题**: /client/\${baseSN}/send | |
| 209 | +- **功能描述**:通用停止键盘答题方法,可以停止如同步签到、按键反馈、在线测验中调用startXXX方法启动的业务 | |
| 210 | +- **参数说明** | |
| 211 | + | |
| 212 | +|参数名|类型|限制|非空|说明| | |
| 213 | +|-----|-----|-----|-----|-----| | |
| 214 | +|fun|string|-|是|事件类型| | |
| 215 | +|dataTag|string||否|数据包标识,不需要时可传空字符串| | |
| 216 | + | |
| 217 | +- **示例代码** | |
| 218 | +```json | |
| 219 | +{ | |
| 220 | + "fun":"stopKpVote", | |
| 221 | + "dataTag":"1" | |
| 222 | +} | |
| 223 | +``` | |
| 167 | 224 | |
| 168 | 225 | ## 公共事件 |
| 169 | 226 | ### sEvtBsConnectState |
| ... | ... | @@ -182,7 +239,7 @@ |
| 182 | 239 | |+version|string||否|基站固件版本| |
| 183 | 240 | |
| 184 | 241 | - **示例代码** |
| 185 | -```Json | |
| 242 | +```json | |
| 186 | 243 | //连接成功 |
| 187 | 244 | { |
| 188 | 245 | "fun":"sEvtBsConnectState", |
| ... | ... | @@ -216,7 +273,7 @@ |
| 216 | 273 | |+value|int||是|有冲突的信道| |
| 217 | 274 | |
| 218 | 275 | - **示例代码** |
| 219 | -```Json | |
| 276 | +```json | |
| 220 | 277 | { |
| 221 | 278 | "fun":"sEvtBsChannelConflict", |
| 222 | 279 | "dataTag":"1", |
| ... | ... | @@ -239,7 +296,7 @@ |
| 239 | 296 | |+value|int||是|刷卡的状态<br>1-成功<br>2-失败| |
| 240 | 297 | |
| 241 | 298 | - **示例代码** |
| 242 | -```Json | |
| 299 | +```json | |
| 243 | 300 | { |
| 244 | 301 | "fun":"sEvtBsNfcResults", |
| 245 | 302 | "dataTag":"1", //不需要时可传空字符串 |
| ... | ... | @@ -265,7 +322,7 @@ |
| 265 | 322 | |+model|int||是|键盘型号| |
| 266 | 323 | |
| 267 | 324 | - **示例代码** |
| 268 | -```Json | |
| 325 | +```json | |
| 269 | 326 | { |
| 270 | 327 | "fun":"sEvtBsKpOnlineMsg", |
| 271 | 328 | "dataTag":"1", |
| ... | ... | @@ -276,6 +333,52 @@ |
| 276 | 333 | } |
| 277 | 334 | } |
| 278 | 335 | ``` |
| 336 | +### sEvtKpRtFeedback | |
| 337 | +- **主题**: /basestation/\${baseSN}/receive | |
| 338 | +- **功能描述**:开启键盘实时反馈后,键盘按键时上报 | |
| 339 | +- **参数说明** | |
| 340 | + | |
| 341 | +|参数名|类型|限制|非空|说明| | |
| 342 | +|---|---|---|---|---| | |
| 343 | +|fun|string|-|是|事件名称| | |
| 344 | +|dataTag|string|-|否|数据包标识| | |
| 345 | +|data|object|-|是|传送参数的对象| | |
| 346 | +|+keySn|string||是|键盘SN| | |
| 347 | +|+keyValue|string||是|键盘提交的按键值| | |
| 348 | + | |
| 349 | +- **示例代码** | |
| 350 | +```json | |
| 351 | +{ | |
| 352 | + "fun":"sEvtKpRtFeedback", | |
| 353 | + "dataTag":"1", | |
| 354 | + "data":{ | |
| 355 | + "keySn":"1234567890", | |
| 356 | + "keyValue":"A" | |
| 357 | + } | |
| 358 | +} | |
| 359 | +``` | |
| 360 | +### sEvtKpHandUp | |
| 361 | +- **主题**: /basestation/\${baseSN}/receive | |
| 362 | +- **功能描述**:开启键盘举手功能后,键盘按举手键时上报 | |
| 363 | +- **参数说明** | |
| 364 | + | |
| 365 | +|参数名|类型|限制|非空|说明| | |
| 366 | +|---|---|---|---|---| | |
| 367 | +|fun|string|-|是|事件名称| | |
| 368 | +|dataTag|string|-|否|数据包标识| | |
| 369 | +|data|object|-|是|传送参数的对象| | |
| 370 | +|+keySn|string||是|举手的键盘SN| | |
| 371 | + | |
| 372 | +- **示例代码** | |
| 373 | +```json | |
| 374 | +{ | |
| 375 | + "fun":"sEvtKpHandUp", | |
| 376 | + "dataTag":"1", | |
| 377 | + "data":{ | |
| 378 | + "keySn":"1234567890" | |
| 379 | + } | |
| 380 | +} | |
| 381 | +``` | |
| 279 | 382 | ### sEvtStateCode |
| 280 | 383 | - **主题**: /basestation/\${baseSN}/receive |
| 281 | 384 | - **功能描述**:返回基站接收指令状态信息 |
| ... | ... | @@ -304,7 +407,7 @@ |
| 304 | 407 | |60001|此功能必须指定键盘SN| |
| 305 | 408 | |
| 306 | 409 | - **示例代码** |
| 307 | -```Json | |
| 410 | +```json | |
| 308 | 411 | { |
| 309 | 412 | "fun":"sEvtStateCode", |
| 310 | 413 | "dataTag":"1", |
| ... | ... | @@ -327,7 +430,7 @@ |
| 327 | 430 | |fun|string|-|是|固定指令名称| |
| 328 | 431 | |dataTag|string|-|否|数据包标识| |
| 329 | 432 | - **示例代码** |
| 330 | -```Json | |
| 433 | +```json | |
| 331 | 434 | { |
| 332 | 435 | "fun":"getBsOnlineState", |
| 333 | 436 | "dataTag":"1" |
| ... | ... | @@ -344,7 +447,7 @@ |
| 344 | 447 | |fun|string|-|是|固定指令名称| |
| 345 | 448 | |dataTag|string|-|否|数据包标识| |
| 346 | 449 | - **示例代码** |
| 347 | -```Json | |
| 450 | +```json | |
| 348 | 451 | { |
| 349 | 452 | "fun":"getBsConnectState", |
| 350 | 453 | "dataTag":"1" |
| ... | ... | @@ -370,7 +473,7 @@ |
| 370 | 473 | |+baseSN|string||否|基站SN| |
| 371 | 474 | |
| 372 | 475 | - **示例代码** |
| 373 | -```Json | |
| 476 | +```json | |
| 374 | 477 | //连接成功 |
| 375 | 478 | { |
| 376 | 479 | "fun":"fEvtBsOnlineState", |
| ... | ... | @@ -398,7 +501,7 @@ |
| 398 | 501 | |+timeStamp|long ||否|当前时间的时间戳| |
| 399 | 502 | |
| 400 | 503 | - **示例代码** |
| 401 | -```Json | |
| 504 | +```json | |
| 402 | 505 | { |
| 403 | 506 | "fun":"timeSync", |
| 404 | 507 | "dataTag":"1", |
| ... | ... | @@ -428,7 +531,7 @@ |
| 428 | 531 | |+verCode|string||是|内部主题校验码,时间+固定key加密| --> |
| 429 | 532 | |
| 430 | 533 | - **示例代码** |
| 431 | -```Json | |
| 534 | +```json | |
| 432 | 535 | { |
| 433 | 536 | "fun":"setBsSN", |
| 434 | 537 | "dataTag":"1", |
| ... | ... | @@ -448,7 +551,7 @@ |
| 448 | 551 | |dataTag|string|-|否|数据包标识,可为空字符串| |
| 449 | 552 | |
| 450 | 553 | - **示例代码** |
| 451 | -```Json | |
| 554 | +```json | |
| 452 | 555 | { |
| 453 | 556 | "fun":"getBsModel", |
| 454 | 557 | "dataTag":"1" |
| ... | ... | @@ -465,7 +568,7 @@ |
| 465 | 568 | |dataTag|string|-|否|数据包标识,可为空字符串| |
| 466 | 569 | |
| 467 | 570 | - **示例代码** |
| 468 | -```Json | |
| 571 | +```json | |
| 469 | 572 | { |
| 470 | 573 | "fun":"getBsFWVersion", |
| 471 | 574 | "dataTag":"1" |
| ... | ... | @@ -482,7 +585,7 @@ |
| 482 | 585 | |dataTag|string|-|否|数据包标识,可为空字符串| |
| 483 | 586 | |
| 484 | 587 | - **示例代码** |
| 485 | -```Json | |
| 588 | +```json | |
| 486 | 589 | { |
| 487 | 590 | "fun":"getBsBIC", |
| 488 | 591 | "dataTag":"1" |
| ... | ... | @@ -503,7 +606,7 @@ |
| 503 | 606 | |+verCode|string||是|内部主题校验码,时间+固定key加密| --> |
| 504 | 607 | |
| 505 | 608 | - **示例代码** |
| 506 | -```Json | |
| 609 | +```json | |
| 507 | 610 | { |
| 508 | 611 | "fun":"setBsBIC", |
| 509 | 612 | "dataTag":"1", |
| ... | ... | @@ -526,7 +629,7 @@ |
| 526 | 629 | |+value|string|-|是|基站的出厂编码| |
| 527 | 630 | |
| 528 | 631 | - **示例代码** |
| 529 | -```Json | |
| 632 | +```json | |
| 530 | 633 | { |
| 531 | 634 | "fun":"fEvtBsSN", |
| 532 | 635 | "dataTag":"1", |
| ... | ... | @@ -548,7 +651,7 @@ |
| 548 | 651 | |+value|string|-|是|基站的型号名称| |
| 549 | 652 | |
| 550 | 653 | - **示例代码** |
| 551 | -```Json | |
| 654 | +```json | |
| 552 | 655 | { |
| 553 | 656 | "fun":"fEvtBsModel", |
| 554 | 657 | "dataTag":"1", |
| ... | ... | @@ -570,7 +673,7 @@ |
| 570 | 673 | |+value|string||是|基站的固件版本号| |
| 571 | 674 | |
| 572 | 675 | - **示例代码** |
| 573 | -```Json | |
| 676 | +```json | |
| 574 | 677 | { |
| 575 | 678 | "fun":"fEvtBsFWVersion", |
| 576 | 679 | "dataTag":"1", |
| ... | ... | @@ -592,7 +695,7 @@ |
| 592 | 695 | |+value|string||是|基站的品牌码| |
| 593 | 696 | |
| 594 | 697 | - **示例代码** |
| 595 | -```Json | |
| 698 | +```json | |
| 596 | 699 | { |
| 597 | 700 | "fun":"fEvtBsBIC", |
| 598 | 701 | "dataTag":"1", |
| ... | ... | @@ -614,7 +717,7 @@ |
| 614 | 717 | |dataTag|string|-|否|数据包标识,可为空字符串| |
| 615 | 718 | |
| 616 | 719 | - **示例代码** |
| 617 | -```Json | |
| 720 | +```json | |
| 618 | 721 | { |
| 619 | 722 | "fun":"getBsNetworkMode", |
| 620 | 723 | "dataTag":"1" |
| ... | ... | @@ -633,7 +736,7 @@ |
| 633 | 736 | |+value|string|-|是|设置的基站组网模式<br>1-配对模式<br>2-白名单模式| |
| 634 | 737 | |
| 635 | 738 | - **示例代码** |
| 636 | -```Json | |
| 739 | +```json | |
| 637 | 740 | { |
| 638 | 741 | "fun":"setBsNetworkMode", |
| 639 | 742 | "dataTag":"1", |
| ... | ... | @@ -653,7 +756,7 @@ |
| 653 | 756 | |dataTag|string|-|否|数据包标识,可为空字符串| |
| 654 | 757 | |
| 655 | 758 | - **示例代码** |
| 656 | -```Json | |
| 759 | +```json | |
| 657 | 760 | { |
| 658 | 761 | "fun":"getBsPairCode", |
| 659 | 762 | "dataTag":"1" |
| ... | ... | @@ -674,7 +777,7 @@ |
| 674 | 777 | |+verCode|string||是|内部主题校验码,时间+固定key加密| --> |
| 675 | 778 | |
| 676 | 779 | - **示例代码** |
| 677 | -```Json | |
| 780 | +```json | |
| 678 | 781 | { |
| 679 | 782 | "fun":"setBsPairCode", |
| 680 | 783 | "dataTag":"1", |
| ... | ... | @@ -694,7 +797,7 @@ |
| 694 | 797 | |dataTag|string|-|否|数据包标识,可为空字符串| |
| 695 | 798 | |
| 696 | 799 | - **示例代码** |
| 697 | -```Json | |
| 800 | +```json | |
| 698 | 801 | { |
| 699 | 802 | "fun":"getBsNfcLogin", |
| 700 | 803 | "dataTag":"1" |
| ... | ... | @@ -713,7 +816,7 @@ |
| 713 | 816 | |+value|string|-|是|设置的基站刷卡配对状态<br>0-关闭刷卡配对<br>1-开启刷卡配对| |
| 714 | 817 | |
| 715 | 818 | - **示例代码** |
| 716 | -```Json | |
| 819 | +```json | |
| 717 | 820 | { |
| 718 | 821 | "fun":"setBsNfcLogin", |
| 719 | 822 | "dataTag":"1", |
| ... | ... | @@ -733,7 +836,7 @@ |
| 733 | 836 | |dataTag|string|-|否|数据包标识,可为空字符串| |
| 734 | 837 | |
| 735 | 838 | - **示例代码** |
| 736 | -```Json | |
| 839 | +```json | |
| 737 | 840 | { |
| 738 | 841 | "fun":"getBsChannel", |
| 739 | 842 | "dataTag":"1" |
| ... | ... | @@ -752,7 +855,7 @@ |
| 752 | 855 | |+value|string|-|是|设置的基站信道,可设范围:1-80| |
| 753 | 856 | |
| 754 | 857 | - **示例代码** |
| 755 | -```Json | |
| 858 | +```json | |
| 756 | 859 | { |
| 757 | 860 | "fun":"setBsChannel", |
| 758 | 861 | "dataTag":"1", |
| ... | ... | @@ -775,7 +878,7 @@ |
| 775 | 878 | |+value|string||是|基站的组网模式<br>1-配对模式<br>2-白名单模式| |
| 776 | 879 | |
| 777 | 880 | - **示例代码** |
| 778 | -```Json | |
| 881 | +```json | |
| 779 | 882 | { |
| 780 | 883 | "fun":"fEvtBsNetworkMode", |
| 781 | 884 | "dataTag":"1", |
| ... | ... | @@ -797,7 +900,7 @@ |
| 797 | 900 | |+value|string||是|基站的配对码| |
| 798 | 901 | |
| 799 | 902 | - **示例代码** |
| 800 | -```Json | |
| 903 | +```json | |
| 801 | 904 | { |
| 802 | 905 | "fun":"fEvtBsPairCode", |
| 803 | 906 | "dataTag":"1", |
| ... | ... | @@ -820,7 +923,7 @@ |
| 820 | 923 | |+value|string||是|基站信道| |
| 821 | 924 | |
| 822 | 925 | - **示例代码** |
| 823 | -```Json | |
| 926 | +```json | |
| 824 | 927 | { |
| 825 | 928 | "fun":"fEvtBsChannel", |
| 826 | 929 | "dataTag":"1", |
| ... | ... | @@ -842,7 +945,7 @@ |
| 842 | 945 | |+value|string||是|0-关闭 1-开启| |
| 843 | 946 | |
| 844 | 947 | - **示例代码** |
| 845 | -```Json | |
| 948 | +```json | |
| 846 | 949 | { |
| 847 | 950 | "fun":"fEvtBsNfcLogin", |
| 848 | 951 | "dataTag":"1", |
| ... | ... | @@ -865,7 +968,7 @@ |
| 865 | 968 | |dataTag|string|-|否|数据包标识| |
| 866 | 969 | |
| 867 | 970 | - **示例代码** |
| 868 | -```Json | |
| 971 | +```json | |
| 869 | 972 | { |
| 870 | 973 | "fun":"getBsSSID", |
| 871 | 974 | "dataTag":"1" |
| ... | ... | @@ -884,7 +987,7 @@ |
| 884 | 987 | |+value|string||是|设置的基站SSID,最长12字符| |
| 885 | 988 | |
| 886 | 989 | - **示例代码** |
| 887 | -```Json | |
| 990 | +```json | |
| 888 | 991 | { |
| 889 | 992 | "fun":"setBsSSID", |
| 890 | 993 | "dataTag":"1", |
| ... | ... | @@ -893,6 +996,86 @@ |
| 893 | 996 | } |
| 894 | 997 | } |
| 895 | 998 | ``` |
| 999 | +##### getBsLoginPwd | |
| 1000 | +- **主题**:/client/\${baseSN}/send | |
| 1001 | +- **功能描述**:获取基站登录密码 | |
| 1002 | +- **参数说明** | |
| 1003 | + | |
| 1004 | +|参数名|类型|限制|是否必填|说明| | |
| 1005 | +|---|---|---|---|---| | |
| 1006 | +|fun|string|-|是|固定指令名称| | |
| 1007 | +|dataTag|string|-|否|数据包标识| | |
| 1008 | + | |
| 1009 | +- **示例代码** | |
| 1010 | +```json | |
| 1011 | +{ | |
| 1012 | + "fun":"getBsLoginPwd", | |
| 1013 | + "dataTag":"1" | |
| 1014 | +} | |
| 1015 | +``` | |
| 1016 | +##### setBsLoginPwd | |
| 1017 | +- **主题**:/client/\${baseSN}/send | |
| 1018 | +- **功能描述**:设置基站登录密码 | |
| 1019 | +- **参数说明** | |
| 1020 | + | |
| 1021 | +|参数名|类型|限制|是否必填|说明| | |
| 1022 | +|---|---|---|---|---| | |
| 1023 | +|fun|string|-|是|指令名称| | |
| 1024 | +|dataTag|string|-|否|数据包标识,可为空字符串| | |
| 1025 | +|data|object|-|是|传送参数的对象| | |
| 1026 | +|+value|string||是|设置的基站登录密码,数字类型,为空代表无需密码登录| | |
| 1027 | + | |
| 1028 | +- **示例代码** | |
| 1029 | +```json | |
| 1030 | +{ | |
| 1031 | + "fun":"setBsLoginPwd", | |
| 1032 | + "dataTag":"1", | |
| 1033 | + "data":{ | |
| 1034 | + "value":"123456" | |
| 1035 | + } | |
| 1036 | +} | |
| 1037 | +``` | |
| 1038 | +##### getBsLoginState | |
| 1039 | +获取基站登录名称 | |
| 1040 | +- **主题**:/client/\${baseSN}/send | |
| 1041 | +- **功能描述**:获取基站登录状态 | |
| 1042 | +- **参数说明** | |
| 1043 | + | |
| 1044 | +|参数名|类型|限制|是否必填|说明| | |
| 1045 | +|---|---|---|---|---| | |
| 1046 | +|fun|string|-|是|固定指令名称| | |
| 1047 | +|dataTag|string|-|否|数据包标识| | |
| 1048 | + | |
| 1049 | +- **示例代码** | |
| 1050 | +```json | |
| 1051 | +{ | |
| 1052 | + "fun":"getBsLoginState", | |
| 1053 | + "dataTag":"1" | |
| 1054 | +} | |
| 1055 | +``` | |
| 1056 | +##### setBsLoginState | |
| 1057 | +- **主题**:/client/\${baseSN}/send | |
| 1058 | +- **功能描述**:设置基站登录状态 | |
| 1059 | +- **参数说明** | |
| 1060 | + | |
| 1061 | +|参数名|类型|限制|是否必填|说明| | |
| 1062 | +|---|---|---|---|---| | |
| 1063 | +|fun|string|-|是|指令名称| | |
| 1064 | +|dataTag|string|-|否|数据包标识,可为空字符串| | |
| 1065 | +|data|object|-|是|传送参数的对象| | |
| 1066 | +|+value|string||是|设置是否允许键盘自主登入<br>0 - 不允许键盘登入<br>1 - 允许键盘登入| | |
| 1067 | + | |
| 1068 | +- **示例代码** | |
| 1069 | +```json | |
| 1070 | +{ | |
| 1071 | + "fun":"setBsLoginState", | |
| 1072 | + "dataTag":"1", | |
| 1073 | + "data":{ | |
| 1074 | + "value":"1" | |
| 1075 | + } | |
| 1076 | +} | |
| 1077 | +``` | |
| 1078 | + | |
| 896 | 1079 | #### 事件 |
| 897 | 1080 | ##### fEvtBsSSID |
| 898 | 1081 | - **主题**: /basestation/\${baseSN}/receive |
| ... | ... | @@ -907,7 +1090,7 @@ |
| 907 | 1090 | |+value|string||是|基站名称| |
| 908 | 1091 | |
| 909 | 1092 | - **示例代码** |
| 910 | -```Json | |
| 1093 | +```json | |
| 911 | 1094 | { |
| 912 | 1095 | "fun":"fEvtBsSSID", |
| 913 | 1096 | "dataTag":"1", |
| ... | ... | @@ -916,6 +1099,50 @@ |
| 916 | 1099 | } |
| 917 | 1100 | } |
| 918 | 1101 | ``` |
| 1102 | +##### fEvtBsLoginPwd | |
| 1103 | +- **主题**: /basestation/\${baseSN}/receive | |
| 1104 | +- **功能描述**:返回基站登录密码 | |
| 1105 | +- **参数说明** | |
| 1106 | + | |
| 1107 | +|参数名|类型|限制|非空|说明| | |
| 1108 | +|---|---|---|---|---| | |
| 1109 | +|fun|string|-|是|事件名称| | |
| 1110 | +|dataTag|string|-|否|数据包标识,可传空字符串| | |
| 1111 | +|data|object|-|是|传送参数的对象| | |
| 1112 | +|+value|string||是|基站登录密码| | |
| 1113 | + | |
| 1114 | +- **示例代码** | |
| 1115 | +```json | |
| 1116 | +{ | |
| 1117 | + "fun":"fEvtBsLoginPwd", | |
| 1118 | + "dataTag":"1", | |
| 1119 | + "data":{ | |
| 1120 | + "value":"123456" | |
| 1121 | + } | |
| 1122 | +} | |
| 1123 | +``` | |
| 1124 | +##### fEvtBsLoginState | |
| 1125 | +- **主题**: /basestation/\${baseSN}/receive | |
| 1126 | +- **功能描述**:返回基站登录状态 | |
| 1127 | +- **参数说明** | |
| 1128 | + | |
| 1129 | +|参数名|类型|限制|非空|说明| | |
| 1130 | +|---|---|---|---|---| | |
| 1131 | +|fun|string|-|是|事件名称| | |
| 1132 | +|dataTag|string|-|否|数据包标识,可传空字符串| | |
| 1133 | +|data|object|-|是|传送参数的对象| | |
| 1134 | +|+value|string||是|基站登录状态| | |
| 1135 | + | |
| 1136 | +- **示例代码** | |
| 1137 | +```json | |
| 1138 | +{ | |
| 1139 | + "fun":"fEvtBsLoginState", | |
| 1140 | + "dataTag":"1", | |
| 1141 | + "data":{ | |
| 1142 | + "value":"1" | |
| 1143 | + } | |
| 1144 | +} | |
| 1145 | +``` | |
| 919 | 1146 | ### 键盘统一设置 |
| 920 | 1147 | #### 方法 |
| 921 | 1148 | ##### getBsKpLanguage |
| ... | ... | @@ -929,7 +1156,7 @@ |
| 929 | 1156 | |dataTag|string|-|否|数据包标识,可为空字符串| |
| 930 | 1157 | |
| 931 | 1158 | - **示例代码** |
| 932 | -```Json | |
| 1159 | +```json | |
| 933 | 1160 | { |
| 934 | 1161 | "fun":"getBsKpLanguage", |
| 935 | 1162 | "dataTag":"1" |
| ... | ... | @@ -948,7 +1175,7 @@ |
| 948 | 1175 | |+value|string||是|设置键盘显示的语言<br>1-简体中文<br>2-英文| |
| 949 | 1176 | |
| 950 | 1177 | - **示例代码** |
| 951 | -```Json | |
| 1178 | +```json | |
| 952 | 1179 | { |
| 953 | 1180 | "fun":"setBsKpLanguage", |
| 954 | 1181 | "dataTag":"1", |
| ... | ... | @@ -957,10 +1184,9 @@ |
| 957 | 1184 | } |
| 958 | 1185 | } |
| 959 | 1186 | ``` |
| 960 | - | |
| 961 | -##### getBsKpSleepLevel | |
| 962 | -- **主题**:<sapn class="yellowFill">/manage/\${baseSN}/send</span> | |
| 963 | -- **功能描述**:获取键盘休眠时间等级 | |
| 1187 | +##### getBsKpStbMsgMode | |
| 1188 | +- **主题**:/client/\${baseSN}/send | |
| 1189 | +- **功能描述**:获取状态语设置状态 | |
| 964 | 1190 | - **参数说明** |
| 965 | 1191 | |
| 966 | 1192 | |参数名|类型|限制|是否必填|说明| |
| ... | ... | @@ -969,16 +1195,15 @@ |
| 969 | 1195 | |dataTag|string|-|否|数据包标识,可为空字符串| |
| 970 | 1196 | |
| 971 | 1197 | - **示例代码** |
| 972 | -```Json | |
| 1198 | +```json | |
| 973 | 1199 | { |
| 974 | - "fun":"getBsKpSleepLevel", | |
| 1200 | + "fun":"getBsKpStbMsgMode", | |
| 975 | 1201 | "dataTag":"1" |
| 976 | 1202 | } |
| 977 | 1203 | ``` |
| 978 | - | |
| 979 | -##### setBsKpSleepLevel | |
| 980 | -- **主题**:<sapn class="yellowFill">/manage/\${baseSN}/send</span> | |
| 981 | -- **功能描述**:设置键盘休眠时间等级 | |
| 1204 | +##### setBsKpStbMsgMode | |
| 1205 | +- **主题**:/client/\${baseSN}/send | |
| 1206 | +- **功能描述**:设置状态语工作状态 | |
| 982 | 1207 | - **参数说明** |
| 983 | 1208 | |
| 984 | 1209 | |参数名|类型|限制|是否必填|说明| |
| ... | ... | @@ -986,94 +1211,217 @@ |
| 986 | 1211 | |fun|string|-|是|指令名称| |
| 987 | 1212 | |dataTag|string|-|否|数据包标识,可为空字符串| |
| 988 | 1213 | |data|object|-|是|传送参数的对象| |
| 989 | -|+value|string||是|设置键盘休眠的时间等级<br>0-30秒<br>1-2分钟<br>2-10分钟<br>3-45分钟| | |
| 1214 | +|+value|string||是|设置状态语工作状态<br>0-系统默认<br>1-用户内置| | |
| 990 | 1215 | |
| 991 | 1216 | - **示例代码** |
| 992 | -```Json | |
| 1217 | +```json | |
| 993 | 1218 | { |
| 994 | - "fun":"setBsKpSleepLevel", | |
| 1219 | + "fun":"setBsKpStbMsgMode", | |
| 995 | 1220 | "dataTag":"1", |
| 996 | 1221 | "data":{ |
| 997 | - "value":"1" | |
| 1222 | + "value":"0" | |
| 998 | 1223 | } |
| 999 | 1224 | } |
| 1000 | 1225 | ``` |
| 1001 | - | |
| 1002 | -##### setBsKpPauseSleep | |
| 1003 | -- **主题**:<sapn class="yellowFill">/manage/\${baseSN}/send</span> | |
| 1004 | -- **功能描述**:设置键盘暂停休眠是否开启<br><font color="red">注意:请谨慎使用本功能,务必在相关测试或功能完成后关闭,否则可能会导致键盘异常耗电<br>设置单次生效,基站拔插后复位成关闭状态</font> | |
| 1226 | +##### getBsKpLoginMenu | |
| 1227 | +- **主题**:/client/\${baseSN}/send | |
| 1228 | +- **功能描述**:获取键盘登录菜单显示状态 | |
| 1005 | 1229 | - **参数说明** |
| 1006 | 1230 | |
| 1007 | 1231 | |参数名|类型|限制|是否必填|说明| |
| 1008 | 1232 | |---|---|---|---|---| |
| 1009 | 1233 | |fun|string|-|是|指令名称| |
| 1010 | 1234 | |dataTag|string|-|否|数据包标识,可为空字符串| |
| 1011 | -|data|object|-|是|传送参数的对象| | |
| 1012 | -|+value|string||是|设置键盘暂停休眠是否开启<br>0-关闭暂停休眠<br>1-开启暂停休眠| | |
| 1013 | 1235 | |
| 1014 | 1236 | - **示例代码** |
| 1015 | -```Json | |
| 1237 | +```json | |
| 1016 | 1238 | { |
| 1017 | - "fun":"setBsKpPauseSleep", | |
| 1018 | - "dataTag":"1", | |
| 1019 | - "data":{ | |
| 1020 | - "value":"1" | |
| 1021 | - } | |
| 1239 | + "fun":"getBsKpLoginMenu", | |
| 1240 | + "dataTag":"1" | |
| 1022 | 1241 | } |
| 1023 | 1242 | ``` |
| 1024 | 1243 | |
| 1025 | -#### 事件 | |
| 1026 | -##### fEvtBsKpLanguage | |
| 1027 | -- **主题**: /basestation/\${baseSN}/receive | |
| 1028 | -- **功能描述**:返回键盘语言 | |
| 1244 | +##### setBsKpLoginMenu | |
| 1245 | +- **主题**:/client/\${baseSN}/send | |
| 1246 | +- **功能描述**:设置键盘登录菜单显示状态 | |
| 1029 | 1247 | - **参数说明** |
| 1030 | 1248 | |
| 1031 | -|参数名|类型|限制|非空|说明| | |
| 1249 | +|参数名|类型|限制|是否必填|说明| | |
| 1032 | 1250 | |---|---|---|---|---| |
| 1033 | 1251 | |fun|string|-|是|指令名称| |
| 1034 | 1252 | |dataTag|string|-|否|数据包标识,可为空字符串| |
| 1035 | 1253 | |data|object|-|是|传送参数的对象| |
| 1036 | -|+value|string||是|键盘显示的语言<br>1-简体中文<br>2-英文| | |
| 1254 | +|+value|string||是|设置键盘登录菜单显示状态<br>0-不显示<br>1-显示| | |
| 1037 | 1255 | |
| 1038 | 1256 | - **示例代码** |
| 1039 | -```Json | |
| 1257 | +```json | |
| 1040 | 1258 | { |
| 1041 | - "fun":"fEvtBsKpLanguage", | |
| 1259 | + "fun":"setBsKpLoginMenu", | |
| 1042 | 1260 | "dataTag":"1", |
| 1043 | 1261 | "data":{ |
| 1044 | 1262 | "value":"1" |
| 1045 | 1263 | } |
| 1046 | 1264 | } |
| 1047 | 1265 | ``` |
| 1048 | - | |
| 1049 | -##### fEvtBsKpSleepLevel | |
| 1050 | -- **主题**: <sapn class="yellowFill">/manage/\${baseSN}/receive</span> | |
| 1051 | -- **功能描述**:返回键盘休眠时间等级 | |
| 1266 | +##### getBsKpSleepLevel | |
| 1267 | +- **主题**:<sapn class="yellowFill">/manage/\${baseSN}/send</span> | |
| 1268 | +- **功能描述**:获取键盘休眠时间等级 | |
| 1052 | 1269 | - **参数说明** |
| 1053 | 1270 | |
| 1054 | -|参数名|类型|限制|非空|说明| | |
| 1271 | +|参数名|类型|限制|是否必填|说明| | |
| 1055 | 1272 | |---|---|---|---|---| |
| 1056 | 1273 | |fun|string|-|是|指令名称| |
| 1057 | 1274 | |dataTag|string|-|否|数据包标识,可为空字符串| |
| 1058 | -|data|object|-|是|传送参数的对象| | |
| 1059 | -|+value|string||是|键盘休眠的时间等级<br>0-30秒<br>1-2分钟<br>2-10分钟<br>3-45分钟| | |
| 1060 | 1275 | |
| 1061 | 1276 | - **示例代码** |
| 1062 | -```Json | |
| 1277 | +```json | |
| 1063 | 1278 | { |
| 1064 | - "fun":"fEvtBsKpSleepLevel", | |
| 1065 | - "dataTag":"1", | |
| 1066 | - "data":{ | |
| 1067 | - "value":"1" | |
| 1068 | - } | |
| 1279 | + "fun":"getBsKpSleepLevel", | |
| 1280 | + "dataTag":"1" | |
| 1069 | 1281 | } |
| 1070 | 1282 | ``` |
| 1071 | 1283 | |
| 1072 | -##### fEvtBsKpPauseSleep | |
| 1073 | -- **主题**: <sapn class="yellowFill">/manage/\${baseSN}/receive</span> | |
| 1074 | -- **功能描述**:返回暂停键盘休眠开启状态 | |
| 1075 | -- **参数说明** | |
| 1076 | - | |
| 1284 | +##### setBsKpSleepLevel | |
| 1285 | +- **主题**:<sapn class="yellowFill">/manage/\${baseSN}/send</span> | |
| 1286 | +- **功能描述**:设置键盘休眠时间等级 | |
| 1287 | +- **参数说明** | |
| 1288 | + | |
| 1289 | +|参数名|类型|限制|是否必填|说明| | |
| 1290 | +|---|---|---|---|---| | |
| 1291 | +|fun|string|-|是|指令名称| | |
| 1292 | +|dataTag|string|-|否|数据包标识,可为空字符串| | |
| 1293 | +|data|object|-|是|传送参数的对象| | |
| 1294 | +|+value|string||是|设置键盘休眠的时间等级<br>0-30秒<br>1-2分钟<br>2-10分钟<br>3-45分钟| | |
| 1295 | + | |
| 1296 | +- **示例代码** | |
| 1297 | +```json | |
| 1298 | +{ | |
| 1299 | + "fun":"setBsKpSleepLevel", | |
| 1300 | + "dataTag":"1", | |
| 1301 | + "data":{ | |
| 1302 | + "value":"1" | |
| 1303 | + } | |
| 1304 | +} | |
| 1305 | +``` | |
| 1306 | + | |
| 1307 | +##### setBsKpPauseSleep | |
| 1308 | +- **主题**:<sapn class="yellowFill">/manage/\${baseSN}/send</span> | |
| 1309 | +- **功能描述**:设置键盘暂停休眠是否开启<br><font color="red">注意:请谨慎使用本功能,务必在相关测试或功能完成后关闭,否则可能会导致键盘异常耗电<br>设置单次生效,基站拔插后复位成关闭状态</font> | |
| 1310 | +- **参数说明** | |
| 1311 | + | |
| 1312 | +|参数名|类型|限制|是否必填|说明| | |
| 1313 | +|---|---|---|---|---| | |
| 1314 | +|fun|string|-|是|指令名称| | |
| 1315 | +|dataTag|string|-|否|数据包标识,可为空字符串| | |
| 1316 | +|data|object|-|是|传送参数的对象| | |
| 1317 | +|+value|string||是|设置键盘暂停休眠是否开启<br>0-关闭暂停休眠<br>1-开启暂停休眠| | |
| 1318 | + | |
| 1319 | +- **示例代码** | |
| 1320 | +```json | |
| 1321 | +{ | |
| 1322 | + "fun":"setBsKpPauseSleep", | |
| 1323 | + "dataTag":"1", | |
| 1324 | + "data":{ | |
| 1325 | + "value":"1" | |
| 1326 | + } | |
| 1327 | +} | |
| 1328 | +``` | |
| 1329 | + | |
| 1330 | +#### 事件 | |
| 1331 | +##### fEvtBsKpLanguage | |
| 1332 | +- **主题**: /basestation/\${baseSN}/receive | |
| 1333 | +- **功能描述**:返回键盘语言 | |
| 1334 | +- **参数说明** | |
| 1335 | + | |
| 1336 | +|参数名|类型|限制|非空|说明| | |
| 1337 | +|---|---|---|---|---| | |
| 1338 | +|fun|string|-|是|指令名称| | |
| 1339 | +|dataTag|string|-|否|数据包标识,可为空字符串| | |
| 1340 | +|data|object|-|是|传送参数的对象| | |
| 1341 | +|+value|string||是|键盘显示的语言<br>1-简体中文<br>2-英文| | |
| 1342 | + | |
| 1343 | +- **示例代码** | |
| 1344 | +```json | |
| 1345 | +{ | |
| 1346 | + "fun":"fEvtBsKpLanguage", | |
| 1347 | + "dataTag":"1", | |
| 1348 | + "data":{ | |
| 1349 | + "value":"1" | |
| 1350 | + } | |
| 1351 | +} | |
| 1352 | +``` | |
| 1353 | +##### fEvtBsKpStbMsgMode | |
| 1354 | +- **主题**: /basestation/\${baseSN}/receive | |
| 1355 | +- **功能描述**:返回状态语工作状态 | |
| 1356 | +- **参数说明** | |
| 1357 | + | |
| 1358 | +|参数名|类型|限制|非空|说明| | |
| 1359 | +|---|---|---|---|---| | |
| 1360 | +|fun|string|-|是|指令名称| | |
| 1361 | +|dataTag|string|-|否|数据包标识,可为空字符串| | |
| 1362 | +|data|object|-|是|传送参数的对象| | |
| 1363 | +|+value|string||是|返回状态语工作状态<br>0-系统默认<br>1-用户内置| | |
| 1364 | + | |
| 1365 | +- **示例代码** | |
| 1366 | +```json | |
| 1367 | +{ | |
| 1368 | + "fun":"fEvtBsKpStbMsgMode", | |
| 1369 | + "dataTag":"1", | |
| 1370 | + "data":{ | |
| 1371 | + "value":"0" | |
| 1372 | + } | |
| 1373 | +} | |
| 1374 | +``` | |
| 1375 | +##### fEvtBsKpLoginMenu | |
| 1376 | +- **主题**: /basestation/\${baseSN}/receive | |
| 1377 | +- **功能描述**:返回键盘登录菜单显示状态 | |
| 1378 | +- **参数说明** | |
| 1379 | + | |
| 1380 | +|参数名|类型|限制|非空|说明| | |
| 1381 | +|---|---|---|---|---| | |
| 1382 | +|fun|string|-|是|指令名称| | |
| 1383 | +|dataTag|string|-|否|数据包标识,可为空字符串| | |
| 1384 | +|data|object|-|是|传送参数的对象| | |
| 1385 | +|+value|string||是|返回键盘登录菜单显示状态<br>0-不显示<br>1-显示| | |
| 1386 | + | |
| 1387 | +- **示例代码** | |
| 1388 | +```json | |
| 1389 | +{ | |
| 1390 | + "fun":"fEvtBsKpLoginMenu", | |
| 1391 | + "dataTag":"1", | |
| 1392 | + "data":{ | |
| 1393 | + "value":"0" | |
| 1394 | + } | |
| 1395 | +} | |
| 1396 | +``` | |
| 1397 | +##### fEvtBsKpSleepLevel | |
| 1398 | +- **主题**: <sapn class="yellowFill">/manage/\${baseSN}/receive</span> | |
| 1399 | +- **功能描述**:返回键盘休眠时间等级 | |
| 1400 | +- **参数说明** | |
| 1401 | + | |
| 1402 | +|参数名|类型|限制|非空|说明| | |
| 1403 | +|---|---|---|---|---| | |
| 1404 | +|fun|string|-|是|指令名称| | |
| 1405 | +|dataTag|string|-|否|数据包标识,可为空字符串| | |
| 1406 | +|data|object|-|是|传送参数的对象| | |
| 1407 | +|+value|string||是|键盘休眠的时间等级<br>0-30秒<br>1-2分钟<br>2-10分钟<br>3-45分钟| | |
| 1408 | + | |
| 1409 | +- **示例代码** | |
| 1410 | +```json | |
| 1411 | +{ | |
| 1412 | + "fun":"fEvtBsKpSleepLevel", | |
| 1413 | + "dataTag":"1", | |
| 1414 | + "data":{ | |
| 1415 | + "value":"1" | |
| 1416 | + } | |
| 1417 | +} | |
| 1418 | +``` | |
| 1419 | + | |
| 1420 | +##### fEvtBsKpPauseSleep | |
| 1421 | +- **主题**: <sapn class="yellowFill">/manage/\${baseSN}/receive</span> | |
| 1422 | +- **功能描述**:返回暂停键盘休眠开启状态 | |
| 1423 | +- **参数说明** | |
| 1424 | + | |
| 1077 | 1425 | |参数名|类型|限制|非空|说明| |
| 1078 | 1426 | |---|---|---|---|---| |
| 1079 | 1427 | |fun|string|-|是|指令名称| |
| ... | ... | @@ -1082,7 +1430,7 @@ |
| 1082 | 1430 | |+value|string||是|返回暂停键盘休眠开启状态<br>0-未开启暂停休眠<br>1-开启暂停休眠| |
| 1083 | 1431 | |
| 1084 | 1432 | - **示例代码** |
| 1085 | -```Json | |
| 1433 | +```json | |
| 1086 | 1434 | { |
| 1087 | 1435 | "fun":"fEvtBsKpPauseSleep", |
| 1088 | 1436 | "dataTag":"1", |
| ... | ... | @@ -1254,7 +1602,7 @@ |
| 1254 | 1602 | |+keySns|array||是|基站当前的白名单列表| |
| 1255 | 1603 | |
| 1256 | 1604 | - **示例代码** |
| 1257 | -```Json | |
| 1605 | +```json | |
| 1258 | 1606 | { |
| 1259 | 1607 | "fun":"fEvtBsWhitelist", |
| 1260 | 1608 | "dataTag":"1", |
| ... | ... | @@ -1278,7 +1626,7 @@ |
| 1278 | 1626 | |++state|int||是|键盘SN的写入状态 <br>0-写入成功<br> 1-写入失败| |
| 1279 | 1627 | |
| 1280 | 1628 | - **示例代码** |
| 1281 | -```Json | |
| 1629 | +```json | |
| 1282 | 1630 | { |
| 1283 | 1631 | "fun":"fEvtSetBsWhitelist", |
| 1284 | 1632 | "dataTag":"1", |
| ... | ... | @@ -1306,7 +1654,7 @@ |
| 1306 | 1654 | |++state|int||是|键盘的增加状态 <br>0-增加成功<br> 1-增加失败| |
| 1307 | 1655 | |
| 1308 | 1656 | - **示例代码** |
| 1309 | -```Json | |
| 1657 | +```json | |
| 1310 | 1658 | { |
| 1311 | 1659 | "fun":"fEvtAddBsWhitelist", |
| 1312 | 1660 | "dataTag":"1", |
| ... | ... | @@ -1334,7 +1682,7 @@ |
| 1334 | 1682 | |++state|int||是|键盘的删除状态 <br>0-删除成功<br> 1-删除失败| |
| 1335 | 1683 | |
| 1336 | 1684 | - **示例代码** |
| 1337 | -```Json | |
| 1685 | +```json | |
| 1338 | 1686 | { |
| 1339 | 1687 | "fun":"fEvtDelBsWhitelist", |
| 1340 | 1688 | "dataTag":"1", |
| ... | ... | @@ -1361,7 +1709,7 @@ |
| 1361 | 1709 | |dataTag|string|-|否|数据包标识,可为空字符串| |
| 1362 | 1710 | |
| 1363 | 1711 | - **示例代码** |
| 1364 | -```Json | |
| 1712 | +```json | |
| 1365 | 1713 | { |
| 1366 | 1714 | "fun":"getBsTcpipParams", |
| 1367 | 1715 | "dataTag":"1" |
| ... | ... | @@ -1383,7 +1731,7 @@ |
| 1383 | 1731 | |+ipAllocation|int||否|基站IP获取方式<br>0 - 手动指定<br>1 - DHCP获取| |
| 1384 | 1732 | |
| 1385 | 1733 | - **示例代码** |
| 1386 | -```Json | |
| 1734 | +```json | |
| 1387 | 1735 | { |
| 1388 | 1736 | "fun":"setBsTcpipParams", |
| 1389 | 1737 | "dataTag":"1", |
| ... | ... | @@ -1406,7 +1754,7 @@ |
| 1406 | 1754 | |dataTag|string|-|否|数据包标识,可为空字符串| |
| 1407 | 1755 | |
| 1408 | 1756 | - **示例代码** |
| 1409 | -```Json | |
| 1757 | +```json | |
| 1410 | 1758 | { |
| 1411 | 1759 | "fun":"getBsMqttParams", |
| 1412 | 1760 | "dataTag":"1" |
| ... | ... | @@ -1429,7 +1777,7 @@ |
| 1429 | 1777 | |+interval|int|>=10|否|基站连接服务器失败后重连的间隔时长,单位秒| |
| 1430 | 1778 | |
| 1431 | 1779 | - **示例代码** |
| 1432 | -```Json | |
| 1780 | +```json | |
| 1433 | 1781 | { |
| 1434 | 1782 | "fun":"setBsMqttParams", |
| 1435 | 1783 | "dataTag":"1", |
| ... | ... | @@ -1460,7 +1808,7 @@ |
| 1460 | 1808 | |+ipAllocation|int||否|基站IP获取方式<br>0 - 手动指定<br>1 - DHCP获取| |
| 1461 | 1809 | |
| 1462 | 1810 | - **示例代码** |
| 1463 | -```Json | |
| 1811 | +```json | |
| 1464 | 1812 | { |
| 1465 | 1813 | "fun":"fEvtBsTcpipParams", |
| 1466 | 1814 | "dataTag":"1", |
| ... | ... | @@ -1490,7 +1838,7 @@ |
| 1490 | 1838 | |+interval|int|>=10|否|基站连接服务器失败后重连的间隔时长,单位秒| |
| 1491 | 1839 | |
| 1492 | 1840 | - **示例代码** |
| 1493 | -```Json | |
| 1841 | +```json | |
| 1494 | 1842 | { |
| 1495 | 1843 | "fun":"fEvtBsMqttParams", |
| 1496 | 1844 | "dataTag":"1", |
| ... | ... | @@ -1503,6 +1851,70 @@ |
| 1503 | 1851 | } |
| 1504 | 1852 | } |
| 1505 | 1853 | ``` |
| 1854 | +### 基站加密 | |
| 1855 | +#### 方法 | |
| 1856 | +##### getBsSoftwareKey | |
| 1857 | +- **主题**:/client/\${baseSN}/send | |
| 1858 | +- **功能描述**:获取基站软件狗密钥 | |
| 1859 | +- **参数说明** | |
| 1860 | + | |
| 1861 | +|参数名|类型|限制|是否必填|说明| | |
| 1862 | +|---|---|---|---|---| | |
| 1863 | +|fun|string|-|是|指令名称| | |
| 1864 | +|dataTag|string|-|否|数据包标识,可为空字符串| | |
| 1865 | + | |
| 1866 | +- **示例代码** | |
| 1867 | +```json | |
| 1868 | +{ | |
| 1869 | + "fun":"getBsSoftwareKey", | |
| 1870 | + "dataTag":"1" | |
| 1871 | +} | |
| 1872 | +``` | |
| 1873 | +##### setBsSoftwareKey | |
| 1874 | +- **主题**:/client/\${baseSN}/send | |
| 1875 | +- **功能描述**:设置基站软件狗密钥 | |
| 1876 | +- **参数说明** | |
| 1877 | + | |
| 1878 | +|参数名|类型|限制|是否必填|说明| | |
| 1879 | +|---|---|---|---|---| | |
| 1880 | +|fun|string|-|是|指令名称| | |
| 1881 | +|dataTag|string|-|否|数据包标识,可为空字符串| | |
| 1882 | +|data|object|-|是|传送参数的对象| | |
| 1883 | +|+value|string|-|是|基站软件狗密钥,长度不超过32字节| | |
| 1884 | + | |
| 1885 | +- **示例代码** | |
| 1886 | +```json | |
| 1887 | +{ | |
| 1888 | + "fun":"setBsSoftwareKey", | |
| 1889 | + "dataTag":"1", | |
| 1890 | + "data":{ | |
| 1891 | + "value":"sunvote123456" | |
| 1892 | + } | |
| 1893 | +} | |
| 1894 | +``` | |
| 1895 | +#### 事件 | |
| 1896 | +##### fEvtBsSoftwareKey | |
| 1897 | +- **主题**:/basestation/\${baseSN}/receive | |
| 1898 | +- **功能描述**:返回基站的软件狗密钥 | |
| 1899 | +- **参数说明** | |
| 1900 | + | |
| 1901 | +|参数名|类型|限制|非空|说明| | |
| 1902 | +|---|---|---|---|---| | |
| 1903 | +|fun|string|-|是|指令名称| | |
| 1904 | +|dataTag|string|-|否|数据包标识,可为空字符串| | |
| 1905 | +|data|object|-|是|传送参数的对象| | |
| 1906 | +|+value|string||是|返回基站的软件狗密钥| | |
| 1907 | + | |
| 1908 | +- **示例代码** | |
| 1909 | +```json | |
| 1910 | +{ | |
| 1911 | + "fun":"fEvtBsSoftwareKey", | |
| 1912 | + "dataTag":"1", | |
| 1913 | + "data":{ | |
| 1914 | + "value":"sunvote123456" | |
| 1915 | + } | |
| 1916 | +} | |
| 1917 | +``` | |
| 1506 | 1918 | ### 基站维护 |
| 1507 | 1919 | #### 方法 |
| 1508 | 1920 | ##### getBsLogInfo |
| ... | ... | @@ -1516,7 +1928,7 @@ |
| 1516 | 1928 | |dataTag|string|-|否|数据包标识,可为空字符串| |
| 1517 | 1929 | |
| 1518 | 1930 | - **示例代码** |
| 1519 | -```Json | |
| 1931 | +```json | |
| 1520 | 1932 | { |
| 1521 | 1933 | "fun":"getBsLogInfo", |
| 1522 | 1934 | "dataTag":"1" |
| ... | ... | @@ -1534,7 +1946,7 @@ |
| 1534 | 1946 | |dataTag|string|-|否|数据包标识,可为空字符串| |
| 1535 | 1947 | |
| 1536 | 1948 | - **示例代码** |
| 1537 | -```Json | |
| 1949 | +```json | |
| 1538 | 1950 | { |
| 1539 | 1951 | "fun":"resetBsSystem", |
| 1540 | 1952 | "dataTag":"1" |
| ... | ... | @@ -1552,7 +1964,7 @@ |
| 1552 | 1964 | |dataTag|string|-|否|数据包标识,可为空字符串| |
| 1553 | 1965 | |
| 1554 | 1966 | - **示例代码** |
| 1555 | -```Json | |
| 1967 | +```json | |
| 1556 | 1968 | { |
| 1557 | 1969 | "fun":"resetBsPower", |
| 1558 | 1970 | "dataTag":"1" |
| ... | ... | @@ -1567,35 +1979,334 @@ |
| 1567 | 1979 | ##### [sEvtBsConnectState](#sevtbsconnectstate) |
| 1568 | 1980 | 复位基站后,基站重新连接成功后上报 |
| 1569 | 1981 | |
| 1570 | -##### fEvtBsLogInfo | |
| 1571 | -- **主题**: <sapn class="yellowFill">/manage/\${baseSN}/receive</span> | |
| 1572 | -- **功能描述**:返回基站存储的日志内容 | |
| 1982 | +##### fEvtBsLogInfo | |
| 1983 | +- **主题**: <sapn class="yellowFill">/manage/\${baseSN}/receive</span> | |
| 1984 | +- **功能描述**:返回基站存储的日志内容 | |
| 1985 | +- **参数说明** | |
| 1986 | + | |
| 1987 | +|参数名|类型|限制|非空|说明| | |
| 1988 | +|---|---|---|---|---| | |
| 1989 | +|fun|string|-|是|指令名称| | |
| 1990 | +|dataTag|string|-|否|数据包标识,可为空字符串| | |
| 1991 | +|data|object|-|是|传送参数的对象| | |
| 1992 | +|+index|int||是|数据包序号,从1开始,传0代表日志已传完| | |
| 1993 | +|+info|string||是|日志内容<br><font color="red">日志的时间依赖于基站授时,需要加上时区得到具体的时间</font>| | |
| 1994 | + | |
| 1995 | +- **示例代码** | |
| 1996 | +```json | |
| 1997 | +{ | |
| 1998 | + "fun":"fEvtBsLogInfo", | |
| 1999 | + "dataTag":"1", | |
| 2000 | + "data":{ | |
| 2001 | + "index":1, | |
| 2002 | + "info":"XXXXXXXXXXXXX" | |
| 2003 | + } | |
| 2004 | +} | |
| 2005 | +``` | |
| 2006 | +### 基站升级 | |
| 2007 | +#### 方法 | |
| 2008 | +##### startBsUpdate | |
| 2009 | +- **主题**:<sapn class="yellowFill">/manage/\${baseSN}/send</span> | |
| 2010 | +- **功能描述**:基站固件升级 | |
| 2011 | +- **参数说明** | |
| 2012 | + | |
| 2013 | +|参数名|类型|限制|是否必填|说明| | |
| 2014 | +|---|---|---|---|---| | |
| 2015 | +|fun|string|-|是|指令名称| | |
| 2016 | +|dataTag|string|-|否|数据包标识,可为空字符串| | |
| 2017 | +|data|object|-|是|传送参数的对象| | |
| 2018 | +|+partition|int||是|存储区域<br> 1-备份区<font class="yellowFill"> 使用备份区固件的方法:打开基站盖子,按住SW1按钮,然后上电,这时基站固件就会更新成备份区的固件</font><br>2-更新区,实时升级基站固件| | |
| 2019 | +|+url|string||是|待升级的固件地址,可访问的网络url| | |
| 2020 | +|+version|string||是|待升级的基站固件版本| | |
| 2021 | +|+crc|uint||是|固件CRC校验码,10进制数字| | |
| 2022 | +<!-- |+time|string||是|时间,yyyyMMddHHmmss| | |
| 2023 | +|+verCode|string||是|内部主题校验码,时间+固定key加密| --> | |
| 2024 | + | |
| 2025 | +- **示例代码** | |
| 2026 | +```json | |
| 2027 | +{ | |
| 2028 | + "fun":"startBsUpdate", | |
| 2029 | + "dataTag":"1", | |
| 2030 | + "data":{ | |
| 2031 | + "partition":2, | |
| 2032 | + "url":"http://192.168.10.10/V1.0.3.bin", | |
| 2033 | + "version":"1.0.3", | |
| 2034 | + "crc":1429319861 | |
| 2035 | + } | |
| 2036 | +} | |
| 2037 | +``` | |
| 2038 | +##### downloadFontLib | |
| 2039 | +- **主题**:<sapn class="yellowFill">/manage/\${baseSN}/send</span> | |
| 2040 | +- **功能描述**:下载更新基站字库文件 | |
| 2041 | +- **参数说明** | |
| 2042 | + | |
| 2043 | +|参数名|类型|限制|是否必填|说明| | |
| 2044 | +|---|---|---|---|---| | |
| 2045 | +|fun|string|-|是|指令名称| | |
| 2046 | +|dataTag|string|-|否|数据包标识,可为空字符串| | |
| 2047 | +|data|object|-|是|传送参数的对象| | |
| 2048 | +|+partition|int||是|存储区域<br> 1-备份区<br>2-更新区| | |
| 2049 | +|+url|string||是|待下载的字库地址,可访问的网络url| | |
| 2050 | +|+version|string||是|待升级的字库版本| | |
| 2051 | +|+crc|int||是|字库CRC校验码,10进制数字| | |
| 2052 | +<!-- |+time|string||是|时间,yyyyMMddHHmmss| | |
| 2053 | +|+verCode|string||是|内部主题校验码,时间+固定key加密| --> | |
| 2054 | + | |
| 2055 | +- **示例代码** | |
| 2056 | +```json | |
| 2057 | +{ | |
| 2058 | + "fun":"downloadFontLib", | |
| 2059 | + "dataTag":"1", | |
| 2060 | + "data":{ | |
| 2061 | + "partition":2, | |
| 2062 | + "url":"http://192.168.10.10/V1.0.3.bin", | |
| 2063 | + "version":"1.0.3", | |
| 2064 | + "crc":1429319861 | |
| 2065 | + } | |
| 2066 | +} | |
| 2067 | +``` | |
| 2068 | + | |
| 2069 | +#### 事件 | |
| 2070 | +##### [sEvtStateCode](#sevtstatecode) | |
| 2071 | +返回升级指令的接收状态 | |
| 2072 | +注意:升级指令的接收状态需从**主题: <sapn class="yellowFill">/manage/\${baseSN}/receive</span>** 返回 | |
| 2073 | + | |
| 2074 | +##### fEvtBsUpateState | |
| 2075 | +- **主题**: <sapn class="yellowFill">/manage/\${baseSN}/receive</span> | |
| 2076 | +- **功能描述**:返回基站启动升级状态 | |
| 2077 | +- **参数说明** | |
| 2078 | + | |
| 2079 | +|参数名|类型|限制|非空|说明| | |
| 2080 | +|---|---|---|---|---| | |
| 2081 | +|fun|string|-|是|指令名称| | |
| 2082 | +|dataTag|string|-|否|数据包标识,可为空字符串| | |
| 2083 | +|data|object|-|是|传送参数的对象| | |
| 2084 | +|+state|int||是|启动升级状态<br>0 - 准备升级<br>1 - 升级成功<br>2 - 升级失败 | |
| 2085 | +|+msg|string||否|返回的失败原因 | |
| 2086 | + | |
| 2087 | +- **示例代码** | |
| 2088 | +```json | |
| 2089 | +{ | |
| 2090 | + "fun":"fEvtBsUpateState", | |
| 2091 | + "dataTag":"1", | |
| 2092 | + "data":{ | |
| 2093 | + "state":2, | |
| 2094 | + "msg":"error msg" | |
| 2095 | + } | |
| 2096 | +} | |
| 2097 | +``` | |
| 2098 | + | |
| 2099 | +##### fEvtBsUpdateProgress | |
| 2100 | +- **主题**: <sapn class="yellowFill">/manage/\${baseSN}/receive</span> | |
| 2101 | +- **功能描述**:返回基站升级进度 | |
| 2102 | +- **参数说明** | |
| 2103 | + | |
| 2104 | +|参数名|类型|限制|非空|说明| | |
| 2105 | +|---|---|---|---|---| | |
| 2106 | +|fun|string|-|是|指令名称| | |
| 2107 | +|dataTag|string|-|否|数据包标识,可为空字符串| | |
| 2108 | +|data|object|-|是|传送参数的对象| | |
| 2109 | +|+progress|int||是|升级进度,百分比| | |
| 2110 | + | |
| 2111 | +- **示例代码** | |
| 2112 | +```json | |
| 2113 | +{ | |
| 2114 | + "fun":"fEvtBsUpdateProgress", | |
| 2115 | + "dataTag":"1", | |
| 2116 | + "data":{ | |
| 2117 | + "progress":20 | |
| 2118 | + } | |
| 2119 | +} | |
| 2120 | +``` | |
| 2121 | + | |
| 2122 | +##### fEvtBsFontLibState | |
| 2123 | +- **主题**: <sapn class="yellowFill">/manage/\${baseSN}/receive</span> | |
| 2124 | +- **功能描述**:返回基站下载字库状态 | |
| 2125 | +- **参数说明** | |
| 2126 | + | |
| 2127 | +|参数名|类型|限制|非空|说明| | |
| 2128 | +|---|---|---|---|---| | |
| 2129 | +|fun|string|-|是|指令名称| | |
| 2130 | +|dataTag|string|-|否|数据包标识,可为空字符串| | |
| 2131 | +|data|object|-|是|传送参数的对象| | |
| 2132 | +|+state|int||是|启动升级状态<br>0 - 准备下载<br>1 - 下载完成<br>2 - 下载失败 | |
| 2133 | +|+msg|string||否|返回的失败原因 | |
| 2134 | + | |
| 2135 | +- **示例代码** | |
| 2136 | +```json | |
| 2137 | +{ | |
| 2138 | + "fun":"fEvtBsFontLibState", | |
| 2139 | + "dataTag":"1", | |
| 2140 | + "data":{ | |
| 2141 | + "state":2, | |
| 2142 | + "msg":"error msg" | |
| 2143 | + } | |
| 2144 | +} | |
| 2145 | +``` | |
| 2146 | + | |
| 2147 | +##### fEvtBsFontLibProgress | |
| 2148 | +- **主题**: <sapn class="yellowFill">/manage/\${baseSN}/receive</span> | |
| 2149 | +- **功能描述**:返回基站下载字库进度 | |
| 2150 | +- **参数说明** | |
| 2151 | + | |
| 2152 | +|参数名|类型|限制|非空|说明| | |
| 2153 | +|---|---|---|---|---| | |
| 2154 | +|fun|string|-|是|指令名称| | |
| 2155 | +|dataTag|string|-|否|数据包标识,可为空字符串| | |
| 2156 | +|data|object|-|是|传送参数的对象| | |
| 2157 | +|+progress|int||是|下载进度,百分比| | |
| 2158 | + | |
| 2159 | +- **示例代码** | |
| 2160 | +```json | |
| 2161 | +{ | |
| 2162 | + "fun":"fEvtBsFontLibProgress", | |
| 2163 | + "dataTag":"1", | |
| 2164 | + "data":{ | |
| 2165 | + "progress":20 | |
| 2166 | + } | |
| 2167 | +} | |
| 2168 | +``` | |
| 2169 | + | |
| 2170 | +## 键盘管理 | |
| 2171 | +### 识别设置 | |
| 2172 | +#### 方法 | |
| 2173 | +##### setKpSN | |
| 2174 | +- **主题**:<sapn class="yellowFill">/manage/\${baseSN}/send</span> | |
| 2175 | +- **功能描述**:设置指定键盘的出厂编码 | |
| 2176 | +- **参数说明** | |
| 2177 | + | |
| 2178 | +|参数名|类型|限制|是否必填|说明| | |
| 2179 | +|---|---|---|---|---| | |
| 2180 | +|fun|string|-|是|指令名称| | |
| 2181 | +|dataTag|string|-|否|数据包标识,可为空字符串| | |
| 2182 | +|data|object|-|是|传送参数的对象| | |
| 2183 | +|+oldKeySn|string||是|键盘原SN| | |
| 2184 | +|+newKeySn|string||是|待设置的新SN| | |
| 2185 | +|+time|string|数字|是|时间,yyyyMMddHHmmss| | |
| 2186 | +|+verCode|string||是|内部主题校验码,时间+固定key加密| | |
| 2187 | + | |
| 2188 | +- **示例代码** | |
| 2189 | +```json | |
| 2190 | +{ | |
| 2191 | + "fun":"setKpIdentityMode", | |
| 2192 | + "dataTag":"1", | |
| 2193 | + "data":{ | |
| 2194 | + "oldKeySn":"1234567890", | |
| 2195 | + "newKeySn":"2024021011" | |
| 2196 | + } | |
| 2197 | +} | |
| 2198 | +``` | |
| 2199 | +##### getKpID | |
| 2200 | +- **主题**:/client/\${baseSN}/send | |
| 2201 | +- **功能描述**:获取键盘编号 | |
| 2202 | +- **参数说明** | |
| 2203 | + | |
| 2204 | +|参数名|类型|限制|是否必填|说明| | |
| 2205 | +|---|---|---|---|---| | |
| 2206 | +|fun|string|-|是|指令名称| | |
| 2207 | +|dataTag|string|-|否|数据包标识,可为空字符串| | |
| 2208 | +|data|object|-|是|传送参数的对象| | |
| 2209 | +|+keySn|string||是|需读取编号的键盘SN| | |
| 2210 | + | |
| 2211 | +- **示例代码** | |
| 2212 | +```json | |
| 2213 | +{ | |
| 2214 | + "fun":"getKpID", | |
| 2215 | + "dataTag":"1", | |
| 2216 | + "data":{ | |
| 2217 | + "keySn":"2024021011" | |
| 2218 | + } | |
| 2219 | +} | |
| 2220 | +``` | |
| 2221 | +##### setKpID | |
| 2222 | +- **主题**:/client/\${baseSN}/send | |
| 2223 | +- **功能描述**:设置键盘编号 | |
| 2224 | +- **参数说明** | |
| 2225 | + | |
| 2226 | +|参数名|类型|限制|是否必填|说明| | |
| 2227 | +|---|---|---|---|---| | |
| 2228 | +|fun|string|-|是|指令名称| | |
| 2229 | +|dataTag|string|-|否|数据包标识,可为空字符串| | |
| 2230 | +|data|object|-|是|传送参数的对象| | |
| 2231 | +|+keySn|string||是|需设置编号的键盘SN| | |
| 2232 | +|+keyId|int||是|键盘编号,不超过65535| | |
| 2233 | +- **示例代码** | |
| 2234 | +```json | |
| 2235 | +{ | |
| 2236 | + "fun":"setKpID", | |
| 2237 | + "dataTag":"1", | |
| 2238 | + "data":{ | |
| 2239 | + "keySn":"2024021011", | |
| 2240 | + "keyId":1 | |
| 2241 | + } | |
| 2242 | +} | |
| 2243 | +``` | |
| 2244 | +##### getKpModel | |
| 2245 | +- **主题**:/client/\${baseSN}/send | |
| 2246 | +- **功能描述**:获取键盘型号 | |
| 2247 | +- **参数说明** | |
| 2248 | + | |
| 2249 | +|参数名|类型|限制|是否必填|说明| | |
| 2250 | +|---|---|---|---|---| | |
| 2251 | +|fun|string|-|是|指令名称| | |
| 2252 | +|dataTag|string|-|否|数据包标识,可为空字符串| | |
| 2253 | +|data|object|-|是|传送参数的对象| | |
| 2254 | +|+keySn|string||是|需读取型号的键盘SN| | |
| 2255 | + | |
| 2256 | +- **示例代码** | |
| 2257 | +```json | |
| 2258 | +{ | |
| 2259 | + "fun":"getKpModel", | |
| 2260 | + "dataTag":"1", | |
| 2261 | + "data":{ | |
| 2262 | + "keySn":"2024021011" | |
| 2263 | + } | |
| 2264 | +} | |
| 2265 | +``` | |
| 2266 | + | |
| 2267 | +##### getKpFWVersion | |
| 2268 | +- **主题**:/client/\${baseSN}/send | |
| 2269 | +- **功能描述**:获取键盘型号 | |
| 1573 | 2270 | - **参数说明** |
| 1574 | 2271 | |
| 1575 | -|参数名|类型|限制|非空|说明| | |
| 2272 | +|参数名|类型|限制|是否必填|说明| | |
| 1576 | 2273 | |---|---|---|---|---| |
| 1577 | 2274 | |fun|string|-|是|指令名称| |
| 1578 | 2275 | |dataTag|string|-|否|数据包标识,可为空字符串| |
| 1579 | 2276 | |data|object|-|是|传送参数的对象| |
| 1580 | -|+index|int||是|数据包序号,从1开始,传0代表日志已传完| | |
| 1581 | -|+info|string||是|日志内容<br><font color="red">日志的时间依赖于基站授时,需要加上时区得到具体的时间</font>| | |
| 2277 | +|+keySn|string||是|需读取版本的键盘SN| | |
| 1582 | 2278 | |
| 1583 | 2279 | - **示例代码** |
| 1584 | -```Json | |
| 2280 | +```json | |
| 1585 | 2281 | { |
| 1586 | - "fun":"fEvtBsLogInfo", | |
| 2282 | + "fun":"getKpFWVersion", | |
| 1587 | 2283 | "dataTag":"1", |
| 1588 | 2284 | "data":{ |
| 1589 | - "index":1, | |
| 1590 | - "info":"XXXXXXXXXXXXX" | |
| 2285 | + "keySn":"2024021011" | |
| 1591 | 2286 | } |
| 1592 | 2287 | } |
| 1593 | 2288 | ``` |
| 1594 | -### 基站升级 | |
| 1595 | -#### 方法 | |
| 1596 | -##### startBsUpdate | |
| 2289 | + | |
| 2290 | +##### getKpIdentityMode | |
| 2291 | +- **主题**:/client/\${baseSN}/send | |
| 2292 | +- **功能描述**:获取键盘识别模式 | |
| 2293 | +- **参数说明** | |
| 2294 | + | |
| 2295 | +|参数名|类型|限制|是否必填|说明| | |
| 2296 | +|---|---|---|---|---| | |
| 2297 | +|fun|string|-|是|指令名称| | |
| 2298 | +|dataTag|string|-|否|数据包标识,可为空字符串| | |
| 2299 | + | |
| 2300 | +- **示例代码** | |
| 2301 | +```json | |
| 2302 | +{ | |
| 2303 | + "fun":"getKpIdentityMode", | |
| 2304 | + "dataTag":"1" | |
| 2305 | +} | |
| 2306 | +``` | |
| 2307 | +##### setKpIdentityMode | |
| 1597 | 2308 | - **主题**:<sapn class="yellowFill">/manage/\${baseSN}/send</span> |
| 1598 | -- **功能描述**:基站固件升级 | |
| 2309 | +- **功能描述**:设置键盘识别模式 | |
| 1599 | 2310 | - **参数说明** |
| 1600 | 2311 | |
| 1601 | 2312 | |参数名|类型|限制|是否必填|说明| |
| ... | ... | @@ -1603,65 +2314,46 @@ |
| 1603 | 2314 | |fun|string|-|是|指令名称| |
| 1604 | 2315 | |dataTag|string|-|否|数据包标识,可为空字符串| |
| 1605 | 2316 | |data|object|-|是|传送参数的对象| |
| 1606 | -|+partition|int||是|存储区域<br> 1-备份区 <font class="yellowFill"> 使用备份区固件的方法:打开基站盖子,按住SW1按钮,然后上电,这时基站固件就会更新成备份区的固件</font><br>2-更新区| | |
| 1607 | -|+url|string||是|待升级的固件地址,可访问的网络url| | |
| 1608 | -|+version|string||是|待升级的基站固件版本| | |
| 1609 | -|+crc|uint||是|固件CRC校验码,10进制数字| | |
| 1610 | -<!-- |+time|string||是|时间,yyyyMMddHHmmss| | |
| 1611 | -|+verCode|string||是|内部主题校验码,时间+固定key加密| --> | |
| 2317 | +|+value|string||是|设置键盘识别模式<br>0 - SN模式<br>1 - ID+SN模式| | |
| 2318 | +|+time|string|数字|是|时间,yyyyMMddHHmmss| | |
| 2319 | +|+verCode|string||是|内部主题校验码,时间+固定key加密| | |
| 1612 | 2320 | |
| 1613 | 2321 | - **示例代码** |
| 1614 | -```Json | |
| 2322 | +```json | |
| 1615 | 2323 | { |
| 1616 | - "fun":"startBsUpdate", | |
| 2324 | + "fun":"setKpIdentityMode", | |
| 1617 | 2325 | "dataTag":"1", |
| 1618 | 2326 | "data":{ |
| 1619 | - "partition":2, | |
| 1620 | - "url":"http://192.168.10.10/V1.0.3.bin", | |
| 1621 | - "version":"1.0.3", | |
| 1622 | - "crc":1429319861 | |
| 2327 | + "value":"0" | |
| 1623 | 2328 | } |
| 1624 | 2329 | } |
| 1625 | 2330 | ``` |
| 1626 | -##### downloadFontLib | |
| 1627 | -- **主题**:<sapn class="yellowFill">/manage/\${baseSN}/send</span> | |
| 1628 | -- **功能描述**:下载更新基站字库文件 | |
| 2331 | +#### 事件 | |
| 2332 | +##### fEvtKpIdentityMode | |
| 2333 | +- **主题**:/basestation/\${baseSN}/receive | |
| 2334 | +- **功能描述**:返回键盘识别模式 | |
| 1629 | 2335 | - **参数说明** |
| 1630 | 2336 | |
| 1631 | -|参数名|类型|限制|是否必填|说明| | |
| 2337 | +|参数名|类型|限制|非空|说明| | |
| 1632 | 2338 | |---|---|---|---|---| |
| 1633 | 2339 | |fun|string|-|是|指令名称| |
| 1634 | 2340 | |dataTag|string|-|否|数据包标识,可为空字符串| |
| 1635 | 2341 | |data|object|-|是|传送参数的对象| |
| 1636 | -|+partition|int||是|存储区域<br> 1-备份区<br>2-更新区| | |
| 1637 | -|+url|string||是|待下载的字库地址,可访问的网络url| | |
| 1638 | -|+version|string||是|待升级的字库版本| | |
| 1639 | -|+crc|int||是|字库CRC校验码,10进制数字| | |
| 1640 | -<!-- |+time|string||是|时间,yyyyMMddHHmmss| | |
| 1641 | -|+verCode|string||是|内部主题校验码,时间+固定key加密| --> | |
| 2342 | +|+value|string||是|设置键盘识别模式<br>0 - SN模式<br>1 - ID+SN模式| | |
| 1642 | 2343 | |
| 1643 | 2344 | - **示例代码** |
| 1644 | -```Json | |
| 2345 | +```json | |
| 1645 | 2346 | { |
| 1646 | - "fun":"downloadFontLib", | |
| 2347 | + "fun":"fEvtKpIdentityMode", | |
| 1647 | 2348 | "dataTag":"1", |
| 1648 | 2349 | "data":{ |
| 1649 | - "partition":2, | |
| 1650 | - "url":"http://192.168.10.10/V1.0.3.bin", | |
| 1651 | - "version":"1.0.3", | |
| 1652 | - "crc":1429319861 | |
| 2350 | + "value":"0" | |
| 1653 | 2351 | } |
| 1654 | 2352 | } |
| 1655 | 2353 | ``` |
| 1656 | - | |
| 1657 | -#### 事件 | |
| 1658 | -##### [sEvtStateCode](#sevtstatecode) | |
| 1659 | -返回升级指令的接收状态 | |
| 1660 | -注意:升级指令的接收状态需从**主题: <sapn class="yellowFill">/manage/\${baseSN}/receive</span>** 返回 | |
| 1661 | - | |
| 1662 | -##### fEvtBsUpateState | |
| 1663 | -- **主题**: <sapn class="yellowFill">/manage/\${baseSN}/receive</span> | |
| 1664 | -- **功能描述**:返回基站启动升级状态 | |
| 2354 | +##### fEvtKpSN | |
| 2355 | +- **主题**:<sapn class="yellowFill">/manage/\${baseSN}/receive</span> | |
| 2356 | +- **功能描述**:返回写键盘SN状态 | |
| 1665 | 2357 | - **参数说明** |
| 1666 | 2358 | |
| 1667 | 2359 | |参数名|类型|限制|非空|说明| |
| ... | ... | @@ -1669,24 +2361,23 @@ |
| 1669 | 2361 | |fun|string|-|是|指令名称| |
| 1670 | 2362 | |dataTag|string|-|否|数据包标识,可为空字符串| |
| 1671 | 2363 | |data|object|-|是|传送参数的对象| |
| 1672 | -|+state|int||是|启动升级状态<br>0 - 准备升级<br>1 - 升级成功<br>2 - 升级失败 | |
| 1673 | -|+msg|string||否|返回的失败原因 | |
| 2364 | +|+keySn|string||是|设置键盘SN的原SN| | |
| 2365 | +|+state|string||是|设置是否成功<br>0-设置成功<br>1-设置失败| | |
| 1674 | 2366 | |
| 1675 | 2367 | - **示例代码** |
| 1676 | -```Json | |
| 2368 | +```json | |
| 1677 | 2369 | { |
| 1678 | - "fun":"fEvtBsUpateState", | |
| 2370 | + "fun":"fEvtKpSN", | |
| 1679 | 2371 | "dataTag":"1", |
| 1680 | 2372 | "data":{ |
| 1681 | - "state":2, | |
| 1682 | - "msg":"error msg" | |
| 2373 | + "keySn":"1234567890", | |
| 2374 | + "state":"0" | |
| 1683 | 2375 | } |
| 1684 | 2376 | } |
| 1685 | 2377 | ``` |
| 1686 | - | |
| 1687 | -##### fEvtBsUpdateProgress | |
| 1688 | -- **主题**: <sapn class="yellowFill">/manage/\${baseSN}/receive</span> | |
| 1689 | -- **功能描述**:返回基站升级进度 | |
| 2378 | +##### fEvtKpID | |
| 2379 | +- **主题**:/basestation/\${baseSN}/receive | |
| 2380 | +- **功能描述**:返回键盘编号 | |
| 1690 | 2381 | - **参数说明** |
| 1691 | 2382 | |
| 1692 | 2383 | |参数名|类型|限制|非空|说明| |
| ... | ... | @@ -1694,22 +2385,23 @@ |
| 1694 | 2385 | |fun|string|-|是|指令名称| |
| 1695 | 2386 | |dataTag|string|-|否|数据包标识,可为空字符串| |
| 1696 | 2387 | |data|object|-|是|传送参数的对象| |
| 1697 | -|+progress|int||是|升级进度,百分比| | |
| 2388 | +|+keySn|string||是|设置键盘SN的原SN| | |
| 2389 | +|+keyId|int||是|键盘编号| | |
| 1698 | 2390 | |
| 1699 | 2391 | - **示例代码** |
| 1700 | -```Json | |
| 2392 | +```json | |
| 1701 | 2393 | { |
| 1702 | - "fun":"fEvtBsUpdateProgress", | |
| 2394 | + "fun":"fEvtKpID", | |
| 1703 | 2395 | "dataTag":"1", |
| 1704 | 2396 | "data":{ |
| 1705 | - "progress":20 | |
| 2397 | + "keySn":"2024021011", | |
| 2398 | + "keyId":11 | |
| 1706 | 2399 | } |
| 1707 | 2400 | } |
| 1708 | 2401 | ``` |
| 1709 | - | |
| 1710 | -##### fEvtBsFontLibState | |
| 1711 | -- **主题**: <sapn class="yellowFill">/manage/\${baseSN}/receive</span> | |
| 1712 | -- **功能描述**:返回基站下载字库状态 | |
| 2402 | +##### fEvtKpModel | |
| 2403 | +- **主题**:/basestation/\${baseSN}/receive | |
| 2404 | +- **功能描述**:返回键盘型号 | |
| 1713 | 2405 | - **参数说明** |
| 1714 | 2406 | |
| 1715 | 2407 | |参数名|类型|限制|非空|说明| |
| ... | ... | @@ -1717,24 +2409,24 @@ |
| 1717 | 2409 | |fun|string|-|是|指令名称| |
| 1718 | 2410 | |dataTag|string|-|否|数据包标识,可为空字符串| |
| 1719 | 2411 | |data|object|-|是|传送参数的对象| |
| 1720 | -|+state|int||是|启动升级状态<br>0 - 准备下载<br>1 - 下载完成<br>2 - 下载失败 | |
| 1721 | -|+msg|string||否|返回的失败原因 | |
| 2412 | +|+keySn|string||是|设置键盘SN的原SN| | |
| 2413 | +|+model|int||是|键盘型号代码| | |
| 1722 | 2414 | |
| 1723 | 2415 | - **示例代码** |
| 1724 | -```Json | |
| 2416 | +```json | |
| 1725 | 2417 | { |
| 1726 | - "fun":"fEvtBsFontLibState", | |
| 2418 | + "fun":"fEvtKpModel", | |
| 1727 | 2419 | "dataTag":"1", |
| 1728 | 2420 | "data":{ |
| 1729 | - "state":2, | |
| 1730 | - "msg":"error msg" | |
| 2421 | + "keySn":"2024021011", | |
| 2422 | + "model":67 | |
| 1731 | 2423 | } |
| 1732 | 2424 | } |
| 1733 | 2425 | ``` |
| 1734 | 2426 | |
| 1735 | -##### fEvtBsFontLibProgress | |
| 1736 | -- **主题**: <sapn class="yellowFill">/manage/\${baseSN}/receive</span> | |
| 1737 | -- **功能描述**:返回基站下载字库进度 | |
| 2427 | +##### fEvtKpFWVersion | |
| 2428 | +- **主题**:/basestation/\${baseSN}/receive | |
| 2429 | +- **功能描述**:返回键盘型号 | |
| 1738 | 2430 | - **参数说明** |
| 1739 | 2431 | |
| 1740 | 2432 | |参数名|类型|限制|非空|说明| |
| ... | ... | @@ -1742,20 +2434,21 @@ |
| 1742 | 2434 | |fun|string|-|是|指令名称| |
| 1743 | 2435 | |dataTag|string|-|否|数据包标识,可为空字符串| |
| 1744 | 2436 | |data|object|-|是|传送参数的对象| |
| 1745 | -|+progress|int||是|下载进度,百分比| | |
| 2437 | +|+keySn|string||是|设置键盘SN的原SN| | |
| 2438 | +|+version|string||是|键盘固件版本| | |
| 1746 | 2439 | |
| 1747 | 2440 | - **示例代码** |
| 1748 | -```Json | |
| 2441 | +```json | |
| 1749 | 2442 | { |
| 1750 | - "fun":"fEvtBsFontLibProgress", | |
| 2443 | + "fun":"fEvtKpFWVersion", | |
| 1751 | 2444 | "dataTag":"1", |
| 1752 | 2445 | "data":{ |
| 1753 | - "progress":20 | |
| 2446 | + "keySn":"2024021011", | |
| 2447 | + "version":"1.0.0" | |
| 1754 | 2448 | } |
| 1755 | 2449 | } |
| 1756 | 2450 | ``` |
| 1757 | 2451 | |
| 1758 | -## 键盘管理 | |
| 1759 | 2452 | ### 交互设置 |
| 1760 | 2453 | #### 方法 |
| 1761 | 2454 | ##### setKpUserStbMsg |
| ... | ... | @@ -1774,7 +2467,7 @@ |
| 1774 | 2467 | |+submitted|string||是|已提交状态语<br>空字符串清除| |
| 1775 | 2468 | |
| 1776 | 2469 | - **示例代码** |
| 1777 | -```Json | |
| 2470 | +```json | |
| 1778 | 2471 | { |
| 1779 | 2472 | "fun":"setKpUserStbMsg", |
| 1780 | 2473 | "dataTag":"1", |
| ... | ... | @@ -1845,7 +2538,7 @@ |
| 1845 | 2538 | |+state|string||是|设置状态语是否成功<br> 0 - 成功<br> 1 - 失败| |
| 1846 | 2539 | |
| 1847 | 2540 | - **示例代码** |
| 1848 | -```Json | |
| 2541 | +```json | |
| 1849 | 2542 | { |
| 1850 | 2543 | "fun":"fEvtKpUserStbMsg", |
| 1851 | 2544 | "dataTag":"1", |
| ... | ... | @@ -1946,7 +2639,7 @@ |
| 1946 | 2639 | |+voltage|double||是|键盘电量<font color="red">(待键盘修改成百分比)</font>| |
| 1947 | 2640 | |
| 1948 | 2641 | - **示例代码** |
| 1949 | -```Json | |
| 2642 | +```json | |
| 1950 | 2643 | { |
| 1951 | 2644 | "fun":"fEvtKpOnlineMsg", |
| 1952 | 2645 | "dataTag":"1", |
| ... | ... | @@ -1974,7 +2667,7 @@ |
| 1974 | 2667 | |+keySns|array||否|需要执行指令的键盘SN数组,<br>空数组表示所有键盘| |
| 1975 | 2668 | |
| 1976 | 2669 | - **示例代码** |
| 1977 | -```Json | |
| 2670 | +```json | |
| 1978 | 2671 | { |
| 1979 | 2672 | "fun":"remoteKpPowerOff", |
| 1980 | 2673 | "dataTag":"1", |
| ... | ... | @@ -1996,7 +2689,7 @@ |
| 1996 | 2689 | |+keySns|array||否|需要执行指令的键盘SN数组,空数组表示所有键盘| |
| 1997 | 2690 | |
| 1998 | 2691 | - **示例代码** |
| 1999 | -```Json | |
| 2692 | +```json | |
| 2000 | 2693 | { |
| 2001 | 2694 | "fun":"remoteKpSleep", |
| 2002 | 2695 | "dataTag":"1", |
| ... | ... | @@ -2023,7 +2716,7 @@ |
| 2023 | 2716 | |+verCode|string||是|内部主题校验码,时间+固定key加密| --> |
| 2024 | 2717 | |
| 2025 | 2718 | - **示例代码** |
| 2026 | -```Json | |
| 2719 | +```json | |
| 2027 | 2720 | { |
| 2028 | 2721 | "fun":"startKpFWUpdate", |
| 2029 | 2722 | "dataTag":"1", |
| ... | ... | @@ -2049,7 +2742,7 @@ |
| 2049 | 2742 | |+verCode|string||是|内部主题校验码,时间+固定key加密| --> |
| 2050 | 2743 | |
| 2051 | 2744 | - **示例代码** |
| 2052 | -```Json | |
| 2745 | +```json | |
| 2053 | 2746 | { |
| 2054 | 2747 | "fun":"stopKpFWUpdate", |
| 2055 | 2748 | "dataTag":"1" |
| ... | ... | @@ -2075,7 +2768,7 @@ |
| 2075 | 2768 | |+msg|string||否|返回的失败原因 |
| 2076 | 2769 | |
| 2077 | 2770 | - **示例代码** |
| 2078 | -```Json | |
| 2771 | +```json | |
| 2079 | 2772 | { |
| 2080 | 2773 | "fun":"fEvtKpFWUpdateState", |
| 2081 | 2774 | "dataTag":"1", |
| ... | ... | @@ -2098,7 +2791,7 @@ |
| 2098 | 2791 | |+progress|int||是|升级进度,百分比| |
| 2099 | 2792 | |
| 2100 | 2793 | - **示例代码** |
| 2101 | -```Json | |
| 2794 | +```json | |
| 2102 | 2795 | { |
| 2103 | 2796 | "fun":"fEvtKpUpdateProgress", |
| 2104 | 2797 | "dataTag":"1", |
| ... | ... | @@ -2239,7 +2932,7 @@ |
| 2239 | 2932 | |+tipTitle |string|-|否| 提示标题,长度最多不超过16个字节| |
| 2240 | 2933 | |
| 2241 | 2934 | - **示例代码** |
| 2242 | -```Json | |
| 2935 | +```json | |
| 2243 | 2936 | //按键签到 |
| 2244 | 2937 | { |
| 2245 | 2938 | "fun":"startKpSignIn", |
| ... | ... | @@ -2264,8 +2957,7 @@ |
| 2264 | 2957 | } |
| 2265 | 2958 | } |
| 2266 | 2959 | ``` |
| 2267 | - | |
| 2268 | -##### stopKpSignIn | |
| 2960 | +<!-- ##### stopKpSignIn | |
| 2269 | 2961 | - **主题**:/client/\${baseSN}/send |
| 2270 | 2962 | - **功能描述**:停止同步签到 |
| 2271 | 2963 | - **参数说明** |
| ... | ... | @@ -2276,12 +2968,15 @@ |
| 2276 | 2968 | |dataTag|string|-|否|数据包标识,可为空字符串| |
| 2277 | 2969 | |
| 2278 | 2970 | - **示例代码** |
| 2279 | -```Json | |
| 2971 | +```json | |
| 2280 | 2972 | { |
| 2281 | 2973 | "fun":"stopKpSignIn", |
| 2282 | 2974 | "dataTag":"1" |
| 2283 | 2975 | } |
| 2284 | -``` | |
| 2976 | +``` --> | |
| 2977 | +##### [stopKpVote](#stopkpvote) | |
| 2978 | +停止同步签到 | |
| 2979 | + | |
| 2285 | 2980 | #### 事件 |
| 2286 | 2981 | ##### [sEvtStateCode](#sevtstatecode) |
| 2287 | 2982 | 发送指令后返回接收状态 |
| ... | ... | @@ -2452,7 +3147,7 @@ |
| 2452 | 3147 | } |
| 2453 | 3148 | } |
| 2454 | 3149 | ``` |
| 2455 | -##### stopQATrueFalse | |
| 3150 | +<!-- ##### stopQATrueFalse | |
| 2456 | 3151 | - **主题**:/client/\${baseSN}/send |
| 2457 | 3152 | - **功能描述**:停止判断题答题 |
| 2458 | 3153 | - **参数说明** |
| ... | ... | @@ -2468,7 +3163,11 @@ |
| 2468 | 3163 | "fun":"stopQATrueFalse", |
| 2469 | 3164 | "dataTag":"1" |
| 2470 | 3165 | } |
| 2471 | -``` | |
| 3166 | +``` --> | |
| 3167 | + | |
| 3168 | +##### [stopKpVote](#stopkpvote) | |
| 3169 | +停止判断题答题 | |
| 3170 | + | |
| 2472 | 3171 | #### 事件 |
| 2473 | 3172 | ##### [sEvtStateCode](#sevtstatecode) |
| 2474 | 3173 | 发送指令后返回接收状态 |
| ... | ... | @@ -2543,7 +3242,7 @@ |
| 2543 | 3242 | } |
| 2544 | 3243 | } |
| 2545 | 3244 | ``` |
| 2546 | -##### stopQAChoice | |
| 3245 | +<!-- ##### stopQAChoice | |
| 2547 | 3246 | - **主题**:/client/\${baseSN}/send |
| 2548 | 3247 | - **功能描述**:停止选择题答题 |
| 2549 | 3248 | - **参数说明** |
| ... | ... | @@ -2559,7 +3258,10 @@ |
| 2559 | 3258 | "fun":"stopQAChoice", |
| 2560 | 3259 | "dataTag":"1" |
| 2561 | 3260 | } |
| 2562 | -``` | |
| 3261 | +``` --> | |
| 3262 | +##### [stopKpVote](#stopkpvote) | |
| 3263 | +停止选择题答题 | |
| 3264 | + | |
| 2563 | 3265 | #### 事件 |
| 2564 | 3266 | ##### [sEvtStateCode](#sevtstatecode) |
| 2565 | 3267 | 发送指令后返回接收状态 |
| ... | ... | @@ -2631,7 +3333,7 @@ |
| 2631 | 3333 | } |
| 2632 | 3334 | } |
| 2633 | 3335 | ``` |
| 2634 | -##### stopQANum | |
| 3336 | +<!-- ##### stopQANum | |
| 2635 | 3337 | - **主题**:/client/\${baseSN}/send |
| 2636 | 3338 | - **功能描述**:停止数字题答题 |
| 2637 | 3339 | - **参数说明** |
| ... | ... | @@ -2647,7 +3349,10 @@ |
| 2647 | 3349 | "fun":"stopQANum", |
| 2648 | 3350 | "dataTag":"1" |
| 2649 | 3351 | } |
| 2650 | -``` | |
| 3352 | +``` --> | |
| 3353 | +##### [stopKpVote](#stopkpvote) | |
| 3354 | +停止数字题答题 | |
| 3355 | + | |
| 2651 | 3356 | #### 事件 |
| 2652 | 3357 | ##### [sEvtStateCode](#sevtstatecode) |
| 2653 | 3358 | 发送指令后返回接收状态 |
| ... | ... | @@ -2713,7 +3418,7 @@ |
| 2713 | 3418 | } |
| 2714 | 3419 | } |
| 2715 | 3420 | ``` |
| 2716 | -##### stopQAQuicker | |
| 3421 | +<!-- ##### stopQAQuicker | |
| 2717 | 3422 | - **主题**:/client/\${baseSN}/send |
| 2718 | 3423 | - **功能描述**:停止抢答答题 |
| 2719 | 3424 | - **参数说明** |
| ... | ... | @@ -2729,7 +3434,11 @@ |
| 2729 | 3434 | "fun":"stopQAQuicker", |
| 2730 | 3435 | "dataTag":"1" |
| 2731 | 3436 | } |
| 2732 | -``` | |
| 3437 | +``` --> | |
| 3438 | + | |
| 3439 | +##### [stopKpVote](#stopkpvote) | |
| 3440 | +停止抢答 | |
| 3441 | + | |
| 2733 | 3442 | #### 事件 |
| 2734 | 3443 | ##### [sEvtStateCode](#sevtstatecode) |
| 2735 | 3444 | 发送指令后返回接收状态 |
| ... | ... | @@ -2760,6 +3469,82 @@ |
| 2760 | 3469 | }] |
| 2761 | 3470 | } |
| 2762 | 3471 | ``` |
| 3472 | +### 待机实时反馈 | |
| 3473 | +#### 方法 | |
| 3474 | +##### setKpStbResponse | |
| 3475 | +- **主题**:/client/\${baseSN}/send | |
| 3476 | +- **功能描述**:启动待机实时反馈 | |
| 3477 | +- **参数说明** | |
| 3478 | + | |
| 3479 | +|参数名|类型|限制|是否必填|说明| | |
| 3480 | +|---|---|---|---|---| | |
| 3481 | +|fun|string|-|是|指令名称| | |
| 3482 | +|dataTag|string|-|否|数据包标识,可为空字符串| | |
| 3483 | +|data|object|-|是|传送参数的对象| | |
| 3484 | +|+state|int||是|启用待机实时反馈<br>0-不启用<br>1-启用| | |
| 3485 | +|+mode|int||是|启动待机反馈类型,state=1时有效<br>0-举手<br>1-指定按键反馈| | |
| 3486 | +|+keys|int||是|有效按键数量,state=1且mode=1时有效, 范围1-10| | |
| 3487 | + | |
| 3488 | +- **示例代码** | |
| 3489 | +```json | |
| 3490 | +//启用举手反馈 | |
| 3491 | +{ | |
| 3492 | + "fun":"setKpStbResponse", | |
| 3493 | + "dataTag":"1", | |
| 3494 | + "data":{ | |
| 3495 | + "state":1, | |
| 3496 | + "mode":0 | |
| 3497 | + } | |
| 3498 | +} | |
| 3499 | +//启用待机按键反馈 | |
| 3500 | +{ | |
| 3501 | + "fun":"setKpStbResponse", | |
| 3502 | + "dataTag":"1", | |
| 3503 | + "data":{ | |
| 3504 | + "state":1, | |
| 3505 | + "mode":1, | |
| 3506 | + "keys":4 | |
| 3507 | + } | |
| 3508 | +} | |
| 3509 | +//关闭待机按键反馈 | |
| 3510 | +{ | |
| 3511 | + "fun":"setKpStbResponse", | |
| 3512 | + "dataTag":"1", | |
| 3513 | + "data":{ | |
| 3514 | + "state":0 | |
| 3515 | + } | |
| 3516 | +} | |
| 3517 | +``` | |
| 3518 | + | |
| 3519 | +#### 事件 | |
| 3520 | +#### fEvtKpStbResponse | |
| 3521 | +- **主题**:/basestation/\${baseSN}/receive | |
| 3522 | +- **功能描述**:返回当前待机按键反馈开启状态 | |
| 3523 | +- **参数说明** | |
| 3524 | + | |
| 3525 | +|参数名|类型|限制|非空|说明| | |
| 3526 | +|---|---|---|---|---| | |
| 3527 | +|fun|string|-|是|指令名称| | |
| 3528 | +|dataTag|string|-|否|数据包标识,可为空字符串| | |
| 3529 | +|data|array|-|是|传送参数的对象数组| | |
| 3530 | +|+state|int||是|启用待机实时反馈<br>0-不启用<br>1-启用| | |
| 3531 | + | |
| 3532 | +- **示例代码** | |
| 3533 | +```json | |
| 3534 | +{ | |
| 3535 | + "fun":"fEvtKpStbResponse", | |
| 3536 | + "dataTag":"1", | |
| 3537 | + "data": { | |
| 3538 | + "state": 1 | |
| 3539 | + } | |
| 3540 | +} | |
| 3541 | +``` | |
| 3542 | + | |
| 3543 | +##### [sEvtKpRtFeedback](#sevtkprtfeedback) | |
| 3544 | +返回待机时键盘返回的按键值 | |
| 3545 | + | |
| 3546 | +##### [sEvtKpHandup](#sevtkphandup) | |
| 3547 | +启动待机按键反馈类型为举手提问时返回此事件 | |
| 2763 | 3548 | ## 在线测验 |
| 2764 | 3549 | ### 标准测验 |
| 2765 | 3550 | #### 方法 |
| ... | ... | @@ -2865,7 +3650,7 @@ |
| 2865 | 3650 | } |
| 2866 | 3651 | } |
| 2867 | 3652 | ``` |
| 2868 | -##### stopKpExam | |
| 3653 | +<!-- ##### stopKpExam | |
| 2869 | 3654 | - **主题**:/client/\${baseSN}/send |
| 2870 | 3655 | - **功能描述**:停止标准测验 |
| 2871 | 3656 | - **参数说明** |
| ... | ... | @@ -2881,7 +3666,10 @@ |
| 2881 | 3666 | "fun":"stopKpExam", |
| 2882 | 3667 | "dataTag":"1" |
| 2883 | 3668 | } |
| 2884 | -``` | |
| 3669 | +``` --> | |
| 3670 | +##### [stopKpVote](#stopkpvote) | |
| 3671 | +停止在线测验 | |
| 3672 | + | |
| 2885 | 3673 | ##### rtGetKpExamData |
| 2886 | 3674 | - **主题**:/client/\${baseSN}/send |
| 2887 | 3675 | - **功能描述**:刷新作答数据 |
| ... | ... | @@ -3101,7 +3889,7 @@ |
| 3101 | 3889 | } |
| 3102 | 3890 | ``` |
| 3103 | 3891 | |
| 3104 | -##### stopKpMultiExam | |
| 3892 | +<!-- ##### stopKpMultiExam | |
| 3105 | 3893 | - **主题**:/client/\${baseSN}/send |
| 3106 | 3894 | - **功能描述**:停止多科测验 |
| 3107 | 3895 | - **参数说明** |
| ... | ... | @@ -3117,7 +3905,9 @@ |
| 3117 | 3905 | "fun":"stopKpMultiExam", |
| 3118 | 3906 | "dataTag":"1" |
| 3119 | 3907 | } |
| 3120 | -``` | |
| 3908 | +``` --> | |
| 3909 | +##### [stopKpVote](#stopkpvote) | |
| 3910 | +停止多科测验 | |
| 3121 | 3911 | |
| 3122 | 3912 | #### 事件 |
| 3123 | 3913 | ##### [sEvtStateCode](#sevtstatecode) |
| ... | ... | @@ -3127,4 +3917,115 @@ |
| 3127 | 3917 | 返回测验中键盘提交答题数据 |
| 3128 | 3918 | |
| 3129 | 3919 | ##### [fEvtFinalSubmit](#fevtfinalsubmit) |
| 3130 | -返回键盘手动交卷标识 | |
| 3131 | 3920 | \ No newline at end of file |
| 3921 | +返回键盘手动交卷标识 | |
| 3922 | + | |
| 3923 | +### 自主录分 | |
| 3924 | +#### 方法 | |
| 3925 | +##### startKpScoreInput | |
| 3926 | +- **主题**:/client/\${baseSN}/send | |
| 3927 | +- **功能描述**:启动标准测验 | |
| 3928 | +- **参数说明** | |
| 3929 | + | |
| 3930 | +|参数名|类型|限制|是否必填|说明| | |
| 3931 | +|---|---|---|---|---| | |
| 3932 | +|fun|string|-|是|指令名称| | |
| 3933 | +|dataTag|string|-|否|数据包标识,可为空字符串| | |
| 3934 | +|data|object|-|是|传送参数的对象| | |
| 3935 | +|+examNo|int||是|0-9999<br>=0,新的录分<br>>0时,与上次启动卷号一致继续录分,不一致进入新的录分| | |
| 3936 | +|+mode|int||是|录分模式<br>0-自主录分<br>1-交叉录分,需先输入录分的人员标识| | |
| 3937 | +|+questions|array||是|题目详情| | |
| 3938 | +|++symbol | string||是 | 题号前缀,可为空 | | |
| 3939 | +|++min |int||是|可输入的最小值,默认为0| | |
| 3940 | +|++max |int||是|可输入的最大值,<=100| | |
| 3941 | +|++digits|int||是|可输入的小数位数,范围0-2| | |
| 3942 | +|++startNo | int||是| 起始题号| | |
| 3943 | +|++count | int||是| 题目数量| | |
| 3944 | + | |
| 3945 | +- **示例代码** | |
| 3946 | +```json | |
| 3947 | +{ | |
| 3948 | + "fun":"startKpScoreInput", | |
| 3949 | + "dataTag":"1", | |
| 3950 | + "data":{ | |
| 3951 | + "mode": 0, | |
| 3952 | + "examNo": 0, | |
| 3953 | + "questions": [{ | |
| 3954 | + //题号1-1-1 到1-1-2 共2题,单题满分10分 | |
| 3955 | + "symbol": "1-", | |
| 3956 | + "min": 0, | |
| 3957 | + "max":10, | |
| 3958 | + "digits":1, | |
| 3959 | + "startNo": 1, | |
| 3960 | + "count":2 | |
| 3961 | + }, { | |
| 3962 | + //题号3到6 共4道题,单题满分5 | |
| 3963 | + "symbol": "", | |
| 3964 | + "min": 0, | |
| 3965 | + "max":5, | |
| 3966 | + "digits":0, | |
| 3967 | + "startNo": 3, | |
| 3968 | + "count":4 | |
| 3969 | + }] | |
| 3970 | + } | |
| 3971 | +} | |
| 3972 | +``` | |
| 3973 | +<!-- | |
| 3974 | +##### stopKpScoreInput | |
| 3975 | +- **主题**:/client/\${baseSN}/send | |
| 3976 | +- **功能描述**:停止自主录分 | |
| 3977 | +- **参数说明** | |
| 3978 | + | |
| 3979 | +|参数名|类型|限制|是否必填|说明| | |
| 3980 | +|---|---|---|---|---| | |
| 3981 | +|fun|string|-|是|指令名称| | |
| 3982 | +|dataTag|string|-|否|数据包标识,可为空字符串| | |
| 3983 | + | |
| 3984 | +- **示例代码** | |
| 3985 | +```json | |
| 3986 | +{ | |
| 3987 | + "fun":"stopKpScoreInput", | |
| 3988 | + "dataTag":"1" | |
| 3989 | +} | |
| 3990 | +``` --> | |
| 3991 | +##### [stopKpVote](#stopkpvote) | |
| 3992 | +停止自主录分 | |
| 3993 | + | |
| 3994 | +#### 事件 | |
| 3995 | +##### [sEvtStateCode](#sevtstatecode) | |
| 3996 | +发送指令后返回接收状态 | |
| 3997 | + | |
| 3998 | +##### fEvtKpScore | |
| 3999 | +- **主题**:/basestation/\${baseSN}/receive | |
| 4000 | +- **功能描述**:返回键盘提交录分信息 | |
| 4001 | +- **参数说明** | |
| 4002 | + | |
| 4003 | +|参数名|类型|限制|非空|说明| | |
| 4004 | +|---|---|---|---|---| | |
| 4005 | +|fun|string|-|是|指令名称| | |
| 4006 | +|dataTag|string|-|否|数据包标识,可为空字符串| | |
| 4007 | +|data|array|-|是|传送参数的对象数组| | |
| 4008 | +|++scoreTag|string||是|录分标识,自主录分为空,交叉录分为键盘录分前输入的标识| | |
| 4009 | +|++keySn|string||是|键盘SN| | |
| 4010 | +|++keyValue|string||是|键盘提交的分值,1:10;2:0表示第1题提交10分,第二题提交0分| | |
| 4011 | +|++keyTime|double||是|录分时间,从启动录分开始计算,单位秒| | |
| 4012 | + | |
| 4013 | +- **示例代码** | |
| 4014 | +```json | |
| 4015 | +{ | |
| 4016 | + "fun":"fEvtKpScore", | |
| 4017 | + "dataTag":"1", | |
| 4018 | + "data": [{ | |
| 4019 | + "scoreTag":"5", | |
| 4020 | + "keySn": "1234567890", | |
| 4021 | + "keyValue":"1:8;2:7.5;3:2;4:3", | |
| 4022 | + "keyTime":3.2 | |
| 4023 | + }, | |
| 4024 | + { | |
| 4025 | + "scoreTag":"3", | |
| 4026 | + "keySn": "1234567891", | |
| 4027 | + "keyValue":"1:10;2:0", | |
| 4028 | + "keyTime":3.5 | |
| 4029 | + } | |
| 4030 | + ] | |
| 4031 | +} | |
| 4032 | +``` | |
| 3132 | 4033 | \ No newline at end of file | ... | ... |