1. 环境检测-环境总览

获取环境总览数据(实时数据),若未传递设备参数则获取项目中的第一个设备数据,传递了设备参数则返回对应设备的数据

注意

  • 如果接口需要提供auth-token,你需要通过轻筑开放平台创建应用来获取appid和secret,然后通过appid和secret来获取接口访问凭证auth-token。
  • 如果需要获取当前用户的使用信息,授权确保你能获取到qzcode,然后通过网页授权接口获取相关信息。

1.1. 基本信息

概况 内容
接口地址 /api/device/environment/info
请求方法 GET
请求数据类型 URL参数
响应数据类型 JSON

1.2. 请求数据

1.2.1. 请求头(request-header)

请求头除了默认的参数还需要添加如下请求头参数:

字段 描述
auth-token 接口访问凭据,你可以通过平台下发的appid和secret获取凭据

1.2.2. 请求参数(request-parameter)

字段 是否必传 描述
projectId 项目ID
deviceId 设备ID

参数请求示例:

http://api.example.com/xxx?key=value

1.3. 响应数据

响应数据中 code, message, data 为默认字段,所有字段如下表所示:

字段 类型 是否必填 描述
code number 响应码
message string 响应消息
data object 响应数据
standardWindSpeed string 风速
standardWindDirection string 风向
currentTemperature string 温度
standardPm10 string pm10
createTime number 监测时间
standardNoise string 噪音
standardPm25 string pm2.5
standardHumidity string 湿度
standardPressure string 气压
deviceId string 设备Id
code string 设备Code
name string 设备名称
alarmOrNot string 是否预警
alarmType string 当前预警类型(01-温度;02-风速;03-PM2.5;04-PM10;05-噪音;06-湿度;07-气压)
alarmReason string 预警原因(1:大于;2:小于)
threshold string 该项参数预警的临界值

响应数据结构如下所示:

{
    "code": 0,
    "message": null,
    "data": {
        "standardWindSpeed": "风速",
        "standardWindDirection": "风向",
        "currentTemperature": "温度",
        "standardPm10": "PM10",
        "createTime": "123456789",
        "standardNoise": "噪音",
        "standardPm25": "PM2.5",
        "standardHumidity": "湿度",
        "standardPressure": "气压",
        "deviceId": "xxxxxxxxxxxx",
        "code": "设备Code",
        "name": "设备名称",
        "alarmOrNot": "是否预警",
        "alarmType": "当前预警类型(01-温度;02-风速;03-PM2.5;04-PM10;05-噪音;06-湿度;07-气压)",
        "alarmReason": "预警原因(1:大于;2:小于)",
        "threshold": "该项参数预警的临界值"
    }
}

1.4. 错误码

当返回数据中的 code 不为 0 时,为错误返回。其中errCode为详细的错误码。

© All Rights Reserved            updated 2024-08-23 10:14:55

results matching ""

    No results matching ""