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

DMchen
2 parents 80b7abcd ee39e1c1
Showing 2 changed files with 335 additions and 4 deletions
通讯协议-B200W-MQTT协议[内部].md
通讯协议-B200W-MQTT协议[外].md
@@ -100,6 +100,16 @@
 ||设置基站登录名称|[setBsSSID](#setbsssid)|[fEvtBsSSID](#fevtbsssid)||
 |键盘统一设置 - 键盘语言|获取键盘语言|[getBsKpLanguage](#getbskplanguage)|[fEvtBsKpLanguage](#fevtbskplanguage)|
 ||设置键盘语言|[setBsKpLanguage](#setbskplanguage)|[fEvtBsKpLanguage](#fevtbskplanguage)||
+|键盘统一设置 - 暂停休眠|设置键盘暂停休眠状态|[setBsKpPauseSleep](#setbskppausesleep)|[fEvtBsKpPauseSleep](#fevtbskppausesleep)|
+|配对模式 - 快速配对|启动基站快速配对|[startBsFastPair](#startbsfastpair)|[sEvtStateCode](#sevtstatecode)<br>[sEvtBsKpOnlineMsg](#sevtbskponlinemsg)|
+||停止基站快速配对|[stopBsFastPair](#stopbsfastpair)|[sEvtStateCode](#sevtstatecode)|
+|白名单模式 - 白名单管理|获取白名单|[getBsWhitelist](#getbswhitelist)|[fEvtBsWhitelist](#fevtbswhitelist)|
+||设置白名单|[setBsWhitelist](#setbswhitelist)|[sEvtStateCode](#sevtstatecode)<br>[fEvtBsWhitelist](#fevtbswhitelist)|
+||清空白名单|[clearBsWhitelist](#clearbswhitelist)|[sEvtStateCode](#sevtstatecode)<br>[fEvtBsWhitelist](#fevtbswhitelist)|
+||增加白名单|[addBsWhitelist](#addbswhitelist)|[sEvtStateCode](#sevtstatecode)<br>[fEvtAddBsWhitelist](#fevtaddbswhitelist)<br>[fEvtBsWhitelist](#fevtbswhitelist)|
+||删除白名单|[delBsWhitelist](#delbswhitelist)|[sEvtStateCode](#sevtstatecode)<br>[fEvtDelBsWhitelist](#fevtdelbswhitelist)<br>[fEvtBsWhitelist](#fevtbswhitelist)|
+||锁定单个白名单|[lockBsWhitelistKp](#lockbswhitelistkp)|[fEvtLockBsWhitelistKp](#fevtlockbswhitelistkp)|
+||解锁单个白名单|[unlockBsWhitelistKp](#unlockbswhitelistkp)|[fEvtLockBsWhitelistKp](#fevtlockbswhitelistkp)|
 |网络设置 - TCP/IP参数|获取TCP/IP参数|[getBsTcpipParams](#getbstcpipparams)|[fEvtBsTcpipParams](#fevtbstcpipparams)|
 ||设置TCP/IP参数|[setBsTcpipParams](#setbstcpipparams)|[fEvtBsTcpipParams](#fevtbstcpipparams)||
 |网络设置 - MQTT参数|获取MQTT参数|[getBsMqttParams](#getbsmqttparams)|[fEvtBsMqttParams](#fevtbsmqttparams)|
@@ -490,7 +500,7 @@
 - **示例代码**
 ```Json
 {
-  "fun":"getBsBIC",
+  "fun":"setBsBIC",
   "dataTag":"1",
   "data":{
     "value":"sunvote"
@@ -942,6 +952,30 @@
   }
 }
 ```
+
+##### setBsKpPauseSleep
+- **主题**：/client/\${baseSN}/send
+- **功能描述**：设置键盘暂停休眠是否开启<br><font color="red">注意：请谨慎使用本功能，务必在相关测试或功能完成后关闭，否则可能会导致键盘异常耗电</font>
+- **参数说明**
+
+|参数名|类型|限制|是否必填|说明|
+|---|---|---|---|---|
+|fun|string|-|是|指令名称|
+|dataTag|string|-|否|数据包标识,可为空字符串|
+|data|object|-|是|传送参数的对象|
+|+value|string||是|设置键盘暂停休眠是否开启<br>0-关闭暂停休眠<br>1-开启暂停休眠|
+
+- **示例代码**
+```Json
+{
+  "fun":"setBsKpPauseSleep",
+  "dataTag":"1",
+  "data":{
+    "value":"1"
+  }
+}
+```
+
 #### 事件
 ##### fEvtBsKpLanguage
 - **主题**: /basestation/\${baseSN}/receive
@@ -965,6 +999,303 @@
   }
 }
 ```
+
+##### fEvtBsKpPauseSleep
+- **主题**: /basestation/\${baseSN}/receive
+- **功能描述**：返回暂停键盘休眠开启状态
+- **参数说明**
+
+|参数名|类型|限制|非空|说明|
+|---|---|---|---|---|
+|fun|string|-|是|指令名称|
+|dataTag|string|-|否|数据包标识,可为空字符串|
+|data|object|-|是|传送参数的对象|
+|+value|string||是|返回暂停键盘休眠开启状态<br>0-未开启暂停休眠<br>1-开启暂停休眠|
+
+- **示例代码**
+```Json
+{
+  "fun":"fEvtBsKpPauseSleep",
+  "dataTag":"1",
+  "data":{
+    "value":"0"
+  }
+}
+```
+
+### 配对模式
+#### 方法
+##### startBsFastPair
+- **主题**：/client/\${baseSN}/send
+- **功能描述**：启动快速配对,键盘配对成功返回键盘信息 [sEvtBsKpOnlineMsg](#sevtbskponlinemsg)
+- **参数说明**
+
+|参数名|类型|限制|是否必填|说明|
+|---|---|---|---|---|
+|fun|string|-|是|指令名称|
+|dataTag|string|-|否|数据包标识,可为空字符串|
+```json
+{
+  "fun": "startBsFastPair",
+  "dataTag":"1"
+}
+```
+##### stopBsFastPair
+- **主题**：/client/\${baseSN}/send
+- **功能描述**：停止快速配对
+- **参数说明**
+
+|参数名|类型|限制|是否必填|说明|
+|---|---|---|---|---|
+|fun|string|-|是|指令名称|
+|dataTag|string|-|否|数据包标识,可为空字符串|
+```json
+{
+  "fun": "stopBsFastPair",
+  "dataTag":"1"
+}
+```
+#### 事件
+##### [sEvtStateCode](#sevtstatecode)
+发送指令后返回此事件
+
+##### [sEvtBsKpOnlineMsg](#sevtbskponlinemsg)
+键盘配对成功后在线返回此事件
+
+### 白名单模式
+#### 方法
+##### getBsWhitelist
+- **主题**：/client/\${baseSN}/send
+- **功能描述**：获取基站白名单列表
+- **参数说明**
+
+|参数名|类型|限制|是否必填|说明|
+|---|---|---|---|---|
+|fun|string|-|是|指令名称|
+|dataTag|string|-|否|数据包标识,可为空字符串|
+```json
+{
+  "fun": "getBsWhitelist",
+  "dataTag":"1"
+}
+```
+##### setBsWhitelist
+- **主题**：/client/\${baseSN}/send
+- **功能描述**：设置基站白名单列表，将基站白名单替换为写入的键盘SN列表
+- **参数说明**
+
+|参数名|类型|限制|是否必填|说明|
+|---|---|---|---|---|
+|fun|string|-|是|指令名称|
+|dataTag|string|-|否|数据包标识,可为空字符串|
+|data|object|-|是|传送参数的对象|
+|+keySns|array|-|是|待写入的键盘SN数组|
+```json
+{
+  "fun": "setBsWhitelist",
+  "dataTag":"1",
+  "data":{
+    "keySns":["2024021001","2024021002","2024021003","2024021004"]
+  }
+}
+```
+##### clearBsWhitelist
+- **主题**：/client/\${baseSN}/send
+- **功能描述**：清空基站白名单列表
+- **参数说明**
+
+|参数名|类型|限制|是否必填|说明|
+|---|---|---|---|---|
+|fun|string|-|是|指令名称|
+|dataTag|string|-|否|数据包标识,可为空字符串|
+```json
+{
+  "fun": "clearBsWhitelist",
+  "dataTag":"1"
+}
+```
+##### addBsWhitelist
+- **主题**：/client/\${baseSN}/send
+- **功能描述**：添加键盘至基站白名单列表
+- **参数说明**
+
+|参数名|类型|限制|是否必填|说明|
+|---|---|---|---|---|
+|fun|string|-|是|指令名称|
+|dataTag|string|-|否|数据包标识,可为空字符串|
+|data|object|-|是|传送参数的对象|
+|+keySns|array|-|是|待添加的键盘SN列表|
+```json
+{
+  "fun": "addBsWhitelist",
+  "dataTag":"1",
+  "data":{
+    "keySns":["2024021001"]
+  }
+}
+```
+##### delBsWhitelist
+- **主题**：/client/\${baseSN}/send
+- **功能描述**：从基站白名单列表中删除键盘
+- **参数说明**
+
+|参数名|类型|限制|是否必填|说明|
+|---|---|---|---|---|
+|fun|string|-|是|指令名称|
+|dataTag|string|-|否|数据包标识,可为空字符串|
+|data|object|-|是|传送参数的对象|
+|+keySns|array|-|是|待删除的键盘SN列表|
+```json
+{
+  "fun": "delBsWhitelist",
+  "dataTag":"1",
+  "data":{
+    "keySns":["2024021001"]
+  }
+}
+```
+##### lockBsWhitelistKp
+- **主题**：/client/\${baseSN}/send
+- **功能描述**：锁定指定的键盘SN，基站限制容量时，被锁定键盘SN不会被新刷卡加入的键盘挤出
+- **参数说明**
+
+|参数名|类型|限制|是否必填|说明|
+|---|---|---|---|---|
+|fun|string|-|是|指令名称|
+|dataTag|string|-|否|数据包标识,可为空字符串|
+|data|object|-|是|传送参数的对象|
+|+keySns|array|-|是|待锁定的键盘SN列表，空数组代表锁定所有键盘|
+```json
+{
+  "fun": "lockBsWhitelistKp",
+  "dataTag":"1",
+  "data":{
+    "keySns":["2024021001"]
+  }
+}
+```
+##### unlockBsWhitelistKp
+- **主题**：/client/\${baseSN}/send
+- **功能描述**：解锁键盘SN
+- **参数说明**
+
+|参数名|类型|限制|是否必填|说明|
+|---|---|---|---|---|
+|fun|string|-|是|指令名称|
+|dataTag|string|-|否|数据包标识,可为空字符串|
+|data|object|-|是|传送参数的对象|
+|+keySns|array|-|是|待解锁的键盘SN列表，空数组代表解锁所有键盘|
+```json
+{
+  "fun": "unlockBsWhitelistKp",
+  "dataTag":"1",
+  "data":{
+    "keySn":["2024021001"]
+  }
+}
+```
+#### 事件
+##### [sEvtStateCode](#sevtstatecode)
+发送指令后返回此事件
+
+##### fEvtBsWhitelist
+- **主题**：/basestation/\${baseSN}/receive
+- **功能描述**：返回基站白名单列表
+- **参数说明**
+
+|参数名|类型|限制|非空|说明|
+|---|---|---|---|---|
+|fun|string|-|是|指令名称|
+|dataTag|string|-|否|数据包标识,可为空字符串|
+|data|object|-|是|传送参数的对象|
+|+keySns|array||是|基站当前的白名单列表|
+
+- **示例代码**
+```Json
+{
+  "fun":"fEvtBsWhitelist",
+  "dataTag":"1",
+  "data":{
+    "keySns":["2024021001","2024021002","2024021003","2024021004"]
+  }
+}
+```
+
+##### fEvtAddBsWhitelist
+- **主题**：/basestation/\${baseSN}/receive
+- **功能描述**：返回增加键盘状态
+- **参数说明**
+
+|参数名|类型|限制|非空|说明|
+|---|---|---|---|---|
+|fun|string|-|是|指令名称|
+|dataTag|string|-|否|数据包标识,可为空字符串|
+|data|array|-|是|传送参数的对象数组|
+|++keySn|string||是|键盘SN|
+|++state|int||是|键盘的增加状态 <br>0-增加成功<br> 1-增加失败|
+
+- **示例代码**
+```Json
+{
+  "fun":"fEvtAddBsWhitelist",
+  "dataTag":"1",
+  "data":[{
+    "keySn":"2024021001",
+    "state":0
+  }]
+}
+```
+
+##### fEvtDelBsWhitelist
+- **主题**：/basestation/\${baseSN}/receive
+- **功能描述**：返回删除键盘状态
+- **参数说明**
+
+|参数名|类型|限制|非空|说明|
+|---|---|---|---|---|
+|fun|string|-|是|指令名称|
+|dataTag|string|-|否|数据包标识,可为空字符串|
+|data|array|-|是|传送参数的对象数组|
+|++keySn|string||是|键盘SN|
+|++state|int||是|键盘的删除状态 <br>0-删除成功<br> 1-删除失败|
+
+- **示例代码**
+```Json
+{
+  "fun":"fEvtDelBsWhitelist",
+  "dataTag":"1",
+  "data":[{
+    "keySn":"2024021001",
+    "state":0
+  }]
+}
+```
+
+##### fEvtLockBsWhitelistKp
+- **主题**：/basestation/\${baseSN}/receive
+- **功能描述**：返回键盘锁定状态
+- **参数说明**
+
+|参数名|类型|限制|非空|说明|
+|---|---|---|---|---|
+|fun|string|-|是|指令名称|
+|dataTag|string|-|否|数据包标识,可为空字符串|
+|data|array|-|是|传送参数的对象数组|
+|++keySn|string||是|解锁或锁定的键盘SN|
+|++state|int||是|键盘的锁定状态 <br>0-未锁定<br> 1-锁定|
+
+- **示例代码**
+```Json
+{
+  "fun":"fEvtLockBsWhitelistKp",
+  "dataTag":"1",
+  "data":[{
+    "keySn":"2024021001",
+    "state":1
+  }]
+}
+```
+
 ### 网络参数设置
 #### 方法
 ##### getBsTcpipParams
@@ -1155,7 +1486,7 @@
 |dataTag|string|-|否|数据包标识,可为空字符串|
 |data|object|-|是|传送参数的对象|
 |+index|int||是|数据包序号，从1开始，传0代表日志已传完|
-|+info|string||是|日志内容|
+|+info|string||是|日志内容<br><font color="red">日志的时间依赖于基站授时，需要加上时区得到具体的时间</font>|
 - **示例代码**
 ```Json
@@ -2398,7 +2729,7 @@
 |dataTag|string|-|否|数据包标识,可为空字符串|
 |data|array|-|是|传送参数的对象数组|
 |++keySn|string||是|键盘SN|
-|++keyValue|string||是|0 - 未提交(修改键盘运行提交时上报)<br>1 - 已交卷|
+|++keyValue|string||是|0 - 未提交(提交完成后，允许键盘修改答案时上报)<br>1 - 已交卷|
 |++keyTime|double||是|提交时间，从启动开始计算，单位秒|
 ```json
 {
@@ -1791,7 +1791,7 @@
 |dataTag|string|-|否|数据包标识,可为空字符串|
 |data|array|-|是|传送参数的对象数组|
 |++keySn|string||是|键盘SN|
-|++keyValue|string||是|0 - 未提交(修改键盘运行提交时上报)<br>1 - 已交卷|
+|++keyValue|string||是|0 - 未提交(提交完成后，允许键盘修改答案时上报)<br>1 - 已交卷|
 |++keyTime|double||是|提交时间，从启动开始计算，单位秒|
 ```json
 {