孙向锦 / public

Commit 02f1c6c38aa0bac1e094ffab3421533e511dd6b5

Authored by 刘琴
1 parent 8a9adc3e

修改部分MD格式，增加单条指令长度不超过2K的限制

Inline Side-by-side
Showing 1 changed file with 168 additions and 41 deletions
通讯协议-B200W-MQTT协议[外].md
  View file @02f1c6c
... ... @@ -36,12 +36,12 @@ MQTT服务器配置结果检查
36 36 \${baseSN}为指定的基站的SN编码，不能为空，接收基站反馈数据需要订阅对应基站SN的接收主题。
37 37 ### 发布的主题
38 38 应用程序发布的主题，基站订阅
39   -/client/\${baseSN}/send
  39 +/client/\${baseSN}/send <br>
40 40 /client/multiBase/send
41 41  
42 42 ### 订阅的主题
43 43 应用程序订阅的主题，基站发布
44   -/basestation/\\${baseSN}/receive
  44 +/basestation/\\${baseSN}/receive <br>
45 45 /basestation/multiBase/receive
46 46  
47 47 ## 指令说明
... ... @@ -60,8 +60,8 @@ MQTT服务器配置结果检查
60 60 |fEvtXXX|指令事件 |调用对应指令后返回|
61 61  
62 62 ## 数据格式约定
63   -- 数据格式统一为**Json**格式，MQTT发送接收消息编码统一为**UTF-8**
64   -- Json通用格式如下：
  63 +- 数据格式统一为**json**格式，MQTT发送接收消息编码统一为**UTF-8**
  64 +- json通用格式如下：
65 65 ```json
66 66 {
67 67 "fun":"xxx",
... ... @@ -71,12 +71,15 @@ MQTT服务器配置结果检查
71 71 }
72 72 }
73 73 ```
  74 +
74 75 |参数 |说明 |约束|
75 76 |---|---|---|
76 77 |fun| 指令或事件名称||
77 78 |dataTag| 数据标签，用于对应收发数据|长度不超过4，可为0-9a-zA-Z的组合|
78 79 |data| 数据内容|对象或者数组，可为空|
79 80  
  81 +<font color="red">注意：基站接收指令数据单次不超过2K长度，在指定键盘发送指令时，如果指令长度超出限制，建议将指令进行拆分，分次发送，如果是所有键盘执行的指令，可将keySns设为空数组不使用指定键盘的模式</font>
  82 +
80 83  
81 84 ## 功能速查一览表
82 85 ### 基站管理
... ... @@ -156,7 +159,7 @@ MQTT服务器配置结果检查
156 159 |+version|string||否|基站固件版本|
157 160  
158 161 - **示例代码**
159   -```Json
  162 +```json
160 163 //连接成功
161 164 {
162 165 "fun":"sEvtBsConnectState",
... ... @@ -177,6 +180,7 @@ MQTT服务器配置结果检查
177 180 }
178 181 }
179 182 ```
  183 +
180 184 ### sEvtBsChannelConflict
181 185 - **主题**: /basestation/\${baseSN}/receive
182 186 - **功能描述**：基站信道冲突时主动上报，应用程序可根据实际业务修改基站信道
... ... @@ -190,7 +194,7 @@ MQTT服务器配置结果检查
190 194 |+value|int||是|有冲突的信道|
191 195  
192 196 - **示例代码**
193   -```Json
  197 +```json
194 198 {
195 199 "fun":"sEvtBsChannelConflict",
196 200 "dataTag":"1",
... ... @@ -199,6 +203,7 @@ MQTT服务器配置结果检查
199 203 }
200 204 }
201 205 ```
  206 +
202 207 ### sEvtBsNfcResults
203 208 - **主题**: /basestation/\${baseSN}/receive
204 209 - **功能描述**：键盘刷卡时主动上报，如果超出基站容量会上报失败
... ... @@ -213,7 +218,7 @@ MQTT服务器配置结果检查
213 218 |+value|int||是|刷卡的状态<br>1-成功<br>2-失败|
214 219  
215 220 - **示例代码**
216   -```Json
  221 +```json
217 222 {
218 223 "fun":"sEvtBsNfcResults",
219 224 "dataTag":"1", //不需要时可传空字符串
... ... @@ -240,7 +245,7 @@ MQTT服务器配置结果检查
240 245 |+voltage|double||是|键盘电压|
241 246  
242 247 - **示例代码**
243   -```Json
  248 +```json
244 249 {
245 250 "fun":"sEvtBsKpOnlineMsg",
246 251 "dataTag":"1",
... ... @@ -252,6 +257,7 @@ MQTT服务器配置结果检查
252 257 }
253 258 }
254 259 ```
  260 +
255 261 ### sEvtStateCode
256 262 - **主题**: /basestation/\${baseSN}/receive
257 263 - **功能描述**：返回基站接收指令状态信息
... ... @@ -280,7 +286,7 @@ MQTT服务器配置结果检查
280 286 |60001|此功能必须指定键盘SN|
281 287  
282 288 - **示例代码**
283   -```Json
  289 +```json
284 290 {
285 291 "fun":"sEvtStateCode",
286 292 "dataTag":"1",
... ... @@ -290,9 +296,13 @@ MQTT服务器配置结果检查
290 296 }
291 297 }
292 298 ```
  299 +
293 300 ## 基站管理
  301 +
294 302 ### 基站连接
  303 +
295 304 #### 方法
  305 +
296 306 ##### getBsOnlineState
297 307 - **主题**：<span class="yellowFill">/client/multiBase/send</span>
298 308 - **功能描述**：主动获取所有在线基站信息,在线基站回复
... ... @@ -303,7 +313,7 @@ MQTT服务器配置结果检查
303 313 |fun|string|-|是|固定指令名称|
304 314 |dataTag|string|-|否|数据包标识|
305 315 - **示例代码**
306   -```Json
  316 +```json
