孙向锦 / public

Commit 0eb4c75fa1ad165791c1a3c4c3b8584ecd282bb6

Authored by 刘琴
1 parent 62b8607d

增加快速配对、白名单管理、同步签到的对应章节内容

Inline Side-by-side
Showing 1 changed file with 335 additions and 4 deletions
通讯协议-B200W-MQTT协议[外].md
  View file @0eb4c75
... ... @@ -102,6 +102,13 @@ MQTT服务器配置结果检查
102 102 ||设置基站登录名称|[setBsSSID](#setbsssid)|[fEvtBsSSID](#fevtbsssid)||
103 103 |键盘统一设置 - 键盘语言|获取键盘语言|[getBsKpLanguage](#getbskplanguage)|[fEvtBsKpLanguage](#fevtbskplanguage)|
104 104 ||设置键盘语言|[setBsKpLanguage](#setbskplanguage)|[fEvtBsKpLanguage](#fevtbskplanguage)||
  105 +|配对模式 - 快速配对|启动基站快速配对|[startBsFastPair](#startbsfastpair)|[sEvtStateCode](#sevtstatecode)<br>[sEvtBsKpOnlineMsg](#sevtbskponlinemsg)|
  106 +||停止基站快速配对|[stopBsFastPair](#stopbsfastpair)|[sEvtStateCode](#sevtstatecode)|
  107 +|白名单模式 - 白名单管理|获取白名单|[getBsWhitelist](#getbswhitelist)|[fEvtBsWhitelist](#fevtbswhitelist)|
  108 +||设置白名单|[setBsWhitelist](#setbswhitelist)|[sEvtStateCode](#sevtstatecode)<br>[fEvtSetBsWhitelist](#fevtsetbswhitelist)|
  109 +||清空白名单|[clearBsWhitelist](#clearbswhitelist)|[sEvtStateCode](#sevtstatecode)<br>[fEvtBsWhitelist](#fevtbswhitelist)|
  110 +||增加白名单|[addBsWhitelist](#addbswhitelist)|[sEvtStateCode](#sevtstatecode)<br>[fEvtAddBsWhitelist](#fevtaddbswhitelist)<br>[fEvtBsWhitelist](#fevtbswhitelist)|
  111 +||删除白名单|[delBsWhitelist](#delbswhitelist)|[sEvtStateCode](#sevtstatecode)<br>[fEvtDelBsWhitelist](#fevtdelbswhitelist)<br>[fEvtBsWhitelist](#fevtbswhitelist)|
105 112 |网络设置 - TCP/IP参数|获取TCP/IP参数|[getBsTcpipParams](#getbstcpipparams)|[fEvtBsTcpipParams](#fevtbstcpipparams)|
106 113 ||设置TCP/IP参数|[setBsTcpipParams](#setbstcpipparams)|[fEvtBsTcpipParams](#fevtbstcpipparams)||
107 114 |网络设置 - MQTT参数|获取MQTT参数|[getBsMqttParams](#getbsmqttparams)|[fEvtBsMqttParams](#fevtbsmqttparams)|
... ... @@ -122,6 +129,8 @@ MQTT服务器配置结果检查
122 129 ### 签到
123 130 |功能归类|功能|API指令|指令事件|
124 131 |---|---|---|---|
  132 +|同步签到|启动同步签到|[startKpSignIn](#startkpsignin)|[sEvtStateCode](#sevtstatecode)<br>[fEvtKpSignIn](#fevtkpsignin)|
  133 +||停止同步签到|[stopKpSignIn](#stopkpsignin)|[sEvtStateCode](#sevtstatecode)|
125 134 |随时签到|启动随时签到|[rtStartKpSignIn](#rtstartkpsignin)|[sEvtStateCode](#sevtstatecode)<br>[fEvtKpSignIn](#fevtkpsignin)|
126 135 ||停止随时签到|[rtStopKpSignIn](#rtstopkpsignin)|[sEvtStateCode](#sevtstatecode)|
127 136 ||实时PIN签到授权|[rtSetKpLoginAllowed](#rtsetkploginallowed)|[sEvtStateCode](#sevtstatecode)<br>[fEvtKpLoginAllowed](#fevtkploginallowed)|
... ... @@ -842,6 +851,261 @@ MQTT服务器配置结果检查
842 851 }
843 852 }
844 853 ```
  854 +### 配对模式
  855 +#### 方法
  856 +##### startBsFastPair
  857 +- **主题**：/client/\${baseSN}/send
  858 +- **功能描述**：启动快速配对,键盘配对成功返回键盘信息 [sEvtBsKpOnlineMsg](#sevtbskponlinemsg)
  859 +- **参数说明**
  860 +
  861 +|参数名|类型|限制|是否必填|说明|
  862 +|---|---|---|---|---|
  863 +|fun|string|-|是|指令名称|
  864 +|dataTag|string|-|否|数据包标识,可为空字符串|
  865 +
  866 +- **示例代码**
  867 +```json
  868 +{
  869 + "fun":"startBsFastPair",
  870 + "dataTag":"1"
  871 +}
  872 +```
  873 +##### stopBsFastPair
  874 +- **主题**：/client/\${baseSN}/send
  875 +- **功能描述**：停止快速配对
  876 +- **参数说明**
  877 +
  878 +|参数名|类型|限制|是否必填|说明|
  879 +|---|---|---|---|---|
  880 +|fun|string|-|是|指令名称|
  881 +|dataTag|string|-|否|数据包标识,可为空字符串|
  882 +
  883 +- **示例代码**
  884 +```json
  885 +{
  886 + "fun":"stopBsFastPair",
  887 + "dataTag":"1"
  888 +}
  889 +```
  890 +#### 事件
  891 +##### [sEvtStateCode](#sevtstatecode)
  892 +发送指令后返回此事件
  893 +
  894 +##### [sEvtBsKpOnlineMsg](#sevtbskponlinemsg)
  895 +键盘配对成功后在线返回此事件
  896 +
  897 +### 白名单模式
  898 +#### 方法
  899 +##### getBsWhitelist
  900 +- **主题**：/client/\${baseSN}/send
  901 +- **功能描述**：获取基站白名单列表
  902 +- **参数说明**
  903 +
  904 +|参数名|类型|限制|是否必填|说明|
  905 +|---|---|---|---|---|
  906 +|fun|string|-|是|指令名称|
  907 +|dataTag|string|-|否|数据包标识,可为空字符串|
  908 +
  909 +- **示例代码**
  910 +```json
  911 +{
  912 + "fun":"getBsWhitelist",
  913 + "dataTag":"1"
  914 +}
  915 +```
  916 +##### setBsWhitelist
  917 +- **主题**：/client/\${baseSN}/send
  918 +- **功能描述**：设置基站白名单列表，将基站白名单替换为写入的键盘SN列表
  919 +- **参数说明**
  920 +
  921 +|参数名|类型|限制|是否必填|说明|
  922 +|---|---|---|---|---|
  923 +|fun|string|-|是|指令名称|
  924 +|dataTag|string|-|否|数据包标识,可为空字符串|
  925 +|data|object|-|是|传送参数的对象|
  926 +|+keySns|array|-|是|待写入的键盘SN数组，最多不超过200<br>键盘SN为10位数字|
  927 +
  928 +- **示例代码**
  929 +```json
  930 +{
  931 + "fun":"setBsWhitelist",
  932 + "dataTag":"1",
  933 + "data":{
  934 + "keySns":["2024021001","2024021002","2024021003","2024021004"]
  935 + }
  936 +}
  937 +```
  938 +##### clearBsWhitelist
  939 +- **主题**：/client/\${baseSN}/send
  940 +- **功能描述**：清空基站白名单列表
  941 +- **参数说明**
  942 +
  943 +|参数名|类型|限制|是否必填|说明|
  944 +|---|---|---|---|---|
  945 +|fun|string|-|是|指令名称|
  946 +|dataTag|string|-|否|数据包标识,可为空字符串|
  947 +
  948 +- **示例代码**
  949 +```json
  950 +{
  951 + "fun":"clearBsWhitelist",
  952 + "dataTag":"1"
  953 +}
  954 +```
  955 +##### addBsWhitelist
  956 +- **主题**：/client/\${baseSN}/send
  957 +- **功能描述**：添加键盘至基站白名单列表
  958 +- **参数说明**
  959 +
  960 +|参数名|类型|限制|是否必填|说明|
  961 +|---|---|---|---|---|
  962 +|fun|string|-|是|指令名称|
  963 +|dataTag|string|-|否|数据包标识,可为空字符串|
  964 +|data|object|-|是|传送参数的对象|
  965 +|+keySns|array|-|是|待添加的键盘SN列表<br>键盘SN为10位数字|
  966 +
  967 +- **示例代码**
  968 +```json
  969 +{
  970 + "fun":"addBsWhitelist",
  971 + "dataTag":"1",
  972 + "data":{
  973 + "keySns":["2024021001"]
  974 + }
  975 +}
  976 +```
  977 +##### delBsWhitelist
  978 +- **主题**：/client/\${baseSN}/send
  979 +- **功能描述**：从基站白名单列表中删除键盘
  980 +- **参数说明**
  981 +
  982 +|参数名|类型|限制|是否必填|说明|
  983 +|---|---|---|---|---|
  984 +|fun|string|-|是|指令名称|
  985 +|dataTag|string|-|否|数据包标识,可为空字符串|
  986 +|data|object|-|是|传送参数的对象|
  987 +|+keySns|array|-|是|待删除的键盘SN列表<br>键盘SN为10位数字|
  988 +
  989 +- **示例代码**
  990 +```json
  991 +{
  992 + "fun":"delBsWhitelist",
  993 + "dataTag":"1",
  994 + "data":{
  995 + "keySns":["2024021001"]
  996 + }
  997 +}
  998 +```
  999 +#### 事件
  1000 +##### [sEvtStateCode](#sevtstatecode)
  1001 +发送指令后返回此事件
  1002 +
  1003 +##### fEvtBsWhitelist
  1004 +- **主题**：/basestation/\${baseSN}/receive
  1005 +- **功能描述**：返回基站白名单列表
  1006 +- **参数说明**
  1007 +
  1008 +|参数名|类型|限制|非空|说明|
  1009 +|---|---|---|---|---|
  1010 +|fun|string|-|是|指令名称|
  1011 +|dataTag|string|-|否|数据包标识,可为空字符串|
  1012 +|data|object|-|是|传送参数的对象|
  1013 +|+keySns|array||是|基站当前的白名单列表|
  1014 +
  1015 +- **示例代码**
  1016 +```Json
  1017 +{
  1018 + "fun":"fEvtBsWhitelist",
  1019 + "dataTag":"1",
  1020 + "data":{
  1021 + "keySns":["2024021001","2024021002","2024021003","2024021004"]
  1022 + }
  1023 +}
  1024 +```
  1025 +
  1026 +##### fEvtSetBsWhitelist
  1027 +- **主题**：/basestation/\${baseSN}/receive
  1028 +- **功能描述**：返回设置白名单状态
  1029 +- **参数说明**
  1030 +
  1031 +|参数名|类型|限制|非空|说明|
  1032 +|---|---|---|---|---|
  1033 +|fun|string|-|是|指令名称|
  1034 +|dataTag|string|-|否|数据包标识,可为空字符串|
  1035 +|data|array|-|是|传送参数的对象数组|
  1036 +|++keySns|array||是|键盘SN数组|
  1037 +|++state|int||是|键盘SN的写入状态 <br>0-写入成功<br> 1-写入失败|
  1038 +
  1039 +- **示例代码**
  1040 +```Json
  1041 +{
  1042 + "fun":"fEvtSetBsWhitelist",
  1043 + "dataTag":"1",
  1044 + "data":[{
  1045 + "keySns":["2024021001","2024021002"],
  1046 + "state":0
  1047 + },{
  1048 + "keySns":["1211"],
  1049 + "state":1
  1050 + }]
  1051 +}
  1052 +```
  1053 +
  1054 +##### fEvtAddBsWhitelist
  1055 +- **主题**：/basestation/\${baseSN}/receive
  1056 +- **功能描述**：返回增加键盘状态
  1057 +- **参数说明**
  1058 +
  1059 +|参数名|类型|限制|非空|说明|
  1060 +|---|---|---|---|---|
  1061 +|fun|string|-|是|指令名称|
  1062 +|dataTag|string|-|否|数据包标识,可为空字符串|
  1063 +|data|array|-|是|传送参数的对象数组|
  1064 +|++keySns|array||是|键盘SN数组|
  1065 +|++state|int||是|键盘的增加状态 <br>0-增加成功<br> 1-增加失败|
  1066 +
  1067 +- **示例代码**
  1068 +```Json
  1069 +{
  1070 + "fun":"fEvtAddBsWhitelist",
  1071 + "dataTag":"1",
  1072 + "data":[{
  1073 + "keySns":["2024021001","2024021002"],
  1074 + "state":0
  1075 + },{
  1076 + "keySns":["1211"],
  1077 + "state":1
  1078 + }]
  1079 +}
  1080 +```
  1081 +
  1082 +##### fEvtDelBsWhitelist
  1083 +- **主题**：/basestation/\${baseSN}/receive
  1084 +- **功能描述**：返回删除键盘状态
  1085 +- **参数说明**
  1086 +
  1087 +|参数名|类型|限制|非空|说明|
  1088 +|---|---|---|---|---|
  1089 +|fun|string|-|是|指令名称|
  1090 +|dataTag|string|-|否|数据包标识,可为空字符串|
  1091 +|data|array|-|是|传送参数的对象数组|
  1092 +|++keySns|array||是|键盘SN数组|
  1093 +|++state|int||是|键盘的删除状态 <br>0-删除成功<br> 1-删除失败|
  1094 +
  1095 +- **示例代码**
  1096 +```Json
  1097 +{
  1098 + "fun":"fEvtDelBsWhitelist",
  1099 + "dataTag":"1",
  1100 + "data":[{
  1101 + "keySns":["2024021002"],
  1102 + "state":0
  1103 + },{
  1104 + "keySns":["2024021001"],
  1105 + "state":1
  1106 + }]
  1107 +}
  1108 +```
845 1109  
846 1110 ### 网络参数设置
847 1111 #### 方法
... ... @@ -1180,7 +1444,6 @@ MQTT服务器配置结果检查
1180 1444 |+version|string||是|键盘固件版本|
1181 1445 |+model|int||是|键盘型号|
1182 1446 |+voltage|double||是|键盘电量|
1183   -|+keyTime|double||是|提交时间，从启动开始计时，单位秒|
1184 1447  
1185 1448 - **示例代码**
1186 1449  
... ... @@ -1192,8 +1455,7 @@ MQTT服务器配置结果检查
1192 1455 "keySn":"1234567890",
1193 1456 "version":"1.0.0",
1194 1457 "model":67,
1195   - "voltage":2.8,
1196   - "keyTime":0.5
  1458 + "voltage":2.8
1197 1459 }
1198 1460 }
1199 1461 ```
... ... @@ -1348,6 +1610,75 @@ MQTT服务器配置结果检查
1348 1610 ```
1349 1611  
1350 1612 ## 签到
  1613 +### 同步签到
  1614 +#### 方法
  1615 +##### startKpSignIn
  1616 +- **主题**：/client/\${baseSN}/send
  1617 +- **功能描述**：启动同步签到
  1618 +- **参数说明**
  1619 +
  1620 +|参数名|类型|限制|是否必填|说明|
  1621 +|---|---|---|---|---|
  1622 +|fun|string|-|是|指令名称|
  1623 +|dataTag|string|-|否|数据包标识,可为空字符串|
  1624 +|data|object|-|是|传递参数的对象|
  1625 +|+mode|int|-|是|签到模式<br>1-按键签到，可指定按键<br>2-PIN码签到，可指定PIN码长度|
  1626 +|+allowModify |int|-|是 | 修改模式 <br> 0-不可修改 <br>1-可以修改(默认值)|
  1627 +|+pinLen |int|-|是| 可输入pin码的最大长度 1≤N≤14 |
  1628 +|+keyValue |int|-|是 | 指定按键键值 <br> 0: 未指定(OK键签到) <br>1-9: 按键1-9 <br> 10: 按键0 <br> 11: 上键 <br> 12: 下键 <br> 13: OK键 <br> 14: ESC键 <br> 15: Menu键 |
  1629 +|+tipTitle |string|-|否| 提示标题,长度最多不超过16个字节|
  1630 +
  1631 +- **示例代码**
  1632 +```Json
  1633 +//按键签到
  1634 +{
  1635 + "fun":"startKpSignIn",
  1636 + "dataTag":"1",
  1637 + "data":{
  1638 + "mode":1,
  1639 + "allowModify":1,
  1640 + "keyValue":5,
  1641 + "tip":"请按5键签到"
  1642 + }
  1643 +}
  1644 +
  1645 +//pin签到
  1646 +{
  1647 + "fun":"startKpSignIn",
  1648 + "dataTag":"1",
  1649 + "data":{
  1650 + "mode":2,
  1651 + "allowModify":1,
  1652 + "pinLen":6,
  1653 + "tip":"请输入PIN码签到"
  1654 + }
  1655 +}
  1656 +```
  1657 +
  1658 +##### stopKpSignIn
  1659 +- **主题**：/client/\${baseSN}/send
  1660 +- **功能描述**：停止同步签到
  1661 +- **参数说明**
  1662 +
  1663 +|参数名|类型|限制|是否必填|说明|
  1664 +|---|---|---|---|---|
  1665 +|fun|string|-|是|指令名称|
  1666 +|dataTag|string|-|否|数据包标识,可为空字符串|
  1667 +
  1668 +- **示例代码**
  1669 +```Json
  1670 +{
  1671 + "fun":"stopKpSignIn",
  1672 + "dataTag":"1"
  1673 +}
  1674 +```
  1675 +#### 事件
  1676 +##### [sEvtStateCode](#sevtstatecode)
  1677 +发送指令后返回接收状态
  1678 +
  1679 +##### [fEvtKpSignIn](#fevtkpsignin)
  1680 +返回键盘提交的签到数据
  1681 +
1351 1682 ### 随时签到
1352 1683 #### 方法
1353 1684 ##### rtStartKpSignIn
... ... @@ -1376,7 +1707,7 @@ MQTT服务器配置结果检查
1376 1707  
1377 1708 ##### rtStopKpSignIn
1378 1709 - **主题**：/client/\${baseSN}/send
1379   -- **功能描述**：停止签到绑定
  1710 +- **功能描述**：停止随时签到绑定
1380 1711 - **参数说明**
1381 1712  
1382 1713 |参数名|类型|限制|是否必填|说明|
... ...