李外 / Protocol

Commit d32784e9a74379f98d3cf879e43430262e5f6d49

Authored by 刘琴
1 parent 86c254ec

修改设置白名单返回事件，增加基站系统复位和断电复位指令

Inline Side-by-side
Showing 1 changed file with 96 additions and 31 deletions
通讯协议-B200W-MQTT协议[内部].md
  View file @d32784e
... ... @@ -74,6 +74,9 @@
74 74 |dataTag| 数据标签，用于对应收发数据|长度不超过4，可为0-9a-zA-Z的组合|
75 75 |data| 数据内容|对象或者数组，可为空|
76 76  
  77 +<font color="red">注意：基站接收指令数据单次不超过2K长度，在指定键盘发送指令时，如果指令长度超出限制，建议将指令进行拆分，分次发送，如果是所有键盘执行的指令，可将keySns设为空数组不使用指定键盘的模式</font>
  78 +
  79 +
77 80 ## 功能速查一览表
78 81 ### 基站管理
79 82 |功能归类|功能|API指令|指令/系统事件|
... ... @@ -100,13 +103,13 @@
100 103 ||设置基站登录名称|[setBsSSID](#setbsssid)|[fEvtBsSSID](#fevtbsssid)||
101 104 |键盘统一设置 - 键盘语言|获取键盘语言|[getBsKpLanguage](#getbskplanguage)|[fEvtBsKpLanguage](#fevtbskplanguage)|
102 105 ||设置键盘语言|[setBsKpLanguage](#setbskplanguage)|[fEvtBsKpLanguage](#fevtbskplanguage)||
103   -|键盘统一设置 - 键盘休眠|设置键盘休眠等级|[setBsKpSleepLevel](#setbskpsleeplevel)|[fEvtBsKpSleepLevel](#fevtbskpsleeplevel)|
104   -||获取键盘休眠等级|[getBsKpSleepLevel](#getbskpsleeplevel)|[fEvtBsKpSleepLevel](#fevtbskpsleeplevel)|
  106 +|键盘统一设置 - 键盘休眠|<font color="red">设置键盘休眠等级(内)</font>|[setBsKpSleepLevel](#setbskpsleeplevel)|[fEvtBsKpSleepLevel](#fevtbskpsleeplevel)|
  107 +||<font color="red">获取键盘休眠等级(内)</font>|[getBsKpSleepLevel](#getbskpsleeplevel)|[fEvtBsKpSleepLevel](#fevtbskpsleeplevel)|
105 108 ||<font color="red">设置键盘暂停休眠状态(内)</font>|[setBsKpPauseSleep](#setbskppausesleep)|[fEvtBsKpPauseSleep](#fevtbskppausesleep)|
106 109 |配对模式 - 快速配对|启动基站快速配对|[startBsFastPair](#startbsfastpair)|[sEvtStateCode](#sevtstatecode)<br>[sEvtBsKpOnlineMsg](#sevtbskponlinemsg)|
107 110 ||停止基站快速配对|[stopBsFastPair](#stopbsfastpair)|[sEvtStateCode](#sevtstatecode)|
108 111 |白名单模式 - 白名单管理|获取白名单|[getBsWhitelist](#getbswhitelist)|[fEvtBsWhitelist](#fevtbswhitelist)|
109   -||设置白名单|[setBsWhitelist](#setbswhitelist)|[sEvtStateCode](#sevtstatecode)<br>[fEvtBsWhitelist](#fevtbswhitelist)|
  112 +||设置白名单|[setBsWhitelist](#setbswhitelist)|[sEvtStateCode](#sevtstatecode)<br>[fEvtSetBsWhitelist](#fevtsetbswhitelist)|
110 113 ||清空白名单|[clearBsWhitelist](#clearbswhitelist)|[sEvtStateCode](#sevtstatecode)<br>[fEvtBsWhitelist](#fevtbswhitelist)|
111 114 ||增加白名单|[addBsWhitelist](#addbswhitelist)|[sEvtStateCode](#sevtstatecode)<br>[fEvtAddBsWhitelist](#fevtaddbswhitelist)<br>[fEvtBsWhitelist](#fevtbswhitelist)|
112 115 ||删除白名单|[delBsWhitelist](#delbswhitelist)|[sEvtStateCode](#sevtstatecode)<br>[fEvtDelBsWhitelist](#fevtdelbswhitelist)<br>[fEvtBsWhitelist](#fevtbswhitelist)|
... ... @@ -115,6 +118,8 @@
115 118 |网络设置 - MQTT参数|获取MQTT参数|[getBsMqttParams](#getbsmqttparams)|[fEvtBsMqttParams](#fevtbsmqttparams)|
116 119 ||设置MQTT参数|[setBsMqttParams](#setbsmqttparams)|[fEvtBsMqttParams](#fevtbsmqttparams)||
117 120 |基站维护|获取基站日志信息|[getBsLogInfo](#getbsloginfo)|[sEvtStateCode](#sevtstatecode)<br>[fEvtBsLogInfo](#fevtbsloginfo)<font color="red">(内)</font>|
  121 +||基站软复位|[resetBsSystem](#resetbssystem)|[sEvtStateCode](#sevtstatecode)<br>[sEvtBsConnectState](#sevtbsconnectstate)|
  122 +||基站断电复位|[resetBsPower](#resetbspower)|[sEvtStateCode](#sevtstatecode)<br>[sEvtBsConnectState](#sevtbsconnectstate)|
118 123 |基站升级|<font color="red">开启基站升级(内)|[startBsUpdate](#startbsupdate)|[sEvtStateCode](#sevtstatecode)<br>[fEvtBsUpateState](#fevtbsupatestate)<br>[fEvtBsUpdateProgress](#fevtbsupdateprogress)|
119 124 ||<font color="red">下载字库(内)|[downloadFontLib](#downloadfontlib)|[sEvtStateCode](#sevtstatecode)<br>[fEvtBsFontLibState](#fevtbsfontlibstate)<br>[fEvtBsFontLibProgress](#fevtbsfontlibprogress)|
120 125 ### 键盘管理
... ... @@ -417,8 +422,8 @@
417 422 |dataTag|string|-|否|数据包标识|
418 423 |data|object|-|是|传送参数的对象|
419 424 |+value|string|数字|是|设置的基站SN，长度为10位数字|
420   -|+time|string|数字|是|时间，yyyyMMddHHmmss|
421   -|+verCode|string||是|内部主题校验码，时间+固定key加密|
  425 +<!-- |+time|string|数字|是|时间，yyyyMMddHHmmss|
  426 +|+verCode|string||是|内部主题校验码，时间+固定key加密| -->
422 427  
423 428 - **示例代码**
424 429 ```Json
... ... @@ -492,8 +497,8 @@
492 497 |dataTag|string|-|否|数据包标识,可为空字符串|
493 498 |data|object|-|是|传送参数的对象|
494 499 |+value|string||是|设置的基站品牌码|
495   -|+time|string|数字|是|时间，yyyyMMddHHmmss|
496   -|+verCode|string||是|内部主题校验码，时间+固定key加密|
  500 +<!-- |+time|string|数字|是|时间，yyyyMMddHHmmss|
  501 +|+verCode|string||是|内部主题校验码，时间+固定key加密| -->
497 502  
498 503 - **示例代码**
499 504 ```Json
... ... @@ -663,8 +668,8 @@
663 668 |dataTag|string|-|否|数据包标识,可为空字符串|
664 669 |data|object|-|否|传送参数的对象|
665 670 |+value|string|-|否|设置的基站配对码，8位数字|
666   -|+time|string|数字|是|时间，yyyyMMddHHmmss|
667   -|+verCode|string||是|内部主题校验码，时间+固定key加密|
  671 +<!-- |+time|string|数字|是|时间，yyyyMMddHHmmss|
  672 +|+verCode|string||是|内部主题校验码，时间+固定key加密| -->
668 673  
669 674 - **示例代码**
670 675 ```Json
... ... @@ -952,7 +957,7 @@
952 957 ```
953 958  
954 959 ##### getBsKpSleepLevel
955   -- **主题**：/client/\${baseSN}/send
  960 +- **主题**：<sapn class="yellowFill">/manage/\${baseSN}/send</span>
956 961 - **功能描述**：获取键盘休眠时间等级
957 962 - **参数说明**
958 963  
... ... @@ -970,7 +975,7 @@
970 975 ```
971 976  
972 977 ##### setBsKpSleepLevel
973   -- **主题**：/client/\${baseSN}/send
  978 +- **主题**：<sapn class="yellowFill">/manage/\${baseSN}/send</span>
974 979 - **功能描述**：设置键盘休眠时间等级
975 980 - **参数说明**
976 981  
... ... @@ -994,7 +999,7 @@
994 999  
995 1000 ##### setBsKpPauseSleep
996 1001 - **主题**：<sapn class="yellowFill">/manage/\${baseSN}/send</span>
997   -- **功能描述**：设置键盘暂停休眠是否开启<br><font color="red">注意：请谨慎使用本功能，务必在相关测试或功能完成后关闭，否则可能会导致键盘异常耗电</font>
  1002 +- **功能描述**：设置键盘暂停休眠是否开启<br><font color="red">注意：请谨慎使用本功能，务必在相关测试或功能完成后关闭，否则可能会导致键盘异常耗电<br>设置单次生效，基站拔插后复位成关闭状态</font>
998 1003 - **参数说明**
999 1004  
1000 1005 |参数名|类型|限制|是否必填|说明|
... ... @@ -1040,7 +1045,7 @@
1040 1045 ```
1041 1046  
1042 1047 ##### fEvtBsKpSleepLevel
1043   -- **主题**: /basestation/\${baseSN}/receive
  1048 +- **主题**: <sapn class="yellowFill">/manage/\${baseSN}/receive</span>
1044 1049 - **功能描述**：返回键盘休眠时间等级
1045 1050 - **参数说明**
1046 1051  
... ... @@ -1143,7 +1148,7 @@
1143 1148 - **示例代码**
1144 1149 ```json
1145 1150 {
1146   - "fun": "getBsWhitelist",
  1151 + "fun":"getBsWhitelist",
1147 1152 "dataTag":"1"
1148 1153 }
1149 1154 ```
... ... @@ -1162,7 +1167,7 @@
1162 1167 - **示例代码**
1163 1168 ```json
1164 1169 {
1165   - "fun": "setBsWhitelist",
  1170 + "fun":"setBsWhitelist",
1166 1171 "dataTag":"1",
1167 1172 "data":{
1168 1173 "keySns":["2024021001","2024021002","2024021003","2024021004"]
... ... @@ -1182,7 +1187,7 @@
1182 1187 - **示例代码**
1183 1188 ```json
1184 1189 {
1185   - "fun": "clearBsWhitelist",
  1190 + "fun":"clearBsWhitelist",
1186 1191 "dataTag":"1"
1187 1192 }
1188 1193 ```
... ... @@ -1201,7 +1206,7 @@
1201 1206 - **示例代码**
1202 1207 ```json
1203 1208 {
1204   - "fun": "addBsWhitelist",
  1209 + "fun":"addBsWhitelist",
1205 1210 "dataTag":"1",
1206 1211 "data":{
1207 1212 "keySns":["2024021001"]
... ... @@ -1223,7 +1228,7 @@
1223 1228 - **示例代码**
1224 1229 ```json
1225 1230 {
1226   - "fun": "delBsWhitelist",
  1231 + "fun":"delBsWhitelist",
1227 1232 "dataTag":"1",
1228 1233 "data":{
1229 1234 "keySns":["2024021001"]
... ... @@ -1257,6 +1262,31 @@
1257 1262 }
1258 1263 ```
1259 1264  
  1265 +##### fEvtSetBsWhitelist
  1266 +- **主题**：/basestation/\${baseSN}/receive
  1267 +- **功能描述**：返回设置白名单状态
  1268 +- **参数说明**
  1269 +
  1270 +|参数名|类型|限制|非空|说明|
  1271 +|---|---|---|---|---|
  1272 +|fun|string|-|是|指令名称|
  1273 +|dataTag|string|-|否|数据包标识,可为空字符串|
  1274 +|data|array|-|是|传送参数的对象数组|
  1275 +|++keySn|string||是|键盘SN|
  1276 +|++state|int||是|键盘SN的写入状态 <br>0-写入成功<br> 1-写入失败|
  1277 +
  1278 +- **示例代码**
  1279 +```Json
  1280 +{
  1281 + "fun":"fEvtSetBsWhitelist",
  1282 + "dataTag":"1",
  1283 + "data":[{
  1284 + "keySn":"2024021001",
  1285 + "state":0
  1286 + }]
  1287 +}
  1288 +```
  1289 +
1260 1290 ##### fEvtAddBsWhitelist
1261 1291 - **主题**：/basestation/\${baseSN}/receive
1262 1292 - **功能描述**：返回增加键盘状态
... ... @@ -1481,10 +1511,49 @@
1481 1511 }
1482 1512 ```
1483 1513  
  1514 +##### resetBsSystem
  1515 +- **主题**：/client/\${baseSN}/send
  1516 +- **功能描述**：软复位基站（公共主题可用，但不体现在外部版本协议中）
  1517 +- **参数说明**
  1518 +
  1519 +|参数名|类型|限制|是否必填|说明|
  1520 +|---|---|---|---|---|
  1521 +|fun|string|-|是|指令名称|
  1522 +|dataTag|string|-|否|数据包标识,可为空字符串|
  1523 +
  1524 +- **示例代码**
  1525 +```Json
  1526 +{
  1527 + "fun":"resetBsSystem",
  1528 + "dataTag":"1"
  1529 +}
  1530 +```
  1531 +
  1532 +##### resetBsPower
  1533 +- **主题**：/client/\${baseSN}/send
  1534 +- **功能描述**：断电复位基站（公共主题可用，但不体现在外部版本协议中）
  1535 +- **参数说明**
  1536 +
  1537 +|参数名|类型|限制|是否必填|说明|
  1538 +|---|---|---|---|---|
  1539 +|fun|string|-|是|指令名称|
  1540 +|dataTag|string|-|否|数据包标识,可为空字符串|
  1541 +
  1542 +- **示例代码**
  1543 +```Json
  1544 +{
  1545 + "fun":"resetBsPower",
  1546 + "dataTag":"1"
  1547 +}
  1548 +```
  1549 +
1484 1550 #### 事件
1485 1551 ##### [sEvtStateCode](#sevtstatecode)
1486 1552 返回指令的接收状态
1487 1553  
  1554 +##### [sEvtBsConnectState](#sevtbsconnectstate)
  1555 +复位基站后，基站重新连接成功后上报
  1556 +
1488 1557 ##### fEvtBsLogInfo
1489 1558 - **主题**: <sapn class="yellowFill">/manage/\${baseSN}/receive</span>
1490 1559 - **功能描述**：返回基站存储的日志内容
... ... @@ -1525,8 +1594,8 @@
1525 1594 |+url|string||是|待升级的固件地址，可访问的网络url|
1526 1595 |+version|string||是|待升级的基站固件版本|
1527 1596 |+crc|uint||是|固件CRC校验码，10进制数字|
1528   -|+time|string||是|时间，yyyyMMddHHmmss|
1529   -|+verCode|string||是|内部主题校验码，时间+固定key加密|
  1597 +<!-- |+time|string||是|时间，yyyyMMddHHmmss|
  1598 +|+verCode|string||是|内部主题校验码，时间+固定key加密| -->
1530 1599  
1531 1600 - **示例代码**
1532 1601 ```Json
... ... @@ -1555,8 +1624,8 @@
1555 1624 |+url|string||是|待下载的字库地址，可访问的网络url|
1556 1625 |+version|string||是|待升级的字库版本|
1557 1626 |+crc|int||是|字库CRC校验码，10进制数字|
1558   -|+time|string||是|时间，yyyyMMddHHmmss|
1559   -|+verCode|string||是|内部主题校验码，时间+固定key加密|
  1627 +<!-- |+time|string||是|时间，yyyyMMddHHmmss|
  1628 +|+verCode|string||是|内部主题校验码，时间+固定key加密| -->
1560 1629  
1561 1630 - **示例代码**
1562 1631 ```Json
... ... @@ -1934,8 +2003,8 @@
1934 2003 |+url|string||是|待升级的固件地址，可访问的网络url|
1935 2004 |+version|string||是|待升级的固件版本号|
1936 2005 |+crc|uint||是|固件CRC校验码,10进制数字|
1937   -|+time|string|数字|是|时间，yyyyMMddHHmmss|
1938   -|+verCode|string||是|内部主题校验码，时间+固定key加密|
  2006 +<!-- |+time|string|数字|是|时间，yyyyMMddHHmmss|
  2007 +|+verCode|string||是|内部主题校验码，时间+固定key加密| -->
1939 2008  
1940 2009 - **示例代码**
1941 2010 ```Json
... ... @@ -1960,18 +2029,14 @@
1960 2029 |fun|string|-|是|指令名称|
1961 2030 |dataTag|string|-|否|数据包标识,可为空字符串|
1962 2031 |data|object|-|是|传送参数的对象|
1963   -|+time|string|数字|是|时间，yyyyMMddHHmmss|
1964   -|+verCode|string||是|内部主题校验码，时间+固定key加密|
  2032 +<!-- |+time|string|数字|是|时间，yyyyMMddHHmmss|
  2033 +|+verCode|string||是|内部主题校验码，时间+固定key加密| -->
1965 2034  
1966 2035 - **示例代码**
1967 2036 ```Json
1968 2037 {
1969 2038 "fun":"stopKpFWUpdate",
1970   - "dataTag":"1",
1971   - "data":{
1972   - "time":"",
1973   - "verCode":""
1974   - }
  2039 + "dataTag":"1"
1975 2040 }
1976 2041 ```
1977 2042  
... ...