Commit 038c24f8e35fa0c5726b5ab47a08a631ce7b3356

Authored by DMchen
1 parent 3280551e

1.SDK应用部分,修改发现的错误。

img/image6.png 0 → 100644

9.28 KB

通讯协议-SDK应用部分.md
@@ -3,7 +3,7 @@ @@ -3,7 +3,7 @@
3 <br> 3 <br>
4 4
5 <div style="text-align: center;font-size: 70px;"> 5 <div style="text-align: center;font-size: 70px;">
6 -WSCmdApp接口协议接口说明 6 +WSCmdApp协议接口说明
7 </div> 7 </div>
8 8
9 9
@@ -2620,7 +2620,7 @@ infos: {} @@ -2620,7 +2620,7 @@ infos: {}
2620 | **Json字段** | **字段含义** | **赋值及含义** | 2620 | **Json字段** | **字段含义** | **赋值及含义** |
2621 | --- | --- | --- | 2621 | --- | --- | --- |
2622 | keySn | 键盘Sn | | 2622 | keySn | 键盘Sn | |
2623 -| keyValue | 键值 | ABCD/1234/AA123 | 2623 +| keyValue | 键值 | 字符串 |
2624 2624
2625 2625
2626 指令样例: 2626 指令样例:
@@ -2631,27 +2631,12 @@ infos: {} @@ -2631,27 +2631,12 @@ infos: {}
2631 "baseId": 1, 2631 "baseId": 1,
2632 "infos": { 2632 "infos": {
2633 "keySn": "1479824643", 2633 "keySn": "1479824643",
2634 - "keyValue": "1" 2634 + "keyValue": "abcdef"
2635 }, 2635 },
2636 "packetTag": "1" 2636 "packetTag": "1"
2637 } 2637 }
2638 ``` 2638 ```
2639 2639
2640 -发送:  
2641 -  
2642 -fun: "answerTextAnswer" //填空题作答返回  
2643 -baseId: "1"//接收的基站ID  
2644 -params:{} //为空  
2645 -  
2646 -指令样例:  
2647 -  
2648 -```json  
2649 -{  
2650 - "fun": "answerTextAnswer",  
2651 - "baseId": 1,  
2652 - "packetTag": "1"  
2653 -}  
2654 -```  
2655 #### 停止作答 2640 #### 停止作答
2656 2641
2657 发送: 2642 发送:
@@ -2850,9 +2835,10 @@ infos:{&quot;state&quot;:&quot;OK&quot;}//返回状态,成功为OK @@ -2850,9 +2835,10 @@ infos:{&quot;state&quot;:&quot;OK&quot;}//返回状态,成功为OK
2850 | --- | --- | --- | 2835 | --- | --- | --- |
2851 | B200-2.4G+S6 | 支持 |需要指定键盘支持| 2836 | B200-2.4G+S6 | 支持 |需要指定键盘支持|
2852 2837
2853 -## NFC刷卡 2838 +## 刷卡
2854 2839
2855 刷卡流程: 2840 刷卡流程:
  2841 +![](img/image6.png)
2856 2842
2857 刷卡后可以将键盘和基站自动完成配对。当需要刷卡绑定时应用软件先给基站发送一个键盘的姓名,键盘靠近基站感应区就会直接绑定当前数据并返回状态给应用。绑定成功后应用再发送下一个键盘的绑定信息,依次循环来绑定多个。 2843 刷卡后可以将键盘和基站自动完成配对。当需要刷卡绑定时应用软件先给基站发送一个键盘的姓名,键盘靠近基站感应区就会直接绑定当前数据并返回状态给应用。绑定成功后应用再发送下一个键盘的绑定信息,依次循环来绑定多个。
2858 2844
@@ -2885,17 +2871,40 @@ params:{}// @@ -2885,17 +2871,40 @@ params:{}//
2885 } 2871 }
2886 ``` 2872 ```
2887 2873
2888 -### 刷卡绑定反馈 2874 +接收:
  2875 +fun: "writeNFCInfo" //
  2876 +baseId: "1"//收到的基站ID
  2877 +infos:{"value":"OK"}//返回状态,成功为OK
  2878 +
  2879 +
  2880 +指令样例:
  2881 +```json
  2882 +{
  2883 + "fun": "writeNFCInfo",
  2884 + "baseId": 1,
  2885 + "infos": {
  2886 + "value": "OK"
  2887 + },
  2888 + "packetTag": "1"
  2889 +}
  2890 +```
  2891 +
  2892 + 支持设备说明
  2893 +| **基站+键盘** | **支持** | **备注** |
  2894 +| --- | --- | --- |
  2895 +| B200-2.4GS+S6 | 支持 |带NFC键盘有效|
  2896 +
  2897 +### 刷卡反馈
