李外 / Protocol

Commit 2b646f14cfe84479c0b6c80a75aed43c67d202fe

Authored by 刘琴
1 parent 2448f2b2

增加同步签到相关内容

Inline Side-by-side
Showing 1 changed file with 108 additions and 37 deletions
通讯协议-B200W-MQTT协议[内部].md
  View file @2b646f1
... ... @@ -141,6 +141,8 @@
141 141 ### 签到
142 142 |功能归类|功能|API指令|指令事件|
143 143 |---|---|---|---|
  144 +|同步签到|启动同步签到|[startKpSignIn](#startkpsignin)|[sEvtStateCode](#sevtstatecode)<br>[fEvtKpSignIn](#fevtkpsignin)|
  145 +||停止同步签到|[stopKpSignIn](#stopkpsignin)|[sEvtStateCode](#sevtstatecode)|
144 146 |随时签到|启动随时签到|[rtStartKpSignIn](#rtstartkpsignin)|[sEvtStateCode](#sevtstatecode)<br>[fEvtKpSignIn](#fevtkpsignin)|
145 147 ||停止随时签到|[rtStopKpSignIn](#rtstopkpsignin)|[sEvtStateCode](#sevtstatecode)|
146 148 ||实时PIN签到授权|[rtSetKpLoginAllowed](#rtsetkploginallowed)|[sEvtStateCode](#sevtstatecode)<br>[fEvtKpLoginAllowed](#fevtkploginallowed)|
... ... @@ -1105,7 +1107,7 @@
1105 1107 - **示例代码**
1106 1108 ```json
1107 1109 {
1108   - "fun": "startBsFastPair",
  1110 + "fun":"startBsFastPair",
1109 1111 "dataTag":"1"
1110 1112 }
1111 1113 ```
... ... @@ -1122,7 +1124,7 @@
1122 1124 - **示例代码**
1123 1125 ```json
1124 1126 {
1125   - "fun": "stopBsFastPair",
  1127 + "fun":"stopBsFastPair",
1126 1128 "dataTag":"1"
1127 1129 }
1128 1130 ```
... ... @@ -1800,7 +1802,7 @@
1800 1802 ```json
1801 1803 //分别提示
1802 1804 {
1803   - "fun": "rtSetKpUserPrompt",
  1805 + "fun":"rtSetKpUserPrompt",
1804 1806 "dataTag":"1",
1805 1807 "data": [
1806 1808 {
... ... @@ -1815,7 +1817,7 @@
1815 1817 }
1816 1818 //统一提示
1817 1819 {
1818   - "fun": "rtSetKpUserPrompt",
  1820 + "fun":"rtSetKpUserPrompt",
1819 1821 "dataTag":"1",
1820 1822 "data": [
1821 1823 {
... ... @@ -1865,7 +1867,7 @@
1865 1867 |++state|string||是|设置的提示语是否成功<br>0 - 成功<br>1 - 失败|
1866 1868 ```json
1867 1869 {
1868   - "fun": "fEvtSetKpUserPrompt",
  1870 + "fun":"fEvtSetKpUserPrompt",
1869 1871 "dataTag":"1",
1870 1872 "data": [
1871 1873 {
... ... @@ -1898,7 +1900,7 @@
1898 1900 - **示例代码**
1899 1901 ```json
1900 1902 {
1901   - "fun": "startGetKpOnline",
  1903 + "fun":"startGetKpOnline",
1902 1904 "dataTag":"1"
1903 1905 }
1904 1906 ```
... ... @@ -1916,7 +1918,7 @@
1916 1918 - **示例代码**
1917 1919 ```json
1918 1920 {
1919   - "fun": "stopGetKpOnline",
  1921 + "fun":"stopGetKpOnline",
1920 1922 "dataTag":"1"
1921 1923 }
1922 1924 ```
... ... @@ -2120,7 +2122,7 @@
2120 2122 - **示例代码**
2121 2123 ```json
2122 2124 {
2123   - "fun": "rtSetKpBindingInfo",
  2125 + "fun":"rtSetKpBindingInfo",
2124 2126 "dataTag":"1",
2125 2127 "data": [
2126 2128 {
... ... @@ -2150,7 +2152,7 @@
2150 2152 - **示例代码**
2151 2153 ```json
2152 2154 {
2153   - "fun": "clearKpBindingInfo",
  2155 + "fun":"clearKpBindingInfo",
2154 2156 "dataTag":"1",
2155 2157 "data": {
2156 2158 "keySns":["1479824643","1479824644","1479824645"]
... ... @@ -2177,7 +2179,7 @@
2177 2179 - **示例代码**
2178 2180 ```json
2179 2181 {
2180   - "fun": "fEvtKpBindingInfo",
  2182 + "fun":"fEvtKpBindingInfo",
2181 2183 "dataTag":"1",
2182 2184 "data": [
2183 2185 {
... ... @@ -2206,7 +2208,7 @@
2206 2208 - **示例代码**
2207 2209 ```json
2208 2210 {
2209   - "fun": "fEvtClearKpBindingInfo",
  2211 + "fun":"fEvtClearKpBindingInfo",
2210 2212 "dataTag":"1",
2211 2213 "data": {
2212 2214 "state": "0"
... ... @@ -2214,6 +2216,75 @@
2214 2216 }
2215 2217 ```
2216 2218 ## 签到
  2219 +### 同步签到
  2220 +#### 方法
  2221 +##### startKpSignIn
  2222 +- **主题**：/client/\${baseSN}/send
  2223 +- **功能描述**：启动同步签到
  2224 +- **参数说明**
  2225 +
  2226 +|参数名|类型|限制|是否必填|说明|
  2227 +|---|---|---|---|---|
  2228 +|fun|string|-|是|指令名称|
  2229 +|dataTag|string|-|否|数据包标识,可为空字符串|
  2230 +|data|object|-|是|传递参数的对象|
  2231 +|+mode|int|-|是|签到模式<br>1-按键签到，可指定按键<br>2-PIN码签到，可指定PIN码长度<br>3-指纹签到(<font color="red">暂不支持</font>)|
  2232 +|+allowModify |int|-|是 | 修改模式 <br> 0-不可修改 <br>1-可以修改(默认值)|
  2233 +|+pinLen |int|-|是| 可输入pin码的最大长度 1≤N≤14 |
  2234 +|+keyValue |int|-|是 | 指定按键键值 <br> 0: 未指定(OK键签到) <br>1-9: 按键1-9 <br> 10: 按键0 <br> 11: 上键 <br> 12: 下键 <br> 13: OK键 <br> 14: ESC键 <br> 15: Menu键 |
  2235 +|+tipTitle |string|-|否| 提示标题,长度最多不超过16个字节|
  2236 +
  2237 +- **示例代码**
  2238 +```Json
  2239 +//按键签到
  2240 +{
  2241 + "fun":"startKpSignIn",
  2242 + "dataTag":"1",
  2243 + "data":{
  2244 + "mode":1,
  2245 + "allowModify":1,
  2246 + "keyValue":5,
  2247 + "tip":"请按5键签到"
  2248 + }
  2249 +}
  2250 +
  2251 +//pin签到
  2252 +{
  2253 + "fun":"startKpSignIn",
  2254 + "dataTag":"1",
  2255 + "data":{
  2256 + "mode":2,
  2257 + "allowModify":1,
  2258 + "pinLen":6,
  2259 + "tip":"请输入PIN码签到"
  2260 + }
  2261 +}
  2262 +```
  2263 +
  2264 +##### stopKpSignIn
  2265 +- **主题**：/client/\${baseSN}/send
  2266 +- **功能描述**：停止同步签到
  2267 +- **参数说明**
  2268 +
  2269 +|参数名|类型|限制|是否必填|说明|
  2270 +|---|---|---|---|---|
  2271 +|fun|string|-|是|指令名称|
  2272 +|dataTag|string|-|否|数据包标识,可为空字符串|
  2273 +
  2274 +- **示例代码**
  2275 +```Json
  2276 +{
  2277 + "fun":"stopKpSignIn",
  2278 + "dataTag":"1"
  2279 +}
  2280 +```
  2281 +#### 事件
  2282 +##### [sEvtStateCode](#sevtstatecode)
  2283 +发送指令后返回接收状态
  2284 +
  2285 +##### [fEvtKpSignIn](#fevtkpsignin)
  2286 +返回键盘提交的签到数据
  2287 +
2217 2288 ### 随时签到
2218 2289 #### 方法
2219 2290 ##### rtStartKpSignIn
... ... @@ -2231,7 +2302,7 @@
2231 2302 - **示例代码**
2232 2303 ```json
2233 2304 {
2234   - "fun": "rtStartKpSignIn",
  2305 + "fun":"rtStartKpSignIn",
2235 2306 "dataTag":"1",
2236 2307 "data":{
2237 2308 "mode":2
... ... @@ -2240,7 +2311,7 @@
2240 2311 ```
2241 2312 ##### rtStopKpSignIn
2242 2313 - **主题**：/client/\${baseSN}/send
2243   -- **功能描述**：停止签到绑定
  2314 +- **功能描述**：停止随时签到绑定
2244 2315 - **参数说明**
2245 2316  
2246 2317 |参数名|类型|限制|是否必填|说明|
... ... @@ -2251,7 +2322,7 @@
2251 2322 - **示例代码**
2252 2323 ```json
2253 2324 {
2254   - "fun": "rtStopKpSignIn",
  2325 + "fun":"rtStopKpSignIn",
2255 2326 "dataTag":"1"
2256 2327 }
2257 2328 ```
... ... @@ -2271,7 +2342,7 @@
2271 2342 - **示例代码**
2272 2343 ```json
2273 2344 {
2274   - "fun": "rtSetKpLoginAllowed",
  2345 + "fun":"rtSetKpLoginAllowed",
2275 2346 "dataTag":"1",
2276 2347 "data":{
2277 2348 "keySn":"1479824643",
... ... @@ -2300,7 +2371,7 @@
2300 2371 - **示例代码**
2301 2372 ```json
2302 2373 {
2303   - "fun": "fEvtKpSignIn",
  2374 + "fun":"fEvtKpSignIn",
2304 2375 "dataTag":"1",
2305 2376 "data": [{
2306 2377 "keySn": "1234567890",
... ... @@ -2331,7 +2402,7 @@
2331 2402 - **示例代码**
2332 2403 ```json
2333 2404 {
2334   - "fun": "fEvtKpLoginAllowed",
  2405 + "fun":"fEvtKpLoginAllowed",
2335 2406 "dataTag":"1",
2336 2407 "data": {
2337 2408 "keySn":"1479824643",
... ... @@ -2363,7 +2434,7 @@
2363 2434 - **示例代码**
2364 2435 ```json
2365 2436 {
2366   - "fun": "startQATrueFalse",
  2437 + "fun":"startQATrueFalse",
2367 2438 "dataTag":"1",
2368 2439 "data":{
2369 2440 "keySns":[],
... ... @@ -2390,7 +2461,7 @@
2390 2461 - **示例代码**
2391 2462 ```json
2392 2463 {
2393   - "fun": "stopQATrueFalse",
  2464 + "fun":"stopQATrueFalse",
2394 2465 "dataTag":"1"
2395 2466 }
2396 2467 ```
... ... @@ -2415,7 +2486,7 @@
2415 2486 - **示例代码**
2416 2487 ```json
2417 2488 {
2418   - "fun": "fEvtQATrueFalse",
  2489 + "fun":"fEvtQATrueFalse",
2419 2490 "dataTag":"1",
2420 2491 "data": [{
2421 2492 "keySn": "1234567890",
... ... @@ -2451,7 +2522,7 @@
2451 2522 - **示例代码**
2452 2523 ```json
2453 2524 {
2454   - "fun": "startQAChoice",
  2525 + "fun":"startQAChoice",
2455 2526 "dataTag":"1",
2456 2527 "data":{
2457 2528 "keySns":[],
... ... @@ -2481,7 +2552,7 @@
2481 2552 - **示例代码**
2482 2553 ```json
2483 2554 {
2484   - "fun": "stopQAChoice",
  2555 + "fun":"stopQAChoice",
2485 2556 "dataTag":"1"
2486 2557 }
2487 2558 ```
... ... @@ -2506,7 +2577,7 @@
2506 2577 - **示例代码**
2507 2578 ```json
2508 2579 {
2509   - "fun": "fEvtQAChoice",
  2580 + "fun":"fEvtQAChoice",
2510 2581 "dataTag":"1",
2511 2582 "data": [{
2512 2583 "keySn": "1234567890",
... ... @@ -2540,7 +2611,7 @@
2540 2611 - **示例代码**
2541 2612 ```json
2542 2613 {
2543   - "fun": "startQANum",
  2614 + "fun":"startQANum",
2544 2615 "dataTag":"1",
2545 2616 "data":{
2546 2617 "keySns":[],
... ... @@ -2569,7 +2640,7 @@
2569 2640 - **示例代码**
2570 2641 ```json
2571 2642 {
2572   - "fun": "stopQANum",
  2643 + "fun":"stopQANum",
2573 2644 "dataTag":"1"
2574 2645 }
2575 2646 ```
... ... @@ -2594,7 +2665,7 @@
2594 2665 - **示例代码**
2595 2666 ```json
2596 2667 {
2597   - "fun": "fEvtQANum",
  2668 + "fun":"fEvtQANum",
2598 2669 "dataTag":"1",
2599 2670 "data": [{
2600 2671 "keySn": "1234567890",
... ... @@ -2625,7 +2696,7 @@
2625 2696 - **示例代码**
2626 2697 ```json
2627 2698 {
2628   - "fun": "startQAQuicker",
  2699 + "fun":"startQAQuicker",
2629 2700 "dataTag":"1",
2630 2701 "data":{
2631 2702 "keySns":[],
... ... @@ -2651,7 +2722,7 @@
2651 2722 - **示例代码**
2652 2723 ```json
2653 2724 {
2654   - "fun": "stopQAQuicker",
  2725 + "fun":"stopQAQuicker",
2655 2726 "dataTag":"1"
2656 2727 }
2657 2728 ```
... ... @@ -2676,7 +2747,7 @@
2676 2747 - **示例代码**
2677 2748 ```json
2678 2749 {
2679   - "fun": "fEvtQAQuicker",
  2750 + "fun":"fEvtQAQuicker",
2680 2751 "dataTag":"1",
2681 2752 "data": [{
2682 2753 "keySn": "1234567890",
... ... @@ -2713,7 +2784,7 @@
2713 2784 ```json
2714 2785 //自定义题号
2715 2786 {
2716   - "fun": "startKpExam",
  2787 + "fun":"startKpExam",
2717 2788 "dataTag":"1",
2718 2789 "data":{
2719 2790 "mode": 0,
... ... @@ -2752,7 +2823,7 @@
2752 2823  
2753 2824 //显示Q开头
2754 2825 {
2755   - "fun": "startKpExam",
  2826 + "fun":"startKpExam",
2756 2827 "dataTag":"1",
2757 2828 "data":{
2758 2829 "mode": 1,
... ... @@ -2772,7 +2843,7 @@
2772 2843  
2773 2844 //显示题开头
2774 2845 {
2775   - "fun": "startKpExam",
  2846 + "fun":"startKpExam",
2776 2847 "dataTag":"1",
2777 2848 "data":{
2778 2849 "mode": 2,
... ... @@ -2803,7 +2874,7 @@
2803 2874 - **示例代码**
2804 2875 ```json
2805 2876 {
2806   - "fun": "stopKpExam",
  2877 + "fun":"stopKpExam",
2807 2878 "dataTag":"1"
2808 2879 }
2809 2880 ```
... ... @@ -2822,7 +2893,7 @@
2822 2893 - **示例代码**
2823 2894 ```json
2824 2895 {
2825   - "fun": "rtGetKpExamData",
  2896 + "fun":"rtGetKpExamData",
2826 2897 "dataTag":"1",
2827 2898 "data":{
2828 2899 "keySns":["1234567890","1234567891"]
... ... @@ -2844,7 +2915,7 @@
2844 2915 - **示例代码**
2845 2916 ```json
2846 2917 {
2847   - "fun": "rtKpAllowEdited",
  2918 + "fun":"rtKpAllowEdited",
2848 2919 "dataTag":"1",
2849 2920 "data":{
2850 2921 "keySns":["1234567890","1234567891"]
... ... @@ -2872,7 +2943,7 @@
2872 2943 - **示例代码**
2873 2944 ```json
2874 2945 {
2875   - "fun": "fEvtKpExam",
  2946 + "fun":"fEvtKpExam",
2876 2947 "dataTag":"1",
2877 2948 "data": [{
2878 2949 "keySn": "1234567890",
... ... @@ -2904,7 +2975,7 @@
2904 2975 - **示例代码**
2905 2976 ```json
2906 2977 {
2907   - "fun": "fEvtFinalSubmit",
  2978 + "fun":"fEvtFinalSubmit",
2908 2979 "dataTag":"1",
2909 2980 "data": [{
2910 2981 "keySn": "1234567890",
... ...