307 317 {
308 318 "fun":"getBsOnlineState",
309 319 "dataTag":"1"
... ... @@ -320,13 +330,15 @@ MQTT服务器配置结果检查
320 330 |fun|string|-|是|固定指令名称|
321 331 |dataTag|string|-|否|数据包标识|
322 332 - **示例代码**
323   -```Json
  333 +```json
324 334 {
325 335 "fun":"getBsConnectState",
326 336 "dataTag":"1"
327 337 }
328 338 ```
  339 +
329 340 #### 事件
  341 +
330 342 ##### [sEvtBsConnectState](#sevtbsconnectstate)
331 343 参见基站连接变化系统通知
332 344  
... ... @@ -346,7 +358,7 @@ MQTT服务器配置结果检查
346 358 |+baseSN|string||否|基站SN|
347 359  
348 360 - **示例代码**
349   -```Json
  361 +```json
350 362 //连接成功
351 363 {
352 364 "fun":"fEvtBsOnlineState",
... ... @@ -375,7 +387,7 @@ MQTT服务器配置结果检查
375 387 |+timeStamp|long ||否|当前时间的时间戳|
376 388  
377 389 - **示例代码**
378   -```Json
  390 +```json
379 391 {
380 392 "fun":"timeSync",
381 393 "dataTag":"1",
... ... @@ -384,6 +396,7 @@ MQTT服务器配置结果检查
384 396 }
385 397 }
386 398 ```
  399 +
387 400 #### 事件
388 401 ##### [sEvtStateCode](#sevtstatecode)
389 402 返回指令的接收状态
... ... @@ -401,12 +414,13 @@ MQTT服务器配置结果检查
401 414 |dataTag|string|-|否|数据包标识,可为空字符串|
402 415  
403 416 - **示例代码**
404   -```Json
  417 +```json
405 418 {
406 419 "fun":"getBsModel",
407 420 "dataTag":"1"
408 421 }
409 422 ```
  423 +
410 424 ##### getBsFWVersion
411 425 - **主题**：/client/\${baseSN}/send
412 426 - **功能描述**：获取基站固件版本
... ... @@ -418,12 +432,13 @@ MQTT服务器配置结果检查
418 432 |dataTag|string|-|否|数据包标识,可为空字符串|
419 433  
420 434 - **示例代码**
421   -```Json
  435 +```json
422 436 {
423 437 "fun":"getBsFWVersion",
424 438 "dataTag":"1"
425 439 }
426 440 ```
  441 +
427 442 #### 事件
428 443 ##### fEvtBsSN
429 444 - **主题**: /basestation/\${baseSN}/receive
... ... @@ -438,7 +453,7 @@ MQTT服务器配置结果检查
438 453 |+value|string|-|是|基站的出厂编码|
439 454  
440 455 - **示例代码**
441   -```Json
  456 +```json
442 457 {
443 458 "fun":"fEvtBsSN",
444 459 "dataTag":"1",
... ... @@ -447,6 +462,7 @@ MQTT服务器配置结果检查
447 462 }
448 463 }
449 464 ```
  465 +
450 466 ##### fEvtBsModel
451 467 - **主题**: /basestation/\${baseSN}/receive
452 468 - **功能描述**：返回基站的型号
... ... @@ -460,7 +476,8 @@ MQTT服务器配置结果检查
460 476 |+value|string|-|是|基站的型号名称|
461 477  
462 478 - **示例代码**
463   -```Json
  479 +
  480 +```json
464 481 {
465 482 "fun":"fEvtBsModel",
466 483 "dataTag":"1",
... ... @@ -469,6 +486,7 @@ MQTT服务器配置结果检查
469 486 }
470 487 }
471 488 ```
  489 +
472 490 ##### fEvtBsFWVersion
473 491 - **主题**: /basestation/\${baseSN}/receive
474 492 - **功能描述**：返回基站的固件版本
... ... @@ -482,7 +500,8 @@ MQTT服务器配置结果检查
482 500 |+value|string||是|基站的固件版本号|
483 501  
484 502 - **示例代码**
485   -```Json
  503 +
  504 +```json
486 505 {
487 506 "fun":"fEvtBsFWVersion",
488 507 "dataTag":"1",
... ... @@ -491,6 +510,7 @@ MQTT服务器配置结果检查
491 510 }
492 511 }
493 512 ```
  513 +
494 514 ### 组网设置
495 515 #### 方法
496 516 ##### getBsPairCode
... ... @@ -504,12 +524,13 @@ MQTT服务器配置结果检查
504 524 |dataTag|string|-|否|数据包标识,可为空字符串|
505 525  
506 526 - **示例代码**
507   -```Json
  527 +```json
508 528 {
509 529 "fun":"getBsPairCode",
510 530 "dataTag":"1"
511 531 }
512 532 ```
  533 +
513 534 ##### getBsNfcLogin
514 535 - **主题**：/client/\${baseSN}/send
515 536 - **功能描述**：获取刷卡配对状态
... ... @@ -521,12 +542,13 @@ MQTT服务器配置结果检查
521 542 |dataTag|string|-|否|数据包标识,可为空字符串|
522 543  
523 544 - **示例代码**
524   -```Json
  545 +```json
