欢迎进入厦门欣仰邦科技有限公司官网！
  • 电话图标
0592-3564822
智能报导
智能报导
联系方式

企业服务热线：0592-3564822 0592-3564822

公司电话 : 0592-3564822

业务咨询 : 17850532774

开发文档

主页 > 关于我们 > 智能报导 > 开发文档 >

欣仰邦墒情、苗情、虫情、灾情农业四情测报平台接口说明书

发布时间:2021-12-17 来源:开发文档 作者:xmsiyb
 

一、统一说明

1、通讯方式
数据接口采用http协议，通讯内容采用JSON数据格式。
接口返回数据格式如下：
{"code":1001, "message":"信息内容", "data":object}
 
ResultData字段说明
字段 类型 说明
code Integer 代码(参考返回代码说明表)
message String 返回操作结果描述
data Json Json数据，具体格式参考各个接口
 
文档中所有接口的返回数据说明表，如无特殊说明均为ResultData数据格式，返回的数据均存放于data字段中
  1. 接口调用注意事项：
           调用接口（除登录接口外）需要将token写入http请求头中。请求头字段名     固定为token，字段值可通过登录接口获取。
           接口中如无特殊说明，采用post方法的接口中参数为json格式；采用get方法的接口    中参数为查询参数，放入请求地址后
  2. 接口地址
正式接口地址： http://farm.0531yun.cn

二、接口详细

1、登录操作

1.1 登录

1.1.1接口描述

接口编号 1.1
接口名称 登录接口
功能描述 用户登录
接口地址 /customUser/Login
请求方式 POST
参数格式 JSON
返回数据格式 JSON
备注  
表1.1.1.1

1.1.2请求参数说明

字段 类型 说明
loginName String 登录名
loginPwd String 密码
表1.1.2.1

1.1.3返回数据说明

参数名 类型 说明
code string 1000,”登录成功”
message string 无
data object 无
token string token
expDate string token过期时间
currDate string token开始时间
loginSign string 登录标识
表1.1.3.1

1.1.4返回格式示例

{
  "code": 1000,
  "data": {
    "token": "eyJhbGciOiJIUzI1NiJ9.eyJsb2dpbm5hbWUiOiJtYXN0ZXIiLCJleHAiOjE2MjA2NDIyMDIsInVzZXJpZCI6IjAiLCJpYXQiOjE2MjA2MzUwMDIsImp0aSI6InRva2VuSWQifQ.pUgt6TnUznLIbUi-aXkqsOMpXcaenviMacxD5TaLcXA",
    "expDate": 1620642202287,
    "currDate": 1620635002287,
    "loginSign": "0"
  },
  "message": "登录成功"
}

2、区域操作

2.1 用户区域分组

2.1.1接口描述

 
接口编号 2.1
接口名称 用户区域分组
功能描述 获取用户区域分组
接口地址 /UserGroup/UserGroup
请求方式 get
参数格式 JSON
返回数据格式 JSON
备注  
表2.1.1.1

2.1.2请求参数说明

2.1.2.1请求头Header参数
header 必选 类型 说明
token 是 string token
表2.1.2.1.1

2.1.3返回数据说明

参数名 类型 说明
code string 1000,”操作成功”
message string 无
data array 无
groupId string 区域id
groupName string 区域名称
createTime string 无
remark string 备注
deviceDOS array 设备信息
deviceAddr string 虫情设备地址码
deviceType string 设备类型 0:虫情设备，1:气象设备，2:摄像头，3:墒情设备4:孢子分析设备 5灌溉设备
deviceName string 设备名称
lng string 经度
lat string 纬度
saveDateInterval string 数据保存间隔
offlineInterval string 离线判断间隔
httpUrl object 摄像头httpUrl
rtmpUrl object 摄像头rtmpUrl
city object 城市
表2.1.3.1

2.1.4返回格式示例

{
  "code": 1000,
  "data": [
    {
      "groupId": "0F47931769AEE0B414700782E3F3FA72",
      "groupName": "测试",
      "createTime": 1620700613000,
      "remark": "测试",
      "deviceDOS": [
        {
          "deviceAddr": "12345602",
          "deviceType": 0,
          "deviceName": "12345602",
          "lng": 0,
          "lat": 0,
          "saveDateInterval": 5,
          "offlineInterval": 5,
          "groupId": "0F47931769AEE0B414700782E3F3FA72",
          "httpUrl": null,
          "rtmpUrl": null,
          "city": null,
          "createTime": 1619576457000
        }
      ]
    }
  ],
  "message": "操作成功"
}

3.设备操作

3.1 获取气象设备详细信息

3.1.1 接口描述

接口编号 3.1
接口名称 获取气象设备详细信息
功能描述 获取气象设备详细信息
接口地址 /UserDevice/UserDeviceParticulars
请求方式 get
参数格式 JSON
返回数据格式 JSON
备注  
表3.1.1.1

3.1.2 请求参数说明

3.1.2.1 请求头Header参数
header 必选 类型 说明
token 是 string token
表3.1.2.1.1
3.1.2.2 请求参数
字段 必选 类型 说明
deviceAddr 是 string 无
表3.1.2.2.1

3.1.3 返回数据说明

字段 类型 说明
code string 1000,”操作成功”
message string 无
data array 无
termId string 节点id
termName string 节点名称
termNo string 节点编号
enabled string 节点使能，0关闭，1开启
deviceAddr string 设备地址id
level string 优先级
nodeType string //1: 模拟量1使能模拟量2使能 //2: 模拟量1使能模拟量2禁用 //3: 模拟量1禁用模拟量2使能 //4: 浮点型设备 //5: 开关量型设备 //6: 32位有符号整形 //7: 32位无符号整形 //8:遥调设备
temName string 模拟量1名称
humName string 模拟量2名称
temTag string 模拟量1单位
humTag string 模拟量2单位
temCoefficient string 模拟量1系数
humCoefficient string 模拟量2系数
temOffset string 模拟量1偏差
humOffset string 模拟量2偏差
temMax string 温度上限值
temMin string 温度下限值
humMax string 湿度上限值
humMin string 湿度下限值
digits string 小数位数
switchOnText string 开关量闭合内容
switchOffText string 开关量断开内容
switchAlarmType string 开关量报警类型（0 不报警 1闭合报警 2断开报警）
weatherTermRegualtingDOS array 无
regularNo string 档位
regularValue string 值
regularText string 显示内容
alarm string 报警开关，0不报警，1报警
regulatingId string 无
表3.1.3.1

