zhangqian
2023-09-22 71cc6deae4b873c3382895054fe2bd6816290755
docs/swagger.yaml
@@ -25,6 +25,11 @@
    type: object
  common.ProductProcedure:
    properties:
      allProcedureNames:
        description: 所属工单工序列表
        items:
          type: string
        type: array
      deviceId:
        type: string
      deviceName:
@@ -36,6 +41,10 @@
        items:
          $ref: '#/definitions/common.ProcedureMaterial'
        type: array
      nextProcedureId:
        type: string
      nextProcedureName:
        type: string
      outputMaterials:
        description: 输出物料列表
        items:
@@ -55,6 +64,34 @@
          $ref: '#/definitions/common.ProcedureWorker'
        type: array
    type: object
  constvar.PlcMethod:
    enum:
    - modbusTCP
    - serial
    - 网络
    - 串口
    type: string
    x-enum-varnames:
    - PlcMethodModbusTCP
    - PlcMethodSerial
    - PlcMethodModbusTCPChinese
    - PlcMethodSerialChinese
  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:
@@ -62,6 +99,55 @@
      data: {}
      msg:
        type: string
    type: object
  model.DevicePlc:
    properties:
      address:
        description: |-
          PortName   string `gorm:"type:varchar(191);comment:端口名称" json:"portName"`
          Frequency  int    `gorm:"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: 串口名称,method = serial时 用
        type: string
    type: object
  model.DevicePlcAddress:
    properties:
      fieldName:
        allOf:
        - $ref: '#/definitions/constvar.PlcStartAddressType'
        description: 对应系统字段
      length:
        description: 数据长度
        type: integer
      position:
        description: 数据起始地址
        type: integer
      startAddress:
        description: 数据起始地址
        type: integer
      type:
        allOf:
        - $ref: '#/definitions/constvar.PlcStartAddressValueType'
        description: 数据类型
    type: object
  model.NetConfig:
    properties:
@@ -137,9 +223,11 @@
    enum:
    - 1
    - 2
    - 3
    type: integer
    x-enum-varnames:
    - OrderStatusUnFinished
    - OrderStatusWaitProcess
    - OrderStatusProcessing
    - OrderStatusFinished
  model.PlcBrand:
    properties:
@@ -152,20 +240,29 @@
    enum:
    - 1
    - 2
    - 3
    type: integer
    x-enum-varnames:
    - ProcedureStatusUnFinished
    - ProcedureStatusWaitProcess
    - ProcedureStatusProcessing
    - ProcedureStatusFinished
  model.Procedures:
    properties:
      deviceId:
        type: string
      endTime:
        type: integer
      id:
        type: integer
      position:
        description: 每个设备可能有多个机位同时生产,用position表示位置
        type: integer
      procedure:
        allOf:
        - $ref: '#/definitions/common.ProductProcedure'
        description: common.ProductProcedure  对象
      procedureId:
        type: string
      startTime:
        type: integer
      status:
@@ -176,6 +273,44 @@
      id:
        type: integer
      name:
        type: string
    type: object
  request.SendProcessParams:
    properties:
      position:
        type: integer
      procedureId:
        type: integer
    required:
    - procedureId
    type: object
  request.UpdatePlc:
    properties:
      address:
        description: |-
          PortName   string `gorm:"type:varchar(191);comment:端口名称" json:"portName"`
          Frequency  int    `gorm:"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: 串口名称,method = serial时 用
        type: string
    type: object
  request.UpdatePlcBrand:
@@ -201,66 +336,58 @@
        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
      plcStatus:
        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
      nextProcedure:
        $ref: '#/definitions/model.Procedures'
      allProcedures:
        items:
          type: string
        type: array
      canStarted:
        description: 是否可以开始生产
        type: boolean
      currentProcedureIndex:
        type: integer
      order:
        $ref: '#/definitions/model.Order'
      position:
        description: 当前任务在设备第几个位置
        type: integer
      procedure:
        $ref: '#/definitions/model.Procedures'
    type: object
info:
  contact: {}
paths:
  /v1/cc/nn:
    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
    put:
      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/net:
    get:
      produces:
@@ -280,7 +407,7 @@
      summary: 获取网络配置
      tags:
      - Config
    put:
    post:
      parameters:
      - description: 参数
        in: body
@@ -305,6 +432,94 @@
      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:
    post:
      parameters:
      - description: 查询参数
        in: body
        name: object
        required: true
        schema:
          $ref: '#/definitions/request.SendProcessParams'
      produces:
      - application/json
      responses:
        "200":
          description: 成功
          schema:
            allOf:
            - $ref: '#/definitions/contextx.Response'
            - properties:
                data:
                  $ref: '#/definitions/response.ProductProgress'
              type: object
      summary: 获取生产进度
      tags:
      - 生产数量
  /v1/plc/productProgressRealTime:
    post:
      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:
@@ -380,6 +595,23 @@
      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:
@@ -400,6 +632,15 @@
      - Task
  /v1/task/get:
    get:
      parameters:
      - description: 页码
        in: query
        name: page
        type: integer
      - description: 每页大小
        in: query
        name: pageSize
        type: integer
      produces:
      - application/json
      responses:
@@ -415,13 +656,16 @@
      summary: 获取任务
      tags:
      - Task
  /v1/task/sendProcessParams/{id}:
    post:
  /v1/task/get/unStarted:
    get:
      parameters:
      - description: 工序id
        in: path
        name: id
        required: true
      - description: 页码
        in: query
        name: page
        type: integer
      - description: 每页大小
        in: query
        name: pageSize
        type: integer
      produces:
      - application/json
@@ -429,8 +673,32 @@
        "200":
          description: 成功
          schema:
            allOf:
            - $ref: '#/definitions/contextx.Response'
            - properties:
                data:
                  $ref: '#/definitions/response.TaskData'
              type: object
      summary: 获取未开始的任务
      tags:
      - Task
  /v1/task/sendProcessParams:
    post:
      parameters:
      - description: 查询参数
        in: body
        name: object
        required: true
        schema:
          $ref: '#/definitions/request.SendProcessParams'
      produces:
      - application/json
      responses:
        "200":
          description: 成功
          schema:
            $ref: '#/definitions/contextx.Response'
      summary: 下发工艺参数
      summary: 下发工艺参数(开始任务)
      tags:
      - Task
  /v1/task/start/{id}:
@@ -451,11 +719,9 @@
            - $ref: '#/definitions/contextx.Response'
            - properties:
                data:
                  items:
                    $ref: '#/definitions/response.ProcessParams'
                  type: array
                  $ref: '#/definitions/response.ProcessParamsResponse'
              type: object
      summary: 任务开始
      summary: 任务开始(获取工艺参数)
      tags:
      - Task
swagger: "2.0"