From 0eb4c75fa1ad165791c1a3c4c3b8584ecd282bb6 Mon Sep 17 00:00:00 2001 From: liuqin Date: Mon, 19 Aug 2024 15:59:17 +0800 Subject: [PATCH] 增加快速配对、白名单管理、同步签到的对应章节内容 --- 通讯协议-B200W-MQTT协议[外].md | 339 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 335 insertions(+), 4 deletions(-) diff --git a/通讯协议-B200W-MQTT协议[外].md b/通讯协议-B200W-MQTT协议[外].md index 050865d..bfee838 100644 --- a/通讯协议-B200W-MQTT协议[外].md +++ b/通讯协议-B200W-MQTT协议[外].md @@ -102,6 +102,13 @@ MQTT服务器配置结果检查 ||设置基站登录名称|[setBsSSID](#setbsssid)|[fEvtBsSSID](#fevtbsssid)|| |键盘统一设置 - 键盘语言|获取键盘语言|[getBsKpLanguage](#getbskplanguage)|[fEvtBsKpLanguage](#fevtbskplanguage)| ||设置键盘语言|[setBsKpLanguage](#setbskplanguage)|[fEvtBsKpLanguage](#fevtbskplanguage)|| +|配对模式 - 快速配对|启动基站快速配对|[startBsFastPair](#startbsfastpair)|[sEvtStateCode](#sevtstatecode)
[sEvtBsKpOnlineMsg](#sevtbskponlinemsg)| +||停止基站快速配对|[stopBsFastPair](#stopbsfastpair)|[sEvtStateCode](#sevtstatecode)| +|白名单模式 - 白名单管理|获取白名单|[getBsWhitelist](#getbswhitelist)|[fEvtBsWhitelist](#fevtbswhitelist)| +||设置白名单|[setBsWhitelist](#setbswhitelist)|[sEvtStateCode](#sevtstatecode)
[fEvtSetBsWhitelist](#fevtsetbswhitelist)| +||清空白名单|[clearBsWhitelist](#clearbswhitelist)|[sEvtStateCode](#sevtstatecode)
[fEvtBsWhitelist](#fevtbswhitelist)| +||增加白名单|[addBsWhitelist](#addbswhitelist)|[sEvtStateCode](#sevtstatecode)
[fEvtAddBsWhitelist](#fevtaddbswhitelist)
[fEvtBsWhitelist](#fevtbswhitelist)| +||删除白名单|[delBsWhitelist](#delbswhitelist)|[sEvtStateCode](#sevtstatecode)
[fEvtDelBsWhitelist](#fevtdelbswhitelist)
[fEvtBsWhitelist](#fevtbswhitelist)| |网络设置 - TCP/IP参数|获取TCP/IP参数|[getBsTcpipParams](#getbstcpipparams)|[fEvtBsTcpipParams](#fevtbstcpipparams)| ||设置TCP/IP参数|[setBsTcpipParams](#setbstcpipparams)|[fEvtBsTcpipParams](#fevtbstcpipparams)|| |网络设置 - MQTT参数|获取MQTT参数|[getBsMqttParams](#getbsmqttparams)|[fEvtBsMqttParams](#fevtbsmqttparams)| @@ -122,6 +129,8 @@ MQTT服务器配置结果检查 ### 签到 |功能归类|功能|API指令|指令事件| |---|---|---|---| +|同步签到|启动同步签到|[startKpSignIn](#startkpsignin)|[sEvtStateCode](#sevtstatecode)
[fEvtKpSignIn](#fevtkpsignin)| +||停止同步签到|[stopKpSignIn](#stopkpsignin)|[sEvtStateCode](#sevtstatecode)| |随时签到|启动随时签到|[rtStartKpSignIn](#rtstartkpsignin)|[sEvtStateCode](#sevtstatecode)
[fEvtKpSignIn](#fevtkpsignin)| ||停止随时签到|[rtStopKpSignIn](#rtstopkpsignin)|[sEvtStateCode](#sevtstatecode)| ||实时PIN签到授权|[rtSetKpLoginAllowed](#rtsetkploginallowed)|[sEvtStateCode](#sevtstatecode)
[fEvtKpLoginAllowed](#fevtkploginallowed)| @@ -842,6 +851,261 @@ MQTT服务器配置结果检查 } } ``` +### 配对模式 +#### 方法 +##### 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数组，最多不超过200
键盘SN为10位数字| + +- **示例代码** +```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列表
键盘SN为10位数字| + +- **示例代码** +```json +{ + "fun":"addBsWhitelist", + "dataTag":"1", + "data":{ + "keySns":["2024021001"] + } +} +``` +##### delBsWhitelist +- **主题**：/client/\${baseSN}/send +- **功能描述**：从基站白名单列表中删除键盘 +- **参数说明** + +|参数名|类型|限制|是否必填|说明| +|---|---|---|---|---| +|fun|string|-|是|指令名称| +|dataTag|string|-|否|数据包标识,可为空字符串| +|data|object|-|是|传送参数的对象| +|+keySns|array|-|是|待删除的键盘SN列表
键盘SN为10位数字| + +- **示例代码** +```json +{ + "fun":"delBsWhitelist", + "dataTag":"1", + "data":{ + "keySns":["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"] + } +} +``` + +##### fEvtSetBsWhitelist +- **主题**：/basestation/\${baseSN}/receive +- **功能描述**：返回设置白名单状态 +- **参数说明** + +|参数名|类型|限制|非空|说明| +|---|---|---|---|---| +|fun|string|-|是|指令名称| +|dataTag|string|-|否|数据包标识,可为空字符串| +|data|array|-|是|传送参数的对象数组| +|++keySns|array||是|键盘SN数组| +|++state|int||是|键盘SN的写入状态
0-写入成功
1-写入失败| + +- **示例代码** +```Json +{ + "fun":"fEvtSetBsWhitelist", + "dataTag":"1", + "data":[{ + "keySns":["2024021001","2024021002"], + "state":0 + },{ + "keySns":["1211"], + "state":1 + }] +} +``` + +##### fEvtAddBsWhitelist +- **主题**：/basestation/\${baseSN}/receive +- **功能描述**：返回增加键盘状态 +- **参数说明** + +|参数名|类型|限制|非空|说明| +|---|---|---|---|---| +|fun|string|-|是|指令名称| +|dataTag|string|-|否|数据包标识,可为空字符串| +|data|array|-|是|传送参数的对象数组| +|++keySns|array||是|键盘SN数组| +|++state|int||是|键盘的增加状态
0-增加成功
1-增加失败| + +- **示例代码** +```Json +{ + "fun":"fEvtAddBsWhitelist", + "dataTag":"1", + "data":[{ + "keySns":["2024021001","2024021002"], + "state":0 + },{ + "keySns":["1211"], + "state":1 + }] +} +``` + +##### fEvtDelBsWhitelist +- **主题**：/basestation/\${baseSN}/receive +- **功能描述**：返回删除键盘状态 +- **参数说明** + +|参数名|类型|限制|非空|说明| +|---|---|---|---|---| +|fun|string|-|是|指令名称| +|dataTag|string|-|否|数据包标识,可为空字符串| +|data|array|-|是|传送参数的对象数组| +|++keySns|array||是|键盘SN数组| +|++state|int||是|键盘的删除状态
0-删除成功
1-删除失败| + +- **示例代码** +```Json +{ + "fun":"fEvtDelBsWhitelist", + "dataTag":"1", + "data":[{ + "keySns":["2024021002"], + "state":0 + },{ + "keySns":["2024021001"], + "state":1 + }] +} +``` ### 网络参数设置 #### 方法 @@ -1180,7 +1444,6 @@ MQTT服务器配置结果检查 |+version|string||是|键盘固件版本| |+model|int||是|键盘型号| |+voltage|double||是|键盘电量| -|+keyTime|double||是|提交时间，从启动开始计时，单位秒| - **示例代码** @@ -1192,8 +1455,7 @@ MQTT服务器配置结果检查 "keySn":"1234567890", "version":"1.0.0", "model":67, - "voltage":2.8, - "keyTime":0.5 + "voltage":2.8 } } ``` @@ -1348,6 +1610,75 @@ MQTT服务器配置结果检查 ``` ## 签到 +### 同步签到 +#### 方法 +##### startKpSignIn +- **主题**：/client/\${baseSN}/send +- **功能描述**：启动同步签到 +- **参数说明** + +|参数名|类型|限制|是否必填|说明| +|---|---|---|---|---| +|fun|string|-|是|指令名称| +|dataTag|string|-|否|数据包标识,可为空字符串| +|data|object|-|是|传递参数的对象| +|+mode|int|-|是|签到模式
1-按键签到，可指定按键
2-PIN码签到，可指定PIN码长度| +|+allowModify |int|-|是 | 修改模式
0-不可修改
1-可以修改(默认值)| +|+pinLen |int|-|是| 可输入pin码的最大长度 1≤N≤14 | +|+keyValue |int|-|是 | 指定按键键值
0: 未指定(OK键签到)
1-9: 按键1-9
10: 按键0
11: 上键
12: 下键
13: OK键
14: ESC键
15: Menu键 | +|+tipTitle |string|-|否| 提示标题,长度最多不超过16个字节| + +- **示例代码** +```Json +//按键签到 +{ + "fun":"startKpSignIn", + "dataTag":"1", + "data":{ + "mode":1, + "allowModify":1, + "keyValue":5, + "tip":"请按5键签到" + } +} + +//pin签到 +{ + "fun":"startKpSignIn", + "dataTag":"1", + "data":{ + "mode":2, + "allowModify":1, + "pinLen":6, + "tip":"请输入PIN码签到" + } +} +``` + +##### stopKpSignIn +- **主题**：/client/\${baseSN}/send +- **功能描述**：停止同步签到 +- **参数说明** + +|参数名|类型|限制|是否必填|说明| +|---|---|---|---|---| +|fun|string|-|是|指令名称| +|dataTag|string|-|否|数据包标识,可为空字符串| + +- **示例代码** +```Json +{ + "fun":"stopKpSignIn", + "dataTag":"1" +} +``` +#### 事件 +##### [sEvtStateCode](#sevtstatecode) +发送指令后返回接收状态 + +##### [fEvtKpSignIn](#fevtkpsignin) +返回键盘提交的签到数据 + ### 随时签到 #### 方法 ##### rtStartKpSignIn @@ -1376,7 +1707,7 @@ MQTT服务器配置结果检查 ##### rtStopKpSignIn - **主题**：/client/\${baseSN}/send -- **功能描述**：停止签到绑定 +- **功能描述**：停止随时签到绑定 - **参数说明** |参数名|类型|限制|是否必填|说明| -- libgit2 0.21.4