Commit 61c47532748691f6a5ecf4515f8879b11ab9b141

Authored by 刘琴
1 parent 02f1c6c3

修正格式

通讯协议-B200W-MQTT协议[外].md
... ... @@ -159,6 +159,7 @@ MQTT服务器配置结果检查
159 159 |+version|string||否|基站固件版本|
160 160  
161 161 - **示例代码**
  162 +
162 163 ```json
163 164 //连接成功
164 165 {
... ... @@ -194,6 +195,7 @@ MQTT服务器配置结果检查
194 195 |+value|int||是|有冲突的信道|
195 196  
196 197 - **示例代码**
  198 +
197 199 ```json
198 200 {
199 201 "fun":"sEvtBsChannelConflict",
... ... @@ -218,6 +220,7 @@ MQTT服务器配置结果检查
218 220 |+value|int||是|刷卡的状态<br>1-成功<br>2-失败|
219 221  
220 222 - **示例代码**
  223 +
221 224 ```json
222 225 {
223 226 "fun":"sEvtBsNfcResults",
... ... @@ -245,6 +248,7 @@ MQTT服务器配置结果检查
245 248 |+voltage|double||是|键盘电压|
246 249  
247 250 - **示例代码**
  251 +
248 252 ```json
249 253 {
250 254 "fun":"sEvtBsKpOnlineMsg",
... ... @@ -286,6 +290,7 @@ MQTT服务器配置结果检查
286 290 |60001|此功能必须指定键盘SN|
287 291  
288 292 - **示例代码**
  293 +
289 294 ```json
290 295 {
291 296 "fun":"sEvtStateCode",
... ... @@ -313,6 +318,7 @@ MQTT服务器配置结果检查
313 318 |fun|string|-|是|固定指令名称|
314 319 |dataTag|string|-|否|数据包标识|
315 320 - **示例代码**
  321 +
316 322 ```json
317 323 {
318 324 "fun":"getBsOnlineState",
... ... @@ -330,6 +336,7 @@ MQTT服务器配置结果检查
330 336 |fun|string|-|是|固定指令名称|
331 337 |dataTag|string|-|否|数据包标识|
332 338 - **示例代码**
  339 +
333 340 ```json
334 341 {
335 342 "fun":"getBsConnectState",
... ... @@ -358,6 +365,7 @@ MQTT服务器配置结果检查
358 365 |+baseSN|string||否|基站SN|
359 366  
360 367 - **示例代码**
  368 +
361 369 ```json
362 370 //连接成功
363 371 {
... ... @@ -387,6 +395,7 @@ MQTT服务器配置结果检查
387 395 |+timeStamp|long ||否|当前时间的时间戳|
388 396  
389 397 - **示例代码**
  398 +
390 399 ```json
391 400 {
392 401 "fun":"timeSync",
... ... @@ -414,6 +423,7 @@ MQTT服务器配置结果检查
414 423 |dataTag|string|-|否|数据包标识,可为空字符串|
415 424  
416 425 - **示例代码**
  426 +
417 427 ```json
418 428 {
419 429 "fun":"getBsModel",
... ... @@ -432,6 +442,7 @@ MQTT服务器配置结果检查
432 442 |dataTag|string|-|否|数据包标识,可为空字符串|
433 443  
434 444 - **示例代码**
  445 +
435 446 ```json
436 447 {
437 448 "fun":"getBsFWVersion",
... ... @@ -453,6 +464,7 @@ MQTT服务器配置结果检查
453 464 |+value|string|-|是|基站的出厂编码|
454 465  
455 466 - **示例代码**
  467 +
456 468 ```json
457 469 {
458 470 "fun":"fEvtBsSN",
... ... @@ -524,6 +536,7 @@ MQTT服务器配置结果检查
524 536 |dataTag|string|-|否|数据包标识,可为空字符串|
525 537  
526 538 - **示例代码**
  539 +
527 540 ```json
528 541 {
529 542 "fun":"getBsPairCode",
... ... @@ -542,6 +555,7 @@ MQTT服务器配置结果检查
542 555 |dataTag|string|-|否|数据包标识,可为空字符串|
543 556  
544 557 - **示例代码**
  558 +
545 559 ```json
546 560 {
547 561 "fun":"getBsNfcLogin",
... ... @@ -562,6 +576,7 @@ MQTT服务器配置结果检查
562 576 |+value|string|-|是|设置的基站刷卡配对状态<br>0-关闭刷卡配对<br>1-开启刷卡配对|
563 577  
564 578 - **示例代码**
  579 +
565 580 ```json
566 581 {
567 582 "fun":"setBsNfcLogin",
... ... @@ -583,6 +598,7 @@ MQTT服务器配置结果检查
583 598 |dataTag|string|-|否|数据包标识,可为空字符串|
584 599  
585 600 - **示例代码**
  601 +
586 602 ```json
587 603 {
588 604 "fun":"getBsChannel",
... ... @@ -603,6 +619,7 @@ MQTT服务器配置结果检查
603 619 |+value|string|-|是|设置的基站信道,可设范围:1-80|
604 620  
605 621 - **示例代码**
  622 +
606 623 ```json
607 624 {
608 625 "fun":"setBsChannel",
... ... @@ -627,6 +644,7 @@ MQTT服务器配置结果检查
627 644 |+value|string||是|基站的配对码|
628 645  
629 646 - **示例代码**
  647 +
630 648 ```json
631 649 {
632 650 "fun":"fEvtBsPairCode",
... ... @@ -650,6 +668,7 @@ MQTT服务器配置结果检查
650 668 |+value|string||是|基站信道|
651 669  
652 670 - **示例代码**
  671 +
653 672 ```json
654 673 {
655 674 "fun":"fEvtBsChannel",
... ... @@ -673,6 +692,7 @@ MQTT服务器配置结果检查
673 692 |+value|string||是|0-关闭 1-开启|
674 693  
675 694 - **示例代码**
  695 +
676 696 ```json
677 697 {
678 698 "fun":"fEvtBsNfcLogin",
... ... @@ -697,6 +717,7 @@ MQTT服务器配置结果检查
697 717 |dataTag|string|-|否|数据包标识|
698 718  
699 719 - **示例代码**
  720 +
700 721 ```json
701 722 {
702 723 "fun":"getBsSSID",
... ... @@ -717,6 +738,7 @@ MQTT服务器配置结果检查
717 738 |+value|string||是|设置的基站SSID,最长12字符|
718 739  
719 740 - **示例代码**
  741 +
720 742 ```json
721 743 {
722 744 "fun":"setBsSSID",
... ... @@ -741,6 +763,7 @@ MQTT服务器配置结果检查
741 763 |+value|string||是|基站名称|
742 764  
743 765 - **示例代码**
  766 +
744 767 ```json
745 768 {
746 769 "fun":"fEvtBsSSID",
... ... @@ -764,6 +787,7 @@ MQTT服务器配置结果检查
764 787 |dataTag|string|-|否|数据包标识,可为空字符串|
765 788  
766 789 - **示例代码**
  790 +
767 791 ```json
768 792 {
769 793 "fun":"getBsKpLanguage",
... ... @@ -784,6 +808,7 @@ MQTT服务器配置结果检查
784 808 |+value|string||是|设置键盘显示的语言<br>1-简体中文<br>2-英文|
785 809  
786 810 - **示例代码**
  811 +
787 812 ```json
788 813 {
789 814 "fun":"setBsKpLanguage",
... ... @@ -808,6 +833,7 @@ MQTT服务器配置结果检查
808 833 |+value|string||是|设置键盘显示的语言<br>1-简体中文<br>2-英文|
809 834  
810 835 - **示例代码**
  836 +
811 837 ```json
812 838 {
813 839 "fun":"fEvtBsKpLanguage",
... ... @@ -831,6 +857,7 @@ MQTT服务器配置结果检查
831 857 |dataTag|string|-|否|数据包标识,可为空字符串|
832 858  
833 859 - **示例代码**
  860 +
834 861 ```json
835 862 {
836 863 "fun":"getBsTcpipParams",
... ... @@ -854,6 +881,7 @@ MQTT服务器配置结果检查
854 881 |+ipAllocation|int||否|基站IP获取方式<br>0 - 手动指定<br>1 - DHCP获取|
855 882  
856 883 - **示例代码**
  884 +
857 885 ```json
858 886 {
859 887 "fun":"setBsTcpipParams",
... ... @@ -878,6 +906,7 @@ MQTT服务器配置结果检查
878 906 |dataTag|string|-|否|数据包标识,可为空字符串|
879 907  
880 908 - **示例代码**
  909 +
881 910 ```json
882 911 {
883 912 "fun":"getBsMqttParams",
... ... @@ -902,6 +931,7 @@ MQTT服务器配置结果检查
902 931 |+interval|int|>=10|否|基站连接服务器失败后重连的间隔时长,单位秒|
903 932  
904 933 - **示例代码**
  934 +
905 935 ```json
906 936 {
907 937 "fun":"setBsMqttParams",
... ... @@ -934,6 +964,7 @@ MQTT服务器配置结果检查
934 964 |+ipAllocation|int||否|基站IP获取方式<br>0 - 手动指定<br>1 - DHCP获取|
935 965  
936 966 - **示例代码**
  967 +
937 968 ```json
938 969 {
939 970 "fun":"fEvtBsTcpipParams",
... ... @@ -965,6 +996,7 @@ MQTT服务器配置结果检查
965 996 |+interval|int|>=10|否|基站连接服务器失败后重连的间隔时长,单位秒|
966 997  
967 998 - **示例代码**
  999 +
968 1000 ```json
969 1001 {
970 1002 "fun":"fEvtBsMqttParams",
... ... @@ -992,6 +1024,7 @@ MQTT服务器配置结果检查
992 1024 |dataTag|string|-|否|数据包标识,可为空字符串|
993 1025  
994 1026 - **示例代码**
  1027 +
995 1028 ```json
996 1029 {
997 1030 "fun":"getBsLogInfo",
... ... @@ -1020,6 +1053,7 @@ MQTT服务器配置结果检查
1020 1053 |++info|string||否|设置的反馈信息<br>不同键盘可设置不同反馈信息|
1021 1054  
1022 1055 - **示例代码**
  1056 +
1023 1057 ```json
1024 1058 //分别提示
1025 1059 {
... ... @@ -1067,6 +1101,7 @@ MQTT服务器配置结果检查
1067 1101 |++state|string||是|设置的提示语是否成功<br>0 - 成功<br>1 - 失败|
1068 1102  
1069 1103 - **示例代码**
  1104 +
1070 1105 ```json
1071 1106 {
1072 1107 "fun": "fEvtSetKpUserPrompt",
... ... @@ -1101,6 +1136,7 @@ MQTT服务器配置结果检查
1101 1136 |dataTag|string|-|否|数据包标识,可为空字符串|
1102 1137  
1103 1138 - **示例代码**
  1139 +
1104 1140 ```json
1105 1141 {
1106 1142 "fun": "startGetKpOnline",
... ... @@ -1119,6 +1155,7 @@ MQTT服务器配置结果检查
1119 1155 |dataTag|string|-|否|数据包标识,可为空字符串|
1120 1156  
1121 1157 - **示例代码**
  1158 +
1122 1159 ```json
1123 1160 {
1124 1161 "fun": "stopGetKpOnline",
... ... @@ -1148,6 +1185,7 @@ MQTT服务器配置结果检查
1148 1185 |+keySns|array||否|需要执行指令的键盘SN数组,空数组表示所有键盘|
1149 1186  
1150 1187 - **示例代码**
  1188 +
1151 1189 ```json
1152 1190 {
1153 1191 "fun":"remoteKpSleep",
... ... @@ -1179,6 +1217,7 @@ MQTT服务器配置结果检查
1179 1217 |++info|string||是|设置的绑定信息,一般为学生姓名<br>最长48个字符,显示在键盘左上角|
1180 1218  
1181 1219 - **示例代码**
  1220 +
1182 1221 ```json
1183 1222 {
1184 1223 "fun": "rtSetKpBindingInfo",
... ... @@ -1209,6 +1248,7 @@ MQTT服务器配置结果检查
1209 1248 |+keySns|array||否|需要清除绑定信息键盘SN数组,<br>空数组表示清空所有键盘|
1210 1249  
1211 1250 - **示例代码**
  1251 +
1212 1252 ```json
1213 1253 {
1214 1254 "fun": "clearKpBindingInfo",
... ... @@ -1237,6 +1277,7 @@ MQTT服务器配置结果检查
1237 1277 |++state|string||是|设置的绑定信息是否成功<br>0 - 成功<br>1 - 失败|
1238 1278  
1239 1279 - **示例代码**
  1280 +
1240 1281 ```json
1241 1282 {
1242 1283 "fun": "fEvtKpBindingInfo",
... ... @@ -1267,6 +1308,7 @@ MQTT服务器配置结果检查
1267 1308 |+state|string||是|设置的绑定信息是否成功<br>0 - 成功<br>1 - 失败|
1268 1309  
1269 1310 - **示例代码**
  1311 +
1270 1312 ```json
1271 1313 {
1272 1314 "fun": "fEvtClearKpBindingInfo",
... ... @@ -1293,6 +1335,7 @@ MQTT服务器配置结果检查
1293 1335 |+mode|int|-|是|签到模式<br>2-PIN码签到,输入pin码后由应用程序决定是否授权|
1294 1336  
1295 1337 - **示例代码**
  1338 +
1296 1339 ```json
1297 1340 {
1298 1341 "fun": "rtStartKpSignIn",
... ... @@ -1314,6 +1357,7 @@ MQTT服务器配置结果检查
1314 1357 |dataTag|string|-|否|数据包标识,可为空字符串|
1315 1358  
1316 1359 - **示例代码**
  1360 +
1317 1361 ```json
1318 1362 {
1319 1363 "fun": "rtStopKpSignIn",
... ... @@ -1335,6 +1379,7 @@ MQTT服务器配置结果检查
1335 1379 |+state|int|-|是|1-授权成功<br>2-授权失败<br>3-解除已授权|
1336 1380  
1337 1381 - **示例代码**
  1382 +
1338 1383 ```json
1339 1384 {
1340 1385 "fun": "rtSetKpLoginAllowed",
... ... @@ -1365,6 +1410,7 @@ MQTT服务器配置结果检查
1365 1410 |++keyTime|double||是|答题时间,从启动开始计算,单位秒|
1366 1411  
1367 1412 - **示例代码**
  1413 +
1368 1414 ```json
1369 1415 {
1370 1416 "fun": "fEvtKpSignIn",
... ... @@ -1397,6 +1443,7 @@ MQTT服务器配置结果检查
1397 1443 |+state|string||是|0-执行成功<br> 1-执行失败|
1398 1444  
1399 1445 - **示例代码**
  1446 +
1400 1447 ```json
1401 1448 {
1402 1449 "fun": "fEvtKpLoginAllowed",
... ... @@ -1427,6 +1474,7 @@ MQTT服务器配置结果检查
1427 1474 |+tip|string||否|提示的标题,长度不超过16字符|
1428 1475  
1429 1476 - **示例代码**
  1477 +
1430 1478 ```json
1431 1479 {
1432 1480 "fun": "startQATrueFalse",
... ... @@ -1451,6 +1499,7 @@ MQTT服务器配置结果检查
1451 1499 |dataTag|string|-|否|数据包标识,可为空字符串|
1452 1500  
1453 1501 - **示例代码**
  1502 +
1454 1503 ```json
1455 1504 {
1456 1505 "fun": "stopQATrueFalse",
... ... @@ -1477,6 +1526,7 @@ MQTT服务器配置结果检查
1477 1526 |++keyTime|double||是|答题时间,从启动开始计算,单位秒|
1478 1527  
1479 1528 - **示例代码**
  1529 +
1480 1530 ```json
1481 1531 {
1482 1532 "fun": "fEvtQATrueFalse",
... ... @@ -1511,6 +1561,7 @@ MQTT服务器配置结果检查
1511 1561 |+tip|string||否|提示的标题,长度不超过16字符|
1512 1562  
1513 1563 - **示例代码**
  1564 +
1514 1565 ```json
1515 1566 {
1516 1567 "fun": "startQAChoice",
... ... @@ -1538,6 +1589,7 @@ MQTT服务器配置结果检查
1538 1589 |dataTag|string|-|否|数据包标识,可为空字符串|
1539 1590  
1540 1591 - **示例代码**
  1592 +
1541 1593 ```json
1542 1594 {
1543 1595 "fun": "stopQAChoice",
... ... @@ -1564,6 +1616,7 @@ MQTT服务器配置结果检查
1564 1616 |++keyTime|double||是|答题时间,从启动开始计算,单位秒|
1565 1617  
1566 1618 - **示例代码**
  1619 +
1567 1620 ```json
1568 1621 {
1569 1622 "fun": "fEvtQAChoice",
... ... @@ -1597,6 +1650,7 @@ MQTT服务器配置结果检查
1597 1650 |+tip|string||否|提示的标题,长度不超过16字符|
1598 1651  
1599 1652 - **示例代码**
  1653 +
1600 1654 ```json
1601 1655 {
1602 1656 "fun": "startQANum",
... ... @@ -1624,6 +1678,7 @@ MQTT服务器配置结果检查
1624 1678 |dataTag|string|-|否|数据包标识,可为空字符串|
1625 1679  
1626 1680 - **示例代码**
  1681 +
1627 1682 ```json
1628 1683 {
1629 1684 "fun": "stopQANum",
... ... @@ -1650,6 +1705,7 @@ MQTT服务器配置结果检查
1650 1705 |++keyTime|double||是|答题时间,从启动开始计算,单位秒|
1651 1706  
1652 1707 - **示例代码**
  1708 +
1653 1709 ```json
1654 1710 {
1655 1711 "fun": "fEvtQANum",
... ... @@ -1680,6 +1736,7 @@ MQTT服务器配置结果检查
1680 1736 |+tip|string||否|提示的标题,长度不超过16字符|
1681 1737  
1682 1738 - **示例代码**
  1739 +
1683 1740 ```json
1684 1741 {
1685 1742 "fun": "startQAQuicker",
... ... @@ -1704,6 +1761,7 @@ MQTT服务器配置结果检查
1704 1761 |dataTag|string|-|否|数据包标识,可为空字符串|
1705 1762  
1706 1763 - **示例代码**
  1764 +
1707 1765 ```json
1708 1766 {
1709 1767 "fun": "stopQAQuicker",
... ... @@ -1730,6 +1788,7 @@ MQTT服务器配置结果检查
1730 1788 |++keyTime|double||是|答题时间,从启动开始计算,单位秒|
1731 1789  
1732 1790 - **示例代码**
  1791 +
1733 1792 ```json
1734 1793 {
1735 1794 "fun": "fEvtQAQuicker",
... ... @@ -1765,6 +1824,7 @@ MQTT服务器配置结果检查
1765 1824 |++count | int||是| 题目数量 |
1766 1825  
1767 1826 - **示例代码**
  1827 +
1768 1828 ```json
1769 1829 //自定义题号
1770 1830 {
... ... @@ -1848,6 +1908,7 @@ MQTT服务器配置结果检查
1848 1908 |dataTag|string|-|否|数据包标识,可为空字符串|
1849 1909  
1850 1910 - **示例代码**
  1911 +
1851 1912 ```json
1852 1913 {
1853 1914 "fun": "stopKpExam",
... ... @@ -1868,6 +1929,7 @@ MQTT服务器配置结果检查
1868 1929 |+keySns|array||是|指定的键盘SN数组,空数组表示全部在线键盘|
1869 1930  
1870 1931 - **示例代码**
  1932 +
1871 1933 ```json
1872 1934 {
1873 1935 "fun": "rtKpAllowEdited",
... ... @@ -1897,6 +1959,7 @@ MQTT服务器配置结果检查
1897 1959 |++keyTime|double||是|答题时间,从启动开始计算,单位秒|
1898 1960  
1899 1961 - **示例代码**
  1962 +
1900 1963 ```json
1901 1964 {
1902 1965 "fun": "fEvtKpExam",
... ... @@ -1930,6 +1993,7 @@ MQTT服务器配置结果检查
1930 1993 |++keyTime|double||是|提交时间,从启动开始计算,单位秒|
1931 1994  
1932 1995 - **示例代码**
  1996 +
1933 1997 ```json
1934 1998 {
1935 1999 "fun": "fEvtFinalSubmit",
... ...