Commit 8317eb3b7e382b7ca5573e3367675453dcb7db0c
1 parent
a7145c62
增加指令拆分说明,约定单条指令长度不超过2K
Showing
2 changed files
with
11 additions
and
4 deletions
通讯协议-B200W-MQTT协议[内部].md
| @@ -55,6 +55,7 @@ | @@ -55,6 +55,7 @@ | ||
| 55 | ## 数据格式约定 | 55 | ## 数据格式约定 |
| 56 | - 数据格式统一为**Json**格式,MQTT发送接收消息编码统一为**UTF-8** | 56 | - 数据格式统一为**Json**格式,MQTT发送接收消息编码统一为**UTF-8** |
| 57 | - Json通用格式如下: | 57 | - Json通用格式如下: |
| 58 | + | ||
| 58 | ```json | 59 | ```json |
| 59 | { | 60 | { |
| 60 | "fun":"xxx", | 61 | "fun":"xxx", |
| @@ -64,6 +65,9 @@ | @@ -64,6 +65,9 @@ | ||
| 64 | } | 65 | } |
| 65 | } | 66 | } |
| 66 | ``` | 67 | ``` |
| 68 | + | ||
| 69 | +<font color="red">注意:基站接收指令数据单次不超过2K长度,在指定键盘发送指令时,如果指令长度超出限制,建议将指令进行拆分,分次发送,如果是所有键盘执行的指令,可将keySns设为空数组不使用指定键盘的模式</font> | ||
| 70 | + | ||
| 67 | |参数 |说明 |约束| | 71 | |参数 |说明 |约束| |
| 68 | |---|---|---| | 72 | |---|---|---| |
| 69 | |fun| 指令或事件名称|| | 73 | |fun| 指令或事件名称|| |
| @@ -2331,7 +2335,7 @@ | @@ -2331,7 +2335,7 @@ | ||
| 2331 | ``` | 2335 | ``` |
| 2332 | ##### rtKpAllowEdited | 2336 | ##### rtKpAllowEdited |
| 2333 | - **主题**:/client/\${baseSN}/send | 2337 | - **主题**:/client/\${baseSN}/send |
| 2334 | -- **功能描述**:键盘键盘后,允许键盘修改答案 | 2338 | +- **功能描述**:键盘提交后,允许键盘修改答案 |
| 2335 | - **参数说明** | 2339 | - **参数说明** |
| 2336 | 2340 | ||
| 2337 | |参数名|类型|限制|是否必填|说明| | 2341 | |参数名|类型|限制|是否必填|说明| |
| @@ -2392,7 +2396,7 @@ | @@ -2392,7 +2396,7 @@ | ||
| 2392 | |---|---|---|---|---| | 2396 | |---|---|---|---|---| |
| 2393 | |fun|string|-|是|指令名称| | 2397 | |fun|string|-|是|指令名称| |
| 2394 | |dataTag|string|-|否|数据包标识,可为空字符串| | 2398 | |dataTag|string|-|否|数据包标识,可为空字符串| |
| 2395 | -|data|object|-|是|传送参数的对象数组| | 2399 | +|data|array|-|是|传送参数的对象数组| |
| 2396 | |++keySn|string||是|键盘SN| | 2400 | |++keySn|string||是|键盘SN| |
| 2397 | |++keyValue|string||是|0 - 未提交(修改键盘运行提交时上报)<br>1 - 已交卷| | 2401 | |++keyValue|string||是|0 - 未提交(修改键盘运行提交时上报)<br>1 - 已交卷| |
| 2398 | |++keyTime|double||是|提交时间,从启动开始计算,单位秒| | 2402 | |++keyTime|double||是|提交时间,从启动开始计算,单位秒| |
通讯协议-B200W-MQTT协议[外].md
| @@ -58,12 +58,15 @@ | @@ -58,12 +58,15 @@ | ||
| 58 | } | 58 | } |
| 59 | } | 59 | } |
| 60 | ``` | 60 | ``` |
| 61 | + | ||
| 61 | |参数 |说明 |约束| | 62 | |参数 |说明 |约束| |
| 62 | |---|---|---| | 63 | |---|---|---| |
| 63 | |fun| 指令或事件名称|| | 64 | |fun| 指令或事件名称|| |
| 64 | |dataTag| 数据标签,用于对应收发数据|长度不超过4,可为0-9a-zA-Z的组合| | 65 | |dataTag| 数据标签,用于对应收发数据|长度不超过4,可为0-9a-zA-Z的组合| |
| 65 | |data| 数据内容|对象或者数组,可为空| | 66 | |data| 数据内容|对象或者数组,可为空| |
| 66 | 67 | ||
| 68 | +<font color="red">注意:基站接收指令数据单次不超过2K长度,在指定键盘发送指令时,如果指令长度超出限制,建议将指令进行拆分,分次发送,如果是所有键盘执行的指令,可将keySns设为空数组不使用指定键盘的模式</font> | ||
| 69 | + | ||
| 67 | 70 | ||
| 68 | ## 功能速查一览表 | 71 | ## 功能速查一览表 |
| 69 | ### 基站管理 | 72 | ### 基站管理 |
| @@ -1725,7 +1728,7 @@ | @@ -1725,7 +1728,7 @@ | ||
| 1725 | ``` | 1728 | ``` |
| 1726 | ##### rtKpAllowEdited | 1729 | ##### rtKpAllowEdited |
| 1727 | - **主题**:/client/\${baseSN}/send | 1730 | - **主题**:/client/\${baseSN}/send |
| 1728 | -- **功能描述**:键盘键盘后,允许键盘修改答案 | 1731 | +- **功能描述**:键盘提交后,允许键盘修改答案 |
| 1729 | - **参数说明** | 1732 | - **参数说明** |
| 1730 | 1733 | ||
| 1731 | |参数名|类型|限制|是否必填|说明| | 1734 | |参数名|类型|限制|是否必填|说明| |
| @@ -1786,7 +1789,7 @@ | @@ -1786,7 +1789,7 @@ | ||
| 1786 | |---|---|---|---|---| | 1789 | |---|---|---|---|---| |
| 1787 | |fun|string|-|是|指令名称| | 1790 | |fun|string|-|是|指令名称| |
| 1788 | |dataTag|string|-|否|数据包标识,可为空字符串| | 1791 | |dataTag|string|-|否|数据包标识,可为空字符串| |
| 1789 | -|data|object|-|是|传送参数的对象数组| | 1792 | +|data|array|-|是|传送参数的对象数组| |
| 1790 | |++keySn|string||是|键盘SN| | 1793 | |++keySn|string||是|键盘SN| |
| 1791 | |++keyValue|string||是|0 - 未提交(修改键盘运行提交时上报)<br>1 - 已交卷| | 1794 | |++keyValue|string||是|0 - 未提交(修改键盘运行提交时上报)<br>1 - 已交卷| |
| 1792 | |++keyTime|double||是|提交时间,从启动开始计算,单位秒| | 1795 | |++keyTime|double||是|提交时间,从启动开始计算,单位秒| |