From 74f8cd07a39795656573d4e4bb2fe85a6dadbb8c Mon Sep 17 00:00:00 2001 From: zhangqian <zhangqian@123.com> Date: 星期六, 02 九月 2023 15:15:44 +0800 Subject: [PATCH] 从云端请求工艺参数,加入deviceId字段用于消息过滤 --- docs/swagger.yaml | 532 +++++++++++++++++++++++++++++++++++++++++++++++++++++----- 1 files changed, 480 insertions(+), 52 deletions(-) diff --git a/docs/swagger.yaml b/docs/swagger.yaml index dd25e9c..34d675d 100644 --- a/docs/swagger.yaml +++ b/docs/swagger.yaml @@ -1,4 +1,88 @@ definitions: + common.ProcedureMaterial: + properties: + amount: + type: number + materialId: + type: string + materialName: + type: string + unit: + type: string + type: object + common.ProcedureWorker: + properties: + endTime: + type: integer + phoneNum: + type: string + startTime: + type: integer + workerId: + type: string + workerName: + type: string + type: object + common.ProductProcedure: + properties: + deviceId: + type: string + deviceName: + type: string + endTime: + type: integer + inputMaterials: + description: 杈撳叆鐗╂枡鍒楄〃 + items: + $ref: '#/definitions/common.ProcedureMaterial' + type: array + nextProcedureId: + type: string + nextProcedureName: + type: string + outputMaterials: + description: 杈撳嚭鐗╂枡鍒楄〃 + items: + $ref: '#/definitions/common.ProcedureMaterial' + type: array + procedureId: + type: string + procedureName: + type: string + startTime: + type: integer + workHours: + type: number + workers: + description: 浜哄憳鍒楄〃 + items: + $ref: '#/definitions/common.ProcedureWorker' + type: array + type: object + constvar.PlcMethod: + enum: + - modbusTCP + - serial + type: string + x-enum-varnames: + - PlcMethodModbusTCP + - PlcMethodSerial + constvar.PlcStartAddressType: + enum: + - 1 + - 2 + type: integer + x-enum-varnames: + - PlcStartAddressTypeFinishNumber + - PlcStartAddressTypeTotalNumber + constvar.PlcStartAddressValueType: + enum: + - string + - int + type: string + x-enum-varnames: + - PlcStartAddressValueTypeString + - PlcStartAddressValueTypeInt contextx.Response: properties: code: @@ -7,6 +91,92 @@ msg: type: string type: object + model.DevicePlc: + properties: + address: + description: |- + PortName string `gorm:"type:varchar(191);comment:绔彛鍚嶇О" json:"portName"` + Frequency int `gorm:"type:int(11);comment:鏁版嵁鏇存柊棰戠巼 0-瀹炴椂鏇存柊 1-1娆�/绉�" json:"frequency"` + type: string + baudRate: + description: 涓插彛娉㈢壒鐜囷紝 method = serial鏃� 鐢� + type: integer + brand: + type: string + details: + items: + $ref: '#/definitions/model.DevicePlcAddress' + type: array + id: + type: integer + isOpen: + type: boolean + method: + $ref: '#/definitions/constvar.PlcMethod' + port: + description: plc 绔彛鍙凤紝 method = modbusTCP鐢� + type: integer + serialName: + description: 涓插彛鍚嶇О锛宮ethod = serial鏃� 鐢� + type: string + type: object + model.DevicePlcAddress: + properties: + fieldName: + allOf: + - $ref: '#/definitions/constvar.PlcStartAddressType' + description: 瀵瑰簲绯荤粺瀛楁 + length: + description: 鏁版嵁闀垮害 + type: integer + startAddress: + description: 鏁版嵁璧峰鍦板潃 + type: integer + type: + allOf: + - $ref: '#/definitions/constvar.PlcStartAddressValueType' + description: 鏁版嵁绫诲瀷 + type: object + model.NetConfig: + properties: + dns: + description: dns + type: string + gateway: + description: 缃戝叧 + type: string + id: + type: integer + ip: + description: 鏈満ip + type: string + mask: + description: 瀛愮綉鎺╃爜 + type: string + networkCard: + description: 缃戝崱 + type: string + status: + allOf: + - $ref: '#/definitions/model.NetConfigStatus' + description: 鐘舵�侊紙1鍚敤2绂佺敤锛� + required: + - gateway + - ip + - mask + - networkCard + type: object + model.NetConfigStatus: + enum: + - 1 + - 2 + type: integer + x-enum-comments: + NetConfigStatusDisabled: 鍏抽棴 + NetConfigStatusEnabled: 寮�鍚� + x-enum-varnames: + - NetConfigStatusEnabled + - NetConfigStatusDisabled model.Order: properties: amount: @@ -30,75 +200,103 @@ type: string startTime: type: integer + status: + $ref: '#/definitions/model.OrderStatus' unit: type: string workOrderId: type: string type: object + model.OrderStatus: + enum: + - 1 + - 2 + type: integer + x-enum-varnames: + - OrderStatusUnFinished + - OrderStatusFinished + model.PlcBrand: + properties: + id: + type: integer + name: + type: string + type: object + model.ProcedureStatus: + enum: + - 1 + - 2 + type: integer + x-enum-varnames: + - ProcedureStatusUnFinished + - ProcedureStatusFinished model.Procedures: properties: + endTime: + type: integer id: type: integer procedure: allOf: - - $ref: '#/definitions/request.ProductProcedure' - description: request.ProductProcedure 瀵硅薄 - type: object - request.ProcedureMaterial: - properties: - amount: - type: number - materialId: - type: string - materialName: - type: string - unit: - type: string - type: object - request.ProcedureWorker: - properties: - endTime: - type: integer - phoneNum: - type: string + - $ref: '#/definitions/common.ProductProcedure' + description: common.ProductProcedure 瀵硅薄 startTime: type: integer - workerId: - type: string - workerName: + status: + $ref: '#/definitions/model.ProcedureStatus' + type: object + request.AddPlcBrand: + properties: + id: + type: integer + name: type: string type: object - request.ProductProcedure: + request.UpdatePlc: properties: - deviceId: + address: + description: |- + PortName string `gorm:"type:varchar(191);comment:绔彛鍚嶇О" json:"portName"` + Frequency int `gorm:"type:int(11);comment:鏁版嵁鏇存柊棰戠巼 0-瀹炴椂鏇存柊 1-1娆�/绉�" json:"frequency"` type: string - deviceName: - type: string - endTime: + baudRate: + description: 涓插彛娉㈢壒鐜囷紝 method = serial鏃� 鐢� type: integer - inputMaterials: - description: 杈撳叆鐗╂枡鍒楄〃 - items: - $ref: '#/definitions/request.ProcedureMaterial' - type: array - outputMaterials: - description: 杈撳嚭鐗╂枡鍒楄〃 - items: - $ref: '#/definitions/request.ProcedureMaterial' - type: array - procedureId: + brand: type: string - procedureName: - type: string - startTime: + details: + items: + $ref: '#/definitions/model.DevicePlcAddress' + type: array + id: type: integer - workHours: - type: number - workers: - description: 浜哄憳鍒楄〃 - items: - $ref: '#/definitions/request.ProcedureWorker' - type: array + isOpen: + type: boolean + method: + $ref: '#/definitions/constvar.PlcMethod' + port: + description: plc 绔彛鍙凤紝 method = modbusTCP鐢� + type: integer + serialName: + description: 涓插彛鍚嶇О锛宮ethod = serial鏃� 鐢� + type: string + type: object + request.UpdatePlcBrand: + properties: + id: + type: integer + name: + type: string + type: object + response.ListResponse: + properties: + code: + type: integer + count: + type: integer + data: {} + msg: + type: string type: object response.ProcessParams: properties: @@ -106,8 +304,40 @@ type: string value: {} type: object + response.ProcessParamsResponse: + properties: + number: + type: string + params: + items: + $ref: '#/definitions/response.ProcessParams' + type: array + type: object + response.ProductProgress: + properties: + finishNumber: + type: integer + totalNumber: + type: integer + type: object + response.TaskCountdown: + properties: + countDownHour: + description: 鍊掕鏃� 鏃� + type: integer + countDownMinute: + description: 鍊掕鏃� 鍒� + type: integer + showCountDown: + description: 鏄惁灞曠ず鍊掕鏃� + type: boolean + type: object response.TaskData: properties: + deviceName: + type: string + deviceStatus: + type: string order: $ref: '#/definitions/model.Order' procedure: @@ -116,6 +346,206 @@ info: contact: {} paths: + /v1/config/net: + get: + produces: + - application/json + responses: + "200": + description: 鎴愬姛 + schema: + allOf: + - $ref: '#/definitions/contextx.Response' + - properties: + data: + items: + $ref: '#/definitions/model.NetConfig' + type: array + type: object + summary: 鑾峰彇缃戠粶閰嶇疆 + tags: + - Config + post: + parameters: + - description: 鍙傛暟 + in: body + name: object + required: true + schema: + $ref: '#/definitions/model.NetConfig' + produces: + - application/json + responses: + "200": + description: 鎴愬姛 + schema: + allOf: + - $ref: '#/definitions/contextx.Response' + - properties: + data: + items: + $ref: '#/definitions/response.ProcessParams' + type: array + type: object + summary: 璁剧疆缃戠粶閰嶇疆 + tags: + - Config + /v1/config/plc: + get: + produces: + - application/json + responses: + "200": + description: 鎴愬姛 + schema: + allOf: + - $ref: '#/definitions/contextx.Response' + - properties: + data: + $ref: '#/definitions/model.DevicePlc' + type: object + summary: 鑾峰彇plc閰嶇疆 + tags: + - Config + post: + parameters: + - description: 鏌ヨ鍙傛暟 + in: body + name: object + required: true + schema: + $ref: '#/definitions/request.UpdatePlc' + produces: + - application/json + responses: + "200": + description: OK + schema: + $ref: '#/definitions/contextx.Response' + summary: 鏇存柊plc閰嶇疆 + tags: + - Config + /v1/plc/productProgress: + get: + produces: + - application/json + responses: + "200": + description: 鎴愬姛 + schema: + allOf: + - $ref: '#/definitions/contextx.Response' + - properties: + data: + $ref: '#/definitions/response.ProductProgress' + type: object + summary: 鑾峰彇鐢熶骇杩涘害 + tags: + - 鐢熶骇鏁伴噺 + /v1/plc/setProductNumber: + post: + produces: + - application/json + responses: + "200": + description: 鎴愬姛 + schema: + $ref: '#/definitions/contextx.Response' + summary: 璁剧疆鐢熶骇鎬婚噺 + tags: + - 鐢熶骇鏁伴噺 + /v1/plcBrand/add: + post: + parameters: + - description: 鏌ヨ鍙傛暟 + in: body + name: object + required: true + schema: + $ref: '#/definitions/request.AddPlcBrand' + produces: + - application/json + responses: + "200": + description: OK + schema: + $ref: '#/definitions/contextx.Response' + summary: 娣诲姞plc鍝佺墝 + tags: + - plc鍝佺墝 + /v1/plcBrand/delete/{id}: + delete: + parameters: + - description: 鏌ヨ鍙傛暟 + in: path + name: id + required: true + type: integer + produces: + - application/json + responses: + "200": + description: OK + schema: + $ref: '#/definitions/contextx.Response' + summary: 鍒犻櫎plc鍝佺墝 + tags: + - plc鍝佺墝 + /v1/plcBrand/list: + get: + produces: + - application/json + responses: + "200": + description: OK + schema: + allOf: + - $ref: '#/definitions/response.ListResponse' + - properties: + data: + items: + $ref: '#/definitions/model.PlcBrand' + type: array + type: object + summary: 鑾峰彇plc鍝佺墝鍒楄〃 + tags: + - plc鍝佺墝 + /v1/plcBrand/update: + put: + parameters: + - description: 鏌ヨ鍙傛暟 + in: body + name: object + required: true + schema: + $ref: '#/definitions/request.UpdatePlcBrand' + produces: + - application/json + responses: + "200": + description: OK + schema: + $ref: '#/definitions/contextx.Response' + summary: 鏇存柊plc鍝佺墝 + tags: + - plc鍝佺墝 + /v1/task/countdown: + get: + produces: + - application/json + responses: + "200": + description: 鎴愬姛 + schema: + allOf: + - $ref: '#/definitions/contextx.Response' + - properties: + data: + $ref: '#/definitions/response.TaskCountdown' + type: object + summary: 鏂颁换鍔″�掕鏃� + tags: + - Task /v1/task/finish/{id}: put: parameters: @@ -187,9 +617,7 @@ - $ref: '#/definitions/contextx.Response' - properties: data: - items: - $ref: '#/definitions/response.ProcessParams' - type: array + $ref: '#/definitions/response.ProcessParamsResponse' type: object summary: 浠诲姟寮�濮� tags: -- Gitblit v1.8.0