From 803c72123fc14274c7a09f6eb0d6076d24afda3f Mon Sep 17 00:00:00 2001
From: zhangqian <zhangqian@123.com>
Date: 星期三, 01 十一月 2023 10:38:34 +0800
Subject: [PATCH] update doc
---
docs/docs.go | 371 ++++++++++++++++++++++++++++++++++++++++++++++++----
1 files changed, 338 insertions(+), 33 deletions(-)
diff --git a/docs/docs.go b/docs/docs.go
index 5868d78..6e7c7ed 100644
--- a/docs/docs.go
+++ b/docs/docs.go
@@ -152,6 +152,67 @@
}
}
},
+ "/v1/device/list": {
+ "post": {
+ "produces": [
+ "application/json"
+ ],
+ "tags": [
+ "Device"
+ ],
+ "summary": "鑾峰彇褰撳墠闈㈡澘缁戝畾鐨勮澶囧垪琛�",
+ "responses": {
+ "200": {
+ "description": "鎴愬姛",
+ "schema": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/contextx.Response"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "data": {
+ "$ref": "#/definitions/response.DeviceListResponse"
+ }
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ },
+ "/v1/device/set": {
+ "post": {
+ "produces": [
+ "application/json"
+ ],
+ "tags": [
+ "璁惧"
+ ],
+ "summary": "璁剧疆褰撳墠璁惧id",
+ "parameters": [
+ {
+ "description": "鏌ヨ鍙傛暟",
+ "name": "object",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/request.SetCurrentDevice"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "鎴愬姛",
+ "schema": {
+ "$ref": "#/definitions/contextx.Response"
+ }
+ }
+ }
+ }
+ },
"/v1/plc/productProgress": {
"post": {
"produces": [
@@ -172,37 +233,6 @@
}
}
],
- "responses": {
- "200": {
- "description": "鎴愬姛",
- "schema": {
- "allOf": [
- {
- "$ref": "#/definitions/contextx.Response"
- },
- {
- "type": "object",
- "properties": {
- "data": {
- "$ref": "#/definitions/response.ProductProgress"
- }
- }
- }
- ]
- }
- }
- }
- }
- },
- "/v1/plc/productProgressRealTime": {
- "post": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "鐢熶骇鏁伴噺"
- ],
- "summary": "瀹炴椂鑾峰彇鐢熶骇杩涘害",
"responses": {
"200": {
"description": "鎴愬姛",
@@ -498,6 +528,11 @@
"summary": "鑾峰彇浠诲姟",
"parameters": [
{
+ "type": "string",
+ "name": "deviceID",
+ "in": "query"
+ },
+ {
"type": "integer",
"description": "椤电爜",
"name": "page",
@@ -543,6 +578,81 @@
"properties": {
"data": {
"$ref": "#/definitions/response.TaskResponse"
+ }
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ },
+ "/v1/task/listByChannel": {
+ "get": {
+ "produces": [
+ "application/json"
+ ],
+ "tags": [
+ "Task"
+ ],
+ "summary": "鑾峰彇浠诲姟鍒楄〃2",
+ "parameters": [
+ {
+ "type": "integer",
+ "description": "閫氶亾鍙枫�備笉浼犲彇鍏ㄩ儴鐨�",
+ "name": "channel",
+ "in": "query"
+ },
+ {
+ "type": "string",
+ "name": "deviceID",
+ "in": "query"
+ },
+ {
+ "type": "integer",
+ "description": "榛樿3",
+ "name": "limit",
+ "in": "query"
+ },
+ {
+ "type": "integer",
+ "description": "榛樿0",
+ "name": "offset",
+ "in": "query"
+ },
+ {
+ "enum": [
+ 1,
+ 2,
+ 3
+ ],
+ "type": "integer",
+ "x-enum-varnames": [
+ "QueryTypeUnFinish",
+ "QueryTypeToday",
+ "QueryTypeFinished"
+ ],
+ "description": "1 鏈畬鎴� 2 浠婂ぉ鏈畬鎴� 3 宸插畬鎴�",
+ "name": "type",
+ "in": "query"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "鎴愬姛",
+ "schema": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/contextx.Response"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "data": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/definitions/response.TaskResponse"
+ }
}
}
}
@@ -766,16 +876,36 @@
}
}
},
+ "constvar.Parity": {
+ "type": "integer",
+ "enum": [
+ 1,
+ 2,
+ 3
+ ],
+ "x-enum-comments": {
+ "ParityEven": "濂囨牎楠�",
+ "ParityNull": "鏃犳牎楠�",
+ "ParityOdd": "鍋舵牎楠�"
+ },
+ "x-enum-varnames": [
+ "ParityEven",
+ "ParityOdd",
+ "ParityNull"
+ ]
+ },
"constvar.PlcMethod": {
"type": "string",
"enum": [
"modbusTCP",
+ "modbusRTU",
"serial",
"缃戠粶",
"涓插彛"
],
"x-enum-varnames": [
"PlcMethodModbusTCP",
+ "PlcMethodModbusRTU",
"PlcMethodSerial",
"PlcMethodModbusTCPChinese",
"PlcMethodSerialChinese"
@@ -837,7 +967,7 @@
"type": "object",
"properties": {
"address": {
- "description": "PortName string ` + "`" + `gorm:\"type:varchar(191);comment:绔彛鍚嶇О\" json:\"portName\"` + "`" + `\nFrequency int ` + "`" + `gorm:\"comment:鏁版嵁鏇存柊棰戠巼 0-瀹炴椂鏇存柊 1-1娆�/绉抃" json:\"frequency\"` + "`" + `",
+ "description": "plc ip鍦板潃锛� method = modbusTCP鐢�",
"type": "string"
},
"baudRate": {
@@ -847,11 +977,25 @@
"brand": {
"type": "string"
},
+ "createdAt": {
+ "type": "string"
+ },
+ "dataBit": {
+ "description": "鏁版嵁浣嶏紝method = modbusRTU 鐢�",
+ "type": "integer"
+ },
+ "deletedAt": {
+ "type": "string"
+ },
"details": {
"type": "array",
"items": {
"$ref": "#/definitions/model.DevicePlcAddress"
}
+ },
+ "deviceID": {
+ "description": "璁惧缂栧彿",
+ "type": "string"
},
"id": {
"type": "integer"
@@ -862,12 +1006,27 @@
"method": {
"$ref": "#/definitions/constvar.PlcMethod"
},
+ "parity": {
+ "description": "鏍￠獙鏂瑰紡锛宮ethod = modbusRTU 鐢�",
+ "allOf": [
+ {
+ "$ref": "#/definitions/constvar.Parity"
+ }
+ ]
+ },
"port": {
"description": "plc 绔彛鍙凤紝 method = modbusTCP鐢�",
"type": "integer"
},
"serialName": {
"description": "涓插彛鍚嶇О锛宮ethod = serial鏃� 鐢�",
+ "type": "string"
+ },
+ "stopBit": {
+ "description": "鍋滄浣嶏紝method = modbusRTU 鐢�",
+ "type": "integer"
+ },
+ "updatedAt": {
"type": "string"
}
}
@@ -914,6 +1073,12 @@
"networkCard"
],
"properties": {
+ "createdAt": {
+ "type": "string"
+ },
+ "deletedAt": {
+ "type": "string"
+ },
"dns": {
"description": "dns",
"type": "string"
@@ -944,6 +1109,9 @@
"$ref": "#/definitions/model.NetConfigStatus"
}
]
+ },
+ "updatedAt": {
+ "type": "string"
}
}
},
@@ -968,13 +1136,22 @@
"amount": {
"type": "number"
},
+ "createdAt": {
+ "type": "string"
+ },
"customer": {
+ "type": "string"
+ },
+ "deletedAt": {
"type": "string"
},
"deliverDate": {
"type": "string"
},
"endTime": {
+ "type": "integer"
+ },
+ "id": {
"type": "integer"
},
"orderAttr": {
@@ -1002,6 +1179,9 @@
"unit": {
"type": "string"
},
+ "updatedAt": {
+ "type": "string"
+ },
"workOrderId": {
"type": "string"
}
@@ -1023,10 +1203,19 @@
"model.PlcBrand": {
"type": "object",
"properties": {
+ "createdAt": {
+ "type": "string"
+ },
+ "deletedAt": {
+ "type": "string"
+ },
"id": {
"type": "integer"
},
"name": {
+ "type": "string"
+ },
+ "updatedAt": {
"type": "string"
}
}
@@ -1050,6 +1239,12 @@
"channel": {
"description": "閫氶亾",
"type": "integer"
+ },
+ "createdAt": {
+ "type": "string"
+ },
+ "deletedAt": {
+ "type": "string"
},
"deviceId": {
"type": "string"
@@ -1075,20 +1270,38 @@
"description": "宸ヨ壓妯″瀷缂栧彿",
"type": "string"
},
+ "realEndTime": {
+ "type": "integer"
+ },
+ "realStartTime": {
+ "type": "integer"
+ },
"startTime": {
"type": "integer"
},
"status": {
"$ref": "#/definitions/model.ProcedureStatus"
+ },
+ "updatedAt": {
+ "type": "string"
}
}
},
"model.ProcessModel": {
"type": "object",
"properties": {
+ "createdAt": {
+ "type": "string"
+ },
+ "deletedAt": {
+ "type": "string"
+ },
"deviceId": {
"description": "鐢ㄤ簬杩囨护鑾峰彇nsq娑堟伅",
"type": "string"
+ },
+ "id": {
+ "type": "integer"
},
"isUpdate": {
"description": "鍓嶇鐢�",
@@ -1119,19 +1332,44 @@
"product": {
"description": "浜у搧鍚嶇О",
"type": "string"
+ },
+ "updatedAt": {
+ "type": "string"
}
}
},
"request.AddPlcBrand": {
"type": "object",
"properties": {
+ "createdAt": {
+ "type": "string"
+ },
+ "deletedAt": {
+ "type": "string"
+ },
"id": {
"type": "integer"
},
"name": {
"type": "string"
+ },
+ "updatedAt": {
+ "type": "string"
}
}
+ },
+ "request.QueryType": {
+ "type": "integer",
+ "enum": [
+ 1,
+ 2,
+ 3
+ ],
+ "x-enum-varnames": [
+ "QueryTypeUnFinish",
+ "QueryTypeToday",
+ "QueryTypeFinished"
+ ]
},
"request.SendProcessParams": {
"type": "object",
@@ -1144,11 +1382,20 @@
}
}
},
+ "request.SetCurrentDevice": {
+ "type": "object",
+ "properties": {
+ "currentDeviceID": {
+ "description": "褰撳墠閫夊畾鐨勭敓浜ц澶�",
+ "type": "string"
+ }
+ }
+ },
"request.UpdatePlc": {
"type": "object",
"properties": {
"address": {
- "description": "PortName string ` + "`" + `gorm:\"type:varchar(191);comment:绔彛鍚嶇О\" json:\"portName\"` + "`" + `\nFrequency int ` + "`" + `gorm:\"comment:鏁版嵁鏇存柊棰戠巼 0-瀹炴椂鏇存柊 1-1娆�/绉抃" json:\"frequency\"` + "`" + `",
+ "description": "plc ip鍦板潃锛� method = modbusTCP鐢�",
"type": "string"
},
"baudRate": {
@@ -1158,11 +1405,25 @@
"brand": {
"type": "string"
},
+ "createdAt": {
+ "type": "string"
+ },
+ "dataBit": {
+ "description": "鏁版嵁浣嶏紝method = modbusRTU 鐢�",
+ "type": "integer"
+ },
+ "deletedAt": {
+ "type": "string"
+ },
"details": {
"type": "array",
"items": {
"$ref": "#/definitions/model.DevicePlcAddress"
}
+ },
+ "deviceID": {
+ "description": "璁惧缂栧彿",
+ "type": "string"
},
"id": {
"type": "integer"
@@ -1173,6 +1434,14 @@
"method": {
"$ref": "#/definitions/constvar.PlcMethod"
},
+ "parity": {
+ "description": "鏍￠獙鏂瑰紡锛宮ethod = modbusRTU 鐢�",
+ "allOf": [
+ {
+ "$ref": "#/definitions/constvar.Parity"
+ }
+ ]
+ },
"port": {
"description": "plc 绔彛鍙凤紝 method = modbusTCP鐢�",
"type": "integer"
@@ -1180,17 +1449,53 @@
"serialName": {
"description": "涓插彛鍚嶇О锛宮ethod = serial鏃� 鐢�",
"type": "string"
+ },
+ "stopBit": {
+ "description": "鍋滄浣嶏紝method = modbusRTU 鐢�",
+ "type": "integer"
+ },
+ "updatedAt": {
+ "type": "string"
}
}
},
"request.UpdatePlcBrand": {
"type": "object",
"properties": {
+ "createdAt": {
+ "type": "string"
+ },
+ "deletedAt": {
+ "type": "string"
+ },
"id": {
"type": "integer"
},
"name": {
"type": "string"
+ },
+ "updatedAt": {
+ "type": "string"
+ }
+ }
+ },
+ "response.DeviceListResponse": {
+ "type": "object",
+ "properties": {
+ "currentDeviceID": {
+ "description": "褰撳墠閫夊畾鐨勭敓浜ц澶�",
+ "type": "string"
+ },
+ "deviceIDList": {
+ "description": "鐢熶骇璁惧id鍒楄〃",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "systemDeviceID": {
+ "description": "宸ユ帶鏈鸿澶嘔D",
+ "type": "string"
}
}
},
--
Gitblit v1.8.0