李外 / Protocol

Commit 6c9391e16aa709579eb1878234c2e2f72cf8dd27

Authored by DMchen
2 parents 80b7abcd ee39e1c1

Merge branch 'master' of http://120.78.57.84/lee/Protocol

Inline Side-by-side
Showing 2 changed files with 335 additions and 4 deletions
通讯协议-B200W-MQTT协议[内部].md
  View file @6c9391e
... ... @@ -100,6 +100,16 @@
100 100 ||设置基站登录名称|[setBsSSID](#setbsssid)|[fEvtBsSSID](#fevtbsssid)||
101 101 |键盘统一设置 - 键盘语言|获取键盘语言|[getBsKpLanguage](#getbskplanguage)|[fEvtBsKpLanguage](#fevtbskplanguage)|
102 102 ||设置键盘语言|[setBsKpLanguage](#setbskplanguage)|[fEvtBsKpLanguage](#fevtbskplanguage)||
  103 +|键盘统一设置 - 暂停休眠|设置键盘暂停休眠状态|[setBsKpPauseSleep](#setbskppausesleep)|[fEvtBsKpPauseSleep](#fevtbskppausesleep)|
  104 +|配对模式 - 快速配对|启动基站快速配对|[startBsFastPair](#startbsfastpair)|[sEvtStateCode](#sevtstatecode)<br>[sEvtBsKpOnlineMsg](#sevtbskponlinemsg)|
  105 +||停止基站快速配对|[stopBsFastPair](#stopbsfastpair)|[sEvtStateCode](#sevtstatecode)|
  106 +|白名单模式 - 白名单管理|获取白名单|[getBsWhitelist](#getbswhitelist)|[fEvtBsWhitelist](#fevtbswhitelist)|
  107 +||设置白名单|[setBsWhitelist](#setbswhitelist)|[sEvtStateCode](#sevtstatecode)<br>[fEvtBsWhitelist](#fevtbswhitelist)|
  108 +||清空白名单|[clearBsWhitelist](#clearbswhitelist)|[sEvtStateCode](#sevtstatecode)<br>[fEvtBsWhitelist](#fevtbswhitelist)|
  109 +||增加白名单|[addBsWhitelist](#addbswhitelist)|[sEvtStateCode](#sevtstatecode)<br>[fEvtAddBsWhitelist](#fevtaddbswhitelist)<br>[fEvtBsWhitelist](#fevtbswhitelist)|
  110 +||删除白名单|[delBsWhitelist](#delbswhitelist)|[sEvtStateCode](#sevtstatecode)<br>[fEvtDelBsWhitelist](#fevtdelbswhitelist)<br>[fEvtBsWhitelist](#fevtbswhitelist)|
  111 +||锁定单个白名单|[lockBsWhitelistKp](#lockbswhitelistkp)|[fEvtLockBsWhitelistKp](#fevtlockbswhitelistkp)|
  112 +||解锁单个白名单|[unlockBsWhitelistKp](#unlockbswhitelistkp)|[fEvtLockBsWhitelistKp](#fevtlockbswhitelistkp)|
103 113 |网络设置 - TCP/IP参数|获取TCP/IP参数|[getBsTcpipParams](#getbstcpipparams)|[fEvtBsTcpipParams](#fevtbstcpipparams)|
104 114 ||设置TCP/IP参数|[setBsTcpipParams](#setbstcpipparams)|[fEvtBsTcpipParams](#fevtbstcpipparams)||
105 115 |网络设置 - MQTT参数|获取MQTT参数|[getBsMqttParams](#getbsmqttparams)|[fEvtBsMqttParams](#fevtbsmqttparams)|
... ... @@ -490,7 +500,7 @@
490 500 - **示例代码**
491 501 ```Json
492 502 {
493   - "fun":"getBsBIC",
  503 + "fun":"setBsBIC",
494 504 "dataTag":"1",
495 505 "data":{
496 506 "value":"sunvote"
... ... @@ -942,6 +952,30 @@
942 952 }
943 953 }
944 954 ```
  955 +
  956 +##### setBsKpPauseSleep
  957 +- **主题**：/client/\${baseSN}/send
  958 +- **功能描述**：设置键盘暂停休眠是否开启<br><font color="red">注意：请谨慎使用本功能，务必在相关测试或功能完成后关闭，否则可能会导致键盘异常耗电</font>
  959 +- **参数说明**
  960 +
  961 +|参数名|类型|限制|是否必填|说明|
  962 +|---|---|---|---|---|
  963 +|fun|string|-|是|指令名称|
  964 +|dataTag|string|-|否|数据包标识,可为空字符串|
  965 +|data|object|-|是|传送参数的对象|
  966 +|+value|string||是|设置键盘暂停休眠是否开启<br>0-关闭暂停休眠<br>1-开启暂停休眠|
  967 +
  968 +- **示例代码**
  969 +```Json
  970 +{
  971 + "fun":"setBsKpPauseSleep",
  972 + "dataTag":"1",
  973 + "data":{
  974 + "value":"1"
  975 + }
  976 +}
  977 +```
  978 +
945 979 #### 事件
946 980 ##### fEvtBsKpLanguage
947 981 - **主题**: /basestation/\${baseSN}/receive
... ... @@ -965,6 +999,303 @@
965 999 }
966 1000 }
967 1001 ```
  1002 +
  1003 +##### fEvtBsKpPauseSleep
  1004 +- **主题**: /basestation/\${baseSN}/receive
  1005 +- **功能描述**：返回暂停键盘休眠开启状态
  1006 +- **参数说明**
  1007 +
  1008 +|参数名|类型|限制|非空|说明|
  1009 +|---|---|---|---|---|
  1010 +|fun|string|-|是|指令名称|
  1011 +|dataTag|string|-|否|数据包标识,可为空字符串|
  1012 +|data|object|-|是|传送参数的对象|
  1013 +|+value|string||是|返回暂停键盘休眠开启状态<br>0-未开启暂停休眠<br>1-开启暂停休眠|
  1014 +
  1015 +- **示例代码**
  1016 +```Json
  1017 +{
  1018 + "fun":"fEvtBsKpPauseSleep",
  1019 + "dataTag":"1",
  1020 + "data":{
  1021 + "value":"0"
  1022 + }
  1023 +}
  1024 +```
  1025 +
  1026 +### 配对模式
  1027 +#### 方法
  1028 +##### startBsFastPair
  1029 +- **主题**：/client/\${baseSN}/send
  1030 +- **功能描述**：启动快速配对,键盘配对成功返回键盘信息 [sEvtBsKpOnlineMsg](#sevtbskponlinemsg)
  1031 +- **参数说明**
  1032 +
  1033 +|参数名|类型|限制|是否必填|说明|
  1034 +|---|---|---|---|---|
  1035 +|fun|string|-|是|指令名称|
  1036 +|dataTag|string|-|否|数据包标识,可为空字符串|
  1037 +```json
  1038 +{
  1039 + "fun": "startBsFastPair",
  1040 + "dataTag":"1"
  1041 +}
  1042 +```
  1043 +##### stopBsFastPair
  1044 +- **主题**：/client/\${baseSN}/send
  1045 +- **功能描述**：停止快速配对
  1046 +- **参数说明**
  1047 +
  1048 +|参数名|类型|限制|是否必填|说明|
  1049 +|---|---|---|---|---|
  1050 +|fun|string|-|是|指令名称|
  1051 +|dataTag|string|-|否|数据包标识,可为空字符串|
  1052 +```json
  1053 +{
  1054 + "fun": "stopBsFastPair",
  1055 + "dataTag":"1"
  1056 +}
  1057 +```
  1058 +#### 事件
  1059 +##### [sEvtStateCode](#sevtstatecode)
  1060 +发送指令后返回此事件
  1061 +
  1062 +##### [sEvtBsKpOnlineMsg](#sevtbskponlinemsg)
  1063 +键盘配对成功后在线返回此事件
  1064 +
  1065 +### 白名单模式
  1066 +#### 方法
  1067 +##### getBsWhitelist
  1068 +- **主题**：/client/\${baseSN}/send
  1069 +- **功能描述**：获取基站白名单列表
  1070 +- **参数说明**
  1071 +
  1072 +|参数名|类型|限制|是否必填|说明|
  1073 +|---|---|---|---|---|
  1074 +|fun|string|-|是|指令名称|
  1075 +|dataTag|string|-|否|数据包标识,可为空字符串|
  1076 +```json
  1077 +{
  1078 + "fun": "getBsWhitelist",
  1079 + "dataTag":"1"
  1080 +}
  1081 +```
  1082 +##### setBsWhitelist
  1083 +- **主题**：/client/\${baseSN}/send
  1084 +- **功能描述**：设置基站白名单列表，将基站白名单替换为写入的键盘SN列表
  1085 +- **参数说明**
  1086 +
  1087 +|参数名|类型|限制|是否必填|说明|
  1088 +|---|---|---|---|---|
  1089 +|fun|string|-|是|指令名称|
  1090 +|dataTag|string|-|否|数据包标识,可为空字符串|
  1091 +|data|object|-|是|传送参数的对象|
  1092 +|+keySns|array|-|是|待写入的键盘SN数组|
  1093 +```json
  1094 +{
  1095 + "fun": "setBsWhitelist",
  1096 + "dataTag":"1",
  1097 + "data":{
  1098 + "keySns":["2024021001","2024021002","2024021003","2024021004"]
  1099 + }
  1100 +}
  1101 +```
  1102 +##### clearBsWhitelist
  1103 +- **主题**：/client/\${baseSN}/send
  1104 +- **功能描述**：清空基站白名单列表
  1105 +- **参数说明**
  1106 +
  1107 +|参数名|类型|限制|是否必填|说明|
  1108 +|---|---|---|---|---|
  1109 +|fun|string|-|是|指令名称|
  1110 +|dataTag|string|-|否|数据包标识,可为空字符串|
  1111 +```json
  1112 +{
  1113 + "fun": "clearBsWhitelist",
  1114 + "dataTag":"1"
  1115 +}
  1116 +```
  1117 +##### addBsWhitelist
  1118 +- **主题**：/client/\${baseSN}/send
  1119 +- **功能描述**：添加键盘至基站白名单列表
  1120 +- **参数说明**
  1121 +
  1122 +|参数名|类型|限制|是否必填|说明|
  1123 +|---|---|---|---|---|
  1124 +|fun|string|-|是|指令名称|
  1125 +|dataTag|string|-|否|数据包标识,可为空字符串|
  1126 +|data|object|-|是|传送参数的对象|
  1127 +|+keySns|array|-|是|待添加的键盘SN列表|
  1128 +```json
  1129 +{
  1130 + "fun": "addBsWhitelist",
  1131 + "dataTag":"1",
  1132 + "data":{
  1133 + "keySns":["2024021001"]
  1134 + }
  1135 +}
  1136 +```
  1137 +##### delBsWhitelist
  1138 +- **主题**：/client/\${baseSN}/send
  1139 +- **功能描述**：从基站白名单列表中删除键盘
  1140 +- **参数说明**
  1141 +
  1142 +|参数名|类型|限制|是否必填|说明|
  1143 +|---|---|---|---|---|
  1144 +|fun|string|-|是|指令名称|
  1145 +|dataTag|string|-|否|数据包标识,可为空字符串|
  1146 +|data|object|-|是|传送参数的对象|
  1147 +|+keySns|array|-|是|待删除的键盘SN列表|
  1148 +```json
  1149 +{
  1150 + "fun": "delBsWhitelist",
  1151 + "dataTag":"1",
  1152 + "data":{
  1153 + "keySns":["2024021001"]
  1154 + }
  1155 +}
  1156 +```
  1157 +##### lockBsWhitelistKp
  1158 +- **主题**：/client/\${baseSN}/send
  1159 +- **功能描述**：锁定指定的键盘SN，基站限制容量时，被锁定键盘SN不会被新刷卡加入的键盘挤出
  1160 +- **参数说明**
  1161 +
  1162 +|参数名|类型|限制|是否必填|说明|
  1163 +|---|---|---|---|---|
  1164 +|fun|string|-|是|指令名称|
  1165 +|dataTag|string|-|否|数据包标识,可为空字符串|
  1166 +|data|object|-|是|传送参数的对象|
  1167 +|+keySns|array|-|是|待锁定的键盘SN列表，空数组代表锁定所有键盘|
  1168 +```json
  1169 +{
  1170 + "fun": "lockBsWhitelistKp",
  1171 + "dataTag":"1",
  1172 + "data":{
  1173 + "keySns":["2024021001"]
  1174 + }
  1175 +}
  1176 +```
  1177 +##### unlockBsWhitelistKp
  1178 +- **主题**：/client/\${baseSN}/send
  1179 +- **功能描述**：解锁键盘SN
  1180 +- **参数说明**
  1181 +
  1182 +|参数名|类型|限制|是否必填|说明|
  1183 +|---|---|---|---|---|
  1184 +|fun|string|-|是|指令名称|
  1185 +|dataTag|string|-|否|数据包标识,可为空字符串|
  1186 +|data|object|-|是|传送参数的对象|
  1187 +|+keySns|array|-|是|待解锁的键盘SN列表，空数组代表解锁所有键盘|
  1188 +```json
  1189 +{
  1190 + "fun": "unlockBsWhitelistKp",
  1191 + "dataTag":"1",
  1192 + "data":{
  1193 + "keySn":["2024021001"]
  1194 + }
  1195 +}
  1196 +```
  1197 +#### 事件
  1198 +##### [sEvtStateCode](#sevtstatecode)
  1199 +发送指令后返回此事件
  1200 +
  1201 +##### fEvtBsWhitelist
  1202 +- **主题**：/basestation/\${baseSN}/receive
  1203 +- **功能描述**：返回基站白名单列表
  1204 +- **参数说明**
  1205 +
  1206 +|参数名|类型|限制|非空|说明|
  1207 +|---|---|---|---|---|
  1208 +|fun|string|-|是|指令名称|
  1209 +|dataTag|string|-|否|数据包标识,可为空字符串|
  1210 +|data|object|-|是|传送参数的对象|
  1211 +|+keySns|array||是|基站当前的白名单列表|
  1212 +
  1213 +- **示例代码**
  1214 +```Json
  1215 +{
  1216 + "fun":"fEvtBsWhitelist",
  1217 + "dataTag":"1",
  1218 + "data":{
  1219 + "keySns":["2024021001","2024021002","2024021003","2024021004"]
  1220 + }
  1221 +}
  1222 +```
  1223 +
  1224 +##### fEvtAddBsWhitelist
  1225 +- **主题**：/basestation/\${baseSN}/receive
  1226 +- **功能描述**：返回增加键盘状态
  1227 +- **参数说明**
  1228 +
  1229 +|参数名|类型|限制|非空|说明|
  1230 +|---|---|---|---|---|
  1231 +|fun|string|-|是|指令名称|
  1232 +|dataTag|string|-|否|数据包标识,可为空字符串|
  1233 +|data|array|-|是|传送参数的对象数组|
  1234 +|++keySn|string||是|键盘SN|
  1235 +|++state|int||是|键盘的增加状态 <br>0-增加成功<br> 1-增加失败|
  1236 +
  1237 +- **示例代码**
  1238 +```Json
  1239 +{
  1240 + "fun":"fEvtAddBsWhitelist",
  1241 + "dataTag":"1",
  1242 + "data":[{
  1243 + "keySn":"2024021001",
  1244 + "state":0
  1245 + }]
  1246 +}
  1247 +```
  1248 +
  1249 +##### fEvtDelBsWhitelist
  1250 +- **主题**：/basestation/\${baseSN}/receive
  1251 +- **功能描述**：返回删除键盘状态
  1252 +- **参数说明**
  1253 +
  1254 +|参数名|类型|限制|非空|说明|
  1255 +|---|---|---|---|---|
  1256 +|fun|string|-|是|指令名称|
  1257 +|dataTag|string|-|否|数据包标识,可为空字符串|
  1258 +|data|array|-|是|传送参数的对象数组|
  1259 +|++keySn|string||是|键盘SN|
  1260 +|++state|int||是|键盘的删除状态 <br>0-删除成功<br> 1-删除失败|
  1261 +
  1262 +- **示例代码**
  1263 +```Json
  1264 +{
  1265 + "fun":"fEvtDelBsWhitelist",
  1266 + "dataTag":"1",
  1267 + "data":[{
  1268 + "keySn":"2024021001",
  1269 + "state":0
  1270 + }]
  1271 +}
  1272 +```
  1273 +
  1274 +##### fEvtLockBsWhitelistKp
  1275 +- **主题**：/basestation/\${baseSN}/receive
  1276 +- **功能描述**：返回键盘锁定状态
  1277 +- **参数说明**
  1278 +
  1279 +|参数名|类型|限制|非空|说明|
  1280 +|---|---|---|---|---|
  1281 +|fun|string|-|是|指令名称|
  1282 +|dataTag|string|-|否|数据包标识,可为空字符串|
  1283 +|data|array|-|是|传送参数的对象数组|
  1284 +|++keySn|string||是|解锁或锁定的键盘SN|
  1285 +|++state|int||是|键盘的锁定状态 <br>0-未锁定<br> 1-锁定|
  1286 +
  1287 +- **示例代码**
  1288 +```Json
  1289 +{
  1290 + "fun":"fEvtLockBsWhitelistKp",
  1291 + "dataTag":"1",
  1292 + "data":[{
  1293 + "keySn":"2024021001",
  1294 + "state":1
  1295 + }]
  1296 +}
  1297 +```
  1298 +
968 1299 ### 网络参数设置
969 1300 #### 方法
970 1301 ##### getBsTcpipParams
... ... @@ -1155,7 +1486,7 @@
1155 1486 |dataTag|string|-|否|数据包标识,可为空字符串|
1156 1487 |data|object|-|是|传送参数的对象|
1157 1488 |+index|int||是|数据包序号，从1开始，传0代表日志已传完|
1158   -|+info|string||是|日志内容|
  1489 +|+info|string||是|日志内容<br><font color="red">日志的时间依赖于基站授时，需要加上时区得到具体的时间</font>|
1159 1490  
1160 1491 - **示例代码**
1161 1492 ```Json
... ... @@ -2398,7 +2729,7 @@
2398 2729 |dataTag|string|-|否|数据包标识,可为空字符串|
2399 2730 |data|array|-|是|传送参数的对象数组|
2400 2731 |++keySn|string||是|键盘SN|
2401   -|++keyValue|string||是|0 - 未提交(修改键盘运行提交时上报)<br>1 - 已交卷|
  2732 +|++keyValue|string||是|0 - 未提交(提交完成后，允许键盘修改答案时上报)<br>1 - 已交卷|
2402 2733 |++keyTime|double||是|提交时间，从启动开始计算，单位秒|
2403 2734 ```json
2404 2735 {
... ...
通讯协议-B200W-MQTT协议[外].md
  View file @6c9391e
... ... @@ -1791,7 +1791,7 @@
1791 1791 |dataTag|string|-|否|数据包标识,可为空字符串|
1792 1792 |data|array|-|是|传送参数的对象数组|
1793 1793 |++keySn|string||是|键盘SN|
1794   -|++keyValue|string||是|0 - 未提交(修改键盘运行提交时上报)<br>1 - 已交卷|
  1794 +|++keyValue|string||是|0 - 未提交(提交完成后，允许键盘修改答案时上报)<br>1 - 已交卷|
1795 1795 |++keyTime|double||是|提交时间，从启动开始计算，单位秒|
1796 1796 ```json
1797 1797 {
... ...