3.1.4 返回格式示例

{
  "code": 1000,
  "data": [
    {
      "termId": 1,
      "termName": "测试节点",
      "termNo": 1,
      "enabled": 1,
      "deviceAddr": "10000001",
      "level": 2,
      "nodeType": 5,
      "temName": "11",
      "humName": "湿度",
      "temTag": "℃",
      "humTag": "%RH",
      "temCoefficient": 0.1,
      "humCoefficient": 0,
      "temOffset": 0.1,
      "humOffset": 0,
      "temMax": 50,
      "temMin": 10,
      "humMax": 100,
      "humMin": 0,
      "digits": 2,
      "switchOnText": "12",
      "switchOffText": "23",
      "switchAlarmType": 2,
      "weatherTermRegualtingDOS": []
    },
    {
      "termId": 8,
      "termName": "节点8",
      "termNo": 8,
      "enabled": 0,
      "deviceAddr": "10000001",
      "level": 6,
      "nodeType": 8,
      "temName": "测试测试遥调",
      "humName": "湿度",
      "temTag": "℃",
      "humTag": "%RH",
      "temCoefficient": 0.1,
      "humCoefficient": 0.2,
      "temOffset": 0,
      "humOffset": 1,
      "temMax": 100,
      "temMin": 0,
      "humMax": 200,
      "humMin": 10,
      "digits": 1,
      "switchOnText": "",
      "switchOffText": "",
      "switchAlarmType": 0,
      "weatherTermRegualtingDOS": [
        {
          "regulatingId": 377,
          "termId": null,
          "regularNo": 14,
          "regularValue": 13,
          "regularText": "",
          "alarm": 0,
          "deviceAddr": null
        },
        {
          "regulatingId": 376,
          "termId": null,
          "regularNo": 13,
          "regularValue": 12,
          "regularText": "",
          "alarm": 0,
          "deviceAddr": null
        },
        {
          "regulatingId": 375,
          "termId": null,
          "regularNo": 12,
          "regularValue": 11,
          "regularText": "",
          "alarm": 0,
          "deviceAddr": null
        },
        {
          "regulatingId": 374,
          "termId": null,
          "regularNo": 11,
          "regularValue": 10,
          "regularText": "",
          "alarm": 0,
          "deviceAddr": null
        },
        {
          "regulatingId": 373,
          "termId": null,
          "regularNo": 10,
          "regularValue": 9,
          "regularText": "",
          "alarm": 0,
          "deviceAddr": null
        },
        {
          "regulatingId": 372,
          "termId": null,
          "regularNo": 9,
          "regularValue": 8,
          "regularText": "",
          "alarm": 0,
          "deviceAddr": null
        },
        {
          "regulatingId": 371,
          "termId": null,
          "regularNo": 8,
          "regularValue": 7,
          "regularText": "西北风",
          "alarm": 0,
          "deviceAddr": null
        },
        {
          "regulatingId": 370,
          "termId": null,
          "regularNo": 7,
          "regularValue": 6,
          "regularText": "西风",
          "alarm": 0,
          "deviceAddr": null
        },
        {
          "regulatingId": 369,
          "termId": null,
          "regularNo": 6,
          "regularValue": 5,
          "regularText": "西南风",
          "alarm": 0,
          "deviceAddr": null
        },
        {
          "regulatingId": 368,
          "termId": null,
          "regularNo": 5,
          "regularValue": 4,
          "regularText": "南风",
          "alarm": 0,
          "deviceAddr": null
        },
        {
          "regulatingId": 367,
          "termId": null,
          "regularNo": 4,
          "regularValue": 3,
          "regularText": "东南风",
          "alarm": 0,
          "deviceAddr": null
        },
        {
          "regulatingId": 366,
          "termId": null,
          "regularNo": 3,
          "regularValue": 2,
          "regularText": "东北风",
          "alarm": 0,
          "deviceAddr": null
        },
        {
          "regulatingId": 365,
          "termId": null,
          "regularNo": 2,
          "regularValue": 1,
          "regularText": "东风",
          "alarm": 0,
          "deviceAddr": null
        },
        {
          "regulatingId": 364,
          "termId": null,
          "regularNo": 1,
          "regularValue": 0,
          "regularText": "北风",
          "alarm": 1,
          "deviceAddr": null
        },
        {
          "regulatingId": 378,
          "termId": null,
          "regularNo": 15,
          "regularValue": 14,
          "regularText": "",
          "alarm": 0,
          "deviceAddr": null
        }
      ]
    },
    {
      "termId": 9,
      "termName": "节点9",
      "termNo": 9,
      "enabled": 1,
      "deviceAddr": "10000001",
      "level": 0,
      "nodeType": 5,
      "temName": "温度",
      "humName": "湿度",
      "temTag": "℃",
      "humTag": "%RH",
      "temCoefficient": 0.1,
      "humCoefficient": 0.1,
      "temOffset": 0,
      "humOffset": 0,
      "temMax": 100,
      "temMin": 0,
      "humMax": 100,
      "humMin": 0,
      "digits": 2,
      "switchOnText": "1",
      "switchOffText": "1",
      "switchAlarmType": 0,
      "weatherTermRegualtingDOS": []
    }
  ],
  "message": "操作成功"
}
 
 

3.2 获取设备信息历史记录

3.2.1接口描述

接口编号 3.2
接口名称 获取设备信息历史记录
功能描述 获取设备信息历史记录
接口地址 /UserDevice/WeatherDeviceHistory
请求方式 get
参数格式 JSON
返回数据格式 JSON
备注  
表3.2.1.1

3.2.2 请求参数说明

3.2.2.1 请求头Header参数
header 必选 类型 说明
token 是 string token
表3.2.2.1.1
3.2.2.2 请求参数
字段 必选 类型 说明
deviceAddr 是 string 设备地址
startTime 是 string 开始时间
endTime 是 string 结束时间
表3.2.2.2.1

3.2.3 返回数据说明

字段 类型 说明
code string 无
message string 无
data array 无
id string 无
deviceAddr string 设备地址ID
termId string 节点ID
tem string 模拟量1
hum string 模拟量2
createTime string 时间
isAlarm string //0:正常 //1:报警
表3.2.3.1

3.2.4 返回格式示例

{
  "code": 1000,
  "data": [
    {
      "id": 14,
      "deviceAddr": "10000001",
      "termId": 1,
      "tem": "100",
      "hum": "100",
      "createTime": 1618365553000,
      "isAlarm": 1
    },
    {
      "id": 12,
      "deviceAddr": "10000001",
      "termId": 1,
      "tem": "50",
      "hum": "23.3",
      "createTime": 1618365689000,
      "isAlarm": 1
    },
    {
      "id": 15,
      "deviceAddr": "10000001",
      "termId": 1,
      "tem": "1",
      "hum": "20.3",
      "createTime": 1618367552000,
      "isAlarm": 0
    }
  ],
  "message": "操作成功"
}

3.3 获取虫情设备历史记录

3.3.1 接口描述

接口编号 3.3
接口名称 获取虫情设备历史记录
功能描述 获取虫情设备历史记录
接口地址 /UserDevice/WormDeviceHistory
请求方式 get
参数格式 JSON
返回数据格式 JSON
备注  
表3.3.1.1

3.3.2 请求参数说明

3.3.2.1 请求头Header参数
header 必选 类型 说明
token 是 string token
表3.3.2.1.1
3.3.2.2 请求参数
字段 必选 类型 说明
deviceAddr 是 string 设备地址
startTime 是 string 开始时间
endTime 是 string 结束时间
表3.3.2.2.1

3.3.3 返回数据说明

字段 类型 说明
code string 无
message string 无
data array 无
recordId string 无
deviceAddr string 设备地址ID
value string 数据
createTime string 无
表3.3.3.1

3.3.4 返回格式示例

{
  "code": 1000,
  "data": [
    {
      "recordId": 2,
      "deviceAddr": "10000000",
      "value": "杀虫仓温度: 离线|烘干仓温度: 离线|电池电量: 离线|降雨状态:无|光照度: 离线|诱虫灯状态:无",
      "createTime": 1618982274000
    },
    {
      "recordId": 1,
      "deviceAddr": "10000000",
      "value": "杀虫仓温度: 离线|烘干仓温度: 离线|电池电量: 离线|降雨状态:无|光照度: 离线|诱虫灯状态:无",
      "createTime": 1618970306000
    }
  ],
  "message": "操作成功"
}

3.4 虫情设备分析报表记录

3.4.1接口描述

接口编号 3.4
接口名称 虫情设备分析报表记录
功能描述 虫情设备分析报表记录
接口地址 /UserDevice/WormAnalyzeReport
请求方式 get
参数格式 JSON
返回数据格式 JSON
备注  
表3.4.1.1

3.4.2 请求参数说明

3.4.2.1 请求头Header参数
header 必选 类型 说明
token 是 string token
表3.4.2.1.1
3.4.2.2 请求参数
字段 必选 类型 说明
deviceAddr 是 string 设备地址
startTime 是 string 开始时间
endTime 是 string 结束时间
表3.4.2.2.1

3.4.3 返回数据说明

字段 类型 说明
code string 无
message string 无
data array 无
recordId string 无
deviceAddr string 设备地址ID
analyst string 分析员
createTime string 添加时间
verifyTime string 分析时间
remark string 备注
imagesUrl string 拍照图片路径
analyseData string 害虫种类及数量
analyseCoord string 分析坐标
analyseCoordUrl string 分析坐标图片路径
表3.4.3.1

3.4.4 返回格式示例

{
  "code": 1000,
  "data": [
    {
      "recordId": 142,
      "deviceAddr": "12345601",
      "analyst": "AI",
      "createTime": 1620616602000,
      "verifyTime": 1620618019000,
      "remark": "",
      "imagesUrl": "http://farm.0531yun.cn../../static/wormImages/1212121212.png",
      "analyseData": "[{\"name\":\"蚜虫\",\"num\":\"10\"}]",
      "analyseCoord": null,
      "analyseCoordUrl": null
    },
    {
      "recordId": 141,
      "deviceAddr": "12345601",
      "analyst": "11",
      "createTime": 1620616589000,
      "verifyTime": 1620617889000,
      "remark": "1",
      "imagesUrl": "http://farm.0531yun.cn../../static/wormImages/111-big.png",
      "analyseData": "[{\"name\":\"小白蛾\",\"num\":\"1\"},{\"name\":\"玉米螟\",\"num\":\"1\"}]",
      "analyseCoord": null,
      "analyseCoordUrl": null
    },
    {
      "recordId": 140,
      "deviceAddr": "12345601",
      "analyst": "",
      "createTime": 1620616308000,
      "verifyTime": 1620617828000,
      "remark": "1",
      "imagesUrl": "http://farm.0531yun.cn../../static/wormImages/111-big.png",
      "analyseData": "[{\"name\":\"玉米螟\",\"num\":\"1\"}]",
      "analyseCoord": null,
      "analyseCoordUrl": null
    },
    {
      "recordId": 121,
      "deviceAddr": "12345601",
      "analyst": "1",
      "createTime": 1620604468000,
      "verifyTime": 1620617809000,
      "remark": "1",
      "imagesUrl": "http://farm.0531yun.cn../../static/wormImages/1212121212.png",
      "analyseData": "[{\"name\":\"玉米螟\",\"num\":\"2\"}]",
      "analyseCoord": null,
      "analyseCoordUrl": null
    }
  ],
  "message": "操作成功"
}

3.5 获取设备实时数据 气象

3.5.1接口描述

接口编号 3.5
接口名称 获取设备实时数据 气象
功能描述 获取设备实时数据 气象
接口地址 /UserDevice/WeatherDeviceRealData
请求方式 get
参数格式 JSON
返回数据格式 JSON
备注  
表3.5.1.1

3.5.2 请求参数说明

3.5.2.1 请求头Header参数
header 必选 类型 说明
token 是 string token
表3.5.2.1.1
3.5.2.2 请求参数
字段 必选 类型 说明
deviceAddr 是 string 设备地址
表3.5.2.2.1

3.5.3 返回数据说明

