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

    下载盒子驱动

    • 接口功能

      下发盒子与PLC通讯的驱动程序,会覆盖已经下发的驱动。
      可以调用获取FBox驱动列表,然后拼接至Body中下发

    • 请求地址:(二选一)

      旧版:

      URL1: [apiBaseUrl]v2/box/device?boxNo={boxNo}

      URL2: [apiBaseUrl]v2/box/{boxId}/device

      新版:

      URL1:[Host Server]/api/v2/box/device?boxNo={boxNo}

      URL2:[Host Server]/api/v2/box/{boxId}/device

    • 地址参数说明

      字段名 类型 描述
      apiBaseUrl string 详情见名词解释
      boxNo string FBox序列号
      boxId Long FBox列表获取接口中boxRegs下box下id
    • 请求方式

      POST

    • Headers

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

      PLC驱动列表集合,单个驱动列表参数属性如下:

      字段名 类型 描述
      plcId int 驱动的Id,若一个FBox下挂载多个相同的PLC,则ID不唯一
      plcName string PLC名称
      alias string PLC别名(V2版接口通过他表示设备)
      type int 0:串口类型,2:网络类型
      advanced json对象 PLC配置高级参数,详细参考下表,若不配置可传入null.
      portNo int PLC编号,1:串口1,2:串口2,3:串口3,网络PLC无需传,服务器自动计算
      interface int 串口参数,接口类型,0:RS232,1:RS485_4,2:RS485_2,85:网络(串口1支持RS232、RS485_2和RS485_4,串口2仅支持RS485_2,串口3仅支持RS232)
      baudRate int 串口参数,波特率
      dataBits int 串口参数,数据位
      stopBits int 串口参数,停止位
      parityType int 串口参数,校验位
      class int 0:主设备,1:从设备,2:主从设备(目前不支持)
      ip string 网络PLC参数,IP地址
      port int 网络PLC参数,端口号
      enabledBroadcast boolean 是否启动广播站号
      broadcasetStationNo int 广播站号
      slaveNo int 从设备号

      advanced 对象属性:

      字段名 类型 参数描述
      plcResponseTimeout int 通讯超时参数
      protocolTimeout1 int 协议超时参数1
      protocolTimeout2 int 协议超时参数2
      maxPacketsWordReg int 字组包最大寄存器个数
      maxPacketsBitReg int 位组包最大寄存器个数
      assembleIntervalWordReg int 组包字寄存器间隔
      assembleIntervalBitReg int 组包位寄存器间隔
      protocolInterval int 通讯间隔时间(单位:s)
      byteOrder16 int 16位整数字节序 0:21,1:12
      byteOrder32 int 32位整数字节序 0:4321,1:3412,2:2143,3:1234
      byteOrderFloat int 32位浮点数字节序 0:4321,1:3412,2:2143,3:1234
      retryType int 重试类型,0:重试,1:切断
      errMsgDispTime int 提示信息持续时间
    • 响应成功

      NUll

    • 返回码

      字段名 参数描述
      200 执行成功
      400 错误信息在HTTP Header里[X-FBox-Code],详细见附录三
      401 accessToken过期
      404 接口不存在,请检查URL
    • Postman示例如下

    登录接口

    • 使用案例如下图

    登录接口

    Back to top Generated by DocFX