增加设置键盘休眠时间等级的协议内容，修改暂停休眠的主题为内部主题

刘琴
1 parent a2f1ba0a
Showing 2 changed files with 141 additions and 8 deletions
通讯协议-B200W-MQTT协议[内部].md
通讯协议-平台化-应用部分.md
@@ -100,7 +100,9 @@
 ||设置基站登录名称|[setBsSSID](#setbsssid)|[fEvtBsSSID](#fevtbsssid)||
 |键盘统一设置 - 键盘语言|获取键盘语言|[getBsKpLanguage](#getbskplanguage)|[fEvtBsKpLanguage](#fevtbskplanguage)|
 ||设置键盘语言|[setBsKpLanguage](#setbskplanguage)|[fEvtBsKpLanguage](#fevtbskplanguage)||
-|键盘统一设置 - 暂停休眠|设置键盘暂停休眠状态|[setBsKpPauseSleep](#setbskppausesleep)|[fEvtBsKpPauseSleep](#fevtbskppausesleep)|
+|键盘统一设置 - 键盘休眠|设置键盘休眠等级|[setBsKpSleepLevel](#setbskpsleeplevel)|[fEvtBsKpSleepLevel](#fevtbskpsleeplevel)|
+||获取键盘休眠等级|[getBsKpSleepLevel](#getbskpsleeplevel)|[fEvtBsKpSleepLevel](#fevtbskpsleeplevel)|
+||<font color="red">设置键盘暂停休眠状态(内)</font>|[setBsKpPauseSleep](#setbskppausesleep)|[fEvtBsKpPauseSleep](#fevtbskppausesleep)|
 |配对模式 - 快速配对|启动基站快速配对|[startBsFastPair](#startbsfastpair)|[sEvtStateCode](#sevtstatecode)<br>[sEvtBsKpOnlineMsg](#sevtbskponlinemsg)|
 ||停止基站快速配对|[stopBsFastPair](#stopbsfastpair)|[sEvtStateCode](#sevtstatecode)|
 |白名单模式 - 白名单管理|获取白名单|[getBsWhitelist](#getbswhitelist)|[fEvtBsWhitelist](#fevtbswhitelist)|
@@ -949,8 +951,49 @@
 }
 ```
-##### setBsKpPauseSleep
+##### getBsKpSleepLevel
 - **主题**：/client/\${baseSN}/send
+- **功能描述**：获取键盘休眠时间等级
+- **参数说明**
+
+|参数名|类型|限制|是否必填|说明|
+|---|---|---|---|---|
+|fun|string|-|是|指令名称|
+|dataTag|string|-|否|数据包标识,可为空字符串|
+
+- **示例代码**
+```Json
+{
+  "fun":"getBsKpSleepLevel",
+  "dataTag":"1"
+}
+```
+
+##### setBsKpSleepLevel
+- **主题**：/client/\${baseSN}/send
+- **功能描述**：设置键盘休眠时间等级
+- **参数说明**
+
+|参数名|类型|限制|是否必填|说明|
+|---|---|---|---|---|
+|fun|string|-|是|指令名称|
+|dataTag|string|-|否|数据包标识,可为空字符串|
+|data|object|-|是|传送参数的对象|
+|+value|string||是|设置键盘休眠的时间等级<br>0-30秒<br>1-2分钟<br>2-10分钟<br>3-45分钟|
+
+- **示例代码**
+```Json
+{
+  "fun":"setBsKpSleepLevel",
+  "dataTag":"1",
+  "data":{
+    "value":"1"
+  }
+}
+```
+
+##### setBsKpPauseSleep
+- **主题**：<sapn class="yellowFill">/manage/\${baseSN}/send</span>
 - **功能描述**：设置键盘暂停休眠是否开启<br><font color="red">注意：请谨慎使用本功能，务必在相关测试或功能完成后关闭，否则可能会导致键盘异常耗电</font>
 - **参数说明**
@@ -983,7 +1026,7 @@
 |fun|string|-|是|指令名称|
 |dataTag|string|-|否|数据包标识,可为空字符串|
 |data|object|-|是|传送参数的对象|
-|+value|string||是|设置键盘显示的语言<br>1-简体中文<br>2-英文|
+|+value|string||是|键盘显示的语言<br>1-简体中文<br>2-英文|
 - **示例代码**
 ```Json
@@ -996,8 +1039,31 @@
 }
 ```
-##### fEvtBsKpPauseSleep
+##### fEvtBsKpSleepLevel
 - **主题**: /basestation/\${baseSN}/receive
+- **功能描述**：返回键盘休眠时间等级
+- **参数说明**
+
+|参数名|类型|限制|非空|说明|
+|---|---|---|---|---|
+|fun|string|-|是|指令名称|
+|dataTag|string|-|否|数据包标识,可为空字符串|
+|data|object|-|是|传送参数的对象|
+|+value|string||是|键盘休眠的时间等级<br>0-30秒<br>1-2分钟<br>2-10分钟<br>3-45分钟|
+
+- **示例代码**
+```Json
+{
+  "fun":"fEvtBsKpSleepLevel",
+  "dataTag":"1",
+  "data":{
+    "value":"1"
+  }
+}
+```
+
+##### fEvtBsKpPauseSleep
+- **主题**: <sapn class="yellowFill">/manage/\${baseSN}/receive</span>
 - **功能描述**：返回暂停键盘休眠开启状态
 - **参数说明**
@@ -153,7 +153,9 @@ WebSocketæ–¹å¼åº”ç”¨ä¸ŽSDKæˆ–åŸºç«™å»ºç«‹é•¿è¿žæŽ¥åŽï¼Œé€šè¿‡WebSocketæŽ¥å£å
 ||è®¾ç½®Beepå·¥ä½œçŠ¶æ€|[setBsKpBeepMode](#setbskpbeepmode)|[fEvtBsKpBeepMode](#fevtbskpbeepmode)|
 |é”®ç›˜ç»Ÿä¸€è®¾ç½® - é•¿è·è€ƒå‹¤|èŽ·å–é”®ç›˜é•¿è·è€ƒå‹¤çŠ¶æ€|[getBsKpRFIDState](#getbskprfidstate)|[fEvtBsKpRFIDState](#fevtbskprfidstate)|
 ||è®¾ç½®é”®ç›˜é•¿è·è€ƒå‹¤çŠ¶æ€|[setBsKpRFIDState](#setbskprfidstate)|[fEvtBsKpRFIDState](#fevtbskprfidstate)|
-|é”®ç›˜ç»Ÿä¸€è®¾ç½® - æš‚åœä¼‘çœ |è®¾ç½®é”®ç›˜æš‚åœä¼‘çœ çŠ¶æ€|[setBsKpPauseSleep](#setbskppausesleep)|[fEvtBsKpPauseSleep](#fevtbskppausesleep)|
+|é”®ç›˜ç»Ÿä¸€è®¾ç½® - é”®ç›˜ä¼‘çœ |è®¾ç½®é”®ç›˜ä¼‘çœ ç‰çº§|[setBsKpSleepLevel](#setbskpsleeplevel)|[fEvtBsKpSleepLevel](#fevtbskpsleeplevel)|
+||èŽ·å–é”®ç›˜ä¼‘çœ ç‰çº§|[getBsKpSleepLevel](#getbskpsleeplevel)|[fEvtBsKpSleepLevel](#fevtbskpsleeplevel)|
+||<font color="red">è®¾ç½®é”®ç›˜æš‚åœä¼‘çœ çŠ¶æ€(å†…)</font>|[setBsKpPauseSleep](#setbskppausesleep)|[fEvtBsKpPauseSleep](#fevtbskppausesleep)|
 |é…å¯¹æ¨¡å¼ - å¿«é€Ÿé…å¯¹|å¯åŠ¨åŸºç«™å¿«é€Ÿé…å¯¹|[startBsFastPair](#startbsfastpair)|[sEvtStateCode](#sevtstatecode)<br>[sEvtBsKpOnlineMsg](#sevtbskponlinemsg)|
 ||åœæ¢åŸºç«™å¿«é€Ÿé…å¯¹|[stopBsFastPair](#stopbsfastpair)|[sEvtStateCode](#sevtstatecode)|
 |ç™½åå•æ¨¡å¼ - ç™½åå•ç®¡ç†|èŽ·å–ç™½åå•|[getBsWhitelist](#getbswhitelist)|[fEvtBsWhitelist](#fevtbswhitelist)|
@@ -1575,6 +1577,49 @@ WebSocketæ–¹å¼åº”ç”¨ä¸ŽSDKæˆ–åŸºç«™å»ºç«‹é•¿è¿žæŽ¥åŽï¼Œé€šè¿‡WebSocketæŽ¥å£å
   }
 }
 ```
+
+
+##### getBsKpSleepLevel
+- **ä¸»é¢˜**ï¼š/client/\${baseSN}/send
+- **åŠŸèƒ½æè¿°**ï¼šèŽ·å–é”®ç›˜ä¼‘çœ æ—¶é—´ç‰çº§
+- **å‚æ•°è¯´æ˜Ž**
+
+|å‚æ•°å|ç±»åž‹|é™åˆ¶|æ˜¯å¦å¿…å¡«|è¯´æ˜Ž|
+|---|---|---|---|---|
+|fun|string|-|æ˜¯|æŒ‡ä»¤åç§°|
+|dataTag|string|-|å¦|æ•°æ®åŒ…æ ‡è¯†,å¯ä¸ºç©ºå—ç¬¦ä¸²|
+
+- **ç¤ºä¾‹ä»£ç **
+```Json
+{
+  "fun":"getBsKpSleepLevel",
+  "dataTag":"1"
+}
+```
+
+##### setBsKpSleepLevel
+- **ä¸»é¢˜**ï¼š/client/\${baseSN}/send
+- **åŠŸèƒ½æè¿°**ï¼šè®¾ç½®é”®ç›˜ä¼‘çœ æ—¶é—´ç‰çº§
+- **å‚æ•°è¯´æ˜Ž**
+
+|å‚æ•°å|ç±»åž‹|é™åˆ¶|æ˜¯å¦å¿…å¡«|è¯´æ˜Ž|
+|---|---|---|---|---|
+|fun|string|-|æ˜¯|æŒ‡ä»¤åç§°|
+|dataTag|string|-|å¦|æ•°æ®åŒ…æ ‡è¯†,å¯ä¸ºç©ºå—ç¬¦ä¸²|
+|data|object|-|æ˜¯|ä¼ é€å‚æ•°çš„å¯¹è±¡|
+|+value|string||æ˜¯|è®¾ç½®é”®ç›˜ä¼‘çœ çš„æ—¶é—´ç‰çº§<br>0-30ç§’<br>1-2åˆ†é’Ÿ<br>2-10åˆ†é’Ÿ<br>3-45åˆ†é’Ÿ|
+
+- **ç¤ºä¾‹ä»£ç **
+```Json
+{
+  "fun":"setBsKpSleepLevel",
+  "dataTag":"1",
+  "data":{
+    "value":"1"
+  }
+}
+```
+
 ##### setBsKpPauseSleep
 - **ä¸»é¢˜**ï¼š/client/\${baseSN}/send
 - **åŠŸèƒ½æè¿°**ï¼šè®¾ç½®é”®ç›˜æš‚åœä¼‘çœ æ˜¯å¦å¼€å¯<br><font color="red">æ³¨æ„ï¼šè¯·è°¨æ…Žä½¿ç”¨æœ¬åŠŸèƒ½ï¼ŒåŠ¡å¿…åœ¨ç›¸å…³æµ‹è¯•æˆ–åŠŸèƒ½å®ŒæˆåŽå…³é—ï¼Œå¦åˆ™å¯èƒ½ä¼šå¯¼è‡´é”®ç›˜å¼‚å¸¸è€—ç”µ</font>
@@ -1690,6 +1735,30 @@ WebSocketæ–¹å¼åº”ç”¨ä¸ŽSDKæˆ–åŸºç«™å»ºç«‹é•¿è¿žæŽ¥åŽï¼Œé€šè¿‡WebSocketæŽ¥å£å
   }
 }
 ```
+
+##### fEvtBsKpSleepLevel
+- **ä¸»é¢˜**: /basestation/\${baseSN}/receive
+- **åŠŸèƒ½æè¿°**ï¼šè¿”å›žé”®ç›˜ä¼‘çœ æ—¶é—´ç‰çº§
+- **å‚æ•°è¯´æ˜Ž**
+
+|å‚æ•°å|ç±»åž‹|é™åˆ¶|éžç©º|è¯´æ˜Ž|
+|---|---|---|---|---|
+|fun|string|-|æ˜¯|æŒ‡ä»¤åç§°|
+|dataTag|string|-|å¦|æ•°æ®åŒ…æ ‡è¯†,å¯ä¸ºç©ºå—ç¬¦ä¸²|
+|data|object|-|æ˜¯|ä¼ é€å‚æ•°çš„å¯¹è±¡|
+|+value|string||æ˜¯|é”®ç›˜ä¼‘çœ çš„æ—¶é—´ç‰çº§<br>0-30ç§’<br>1-2åˆ†é’Ÿ<br>2-10åˆ†é’Ÿ<br>3-45åˆ†é’Ÿ|
+
+- **ç¤ºä¾‹ä»£ç **
+```Json
+{
+  "fun":"fEvtBsKpSleepLevel",
+  "dataTag":"1",
+  "data":{
+    "value":"1"
+  }
+}
+```
+
 ##### fEvtBsKpPauseSleep
 - **ä¸»é¢˜**: /basestation/\${baseSN}/receive
 - **åŠŸèƒ½æè¿°**ï¼šè¿”å›žæš‚åœé”®ç›˜ä¼‘çœ å¼€å¯çŠ¶æ€
@@ -2917,7 +2986,6 @@ WebSocketæ–¹å¼åº”ç”¨ä¸ŽSDKæˆ–åŸºç«™å»ºç«‹é•¿è¿žæŽ¥åŽï¼Œé€šè¿‡WebSocketæŽ¥å£å
 |+version|string||æ˜¯|é”®ç›˜å›ºä»¶ç‰ˆæœ¬|
 |+model|int||æ˜¯|é”®ç›˜åž‹å·|
 |+voltage|double||æ˜¯|é”®ç›˜ç”µé‡<font color="red">ï¼ˆå¾…é”®ç›˜ä¿®æ”¹æˆç™¾åˆ†æ¯”ï¼‰</font>|
-|+isWeak|int||æ˜¯|æ˜¯å¦å¼±ç”µï¼Œ 0-æ£å¸¸ï¼Œ1-å¼±ç”µ<font color="red">ï¼ˆå¾…é”®ç›˜ä¿®æ”¹ä¸ŠæŠ¥å¼±ç”µçŠ¶æ€ï¼‰</font>|
 - **ç¤ºä¾‹ä»£ç **
 ```Json
@@ -2928,8 +2996,7 @@ WebSocketæ–¹å¼åº”ç”¨ä¸ŽSDKæˆ–åŸºç«™å»ºç«‹é•¿è¿žæŽ¥åŽï¼Œé€šè¿‡WebSocketæŽ¥å£å
         "keySn":"1234567890",
         "version":"1.0.0",
         "model":67,
-        "voltage":2.8,
-        "isWeak":0
+        "voltage":2.8
     }
 }
 ```