update doc

zhangqian

2023-11-01 803c72123fc14274c7a09f6eb0d6076d24afda3f

 docs/swagger.yaml

@@ -74,15 +74,31 @@
      safeProduce:
        type: string
    type: object
  constvar.Parity:
    enum:
    - 1
    - 2
    - 3
    type: integer
    x-enum-comments:
      ParityEven: 奇校验
      ParityNull: 无校验
      ParityOdd: 偶校验
    x-enum-varnames:
    - ParityEven
    - ParityOdd
    - ParityNull
  constvar.PlcMethod:
    enum:
    - modbusTCP
    - modbusRTU
    - serial
    - 网络
    - 串口
    type: string
    x-enum-varnames:
    - PlcMethodModbusTCP
    - PlcMethodModbusRTU
    - PlcMethodSerial
    - PlcMethodModbusTCPChinese
    - PlcMethodSerialChinese
@@ -127,30 +143,47 @@
  model.DevicePlc:
    properties:
      address:
        description: |-
          PortName   string `gorm:"type:varchar(191);comment:端口名称" json:"portName"`
          Frequency  int    `gorm:"comment:数据更新频率 0-实时更新 1-1次/秒" json:"frequency"`
        description: plc ip地址， method = modbusTCP用
        type: string
      baudRate:
        description: 串口波特率， method = serial时 用
        type: integer
      brand:
        type: string
      createdAt:
        type: string
      dataBit:
        description: 数据位，method = modbusRTU 用
        type: integer
      deletedAt:
        type: string
      details:
        items:
          $ref: '#/definitions/model.DevicePlcAddress'
        type: array
      deviceID:
        description: 设备编号
        type: string
      id:
        type: integer
      isOpen:
        type: boolean
      method:
        $ref: '#/definitions/constvar.PlcMethod'
      parity:
        allOf:
        - $ref: '#/definitions/constvar.Parity'
        description: 校验方式，method = modbusRTU 用
      port:
        description: plc 端口号，  method =  modbusTCP用
        type: integer
      serialName:
        description: 串口名称，method = serial时 用
        type: string
      stopBit:
        description: 停止位，method = modbusRTU 用
        type: integer
      updatedAt:
        type: string
    type: object
  model.DevicePlcAddress:
@@ -175,6 +208,10 @@
    type: object
  model.NetConfig:
    properties:
      createdAt:
        type: string
      deletedAt:
        type: string
      dns:
        description: dns
        type: string
@@ -196,6 +233,8 @@
        allOf:
        - $ref: '#/definitions/model.NetConfigStatus'
        description: 状态（1启用2禁用）
      updatedAt:
        type: string
    required:
    - gateway
    - ip
@@ -217,11 +256,17 @@
    properties:
      amount:
        type: number
      createdAt:
        type: string
      customer:
        type: string
      deletedAt:
        type: string
      deliverDate:
        type: string
      endTime:
        type: integer
      id:
        type: integer
      orderAttr:
        description: 订单属性拼接的字符串，即货物描述
@@ -240,6 +285,8 @@
        $ref: '#/definitions/model.OrderStatus'
      unit:
        type: string
      updatedAt:
        type: string
      workOrderId:
        type: string
    type: object
@@ -255,9 +302,15 @@
    - OrderStatusFinished
  model.PlcBrand:
    properties:
      createdAt:
        type: string
      deletedAt:
        type: string
      id:
        type: integer
      name:
        type: string
      updatedAt:
        type: string
    type: object
  model.ProcedureStatus:
@@ -275,6 +328,10 @@
      channel:
        description: 通道
        type: integer
      createdAt:
        type: string
      deletedAt:
        type: string
      deviceId:
        type: string
      endTime:
@@ -290,16 +347,28 @@
      processModelNumber:
        description: 工艺模型编号
        type: string
      realEndTime:
        type: integer
      realStartTime:
        type: integer
      startTime:
        type: integer
      status:
        $ref: '#/definitions/model.ProcedureStatus'
      updatedAt:
        type: string
    type: object
  model.ProcessModel:
    properties:
      createdAt:
        type: string
      deletedAt:
        type: string
      deviceId:
        description: 用于过滤获取nsq消息
        type: string
      id:
        type: integer
      isUpdate:
        description: 前端用
        type: boolean
