李外 / Protocol

Commit b0429b7074e75abb296b8f86602ea25d496ef915

Authored by 刘琴
1 parent e20a7371

1. 修改fEvtKpOnlineMsg返回为数组形式 

2. 增加内部指令stopBsUpdate、stopFontLibUpdate，返回状态增加 3 - 收到停止指令
Inline Side-by-side
Showing 1 changed file with 59 additions and 9 deletions
通讯协议-平台化-应用部分.md
  View file @b0429b7
@@ -32,7 +32,7 @@ SunVote 二次开å‘<br>通讯åè®® @@ -32,7 +32,7 @@ SunVote 二次开å‘<br>通讯åè®®
32 <br> 32 <br>
33 <br> 33 <br>
34 <div style="text-align: center;font-size: 30px;"> 34 <div style="text-align: center;font-size: 30px;">
35 -Ver 1.0.1 35 +Ver 1.0.2
36 </div> 36 </div>
37 <br> 37 <br>
38 <br> 38 <br>
@@ -48,7 +48,7 @@ Ver 1.0.1 @@ -48,7 +48,7 @@ Ver 1.0.1
48 <br> 48 <br>
49 49
50 <div style="text-align: center;font-size: 30px;"> 50 <div style="text-align: center;font-size: 30px;">
51 -二〇二五年三月 51 +二〇二五年四月
52 </div> 52 </div>
53 53
54 <br> 54 <br>
@@ -66,7 +66,8 @@ Ver 1.0.1 @@ -66,7 +66,8 @@ Ver 1.0.1
66 <br> 66 <br>
67 | 文档版本 | 日期 | 作者 | 版本说明 | 67 | 文档版本 | 日期 | 作者 | 版本说明 |
68 |---|---|---|---| 68 |---|---|---|---|
69 -|1.0.1| 2025å¹´3月24æ—¥|刘ç´|1. åˆå§‹ç‰ˆ<br>2. 修改fEvtKpOnlineMsg返回为数组形å¼| 69 +|1.0.1| 2025å¹´3月24æ—¥|刘ç´|1. 建立版本|
  70 +|1.0.2| 2025å¹´4月24æ—¥|刘ç´|1. 修改fEvtKpOnlineMsg返回为数组形å¼<br>2. 增加内部指令stopBsUpdateã€stopFontLibUpdate，返回状æ€å¢žåŠ  3 - 收到åœæ­¢æŒ‡ä»¤|