2889 2898
2890 接收: 2899 接收:
2891 -fun: "NFCInfo" //NFC绑定数据 2900 +fun: "NFCInfo" //刷卡反馈
2892 baseId: "1"//键盘所连基站ID 2901 baseId: "1"//键盘所连基站ID
2893 infos:{} 2902 infos:{}
2894 2903
2895 | **Json字段** | **字段含义** | **赋值及含义** | 2904 | **Json字段** | **字段含义** | **赋值及含义** |
2896 | --- | --- | --- | 2905 | --- | --- | --- |
2897 |keySn|键盘Sn|| 2906 |keySn|键盘Sn||
2898 -|state|状态|1:预留<br>2:基站报告正常刷卡的键盘SN<br>3:预留<br>4:刷卡写指定配对码消息| 2907 +|state|状态|1:预留<br>2:基站报告NFC刷卡的键盘SN<br>3:预留<br>4:刷卡写指定配对码消息<br>5:基站报告M1刷卡的键盘SN|
2899 |number|数量|预留| 2908 |number|数量|预留|
2900 2909
2901 2910
@@ -2914,11 +2923,19 @@ infos:{} @@ -2914,11 +2923,19 @@ infos:{}
2914 } 2923 }
2915 ``` 2924 ```
2916 2925
  2926 +支持设备说明
  2927 +
  2928 +|基站+键盘|支持/不支持|备注|
  2929 +|---|---|---|
  2930 +|B200-2.4GS+S6|支持||
  2931 +|B200-2.4GS+M1|支持||
  2932 +|B200-5.8G+T2|支持||
  2933 +
2917 2934
2918 ### NFC数据清除指令 2935 ### NFC数据清除指令
2919 2936
2920 发送: 2937 发送:
2921 -fun: "writeNFCEmpty" //写NFC绑定数据 2938 +fun: "writeNFCEmpty" //清除NFC数据
2922 baseId: 1//1~32 (键盘所连基站ID) 2939 baseId: 1//1~32 (键盘所连基站ID)
2923 params:{}// 2940 params:{}//
2924 2941
@@ -2933,11 +2950,28 @@ params:{}// @@ -2933,11 +2950,28 @@ params:{}//
2933 "packetTag": "1" 2950 "packetTag": "1"
2934 } 2951 }
2935 ``` 2952 ```
  2953 +接收:
  2954 +fun: "writeNFCEmpty" //
  2955 +baseId: "1"//收到的基站ID
  2956 +infos:{"value":"OK"}//返回状态,成功为OK
2936 2957
2937 -### 支持设备说明 2958 +
  2959 +指令样例:
  2960 +```json
  2961 +{
  2962 + "fun": "writeNFCEmpty",
  2963 + "baseId": 1,
  2964 + "infos": {
  2965 + "value": "OK"
  2966 + },
  2967 + "packetTag": "1"
  2968 +}
  2969 +```
  2970 +
  2971 + 支持设备说明