@@ -322,14 +391,32 @@
      product:
        description: 产品名称
        type: string
      updatedAt:
        type: string
    type: object
  request.AddPlcBrand:
    properties:
      createdAt:
        type: string
      deletedAt:
        type: string
      id:
        type: integer
      name:
        type: string
      updatedAt:
        type: string
    type: object
  request.QueryType:
    enum:
    - 1
    - 2
    - 3
    type: integer
    x-enum-varnames:
    - QueryTypeUnFinish
    - QueryTypeToday
    - QueryTypeFinished
  request.SendProcessParams:
    properties:
      procedureId:
@@ -337,40 +424,83 @@
    required:
    - procedureId
    type: object
  request.SetCurrentDevice:
    properties:
      currentDeviceID:
        description: 当前选定的生产设备
        type: string
    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"`
        description: plc ip地址， method = modbusTCP用
        type: string
      baudRate:
        description: 串口波特率， method = serial时 用
        type: integer
      brand:
        type: string
      createdAt:
        type: string
      dataBit:
        description: 数据位，method = modbusRTU 用
        type: integer
      deletedAt:
        type: string
      details:
        items:
          $ref: '#/definitions/model.DevicePlcAddress'
        type: array
      deviceID:
        description: 设备编号
        type: string
      id:
        type: integer
      isOpen:
        type: boolean
      method:
        $ref: '#/definitions/constvar.PlcMethod'
      parity:
        allOf:
        - $ref: '#/definitions/constvar.Parity'
        description: 校验方式，method = modbusRTU 用
      port:
        description: plc 端口号，  method =  modbusTCP用
        type: integer
      serialName:
        description: 串口名称，method = serial时 用
        type: string
      stopBit:
        description: 停止位，method = modbusRTU 用
        type: integer
      updatedAt:
        type: string
    type: object
  request.UpdatePlcBrand:
    properties:
      createdAt:
        type: string
      deletedAt:
        type: string
      id:
        type: integer
      name:
        type: string
      updatedAt:
        type: string
    type: object
  response.DeviceListResponse:
    properties:
      currentDeviceID:
        description: 当前选定的生产设备
        type: string
      deviceIDList:
        description: 生产设备id列表
        items:
          type: string
        type: array
      systemDeviceID:
        description: 工控机设备ID
        type: string
    type: object
  response.ListResponse:
@@ -543,6 +673,42 @@
      summary: 更新plc配置
      tags:
      - Config
  /v1/device/list:
    post:
      produces:
      - application/json
      responses:
        "200":
          description: 成功
          schema:
            allOf:
            - $ref: '#/definitions/contextx.Response'
            - properties:
                data:
                  $ref: '#/definitions/response.DeviceListResponse'
              type: object
      summary: 获取当前面板绑定的设备列表
      tags:
      - Device
  /v1/device/set:
    post:
      parameters:
      - description: 查询参数
        in: body
        name: object
        required: true
        schema:
          $ref: '#/definitions/request.SetCurrentDevice'
      produces:
      - application/json
      responses:
        "200":
          description: 成功
          schema:
            $ref: '#/definitions/contextx.Response'
      summary: 设置当前设备id
      tags:
      - 设备
  /v1/plc/productProgress:
    post:
      parameters:
@@ -565,23 +731,6 @@
                  $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:
@@ -747,6 +896,9 @@
  /v1/task/get:
    get:
      parameters:
      - in: query
        name: deviceID
        type: string
      - description: 页码
        in: query
        name: page
@@ -785,6 +937,53 @@
      summary: 获取任务
      tags:
      - Task
  /v1/task/listByChannel:
    get:
      parameters:
      - description: 通道号。不传取全部的
        in: query
        name: channel
        type: integer
      - in: query
        name: deviceID
        type: string
      - description: 默认3
        in: query
        name: limit
        type: integer
      - description: 默认0
        in: query
        name: offset
        type: integer
      - description: 1 未完成 2 今天未完成 3 已完成
        enum:
        - 1
        - 2
        - 3
        in: query
        name: type
        type: integer
        x-enum-varnames:
        - QueryTypeUnFinish
        - QueryTypeToday
        - QueryTypeFinished
      produces:
      - application/json
      responses:
        "200":
          description: 成功
          schema:
            allOf:
            - $ref: '#/definitions/contextx.Response'
            - properties:
                data:
                  additionalProperties:
                    $ref: '#/definitions/response.TaskResponse'
                  type: object
              type: object
      summary: 获取任务列表2
      tags:
      - Task
  /v1/task/sendProcessParams:
    post:
      parameters: