• 快速入门
  • HTTP文档
  • .NET开发指南
  • DEMO下载
  • 调用HTTP常见问题
    Show / Hide Table of Contents
    • 登录接口
      • 名词解释
      • 用户登录
      • 重新登录
    • 写值流程
      • 新增FBox分组
      • FBox新增
      • 新增监控点分组
      • 新增数据监控点
      • FBox列表获取
      • FBox监控点列表
      • 监控点值写入
      • 获取监控点值
    • 获取信息接口
      • 获取单个盒子
      • 获取监控点分组
      • 获取某些监控点
      • 根据监控点分组获取监控点
      • 获取物联网卡Iccid、Imei
      • 获取盒子地理位置
      • 获取HMI外部变量
    • 远程下载
      • 获取FBox驱动列表
      • 下载盒子驱动
      • 获取连接设备的寄存器类型
      • 获取服务器驱动列表
    • 盒子修改接口
      • 修改FBox分组
      • FBox名称修改
      • 修改数据监控点
      • 修改省流量模式刷新间隔
    • 盒子删除接口
      • 删除FBox分组
      • FBox删除
      • 删除监控点分组
      • 删除数据监控点
    • 报警接口
      • 报警分组接口
        • 获取报警分组列表
        • 新增报警分组
        • 修改报警分组
        • 删除报警分组
      • 报警联系人接口
        • 获取报警联系人列表
        • 获取单个报警联系人
        • 新增报警联系人
        • 修改报警联系人
        • 删除报警联系人
      • 报警记录接口
        • 获取报警条目列表
        • 获取某些报警条目
        • 新增报警条目
        • 修改报警条目
        • 删除报警条目
        • 获取报警历史
        • 获取报警条目状态
        • 确认报警
    • 历史记录接口
      • 获取历史记录条目
      • 获取某些历史记录条目
      • 新增历史记录
      • 更新历史记录
      • 删除历史记录
      • 获取历史记录数据
    • 监控点推送控制接口
      • 开启某监控点组别
      • 停止某监控点组别
      • 开启监控点组别列表
      • 停止监控点组别列表
      • 开启FBox所有监控点
      • 停止FBox所有监控点
      • 开启某条监控点
      • 停止某条监控点
      • 开启某些监控点
      • 停止某些监控点
      • 只开启某些监控点
      • 只开启某监控点组
      • 只开启某些监控点组
    • 数据推送(SignalR)
      • 实时数据推送(signalR)
      • FBox状态变更推送
      • 实时数据推送
      • 报警触发推送
      • 报警还原推送
    • 统一写值
      • 获取所有统一写分组
      • 统一写分组值写入
    • 附录
      • 附录一
      • 附录二
      • 附录三
      • 429状态码

    获取服务器驱动列表

    • 接口功能

      从服务器上拉取FBox支持的驱动

    • 请求地址:(二选一)

      旧版:

      URL:[apiBaseUrl]device/spec/{boxType}

      新版:

      URL:[Host Server]/api/device/spec/{boxType}

    • 地址参数说明

      字段名 类型 参数描述
      apiBaseUrl string 详情见名词解释
      boxType int FBox类型,0:标准盒子,1:mini盒子,2:Lite 3:VPN盒子
    • 请求方式

      GET

    • Headers

      字段名 类型 参数描述
      Authorization string Bearer+ 空格+登录接口中获得的access_token
    • Body

      NULL

    • 返回字段

      字段名 类型 参数描述
      id int 设备Id
      name string PLC名称
      defaultStationNo int 默认站号
      minStationNo int 最小站号
      maxStationNo int 最大站号
      class int 设备类型,0:其他,1:主设备,2:从设备
      comPortParams json对象 串口默认配置项,详情见下表
      ethParams json对象 以太网默认配置项,详情见下表
      byteOrders json对象 字节序信息,详情见下表
      supportedPlcs string数组 支持的PLC类型
      regs JSON数组 所支持的寄存器列表,详情见下表
      broadcastNo int 广播账号
      manufacturer string PLC厂家
      connType int 0:串口,1:以太网

      comPortParams对象属性:

      字段名 类型 参数描述
      baudRate int 串口波特率
      dataBits int 串口数据位
      stopBits int 串口停止位
      parity int 串口校验位
      workingMode int 工作模式,1:RS232,2:RS485_4,3:RS485_2
      plcResponseTimeout int 通讯超时时间
      protocolTimeout1 int 协议超时参数1
      protocolTimeout2 int 协议超时参数2
      maxPacketsWordReg int 字组包最大寄存器个数
      maxPacketsBitReg int 位组包最大寄存器个数
      assembleIntervalWordReg int 组包字寄存器间隔
      assembleIntervalBitReg int 组包位寄存器间隔
      protocolInterval int 通讯间隔时间

      ethParams对象属性:

      字段名 类型 参数描述
      ip string 网络参数,IP地址
      port int 通讯端口
      plcResponseTimeout int 通讯超时时间
      protocolTimeout1 int 协议超时参数1
      protocolTimeout2 int 协议超时参数2
      maxPacketsWordReg int 字组包最大寄存器个数
      maxPacketsBitReg int 位组包最大寄存器个数
      assembleIntervalWordReg int 组包字寄存器间隔
      assembleIntervalBitReg int 组包位寄存器间隔
      protocolInterval int 通讯间隔时间

      regs数组单个对象属性:

      字段名 类型 参数描述
      id int 寄存器ID, 对于同一个设备,此值不唯一,需要和Iowidth联合方可确定一个寄存器
      name string 寄存器名称
      ioWidth int 寄存器位宽,0:Bit,1:Byte,2:Word,3:DWord,4:QWord
      mainAddrWitdh int 主地址寻址方式0:Bit,1:Byte,2:Word,3:DWord,4:QWord
      minMainAddr int 最小主地址值
      maxMainAddr int 最大主地址值
      mainAddrType int 主地址进制类型0:无,8:8进制,10:10进制,16:16进制
      subAddrType int 子地址进制类型0:无,8:8进制,10:10进制,16:16进制
      subAddrLen int 子地址使用,使用方式如下:子地址最大值为2的subAddrLen次方减1如subAddrLen为3,则2的3次方为8,则子地址范围为0-7( [0,2^subAddrLen -1])
      subIndexType int DB块地址进制类型(一般西门子特有)0:无,8:8进制,10:10进制,16:16进制
      minSubIndex int 最小DB块地址
      maxSubIndex int 最大DB块地址

      byteOrders对象属性:

      字段名 类型 参数描述
      u16 int 0:21,1:12
      u32 int 0:4321,1:3412,2:2143,3:1234
      float int 0:4321,1:3412,2:2143,3:1234
    • 返回码

      字段名 参数描述
      401 accessToken过期
      404 接口不存在,请检查URL
    Back to top Generated by DocFX