2938 | **基站+键盘** | **支持** | **备注** | 2972 | **基站+键盘** | **支持** | **备注** |
2939 | --- | --- | --- | 2973 | --- | --- | --- |
2940 -| B200-2.4G+S6 | 支持 |带NFC键盘有效| 2974 +| B200-2.4GS+S6 | 支持 |带NFC键盘有效|
2941 2975
2942 2976
2943 ## 硬件参数 2977 ## 硬件参数
@@ -3495,8 +3529,8 @@ infos:{&quot;keypadNumber&quot;:&quot;60&quot;,&quot;lock&quot;:&quot;1&quot;}//返回基站键盘容量值 @@ -3495,8 +3529,8 @@ infos:{&quot;keypadNumber&quot;:&quot;60&quot;,&quot;lock&quot;:&quot;1&quot;}//返回基站键盘容量值
3495 3529
3496 ```json 3530 ```json
3497 { 3531 {
3498 - "fun": "baseStationID",  
3499 "baseId": 2, 3532 "baseId": 2,
  3533 + "fun": "baseStationCapacity",
3500 "infos": { 3534 "infos": {
3501 "keypadNumber": "60", 3535 "keypadNumber": "60",
3502 "lock": "1" 3536 "lock": "1"
@@ -3590,7 +3624,7 @@ infos:{&quot;state&quot;:&quot;OK&quot;}//返回状态,成功为OK @@ -3590,7 +3624,7 @@ infos:{&quot;state&quot;:&quot;OK&quot;}//返回状态,成功为OK
3590 } 3624 }
3591 ``` 3625 ```
3592 3626
3593 -#####支持设备说明 3627 +##### 支持设备说明
3594 3628
3595 | **基站+键盘** | **支持** | **备注** | 3629 | **基站+键盘** | **支持** | **备注** |
3596 | --- | --- | --- | 3630 | --- | --- | --- |
@@ -3777,7 +3811,7 @@ params: @@ -3777,7 +3811,7 @@ params:
3777 "fun": "writeBaseStationTcpIp", 3811 "fun": "writeBaseStationTcpIp",
3778 "baseId": 1, 3812 "baseId": 1,
3779 "params": { 3813 "params": {
3780 - "mac": "FF.FF.FF.FF.FF", 3814 + "mac": "FF:FF:FF:FF:FF:FF",
3781 "ip": "192.168.10.10", 3815 "ip": "192.168.10.10",
3782 "mask": "255.255.255.0", 3816 "mask": "255.255.255.0",
3783 "gateway": "192.168.10.1" 3817 "gateway": "192.168.10.1"
@@ -3804,7 +3838,7 @@ infos:{&quot;value&quot;:&quot;1&quot;}//返回基站TcpIp @@ -3804,7 +3838,7 @@ infos:{&quot;value&quot;:&quot;1&quot;}//返回基站TcpIp
3804 "baseId": 1, 3838 "baseId": 1,
3805 "infos": { 3839 "infos": {
3806 "ip": "192.168.10.10", 3840 "ip": "192.168.10.10",
3807 - "mac": "FF.FF.FF.FF.FF", 3841 + "mac": "FF:FF:FF:FF:FF:FF",
3808 "mask": "255.255.255.0", 3842 "mask": "255.255.255.0",
3809 "gateway": "192.168.10.1" 3843 "gateway": "192.168.10.1"
3810 }, 3844 },
@@ -4749,7 +4783,7 @@ params:{} // 数组对象,对象中的默认值为空字符串 @@ -4749,7 +4783,7 @@ params:{} // 数组对象,对象中的默认值为空字符串
4749 | **Json字段** | **字段含义** | **赋值及含义** | 4783 | **Json字段** | **字段含义** | **赋值及含义** |
4750 | --- | --- | --- | 4784 | --- | --- | --- |
4751 |keySn|键盘SN|空字符串,为所有在线键盘| 4785 |keySn|键盘SN|空字符串,为所有在线键盘|
4752 -|txt|短消息内容|字符串最长80字节| 4786 +|txt|短消息内容|字符串最长40字节[20汉字]|
4753 4787
4754 4788
4755 指令样例: 4789 指令样例:
通讯协议-SDK应用部分[内部].md
@@ -3,7 +3,7 @@ @@ -3,7 +3,7 @@
3 <br> 3 <br>
4 4
5 <div style="text-align: center;font-size: 70px;"> 5 <div style="text-align: center;font-size: 70px;">
6 -WSCmdApp接口协议接口说明 6 +WSCmdApp协议接口说明
7 </div> 7 </div>
8 8
9 9
@@ -2733,7 +2733,7 @@ infos: {} @@ -2733,7 +2733,7 @@ infos: {}
2733 | **Json字段** | **字段含义** | **赋值及含义** | 2733 | **Json字段** | **字段含义** | **赋值及含义** |
2734 | --- | --- | --- | 2734 | --- | --- | --- |
2735 | keySn | 键盘Sn | | 2735 | keySn | 键盘Sn | |
2736 -| keyValue | 键值 | ABCD/1234/AA123 | 2736 +| keyValue | 键值 | 字符串 |
2737 2737
2738 2738
2739 指令样例: 2739 指令样例:
@@ -2744,27 +2744,12 @@ infos: {} @@ -2744,27 +2744,12 @@ infos: {}
2744 "baseId": 1, 2744 "baseId": 1,
2745 "infos": { 2745 "infos": {
2746 "keySn": "1479824643", 2746 "keySn": "1479824643",
2747 - "keyValue": "1" 2747 + "keyValue": "abcdef"
2748 }, 2748 },
2749 "packetTag": "1" 2749 "packetTag": "1"
2750 } 2750 }
2751 ``` 2751 ```
2752 2752
2753 -发送:  
2754 -  
2755 -fun: "answerTextAnswer" //填空题作答返回  
2756 -baseId: "1"//接收的基站ID  
2757 -params:{} //为空  
2758 -  
2759 -指令样例:  
2760 -  
2761 -```json  
2762 -{  
2763 - "fun": "answerTextAnswer",  
2764 - "baseId": 1,  
2765 - "packetTag": "1"  
2766 -}  
2767 -```  
2768 #### 停止作答 2753 #### 停止作答
2769 2754
2770 发送: 2755 发送:
@@ -2963,6 +2948,7 @@ infos:{&quot;state&quot;:&quot;OK&quot;}//返回状态,成功为OK @@ -2963,6 +2948,7 @@ infos:{&quot;state&quot;:&quot;OK&quot;}//返回状态,成功为OK
2963 | --- | --- | --- | 2948 | --- | --- | --- |
2964 | B200-2.4G+S6 | 支持 |需要指定键盘支持| 2949 | B200-2.4G+S6 | 支持 |需要指定键盘支持|
2965 2950
  2951 +### 数字选举
2966 2952
2967 ### 自定义题型 2953 ### 自定义题型
2968 2954
@@ -2984,7 +2970,7 @@ params:{} @@ -2984,7 +2970,7 @@ params:{}
2984 许可权限表结构表说明 2970 许可权限表结构表说明
2985 | **Json字段** | **字段含义** | **赋值及含义** | 2971 | **Json字段** | **字段含义** | **赋值及含义** |
2986 | --- | --- | --- | 2972 | --- | --- | --- |
2987 -|permission| 许可权限 |0无[默认]<br>1: 允许<br>2: 禁止| 2973 +|permission| 许可权限 |0:无[默认]<br>1: 允许<br>2: 禁止|
2988 |KeySnList| 键盘列表 |数组<br>"1479824643"<br>"1479824644"<br>"1479824645"<br>"1479824646"| 2974 |KeySnList| 键盘列表 |数组<br>"1479824643"<br>"1479824644"<br>"1479824645"<br>"1479824646"|
2989 2975
2990 2976
@@ -3216,9 +3202,10 @@ infos:{&quot;state&quot;:&quot;OK&quot;}//返回状态,成功为OK @@ -3216,9 +3202,10 @@ infos:{&quot;state&quot;:&quot;OK&quot;}//返回状态,成功为OK
3216 3202
3217 3203
3218 3204
3219 -## NFC刷卡 3205 +## 刷卡
3220 3206
3221 刷卡流程: 3207 刷卡流程:
  3208 +![](img/image6.png)
3222 3209
3223 刷卡后可以将键盘和基站自动完成配对。当需要刷卡绑定时应用软件先给基站发送一个键盘的姓名,键盘靠近基站感应区就会直接绑定当前数据并返回状态给应用。绑定成功后应用再发送下一个键盘的绑定信息,依次循环来绑定多个。 3210 刷卡后可以将键盘和基站自动完成配对。当需要刷卡绑定时应用软件先给基站发送一个键盘的姓名,键盘靠近基站感应区就会直接绑定当前数据并返回状态给应用。绑定成功后应用再发送下一个键盘的绑定信息,依次循环来绑定多个。
3224 3211
@@ -3251,17 +3238,40 @@ params:{}// @@ -3251,17 +3238,40 @@ params:{}//
3251 } 3238 }
3252 ``` 3239 ```
3253 3240
3254 -### 刷卡绑定反馈 3241 +接收:
  3242 +fun: "writeNFCInfo" //
  3243 +baseId: "1"//收到的基站ID
  3244 +infos:{"value":"OK"}//返回状态,成功为OK
  3245 +
  3246 +
  3247 +指令样例:
  3248 +```json
  3249 +{
  3250 + "fun": "writeNFCInfo",
  3251 + "baseId": 1,
  3252 + "infos": {
  3253 + "value": "OK"
  3254 + },
  3255 + "packetTag": "1"
  3256 +}
  3257 +```
  3258 +
  3259 + 支持设备说明
  3260 +| **基站+键盘** | **支持** | **备注** |
  3261 +| --- | --- | --- |
  3262 +| B200-2.4GS+S6 | 支持 |带NFC键盘有效|
  3263 +
  3264 +### 刷卡反馈
