Commit 68de43d285bc4b1cfc2678d897984009f7a71b5a
1 parent
672a1818
1.SDK应用部分,更新了后台签到实例部分。
Showing
2 changed files
with
349 additions
and
15 deletions
通讯协议-SDK应用部分.md
@@ -8,7 +8,7 @@ WSCmdApp协议接口说明 | @@ -8,7 +8,7 @@ WSCmdApp协议接口说明 | ||
8 | 8 | ||
9 | 9 | ||
10 | <div style="text-align: center;font-size: 30px;"> | 10 | <div style="text-align: center;font-size: 30px;"> |
11 | -Ver5.1.6 | 11 | +Ver5.1.7 |
12 | </div> | 12 | </div> |
13 | <br> | 13 | <br> |
14 | <br> | 14 | <br> |
@@ -48,6 +48,7 @@ Ver5.1.6 | @@ -48,6 +48,7 @@ Ver5.1.6 | ||
48 | |5.1.3| 2023年11月15日|陈定敏|1. 更新语音题接口参数| | 48 | |5.1.3| 2023年11月15日|陈定敏|1. 更新语音题接口参数| |
49 | |5.1.5| 2023年12月28日|陈定敏|1. 增加Json指令支持基站id和基站SN两种模式| | 49 | |5.1.5| 2023年12月28日|陈定敏|1. 增加Json指令支持基站id和基站SN两种模式| |
50 | |5.1.6| 2024年02月19日|陈定敏|1. 增加keypadRemoteControl接口<br>2. 增加举手功能接口| | 50 | |5.1.6| 2024年02月19日|陈定敏|1. 增加keypadRemoteControl接口<br>2. 增加举手功能接口| |
51 | +|5.1.7| 2024年04月22日|陈定敏|1. 增加后台签到接口<br>2. 增加键盘最终提交状态接口| | ||
51 | 52 | ||
52 | <br> | 53 | <br> |
53 | 54 | ||
@@ -491,8 +492,8 @@ params:{} //为空 | @@ -491,8 +492,8 @@ params:{} //为空 | ||
491 | 492 | ||
492 | 493 | ||
493 | ### 签到设备 | 494 | ### 签到设备 |
494 | - | ||
495 | -#### 开始签到 | 495 | +#### 普通签到 |
496 | +##### 开始签到 | ||
496 | 497 | ||
497 | 发送: | 498 | 发送: |
498 | 499 | ||
@@ -522,7 +523,6 @@ params:{} | @@ -522,7 +523,6 @@ params:{} | ||
522 | "bindMode": "1", | 523 | "bindMode": "1", |
523 | "lessMode": "0", | 524 | "lessMode": "0", |
524 | "modifyMode": "1", | 525 | "modifyMode": "1", |
525 | - "limitNumber": "1", | ||
526 | "options": "10", | 526 | "options": "10", |
527 | "optionalN": "10", | 527 | "optionalN": "10", |
528 | "keyValue": "0" | 528 | "keyValue": "0" |
@@ -531,7 +531,7 @@ params:{} | @@ -531,7 +531,7 @@ params:{} | ||
531 | } | 531 | } |
532 | ``` | 532 | ``` |
533 | 533 | ||
534 | -#### 接收签到信息 | 534 | +##### 接收签到信息 |
535 | 535 | ||
536 | 接收: | 536 | 接收: |
537 | 537 | ||
@@ -561,7 +561,7 @@ infos:{} | @@ -561,7 +561,7 @@ infos:{} | ||
561 | } | 561 | } |
562 | ``` | 562 | ``` |
563 | 563 | ||
564 | -#### 停止签到 | 564 | +##### 停止签到 |
565 | 565 | ||
566 | 发送: | 566 | 发送: |
567 | 567 | ||
@@ -598,13 +598,153 @@ infos:{"state":"OK"}//返回状态,成功为OK | @@ -598,13 +598,153 @@ infos:{"state":"OK"}//返回状态,成功为OK | ||
598 | } | 598 | } |
599 | ``` | 599 | ``` |
600 | 600 | ||
601 | -#### 支持设备说明 | 601 | +##### 支持设备说明 |
602 | 602 | ||
603 | |**基站+键盘 **|**支持/不支持**|**备注**| | 603 | |**基站+键盘 **|**支持/不支持**|**备注**| |
604 | | --- | --- | --- | | 604 | | --- | --- | --- | |
605 | |B100-2.4G+S6|支持|| | 605 | |B100-2.4G+S6|支持|| |
606 | |B200-2.4G+S6|支持|| | 606 | |B200-2.4G+S6|支持|| |
607 | |B200-5.8G+T2|支持|| | 607 | |B200-5.8G+T2|支持|| |
608 | +#### 后台签到 | ||
609 | +##### 设置后台签到模式 | ||
610 | + | ||
611 | +注意:此接口只支持广播模式使用。 | ||
612 | + | ||
613 | +发送: | ||
614 | + | ||
615 | +fun: "backendBind" // | ||
616 | +params:{} | ||
617 | + | ||
618 | +|**Json字段**| **字段含义** | **赋值及含义**| | ||
619 | +| --- | --- | --- | | ||
620 | +| mode | 签到模式| 0: 关闭 <br> 1: 开启 | | ||
621 | + | ||
622 | + | ||
623 | +指令样例: | ||
624 | + | ||
625 | +```json | ||
626 | +{ | ||
627 | + "fun": "backendBind", | ||
628 | + "baseId": 0, | ||
629 | + "baseSn":"2023031402", | ||
630 | + "params": { | ||
631 | + "mode": "1" | ||
632 | + }, | ||
633 | + "packetTag": "1" | ||
634 | +} | ||
635 | +``` | ||
636 | + | ||
637 | +接收: | ||
638 | + | ||
639 | +fun: "backendBind" // | ||
640 | +baseId: "1"//接收到指令的基站ID | ||
641 | +infos:{"state":"OK"}//返回状态,成功为OK | ||
642 | + | ||
643 | +指令样例: | ||
644 | + | ||
645 | +```json | ||
646 | +{ | ||
647 | + "fun": "backendBind", | ||
648 | + "baseId": 1, | ||
649 | + "baseSn":"2023031402", | ||
650 | + "infos": { | ||
651 | + "mode": "1", | ||
652 | + "state": "OK" | ||
653 | + }, | ||
654 | + "packetTag": "1" | ||
655 | +} | ||
656 | +``` | ||
657 | + | ||
658 | +##### 接收签到信息 | ||
659 | + | ||
660 | +接收: | ||
661 | + | ||
662 | +fun: "answerBind" //签到返回 | ||
663 | +baseId: "1"//接收到指令的基站ID | ||
664 | +infos:{} | ||
665 | + | ||
666 | +| Json字段|字段含义|赋值及含义| | ||
667 | +|---|---|---| | ||
668 | +|time|答题时间|单位秒| | ||
669 | +|keySn|键盘Sn|| | ||
670 | +|keyValue|键值|键盘提交的值| | ||
671 | + | ||
672 | +指令样例: | ||
673 | + | ||
674 | +```json | ||
675 | +{ | ||
676 | + "fun": "answerBind", | ||
677 | + "baseId": 1, | ||
678 | + "baseSn":"2023031402", | ||
679 | + "infos": { | ||
680 | + "time": "0", | ||
681 | + "keySn": "1479824643", | ||
682 | + "keyValue": "1234" | ||
683 | + }, | ||
684 | + "packetTag": "1" | ||
685 | +} | ||
686 | +``` | ||
687 | + | ||
688 | + | ||
689 | + | ||
690 | +##### 键盘授权 | ||
691 | + | ||
692 | +注意:此接口配合后台签到指令使用,只支持指定键盘操作。 | ||
693 | + | ||
694 | +发送: | ||
695 | + | ||
696 | +fun: "keyPadAuthorize" // | ||
697 | +baseId: "1"//收到的基站ID | ||
698 | +params:{} //默认空 | ||
699 | + | ||
700 | +| **Json字段** | **字段含义** | **赋值及含义** | | ||
701 | +| --- | --- | --- | | ||
702 | +| baseId | 基站ID | 1-32 | | ||
703 | +| authorize | 状态 | 1:成功<br>2:失败| | ||
704 | + | ||
705 | + | ||
706 | +指令样例: | ||
707 | +```json | ||
708 | +{ | ||
709 | + "fun": "keyPadAuthorize", | ||
710 | + "baseId": 0, | ||
711 | + "baseSn": "2023031402", | ||
712 | + "keySnList": [{ | ||
713 | + "keySn": "0112540402" | ||
714 | + }], | ||
715 | + "params": { | ||
716 | + "authorize": "1" | ||
717 | + }, | ||
718 | + "packetTag": "20" | ||
719 | +} | ||
720 | +``` | ||
721 | + | ||
722 | +接收: | ||
723 | + | ||
724 | +fun: "keyPadAuthorize" // | ||
725 | +baseId: "1"//收到的基站ID | ||
726 | +infos:{"authorize":"1"}//返回状态 | ||
727 | + | ||
728 | +指令样例: | ||
729 | +```json | ||
730 | +{ | ||
731 | + "fun": "keyPadAuthorize", | ||
732 | + "baseId": 1, | ||
733 | + "baseSn":"2023031402", | ||
734 | + "infos": { | ||
735 | + "authorize": "1", | ||
736 | + "keySn": "0112402128" | ||
737 | + }, | ||
738 | + "packetTag": "20" | ||
739 | +} | ||
740 | +``` | ||
741 | + | ||
742 | +##### 支持设备说明 | ||
743 | + | ||
744 | +|**基站+键盘 **|**支持/不支持**|**备注**| | ||
745 | +| --- | --- | --- | | ||
746 | +|B100-2.4G+S6|支持|| | ||
747 | +|B200-2.4G+S6|支持|| | ||
608 | 748 | ||
609 | ### 选择题 | 749 | ### 选择题 |
610 | 750 | ||
@@ -2641,6 +2781,54 @@ infos:{"state":"OK"}//返回状态,成功为OK | @@ -2641,6 +2781,54 @@ infos:{"state":"OK"}//返回状态,成功为OK | ||
2641 | } | 2781 | } |
2642 | ``` | 2782 | ``` |
2643 | 2783 | ||
2784 | +#### 键盘最终提交状态 | ||
2785 | + | ||
2786 | +发送: | ||
2787 | + | ||
2788 | +fun: "keyPadFinalSubmit" // | ||
2789 | +baseId: "1"//收到的基站ID | ||
2790 | +params:{} //默认空 | ||
2791 | + | ||
2792 | +| **Json字段** | **字段含义** | **赋值及含义** | | ||
2793 | +| --- | --- | --- | | ||
2794 | +| baseId | 基站ID | 1-32 | | ||
2795 | +| commitok | 状态 | 0:解锁 | | ||
2796 | + | ||
2797 | + | ||
2798 | +指令样例: | ||
2799 | +```json | ||
2800 | +{ | ||
2801 | + "fun": "keyPadFinalSubmit", | ||
2802 | + "baseId": 0, | ||
2803 | + "baseSn":"2023031402", | ||
2804 | + "params": { | ||
2805 | + "commitok": "0" | ||
2806 | + }, | ||
2807 | + "packetTag": "20" | ||
2808 | +} | ||
2809 | +``` | ||
2810 | + | ||
2811 | +接收: | ||
2812 | + | ||
2813 | +fun: "keyPadFinalSubmit" // | ||
2814 | +baseId: "1"//收到的基站ID | ||
2815 | +infos:{"commitok":"OK"}//返回状态 | ||
2816 | + | ||
2817 | +指令样例: | ||
2818 | +```json | ||
2819 | +{ | ||
2820 | + "fun": "keyPadFinalSubmit", | ||
2821 | + "baseId": 1, | ||
2822 | + "baseSn":"2023031402", | ||
2823 | + "infos": { | ||
2824 | + "commitok": "0", | ||
2825 | + "keySn": "0112402128", | ||
2826 | + "time": "84.5" | ||
2827 | + }, | ||
2828 | + "packetTag": "20" | ||
2829 | +} | ||
2830 | +``` | ||
2831 | + | ||
2644 | #### 支持设备说明 | 2832 | #### 支持设备说明 |
2645 | 2833 | ||
2646 | | **基站+键盘** | **支持** | **备注** | | 2834 | | **基站+键盘** | **支持** | **备注** | |
@@ -5790,3 +5978,6 @@ infos:{ "funId":"F0001","code":"10002"}// | @@ -5790,3 +5978,6 @@ infos:{ "funId":"F0001","code":"10002"}// | ||
5790 | |F0115|写入键盘姓名| | 5978 | |F0115|写入键盘姓名| |
5791 | |F0116|键盘关机时间等级| | 5979 | |F0116|键盘关机时间等级| |
5792 | |F0117|基础配置模式| | 5980 | |F0117|基础配置模式| |
5981 | +|F0118|最终提交状态| | ||
5982 | +|F0119|后台签到| | ||
5983 | +|F0120|键盘授权| |
通讯协议-SDK应用部分[内部].md
@@ -8,7 +8,7 @@ WSCmdApp协议接口说明 | @@ -8,7 +8,7 @@ WSCmdApp协议接口说明 | ||
8 | 8 | ||
9 | 9 | ||
10 | <div style="text-align: center;font-size: 30px;"> | 10 | <div style="text-align: center;font-size: 30px;"> |
11 | -Ver5.1.6 | 11 | +Ver5.1.7 |
12 | </div> | 12 | </div> |
13 | <br> | 13 | <br> |
14 | <br> | 14 | <br> |
@@ -48,6 +48,7 @@ Ver5.1.6 | @@ -48,6 +48,7 @@ Ver5.1.6 | ||
48 | |5.1.3| 2023年11月15日|陈定敏|1. 更新语音题接口参数| | 48 | |5.1.3| 2023年11月15日|陈定敏|1. 更新语音题接口参数| |
49 | |5.1.5| 2023年12月28日|陈定敏|1. 增加Json指令支持基站id和基站SN两种模式| | 49 | |5.1.5| 2023年12月28日|陈定敏|1. 增加Json指令支持基站id和基站SN两种模式| |
50 | |5.1.6| 2024年02月19日|陈定敏|1. 增加keypadRemoteControl接口<br>2. 增加举手功能接口| | 50 | |5.1.6| 2024年02月19日|陈定敏|1. 增加keypadRemoteControl接口<br>2. 增加举手功能接口| |
51 | +|5.1.7| 2024年04月22日|陈定敏|1. 增加后台签到接口<br>2. 增加键盘最终提交状态接口| | ||
51 | 52 | ||
52 | <br> | 53 | <br> |
53 | 54 | ||
@@ -491,8 +492,8 @@ params:{} //为空 | @@ -491,8 +492,8 @@ params:{} //为空 | ||
491 | 492 | ||
492 | 493 | ||
493 | ### 签到设备 | 494 | ### 签到设备 |
494 | - | ||
495 | -#### 开始签到 | 495 | +#### 普通签到 |
496 | +##### 开始签到 | ||
496 | 497 | ||
497 | 发送: | 498 | 发送: |
498 | 499 | ||
@@ -530,7 +531,7 @@ params:{} | @@ -530,7 +531,7 @@ params:{} | ||
530 | } | 531 | } |
531 | ``` | 532 | ``` |
532 | 533 | ||
533 | -#### 接收签到信息 | 534 | +##### 接收签到信息 |
534 | 535 | ||
535 | 接收: | 536 | 接收: |
536 | 537 | ||
@@ -560,7 +561,7 @@ infos:{} | @@ -560,7 +561,7 @@ infos:{} | ||
560 | } | 561 | } |
561 | ``` | 562 | ``` |
562 | 563 | ||
563 | -#### 停止签到 | 564 | +##### 停止签到 |
564 | 565 | ||
565 | 发送: | 566 | 发送: |
566 | 567 | ||
@@ -597,13 +598,153 @@ infos:{"state":"OK"}//返回状态,成功为OK | @@ -597,13 +598,153 @@ infos:{"state":"OK"}//返回状态,成功为OK | ||
597 | } | 598 | } |
598 | ``` | 599 | ``` |
599 | 600 | ||
600 | -#### 支持设备说明 | 601 | +##### 支持设备说明 |
601 | 602 | ||
602 | |**基站+键盘 **|**支持/不支持**|**备注**| | 603 | |**基站+键盘 **|**支持/不支持**|**备注**| |
603 | | --- | --- | --- | | 604 | | --- | --- | --- | |
604 | |B100-2.4G+S6|支持|| | 605 | |B100-2.4G+S6|支持|| |
605 | |B200-2.4G+S6|支持|| | 606 | |B200-2.4G+S6|支持|| |
606 | |B200-5.8G+T2|支持|| | 607 | |B200-5.8G+T2|支持|| |
608 | +#### 后台签到 | ||
609 | +##### 设置后台签到模式 | ||
610 | + | ||
611 | +注意:此接口只支持广播模式使用。 | ||
612 | + | ||
613 | +发送: | ||
614 | + | ||
615 | +fun: "backendBind" // | ||
616 | +params:{} | ||
617 | + | ||
618 | +|**Json字段**| **字段含义** | **赋值及含义**| | ||
619 | +| --- | --- | --- | | ||
620 | +| mode | 签到模式| 0: 关闭 <br> 1: 开启 | | ||
621 | + | ||
622 | + | ||
623 | +指令样例: | ||
624 | + | ||
625 | +```json | ||
626 | +{ | ||
627 | + "fun": "backendBind", | ||
628 | + "baseId": 0, | ||
629 | + "baseSn":"2023031402", | ||
630 | + "params": { | ||
631 | + "mode": "1" | ||
632 | + }, | ||
633 | + "packetTag": "1" | ||
634 | +} | ||
635 | +``` | ||
636 | + | ||
637 | +接收: | ||
638 | + | ||
639 | +fun: "backendBind" // | ||
640 | +baseId: "1"//接收到指令的基站ID | ||
641 | +infos:{"state":"OK"}//返回状态,成功为OK | ||
642 | + | ||
643 | +指令样例: | ||
644 | + | ||
645 | +```json | ||
646 | +{ | ||
647 | + "fun": "backendBind", | ||
648 | + "baseId": 1, | ||
649 | + "baseSn":"2023031402", | ||
650 | + "infos": { | ||
651 | + "mode": "1", | ||
652 | + "state": "OK" | ||
653 | + }, | ||
654 | + "packetTag": "1" | ||
655 | +} | ||
656 | +``` | ||
657 | + | ||
658 | +##### 接收签到信息 | ||
659 | + | ||
660 | +接收: | ||
661 | + | ||
662 | +fun: "answerBind" //签到返回 | ||
663 | +baseId: "1"//接收到指令的基站ID | ||
664 | +infos:{} | ||
665 | + | ||
666 | +| Json字段|字段含义|赋值及含义| | ||
667 | +|---|---|---| | ||
668 | +|time|答题时间|单位秒| | ||
669 | +|keySn|键盘Sn|| | ||
670 | +|keyValue|键值|键盘提交的值| | ||
671 | + | ||
672 | +指令样例: | ||
673 | + | ||
674 | +```json | ||
675 | +{ | ||
676 | + "fun": "answerBind", | ||
677 | + "baseId": 1, | ||
678 | + "baseSn":"2023031402", | ||
679 | + "infos": { | ||
680 | + "time": "0", | ||
681 | + "keySn": "1479824643", | ||
682 | + "keyValue": "1234" | ||
683 | + }, | ||
684 | + "packetTag": "1" | ||
685 | +} | ||
686 | +``` | ||
687 | + | ||
688 | + | ||
689 | + | ||
690 | +##### 键盘授权 | ||
691 | + | ||
692 | +注意:此接口配合后台签到指令使用,只支持指定键盘操作。 | ||
693 | + | ||
694 | +发送: | ||
695 | + | ||
696 | +fun: "keyPadAuthorize" // | ||
697 | +baseId: "1"//收到的基站ID | ||
698 | +params:{} //默认空 | ||
699 | + | ||
700 | +| **Json字段** | **字段含义** | **赋值及含义** | | ||
701 | +| --- | --- | --- | | ||
702 | +| baseId | 基站ID | 1-32 | | ||
703 | +| authorize | 状态 | 1:成功<br>2:失败| | ||
704 | + | ||
705 | + | ||
706 | +指令样例: | ||
707 | +```json | ||
708 | +{ | ||
709 | + "fun": "keyPadAuthorize", | ||
710 | + "baseId": 0, | ||
711 | + "baseSn": "2023031402", | ||
712 | + "keySnList": [{ | ||
713 | + "keySn": "0112540402" | ||
714 | + }], | ||
715 | + "params": { | ||
716 | + "authorize": "1" | ||
717 | + }, | ||
718 | + "packetTag": "20" | ||
719 | +} | ||
720 | +``` | ||
721 | + | ||
722 | +接收: | ||
723 | + | ||
724 | +fun: "keyPadAuthorize" // | ||
725 | +baseId: "1"//收到的基站ID | ||
726 | +infos:{"authorize":"1"}//返回状态 | ||
727 | + | ||
728 | +指令样例: | ||
729 | +```json | ||
730 | +{ | ||
731 | + "fun": "keyPadAuthorize", | ||
732 | + "baseId": 1, | ||
733 | + "baseSn":"2023031402", | ||
734 | + "infos": { | ||
735 | + "authorize": "1", | ||
736 | + "keySn": "0112402128" | ||
737 | + }, | ||
738 | + "packetTag": "20" | ||
739 | +} | ||
740 | +``` | ||
741 | + | ||
742 | +##### 支持设备说明 | ||
743 | + | ||
744 | +|**基站+键盘 **|**支持/不支持**|**备注**| | ||
745 | +| --- | --- | --- | | ||
746 | +|B100-2.4G+S6|支持|| | ||
747 | +|B200-2.4G+S6|支持|| | ||
607 | 748 | ||
608 | ### 选择题 | 749 | ### 选择题 |
609 | 750 | ||
@@ -2808,7 +2949,7 @@ params:{} //默认空 | @@ -2808,7 +2949,7 @@ params:{} //默认空 | ||
2808 | "baseId": 0, | 2949 | "baseId": 0, |
2809 | "baseSn":"2023031402", | 2950 | "baseSn":"2023031402", |
2810 | "params": { | 2951 | "params": { |
2811 | - "commitok": "1" | 2952 | + "commitok": "0" |
2812 | }, | 2953 | }, |
2813 | "packetTag": "20" | 2954 | "packetTag": "20" |
2814 | } | 2955 | } |
@@ -7079,4 +7220,6 @@ infos:{ "funId":"F0001","code":"10002"}// | @@ -7079,4 +7220,6 @@ infos:{ "funId":"F0001","code":"10002"}// | ||
7079 | |F0115|写入键盘姓名| | 7220 | |F0115|写入键盘姓名| |
7080 | |F0116|键盘关机时间等级| | 7221 | |F0116|键盘关机时间等级| |
7081 | |F0117|基础配置模式| | 7222 | |F0117|基础配置模式| |
7082 | -|F0118|提交状态| | 7223 | +|F0118|最终提交状态| |
7224 | +|F0119|后台签到| | ||
7225 | +|F0120|键盘授权| |