Commit fbecaf75eefc1855fe2b5bb46029255fc81f78f7
1 parent
63b4549b
拆分键盘开机上线事件和扫描中状态上报事件
Showing
1 changed file
with
32 additions
and
7 deletions
通讯协议-B200W-MQTT协议[外].md
@@ -111,7 +111,7 @@ MQTT服务器配置结果检查 | @@ -111,7 +111,7 @@ MQTT服务器配置结果检查 | ||
111 | |功能归类|功能|API指令|指令事件| | 111 | |功能归类|功能|API指令|指令事件| |
112 | |---|---|---|---| | 112 | |---|---|---|---| |
113 | |交互设置 - 用户实时提示信息|实时设置提示反馈信息|[rtSetKpUserPrompt](#rtsetkpuserprompt)|[sEvtStateCode](#sevtstatecode)<br>[fEvtSetKpUserPrompt](#fevtsetkpuserprompt)| | 113 | |交互设置 - 用户实时提示信息|实时设置提示反馈信息|[rtSetKpUserPrompt](#rtsetkpuserprompt)|[sEvtStateCode](#sevtstatecode)<br>[fEvtSetKpUserPrompt](#fevtsetkpuserprompt)| |
114 | -|在线状态获取|开启扫描在线键盘|[startGetKpOnline](#startgetkponline)|[sEvtStateCode](#sevtstatecode)<br>[sEvtBsKpOnlineMsg](#sevtbskponlinemsg)| | 114 | +|在线状态获取|开启扫描在线键盘|[startGetKpOnline](#startgetkponline)|[sEvtStateCode](#sevtstatecode)<br>[fEvtKpOnlineMsg](#fevtkponlinemsg)| |
115 | ||停止扫描在线键盘|[stopGetKpOnline](#stopgetkponline)|[sEvtStateCode](#sevtstatecode)| | 115 | ||停止扫描在线键盘|[stopGetKpOnline](#stopgetkponline)|[sEvtStateCode](#sevtstatecode)| |
116 | |维护功能 - 遥控功能|遥控键盘休眠|[remoteKpSleep](#remotekpsleep)|[sEvtStateCode](#sevtstatecode)| | 116 | |维护功能 - 遥控功能|遥控键盘休眠|[remoteKpSleep](#remotekpsleep)|[sEvtStateCode](#sevtstatecode)| |
117 | ### 绑定 | 117 | ### 绑定 |
@@ -246,7 +246,6 @@ MQTT服务器配置结果检查 | @@ -246,7 +246,6 @@ MQTT服务器配置结果检查 | ||
246 | |+keySn|string||是|键盘SN| | 246 | |+keySn|string||是|键盘SN| |
247 | |+version|string||是|键盘固件版本| | 247 | |+version|string||是|键盘固件版本| |
248 | |+model|int||是|键盘型号| | 248 | |+model|int||是|键盘型号| |
249 | -|+voltage|double||是|键盘电压| | ||
250 | 249 | ||
251 | - **示例代码** | 250 | - **示例代码** |
252 | 251 | ||
@@ -257,8 +256,7 @@ MQTT服务器配置结果检查 | @@ -257,8 +256,7 @@ MQTT服务器配置结果检查 | ||
257 | "data":{ | 256 | "data":{ |
258 | "keySn":"1234567890", | 257 | "keySn":"1234567890", |
259 | "version":"1.0.0", | 258 | "version":"1.0.0", |
260 | - "model":67, | ||
261 | - "voltage":2.8 | 259 | + "model":67 |
262 | } | 260 | } |
263 | } | 261 | } |
264 | ``` | 262 | ``` |
@@ -1128,7 +1126,7 @@ MQTT服务器配置结果检查 | @@ -1128,7 +1126,7 @@ MQTT服务器配置结果检查 | ||
1128 | #### 方法 | 1126 | #### 方法 |
1129 | ##### startGetKpOnline | 1127 | ##### startGetKpOnline |
1130 | - **主题**:/client/\${baseSN}/send | 1128 | - **主题**:/client/\${baseSN}/send |
1131 | -- **功能描述**:开始获取键盘在线信息,键盘在线返回键盘信息 [sEvtBsKpOnlineMsg](#sevtbskponlinemsg) | 1129 | +- **功能描述**:开始获取键盘在线信息,键盘在线返回键盘信息 |
1132 | - **参数说明** | 1130 | - **参数说明** |
1133 | 1131 | ||
1134 | |参数名|类型|限制|是否必填|说明| | 1132 | |参数名|类型|限制|是否必填|说明| |
@@ -1168,8 +1166,35 @@ MQTT服务器配置结果检查 | @@ -1168,8 +1166,35 @@ MQTT服务器配置结果检查 | ||
1168 | ##### [sEvtStateCode](#sevtstatecode) | 1166 | ##### [sEvtStateCode](#sevtstatecode) |
1169 | 发送指令后返回此事件 | 1167 | 发送指令后返回此事件 |
1170 | 1168 | ||
1171 | -##### [sEvtBsKpOnlineMsg](#sevtbskponlinemsg) | ||
1172 | -键盘在线返回此事件 | 1169 | +##### fEvtKpOnlineMsg |
1170 | +- **主题**: /basestation/\${baseSN}/receive | ||
1171 | +- **功能描述**:主动获取在线键盘时,在线键盘状态报告 | ||
1172 | +- **参数说明** | ||
1173 | + | ||
1174 | +|参数名|类型|限制|非空|说明| | ||
1175 | +|---|---|---|---|---| | ||
1176 | +|fun|string|-|是|事件名称| | ||
1177 | +|dataTag|string|-|否|数据包标识| | ||
1178 | +|data|object|-|是|传送参数的对象| | ||
1179 | +|+keySn|string||是|键盘SN| | ||
1180 | +|+version|string||是|键盘固件版本| | ||
1181 | +|+model|int||是|键盘型号| | ||
1182 | +|+voltage|double||是|键盘电量| | ||
1183 | + | ||
1184 | +- **示例代码** | ||
1185 | + | ||
1186 | +```json | ||
1187 | +{ | ||
1188 | + "fun":"fEvtKpOnlineMsg", | ||
1189 | + "dataTag":"1", | ||
1190 | + "data":{ | ||
1191 | + "keySn":"1234567890", | ||
1192 | + "version":"1.0.0", | ||
1193 | + "model":67, | ||
1194 | + "voltage":2.8 | ||
1195 | + } | ||
1196 | +} | ||
1197 | +``` | ||
1173 | 1198 | ||
1174 | ### 维护功能 | 1199 | ### 维护功能 |
1175 | #### 方法 | 1200 | #### 方法 |