525 546 {
526 547 "fun":"getBsNfcLogin",
527 548 "dataTag":"1"
528 549 }
529 550 ```
  551 +
530 552 ##### setBsNfcLogin
531 553 - **主题**：/client/\${baseSN}/send
532 554 - **功能描述**：设置基站刷卡配对状态
... ... @@ -540,7 +562,7 @@ MQTT服务器配置结果检查
540 562 |+value|string|-|是|设置的基站刷卡配对状态<br>0-关闭刷卡配对<br>1-开启刷卡配对|
541 563  
542 564 - **示例代码**
543   -```Json
  565 +```json
544 566 {
545 567 "fun":"setBsNfcLogin",
546 568 "dataTag":"1",
... ... @@ -549,6 +571,7 @@ MQTT服务器配置结果检查
549 571 }
550 572 }
551 573 ```
  574 +
552 575 ##### getBsChannel
553 576 - **主题**：/client/\${baseSN}/send
554 577 - **功能描述**：获取基站信道
... ... @@ -560,12 +583,13 @@ MQTT服务器配置结果检查
560 583 |dataTag|string|-|否|数据包标识,可为空字符串|
561 584  
562 585 - **示例代码**
563   -```Json
  586 +```json
564 587 {
565 588 "fun":"getBsChannel",
566 589 "dataTag":"1"
567 590 }
568 591 ```
  592 +
569 593 ##### setBsChannel
570 594 - **主题**：/client/\${baseSN}/send
571 595 - **功能描述**：设置基站信道
... ... @@ -579,7 +603,7 @@ MQTT服务器配置结果检查
579 603 |+value|string|-|是|设置的基站信道，可设范围：1-80|
580 604  
581 605 - **示例代码**
582   -```Json
  606 +```json
583 607 {
584 608 "fun":"setBsChannel",
585 609 "dataTag":"1",
... ... @@ -588,6 +612,7 @@ MQTT服务器配置结果检查
588 612 }
589 613 }
590 614 ```
  615 +
591 616 #### 事件
592 617 ##### fEvtBsPairCode
593 618 - **主题**: /basestation/\${baseSN}/receive
... ... @@ -602,7 +627,7 @@ MQTT服务器配置结果检查
602 627 |+value|string||是|基站的配对码|
603 628  
604 629 - **示例代码**
605   -```Json
  630 +```json
606 631 {
607 632 "fun":"fEvtBsPairCode",
608 633 "dataTag":"1",
... ... @@ -625,7 +650,7 @@ MQTT服务器配置结果检查
625 650 |+value|string||是|基站信道|
626 651  
627 652 - **示例代码**
628   -```Json
  653 +```json
629 654 {
630 655 "fun":"fEvtBsChannel",
631 656 "dataTag":"1",
... ... @@ -634,6 +659,7 @@ MQTT服务器配置结果检查
634 659 }
635 660 }
636 661 ```
  662 +
637 663 ##### fEvtBsNfcLogin
638 664 - **主题**: /basestation/\${baseSN}/receive
639 665 - **功能描述**：返回基站是否允许NFC刷卡
... ... @@ -647,7 +673,7 @@ MQTT服务器配置结果检查
647 673 |+value|string||是|0-关闭 1-开启|
648 674  
649 675 - **示例代码**
650   -```Json
  676 +```json
651 677 {
652 678 "fun":"fEvtBsNfcLogin",
653 679 "dataTag":"1",
... ... @@ -656,6 +682,7 @@ MQTT服务器配置结果检查
656 682 }
657 683 }
658 684 ```
  685 +
659 686 ### 登录设置
660 687 #### 方法
661 688 ##### getBsSSID
... ... @@ -670,12 +697,13 @@ MQTT服务器配置结果检查
670 697 |dataTag|string|-|否|数据包标识|
671 698  
672 699 - **示例代码**
673   -```Json
  700 +```json
674 701 {
675 702 "fun":"getBsSSID",
676 703 "dataTag":"1"
677 704 }
678 705 ```
  706 +
679 707 ##### setBsSSID
680 708 - **主题**：/client/\${baseSN}/send
681 709 - **功能描述**：设置基站登录名称
... ... @@ -689,7 +717,7 @@ MQTT服务器配置结果检查
689 717 |+value|string||是|设置的基站SSID，最长12字符|
690 718  
691 719 - **示例代码**
692   -```Json
  720 +```json
693 721 {
694 722 "fun":"setBsSSID",
695 723 "dataTag":"1",
... ... @@ -698,6 +726,7 @@ MQTT服务器配置结果检查
698 726 }
699 727 }
700 728 ```
  729 +
701 730 #### 事件
702 731 ##### fEvtBsSSID
703 732 - **主题**: /basestation/\${baseSN}/receive
... ... @@ -712,7 +741,7 @@ MQTT服务器配置结果检查
712 741 |+value|string||是|基站名称|
713 742  
714 743 - **示例代码**
715   -```Json
  744 +```json
716 745 {
717 746 "fun":"fEvtBsSSID",
718 747 "dataTag":"1",
... ... @@ -721,6 +750,7 @@ MQTT服务器配置结果检查
721 750 }
722 751 }
723 752 ```
  753 +
724 754 ### 键盘统一设置
725 755 #### 方法
726 756 ##### getBsKpLanguage
... ... @@ -734,12 +764,13 @@ MQTT服务器配置结果检查
734 764 |dataTag|string|-|否|数据包标识,可为空字符串|
735 765  
736 766 - **示例代码**
737   -```Json
  767 +```json
738 768 {
739 769 "fun":"getBsKpLanguage",
740 770 "dataTag":"1"
741 771 }
742 772 ```
  773 +
743 774 ##### setBsKpLanguage
744 775 - **主题**：/client/\${baseSN}/send
745 776 - **功能描述**：设置键盘语言
... ... @@ -753,7 +784,7 @@ MQTT服务器配置结果检查
753 784 |+value|string||是|设置键盘显示的语言<br>1-简体中文<br>2-英文|
754 785  
755 786 - **示例代码**
756   -```Json
  787 +```json
757 788 {
758 789 "fun":"setBsKpLanguage",
759 790 "dataTag":"1",
... ... @@ -762,6 +793,7 @@ MQTT服务器配置结果检查
762 793 }
763 794 }
764 795 ```
  796 +
765 797 #### 事件
766 798 ##### fEvtBsKpLanguage
767 799 - **主题**: /basestation/\${baseSN}/receive
... ... @@ -776,7 +808,7 @@ MQTT服务器配置结果检查
776 808 |+value|string||是|设置键盘显示的语言<br>1-简体中文<br>2-英文|
777 809  
778 810 - **示例代码**
779   -```Json
  811 +```json
780 812 {
781 813 "fun":"fEvtBsKpLanguage",
782 814 "dataTag":"1",
... ... @@ -785,6 +817,7 @@ MQTT服务器配置结果检查
785 817 }
786 818 }
787 819 ```
  820 +
788 821 ### 网络参数设置
789 822 #### 方法
790 823 ##### getBsTcpipParams
... ... @@ -798,12 +831,13 @@ MQTT服务器配置结果检查
798 831 |dataTag|string|-|否|数据包标识,可为空字符串|
799 832  
800 833 - **示例代码**
801   -```Json
  834 +```json
802 835 {
803 836 "fun":"getBsTcpipParams",
804 837 "dataTag":"1"
805 838 }
806 839 ```
  840 +
807 841 ##### setBsTcpipParams
808 842 - **主题**：/client/\${baseSN}/send
809 843 - **功能描述**：设置基站TCP/IP参数
... ... @@ -820,7 +854,7 @@ MQTT服务器配置结果检查
820 854 |+ipAllocation|int||否|基站IP获取方式<br>0 - 手动指定<br>1 - DHCP获取|
821 855  
822 856 - **示例代码**
823   -```Json
  857 +```json
824 858 {
825 859 "fun":"setBsTcpipParams",
826 860 "dataTag":"1",
... ... @@ -832,6 +866,7 @@ MQTT服务器配置结果检查
832 866 }
833 867 }
834 868 ```
  869 +
835 870 ##### getBsMqttParams
836 871 - **主题**：/client/\${baseSN}/send
837 872 - **功能描述**：获取基站MQTT参数
... ... @@ -843,12 +878,13 @@ MQTT服务器配置结果检查
843 878 |dataTag|string|-|否|数据包标识,可为空字符串|
844 879  
845 880 - **示例代码**
846   -```Json
  881 +```json
847 882 {
848 883 "fun":"getBsMqttParams",
849 884 "dataTag":"1"
850 885 }
851 886 ```
  887 +
852 888 ##### setBsMqttParams
853 889 - **主题**：/client/\${baseSN}/send
854 890 - **功能描述**：设置基站MQTT参数
... ... @@ -866,7 +902,7 @@ MQTT服务器配置结果检查
866 902 |+interval|int|>=10|否|基站连接服务器失败后重连的间隔时长，单位秒|
867 903  
868 904 - **示例代码**
869   -```Json
  905 +```json
870 906 {
871 907 "fun":"setBsMqttParams",
872 908 "dataTag":"1",
... ... @@ -879,6 +915,7 @@ MQTT服务器配置结果检查
879 915 }
880 916 }
881 917 ```
  918 +
882 919 #### 事件
883 920 ##### fEvtBsTcpipParams
884 921 - **主题**: /basestation/\${baseSN}/receive
... ... @@ -897,7 +934,7 @@ MQTT服务器配置结果检查
897 934 |+ipAllocation|int||否|基站IP获取方式<br>0 - 手动指定<br>1 - DHCP获取|
898 935  
899 936 - **示例代码**
900   -```Json
  937 +```json
901 938 {
902 939 "fun":"fEvtBsTcpipParams",
903 940 "dataTag":"1",
... ... @@ -910,6 +947,7 @@ MQTT服务器配置结果检查
910 947 }
911 948 }
912 949 ```
  950 +
913 951 ##### fEvtBsMqttParams
914 952 - **主题**: /basestation/\${baseSN}/receive
915 953 - **功能描述**：返回基站MQTT参数
... ... @@ -927,7 +965,7 @@ MQTT服务器配置结果检查
927 965 |+interval|int|>=10|否|基站连接服务器失败后重连的间隔时长，单位秒|
928 966  
929 967 - **示例代码**
930   -```Json
  968 +```json
931 969 {
932 970 "fun":"fEvtBsMqttParams",
933 971 "dataTag":"1",
... ... @@ -940,6 +978,7 @@ MQTT服务器配置结果检查
940 978 }
941 979 }
942 980 ```
  981 +
943 982 ### 基站维护
944 983 #### 方法
945 984 ##### getBsLogInfo
... ... @@ -953,7 +992,7 @@ MQTT服务器配置结果检查
953 992 |dataTag|string|-|否|数据包标识,可为空字符串|
954 993  
955 994 - **示例代码**
956   -```Json
  995 +```json
957 996 {
958 997 "fun":"getBsLogInfo",
959 998 "dataTag":"1"
... ... @@ -979,6 +1018,8 @@ MQTT服务器配置结果检查
979 1018 |data|array|-|否|传送参数的对象数组|
980 1019 |++keySns|array||是|指定的键盘SN数组，空数组表示全部在线键盘<br><font color="red">注意：不允许空数组和指定SN数组混合使用<br>包含空数组默认为全部在线键盘，其他指定键盘无效</font>|
981 1020 |++info|string||否|设置的反馈信息<br>不同键盘可设置不同反馈信息|
  1021 +
  1022 +- **示例代码**
982 1023 ```json
983 1024 //分别提示
984 1025 {
... ... @@ -1007,6 +1048,7 @@ MQTT服务器配置结果检查
1007 1048 ]
1008 1049 }
1009 1050 ```
  1051 +
1010 1052 #### 事件
1011 1053 ##### [sEvtStateCode](#sevtstatecode)
1012 1054 发送指令后返回接收状态
... ... @@ -1023,6 +1065,8 @@ MQTT服务器配置结果检查
1023 1065 |data|array|-|是|传送参数的对象数组|
1024 1066 |++keySn|string||是|设置提示语信息的键盘SN|
1025 1067 |++state|string||是|设置的提示语是否成功<br>0 - 成功<br>1 - 失败|
  1068 +
  1069 +- **示例代码**
1026 1070 ```json
1027 1071 {
1028 1072 "fun": "fEvtSetKpUserPrompt",
... ... @@ -1043,6 +1087,7 @@ MQTT服务器配置结果检查
1043 1087 ]
1044 1088 }
1045 1089 ```
  1090 +
1046 1091 ### 在线状态
1047 1092 #### 方法
1048 1093 ##### startGetKpOnline
... ... @@ -1054,6 +1099,8 @@ MQTT服务器配置结果检查
1054 1099 |---|---|---|---|---|
1055 1100 |fun|string|-|是|指令名称|
1056 1101 |dataTag|string|-|否|数据包标识,可为空字符串|
  1102 +
  1103 +- **示例代码**
1057 1104 ```json
1058 1105 {
1059 1106 "fun": "startGetKpOnline",
... ... @@ -1070,12 +1117,15 @@ MQTT服务器配置结果检查
1070 1117 |---|---|---|---|---|
1071 1118 |fun|string|-|是|指令名称|
1072 1119 |dataTag|string|-|否|数据包标识,可为空字符串|
  1120 +
  1121 +- **示例代码**
1073 1122 ```json
1074 1123 {
1075 1124 "fun": "stopGetKpOnline",
1076 1125 "dataTag":"1"
1077 1126 }
1078 1127 ```
  1128 +
1079 1129 #### 事件
1080 1130 ##### [sEvtStateCode](#sevtstatecode)
1081 1131 发送指令后返回此事件
... ... @@ -1098,7 +1148,7 @@ MQTT服务器配置结果检查
1098 1148 |+keySns|array||否|需要执行指令的键盘SN数组，空数组表示所有键盘|
1099 1149  
1100 1150 - **示例代码**
1101   -```Json
  1151 +```json
1102 1152 {
1103 1153 "fun":"remoteKpSleep",
1104 1154 "dataTag":"1",
... ... @@ -1107,6 +1157,7 @@ MQTT服务器配置结果检查
1107 1157 }
1108 1158 }
1109 1159 ```
  1160 +
1110 1161 #### 事件
1111 1162 ##### [sEvtStateCode](#sevtstatecode)
1112 1163 返回指令的接收状态
... ... @@ -1126,6 +1177,8 @@ MQTT服务器配置结果检查
1126 1177 |data|array|-|是|传送参数的对象数组，不可为空|
1127 1178 |++keySn|string||是|需要设置绑定信息的键盘SN|
1128 1179 |++info|string||是|设置的绑定信息，一般为学生姓名<br>最长48个字符，显示在键盘左上角|
  1180 +
  1181 +- **示例代码**
1129 1182 ```json
1130 1183 {
1131 1184 "fun": "rtSetKpBindingInfo",
... ... @@ -1154,6 +1207,8 @@ MQTT服务器配置结果检查
1154 1207 |dataTag|string|-|否|数据包标识,可为空字符串|
1155 1208 |data|object|-|是|传送参数的对象数组|
1156 1209 |+keySns|array||否|需要清除绑定信息键盘SN数组，<br>空数组表示清空所有键盘|
  1210 +
  1211 +- **示例代码**
1157 1212 ```json
1158 1213 {
1159 1214 "fun": "clearKpBindingInfo",
... ... @@ -1163,6 +1218,7 @@ MQTT服务器配置结果检查
1163 1218 }
1164 1219 }
1165 1220 ```
  1221 +
1166 1222 #### 事件
1167 1223 ##### [sEvtStateCode](#sevtstatecode)
1168 1224 发送指令后返回接收状态
... ... @@ -1179,6 +1235,8 @@ MQTT服务器配置结果检查
1179 1235 |data|array|-|否|传送参数的对象数组|
1180 1236 |++keySn|string||是|需要设置绑定信息的键盘SN|
1181 1237 |++state|string||是|设置的绑定信息是否成功<br>0 - 成功<br>1 - 失败|
  1238 +
  1239 +- **示例代码**
1182 1240 ```json
1183 1241 {
1184 1242 "fun": "fEvtKpBindingInfo",
... ... @@ -1195,6 +1253,7 @@ MQTT服务器配置结果检查
1195 1253 ]
1196 1254 }
1197 1255 ```
  1256 +
1198 1257 ##### fEvtClearKpBindingInfo
1199 1258 - **主题**：/basestation/\${baseSN}/receive
1200 1259 - **功能描述**：返回清空绑定信息的指令状态是否成功
... ... @@ -1206,6 +1265,8 @@ MQTT服务器配置结果检查
1206 1265 |dataTag|string|-|否|数据包标识,可为空字符串|
1207 1266 |data|object|-|否|传送参数的对象|
1208 1267 |+state|string||是|设置的绑定信息是否成功<br>0 - 成功<br>1 - 失败|
  1268 +
  1269 +- **示例代码**
1209 1270 ```json
1210 1271 {
1211 1272 "fun": "fEvtClearKpBindingInfo",
... ... @@ -1215,6 +1276,7 @@ MQTT服务器配置结果检查
1215 1276 }
1216 1277 }
1217 1278 ```
  1279 +
1218 1280 ## 签到
1219 1281 ### 随时签到
1220 1282 #### 方法
... ... @@ -1229,6 +1291,8 @@ MQTT服务器配置结果检查
1229 1291 |dataTag|string|-|否|数据包标识,可为空字符串|
1230 1292 |data|object|-|是|传递参数的对象|
1231 1293 |+mode|int|-|是|签到模式<br>2-PIN码签到，输入pin码后由应用程序决定是否授权|
  1294 +
  1295 +- **示例代码**
1232 1296 ```json
1233 1297 {
1234 1298 "fun": "rtStartKpSignIn",
... ... @@ -1238,6 +1302,7 @@ MQTT服务器配置结果检查
1238 1302 }
1239 1303 }
1240 1304 ```
  1305 +
1241 1306 ##### rtStopKpSignIn
1242 1307 - **主题**：/client/\${baseSN}/send
1243 1308 - **功能描述**：停止签到绑定
... ... @@ -1247,12 +1312,15 @@ MQTT服务器配置结果检查
1247 1312 |---|---|---|---|---|
1248 1313 |fun|string|-|是|指令名称|
1249 1314 |dataTag|string|-|否|数据包标识,可为空字符串|
  1315 +
  1316 +- **示例代码**
1250 1317 ```json
1251 1318 {
1252 1319 "fun": "rtStopKpSignIn",
1253 1320 "dataTag":"1"
1254 1321 }
1255 1322 ```
  1323 +
1256 1324 ##### rtSetKpLoginAllowed
1257 1325 - **主题**：/client/\${baseSN}/send
1258 1326 - **功能描述**：实时PIN绑定授权,可取消授权
... ... @@ -1265,6 +1333,8 @@ MQTT服务器配置结果检查
1265 1333 |data|object|-|是|传递参数的对象|
1266 1334 |+keySn|string|-|是|键盘SN|
1267 1335 |+state|int|-|是|1-授权成功<br>2-授权失败<br>3-解除已授权|
  1336 +
  1337 +- **示例代码**
1268 1338 ```json
1269 1339 {
1270 1340 "fun": "rtSetKpLoginAllowed",
... ... @@ -1275,6 +1345,7 @@ MQTT服务器配置结果检查
1275 1345 }
1276 1346 }
1277 1347 ```
  1348 +
1278 1349 #### 事件
1279 1350 ##### [sEvtStateCode](#sevtstatecode)
1280 1351 发送指令后返回接收状态
... ... @@ -1292,6 +1363,8 @@ MQTT服务器配置结果检查
1292 1363 |++keySn|string||是|键盘SN|
1293 1364 |++keyValue|string||是|键盘提交的按键值|
1294 1365 |++keyTime|double||是|答题时间，从启动开始计算，单位秒|
  1366 +
  1367 +- **示例代码**
1295 1368 ```json
1296 1369 {
1297 1370 "fun": "fEvtKpSignIn",
... ... @@ -1309,6 +1382,7 @@ MQTT服务器配置结果检查
1309 1382 ]
1310 1383 }
1311 1384 ```
  1385 +
1312 1386 ##### fEvtKpLoginAllowed
1313 1387 - **主题**：/basestation/\${baseSN}/receive
1314 1388 - **功能描述**：返回键盘授权状态
... ... @@ -1321,6 +1395,8 @@ MQTT服务器配置结果检查
1321 1395 |data|object|-|是|传送参数的对象|
1322 1396 |+keySn|string||是|键盘SN|
1323 1397 |+state|string||是|0-执行成功<br> 1-执行失败|
  1398 +
  1399 +- **示例代码**
1324 1400 ```json
1325 1401 {
1326 1402 "fun": "fEvtKpLoginAllowed",
... ... @@ -1331,6 +1407,7 @@ MQTT服务器配置结果检查
1331 1407 }
1332 1408 }
1333 1409 ```
  1410 +
1334 1411 ## 按键反馈
1335 1412 ### 判断题
1336 1413 #### 方法
... ... @@ -1348,6 +1425,8 @@ MQTT服务器配置结果检查
1348 1425 |+mode|int||是|1 - True/False 对/错 <br>2 - Yes/No 是/否<br> 3 - √/×|
1349 1426 |+allowModify|int||是|0 - 不允许修改<br>1 - 允许修改|
1350 1427 |+tip|string||否|提示的标题，长度不超过16字符|
  1428 +
  1429 +- **示例代码**
1351 1430 ```json
1352 1431 {
1353 1432 "fun": "startQATrueFalse",
... ... @@ -1360,6 +1439,7 @@ MQTT服务器配置结果检查
1360 1439 }
1361 1440 }
1362 1441 ```
  1442 +
1363 1443 ##### stopQATrueFalse
1364 1444 - **主题**：/client/\${baseSN}/send
1365 1445 - **功能描述**：停止判断题答题
... ... @@ -1369,12 +1449,15 @@ MQTT服务器配置结果检查
1369 1449 |---|---|---|---|---|
1370 1450 |fun|string|-|是|指令名称|
1371 1451 |dataTag|string|-|否|数据包标识,可为空字符串|
  1452 +
  1453 +- **示例代码**
1372 1454 ```json
1373 1455 {
1374 1456 "fun": "stopQATrueFalse",
1375 1457 "dataTag":"1"
1376 1458 }
1377 1459 ```
  1460 +
1378 1461 #### 事件
1379 1462 ##### [sEvtStateCode](#sevtstatecode)
1380 1463 发送指令后返回接收状态
... ... @@ -1392,6 +1475,8 @@ MQTT服务器配置结果检查
1392 1475 |++keySn|string||是|键盘SN|
1393 1476 |++keyValue|string||是|键盘提交的按键值<br>1-对<br>2-错|
1394 1477 |++keyTime|double||是|答题时间，从启动开始计算，单位秒|
  1478 +
  1479 +- **示例代码**
1395 1480 ```json
1396 1481 {
1397 1482 "fun": "fEvtQATrueFalse",
... ... @@ -1404,6 +1489,7 @@ MQTT服务器配置结果检查
1404 1489 ]
1405 1490 }
1406 1491 ```
  1492 +
1407 1493 ### 选择题
1408 1494 #### 方法
1409 1495 ##### startQAChoice
... ... @@ -1423,6 +1509,8 @@ MQTT服务器配置结果检查
1423 1509 |+optionalN|int||是|可选项个数，1≤N≤M(默认值1)|
1424 1510 |+allowModify|int||是|修改模式<br>0 - 不允许修改<br>1 - 允许修改|
1425 1511 |+tip|string||否|提示的标题，长度不超过16字符|
  1512 +
  1513 +- **示例代码**
1426 1514 ```json
1427 1515 {
1428 1516 "fun": "startQAChoice",
... ... @@ -1438,6 +1526,7 @@ MQTT服务器配置结果检查
1438 1526 }
1439 1527 }
1440 1528 ```
  1529 +
1441 1530 ##### stopQAChoice
1442 1531 - **主题**：/client/\${baseSN}/send
1443 1532 - **功能描述**：停止选择题答题
... ... @@ -1447,12 +1536,15 @@ MQTT服务器配置结果检查
1447 1536 |---|---|---|---|---|
1448 1537 |fun|string|-|是|指令名称|
1449 1538 |dataTag|string|-|否|数据包标识,可为空字符串|
  1539 +
  1540 +- **示例代码**
1450 1541 ```json
1451 1542 {
1452 1543 "fun": "stopQAChoice",
1453 1544 "dataTag":"1"
1454 1545 }
1455 1546 ```
  1547 +
1456 1548 #### 事件
1457 1549 ##### [sEvtStateCode](#sevtstatecode)
1458 1550 发送指令后返回接收状态
... ... @@ -1470,6 +1562,8 @@ MQTT服务器配置结果检查
1470 1562 |++keySn|string||是|键盘SN|
1471 1563 |++keyValue|string||是|键盘提交的按键值|
1472 1564 |++keyTime|double||是|答题时间，从启动开始计算，单位秒|
  1565 +
  1566 +- **示例代码**
1473 1567 ```json
1474 1568 {
1475 1569 "fun": "fEvtQAChoice",
... ... @@ -1481,6 +1575,7 @@ MQTT服务器配置结果检查
1481 1575 }]
1482 1576 }
1483 1577 ```
  1578 +
1484 1579 ### 数字题
1485 1580 #### 方法
1486 1581 ##### startQANum
... ... @@ -1500,6 +1595,8 @@ MQTT服务器配置结果检查
1500 1595 |+numMax|int||是|可输入上限,mode=1有效，范围0-100|
1501 1596 |+allowModify|int||是|修改模式<br>0 - 不允许修改<br>1 - 允许修改|
1502 1597 |+tip|string||否|提示的标题，长度不超过16字符|
  1598 +
  1599 +- **示例代码**
1503 1600 ```json
1504 1601 {
1505 1602 "fun": "startQANum",
... ... @@ -1515,6 +1612,7 @@ MQTT服务器配置结果检查
1515 1612 }
1516 1613 }
1517 1614 ```
  1615 +
1518 1616 ##### stopQANum
1519 1617 - **主题**：/client/\${baseSN}/send
1520 1618 - **功能描述**：停止数字题答题
... ... @@ -1524,12 +1622,15 @@ MQTT服务器配置结果检查
1524 1622 |---|---|---|---|---|
1525 1623 |fun|string|-|是|指令名称|
1526 1624 |dataTag|string|-|否|数据包标识,可为空字符串|
  1625 +
  1626 +- **示例代码**
1527 1627 ```json
1528 1628 {
1529 1629 "fun": "stopQANum",
1530 1630 "dataTag":"1"
1531 1631 }
1532 1632 ```
  1633 +
1533 1634 #### 事件
1534 1635 ##### [sEvtStateCode](#sevtstatecode)
1535 1636 发送指令后返回接收状态
... ... @@ -1547,6 +1648,8 @@ MQTT服务器配置结果检查
1547 1648 |++keySn|string||是|键盘SN|
1548 1649 |++keyValue|string||是|键盘提交的按键值|
1549 1650 |++keyTime|double||是|答题时间，从启动开始计算，单位秒|
  1651 +
  1652 +- **示例代码**
1550 1653 ```json
1551 1654 {
1552 1655 "fun": "fEvtQANum",
... ... @@ -1558,6 +1661,7 @@ MQTT服务器配置结果检查
1558 1661 }
1559 1662 }
1560 1663 ```
  1664 +
1561 1665 ### 抢答题
1562 1666 #### 方法
1563 1667 ##### startQAQuicker
... ... @@ -1574,6 +1678,8 @@ MQTT服务器配置结果检查
1574 1678 |+mode|int||是|模式<br>0:普通抢答|
1575 1679 |+allowModify|int||是|修改模式<br>0 - 不允许修改<br>1 - 允许修改|
1576 1680 |+tip|string||否|提示的标题，长度不超过16字符|
  1681 +
  1682 +- **示例代码**
1577 1683 ```json
1578 1684 {
1579 1685 "fun": "startQAQuicker",
... ... @@ -1586,6 +1692,7 @@ MQTT服务器配置结果检查
1586 1692 }
1587 1693 }
1588 1694 ```
  1695 +
1589 1696 ##### stopQAQuicker
1590 1697 - **主题**：/client/\${baseSN}/send
1591 1698 - **功能描述**：停止抢答答题
... ... @@ -1595,12 +1702,15 @@ MQTT服务器配置结果检查
1595 1702 |---|---|---|---|---|
1596 1703 |fun|string|-|是|指令名称|
1597 1704 |dataTag|string|-|否|数据包标识,可为空字符串|
  1705 +
  1706 +- **示例代码**
1598 1707 ```json
1599 1708 {
1600 1709 "fun": "stopQAQuicker",
1601 1710 "dataTag":"1"
1602 1711 }
1603 1712 ```
  1713 +
1604 1714 #### 事件
1605 1715 ##### [sEvtStateCode](#sevtstatecode)
1606 1716 发送指令后返回接收状态
... ... @@ -1618,6 +1728,8 @@ MQTT服务器配置结果检查
1618 1728 |++keySn|string||是|键盘SN|
1619 1729 |++keyValue|string||是|键盘提交的按键值|
1620 1730 |++keyTime|double||是|答题时间，从启动开始计算，单位秒|
  1731 +
  1732 +- **示例代码**
1621 1733 ```json
1622 1734 {
1623 1735 "fun": "fEvtQAQuicker",
... ... @@ -1629,6 +1741,7 @@ MQTT服务器配置结果检查
1629 1741 }]
1630 1742 }
1631 1743 ```
  1744 +
1632 1745 ## 在线测验
1633 1746 ### 标准测验
1634 1747 #### 方法
... ... @@ -1650,6 +1763,8 @@ MQTT服务器配置结果检查
1650 1763 |++option |int||是 |选项数目<br> quesType = 1 有效。<br>quesType = 2 有效。<br>此项缺省时 默认4;<br>范围：1-10。|
1651 1764 |++startNo | int||是| 起始题号 |
1652 1765 |++count | int||是| 题目数量 |
  1766 +
  1767 +- **示例代码**
1653 1768 ```json
1654 1769 //自定义题号
1655 1770 {
... ... @@ -1721,6 +1836,7 @@ MQTT服务器配置结果检查
1721 1836 }
1722 1837 }
1723 1838 ```
  1839 +
1724 1840 ##### stopKpExam
1725 1841 - **主题**：/client/\${baseSN}/send
1726 1842 - **功能描述**：停止标准测验
... ... @@ -1730,12 +1846,15 @@ MQTT服务器配置结果检查
1730 1846 |---|---|---|---|---|
1731 1847 |fun|string|-|是|指令名称|
1732 1848 |dataTag|string|-|否|数据包标识,可为空字符串|
  1849 +
  1850 +- **示例代码**
1733 1851 ```json
1734 1852 {
1735 1853 "fun": "stopKpExam",
1736 1854 "dataTag":"1"
1737 1855 }
1738 1856 ```
  1857 +
1739 1858 ##### rtKpAllowEdited
1740 1859 - **主题**：/client/\${baseSN}/send
1741 1860 - **功能描述**：键盘键盘后，允许键盘修改答案
... ... @@ -1747,6 +1866,8 @@ MQTT服务器配置结果检查
1747 1866 |dataTag|string|-|否|数据包标识,可为空字符串|
1748 1867 |data|object|-|是|传送参数的对象|
1749 1868 |+keySns|array||是|指定的键盘SN数组，空数组表示全部在线键盘|
  1869 +
  1870 +- **示例代码**
1750 1871 ```json
1751 1872 {
1752 1873 "fun": "rtKpAllowEdited",
... ... @@ -1756,6 +1877,7 @@ MQTT服务器配置结果检查
1756 1877 }
1757 1878 }
1758 1879 ```
  1880 +
1759 1881 #### 事件
1760 1882 ##### [sEvtStateCode](#sevtstatecode)
1761 1883 发送指令后返回接收状态
... ... @@ -1773,6 +1895,8 @@ MQTT服务器配置结果检查
1773 1895 |++keySn|string||是|键盘SN|
1774 1896 |++keyValue|string||是|键盘提交的按键值,1:A;2:B表示第1题提交A，第二题提交B|
1775 1897 |++keyTime|double||是|答题时间，从启动开始计算，单位秒|
  1898 +
  1899 +- **示例代码**
1776 1900 ```json
1777 1901 {
1778 1902 "fun": "fEvtKpExam",
... ... @@ -1790,6 +1914,7 @@ MQTT服务器配置结果检查
1790 1914 ]
1791 1915 }
1792 1916 ```
  1917 +
1793 1918 ##### fEvtFinalSubmit
1794 1919 - **主题**：/basestation/\${baseSN}/receive
1795 1920 - **功能描述**：返回键盘手动交卷标识
... ... @@ -1803,6 +1928,8 @@ MQTT服务器配置结果检查
1803 1928 |++keySn|string||是|键盘SN|
1804 1929 |++keyValue|string||是|0 - 未提交(修改键盘运行提交时上报)<br>1 - 已交卷|
1805 1930 |++keyTime|double||是|提交时间，从启动开始计算，单位秒|
  1931 +
  1932 +- **示例代码**
1806 1933 ```json
1807 1934 {
1808 1935 "fun": "fEvtFinalSubmit",
... ... @@ -1813,4 +1940,4 @@ MQTT服务器配置结果检查
1813 1940 "keyTime":3.2
1814 1941 }]
1815 1942 }
1816   -```
1817 1943 \ No newline at end of file
  1944 +```
... ...