70 71
71 <br> 72 <br>
72 <br> 73 <br>
@@ -245,7 +246,9 @@ WebSocketæ–¹å¼åº”用与SDK或基站建立长连接åŽï¼Œé€šè¿‡WebSocket接å£å @@ -245,7 +246,9 @@ WebSocketæ–¹å¼åº”用与SDK或基站建立长连接åŽï¼Œé€šè¿‡WebSocket接å£å
245 ||基站断电å¤ä½|[resetBsPower](#resetbspower)|[sEvtStateCode](#sevtstatecode)<br>[sEvtBsConnectState](#sevtbsconnectstate)| 246 ||基站断电å¤ä½|[resetBsPower](#resetbspower)|[sEvtStateCode](#sevtstatecode)<br>[sEvtBsConnectState](#sevtbsconnectstate)|
246 ||<font color="red">基站自检(内)</font>|[startBsSelfCheck](#startbsselfcheck)|[sEvtStateCode](#sevtstatecode)<br>[fEvtBsSelfCheck](#fevtbsselfcheck)| 247 ||<font color="red">基站自检(内)</font>|[startBsSelfCheck](#startbsselfcheck)|[sEvtStateCode](#sevtstatecode)<br>[fEvtBsSelfCheck](#fevtbsselfcheck)|
247 |基站å‡çº§|<font color="red">å¼€å¯åŸºç«™å‡çº§(内)|[startBsUpdate](#startbsupdate)|[sEvtStateCode](#sevtstatecode)<br>[fEvtBsUpateState](#fevtbsupatestate)<br>[fEvtBsUpdateProgress](#fevtbsupdateprogress)| 248 |基站å‡çº§|<font color="red">å¼€å¯åŸºç«™å‡çº§(内)|[startBsUpdate](#startbsupdate)|[sEvtStateCode](#sevtstatecode)<br>[fEvtBsUpateState](#fevtbsupatestate)<br>[fEvtBsUpdateProgress](#fevtbsupdateprogress)|
248 -||<font color="red">下载字库(内)|[downloadFontLib](#downloadfontlib)|[sEvtStateCode](#sevtstatecode)<br>[fEvtBsFontLibState](#fevtbsfontlibstate)<br>[fEvtBsFontLibProgress](#fevtbsfontlibprogress)|</inner> 249 +||<font color="red">åœæ­¢åŸºç«™å‡çº§(内)|[stopBsUpdate](#stopbsupdate)|[sEvtStateCode](#sevtstatecode)<br>[fEvtBsUpateState](#fevtbsupatestate)|
  250 +||<font color="red">下载字库(内)|[downloadFontLib](#downloadfontlib)|[sEvtStateCode](#sevtstatecode)<br>[fEvtBsFontLibState](#fevtbsfontlibstate)<br>[fEvtBsFontLibProgress](#fevtbsfontlibprogress)|
  251 +||<font color="red">åœæ­¢åŸºç«™å­—库å‡çº§(内)|[stopFontLibUpdate](#stopfontlibupdate)|[sEvtStateCode](#sevtstatecode)<br>[fEvtBsFontLibState](#fevtbsfontlibstate)|</inner>
249 ### é”®ç›˜ç®¡ç† 252 ### 键盘管ç†
250 |功能归类|功能|API指令|指令事件| 253 |功能归类|功能|API指令|指令事件|
251 |---|---|---|---| 254 |---|---|---|---|
@@ -2496,7 +2499,7 @@ WebSocketæ–¹å¼åº”用与SDK或基站建立长连接åŽï¼Œé€šè¿‡WebSocket接å£å @@ -2496,7 +2499,7 @@ WebSocketæ–¹å¼åº”用与SDK或基站建立长连接åŽï¼Œé€šè¿‡WebSocket接å£å
2496 |+port|int||是|端å£ï¼Œé»˜è®¤1883| 2499 |+port|int||是|端å£ï¼Œé»˜è®¤1883|
2497 |+userName|string||å¦|连接æœåŠ¡å™¨çš„用户å，å¯ä¸è®¾ç½®| 2500 |+userName|string||å¦|连接æœåŠ¡å™¨çš„用户å，å¯ä¸è®¾ç½®|
2498 |+password|string||å¦|连接æœåŠ¡å™¨çš„密ç ï¼Œå¯ä¸è®¾ç½®| 2501 |+password|string||å¦|连接æœåŠ¡å™¨çš„密ç ï¼Œå¯ä¸è®¾ç½®|
2499 -|+interval|int|>=10|å¦|基站连接æœåŠ¡å™¨å¤±è´¥åŽé‡è¿žçš„间隔时长，å•ä½ç§’| 2502 +|+interval|int||å¦|基站连接æœåŠ¡å™¨å¤±è´¥åŽé‡è¿žçš„间隔时长，å•ä½ç§’|
2500 2503
2501 - **示例代ç ** 2504 - **示例代ç **
2502 ```json 2505 ```json
@@ -2777,7 +2780,7 @@ WebSocketæ–¹å¼åº”用与SDK或基站建立长连接åŽï¼Œé€šè¿‡WebSocket接å£å @@ -2777,7 +2780,7 @@ WebSocketæ–¹å¼åº”用与SDK或基站建立长连接åŽï¼Œé€šè¿‡WebSocket接å£å
2777 |baseSn|string||是|基站的出厂编ç | 2780 |baseSn|string||是|基站的出厂编ç |
2778 |data|object|-|是|ä¼ é€å‚数的对象| 2781 |data|object|-|是|ä¼ é€å‚数的对象|
2779 |+partition|int||是|存储区域<br> 1-备份区<font class="yellowFill"> 使用备份区固件的方法：打开基站盖å­ï¼ŒæŒ‰ä½SW1按钮，上电åŽæ¾å¼€æŒ‰é’®ï¼Œè¿™æ—¶åŸºç«™å›ºä»¶å°±ä¼šæ›´æ–°æˆå¤‡ä»½åŒºçš„固件</font><br>2-更新区，实时å‡çº§åŸºç«™å›ºä»¶| 2782 |+partition|int||是|存储区域<br> 1-备份区<font class="yellowFill"> 使用备份区固件的方法：打开基站盖å­ï¼ŒæŒ‰ä½SW1按钮，上电åŽæ¾å¼€æŒ‰é’®ï¼Œè¿™æ—¶åŸºç«™å›ºä»¶å°±ä¼šæ›´æ–°æˆå¤‡ä»½åŒºçš„固件</font><br>2-更新区，实时å‡çº§åŸºç«™å›ºä»¶|
2780 -|+url|string||是|å¾…å‡çº§çš„固件地å€ï¼Œå¯è®¿é—®çš„网络url| 2783 +|+url|string||是|å¾…å‡çº§çš„固件地å€ï¼Œå¯è®¿é—®çš„网络url<br>直连基站为本地的文件路径|
2781 |+version|string||是|å¾…å‡çº§çš„基站固件版本| 2784 |+version|string||是|å¾…å‡çº§çš„基站固件版本|
2782 |+crc|uint||是|固件CRC校验ç ï¼Œ10进制数字| 2785 |+crc|uint||是|固件CRC校验ç ï¼Œ10进制数字|
2783 <!-- |+time|string||是|时间，yyyyMMddHHmmss| 2786 <!-- |+time|string||是|时间，yyyyMMddHHmmss|
@@ -2797,9 +2800,33 @@ WebSocketæ–¹å¼åº”用与SDK或基站建立长连接åŽï¼Œé€šè¿‡WebSocket接å£å @@ -2797,9 +2800,33 @@ WebSocketæ–¹å¼åº”用与SDK或基站建立长连接åŽï¼Œé€šè¿‡WebSocket接å£å
2797 } 2800 }
2798 } 2801 }
2799 ``` 2802 ```
  2803 +
  2804 +##### stopBsUpdate
  2805 +- **主题**：<sapn class="yellowFill">/manage/{baseSN}/send</span>
  2806 +- **功能æè¿°**:åœæ­¢åŸºç«™å›ºä»¶å‡çº§
  2807 +- **å‚数说明**
  2808 +
  2809 +|å‚æ•°å|类型|é™åˆ¶|是å¦å¿…å¡«|说明|
  2810 +|---|---|---|---|---|
  2811 +|fun|string|-|是|指令å称|
  2812 +|dataTag|string|-|å¦|æ•°æ®åŒ…标识,å¯ä¸ºç©ºå­—符串|
  2813 +|baseSn|string||是|基站的出厂编ç |
  2814 +|data|object|-|是|ä¼ é€å‚数的对象|
  2815 +<!-- |+time|string|æ•°å­—|是|时间，yyyyMMddHHmmss|
  2816 +|+verCode|string||是|内部主题校验ç ï¼Œæ—¶é—´+固定key加密| -->
  2817 +
  2818 +- **示例代ç **
  2819 +```json
  2820 +{
  2821 + "fun":"stopBsUpdate",
  2822 + "dataTag":"1",
  2823 + "baseSn":"2024061101"
  2824 +}
  2825 +```
  2826 +
2800 ##### downloadFontLib 2827 ##### downloadFontLib
2801 - **主题**：<sapn class="yellowFill">/manage/{baseSN}/send</span> 2828 - **主题**：<sapn class="yellowFill">/manage/{baseSN}/send</span>
2802 -- **功能æè¿°**:下载更新基站字库文件 2829 +- **功能æè¿°**: 下载更新基站字库文件
2803 - **å‚数说明** 2830 - **å‚数说明**
2804 2831
2805 |å‚æ•°å|类型|é™åˆ¶|是å¦å¿…å¡«|说明| 2832 |å‚æ•°å|类型|é™åˆ¶|是å¦å¿…å¡«|说明|
@@ -2829,6 +2856,29 @@ WebSocketæ–¹å¼åº”用与SDK或基站建立长连接åŽï¼Œé€šè¿‡WebSocket接å£å @@ -2829,6 +2856,29 @@ WebSocketæ–¹å¼åº”用与SDK或基站建立长连接åŽï¼Œé€šè¿‡WebSocket接å£å
2829 } 2856 }
2830 } 2857 }
2831 ``` 2858 ```
  2859 +##### stopFontLibUpdate
  2860 +- **主题**：<sapn class="yellowFill">/manage/{baseSN}/send</span>
  2861 +- **功能æè¿°**: åœæ­¢åŸºç«™å­—库å‡çº§
  2862 +- **å‚数说明**
  2863 +
  2864 +|å‚æ•°å|类型|é™åˆ¶|是å¦å¿…å¡«|说明|
  2865 +|---|---|---|---|---|
  2866 +|fun|string|-|是|指令å称|
  2867 +|dataTag|string|-|å¦|æ•°æ®åŒ…标识,å¯ä¸ºç©ºå­—符串|
  2868 +|baseSn|string||是|基站的出厂编ç |
  2869 +|data|object|-|是|ä¼ é€å‚数的对象|
  2870 +<!-- |+time|string|æ•°å­—|是|时间，yyyyMMddHHmmss|
  2871 +|+verCode|string||是|内部主题校验ç ï¼Œæ—¶é—´+固定key加密| -->
  2872 +
  2873 +- **示例代ç **
  2874 +```json
  2875 +{
  2876 + "fun":"stopFontLibUpdate",
  2877 + "dataTag":"1",
  2878 + "baseSn":"2024061101"
  2879 +}
  2880 +```
  2881 +