3255 3265
3256 接收: 3266 接收:
3257 -fun: "NFCInfo" //NFC绑定数据 3267 +fun: "NFCInfo" //刷卡反馈
3258 baseId: "1"//键盘所连基站ID 3268 baseId: "1"//键盘所连基站ID
3259 infos:{} 3269 infos:{}
3260 3270
3261 | **Json字段** | **字段含义** | **赋值及含义** | 3271 | **Json字段** | **字段含义** | **赋值及含义** |
3262 | --- | --- | --- | 3272 | --- | --- | --- |
3263 |keySn|键盘Sn|| 3273 |keySn|键盘Sn||
3264 -|state|状态|1:预留<br>2:基站报告正常刷卡的键盘SN<br>3:预留<br>4:刷卡写指定配对码消息| 3274 +|state|状态|1:预留<br>2:基站报告NFC刷卡的键盘SN<br>3:预留<br>4:刷卡写指定配对码消息<br>5:基站报告M1刷卡的键盘SN|
3265 |number|数量|预留| 3275 |number|数量|预留|
3266 3276
3267 3277
@@ -3280,11 +3290,19 @@ infos:{} @@ -3280,11 +3290,19 @@ infos:{}
3280 } 3290 }
3281 ``` 3291 ```
3282 3292
  3293 +支持设备说明
  3294 +
  3295 +|基站+键盘|支持/不支持|备注|
  3296 +|---|---|---|
  3297 +|B200-2.4GS+S6|支持||
  3298 +|B200-2.4GS+M1|支持||
  3299 +|B200-5.8G+T2|支持||
  3300 +
