Commit 280769e53f141496e24041d2b94a012c6cd815d4
1 parent
5b727575
修改实时绑定信息的事件返回,拆分为指令状态和执行结果两个
Showing
1 changed file
with
32 additions
and
20 deletions
通讯协议-B200W-MQTT协议[内部].md
@@ -99,8 +99,8 @@ | @@ -99,8 +99,8 @@ | ||
99 | ### 绑定 | 99 | ### 绑定 |
100 | |功能归类|功能|API指令|指令事件| | 100 | |功能归类|功能|API指令|指令事件| |
101 | |---|---|---|---| | 101 | |---|---|---|---| |
102 | -|无线绑定|设置绑定信息到键盘|[rtSetKpBindingInfo](#rtsetkpbindinginfo)|[fEvtSetKpBindingInfo](#fevtsetkpbindinginfo)| | ||
103 | -||清除键盘绑定信息|[clearKpBindingInfo](#clearkpbindinginfo)|[fEvtClearKpBindingInfo](#fevtclearkpbindinginfo)| | 102 | +|无线绑定|设置绑定信息到键盘|[rtSetKpBindingInfo](#rtsetkpbindinginfo)|[fEvtSetKpBindingInfo](#fevtsetkpbindinginfo)<br>[fEvtKpBindingInfo](#fevtkpbindinginfo)| |
103 | +||清除键盘绑定信息|[clearKpBindingInfo](#clearkpbindinginfo)|[fEvtClearKpBindingInfo](#fevtclearkpbindinginfo)<br>[fEvtKpBindingInfo](#fevtkpbindinginfo)| | ||
104 | ### 签到 | 104 | ### 签到 |
105 | |功能归类|功能|API指令|指令事件| | 105 | |功能归类|功能|API指令|指令事件| |
106 | |---|---|---|---| | 106 | |---|---|---|---| |
@@ -1628,7 +1628,7 @@ | @@ -1628,7 +1628,7 @@ | ||
1628 | |dataTag|string|-|否|数据包标识,可为空字符串| | 1628 | |dataTag|string|-|否|数据包标识,可为空字符串| |
1629 | |data|array|-|是|传送参数的对象数组,不可为空| | 1629 | |data|array|-|是|传送参数的对象数组,不可为空| |
1630 | |++keySN|string||是|需要设置绑定信息的键盘SN| | 1630 | |++keySN|string||是|需要设置绑定信息的键盘SN| |
1631 | -|++info|string||是|设置的绑定信息,一般为学生姓名| | 1631 | +|++info|string||是|设置的绑定信息,一般为学生姓名<br>最长48个字符,显示在键盘左上角| |
1632 | ```json | 1632 | ```json |
1633 | { | 1633 | { |
1634 | "fun": "rtSetKpBindingInfo", | 1634 | "fun": "rtSetKpBindingInfo", |
@@ -1670,7 +1670,27 @@ | @@ -1670,7 +1670,27 @@ | ||
1670 | #### 事件 | 1670 | #### 事件 |
1671 | ##### fEvtSetKpBindingInfo | 1671 | ##### fEvtSetKpBindingInfo |
1672 | - **主题**:/basestation/\${baseSN}/receive | 1672 | - **主题**:/basestation/\${baseSN}/receive |
1673 | -- **功能描述**:返回实时设置绑定信息的状态是否成功 | 1673 | +- **功能描述**:返回实时设置绑定信息的指令接收状态 |
1674 | +- **参数说明** | ||
1675 | + | ||
1676 | +|参数名|类型|限制|非空|说明| | ||
1677 | +|---|---|---|---|---| | ||
1678 | +|fun|string|-|是|指令名称| | ||
1679 | +|dataTag|string|-|否|数据包标识,可为空字符串| | ||
1680 | +|data|object|-|否|传送参数的对象| | ||
1681 | +|+state|string||是|设置的绑定信息是否成功<br>0 - 成功<br>1 - 失败| | ||
1682 | +```json | ||
1683 | +{ | ||
1684 | + "fun": "fEvtSetKpBindingInfo", | ||
1685 | + "dataTag":"1", | ||
1686 | + "data": { | ||
1687 | + "state": "0" | ||
1688 | + } | ||
1689 | +} | ||
1690 | +``` | ||
1691 | +##### fEvtKpBindingInfo | ||
1692 | +- **主题**:/basestation/\${baseSN}/receive | ||
1693 | +- **功能描述**:返回键盘实时设置绑定信息的状态是否成功 | ||
1674 | - **参数说明** | 1694 | - **参数说明** |
1675 | 1695 | ||
1676 | |参数名|类型|限制|非空|说明| | 1696 | |参数名|类型|限制|非空|说明| |
@@ -1682,7 +1702,7 @@ | @@ -1682,7 +1702,7 @@ | ||
1682 | |++state|string||是|设置的绑定信息是否成功<br>0 - 成功<br>1 - 失败| | 1702 | |++state|string||是|设置的绑定信息是否成功<br>0 - 成功<br>1 - 失败| |
1683 | ```json | 1703 | ```json |
1684 | { | 1704 | { |
1685 | - "fun": "fEvtSetKpBindingInfo", | 1705 | + "fun": "fEvtKpBindingInfo", |
1686 | "dataTag":"1", | 1706 | "dataTag":"1", |
1687 | "data": [ | 1707 | "data": [ |
1688 | { | 1708 | { |
@@ -1698,30 +1718,22 @@ | @@ -1698,30 +1718,22 @@ | ||
1698 | ``` | 1718 | ``` |
1699 | ##### fEvtClearKpBindingInfo | 1719 | ##### fEvtClearKpBindingInfo |
1700 | - **主题**:/basestation/\${baseSN}/receive | 1720 | - **主题**:/basestation/\${baseSN}/receive |
1701 | -- **功能描述**:返回实时设置绑定信息的状态是否成功 | 1721 | +- **功能描述**:返回清空绑定信息的指令状态是否成功 |
1702 | - **参数说明** | 1722 | - **参数说明** |
1703 | 1723 | ||
1704 | |参数名|类型|限制|非空|说明| | 1724 | |参数名|类型|限制|非空|说明| |
1705 | |---|---|---|---|---| | 1725 | |---|---|---|---|---| |
1706 | |fun|string|-|是|指令名称| | 1726 | |fun|string|-|是|指令名称| |
1707 | |dataTag|string|-|否|数据包标识,可为空字符串| | 1727 | |dataTag|string|-|否|数据包标识,可为空字符串| |
1708 | -|data|array|-|是|传送参数的对象数组| | ||
1709 | -|++keySN|string||是|需要设置绑定信息的键盘SN| | ||
1710 | -|++state|string||是|清空绑定信息是否成功<br>0 - 成功<br>1 - 失败| | 1728 | +|data|object|-|否|传送参数的对象| |
1729 | +|+state|string||是|设置的绑定信息是否成功<br>0 - 成功<br>1 - 失败| | ||
1711 | ```json | 1730 | ```json |
1712 | { | 1731 | { |
1713 | - "fun": "fEvtClearKpBindingInfo", | 1732 | + "fun": "fEvtSetKpBindingInfo", |
1714 | "dataTag":"1", | 1733 | "dataTag":"1", |
1715 | - "data": [ | ||
1716 | - { | ||
1717 | - "keySn": "1479824643", | ||
1718 | - "state": "0" | ||
1719 | - }, | ||
1720 | - { | ||
1721 | - "keySn": "1479824644", | ||
1722 | - "state": "1" | ||
1723 | - } | ||
1724 | - ] | 1734 | + "data": { |
1735 | + "state": "0" | ||
1736 | + } | ||
1725 | } | 1737 | } |
1726 | ``` | 1738 | ``` |
1727 | ## 签到 | 1739 | ## 签到 |