字段 类型 说明
code string 无
message string 无
data object 无
deviceAddr string 设备地址
deviceName string 设备名称
deviceType string 设备识别号1:气象设备，3:墒情设备
lat string 维度
lng string 经度
status string 状态 online,offline,alarm
terms array 节点
hum string 模拟量2
recordTime string 时间
tem string 模拟量1
termId string 节点ID
alarmInfos array 报警信息
alarmInfo string 报警信息
analog string 模拟量
state string 1正常 2报警
表3.5.3.1

3.5.4 返回格式示例

{
    "code":1000,
    "message":"操作成功",
    "data":{
        "deviceAddr":"10000001",
        "deviceName":"气象设备001",
        "deviceType":"1",
        "lat":0.9999999999,
        "lng":0.9999999999,
        "status":"alarm",
        "terms":[
            {
                "hum":83,
                "recordTime":1620719567872,
                "tem":-13.800000190734863,
                "termId":1,
                "alarmInfos":[
                    {
                        "alarmInfo":"断开报警",
                        "analog":"1",
                        "state":2
                    }
                ]
            }
        ]
    }
}

3.6 获取设备实时数据 虫情

3.6.1接口描述

接口编号 3.6
接口名称 获取设备实时数据 虫情
功能描述 获取设备实时数据 虫情
接口地址 /UserDevice/WormDeviceRealData
请求方式 get
参数格式 JSON
返回数据格式 JSON
备注  
表3.6.1.1

3.6.2 请求参数说明

3.6.2.1 请求头Header参数
header 必选 类型 说明
token 是 string token
表3.6.2.1.1
3.6.2.2 请求参数
字段 必选 类型 说明
deviceAddr 是 string 设备地址
表3.6.2.2.1

3.6.3 返回数据说明

字段 类型 说明
code string 无
message string 无
data object 无
deviceAddr string 设备编号
deviceType string 虫情设备标识 虫情：0
wormFlap string 杀虫挡板
rain string 降雨状态
door string 设备门状态
insecticideTem string 杀虫仓温度
shake string 震动装置
dryingFlap string 烘干挡板
lng string 经度
insecticide string 杀虫控制
moveWorm string 移虫挡板
cell string 电池电量
mode string 运行模式 1:NormalMode 自动 2:DebugMode 手动
drying string 烘干控制
rainFlap string 雨水电机
DTime string 系统时间（实时数据推送）
attractWorm string 诱虫灯状态
illum string 光照度
dryingTem string 烘干仓温度
lat string 纬度
fillLight string 补光灯
status string 设备状态 online offline
表3.6.3.1

3.6.4 返回格式示例

  "code": 1000,
  "data": {
    "deviceAddr": "21022406",
    "deviceType": 0,
    "wormFlap": 0,
    "rain": 0,
    "door": 0,
    "insecticideTem": 25,
    "shake": 0,
    "dryingFlap": 0,
    "lng": 117.14513397216797,
    "insecticide": 0,
    "moveWorm": 0,
    "cell": 100,
    "mode": 2,
    "drying": 0,
    "rainFlap": 0,
    "DTime": 1620721816,
    "attractWorm": 0,
    "illum": 242,
    "dryingTem": 25,
    "lat": 36.662166595458984,
    "fillLight": 0,
    "status": "online"
  },
  "message": "操作成功"
}

3.7 害虫趋势分析报告

3.7.1接口描述

接口编号 3.7
接口名称 害虫趋势分析报告
功能描述 害虫趋势分析报告
接口地址 /UserDevice/getWormReportData
请求方式 get
参数格式 JSON
返回数据格式 JSON
备注  
表3.7.1.1

3.7.2 请求参数说明

3.7.2.1 请求头Header参数
header 必选 类型 说明
token 是 string token
表3.7.2.1.1
3.7.2.2 请求参数
字段 必选 类型 说明
deviceAddr 是 string 设备地址
beginTime 是 string 开始时间
endTime 是 string 结束时间
表3.7.2.2.1

3.7.3 返回数据说明

字段 类型 说明
code string 无
message string 无
data object 无
num string 数量
name string 害虫名称
time string 时间
表3.7.3.1

3.7.4 返回格式示例

{
  "code": 1000,
  "data": [
    {
      "num": "7",
      "name": "棉铃虫",
      "time": 1619770740000
    },
    {
      "num": "9",
      "name": "蝗虫",
      "time": 1619770740000
    }
  ],
  "message": "操作成功"
}
 
 
 

3.8 虫情区域统计

3.8.1接口描述

接口编号 3.8
接口名称 虫情区域统计
功能描述 虫情区域统计
接口地址 /UserDevice/getWormHistoryByGroup
请求方式 get
参数格式 JSON
返回数据格式 JSON
备注  
表3.8.1.1

3.8.2 请求参数说明

3.8.2.1 请求头Header参数
header 必选 类型 说明
token 是 string token
表3.8.2.1.1
3.8.2.2 请求参数
字段 必选 类型 说明
groupId 是 string 区域ID
beginTime 是 string 开始时间
endTime 是 string 结束时间
表3.8.2.2.1

3.8.3 返回数据说明

字段 类型 说明
code string 无
message string 无
data object 无
deviceAddr string 设备地址
wornData array 害虫数据
num string 数量
name string 害虫名称
表3.8.3.1

3.8.4 返回格式示例

{
  "code": 1000,
  "data": [
    {
      "deviceAddr": "21022405",
      "wornData": [
        {
          "num": 9,
          "name": "蝗虫"
        },
        {
          "num": 7,
          "name": "棉铃虫"
        }
      ]
    }
  ],
  "message": "操作成功"
}
 

3.9 害虫自动识别

3.9.1接口描述

接口编号 3.9
接口名称 害虫自动识别
功能描述 害虫自动识别
接口地址 /UserDevice/analysistWorm
请求方式 get
参数格式 JSON
返回数据格式 JSON
备注  
表3.9.1.1

3.9.2 请求参数说明

3.9.2.1 请求头Header参数
header 必选 类型 说明
token 是 string token
表3.9.2.1.1
3.9.2.2 请求参数
字段 必选 类型 说明
recordId 是 string 分析报告记录表ID
表3.8.2.2.1

3.9.3 返回数据说明

字段 类型 说明
code string 无
message string 无
data object 无
表3.9.3.1

3.9.4 返回格式示例

{
  "code": 1000,
  "data": null,
  "message": "操作成功"
}
 

3.9.5 备注

 生成分析坐标图片需要5-10秒
 

4.0 孢子分析设备历史记录

4.0.1接口描述

接口编号 4.0
接口名称 孢子分析设备历史记录
功能描述 孢子分析设备历史记录
接口地址 /UserDevice/getSporeAnalyzeHistoryData
请求方式 get
参数格式 JSON
返回数据格式 JSON
备注  
表4.0.1.1

4.0.2 请求参数说明

4.0.2.1 请求头Header参数
header 必选 类型 说明
token 是 string token
表4.0.2.1.1
4.0.2.2 请求参数
字段 必选 类型 说明
deviceAddr 是 string 设备地址
beginTime 是 string 开始时间(2021/08/13 14:00:00)
endTime 是 string 结束时间(2021/09/13 14:00:00)
表4.0.2.2.1

4.0.3 返回数据说明

字段 类型 说明
code string 无
message string 无
data object 无
recordId Int 记录表Id
deviceAddr string 设备地址
value string 历史记录数据
createTime string 保存时间
表4.0.3.1

4.0.4 返回格式示例

{
  "code": 1000,
  "data": [
    {
      "recordId": 332,
      "deviceAddr": "44444444",
      "value": "设备地址码:44444444|光源状态：关闭|采集的单次脉冲数：0|采样口状态：打开|控制模式：自动|对应设备门状态：关门|Y轴电机脉冲数：0|排气口状态：打开|吸气口状态：打开|Y轴电机状态：停止|载玻带电机状态：停止|载玻带单次运动距离的脉冲数：5",
      "createTime": "2021-08-09 14:06:48"
    },
    {
      "recordId": 331,
      "deviceAddr": "44444444",
      "value": "设备地址码:44444444|光源状态：关闭|采集的单次脉冲数：0|采样口状态：打开|控制模式：手动|对应设备门状态：关门|Y轴电机脉冲数：0|排气口状态：打开|吸气口状态：打开|Y轴电机状态：停止|载玻带电机状态：停止|载玻带单次运动距离的脉冲数：5",
      "createTime": "2021-08-09 14:05:38"
    }
  ],
  "message": "操作成功"
}
 
 

4.1 孢子分析报告

4.1.1接口描述

接口编号 4.1
接口名称 孢子分析报告
功能描述 孢子分析报告
接口地址 /UserDevice/getSporeAnalyzeReportData
请求方式 get
参数格式 JSON
返回数据格式 JSON
备注  
表4.1.1.1

4.1.2 请求参数说明

4.1.2.1 请求头Header参数
header 必选 类型 说明
token 是 string token
表4.1.2.1.1
4.1.2.2 请求参数
字段 必选 类型 说明
deviceAddr 是 string 设备地址
beginTime 是 string 开始时间(2021/08/13 14:00:00)
endTime 是 string 结束时间(2021/09/13 14:00:00)
表4.1.2.2.1

4.1.3 返回数据说明

字段 类型 说明
code string 无
message string 无
data object 无
recordId Int 记录表Id
deviceAddr string 设备地址
analyst string 分析员
createTime string 添加时间
verifyTime   分析时间
remark   备注
imagesUrl   拍照图片路径
     
表4.1.3.1

4.1.4 返回格式示例

{
  "code": 1000,
  "data": [
    {
      "recordId": 135,
      "deviceAddr": "0803210101",
      "analyst": null,
      "createTime": "2021-08-12 14:06:05",
      "verifyTime": null,
      "remark": null,
      "imagesUrl": "http://192.168.1.48:8085/static/sporeAnalyzerImages/0812140606599.png",
      "deviceName": null
    },
    {
      "recordId": 134,
      "deviceAddr": "0803210101",
      "analyst": null,
      "createTime": "2021-08-12 14:03:02",
      "verifyTime": null,
      "remark": null,
      "imagesUrl": "http://192.168.1.48:8085/static/sporeAnalyzerImages/0812140303713.png",
      "deviceName": null
    }
  ],
  "message": "操作成功"
}
 

4.2 获取孢子分析设备实时数据

4.2.1接口描述

接口编号 4.2
接口名称 获取孢子分析设备实时数据
功能描述 获取孢子分析设备实时数据
接口地址 /UserDevice/sporeAnalyzerOverallData
请求方式 get
参数格式 JSON
返回数据格式 JSON
备注  
表4.2.1.1

4.2.2 请求参数说明

4.2.2.1 请求头Header参数
header 必选 类型 说明
token 是 string token
表4.2.2.1.1
4.2.2.2 请求参数
字段 必选 类型 说明
deviceAddr 是 string 设备地址
表4.2.2.2.1

4.2.3 返回数据说明