3283 3301
3284 ### NFC数据清除指令 3302 ### NFC数据清除指令
3285 3303
3286 发送: 3304 发送:
3287 -fun: "writeNFCEmpty" //写NFC绑定数据 3305 +fun: "writeNFCEmpty" //清除NFC数据
3288 baseId: 1//1~32 (键盘所连基站ID) 3306 baseId: 1//1~32 (键盘所连基站ID)
3289 params:{}// 3307 params:{}//
3290 3308
@@ -3299,11 +3317,28 @@ params:{}// @@ -3299,11 +3317,28 @@ params:{}//
3299 "packetTag": "1" 3317 "packetTag": "1"
3300 } 3318 }
3301 ``` 3319 ```
  3320 +接收:
  3321 +fun: "writeNFCEmpty" //
  3322 +baseId: "1"//收到的基站ID
  3323 +infos:{"value":"OK"}//返回状态,成功为OK
3302 3324
3303 -### 支持设备说明 3325 +
  3326 +指令样例:
  3327 +```json
  3328 +{
  3329 + "fun": "writeNFCEmpty",
  3330 + "baseId": 1,
  3331 + "infos": {
  3332 + "value": "OK"
  3333 + },
  3334 + "packetTag": "1"
  3335 +}
  3336 +```
  3337 +
  3338 + 支持设备说明