2832 2882
2833 #### 事件 2883 #### 事件
2834 ##### [sEvtStateCode](#sevtstatecode) 2884 ##### [sEvtStateCode](#sevtstatecode)
@@ -2846,7 +2896,7 @@ WebSocketæ–¹å¼åº”用与SDK或基站建立长连接åŽï¼Œé€šè¿‡WebSocket接å£å @@ -2846,7 +2896,7 @@ WebSocketæ–¹å¼åº”用与SDK或基站建立长连接åŽï¼Œé€šè¿‡WebSocket接å£å
2846 |dataTag|string|-|å¦|æ•°æ®åŒ…标识,å¯ä¸ºç©ºå­—符串| 2896 |dataTag|string|-|å¦|æ•°æ®åŒ…标识,å¯ä¸ºç©ºå­—符串|
2847 |baseSn|string||是|基站的出厂编ç | 2897 |baseSn|string||是|基站的出厂编ç |
2848 |data|object|-|是|ä¼ é€å‚数的对象| 2898 |data|object|-|是|ä¼ é€å‚数的对象|
2849 -|+state|int||是|å¯åŠ¨å‡çº§çŠ¶æ€<br>0 - 准备å‡çº§<br>1 - å‡çº§æˆåŠŸ<br>2 - å‡çº§å¤±è´¥ 2899 +|+state|int||是|å¯åŠ¨å‡çº§çŠ¶æ€<br>0 - 准备å‡çº§<br>1 - å‡çº§æˆåŠŸ<br>2 - å‡çº§å¤±è´¥<br> 3 - å·²åœæ­¢(接收到åœæ­¢æŒ‡ä»¤)|
2850 |+msg|string||å¦|返回的失败原因 2900 |+msg|string||å¦|返回的失败原因
2851 2901
2852 - **示例代ç ** 2902 - **示例代ç **
@@ -2898,7 +2948,7 @@ WebSocketæ–¹å¼åº”用与SDK或基站建立长连接åŽï¼Œé€šè¿‡WebSocket接å£å @@ -2898,7 +2948,7 @@ WebSocketæ–¹å¼åº”用与SDK或基站建立长连接åŽï¼Œé€šè¿‡WebSocket接å£å
2898 |dataTag|string|-|å¦|æ•°æ®åŒ…标识,å¯ä¸ºç©ºå­—符串| 2948 |dataTag|string|-|å¦|æ•°æ®åŒ…标识,å¯ä¸ºç©ºå­—符串|
2899 |baseSn|string||是|基站的出厂编ç | 2949 |baseSn|string||是|基站的出厂编ç |
2900 |data|object|-|是|ä¼ é€å‚数的对象| 2950 |data|object|-|是|ä¼ é€å‚数的对象|
2901 -|+state|int||是|å¯åŠ¨å‡çº§çŠ¶æ€<br>0 - 准备下载<br>1 - 下载完æˆ<br>2 - 下载失败 2951 +|+state|int||是|å¯åŠ¨å‡çº§çŠ¶æ€<br>0 - 准备下载<br>1 - 下载完æˆ<br>2 - 下载失败<br> 3 - å·²åœæ­¢(接收到åœæ­¢æŒ‡ä»¤)|
2902 |+msg|string||å¦|返回的失败原因 2952 |+msg|string||å¦|返回的失败原因
2903 2953
2904 - **示例代ç ** 2954 - **示例代ç **