• 快速入门
  • 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状态码

    获取HMI外部变量

    • 功能描述

      该接口用于用户获取天气状况,实时气温,空气质量等相关信息。

      注:不支持海外地址调用,只支持国内地址。

    • 请求地址:(二选一)

      URL1:[Host Server]/api/hmi/outside/variable?boxNo={boxNo}

      URL2:[Host Server]/api/hmi/{boxId}/outside/variable

    • 地址参数说明

      参数名 类型 参数描述
      Host Server string 详情见名词解释
    • 请求方式

      POST

    • Headers

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

      参数名 参数含义
      Aqi 空⽓质量指数
      Level 空⽓质量指数等级
      Category 空⽓质量指数级别
      Pm10 Pm10
      Pm25 Pm2.5
      No2 ⼆氧化氮
      So2 ⼆氧化硫
      Co ⼀氧化碳
      O3 臭氧
      Weather 天⽓现象(汉字描述)
      Temperature 实时⽓温
      Winddirection ⻛向描述
      WindPower ⻛⼒级别
      Humidity 空⽓湿度
    • 响应成功
      返回查询的参数集合JSON对象,单个对象属性如下

      参数名 类型 参数描述
      Status int 1:成功,2:设备未有经纬度,无法调用第三方接口,3:调用第三方接口失败,4:部分成功,部分失败,5: 其他错误
      variables array 变量的key-value
      address object 设备地址,省->市->区

      variables属性对象:

      参数名 类型 参数描述
      name string 传参名称
      value string 传参值

      address属性对象:

      参数名 类型 参数描述
      province string 设备地址,省级
      city string 设备地址,市级
      district string 设备地址,区级
    • 返回状态码

      参数名 参数描述
      401 accessToken过期
      500 接口实现错误
    • Postman调用示例

    Back to top Generated by DocFX