3304 | **基站+键盘** | **支持** | **备注** | 3339 | **基站+键盘** | **支持** | **备注** |
3305 | --- | --- | --- | 3340 | --- | --- | --- |
3306 -| B200-2.4G+S6 | 支持 |带NFC键盘有效| 3341 +| B200-2.4GS+S6 | 支持 |带NFC键盘有效|
3307 3342
3308 3343
3309 ## 硬件参数 3344 ## 硬件参数
@@ -3861,8 +3896,8 @@ infos:{&quot;keypadNumber&quot;:&quot;60&quot;,&quot;lock&quot;:&quot;1&quot;}//返回基站键盘容量值 @@ -3861,8 +3896,8 @@ infos:{&quot;keypadNumber&quot;:&quot;60&quot;,&quot;lock&quot;:&quot;1&quot;}//返回基站键盘容量值
3861 3896
3862 ```json 3897 ```json
3863 { 3898 {
3864 - "fun": "baseStationID",  
3865 "baseId": 2, 3899 "baseId": 2,
  3900 + "fun": "baseStationCapacity",
3866 "infos": { 3901 "infos": {
3867 "keypadNumber": "60", 3902 "keypadNumber": "60",
3868 "lock": "1" 3903 "lock": "1"
@@ -3956,7 +3991,7 @@ infos:{&quot;state&quot;:&quot;OK&quot;}//返回状态,成功为OK @@ -3956,7 +3991,7 @@ infos:{&quot;state&quot;:&quot;OK&quot;}//返回状态,成功为OK
3956 } 3991 }
3957 ``` 3992 ```
3958 3993
3959 -#####支持设备说明 3994 +##### 支持设备说明
3960 3995
3961 | **基站+键盘** | **支持** | **备注** | 3996 | **基站+键盘** | **支持** | **备注** |
3962 | --- | --- | --- | 3997 | --- | --- | --- |
@@ -4143,7 +4178,7 @@ params: @@ -4143,7 +4178,7 @@ params:
4143 "fun": "writeBaseStationTcpIp", 4178 "fun": "writeBaseStationTcpIp",
4144 "baseId": 1, 4179 "baseId": 1,
4145 "params": { 4180 "params": {
4146 - "mac": "FF.FF.FF.FF.FF", 4181 + "mac": "FF:FF:FF:FF:FF:FF",
4147 "ip": "192.168.10.10", 4182 "ip": "192.168.10.10",
4148 "mask": "255.255.255.0", 4183 "mask": "255.255.255.0",
4149 "gateway": "192.168.10.1" 4184 "gateway": "192.168.10.1"
@@ -4170,7 +4205,7 @@ infos:{&quot;value&quot;:&quot;1&quot;}//返回基站TcpIp @@ -4170,7 +4205,7 @@ infos:{&quot;value&quot;:&quot;1&quot;}//返回基站TcpIp
4170 "baseId": 1, 4205 "baseId": 1,
4171 "infos": { 4206 "infos": {
4172 "ip": "192.168.10.10", 4207 "ip": "192.168.10.10",
4173 - "mac": "FF.FF.FF.FF.FF", 4208 + "mac": "FF:FF:FF:FF:FF:FF",
4174 "mask": "255.255.255.0", 4209 "mask": "255.255.255.0",
4175 "gateway": "192.168.10.1" 4210 "gateway": "192.168.10.1"
4176 }, 4211 },
@@ -5219,7 +5254,7 @@ params:{} // 数组对象,对象中的默认值为空字符串 @@ -5219,7 +5254,7 @@ params:{} // 数组对象,对象中的默认值为空字符串
5219 | **Json字段** | **字段含义** | **赋值及含义** | 5254 | **Json字段** | **字段含义** | **赋值及含义** |
5220 | --- | --- | --- | 5255 | --- | --- | --- |
5221 |keySn|键盘SN|空字符串,为所有在线键盘| 5256 |keySn|键盘SN|空字符串,为所有在线键盘|
5222 -|txt|短消息内容|字符串最长80字节| 5257 +|txt|短消息内容|字符串最长40字节[20汉字]|
5223 5258
5224 5259
5225 指令样例: 5260 指令样例: