李外 / Protocol

Commit 3dfdfb32dc44f4c0d930dade38a9550b35da2acc

Authored by 刘琴
1 parent c5600f43

增加键盘管理-在线状态获取的方法和返回

Inline Side-by-side
Showing 1 changed file with 85 additions and 4 deletions
通讯协议-B200W-MQTT协议[内部].md
  View file @3dfdfb3
... ... @@ -89,8 +89,10 @@
89 89 |---|---|---|---|
90 90 |<font color="red">识别设置 - 识别模式(内)|<font color="red">获取键盘识别模式(内)|[getKpIdentityMode](#getkpidentitymode)|[fEvtKpIdentityMode](#fevtkpidentitymode)|
91 91 ||<font color="red">设置键盘识别模式(内)|[setKpIdentityMode](#setkpidentitymode)|[fEvtKpIdentityMode](#fevtkpidentitymode)|
92   -|交互设置 - 用户内置状态语|设置用户内置状态语|[setKpUserStbMsg](#setkpuserstbmsg)|[fEvtKpUserStbMsg]()|
93   -|交互设置 - 用户实时提示信息|实时设置提示反馈信息|[rtSetKpUserPrompt](#rtsetkpuserprompt)|[fEvtSetKpUserPrompt]()|
  92 +|交互设置 - 用户内置状态语|设置用户内置状态语|[setKpUserStbMsg](#setkpuserstbmsg)|[fEvtKpUserStbMsg](#fevtkpuserstbmsg)|
  93 +|交互设置 - 用户实时提示信息|实时设置提示反馈信息|[rtSetKpUserPrompt](#rtsetkpuserprompt)|[fEvtSetKpUserPrompt](#fevtsetkpuserprompt)|
  94 +|在线状态获取|开启扫描在线键盘|[startGetKpOnline](#startgetkponline)|[fEvtStartGetKpOnline](#fevtstartgetkponline)<br>[sEvtBsKpOnlineMsg](#sevtbskponlinemsg)|
  95 +||停止扫描在线键盘|[stopGetKpOnline](#stopgetkponline)|[fEvtStopGetKpOnline](#fevtstopgetkponline)|
94 96 |维护功能 - 遥控功能|遥控键盘关机|[remoteKpPowerOff](#remotekppoweroff)|[fEvtRemoteKpPowerOff](#fevtremotekppoweroff)|
95 97 ||遥控键盘休眠|[remoteKpSleep](#remotekpsleep)|[fEvtRemoteKpSleep](#fevtremotekpsleep)|
96 98 |维护功能 - 遥控功能|<font color="red">启动键盘无线升级(内)|[startKpFWUpdate](#startkpfwupdate)|[fEvtStartKpFWUpdate](#fevtstartkpfwupdate)<br>[fEvtKpUpdateProgress](#fevtkpupdateprogress)<br>[sEvtBsKpOnlineMsg](#sevtbskponlinemsg)|
... ... @@ -1363,6 +1365,85 @@
1363 1365 ]
1364 1366 }
1365 1367 ```
  1368 +### 在线状态
  1369 +#### 方法
  1370 +##### startGetKpOnline
  1371 +- **主题**：/client/\${baseSN}/send
  1372 +- **功能描述**：开始获取键盘在线信息,键盘在线返回键盘信息 [sEvtBsKpOnlineMsg](#sevtbskponlinemsg)
  1373 +- **参数说明**
  1374 +
  1375 +|参数名|类型|限制|是否必填|说明|
  1376 +|---|---|---|---|---|
  1377 +|fun|string|-|是|指令名称|
  1378 +|dataTag|string|-|否|数据包标识,可为空字符串|
  1379 +```json
  1380 +{
  1381 + "fun": "startGetKpOnline",
  1382 + "dataTag":"1",
  1383 +}
  1384 +```
  1385 +
  1386 +##### stopGetKpOnline
  1387 +- **主题**：/client/\${baseSN}/send
  1388 +- **功能描述**：停止获取键盘在线信息
  1389 +- **参数说明**
  1390 +
  1391 +|参数名|类型|限制|是否必填|说明|
  1392 +|---|---|---|---|---|
  1393 +|fun|string|-|是|指令名称|
  1394 +|dataTag|string|-|否|数据包标识,可为空字符串|
  1395 +```json
  1396 +{
  1397 + "fun": "stopGetKpOnline",
  1398 + "dataTag":"1",
  1399 +}
  1400 +```
  1401 +#### 事件
  1402 +##### fEvtStartGetKpOnline
  1403 +- **主题**：/basestation/\${baseSN}/recive
  1404 +- **功能描述**：返回启动扫描在线键盘状态
  1405 +- **参数说明**
  1406 +
  1407 +|参数名|类型|限制|非空|说明|
  1408 +|---|---|---|---|---|
  1409 +|fun|string|-|是|指令名称|
  1410 +|dataTag|string|-|否|数据包标识,可为空字符串|
  1411 +|data|object|-|是|传送参数的对象|
  1412 +|+state|int||是|启动状态<br>0 - 成功<br>1 - 失败|
  1413 +```json
  1414 +{
  1415 + "fun": "fEvtStartGetKpOnline",
  1416 + "dataTag":"1",
  1417 + "data": {
  1418 + "state": 0
  1419 + }
  1420 +}
  1421 +```
  1422 +
  1423 +##### fEvtStopGetKpOnline
  1424 +- **主题**：/basestation/\${baseSN}/recive
  1425 +- **功能描述**：返回停止扫描在线键盘状态
  1426 +- **参数说明**
  1427 +
  1428 +|参数名|类型|限制|非空|说明|
  1429 +|---|---|---|---|---|
  1430 +|fun|string|-|是|指令名称|
  1431 +|dataTag|string|-|否|数据包标识,可为空字符串|
  1432 +|data|object|-|是|传送参数的对象|
  1433 +|+state|int||是|启动状态<br>0 - 成功<br>1 - 失败|
  1434 +```json
  1435 +{
  1436 + "fun": "fEvtStopGetKpOnline",
  1437 + "dataTag":"1",
  1438 + "data": {
  1439 + "state": 0
  1440 + }
  1441 +}
  1442 +```
  1443 +
  1444 +##### [sEvtBsKpOnlineMsg](#sevtbskponlinemsg)
  1445 +键盘在线返回此事件
  1446 +
1366 1447 ### 维护功能
1367 1448 #### 方法
1368 1449 ##### remoteKpPowerOff
... ... @@ -1487,7 +1568,7 @@
1487 1568 ```
1488 1569 ##### fEvtStartKpFWUpdate
1489 1570 - **主题**: <sapn class="yellowFill">/manage/\${baseSN}/recive</span>
1490   -- **功能描述**：返回基站启动升级状态
  1571 +- **功能描述**：返回键盘启动升级状态
1491 1572 - **参数说明**
1492 1573  
1493 1574 |参数名|类型|限制|非空|说明|
... ... @@ -1511,7 +1592,7 @@
1511 1592 ```
1512 1593 ##### fEvtKpUpdateProgress
1513 1594 - **主题**: <sapn class="yellowFill">/manage/\${baseSN}/recive</span>
1514   -- **功能描述**：返回基站升级进度
  1595 +- **功能描述**：返回键盘升级进度
1515 1596 - **参数说明**
1516 1597  
1517 1598 |参数名|类型|限制|非空|说明|
... ...