字段 类型 说明
code string 无
message string 无
data object 无
deviceAddr string 设备地址
deviceType string 设备识别号 4:孢子分析设备
lng double 纬度
lat double 纬度
deviceName string 设备名称
status string 设备状态 online offline alarming
sporeAnalyzerRealData object 实时数据集
controlMode string 控制模式(0:手动；1：自动）
ZBDMotorPulse string 载玻带单次运动距离的脉冲数
BlowVentStatus string 排气口状态（0：关闭；1：打开）
IamphouseStatus string 光源状态(0:关闭；1：开启）
Latitude string 设备上传纬度
SamplingPortStatus string 采样口状态（0：关闭；1：打开）
YMotorStatus string Y轴电机状态（0：停止；1：运行）
Longitude string 设备上传经度
AdmissionPortStatus string 吸气口状态（0：关闭；1：打开）
motorPulse string Y轴电机脉冲范围（最小值，最大值）
PulseTotal string 采集的累计脉冲数
YMotorPulse string Y轴电机脉冲数
ZBDMotorStatus string 载玻带电机状态（0：停止；1：运行）
PulseCurrent string 采集的单次脉冲数
SwitchStatus string 对应设备门状态，0代表关门/1代表开门
YMotorDirection string Y轴电机方向（0：前进；1：后退）
Altitude string 海拔高度
     
表4.2.3.1

4.2.4 返回格式示例

{
  "code": 1000,
  "data": {
    "deviceAddr": "44444444",
    "deviceType": 4,
    "lng": 105.3656218817,
    "sporeAnalyzerRealData": {
      "controlMode": "1",
      "ZBDMotorPulse": "5",
      "BlowVentStatus": "0",
      "IamphouseStatus": "0",
      "Latitude": "0",
      "SamplingPortStatus": "0",
      "YMotorStatus": "0",
      "Longitude": "0",
      "AdmissionPortStatus": "0",
      "motorPulse": "0,55000",
      "PulseTotal": "300",
      "YMotorPulse": "0",
      "ZBDMotorStatus": "0",
      "PulseCurrent": "0",
      "SwitchStatus": "0",
      "YMotorDirection": "0",
      "Altitude": "1"
    },
    "deviceName": "孢子设备44",
    "lat": 61.3111620678,
    "status": "alarm"
  },
  "message": "操作成功"
}
 

4.3 获取灌溉设备详情

4.3.1接口描述

接口编号 4.3
接口名称 获取灌溉设备详情
功能描述 获取灌溉设备详情
接口地址 /UserDevice/getIrrigationDeviceByAddr
请求方式 get
参数格式 JSON
返回数据格式 JSON
备注  
表4.3.1.1

4.3.2 请求参数说明

4.3.2.1 请求头Header参数
header 必选 类型 说明
token 是 string token
表4.3.2.1.1
4.3.2.2 请求参数
字段 必选 类型 说明
deviceAddr 是 string 设备地址
factorType 否 string 1采集器 2阀门
enabled 否 string 因子使能，0,关闭；1,打开
表4.3.2.2.1

4.3.3 返回数据说明

字段 类型 说明
code string 无
message string 无
data object 无
deviceAddr string 虫情设备地址码
deviceType string 设备识别号 5灌溉设备
deviceName string 设备名称
lng string 经度
lat string 纬度
saveDateInterval string 数据保存间隔
offlineInterval string 离线判断间隔
groupId string 区域id
httpUrl string 摄像头httpUrl
rtmpUrl string 摄像头rtmpUrl
city string 城市
createTime string  
alertDataStatus string 报警数据状态 0关闭 1开启
phoneOfflineNotification Integer 手机离线通知状态 0关闭 1开启
phoneAlarmInterval Integer 手机报警间隔（分钟）
phoneMaxSendingNumber Integer 手机最大发送次数
emailOfflineNotification Integer 邮件离线通知状态 0关闭 1开启
emailAlarmInterval Integer 邮件报警间隔（分钟）
emailMaxSendingNumber Integer 邮件最大发送次数
irrigationContactDOList List 设备通信号码
id Integer  
deviceAddr String 设备编号
contactType Integer 1手机 2邮箱
contact String 信号码
updateTime String 更新时间
irrigationFactorDOS List 灌溉因子信息
factorId String 因子ID
factorNo Integer 因子编号
factorType Integer 1采集器 2阀门
deviceAddr String 设备地址
nodeType Integer 无
factorName String 因子名称
enabled Integer 因子使能，0,关闭；1,打开
unit String 单位
digits Integer 小数位数
coefficient Float 系数
offset Float 偏差
upperLimit Float 上限值
lowerLimit Float 下限值
electricLowerlimit Integer 电量报警下限
smsEnabled Integer 短信告警开关，0,关；1,开
emailEnabled Integer 邮件开关
offlineAlarmingSwitch Integer 离线报警开关 0:关 ； 1:开
offlineAlarmingAlarmContent String 报警内容模板、变量：[设备名称][报警等级][报警值][报警范围][设备地址][节点编号][因子名称][系统时间]
electricLimitSwitch Integer 电量报警开关 0:关 ； 1:开
electricLimitAlarmContent String 报警内容模板、变量：[设备名称][报警等级][报警值][报警范围][设备地址][节点编号][因子名称][系统时间]
excessAlarmingSwitch Integer 超限报警开关 0:关 ； 1:开
excessAlarmingAlarmContent String 报警内容模板、变量：[设备名称][报警等级][报警值][报警范围][设备地址][节点编号][因子名称][系统时间]
createTime String 创建时间
     
表4.3.3.1

4.3.4 返回格式示例

{
    "code":1000,
    "data":{
        "deviceAddr":"10000000",
        "deviceType":5,
        "deviceName":"测试 勿动",
        "lng":230,
        "lat":0,
        "saveDateInterval":1,
        "offlineInterval":1,
        "groupId":"506dec60-a8aa-11eb-aa31-45226ea94d1e",
        "httpUrl":null,
        "rtmpUrl":null,
        "city":null,
        "createTime":"2021-08-26 16:53:20",
        "alertDataStatus":"1",
        "phoneOfflineNotification":1,
        "phoneAlarmInterval":222,
        "phoneMaxSendingNumber":0,
        "emailOfflineNotification":1,
        "emailAlarmInterval":111,
        "emailMaxSendingNumber":44,
        "groupName":null,
        "terms":null,
        "irrigationContactDOList":[
            {
                "id":572,
                "deviceAddr":"10000000",
                "contactType":2,
                "contact":"2@qq.com",
                "updateTime":"2021-09-06 13:19:16"
            },
            {
                "id":569,
                "deviceAddr":"10000000",
                "contactType":1,
                "contact":"18312345678",
                "updateTime":"2021-09-06 13:19:16"
            }
        ],
        "irrigationFactorDOS":[
            {
                "factorId":"10000000_1",
                "factorNo":1,
                "factorType":1,
                "deviceAddr":"10000000",
                "nodeType":1,
                "factorName":"10000000_",
                "enabled":1,
                "unit":"℃",
                "digits":1,
                "coefficient":0.1,
                "offset":0,
                "upperLimit":5.235,
                "lowerLimit":12,
                "electricLowerlimit":99,
                "smsEnabled":1,
                "emailEnabled":1,
                "offlineAlarmingSwitch":0,
                "offlineAlarmingAlarmContent":"[预警限值][设备地址]",
                "electricLimitSwitch":1,
                "electricLimitAlarmContent":"[报警限值][预警限值][设备地址][系统时间]",
                "excessAlarmingSwitch":0,
                "excessAlarmingAlarmContent":"[节点编号][报警限值]",
                "createTime":"2021-09-06 13:20:27",
                "irrigationFactorRegulatingDOList":[
 
                ]
            },
            {
                "factorId":"10000000_86",
                "factorNo":86,
                "factorType":2,
                "deviceAddr":"10000000",
                "nodeType":3,
                "factorName":"pc",
                "enabled":1,
                "unit":"℃",
                "digits":2,
                "coefficient":0.1,
                "offset":1,
                "upperLimit":120,
                "lowerLimit":12,
                "electricLowerlimit":20,
                "smsEnabled":null,
                "emailEnabled":null,
                "offlineAlarmingSwitch":null,
                "offlineAlarmingAlarmContent":null,
                "electricLimitSwitch":null,
                "electricLimitAlarmContent":null,
                "excessAlarmingSwitch":null,
                "excessAlarmingAlarmContent":null,
                "createTime":"2021-09-03 15:52:05",
                "irrigationFactorRegulatingDOList":[
 
                ]
            }
        ]
    },
    "message":"操作成功"
}

4.4 获取灌溉设备实时数据

4.4.1接口描述

接口编号 4.4
接口名称 获取灌溉设备实时数据
功能描述 获取灌溉设备实时数据
接口地址 /UserDevice/getIrrigationDeviceOverallData
请求方式 get
参数格式 JSON
返回数据格式 JSON
备注  
表4.4.1.1

4.4.2 请求参数说明

4.4.2.1 请求头Header参数
header 必选 类型 说明
token 是 string token
表4.4.2.1.1
4.4.2.2 请求参数
字段 必选 类型 说明
deviceAddr 是 string 设备地址
表4.4.2.2.1

4.4.3 返回数据说明

字段 类型 说明
code string 无
message string 无
data object 无
deviceAddr String 设备地址
lng Double 经度
lat Double 纬度
status String  设备状态online offline alarming
deviceType String 设备识别号 5灌溉设备
factors List 因子实时数据
electricQuantity String 电量值
factorSignal String 信号值
factorValue String 模拟量值
alarming String 是否报警 0正常 1模拟量报警 2电量报警 3同时报警
alarmingValue String 报警信息
factorType String 因子类型 1采集器 2阀门
factorNo String 因子编号
factorId String 因子id
factorName String 因子名称
factorStatus String 因子状态   online offline alarming
factorMode String 运行模式  1为手动，2为自动，3为定时-定点，4为定时-星期 5为自动-平均值
valveStatus String 阀门状态 1:打开，0:关闭
     
表4.4.3.1

4.4.4 返回格式示例

{
  "code": 1000,
  "data": [
    {
      "deviceAddr": "10000000",
      "deviceType": "5",
      "lng": 0.02200129584349762,
      "lat": 0.008728984041221487,
      "status": "online",
      "factors": [
        {
          "electricQuantity": "0",
          "factorSignal": "200",
          "factorValue": "0℃",
          "alarming": "0",
          "alarmingValue": "10000000_越下限报警，当前值0,下限值12.0",
          "factorType": "1",
          "factorNo": "1",
          "factorId": "10000000_1",
          "factorName": "10000000_",
          "factorStatus": "offline",
          "factorMode": "1",
          "valveStatus": null
        },
        {
          "electricQuantity": "100",
          "factorSignal": "100",
          "factorValue": null,
          "alarming": "0",
          "alarmingValue": null,
          "factorType": "2",
          "factorNo": "86",
          "factorId": "10000000_86",
          "factorName": "pc",
          "factorStatus": "online",
          "factorMode": "3",
          "valveStatus": "0"
        }
      ]
    }
  ],
  "message": "操作成功"
}

4.5 获取灌溉设备历史记录

4.5.1接口描述

接口编号 4.5
接口名称 获取灌溉设备历史记录
功能描述 获取灌溉设备历史记录
接口地址 /UserDevice/getIrrigationHistoryData
请求方式 get
参数格式 JSON
返回数据格式 JSON
备注  
表4.5.1.1

4.5.2 请求参数说明

4.5.2.1 请求头Header参数
header 必选 类型 说明
token 是 string token
表4.5.2.1.1
4.5.2.2 请求参数
字段 必选 类型 说明
deviceAddr 是 string 设备地址
beginTime 是 string 开始时间(2021/08/13 14:00:00)
endTime 是 string 结束时间(2021/09/13 14:00:00)
factorIds 否 string 因子id（多个逗号分割）
表4.5.2.2.1

4.5.3 返回数据说明

字段 类型 说明
code string 无
message string 无
data object 无
id Integer  
deviceAddr String 设备地址
factorId String 因子编号
factorName String 名称
createTime String 创建时间
value String 原始数据
electricQuantity Float 电量
signal Float 信号
alarming Integer 是否报警: 1为数值报警 2电量报警 3同时报警 4信号报警
valueText String 展示数据
     
表4.5.3.1

4.5.4 返回格式示例

{
  "code": 1000,
  "data": [
    {
      "id": 20214303,
      "deviceAddr": "10000000",
      "factorId": "10000000_4",
      "factorName": "10000000_4",
      "createTime": "2021-09-06 13:29:48",
      "value": "100",
      "electricQuantity": 1000,
      "signal": 100,
      "alarming": 0,
      "valueText": null
    },
    {
      "id": 20214293,
      "deviceAddr": "10000000",
      "factorId": "10000000_4",
      "factorName": "10000000_4",
      "createTime": "2021-09-06 13:29:32",
      "value": "100",
      "electricQuantity": 1000,
      "signal": 100,
      "alarming": 0,
      "valueText": null
    }
  ],
  "message": "操作成功"
}

4.6 获取灌溉设备操作记录

4.6.1接口描述

接口编号 4.6
接口名称 获取灌溉设备操作记录
功能描述 获取灌溉设备操作记录
接口地址 /UserDevice/getIrrigationOperationLog
请求方式 get
参数格式 JSON
返回数据格式 JSON
备注  
表4.6.1.1

4.6.2 请求参数说明

4.6.2.1 请求头Header参数
header 必选 类型 说明
token 是 string token
表4.6.2.1.1
4.6.2.2 请求参数
字段 必选 类型 说明
deviceAddr 是 string 设备地址
beginTime 是 string 开始时间(2021/08/13 14:00:00)
endTime 是 string 结束时间(2021/09/13 14:00:00)
factorIds 否 string 因子id（多个逗号分割）
表4.6.2.2.1

4.6.3 返回数据说明

字段 类型 说明
code string 无
message string 无
data object 无
id Integer  
deviceAddr String 设备地址
factorId String 因子编号
factorName String 节点名称
operationContent String 操作内容
operationSource String 操作来源
createTime String 创建时间
表4.6.3.1

4.6.4 返回格式示例

{
  "code": 1000,
  "data": [
    {
      "id": 59,
      "deviceAddr": "10000000",
      "factorId": "10000000_86",
      "factorName": "pc",
      "operationContent": "0",
      "operationSource": "保持时长已到，恢复定时执行之前阀门状态",
      "createTime": "2021-09-04 16:52:46"
    },
    {
      "id": 58,
      "deviceAddr": "10000000",
      "factorId": "10000000_86",
      "factorName": "pc",
      "operationContent": "1",
      "operationSource": "定时",
      "createTime": "2021-09-04 16:50:46"
    }
  ],
  "message": "操作成功"
}

4.7 获取灌溉设备通知记录

4.7.1接口描述

接口编号 4.7
接口名称 获取灌溉设备通知记录
功能描述 获取灌溉设备通知记录
接口地址 /UserDevice/getIrrigationNoticeRecord
请求方式 get
参数格式 JSON
返回数据格式 JSON
备注  
表4.7.1.1

4.7.2 请求参数说明

4.7.2.1 请求头Header参数
header 必选 类型 说明
token 是 string token
表4.7.2.1.1
4.7.2.2 请求参数
字段 必选 类型 说明
deviceAddr 是 string 设备地址
beginTime 是 string 开始时间(2021/08/13 14:00:00)
endTime 是 string 结束时间(2021/09/13 14:00:00)
factorIds 否 string 因子id（多个逗号分割）
noticeIType 否 string 通知类型 0邮件 1短信
表4.7.2.2.1

4.7.3 返回数据说明

字段 类型 说明
code string 无
message string 无
data object 无
noticeID Integer  
noticeIType Integer 通知类型 0邮件 1短信
deviceAddr String 设备地址
factorName String 因子名称
factorId String 因子id
contact String 联系人
noticeIContent String 通知内容
remark String 备注
createTime String 通知时间
表4.7.3.1

4.7.4 返回格式示例

{
  "code": 1000,
  "data": [
    {
      "noticeID": 3,
      "noticeIType": 1,
      "deviceAddr": "20210818",
      "factorName": "雪花",
      "factorId": "20210818_1",
      "contact": "联系人短信",
      "noticeIContent": "通知内容",
      "remark": "备注",
      "createTime": "2021-08-18 09:26:57"
    },
    {
      "noticeID": 2,
      "noticeIType": 1,
      "deviceAddr": "20210818",
      "factorName": "湿度",
      "factorId": "20210818_1",
      "contact": "联系人短息",
      "noticeIContent": "通知内容",
      "remark": "备注",
      "createTime": "2021-08-18 00:00:00"
    }
  ],
  "message": "操作成功"
}
 
 

4.8 灌溉设备工作模式切换

4.8.1接口描述

接口编号 4.8
接口名称 灌溉设备工作模式切换
功能描述 灌溉设备工作模式切换
接口地址 /UserDevice/modeSwitchIrrigation
请求方式 get
参数格式 JSON
返回数据格式 JSON
备注  
表4.8.1.1

4.8.2 请求参数说明

4.8.2.1 请求头Header参数
header 必选 类型 说明
token 是 string token
表4.8.2.1.1
4.8.2.2 请求参数
字段 必选 类型 说明
deviceAddr 是 string 设备地址
factorId 是 string 因子id(多个用逗号分割)
mode 是 string 1为手动，2为自动
表4.8.2.2.1

4.8.3 返回数据说明

字段 类型 说明
code string 无
message string 无
data object 无
表4.8.3.1

4.8.4 返回格式示例

{
  "code": 1000,
  "data": null
  "message": "操作成功"
}
 

4.9 灌溉设备工作状态切换

4.9.1接口描述

接口编号 4.9
接口名称 灌溉设备工作状态切换
功能描述 灌溉设备工作状态切换
接口地址 /UserDevice/workingConditionIrrigation
请求方式 get
参数格式 JSON
返回数据格式 JSON
备注  
表4.9.1.1

4.9.2 请求参数说明

4.9.2.1 请求头Header参数
header 必选 类型 说明
token 是 string token
表4.9.2.1.1
4.9.2.2 请求参数
字段 必选 类型 说明
deviceAddr 是 string 设备地址
factorId 是 string 因子id(多个用逗号分割)
mode 是 string 0为关闭，1为开启
表4.9.2.2.1

4.9.3 返回数据说明

字段 类型 说明
code string 无
message string 无
data object 无
表4.9.3.1

4.9.4 返回格式示例

{
  "code": 1000,
  "data": null
  "message": "操作成功"
}
 
 
 
 
 

四、附录

返回代码

 
代码 说明
1000 接口执行成功，具体参考各个接口
1001 接口执行失败，具体参考各个接口，原因参考Message
1002 接口验证失败，具体参考各个接口，原因参考Message
1003 程序内部异常
1004 登录过期
4000 未登录、登陆失效
5000 操作失败
 
 

上一篇：欣仰邦噪声扬尘小主机modbus从站接口通信详解

下一篇：欣仰邦扬尘平台接口文档

产品中心
LoRa传感器 NB传感变送器 自动化监测 远程控制 智能灌溉 水文水质监控 软件平台系统 环保环境监测
解决方案
智慧园林 智慧农业 水文水质 环保气象 灾害预警 智慧城市 智慧工厂 商业自助 智慧医疗 智慧消防 公共能源 智慧电力
智能报导
智慧百科 传感百科 开发文档
服务支持
下载中心 学习中心
关于我们
公司介绍 企业文化
商务合作
样机申请 开发服务

服务热线

企业服务热线：0592-3564822 0592-3564822
在线咨询时间图标在线咨询 9:00-18:00

官方二维码

厦门欣仰邦科技有限公司官方公众号
Copyright © 2021 厦门欣仰邦科技有限公司 版权所有 备案号：闽ICP备18009268号-1
在线咨询
在线咨询
索要样机
样机申请
扫一扫

扫一扫
欣仰邦公众号

全国免费服务热线
0592-3564822

返回顶部