Commit 6769f08a79c0c3018b0e573cbd7ca3910799a079

Authored by DMchen
2 parents 26d48d5c 2448f2b2

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

通讯协议-B200W-MQTT协议[内部].md
@@ -74,6 +74,9 @@ @@ -74,6 +74,9 @@
74 |dataTag| 数据标签,用于对应收发数据|长度不超过4,可为0-9a-zA-Z的组合| 74 |dataTag| 数据标签,用于对应收发数据|长度不超过4,可为0-9a-zA-Z的组合|
75 |data| 数据内容|对象或者数组,可为空| 75 |data| 数据内容|对象或者数组,可为空|
76 76
  77 +<font color="red">注意:基站接收指令数据单次不超过2K长度,在指定键盘发送指令时,如果指令长度超出限制,建议将指令进行拆分,分次发送,如果是所有键盘执行的指令,可将keySns设为空数组不使用指定键盘的模式</font>
  78 +
  79 +
77 ## 功能速查一览表 80 ## 功能速查一览表
78 ### 基站管理 81 ### 基站管理
79 |功能归类|功能|API指令|指令/系统事件| 82 |功能归类|功能|API指令|指令/系统事件|
@@ -100,11 +103,13 @@ @@ -100,11 +103,13 @@
100 ||设置基站登录名称|[setBsSSID](#setbsssid)|[fEvtBsSSID](#fevtbsssid)|| 103 ||设置基站登录名称|[setBsSSID](#setbsssid)|[fEvtBsSSID](#fevtbsssid)||
101 |键盘统一设置 - 键盘语言|获取键盘语言|[getBsKpLanguage](#getbskplanguage)|[fEvtBsKpLanguage](#fevtbskplanguage)| 104 |键盘统一设置 - 键盘语言|获取键盘语言|[getBsKpLanguage](#getbskplanguage)|[fEvtBsKpLanguage](#fevtbskplanguage)|
102 ||设置键盘语言|[setBsKpLanguage](#setbskplanguage)|[fEvtBsKpLanguage](#fevtbskplanguage)|| 105 ||设置键盘语言|[setBsKpLanguage](#setbskplanguage)|[fEvtBsKpLanguage](#fevtbskplanguage)||
103 -|键盘统一设置 - 暂停休眠|设置键盘暂停休眠状态|[setBsKpPauseSleep](#setbskppausesleep)|[fEvtBsKpPauseSleep](#fevtbskppausesleep)| 106 +|键盘统一设置 - 键盘休眠|<font color="red">设置键盘休眠等级(内)</font>|[setBsKpSleepLevel](#setbskpsleeplevel)|[fEvtBsKpSleepLevel](#fevtbskpsleeplevel)|
  107 +||<font color="red">获取键盘休眠等级(内)</font>|[getBsKpSleepLevel](#getbskpsleeplevel)|[fEvtBsKpSleepLevel](#fevtbskpsleeplevel)|
  108 +||<font color="red">设置键盘暂停休眠状态(内)</font>|[setBsKpPauseSleep](#setbskppausesleep)|[fEvtBsKpPauseSleep](#fevtbskppausesleep)|
104 |配对模式 - 快速配对|启动基站快速配对|[startBsFastPair](#startbsfastpair)|[sEvtStateCode](#sevtstatecode)<br>[sEvtBsKpOnlineMsg](#sevtbskponlinemsg)| 109 |配对模式 - 快速配对|启动基站快速配对|[startBsFastPair](#startbsfastpair)|[sEvtStateCode](#sevtstatecode)<br>[sEvtBsKpOnlineMsg](#sevtbskponlinemsg)|
105 ||停止基站快速配对|[stopBsFastPair](#stopbsfastpair)|[sEvtStateCode](#sevtstatecode)| 110 ||停止基站快速配对|[stopBsFastPair](#stopbsfastpair)|[sEvtStateCode](#sevtstatecode)|
106 |白名单模式 - 白名单管理|获取白名单|[getBsWhitelist](#getbswhitelist)|[fEvtBsWhitelist](#fevtbswhitelist)| 111 |白名单模式 - 白名单管理|获取白名单|[getBsWhitelist](#getbswhitelist)|[fEvtBsWhitelist](#fevtbswhitelist)|
107 -||设置白名单|[setBsWhitelist](#setbswhitelist)|[sEvtStateCode](#sevtstatecode)<br>[fEvtBsWhitelist](#fevtbswhitelist)| 112 +||设置白名单|[setBsWhitelist](#setbswhitelist)|[sEvtStateCode](#sevtstatecode)<br>[fEvtSetBsWhitelist](#fevtsetbswhitelist)|
108 ||清空白名单|[clearBsWhitelist](#clearbswhitelist)|[sEvtStateCode](#sevtstatecode)<br>[fEvtBsWhitelist](#fevtbswhitelist)| 113 ||清空白名单|[clearBsWhitelist](#clearbswhitelist)|[sEvtStateCode](#sevtstatecode)<br>[fEvtBsWhitelist](#fevtbswhitelist)|
109 ||增加白名单|[addBsWhitelist](#addbswhitelist)|[sEvtStateCode](#sevtstatecode)<br>[fEvtAddBsWhitelist](#fevtaddbswhitelist)<br>[fEvtBsWhitelist](#fevtbswhitelist)| 114 ||增加白名单|[addBsWhitelist](#addbswhitelist)|[sEvtStateCode](#sevtstatecode)<br>[fEvtAddBsWhitelist](#fevtaddbswhitelist)<br>[fEvtBsWhitelist](#fevtbswhitelist)|
110 ||删除白名单|[delBsWhitelist](#delbswhitelist)|[sEvtStateCode](#sevtstatecode)<br>[fEvtDelBsWhitelist](#fevtdelbswhitelist)<br>[fEvtBsWhitelist](#fevtbswhitelist)| 115 ||删除白名单|[delBsWhitelist](#delbswhitelist)|[sEvtStateCode](#sevtstatecode)<br>[fEvtDelBsWhitelist](#fevtdelbswhitelist)<br>[fEvtBsWhitelist](#fevtbswhitelist)|
@@ -113,6 +118,8 @@ @@ -113,6 +118,8 @@
113 |网络设置 - MQTT参数|获取MQTT参数|[getBsMqttParams](#getbsmqttparams)|[fEvtBsMqttParams](#fevtbsmqttparams)| 118 |网络设置 - MQTT参数|获取MQTT参数|[getBsMqttParams](#getbsmqttparams)|[fEvtBsMqttParams](#fevtbsmqttparams)|
114 ||设置MQTT参数|[setBsMqttParams](#setbsmqttparams)|[fEvtBsMqttParams](#fevtbsmqttparams)|| 119 ||设置MQTT参数|[setBsMqttParams](#setbsmqttparams)|[fEvtBsMqttParams](#fevtbsmqttparams)||
115 |基站维护|获取基站日志信息|[getBsLogInfo](#getbsloginfo)|[sEvtStateCode](#sevtstatecode)<br>[fEvtBsLogInfo](#fevtbsloginfo)<font color="red">(内)</font>| 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)|
116 |基站升级|<font color="red">开启基站升级(内)|[startBsUpdate](#startbsupdate)|[sEvtStateCode](#sevtstatecode)<br>[fEvtBsUpateState](#fevtbsupatestate)<br>[fEvtBsUpdateProgress](#fevtbsupdateprogress)| 123 |基站升级|<font color="red">开启基站升级(内)|[startBsUpdate](#startbsupdate)|[sEvtStateCode](#sevtstatecode)<br>[fEvtBsUpateState](#fevtbsupatestate)<br>[fEvtBsUpdateProgress](#fevtbsupdateprogress)|
117 ||<font color="red">下载字库(内)|[downloadFontLib](#downloadfontlib)|[sEvtStateCode](#sevtstatecode)<br>[fEvtBsFontLibState](#fevtbsfontlibstate)<br>[fEvtBsFontLibProgress](#fevtbsfontlibprogress)| 124 ||<font color="red">下载字库(内)|[downloadFontLib](#downloadfontlib)|[sEvtStateCode](#sevtstatecode)<br>[fEvtBsFontLibState](#fevtbsfontlibstate)<br>[fEvtBsFontLibProgress](#fevtbsfontlibprogress)|
118 ### 键盘管理 125 ### 键盘管理
@@ -415,8 +422,8 @@ @@ -415,8 +422,8 @@
415 |dataTag|string|-|否|数据包标识| 422 |dataTag|string|-|否|数据包标识|
416 |data|object|-|是|传送参数的对象| 423 |data|object|-|是|传送参数的对象|
417 |+value|string|数字|是|设置的基站SN,长度为10位数字| 424 |+value|string|数字|是|设置的基站SN,长度为10位数字|
418 -|+time|string|数字|是|时间,yyyyMMddHHmmss|  
419 -|+verCode|string||是|内部主题校验码,时间+固定key加密| 425 +<!-- |+time|string|数字|是|时间,yyyyMMddHHmmss|
  426 +|+verCode|string||是|内部主题校验码,时间+固定key加密| -->
420 427
421 - **示例代码** 428 - **示例代码**
422 ```Json 429 ```Json
@@ -490,8 +497,8 @@ @@ -490,8 +497,8 @@
490 |dataTag|string|-|否|数据包标识,可为空字符串| 497 |dataTag|string|-|否|数据包标识,可为空字符串|
491 |data|object|-|是|传送参数的对象| 498 |data|object|-|是|传送参数的对象|
492 |+value|string||是|设置的基站品牌码| 499 |+value|string||是|设置的基站品牌码|
493 -|+time|string|数字|是|时间,yyyyMMddHHmmss|  
494 -|+verCode|string||是|内部主题校验码,时间+固定key加密| 500 +<!-- |+time|string|数字|是|时间,yyyyMMddHHmmss|
  501 +|+verCode|string||是|内部主题校验码,时间+固定key加密| -->
495 502
496 - **示例代码** 503 - **示例代码**
497 ```Json 504 ```Json
@@ -661,8 +668,8 @@ @@ -661,8 +668,8 @@
661 |dataTag|string|-|否|数据包标识,可为空字符串| 668 |dataTag|string|-|否|数据包标识,可为空字符串|
662 |data|object|-|否|传送参数的对象| 669 |data|object|-|否|传送参数的对象|
663 |+value|string|-|否|设置的基站配对码,8位数字| 670 |+value|string|-|否|设置的基站配对码,8位数字|
664 -|+time|string|数字|是|时间,yyyyMMddHHmmss|  
665 -|+verCode|string||是|内部主题校验码,时间+固定key加密| 671 +<!-- |+time|string|数字|是|时间,yyyyMMddHHmmss|
  672 +|+verCode|string||是|内部主题校验码,时间+固定key加密| -->
666 673
667 - **示例代码** 674 - **示例代码**
668 ```Json 675 ```Json
@@ -949,9 +956,50 @@ @@ -949,9 +956,50 @@
949 } 956 }
950 ``` 957 ```
951 958
  959 +##### getBsKpSleepLevel
  960 +- **主题**:<sapn class="yellowFill">/manage/\${baseSN}/send</span>
  961 +- **功能描述**:获取键盘休眠时间等级
  962 +- **参数说明**
  963 +
  964 +|参数名|类型|限制|是否必填|说明|
  965 +|---|---|---|---|---|
  966 +|fun|string|-|是|指令名称|
  967 +|dataTag|string|-|否|数据包标识,可为空字符串|
  968 +
  969 +- **示例代码**
  970 +```Json
  971 +{
  972 + "fun":"getBsKpSleepLevel",
  973 + "dataTag":"1"
  974 +}
  975 +```
  976 +
  977 +##### setBsKpSleepLevel
  978 +- **主题**:<sapn class="yellowFill">/manage/\${baseSN}/send</span>
  979 +- **功能描述**:设置键盘休眠时间等级
  980 +- **参数说明**
  981 +
  982 +|参数名|类型|限制|是否必填|说明|
  983 +|---|---|---|---|---|
  984 +|fun|string|-|是|指令名称|
  985 +|dataTag|string|-|否|数据包标识,可为空字符串|
  986 +|data|object|-|是|传送参数的对象|
  987 +|+value|string||是|设置键盘休眠的时间等级<br>0-30秒<br>1-2分钟<br>2-10分钟<br>3-45分钟|
  988 +
  989 +- **示例代码**
  990 +```Json
  991 +{
  992 + "fun":"setBsKpSleepLevel",
  993 + "dataTag":"1",
  994 + "data":{
  995 + "value":"1"
  996 + }
  997 +}
  998 +```
  999 +
952 ##### setBsKpPauseSleep 1000 ##### setBsKpPauseSleep
953 -- **主题**:/client/\${baseSN}/send  
954 -- **功能描述**:设置键盘暂停休眠是否开启<br><font color="red">注意:请谨慎使用本功能,务必在相关测试或功能完成后关闭,否则可能会导致键盘异常耗电</font> 1001 +- **主题**:<sapn class="yellowFill">/manage/\${baseSN}/send</span>
  1002 +- **功能描述**:设置键盘暂停休眠是否开启<br><font color="red">注意:请谨慎使用本功能,务必在相关测试或功能完成后关闭,否则可能会导致键盘异常耗电<br>设置单次生效,基站拔插后复位成关闭状态</font>
955 - **参数说明** 1003 - **参数说明**
956 1004
957 |参数名|类型|限制|是否必填|说明| 1005 |参数名|类型|限制|是否必填|说明|
@@ -983,7 +1031,7 @@ @@ -983,7 +1031,7 @@
983 |fun|string|-|是|指令名称| 1031 |fun|string|-|是|指令名称|
984 |dataTag|string|-|否|数据包标识,可为空字符串| 1032 |dataTag|string|-|否|数据包标识,可为空字符串|
985 |data|object|-|是|传送参数的对象| 1033 |data|object|-|是|传送参数的对象|
986 -|+value|string||是|设置键盘显示的语言<br>1-简体中文<br>2-英文| 1034 +|+value|string||是|键盘显示的语言<br>1-简体中文<br>2-英文|
987 1035
988 - **示例代码** 1036 - **示例代码**
989 ```Json 1037 ```Json
@@ -996,8 +1044,31 @@ @@ -996,8 +1044,31 @@
996 } 1044 }
997 ``` 1045 ```
998 1046
  1047 +##### fEvtBsKpSleepLevel
  1048 +- **主题**: <sapn class="yellowFill">/manage/\${baseSN}/receive</span>
  1049 +- **功能描述**:返回键盘休眠时间等级
  1050 +- **参数说明**
  1051 +
  1052 +|参数名|类型|限制|非空|说明|
  1053 +|---|---|---|---|---|
  1054 +|fun|string|-|是|指令名称|
  1055 +|dataTag|string|-|否|数据包标识,可为空字符串|
  1056 +|data|object|-|是|传送参数的对象|
  1057 +|+value|string||是|键盘休眠的时间等级<br>0-30秒<br>1-2分钟<br>2-10分钟<br>3-45分钟|
  1058 +
  1059 +- **示例代码**
  1060 +```Json
  1061 +{
  1062 + "fun":"fEvtBsKpSleepLevel",
  1063 + "dataTag":"1",
  1064 + "data":{
  1065 + "value":"1"
  1066 + }
  1067 +}
  1068 +```
  1069 +
999 ##### fEvtBsKpPauseSleep 1070 ##### fEvtBsKpPauseSleep
1000 -- **主题**: /basestation/\${baseSN}/receive 1071 +- **主题**: <sapn class="yellowFill">/manage/\${baseSN}/receive</span>
1001 - **功能描述**:返回暂停键盘休眠开启状态 1072 - **功能描述**:返回暂停键盘休眠开启状态
1002 - **参数说明** 1073 - **参数说明**
1003 1074
@@ -1077,7 +1148,7 @@ @@ -1077,7 +1148,7 @@
1077 - **示例代码** 1148 - **示例代码**
1078 ```json 1149 ```json
1079 { 1150 {
1080 - "fun": "getBsWhitelist", 1151 + "fun":"getBsWhitelist",
1081 "dataTag":"1" 1152 "dataTag":"1"
1082 } 1153 }
1083 ``` 1154 ```
@@ -1091,12 +1162,12 @@ @@ -1091,12 +1162,12 @@
1091 |fun|string|-|是|指令名称| 1162 |fun|string|-|是|指令名称|
1092 |dataTag|string|-|否|数据包标识,可为空字符串| 1163 |dataTag|string|-|否|数据包标识,可为空字符串|
1093 |data|object|-|是|传送参数的对象| 1164 |data|object|-|是|传送参数的对象|
1094 -|+keySns|array|-|是|待写入的键盘SN数组| 1165 +|+keySns|array|-|是|待写入的键盘SN数组,最多不超过200<br>键盘SN为10位数字|
1095 1166
1096 - **示例代码** 1167 - **示例代码**
1097 ```json 1168 ```json
1098 { 1169 {
1099 - "fun": "setBsWhitelist", 1170 + "fun":"setBsWhitelist",
1100 "dataTag":"1", 1171 "dataTag":"1",
1101 "data":{ 1172 "data":{
1102 "keySns":["2024021001","2024021002","2024021003","2024021004"] 1173 "keySns":["2024021001","2024021002","2024021003","2024021004"]
@@ -1116,7 +1187,7 @@ @@ -1116,7 +1187,7 @@
1116 - **示例代码** 1187 - **示例代码**
1117 ```json 1188 ```json
1118 { 1189 {
1119 - "fun": "clearBsWhitelist", 1190 + "fun":"clearBsWhitelist",
1120 "dataTag":"1" 1191 "dataTag":"1"
1121 } 1192 }
1122 ``` 1193 ```
@@ -1130,12 +1201,12 @@ @@ -1130,12 +1201,12 @@
1130 |fun|string|-|是|指令名称| 1201 |fun|string|-|是|指令名称|
1131 |dataTag|string|-|否|数据包标识,可为空字符串| 1202 |dataTag|string|-|否|数据包标识,可为空字符串|
1132 |data|object|-|是|传送参数的对象| 1203 |data|object|-|是|传送参数的对象|
1133 -|+keySns|array|-|是|待添加的键盘SN列表| 1204 +|+keySns|array|-|是|待添加的键盘SN列表<br>键盘SN为10位数字|
1134 1205
1135 - **示例代码** 1206 - **示例代码**
1136 ```json 1207 ```json
1137 { 1208 {
1138 - "fun": "addBsWhitelist", 1209 + "fun":"addBsWhitelist",
1139 "dataTag":"1", 1210 "dataTag":"1",
1140 "data":{ 1211 "data":{
1141 "keySns":["2024021001"] 1212 "keySns":["2024021001"]
@@ -1152,12 +1223,12 @@ @@ -1152,12 +1223,12 @@
1152 |fun|string|-|是|指令名称| 1223 |fun|string|-|是|指令名称|
1153 |dataTag|string|-|否|数据包标识,可为空字符串| 1224 |dataTag|string|-|否|数据包标识,可为空字符串|
1154 |data|object|-|是|传送参数的对象| 1225 |data|object|-|是|传送参数的对象|
1155 -|+keySns|array|-|是|待删除的键盘SN列表| 1226 +|+keySns|array|-|是|待删除的键盘SN列表<br>键盘SN为10位数字|
1156 1227
1157 - **示例代码** 1228 - **示例代码**
1158 ```json 1229 ```json
1159 { 1230 {
1160 - "fun": "delBsWhitelist", 1231 + "fun":"delBsWhitelist",
1161 "dataTag":"1", 1232 "dataTag":"1",
1162 "data":{ 1233 "data":{
1163 "keySns":["2024021001"] 1234 "keySns":["2024021001"]
@@ -1191,6 +1262,34 @@ @@ -1191,6 +1262,34 @@
1191 } 1262 }
1192 ``` 1263 ```
1193 1264
  1265 +##### fEvtSetBsWhitelist
  1266 +- **主题**:/basestation/\${baseSN}/receive
  1267 +- **功能描述**:返回设置白名单状态
  1268 +- **参数说明**
  1269 +
  1270 +|参数名|类型|限制|非空|说明|
  1271 +|---|---|---|---|---|
  1272 +|fun|string|-|是|指令名称|
  1273 +|dataTag|string|-|否|数据包标识,可为空字符串|
  1274 +|data|array|-|是|传送参数的对象数组|
  1275 +|++keySns|array||是|键盘SN数组|
  1276 +|++state|int||是|键盘SN的写入状态 <br>0-写入成功<br> 1-写入失败|
  1277 +
  1278 +- **示例代码**
  1279 +```Json
  1280 +{
  1281 + "fun":"fEvtSetBsWhitelist",
  1282 + "dataTag":"1",
  1283 + "data":[{
  1284 + "keySns":["2024021001","2024021002"],
  1285 + "state":0
  1286 + },{
  1287 + "keySns":["1211"],
  1288 + "state":1
  1289 + }]
  1290 +}
  1291 +```
  1292 +
1194 ##### fEvtAddBsWhitelist 1293 ##### fEvtAddBsWhitelist
1195 - **主题**:/basestation/\${baseSN}/receive 1294 - **主题**:/basestation/\${baseSN}/receive
1196 - **功能描述**:返回增加键盘状态 1295 - **功能描述**:返回增加键盘状态
@@ -1201,7 +1300,7 @@ @@ -1201,7 +1300,7 @@
1201 |fun|string|-|是|指令名称| 1300 |fun|string|-|是|指令名称|
1202 |dataTag|string|-|否|数据包标识,可为空字符串| 1301 |dataTag|string|-|否|数据包标识,可为空字符串|
1203 |data|array|-|是|传送参数的对象数组| 1302 |data|array|-|是|传送参数的对象数组|
1204 -|++keySn|string||是|键盘SN| 1303 +|++keySns|array||是|键盘SN数组|
1205 |++state|int||是|键盘的增加状态 <br>0-增加成功<br> 1-增加失败| 1304 |++state|int||是|键盘的增加状态 <br>0-增加成功<br> 1-增加失败|
1206 1305
1207 - **示例代码** 1306 - **示例代码**
@@ -1210,8 +1309,11 @@ @@ -1210,8 +1309,11 @@
1210 "fun":"fEvtAddBsWhitelist", 1309 "fun":"fEvtAddBsWhitelist",
1211 "dataTag":"1", 1310 "dataTag":"1",
1212 "data":[{ 1311 "data":[{
1213 - "keySn":"2024021001", 1312 + "keySns":["2024021001","2024021002"],
1214 "state":0 1313 "state":0
  1314 + },{
  1315 + "keySns":["1211"],
  1316 + "state":1
1215 }] 1317 }]
1216 } 1318 }
1217 ``` 1319 ```
@@ -1226,7 +1328,7 @@ @@ -1226,7 +1328,7 @@
1226 |fun|string|-|是|指令名称| 1328 |fun|string|-|是|指令名称|
1227 |dataTag|string|-|否|数据包标识,可为空字符串| 1329 |dataTag|string|-|否|数据包标识,可为空字符串|
1228 |data|array|-|是|传送参数的对象数组| 1330 |data|array|-|是|传送参数的对象数组|
1229 -|++keySn|string||是|键盘SN| 1331 +|++keySns|array||是|键盘SN数组|
1230 |++state|int||是|键盘的删除状态 <br>0-删除成功<br> 1-删除失败| 1332 |++state|int||是|键盘的删除状态 <br>0-删除成功<br> 1-删除失败|
1231 1333
1232 - **示例代码** 1334 - **示例代码**
@@ -1235,11 +1337,15 @@ @@ -1235,11 +1337,15 @@
1235 "fun":"fEvtDelBsWhitelist", 1337 "fun":"fEvtDelBsWhitelist",
1236 "dataTag":"1", 1338 "dataTag":"1",
1237 "data":[{ 1339 "data":[{
1238 - "keySn":"2024021001", 1340 + "keySns":["2024021002"],
1239 "state":0 1341 "state":0
  1342 + },{
  1343 + "keySns":["2024021001"],
  1344 + "state":1
1240 }] 1345 }]
1241 } 1346 }
1242 ``` 1347 ```
  1348 +
1243 ### 网络参数设置 1349 ### 网络参数设置
1244 #### 方法 1350 #### 方法
1245 ##### getBsTcpipParams 1351 ##### getBsTcpipParams
@@ -1415,10 +1521,49 @@ @@ -1415,10 +1521,49 @@
1415 } 1521 }
1416 ``` 1522 ```
1417 1523
  1524 +##### resetBsSystem
  1525 +- **主题**:/client/\${baseSN}/send
  1526 +- **功能描述**:软复位基站(公共主题可用,但不体现在外部版本协议中)
  1527 +- **参数说明**
  1528 +
  1529 +|参数名|类型|限制|是否必填|说明|
  1530 +|---|---|---|---|---|
  1531 +|fun|string|-|是|指令名称|
  1532 +|dataTag|string|-|否|数据包标识,可为空字符串|
  1533 +
  1534 +- **示例代码**
  1535 +```Json
  1536 +{
  1537 + "fun":"resetBsSystem",
  1538 + "dataTag":"1"
  1539 +}
  1540 +```
  1541 +
  1542 +##### resetBsPower
  1543 +- **主题**:/client/\${baseSN}/send
  1544 +- **功能描述**:断电复位基站(公共主题可用,但不体现在外部版本协议中)
  1545 +- **参数说明**
  1546 +
  1547 +|参数名|类型|限制|是否必填|说明|
  1548 +|---|---|---|---|---|
  1549 +|fun|string|-|是|指令名称|
  1550 +|dataTag|string|-|否|数据包标识,可为空字符串|
  1551 +
  1552 +- **示例代码**
  1553 +```Json
  1554 +{
  1555 + "fun":"resetBsPower",
  1556 + "dataTag":"1"
  1557 +}
  1558 +```
  1559 +
1418 #### 事件 1560 #### 事件
1419 ##### [sEvtStateCode](#sevtstatecode) 1561 ##### [sEvtStateCode](#sevtstatecode)
1420 返回指令的接收状态 1562 返回指令的接收状态
1421 1563
  1564 +##### [sEvtBsConnectState](#sevtbsconnectstate)
  1565 +复位基站后,基站重新连接成功后上报
  1566 +
1422 ##### fEvtBsLogInfo 1567 ##### fEvtBsLogInfo
1423 - **主题**: <sapn class="yellowFill">/manage/\${baseSN}/receive</span> 1568 - **主题**: <sapn class="yellowFill">/manage/\${baseSN}/receive</span>
1424 - **功能描述**:返回基站存储的日志内容 1569 - **功能描述**:返回基站存储的日志内容
@@ -1459,8 +1604,8 @@ @@ -1459,8 +1604,8 @@
1459 |+url|string||是|待升级的固件地址,可访问的网络url| 1604 |+url|string||是|待升级的固件地址,可访问的网络url|
1460 |+version|string||是|待升级的基站固件版本| 1605 |+version|string||是|待升级的基站固件版本|
1461 |+crc|uint||是|固件CRC校验码,10进制数字| 1606 |+crc|uint||是|固件CRC校验码,10进制数字|
1462 -|+time|string||是|时间,yyyyMMddHHmmss|  
1463 -|+verCode|string||是|内部主题校验码,时间+固定key加密| 1607 +<!-- |+time|string||是|时间,yyyyMMddHHmmss|
  1608 +|+verCode|string||是|内部主题校验码,时间+固定key加密| -->
1464 1609
1465 - **示例代码** 1610 - **示例代码**
1466 ```Json 1611 ```Json
@@ -1489,8 +1634,8 @@ @@ -1489,8 +1634,8 @@
1489 |+url|string||是|待下载的字库地址,可访问的网络url| 1634 |+url|string||是|待下载的字库地址,可访问的网络url|
1490 |+version|string||是|待升级的字库版本| 1635 |+version|string||是|待升级的字库版本|
1491 |+crc|int||是|字库CRC校验码,10进制数字| 1636 |+crc|int||是|字库CRC校验码,10进制数字|
1492 -|+time|string||是|时间,yyyyMMddHHmmss|  
1493 -|+verCode|string||是|内部主题校验码,时间+固定key加密| 1637 +<!-- |+time|string||是|时间,yyyyMMddHHmmss|
  1638 +|+verCode|string||是|内部主题校验码,时间+固定key加密| -->
1494 1639
1495 - **示例代码** 1640 - **示例代码**
1496 ```Json 1641 ```Json
@@ -1868,8 +2013,8 @@ @@ -1868,8 +2013,8 @@
1868 |+url|string||是|待升级的固件地址,可访问的网络url| 2013 |+url|string||是|待升级的固件地址,可访问的网络url|
1869 |+version|string||是|待升级的固件版本号| 2014 |+version|string||是|待升级的固件版本号|
1870 |+crc|uint||是|固件CRC校验码,10进制数字| 2015 |+crc|uint||是|固件CRC校验码,10进制数字|
1871 -|+time|string|数字|是|时间,yyyyMMddHHmmss|  
1872 -|+verCode|string||是|内部主题校验码,时间+固定key加密| 2016 +<!-- |+time|string|数字|是|时间,yyyyMMddHHmmss|
  2017 +|+verCode|string||是|内部主题校验码,时间+固定key加密| -->
1873 2018
1874 - **示例代码** 2019 - **示例代码**
1875 ```Json 2020 ```Json
@@ -1894,18 +2039,14 @@ @@ -1894,18 +2039,14 @@
1894 |fun|string|-|是|指令名称| 2039 |fun|string|-|是|指令名称|
1895 |dataTag|string|-|否|数据包标识,可为空字符串| 2040 |dataTag|string|-|否|数据包标识,可为空字符串|
1896 |data|object|-|是|传送参数的对象| 2041 |data|object|-|是|传送参数的对象|
1897 -|+time|string|数字|是|时间,yyyyMMddHHmmss|  
1898 -|+verCode|string||是|内部主题校验码,时间+固定key加密| 2042 +<!-- |+time|string|数字|是|时间,yyyyMMddHHmmss|
  2043 +|+verCode|string||是|内部主题校验码,时间+固定key加密| -->
1899 2044
1900 - **示例代码** 2045 - **示例代码**
1901 ```Json 2046 ```Json
1902 { 2047 {
1903 "fun":"stopKpFWUpdate", 2048 "fun":"stopKpFWUpdate",
1904 - "dataTag":"1",  
1905 - "data":{  
1906 - "time":"",  
1907 - "verCode":""  
1908 - } 2049 + "dataTag":"1"
1909 } 2050 }
1910 ``` 2051 ```
1911 2052
通讯协议-平台化-应用部分.md
@@ -153,7 +153,9 @@ WebSocketæ–¹å¼åº”用与SDK或基站建立长连接åŽï¼Œé€šè¿‡WebSocket接å£å @@ -153,7 +153,9 @@ WebSocketæ–¹å¼åº”用与SDK或基站建立长连接åŽï¼Œé€šè¿‡WebSocket接å£å
153 ||设置Beep工作状æ€|[setBsKpBeepMode](#setbskpbeepmode)|[fEvtBsKpBeepMode](#fevtbskpbeepmode)| 153 ||设置Beep工作状æ€|[setBsKpBeepMode](#setbskpbeepmode)|[fEvtBsKpBeepMode](#fevtbskpbeepmode)|
154 |键盘统一设置 - é•¿è·è€ƒå‹¤|获å–键盘长è·è€ƒå‹¤çжæ€|[getBsKpRFIDState](#getbskprfidstate)|[fEvtBsKpRFIDState](#fevtbskprfidstate)| 154 |键盘统一设置 - é•¿è·è€ƒå‹¤|获å–键盘长è·è€ƒå‹¤çжæ€|[getBsKpRFIDState](#getbskprfidstate)|[fEvtBsKpRFIDState](#fevtbskprfidstate)|
155 ||设置键盘长è·è€ƒå‹¤çжæ€|[setBsKpRFIDState](#setbskprfidstate)|[fEvtBsKpRFIDState](#fevtbskprfidstate)| 155 ||设置键盘长è·è€ƒå‹¤çжæ€|[setBsKpRFIDState](#setbskprfidstate)|[fEvtBsKpRFIDState](#fevtbskprfidstate)|
156 -|键盘统一设置 - æš‚åœä¼‘眠|设置键盘暂åœä¼‘眠状æ€|[setBsKpPauseSleep](#setbskppausesleep)|[fEvtBsKpPauseSleep](#fevtbskppausesleep)| 156 +|键盘统一设置 - 键盘休眠|设置键盘休眠等级|[setBsKpSleepLevel](#setbskpsleeplevel)|[fEvtBsKpSleepLevel](#fevtbskpsleeplevel)|
  157 +||获å–键盘休眠等级|[getBsKpSleepLevel](#getbskpsleeplevel)|[fEvtBsKpSleepLevel](#fevtbskpsleeplevel)|
  158 +||<font color="red">设置键盘暂åœä¼‘眠状æ€(内)</font>|[setBsKpPauseSleep](#setbskppausesleep)|[fEvtBsKpPauseSleep](#fevtbskppausesleep)|
157 |é…å¯¹æ¨¡å¼ - 快速é…对|å¯åŠ¨åŸºç«™å¿«é€Ÿé…对|[startBsFastPair](#startbsfastpair)|[sEvtStateCode](#sevtstatecode)<br>[sEvtBsKpOnlineMsg](#sevtbskponlinemsg)| 159 |é…å¯¹æ¨¡å¼ - 快速é…对|å¯åŠ¨åŸºç«™å¿«é€Ÿé…对|[startBsFastPair](#startbsfastpair)|[sEvtStateCode](#sevtstatecode)<br>[sEvtBsKpOnlineMsg](#sevtbskponlinemsg)|
158 ||åœæ­¢åŸºç«™å¿«é€Ÿé…对|[stopBsFastPair](#stopbsfastpair)|[sEvtStateCode](#sevtstatecode)| 160 ||åœæ­¢åŸºç«™å¿«é€Ÿé…对|[stopBsFastPair](#stopbsfastpair)|[sEvtStateCode](#sevtstatecode)|
159 |白å啿¨¡å¼ - 白åå•管ç†|获å–白åå•|[getBsWhitelist](#getbswhitelist)|[fEvtBsWhitelist](#fevtbswhitelist)| 161 |白å啿¨¡å¼ - 白åå•管ç†|获å–白åå•|[getBsWhitelist](#getbswhitelist)|[fEvtBsWhitelist](#fevtbswhitelist)|
@@ -1575,6 +1577,49 @@ WebSocketæ–¹å¼åº”用与SDK或基站建立长连接åŽï¼Œé€šè¿‡WebSocket接å£å @@ -1575,6 +1577,49 @@ WebSocketæ–¹å¼åº”用与SDK或基站建立长连接åŽï¼Œé€šè¿‡WebSocket接å£å
1575 } 1577 }
1576 } 1578 }
1577 ``` 1579 ```
  1580 +
  1581 +
  1582 +##### getBsKpSleepLevel
  1583 +- **主题**:/client/\${baseSN}/send
  1584 +- **功能æè¿°**:获å–键盘休眠时间等级
  1585 +- **傿•°è¯´æ˜Ž**
  1586 +
  1587 +|傿•°å|类型|é™åˆ¶|是å¦å¿…å¡«|说明|
  1588 +|---|---|---|---|---|
  1589 +|fun|string|-|是|指令åç§°|
  1590 +|dataTag|string|-|å¦|æ•°æ®åŒ…标识,å¯ä¸ºç©ºå­—符串|
  1591 +
  1592 +- **示例代ç **
  1593 +```Json
  1594 +{
  1595 + "fun":"getBsKpSleepLevel",
  1596 + "dataTag":"1"
  1597 +}
  1598 +```
  1599 +
  1600 +##### setBsKpSleepLevel
  1601 +- **主题**:/client/\${baseSN}/send
  1602 +- **功能æè¿°**:设置键盘休眠时间等级
  1603 +- **傿•°è¯´æ˜Ž**
  1604 +
  1605 +|傿•°å|类型|é™åˆ¶|是å¦å¿…å¡«|说明|
  1606 +|---|---|---|---|---|
  1607 +|fun|string|-|是|指令åç§°|
  1608 +|dataTag|string|-|å¦|æ•°æ®åŒ…标识,å¯ä¸ºç©ºå­—符串|
  1609 +|data|object|-|是|ä¼ é€å‚数的对象|
  1610 +|+value|string||是|设置键盘休眠的时间等级<br>0-30ç§’<br>1-2分钟<br>2-10分钟<br>3-45分钟|
  1611 +
  1612 +- **示例代ç **
  1613 +```Json
  1614 +{
  1615 + "fun":"setBsKpSleepLevel",
  1616 + "dataTag":"1",
  1617 + "data":{
  1618 + "value":"1"
  1619 + }
  1620 +}
  1621 +```
  1622 +
1578 ##### setBsKpPauseSleep 1623 ##### setBsKpPauseSleep
1579 - **主题**:/client/\${baseSN}/send 1624 - **主题**:/client/\${baseSN}/send
1580 - **功能æè¿°**:设置键盘暂åœä¼‘眠是å¦å¼€å¯<br><font color="red">注æ„:请谨慎使用本功能,务必在相关测试或功能完æˆåŽå…³é—­ï¼Œå¦åˆ™å¯èƒ½ä¼šå¯¼è‡´é”®ç›˜å¼‚常耗电</font> 1625 - **功能æè¿°**:设置键盘暂åœä¼‘眠是å¦å¼€å¯<br><font color="red">注æ„:请谨慎使用本功能,务必在相关测试或功能完æˆåŽå…³é—­ï¼Œå¦åˆ™å¯èƒ½ä¼šå¯¼è‡´é”®ç›˜å¼‚常耗电</font>
@@ -1690,6 +1735,30 @@ WebSocketæ–¹å¼åº”用与SDK或基站建立长连接åŽï¼Œé€šè¿‡WebSocket接å£å @@ -1690,6 +1735,30 @@ WebSocketæ–¹å¼åº”用与SDK或基站建立长连接åŽï¼Œé€šè¿‡WebSocket接å£å
1690 } 1735 }
1691 } 1736 }
1692 ``` 1737 ```
  1738 +
  1739 +##### fEvtBsKpSleepLevel
  1740 +- **主题**: /basestation/\${baseSN}/receive
  1741 +- **功能æè¿°**:返回键盘休眠时间等级
  1742 +- **傿•°è¯´æ˜Ž**
  1743 +
  1744 +|傿•°å|类型|é™åˆ¶|éžç©º|说明|
  1745 +|---|---|---|---|---|
  1746 +|fun|string|-|是|指令åç§°|
  1747 +|dataTag|string|-|å¦|æ•°æ®åŒ…标识,å¯ä¸ºç©ºå­—符串|
  1748 +|data|object|-|是|ä¼ é€å‚数的对象|
  1749 +|+value|string||是|键盘休眠的时间等级<br>0-30ç§’<br>1-2分钟<br>2-10分钟<br>3-45分钟|
  1750 +
  1751 +- **示例代ç **
  1752 +```Json
  1753 +{
  1754 + "fun":"fEvtBsKpSleepLevel",
  1755 + "dataTag":"1",
  1756 + "data":{
  1757 + "value":"1"
  1758 + }
  1759 +}
  1760 +```
  1761 +
1693 ##### fEvtBsKpPauseSleep 1762 ##### fEvtBsKpPauseSleep
1694 - **主题**: /basestation/\${baseSN}/receive 1763 - **主题**: /basestation/\${baseSN}/receive
1695 - **功能æè¿°**:返回暂åœé”®ç›˜ä¼‘眠开å¯çŠ¶æ€ 1764 - **功能æè¿°**:返回暂åœé”®ç›˜ä¼‘眠开å¯çжæ€
@@ -2917,7 +2986,6 @@ WebSocketæ–¹å¼åº”用与SDK或基站建立长连接åŽï¼Œé€šè¿‡WebSocket接å£å @@ -2917,7 +2986,6 @@ WebSocketæ–¹å¼åº”用与SDK或基站建立长连接åŽï¼Œé€šè¿‡WebSocket接å£å
2917 |+version|string||是|键盘固件版本| 2986 |+version|string||是|键盘固件版本|
2918 |+model|int||是|键盘型å·| 2987 |+model|int||是|键盘型å·|
2919 |+voltage|double||是|键盘电é‡<font color="red">(待键盘修改æˆç™¾åˆ†æ¯”)</font>| 2988 |+voltage|double||是|键盘电é‡<font color="red">(待键盘修改æˆç™¾åˆ†æ¯”)</font>|
2920 -|+isWeak|int||是|是å¦å¼±ç”µï¼Œ 0-正常,1-弱电<font color="red">(待键盘修改上报弱电状æ€ï¼‰</font>|  
2921 2989
2922 - **示例代ç ** 2990 - **示例代ç **
2923 ```Json 2991 ```Json
@@ -2928,8 +2996,7 @@ WebSocketæ–¹å¼åº”用与SDK或基站建立长连接åŽï¼Œé€šè¿‡WebSocket接å£å @@ -2928,8 +2996,7 @@ WebSocketæ–¹å¼åº”用与SDK或基站建立长连接åŽï¼Œé€šè¿‡WebSocket接å£å
2928 "keySn":"1234567890", 2996 "keySn":"1234567890",
2929 "version":"1.0.0", 2997 "version":"1.0.0",
2930 "model":67, 2998 "model":67,
2931 - "voltage":2.8,  
2932 - "isWeak":0 2999 + "voltage":2.8
2933 } 3000 }
2934 } 3001 }
2935 ``` 3002 ```