李外 / Protocol

Commit 84dcab21bbbb242f6b06b11a3117c0f0f78391c2

Authored by 孙向锦
1 parent 5890e4c7

海亮定制

Inline Side-by-side
Showing 1 changed file with 137 additions and 95 deletions
海亮定制.md
  View file @84dcab2
... ... @@ -781,116 +781,158 @@ ${clinetId} clinetId 是基站编号，为替换字符串。
781 781  
782 782 ### 基站升级
783 783  
784   -
785 784 #### 开始升级
786   -
787   -| 主题 | /client/${client}/operate | 备注 |
788   -| --- | --- | --- |
789   -| { "i":17, "m":{ "url":"", "version":"", "CRC":"" }} | url：升级包地址 version：版本号CRC：CRC-32校验码 |
  785 +主题: /client/${client}/operate
  786 +指令内容：
  787 +```json
  788 +{
  789 + "i": 17,
  790 + "en": "12342",
  791 + "m": {
  792 + "url": "",
  793 + "version": "",
  794 + "CRC": ""
  795 + }
  796 +}
  797 +```
  798 +| 名词 | 备注 |
  799 +| --- | --- |
  800 +| i = 17 | 基站升级 |
  801 +| en |序号 |
  802 +| url |固件包地址，基站能访问到的路径 |
  803 +| version |新固件的版本 |
  804 +| CRC |新关键计算的CRC |
  805 +|||
790 806  
791 807  
792 808 #### 升级进度报告
793   -
794   -| 主题 | /client/${client}/report | 备注 |
795   -| --- | --- | --- |
796   -| { "i":18, "m":{ "cId":"123456", "percent":0, "status":0 }} | cId：客户端设备ID percent：升级进度，0-100status：升级状态信息，0：未开始；1：升级中；2：升级成功；4固件版本号错误；5：不在升级名单内；6：升级指令错误；\>127：升级中的错误码。 |
797   -
  809 +主题： /client/${client}/report
  810 +指令内容：
  811 +```json
  812 +{
  813 + "i": 18,
  814 + "m": {
  815 + "cId": "123456",
  816 + "percent": 0,
  817 + "status": 0
  818 + }
  819 +}
  820 +```
  821 +| 名词 | 备注 |
  822 +| --- | --- |
  823 +| i = 18 | 升级进度报告 |
  824 +| cId |基站编号 |
  825 +| percent |升级百分比 |
  826 +| status |升级状态信息。 <br> 0：未开始<br> 1：升级中<br> 2：升级成功<br> 4固件版本号错误<br> 5：不在升级名单内<br> 6：升级指令错误<br> \>127：升级中的错误码。 |
  827 +|||
798 828  
799 829 ### 键盘升级
800   -
801 830  
802 831 #### 开始升级
803   -
804   -| 主题 | /client/${client}/operate | 备注 |
805   -| --- | --- | --- |
806   -| { "i":28, "m":{ "url":"", "version":"", "CRC":"" }} | url：升级包地址 version：版本号CRC：CRC-32校验码 |
807   -
  832 +主题: /client/${client}/operate
  833 +指令内容：
  834 +```json
  835 +{
  836 + "i": 28,
  837 + "m": {
  838 + "url": "",
  839 + "version": "",
  840 + "CRC": ""
  841 + }
  842 +}
  843 +```
  844 +| 名词 | 备注 |
  845 +| --- | --- |
  846 +| i = 28 | 键盘升级 |
  847 +| url |固件包地址，基站能访问到的路径 |
  848 +| version |新固件的版本号 |
  849 +| CRC |新关键计算的CRC |
  850 +|||
808 851  
809 852 #### 升级进度报告
  853 +主题： /client/${client}/report
  854 +指令内容：
  855 +```json
  856 +{
  857 + "i": 29,
  858 + "m": {
  859 + "cId": "123456",
  860 + "percent": 0,
  861 + "status": 0
  862 + }
  863 +}
  864 +```
  865 +| 名词 | 备注 |
  866 +| --- | --- |
  867 +| i = 18 | 升级进度报告 |
  868 +| cId |基站编号 |
  869 +| percent |升级百分比 |
  870 +| status |升级状态信息。 <br> 0：未开始<br> 1：升级中<br> 2：升级成功<br> 4固件版本号错误<br> 5：不在升级名单内<br> 6：升级指令错误<br> \>127：升级中的错误码。 |
  871 +|||
