李外 / Protocol

Commit 86c8097e48ea760301189519fb94db9f3f4bde2b

Authored by 刘琴
1 parent a2f1ba0a

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

Inline Side-by-side
Showing 2 changed files with 141 additions and 8 deletions
通讯协议-B200W-MQTT协议[内部].md
  View file @86c8097
... ... @@ -100,7 +100,9 @@
100 100 ||设置基站登录名称|[setBsSSID](#setbsssid)|[fEvtBsSSID](#fevtbsssid)||
101 101 |键盘统一设置 - 键盘语言|获取键盘语言|[getBsKpLanguage](#getbskplanguage)|[fEvtBsKpLanguage](#fevtbskplanguage)|
102 102 ||设置键盘语言|[setBsKpLanguage](#setbskplanguage)|[fEvtBsKpLanguage](#fevtbskplanguage)||
103   -|键盘统一设置 - 暂停休眠|设置键盘暂停休眠状态|[setBsKpPauseSleep](#setbskppausesleep)|[fEvtBsKpPauseSleep](#fevtbskppausesleep)|
  103 +|键盘统一设置 - 键盘休眠|设置键盘休眠等级|[setBsKpSleepLevel](#setbskpsleeplevel)|[fEvtBsKpSleepLevel](#fevtbskpsleeplevel)|
  104 +||获取键盘休眠等级|[getBsKpSleepLevel](#getbskpsleeplevel)|[fEvtBsKpSleepLevel](#fevtbskpsleeplevel)|
  105 +||<font color="red">设置键盘暂停休眠状态(内)</font>|[setBsKpPauseSleep](#setbskppausesleep)|[fEvtBsKpPauseSleep](#fevtbskppausesleep)|
104 106 |配对模式 - 快速配对|启动基站快速配对|[startBsFastPair](#startbsfastpair)|[sEvtStateCode](#sevtstatecode)<br>[sEvtBsKpOnlineMsg](#sevtbskponlinemsg)|
105 107 ||停止基站快速配对|[stopBsFastPair](#stopbsfastpair)|[sEvtStateCode](#sevtstatecode)|
106 108 |白名单模式 - 白名单管理|获取白名单|[getBsWhitelist](#getbswhitelist)|[fEvtBsWhitelist](#fevtbswhitelist)|
... ... @@ -949,8 +951,49 @@
949 951 }
950 952 ```
951 953  
952   -##### setBsKpPauseSleep
  954 +##### getBsKpSleepLevel
953 955 - **主题**：/client/\${baseSN}/send
  956 +- **功能描述**：获取键盘休眠时间等级
  957 +- **参数说明**
  958 +
  959 +|参数名|类型|限制|是否必填|说明|
  960 +|---|---|---|---|---|
  961 +|fun|string|-|是|指令名称|
  962 +|dataTag|string|-|否|数据包标识,可为空字符串|
  963 +
  964 +- **示例代码**
  965 +```Json
  966 +{
  967 + "fun":"getBsKpSleepLevel",
  968 + "dataTag":"1"
  969 +}
  970 +```
  971 +
  972 +##### setBsKpSleepLevel
  973 +- **主题**：/client/\${baseSN}/send
  974 +- **功能描述**：设置键盘休眠时间等级
  975 +- **参数说明**
  976 +
  977 +|参数名|类型|限制|是否必填|说明|
  978 +|---|---|---|---|---|
  979 +|fun|string|-|是|指令名称|
  980 +|dataTag|string|-|否|数据包标识,可为空字符串|
  981 +|data|object|-|是|传送参数的对象|
  982 +|+value|string||是|设置键盘休眠的时间等级<br>0-30秒<br>1-2分钟<br>2-10分钟<br>3-45分钟|
  983 +
  984 +- **示例代码**
  985 +```Json
  986 +{
  987 + "fun":"setBsKpSleepLevel",
  988 + "dataTag":"1",
  989 + "data":{
  990 + "value":"1"
  991 + }
  992 +}
  993 +```
  994 +
  995 +##### setBsKpPauseSleep
  996 +- **主题**：<sapn class="yellowFill">/manage/\${baseSN}/send</span>
954 997 - **功能描述**：设置键盘暂停休眠是否开启<br><font color="red">注意：请谨慎使用本功能，务必在相关测试或功能完成后关闭，否则可能会导致键盘异常耗电</font>
955 998 - **参数说明**
956 999  
... ... @@ -983,7 +1026,7 @@
983 1026 |fun|string|-|是|指令名称|
984 1027 |dataTag|string|-|否|数据包标识,可为空字符串|
985 1028 |data|object|-|是|传送参数的对象|
986   -|+value|string||是|设置键盘显示的语言<br>1-简体中文<br>2-英文|
  1029 +|+value|string||是|键盘显示的语言<br>1-简体中文<br>2-英文|
987 1030  
988 1031 - **示例代码**
989 1032 ```Json
... ... @@ -996,8 +1039,31 @@
996 1039 }
997 1040 ```
998 1041  
999   -##### fEvtBsKpPauseSleep
  1042 +##### fEvtBsKpSleepLevel
1000 1043 - **主题**: /basestation/\${baseSN}/receive
  1044 +- **功能描述**：返回键盘休眠时间等级
  1045 +- **参数说明**
  1046 +
  1047 +|参数名|类型|限制|非空|说明|
  1048 +|---|---|---|---|---|
  1049 +|fun|string|-|是|指令名称|
  1050 +|dataTag|string|-|否|数据包标识,可为空字符串|
  1051 +|data|object|-|是|传送参数的对象|
  1052 +|+value|string||是|键盘休眠的时间等级<br>0-30秒<br>1-2分钟<br>2-10分钟<br>3-45分钟|
  1053 +
  1054 +- **示例代码**
  1055 +```Json
  1056 +{
  1057 + "fun":"fEvtBsKpSleepLevel",
  1058 + "dataTag":"1",
  1059 + "data":{
  1060 + "value":"1"
  1061 + }
  1062 +}
  1063 +```
  1064 +
  1065 +##### fEvtBsKpPauseSleep
  1066 +- **主题**: <sapn class="yellowFill">/manage/\${baseSN}/receive</span>
1001 1067 - **功能描述**：返回暂停键盘休眠开启状态
1002 1068 - **参数说明**
1003 1069  
... ...
通讯协议-平台化-应用部分.md
  View file @86c8097
... ... @@ -153,7 +153,9 @@ WebSocketæ–¹å¼åº”用与SDK或基站建立长连接åŽï¼Œé€šè¿‡WebSocket接å£å
153 153 ||设置Beep工作状æ€|[setBsKpBeepMode](#setbskpbeepmode)|[fEvtBsKpBeepMode](#fevtbskpbeepmode)|
154 154 |键盘统一设置 - é•¿è·è€ƒå‹¤|获å–键盘长è·è€ƒå‹¤çŠ¶æ€|[getBsKpRFIDState](#getbskprfidstate)|[fEvtBsKpRFIDState](#fevtbskprfidstate)|
155 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 159 |é…å¯¹æ¨¡å¼ - 快速é…对|å¯åŠ¨åŸºç«™å¿«é€Ÿé…对|[startBsFastPair](#startbsfastpair)|[sEvtStateCode](#sevtstatecode)<br>[sEvtBsKpOnlineMsg](#sevtbskponlinemsg)|
158 160 ||åœæ­¢åŸºç«™å¿«é€Ÿé…对|[stopBsFastPair](#stopbsfastpair)|[sEvtStateCode](#sevtstatecode)|
159 161 |白åå•æ¨¡å¼ - 白åå•ç®¡ç†|获å–白åå•|[getBsWhitelist](#getbswhitelist)|[fEvtBsWhitelist](#fevtbswhitelist)|
... ... @@ -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 1623 ##### setBsKpPauseSleep
1579 1624 - **主题**：/client/\${baseSN}/send
1580 1625 - **功能æè¿°**：设置键盘暂åœä¼‘眠是å¦å¼€å¯<br><font color="red">注æ„：请谨慎使用本功能，务必在相关测试或功能完æˆåŽå…³é—­ï¼Œå¦åˆ™å¯èƒ½ä¼šå¯¼è‡´é”®ç›˜å¼‚常耗电</font>
... ... @@ -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 1762 ##### fEvtBsKpPauseSleep
1694 1763 - **主题**: /basestation/\${baseSN}/receive
1695 1764 - **功能æè¿°**：返回暂åœé”®ç›˜ä¼‘眠开å¯çŠ¶æ€
... ... @@ -2917,7 +2986,6 @@ WebSocketæ–¹å¼åº”用与SDK或基站建立长连接åŽï¼Œé€šè¿‡WebSocket接å£å
2917 2986 |+version|string||是|键盘固件版本|
2918 2987 |+model|int||是|键盘型å·|
2919 2988 |+voltage|double||是|键盘电é‡<font color="red">（待键盘修改æˆç™¾åˆ†æ¯”）</font>|
2920   -|+isWeak|int||是|是å¦å¼±ç”µï¼Œ 0-正常，1-弱电<font color="red">（待键盘修改上报弱电状æ€ï¼‰</font>|
2921 2989  
2922 2990 - **示例代ç **
2923 2991 ```Json
... ... @@ -2928,8 +2996,7 @@ WebSocketæ–¹å¼åº”用与SDK或基站建立长连接åŽï¼Œé€šè¿‡WebSocket接å£å
2928 2996 "keySn":"1234567890",
2929 2997 "version":"1.0.0",
2930 2998 "model":67,
2931   - "voltage":2.8,
2932   - "isWeak":0
  2999 + "voltage":2.8
2933 3000 }
2934 3001 }
2935 3002 ```
... ...