Commit e6dd0a8da0458bca1e5ebd8d343d64563cc0f79c
1 parent
6c9391e1
1.SDK应用部分， 增加获取SDK版本接口。
Showing
2 changed files
with
134 additions
and
143 deletions
通讯协议-SDK应用部分.md
| ... | ... | @@ -8,7 +8,7 @@ WSCmdApp协议接口说明 |
| 8 | 8 | |
| 9 | 9 | |
| 10 | 10 | <div style="text-align: center;font-size: 30px;"> |
| 11 | -Ver5.1.8 | |
| 11 | +Ver5.1.9 | |
| 12 | 12 | </div> |
| 13 | 13 | <br> |
| 14 | 14 | <br> |
| ... | ... | @@ -50,6 +50,7 @@ Ver5.1.8 |
| 50 | 50 | |5.1.6| 2024年02月19日|陈定敏|1. 增加keypadRemoteControl接口<br>2. 增加举手功能接口| |
| 51 | 51 | |5.1.7| 2024年04月22日|陈定敏|1. 增加后台签到接口<br>2. 增加键盘最终提交状态接口| |
| 52 | 52 | |5.1.8| 2024年07月01日|陈定敏|1. 投票反馈数据增加电池状态| |
| 53 | +|5.1.9| 2024年07月19日|陈定敏|1. 增加获取SDK版本接口| | |
| 53 | 54 | |
| 54 | 55 | <br> |
| 55 | 56 | |
| ... | ... | @@ -5308,7 +5309,24 @@ fun: "keypadHandUp" |
| 5308 | 5309 | | B200-2.4G+S7 | 支持 | | |
| 5309 | 5310 | |
| 5310 | 5311 | #### 遥控键盘关机 |
| 5312 | +##### 遥控所有键盘关机 | |
| 5313 | +写 | |
| 5314 | +发送： | |
| 5315 | +fun: "remoteKeyShutdown" //遥控键盘关机 | |
| 5316 | +params：{}// | |
| 5317 | +指令样例： | |
| 5318 | + | |
| 5319 | +```json | |
| 5320 | +{ | |
| 5321 | + "fun": "remoteKeyShutdown", | |
| 5322 | + "baseId": 1, | |
| 5323 | + "baseSn":"2023031402", | |
| 5324 | + "params": [], | |
| 5325 | + "packetTag": "1" | |
| 5326 | +} | |
| 5327 | +``` | |
| 5311 | 5328 | |
| 5329 | +##### 遥控指定键盘关机 | |
| 5312 | 5330 | 写 |
| 5313 | 5331 | 发送： |
| 5314 | 5332 | fun: "remoteKeyShutdown" //遥控键盘关机 |
| ... | ... | @@ -5781,172 +5799,91 @@ params:{ |
| 5781 | 5799 | ``` |
| 5782 | 5800 | |
| 5783 | 5801 | 接收： |
| 5784 | -fun: "keypadOnLine" //键盘在线状态 | |
| 5802 | +fun: "answerKeyPadScan" //键盘在线状态 | |
| 5785 | 5803 | infos:{} //数组对象 |
| 5786 | 5804 | |
| 5787 | 5805 | | **基站+键盘** | **支持** | **备注** | |
| 5788 | 5806 | | --- | --- | --- | |
| 5789 | 5807 | |baseId|基站id|keySn键盘所在基站id| |
| 5790 | 5808 | |keySn|键盘Sn|| |
| 5791 | -|keyVer|键盘版本|| | |
| 5792 | -|Volt|键盘电量|T2百分比值，S6无效| | |
| 5793 | 5809 | |
| 5794 | 5810 | |
| 5795 | -指令样例： | |
| 5796 | 5811 | |
| 5797 | -```json | |
| 5798 | -{ | |
| 5799 | - "fun": "keypadOnLine", | |
| 5800 | - "baseId": 0, | |
| 5801 | - "infos": [{ | |
| 5802 | - "baseId": "1", | |
| 5803 | - "keySn": "1837454011", | |
| 5804 | - "ver": "1.0.6", | |
| 5805 | - "hModel": "67", | |
| 5806 | - "Volt": "100" | |
| 5807 | - }, | |
| 5808 | - { | |
| 5809 | - "baseId": "1", | |
| 5810 | - "keySn": "1837454012", | |
| 5811 | - "ver": "1.0.6", | |
| 5812 | - "hModel": "67", | |
| 5813 | - "Volt": "30" | |
| 5814 | - } | |
| 5815 | - ], | |
| 5816 | - "packetTag": "1" | |
| 5817 | -} | |
| 5818 | -``` | |
| 5819 | - | |
| 5820 | -支持设备说明 | |
| 5821 | -| **基站+键盘** | **支持** | **备注** | | |
| 5822 | -| --- | --- | --- | | |
| 5823 | -| B100-2.4G+S6 | 支持 |键盘电量：无效| | |
| 5824 | -| B200-2.4G+S6 | 支持 |键盘电量：无效| | |
| 5825 | -| B200-5.8G+T2 | 支持 |键盘电量：百分比值| | |
| 5826 | - | |
| 5827 | -### 在线键盘扫描 | |
| 5828 | - | |
| 5829 | -#### 开始扫描 | |
| 5830 | - | |
| 5831 | -发送： | |
| 5832 | - | |
| 5833 | -fun: "startKeyPadScan" // | |
| 5834 | -params：{} | |
| 5835 | - | |
| 5836 | -|**Json字段**|**字段含义**|**赋值及含义**| | |
| 5837 | -|---|---|---| | |
| 5812 | +指令样例： | |
| 5838 | 5813 | |
| 5814 | +扫描到的键盘信息指令[这个指令会有多条]： | |
| 5839 | 5815 | |
| 5840 | -指令样例： | |
| 5841 | 5816 | ```json |
| 5842 | 5817 | { |
| 5843 | - "fun": "startKeyPadScan", | |
| 5844 | - "baseId": 0, | |
| 5845 | - "baseSn":"2023031402", | |
| 5846 | - "params": {}, | |
| 5847 | - "packetTag": "1" | |
| 5818 | + "baseId": 1, | |
| 5819 | + "fun": "answerKeyPadScan", | |
| 5820 | + "infos": { | |
| 5821 | + "keySn": "0112375918" | |
| 5822 | + }, | |
| 5823 | + "packetTag": "0" | |
| 5848 | 5824 | } |
| 5849 | 5825 | ``` |
| 5850 | 5826 | |
| 5851 | -接收： | |
| 5852 | - | |
| 5853 | -fun: "startKeyPadScan" // | |
| 5854 | -baseId: "1"//接收到指令的基站ID | |
| 5855 | -infos:{"state":"OK"}//返回状态,成功为OK | |
| 5856 | - | |
| 5857 | -指令样例： | |
| 5827 | +接收扫描停止指令： | |
| 5858 | 5828 | |
| 5859 | 5829 | ```json |
| 5860 | 5830 | { |
| 5861 | - "fun": "startKeyPadScan", | |
| 5862 | 5831 | "baseId": 1, |
| 5863 | - "baseSn":"2023031402", | |
| 5832 | + "fun": "stopgetKeypadOnLine", | |
| 5864 | 5833 | "infos": { |
| 5865 | 5834 | "state": "OK" |
| 5866 | 5835 | }, |
| 5867 | - "packetTag": "1" | |
| 5836 | + "packetTag": "18" | |
| 5868 | 5837 | } |
| 5869 | 5838 | ``` |
| 5870 | 5839 | |
| 5871 | -#### 接收作答 | |
| 5872 | - | |
| 5873 | -接收： | |
| 5874 | -fun: " answerKeyPadScan" | |
| 5875 | -baseId: 1//基站ID | |
| 5876 | -infos:{ "hModel": "67","keySn":"1479824643","ver":"1.0.0","keyBattery":"2.5"}//返回键盘反馈模式参数值 | |
| 5877 | - | |
| 5878 | -| **Json字段** | **字段含义** | **赋值及含义** | | |
| 5840 | +支持设备说明 | |
| 5841 | +| **基站+键盘** | **支持** | **备注** | | |
| 5879 | 5842 | | --- | --- | --- | |
| 5880 | -|hModel|键盘型号|67： S6-2.4G| | |
| 5881 | -|keySn|键盘Sn|| | |
| 5882 | -|keyVer|键盘版本|| | |
| 5883 | -|keyBattery|键盘电量|T2百分比值，S6电压值| | |
| 5843 | +| B100-2.4G+S6 | 支持 |键盘电量：无效| | |
| 5844 | +| B200-2.4G+S6 | 支持 |键盘电量：无效| | |
| 5845 | +| B200-5.8G+T2 | 支持 |键盘电量：无效| | |
| 5884 | 5846 | |
| 5885 | -指令样例： | |
| 5886 | 5847 | |
| 5887 | -```json | |
| 5888 | -{ | |
| 5889 | - "fun": "answerKeyPadScan", | |
| 5890 | - "baseId": 1, | |
| 5891 | - "baseSn":"2023031402", | |
| 5892 | - "infos": { | |
| 5893 | - "hModel": "67", | |
| 5894 | - "keySn": "1479824643", | |
| 5895 | - "ver": "1.0.0", | |
| 5896 | - "keyBattery": "2.5" | |
| 5897 | - }, | |
| 5898 | - "packetTag": "0" | |
| 5899 | -} | |
| 5900 | -``` | |
| 5901 | 5848 | |
| 5902 | -#### 停止键盘扫描 | |
| 5903 | 5849 | |
| 5850 | +## 系统参数 | |
| 5851 | +### 获取 WSCmdApp 版本 | |
| 5852 | + 获取 WSCmdApp 当前版本 | |
| 5904 | 5853 | 发送： |
| 5854 | +fun: "getSdkVer" // | |
| 5855 | +params:{}//无该值 | |
| 5856 | +packetTag:"1"// | |
| 5905 | 5857 | |
| 5906 | -fun: "stopKeyPadScan" //停止扫描 | |
| 5907 | -params:{} //默认空 | |
| 5908 | 5858 | |
| 5909 | 5859 | 指令样例： |
| 5910 | 5860 | |
| 5911 | 5861 | ```json |
| 5912 | 5862 | { |
| 5913 | - "fun": "stopKeyPadScan", | |
| 5914 | - "baseId": 0, | |
| 5915 | - "baseSn":"2023031402", | |
| 5863 | + "fun": "getSdkVer", | |
| 5916 | 5864 | "packetTag": "1" |
| 5917 | 5865 | } |
| 5918 | 5866 | ``` |
| 5919 | 5867 | |
| 5920 | -接收： | |
| 5868 | +接收: | |
| 5869 | + | |
| 5870 | +fun: "getSdkVer" // | |
| 5871 | +infos:{ | |
| 5872 | + "value": "5.1.0.01" | |
| 5873 | +} | |
| 5921 | 5874 | |
| 5922 | -fun: "stopKeyPadScan" // | |
| 5923 | -baseId: "1"//收到的基站ID | |
| 5924 | -infos:{"state":"OK"}//返回状态,成功为OK | |
| 5925 | 5875 | |
| 5926 | 5876 | 指令样例： |
| 5927 | 5877 | |
| 5928 | 5878 | ```json |
| 5929 | 5879 | { |
| 5930 | - "fun": "stopKeyPadScan", | |
| 5931 | - "baseId": 1, | |
| 5932 | - "baseSn":"2023031402", | |
| 5880 | + "fun": "getSdkVer", | |
| 5933 | 5881 | "infos": { |
| 5934 | - "state": "OK" | |
| 5935 | - }, | |
| 5882 | + "value": "5.1.0.01" | |
| 5883 | + } | |
| 5936 | 5884 | "packetTag": "1" |
| 5937 | 5885 | } |
| 5938 | 5886 | ``` |
| 5939 | - | |
| 5940 | -#### 支持设备说明 | |
| 5941 | - | |
| 5942 | -|基站+键盘|支持/不支持|备注| | |
| 5943 | -|---|---|---| | |
| 5944 | -|B100-2.4G+S6|支持|| | |
| 5945 | -|B200-2.4G+S6|支持|| | |
| 5946 | - | |
| 5947 | - | |
| 5948 | -## 系统参数 | |
| 5949 | - | |
| 5950 | 5887 | ### 退出WSCmdApp |
| 5951 | 5888 | |
| 5952 | 5889 | WSCmdApp,WSCmdApp回应后将结束WSCmdApp.exe进程。 | ... | ... |
通讯协议-SDK应用部分[内部].md
| ... | ... | @@ -8,7 +8,7 @@ WSCmdAppå议接å£è¯´æ˜Ž |
| 8 | 8 | |
| 9 | 9 | |
| 10 | 10 | <div style="text-align: center;font-size: 30px;"> |
| 11 | -Ver5.1.8 | |
| 11 | +Ver5.1.9 | |
| 12 | 12 | </div> |
| 13 | 13 | <br> |
| 14 | 14 | <br> |
| ... | ... | @@ -50,6 +50,7 @@ Ver5.1.8 |
| 50 | 50 | |5.1.6| 2024å¹´02月19æ—¥|陈定æ•|1. å¢žåŠ keypadRemoteControl接å£<br>2. å¢žåŠ ä¸¾æ‰‹åŠŸèƒ½æŽ¥å£| |
| 51 | 51 | |5.1.7| 2024å¹´04月22æ—¥|陈定æ•|1. å¢žåŠ åŽå°ç¾åˆ°æŽ¥å£<br>2. å¢žåŠ é”®ç›˜æœ€ç»ˆæ交状æ€æŽ¥å£| |
| 52 | 52 | |5.1.8| 2024å¹´07月01æ—¥|陈定æ•|1. 投票å馈数æ®å¢žåŠ ç”µæ± çŠ¶æ€| |
| 53 | +|5.1.9| 2024å¹´07月19æ—¥|陈定æ•|1. å¢žåŠ èŽ·å–SDK版本接å£| | |
| 53 | 54 | |
| 54 | 55 | <br> |
| 55 | 56 | |
| ... | ... | @@ -6482,7 +6483,24 @@ fun: "keypadHandUp" |
| 6482 | 6483 | | B200-2.4G+S7 | æ”¯æŒ | | |
| 6483 | 6484 | |
| 6484 | 6485 | #### é¥æŽ§é”®ç›˜å…³æœº |
| 6486 | +##### é¥æŽ§æ‰€æœ‰é”®ç›˜å…³æœº | |
| 6487 | +写 | |
| 6488 | +å‘é€ï¼š | |
| 6489 | +fun: "remoteKeyShutdown" //é¥æŽ§é”®ç›˜å…³æœº | |
| 6490 | +params：{}// | |
| 6491 | +æŒ‡ä»¤æ ·ä¾‹ï¼š | |
| 6485 | 6492 | |
| 6493 | +```json | |
| 6494 | +{ | |
| 6495 | + "fun": "remoteKeyShutdown", | |
| 6496 | + "baseId": 1, | |
| 6497 | + "baseSn":"2023031402", | |
| 6498 | + "params": [], | |
| 6499 | + "packetTag": "1" | |
| 6500 | +} | |
| 6501 | +``` | |
| 6502 | + | |
| 6503 | +##### é¥æŽ§æŒ‡å®šé”®ç›˜å…³æœº | |
| 6486 | 6504 | 写 |
| 6487 | 6505 | å‘é€ï¼š |
| 6488 | 6506 | fun: "remoteKeyShutdown" //é¥æŽ§é”®ç›˜å…³æœº |
| ... | ... | @@ -7165,12 +7183,12 @@ infos:{} //数组对象 |
| 7165 | 7183 | "infos": [{ |
| 7166 | 7184 | "baseId": "1", |
| 7167 | 7185 | "keySn": "1837454011", |
| 7168 | - "ver": "1.0.6" | |
| 7186 | + "keyVer": "1.0.6" | |
| 7169 | 7187 | }, |
| 7170 | 7188 | { |
| 7171 | 7189 | "baseId": "1", |
| 7172 | 7190 | "keySn": "1837454012", |
| 7173 | - "ver": "1.0.6" | |
| 7191 | + "keyVer": "1.0.6" | |
| 7174 | 7192 | } |
| 7175 | 7193 | ], |
| 7176 | 7194 | "packetTag": "1" |
| ... | ... | @@ -7196,7 +7214,6 @@ params:{ |
| 7196 | 7214 | "times":1 //基站扫æ键盘时长，å•ä½ç§’ 范围1-10秒 |
| 7197 | 7215 | } // |
| 7198 | 7216 | |
| 7199 | - | |
| 7200 | 7217 | æŒ‡ä»¤æ ·ä¾‹ï¼š |
| 7201 | 7218 | |
| 7202 | 7219 | ```json |
| ... | ... | @@ -7212,39 +7229,41 @@ params:{ |
| 7212 | 7229 | ``` |
| 7213 | 7230 | |
| 7214 | 7231 | 接收： |
| 7215 | -fun: "keypadOnLine" //é”®ç›˜åœ¨çº¿çŠ¶æ€ | |
| 7232 | +fun: "answerKeyPadScan" //é”®ç›˜åœ¨çº¿çŠ¶æ€ | |
| 7216 | 7233 | infos:{} //数组对象 |
| 7217 | 7234 | |
| 7218 | 7235 | | **基站+键盘** | **支æŒ** | **备注** | |
| 7219 | 7236 | | --- | --- | --- | |
| 7220 | 7237 | |baseId|基站id|keySn键盘所在基站id| |
| 7221 | 7238 | |keySn|键盘Sn|| |
| 7222 | -|keyVer|键盘版本|| | |
| 7223 | -|Volt|键盘电é‡|T2百分比值，S6æ— æ•ˆ| | |
| 7239 | + | |
| 7224 | 7240 | |
| 7225 | 7241 | |
| 7226 | 7242 | æŒ‡ä»¤æ ·ä¾‹ï¼š |
| 7227 | 7243 | |
| 7244 | +扫æ到的键盘信æ¯æŒ‡ä»¤[这个指令会有多æ¡]： | |
| 7245 | + | |
| 7228 | 7246 | ```json |
| 7229 | 7247 | { |
| 7230 | - "fun": "keypadOnLine", | |
| 7231 | - "baseId": 0, | |
| 7232 | - "infos": [{ | |
| 7233 | - "baseId": "1", | |
| 7234 | - "keySn": "1837454011", | |
| 7235 | - "ver": "1.0.6", | |
| 7236 | - "hModel": "67", | |
| 7237 | - "Volt": "100" | |
| 7238 | - }, | |
| 7239 | - { | |
| 7240 | - "baseId": "1", | |
| 7241 | - "keySn": "1837454012", | |
| 7242 | - "ver": "1.0.6", | |
| 7243 | - "hModel": "67", | |
| 7244 | - "Volt": "30" | |
| 7245 | - } | |
| 7246 | - ], | |
| 7247 | - "packetTag": "1" | |
| 7248 | + "baseId": 1, | |
| 7249 | + "fun": "answerKeyPadScan", | |
| 7250 | + "infos": { | |
| 7251 | + "keySn": "0112375918" | |
| 7252 | + }, | |
| 7253 | + "packetTag": "0" | |
| 7254 | +} | |
| 7255 | +``` | |
| 7256 | + | |
| 7257 | +接收扫æåœæ¢æŒ‡ä»¤ï¼š | |
| 7258 | + | |
| 7259 | +```json | |
| 7260 | +{ | |
| 7261 | + "baseId": 1, | |
| 7262 | + "fun": "stopgetKeypadOnLine", | |
| 7263 | + "infos": { | |
| 7264 | + "state": "OK" | |
| 7265 | + }, | |
| 7266 | + "packetTag": "18" | |
| 7248 | 7267 | } |
| 7249 | 7268 | ``` |
| 7250 | 7269 | |
| ... | ... | @@ -7253,9 +7272,9 @@ infos:{} //数组对象 |
| 7253 | 7272 | | --- | --- | --- | |
| 7254 | 7273 | | B100-2.4G+S6 | æ”¯æŒ |键盘电é‡ï¼šæ— 效| |
| 7255 | 7274 | | B200-2.4G+S6 | æ”¯æŒ |键盘电é‡ï¼šæ— 效| |
| 7256 | -| B200-5.8G+T2 | æ”¯æŒ |键盘电é‡ï¼šç™¾åˆ†æ¯”值| | |
| 7275 | +| B200-5.8G+T2 | æ”¯æŒ |键盘电é‡ï¼šæ— 效| | |
| 7257 | 7276 | |
| 7258 | -### 在线键盘扫æ | |
| 7277 | +### 在线键盘扫æ[内部] | |
| 7259 | 7278 | |
| 7260 | 7279 | #### 开始扫æ |
| 7261 | 7280 | |
| ... | ... | @@ -7323,7 +7342,7 @@ infos:{ "hModel": "67","keySn":"1479824643","ver":"1.0.0","keyBattery":"2.5"}//è |
| 7323 | 7342 | "infos": { |
| 7324 | 7343 | "hModel": "67", |
| 7325 | 7344 | "keySn": "1479824643", |
| 7326 | - "ver": "1.0.0", | |
| 7345 | + "keyVer": "1.0.0", | |
| 7327 | 7346 | "keyBattery": "2.5" |
| 7328 | 7347 | }, |
| 7329 | 7348 | "packetTag": "0" |
| ... | ... | @@ -7377,7 +7396,42 @@ infos:{"state":"OK"}//返回状æ€,æˆåŠŸä¸ºOK |
| 7377 | 7396 | |
| 7378 | 7397 | |
| 7379 | 7398 | ## 系统å‚æ•° |
| 7399 | +### èŽ·å– WSCmdApp 版本 | |
| 7400 | + èŽ·å– WSCmdApp 当å‰ç‰ˆæœ¬ | |
| 7401 | +å‘é€ï¼š | |
| 7402 | +fun: "getSdkVer" // | |
| 7403 | +params:{}//æ— è¯¥å€¼ | |
| 7404 | +packetTag:"1"// | |
| 7405 | + | |
| 7406 | + | |
| 7407 | +æŒ‡ä»¤æ ·ä¾‹ï¼š | |
| 7408 | + | |
| 7409 | +```json | |
| 7410 | +{ | |
| 7411 | + "fun": "getSdkVer", | |
| 7412 | + "packetTag": "1" | |
| 7413 | +} | |
| 7414 | +``` | |
| 7415 | + | |
| 7416 | +接收: | |
| 7417 | + | |
| 7418 | +fun: "getSdkVer" // | |
| 7419 | +infos:{ | |
| 7420 | + "value": "5.1.0.01" | |
| 7421 | +} | |
| 7422 | + | |
| 7380 | 7423 | |
| 7424 | +æŒ‡ä»¤æ ·ä¾‹ï¼š | |
| 7425 | + | |
| 7426 | +```json | |
| 7427 | +{ | |
| 7428 | + "fun": "getSdkVer", | |
| 7429 | + "infos": { | |
| 7430 | + "value": "5.1.0.01" | |
| 7431 | + } | |
| 7432 | + "packetTag": "1" | |
| 7433 | +} | |
| 7434 | +``` | |
| 7381 | 7435 | ### 退出WSCmdApp |
| 7382 | 7436 | |
| 7383 | 7437 | WSCmdApp,WSCmdApp回应åŽå°†ç»“æŸWSCmdApp.exe进程。 | ... | ... |