810 872  
811   -| 主题 | /client/${client}/report | 备注 |
812   -| --- | --- | --- |
813   -| { "i":29, "m":{ "cId":"123456", "percent":0, "status":0 }} | cId：客户端设备ID percent：升级进度，0-100 status：升级状态信息， 0：未开始； 1：升级中； 2：升级成功； 4固件版本号错误； 5：不在升级名单内；6：升级指令错误；\>127：升级中的错误码。 |
814   -
815   -
816   -### 刷卡事件
817   -
818   -由基站发给应用程序，应用需要订阅主题
819   -
820   -| 主题 | /client/${clientId}/card/swipe | 备注 |
821   -| --- | --- | --- |
822   -| { "i":50, "m":[{ "c":"12345", "el":0.75, "t":1626016299 }]} | i = 50 刷卡事件答题器编号和刷卡时间 |
823   -
824   -
825   -### 指纹事件
826   -
827   -由基站发给应用程序，应用需要订阅主题
828   -
829   -| 主题 | /client/${clientId}/card/fingerprint | 备注 |
830   -| --- | --- | --- |
831   -| { "i":51, "m":[{ "c":"12345", "el":0.75, "t":1626016299 }]} | i = 51指纹事件答题器编号和刷卡时间 |
832   -
833   -
834   -### 考勤
835   -
836   -
837   -#### 打开考勤功能
838   -
839   -应用程序发送给基站
840   -
841   -| 主题 | /lesson/class/${clinetId}/receive | 备注 |
842   -| --- | --- | --- |
843   -| { "i":6} | i = 6 开启考勤功能 |
844   -
845   -
846   -#### 关闭考勤功能
847   -
848   -应用程序发送给基站
849   -
850   -| 主题 | /lesson/class/${clinetId}/receive | 备注 |
851   -| --- | --- | --- |
852   -| { "i":7} | i = 7 关闭考勤功能 |
853   -
854   -
855   -#### 设置考勤上传频率
856   -
857   -应用程序发送给基站
858   -
859   -| 主题 | /lesson/class/${clinetId}/receive | 备注 |
860   -| --- | --- | --- |
861   -| { "i":8, "m":30} | i = 8 设置考勤频率m = 30 表示频率率为30秒采集一次 |
862   -
863   -
864   -#### 上报考勤数据
865   -
866   -| 主题 | /lesson/class/${clientId}/attend | 备注 |
867   -| --- | --- | --- |
868   -| { "i":9, "m":[{ "c":"12345", "t":1626016299 }], "total":4, "current":1} | 内容为答题器序号和时间戳， total为本次上报的总的传输包数，current为当前传输包序号。 |
869   -
870   -
871 873 ### 文本预设
872 874  
873   -
874 875 #### 文本设置
  876 +主题： /client/${client}/operate
  877 +指令内容：
  878 +```json
  879 +{
  880 + "i": 61,
  881 + "en": "123552",
  882 + "sn": ["12345", "56789"],
  883 + "m": [{
  884 + "cmd": 81,
  885 + "text": "hex:"
  886 + }]
  887 +}
  888 +```
  889 +| 名词 | 备注 |
  890 +| --- | --- |
  891 +| i = 18 | 升级进度报告 |
  892 +| sn |键盘列表 |
  893 +| cmd |下发的命令 <br> 4 第二行文本 <br> 81 单选 <br> 82 多选 <br> 83 数字 <br> 84 判断 <br> 85 自判题判断 <br> 87 清除 |
  894 +| text |标题信息，以hex:开头添加的内容 内容为GBK的hex编码 |
  895 +|||
  896 +
  897 +```java
  898 + public static String bytesToHexString(byte[] src) {
  899 + StringBuilder stringBuilder = new StringBuilder("");
  900 + if (src == null || src.length <= 0) {
  901 + return null;
  902 + }
  903 + for (int i = 0; i < src.length; i++) {
  904 + int v = src[i] & 0xFF;
  905 + String hv = Integer.toHexString(v);
  906 + if (hv.length() < 2) {
  907 + stringBuilder.append(0);
  908 + }
  909 + stringBuilder.append(hv);
  910 + stringBuilder.append("");
  911 + }
  912 + return stringBuilder.toString();
  913 +}
  914 +```
875 915  
876   -| 主题 | /client/${client}/operate | 备注 |
877   -| --- | --- | --- |
878   -| { "i":61, "en":"123552", "sn":["12345","56789"], "m":[{ "cmd":81, "text":"",}]} | Cmd:对应测验题显示 1 姓名 2 积分 3 81 单选 82 多选 83 数字 84 判断 85 自判题判断 86 自判题数字 87 清除 Text：文本预设内容，最长不超过8个汉字。 sn 键盘列表
879   - |
880 916  
881 917  
882 918 #### 设置返回
883   -
884   -| 主题 | /client/${client}/report | 备注 |
885   -| --- | --- | --- |
886   -| { "i":61, "en":"123552", "m":[{ "cmd":81, "success":0, "sn":["12345","56789"]}]} | Cmd:对应测验题显示 81单选 82 多选 83 数字 84 判断 85 自判题判断 86 自判题数字 87 清除Text：文本预设内容，最长不超过8个汉字。 |
887   -
888   -
889   -### 学生卡信息上报
890   -
891   -主题：/client/${client}/report
892   -
893   -| 主题 | /client/${client}/report | 备注 |
894   -| --- | --- | --- |
895   -| { "i":32, "m":[{ "c":"1873373905", "cv":"0.2.2", "hw":"67.0", "t":1638865040 }] }
896   - | 消息格式：卡初始化组网的时候会上报一次 c 键盘编号 t 时间 hw 硬件版本号cv 软件版本号 |
897 919 \ No newline at end of file
  920 +主题: /client/${client}/report
  921 +指令内容：
  922 +```json
  923 +{
  924 + "i": 61,
  925 + "en": "123552",
  926 + "sn": ["12345", "56789"],
  927 + "m": [{
  928 + "cmd": 81,
  929 + "success": 0
  930 + }]
  931 +}
  932 +```
  933 +| 名词 | 备注 |
  934 +| --- | --- |
  935 +| i = 61 | 升级进度报告 |
  936 +| sn |键盘列表 |
  937 +| cmd |下发的命令 <br> 4 第二行文本 <br> 81 单选 <br> 82 多选 <br> 83 数字 <br> 84 判断 <br> 85 自判题判断 <br> 87 清除 |
  938 +| success | 是否成功。<br> 0 表示成功 <br> 非0 表示失败 -1失败 |
  939 +|||
... ...