diff --git a/通讯协议-B200W-MQTT协议[内部].md b/通讯协议-B200W-MQTT协议[内部].md index 25f20a5..7fa987a 100644 --- a/通讯协议-B200W-MQTT协议[内部].md +++ b/通讯协议-B200W-MQTT协议[内部].md @@ -89,8 +89,10 @@ |---|---|---|---| |识别设置 - 识别模式(内)|获取键盘识别模式(内)|[getKpIdentityMode](#getkpidentitymode)|[fEvtKpIdentityMode](#fevtkpidentitymode)| ||设置键盘识别模式(内)|[setKpIdentityMode](#setkpidentitymode)|[fEvtKpIdentityMode](#fevtkpidentitymode)| -|交互设置 - 用户内置状态语|设置用户内置状态语|[setKpUserStbMsg](#setkpuserstbmsg)|[fEvtKpUserStbMsg]()| -|交互设置 - 用户实时提示信息|实时设置提示反馈信息|[rtSetKpUserPrompt](#rtsetkpuserprompt)|[fEvtSetKpUserPrompt]()| +|交互设置 - 用户内置状态语|设置用户内置状态语|[setKpUserStbMsg](#setkpuserstbmsg)|[fEvtKpUserStbMsg](#fevtkpuserstbmsg)| +|交互设置 - 用户实时提示信息|实时设置提示反馈信息|[rtSetKpUserPrompt](#rtsetkpuserprompt)|[fEvtSetKpUserPrompt](#fevtsetkpuserprompt)| +|在线状态获取|开启扫描在线键盘|[startGetKpOnline](#startgetkponline)|[fEvtStartGetKpOnline](#fevtstartgetkponline)
[sEvtBsKpOnlineMsg](#sevtbskponlinemsg)| +||停止扫描在线键盘|[stopGetKpOnline](#stopgetkponline)|[fEvtStopGetKpOnline](#fevtstopgetkponline)| |维护功能 - 遥控功能|遥控键盘关机|[remoteKpPowerOff](#remotekppoweroff)|[fEvtRemoteKpPowerOff](#fevtremotekppoweroff)| ||遥控键盘休眠|[remoteKpSleep](#remotekpsleep)|[fEvtRemoteKpSleep](#fevtremotekpsleep)| |维护功能 - 遥控功能|启动键盘无线升级(内)|[startKpFWUpdate](#startkpfwupdate)|[fEvtStartKpFWUpdate](#fevtstartkpfwupdate)
[fEvtKpUpdateProgress](#fevtkpupdateprogress)
[sEvtBsKpOnlineMsg](#sevtbskponlinemsg)| @@ -1363,6 +1365,85 @@ ] } ``` +### 在线状态 +#### 方法 +##### startGetKpOnline +- **主题**:/client/\${baseSN}/send +- **功能描述**:开始获取键盘在线信息,键盘在线返回键盘信息 [sEvtBsKpOnlineMsg](#sevtbskponlinemsg) +- **参数说明** + +|参数名|类型|限制|是否必填|说明| +|---|---|---|---|---| +|fun|string|-|是|指令名称| +|dataTag|string|-|否|数据包标识,可为空字符串| +```json +{ + "fun": "startGetKpOnline", + "dataTag":"1", +} +``` + +##### stopGetKpOnline +- **主题**:/client/\${baseSN}/send +- **功能描述**:停止获取键盘在线信息 +- **参数说明** + +|参数名|类型|限制|是否必填|说明| +|---|---|---|---|---| +|fun|string|-|是|指令名称| +|dataTag|string|-|否|数据包标识,可为空字符串| +```json +{ + "fun": "stopGetKpOnline", + "dataTag":"1", +} +``` +#### 事件 +##### fEvtStartGetKpOnline +- **主题**:/basestation/\${baseSN}/recive +- **功能描述**:返回启动扫描在线键盘状态 +- **参数说明** + +|参数名|类型|限制|非空|说明| +|---|---|---|---|---| +|fun|string|-|是|指令名称| +|dataTag|string|-|否|数据包标识,可为空字符串| +|data|object|-|是|传送参数的对象| +|+state|int||是|启动状态
0 - 成功
1 - 失败| +```json +{ + "fun": "fEvtStartGetKpOnline", + "dataTag":"1", + "data": { + "state": 0 + } +} +``` + +##### fEvtStopGetKpOnline +- **主题**:/basestation/\${baseSN}/recive +- **功能描述**:返回停止扫描在线键盘状态 +- **参数说明** + +|参数名|类型|限制|非空|说明| +|---|---|---|---|---| +|fun|string|-|是|指令名称| +|dataTag|string|-|否|数据包标识,可为空字符串| +|data|object|-|是|传送参数的对象| +|+state|int||是|启动状态
0 - 成功
1 - 失败| +```json +{ + "fun": "fEvtStopGetKpOnline", + "dataTag":"1", + "data": { + "state": 0 + } +} +``` + +##### [sEvtBsKpOnlineMsg](#sevtbskponlinemsg) +键盘在线返回此事件 + ### 维护功能 #### 方法 ##### remoteKpPowerOff @@ -1487,7 +1568,7 @@ ``` ##### fEvtStartKpFWUpdate - **主题**: /manage/\${baseSN}/recive -- **功能描述**:返回基站启动升级状态 +- **功能描述**:返回键盘启动升级状态 - **参数说明** |参数名|类型|限制|非空|说明| @@ -1511,7 +1592,7 @@ ``` ##### fEvtKpUpdateProgress - **主题**: /manage/\${baseSN}/recive -- **功能描述**:返回基站升级进度 +- **功能描述**:返回键盘升级进度 - **参数说明** |参数名|类型|限制|非空|说明|