zhangqian
2023-09-27 4db8b372c61025a80af529a47872a6fec6daf854
docs/swagger.yaml
@@ -25,6 +25,14 @@
    type: object
  common.ProductProcedure:
    properties:
      allProcedureNames:
        description: 所属工单工序列表
        items:
          type: string
        type: array
      channel:
        description: 通道序号
        type: integer
      deviceId:
        type: string
      deviceName:
@@ -59,14 +67,55 @@
          $ref: '#/definitions/common.ProcedureWorker'
        type: array
    type: object
  conf.Prompt:
    properties:
      plcNotConnected:
        type: string
      safeProduce:
        type: string
    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
  constvar.TaskMode:
    enum:
    - 1
    - 2
    - 3
    type: integer
    x-enum-comments:
      TaskModeCurrent: 未开始的和进行中的
      TaskModeLastFinished: 上一个结束的
      TaskModeUnStarted: 未开始的
    x-enum-varnames:
    - TaskModeUnStarted
    - TaskModeCurrent
    - TaskModeLastFinished
  contextx.Response:
    properties:
      code:
@@ -80,7 +129,7 @@
      address:
        description: |-
          PortName   string `gorm:"type:varchar(191);comment:端口名称" json:"portName"`
          Frequency  int    `gorm:"type:int(11);comment:数据更新频率 0-实时更新 1-1次/秒" json:"frequency"`
          Frequency  int    `gorm:"comment:数据更新频率 0-实时更新 1-1次/秒" json:"frequency"`
        type: string
      baudRate:
        description: 串口波特率, method = serial时 用
@@ -106,9 +155,13 @@
    type: object
  model.DevicePlcAddress:
    properties:
      fieldName:
        description: 对应系统字段
      channel:
        description: 数据起始地址
        type: integer
      fieldName:
        allOf:
        - $ref: '#/definitions/constvar.PlcStartAddressType'
        description: 对应系统字段
      length:
        description: 数据长度
        type: integer
@@ -116,8 +169,9 @@
        description: 数据起始地址
        type: integer
      type:
        allOf:
        - $ref: '#/definitions/constvar.PlcStartAddressValueType'
        description: 数据类型
        type: string
    type: object
  model.NetConfig:
    properties:
@@ -193,9 +247,11 @@
    enum:
    - 1
    - 2
    - 3
    type: integer
    x-enum-varnames:
    - OrderStatusUnFinished
    - OrderStatusWaitProcess
    - OrderStatusProcessing
    - OrderStatusFinished
  model.PlcBrand:
    properties:
@@ -208,12 +264,19 @@
    enum:
    - 1
    - 2
    - 3
    type: integer
    x-enum-varnames:
    - ProcedureStatusUnFinished
    - ProcedureStatusWaitProcess
    - ProcedureStatusProcessing
    - ProcedureStatusFinished
  model.Procedures:
    properties:
      channel:
        description: 通道
        type: integer
      deviceId:
        type: string
      endTime:
        type: integer
      id:
@@ -222,6 +285,8 @@
        allOf:
        - $ref: '#/definitions/common.ProductProcedure'
        description: common.ProductProcedure  对象
      procedureId:
        type: string
      startTime:
        type: integer
      status:
@@ -234,12 +299,21 @@
      name:
        type: string
    type: object
  request.SendProcessParams:
    properties:
      channel:
        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:"type:int(11);comment:数据更新频率 0-实时更新 1-1次/秒" json:"frequency"`
          Frequency  int    `gorm:"comment:数据更新频率 0-实时更新 1-1次/秒" json:"frequency"`
        type: string
      baudRate:
        description: 串口波特率, method = serial时 用
@@ -299,17 +373,64 @@
    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
      allProcedures:
        items:
          type: string
        type: array
      canStarted:
        description: 是否可以开始生产
        type: boolean
      channel:
        description: 当前任务在设备第几个通道
        type: integer
      currentProcedureIndex:
        type: integer
      order:
        $ref: '#/definitions/model.Order'
      procedure:
        $ref: '#/definitions/model.Procedures'
    type: object
  response.TaskResponse:
    properties:
      channelAmount:
        description: 通道数量
        type: integer
      prompt:
        allOf:
        - $ref: '#/definitions/conf.Prompt'
        description: 提示语
      taskCount:
        description: 任务数量
        type: integer
      tasks:
        description: 任务列表
        items:
          $ref: '#/definitions/response.TaskData'
        type: array
      workers:
        description: 人员列表
        items:
          $ref: '#/definitions/common.ProcedureWorker'
        type: array
    type: object
info:
  contact: {}
@@ -394,7 +515,14 @@
      tags:
      - Config
  /v1/plc/productProgress:
    get:
    post:
      parameters:
      - description: 查询参数
        in: body
        name: object
        required: true
        schema:
          $ref: '#/definitions/request.SendProcessParams'
      produces:
      - application/json
      responses:
@@ -409,7 +537,36 @@
              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:
@@ -485,6 +642,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:
@@ -505,6 +679,30 @@
      - Task
  /v1/task/get:
    get:
      parameters:
      - description: 页码
        in: query
        name: page
        type: integer
      - description: 每页大小
        in: query
        name: pageSize
        type: integer
      - enum:
        - 1
        - 2
        - 3
        in: query
        name: taskMode
        type: integer
        x-enum-comments:
          TaskModeCurrent: 未开始的和进行中的
          TaskModeLastFinished: 上一个结束的
          TaskModeUnStarted: 未开始的
        x-enum-varnames:
        - TaskModeUnStarted
        - TaskModeCurrent
        - TaskModeLastFinished
      produces:
      - application/json
      responses:
@@ -515,19 +713,20 @@
            - $ref: '#/definitions/contextx.Response'
            - properties:
                data:
                  $ref: '#/definitions/response.TaskData'
                  $ref: '#/definitions/response.TaskResponse'
              type: object
      summary: 获取任务
      tags:
      - Task
  /v1/task/sendProcessParams/{id}:
  /v1/task/sendProcessParams:
    post:
      parameters:
      - description: 工序id
        in: path
        name: id
      - description: 查询参数
        in: body
        name: object
        required: true
        type: integer
        schema:
          $ref: '#/definitions/request.SendProcessParams'
      produces:
      - application/json
      responses:
@@ -535,7 +734,7 @@
          description: 成功
          schema:
            $ref: '#/definitions/contextx.Response'
      summary: 下发工艺参数
      summary: 下发工艺参数(开始任务)
      tags:
      - Task
  /v1/task/start/{id}:
@@ -558,7 +757,7 @@
                data:
                  $ref: '#/definitions/response.ProcessParamsResponse'
              type: object
      summary: 任务开始
      summary: 任务开始(获取工艺参数)
      tags:
      - Task
swagger: "2.0"