code:200 表示成功
code:500 表示失败
采用get 方式以问号分隔
采用post 方式
在 headers 中带 Authorization 值为获取的token值
{
"msg": "操作成功",
"code": 200,
"data": {
"OutParam0": "结果0",
"OutParam1": "结果1",
"OutParam2": "结果2",
"OutParam3": "结果3"
}
}
{
"msg": "操作成功",
"code": 200,
"total": 120,
"rows": [
{
"Value1":"值1",
"Value2":"值2"
},
{
"Value1":"值1",
"Value2":"值2"
}
]
}
{
"msg": "操作成功",
"code": 200,
"data": [
{
"id": 100,
"label": "节点值1",
"children": [
{
"id": 101,
"label": "节点值2",
"children": [
{
"id": 105,
"label": "节点值3"
}
]
}
]
}
]
}
用户名和密码由平台分配,并分配设备
有效期24小时,即24小时不访问则过期
请求url: /gd/device/token
body:
{
"loginName": "admin1", //用户名
"password": "1" //密码
}
返回:
{
"code": 200,
"data": {
"token": "token值"
},
"message": "SUCCESS"
}
请求url:/gd/device/list?pageIndex=1&pageSize=10
pageIndex:表示查询第几页
pageSize:表示每页的设备数(当获取全部时 pageSize=0)
{
"msg": "操作成功",
"code": 200,
"total": 120, //总数量
"rows": [
{
"deviceId":"1", //设备ID 自增ID
"deviceNum":"0", //设备编号
"deviceName":"气象站", //设备名称
"status":"0", //在线状态 1:在线 0:离线
"useFlag":"0", //禁用状态 0:启用 1: 禁用
"typeId":"1", //设备类型ID
"typeName":"通用设备", //设备类型名称
"teamId":12, //分组ID
"teamName":"一号分组", //分组名称
"digitalLength":"0", //数字数
"analogLength":"3", //模拟量个数暂时不使用
"relayLength":"10", //命令数(开关数)
"longitude":"34.1134", //经度
"latitude":"114.3245", //纬度
"createBy":"admin", //创建人
"createTime":"2020-10-24 16:45:30" //创建时间
},
{
"deviceId":"1",
"deviceNum":"0",
"deviceName":"气象站",
"status":"0",
"useFlag":"0", // 0:启用 1: 禁用
"typeId":"1",
"typeName":"通用设备",
"teamId":12,
"teamName":"一号分组",
"digitalLength":"0",
"analogLength":"3",
"relayLength":"10",
"longitude":"34.1134",
"latitude":"114.3245",
"createBy":"admin",
"createTime":"2020-10-24 16:45:30"
}
]
}
用来请求某设备下所有的检测项信息
请求url:/gd/device/deviceInfo?deviceNum=2
deviceNum:设备号
返回:
{
"msg": "操作成功",
"code": 200,
"data": {
"deviceId":"12", //设备ID
"deviceNum":"0", //设备编号
"deviceName":"气象站", //设备名称
"status":"0", //设备状态
"children": [
{
"digitalID":"1", //监测项1
"digitalName":"大气温度", //监测1名称
"unit":"度", //单位
"backColor":"red", //背景色
"backImage":"/image/1.jpg" //背景小图标
},
{
"digitalID":"2", //监测项2
"digitalName":"大气湿度",
"unit":"%RH",
"backColor":"green",
"backImage":"/image/1.jpg"
}
]
}
}
请求url:
/gd/device/realData?deviceNum=12
返回:
{
"code": 200,
"msg": "操作成功",
"data": {
"createTime": "2022-09-28 08:40:00",//创建时间
"digital": [
20.8, //监测项1的值
23.0, //监测项2的值
9.0, //监测项3的值
4.0, //监测项4的值
4.0, //监测项5的值
5.0, //监测项6的值
42.0 //监测项7的值
],
"relay": [],
"deviceID": 395,
"deviceNum": "GDZS22072932",
"preStoreTime": "2022-09-28 08:40:00",
"storeType": 1
}
}
请求url:
/gd/device/historyData?deviceNum=12&pageIndex=1&pageSize=10&beginTime=2020-10-31 12:00:00&endTime=2020-11-01 12:00:00
deviceNum:设备编号
pageIndex:第几页
pageSize:每页的数量
beginTime:开始时间
endTime:结束时间
返回:
{
"msg": "操作成功",
"code": 200,
"total": 2, //总数量
"rows": [
{
"update_dt":"2020-10-24 16:45:30", //创建时间
"digital1":"1", //监测项1的值
"digital2":"2", //监测项2的值
"digital3":"3", //监测项3的值
"digital4":"4", //监测项4的值
"digital5":"5", //监测项5的值
"digital6":"6", //监测项6的值
"digital7":"7", //监测项7的值
"digital8":"8", //监测项8的值
"digital9":"9" //监测项9的值
},
{
"update_dt":"2020-10-24 17:45:30", //创建时间
"digital1":"1", //监测项1的值
"digital2":"2", //监测项2的值
"digital3":"3", //监测项3的值
"digital4":"4", //监测项4的值
"digital5":"5", //监测项5的值
"digital6":"6", //监测项6的值
"digital7":"7", //监测项7的值
"digital8":"8", //监测项8的值
"digital9":"9" //监测项9的值
}
]
}
请求url:/gd/device/relayInfo?deviceNum=12
deviceNum:设备编号
返回:
{
"msg": "操作成功",
"code": 200,
"data": { [
{
"deviceId":"1", //设备ID
"relayID":"1", //开关ID
"relayName":"1号水井", //开关名称
"backColor":"red", //背景色
"backImage":"/image/1.jpg" //背景小图标
},
{
"deviceId":"2", //设备ID
"relayID":"1",
"relayName":"2号水井",
"backColor":"green",
"backImage":"/image/1.jpg"
}
]
}
}
请求url:/gd/device/relay?deviceNum=12
deviceNum:设备号
主动推送
{
"requestType" : "3",
"msg": "操作成功",
"code": 200,
"deviceId":"1", //设备ID
"status":"1", // 1:在线 0:离线
"data": [{
"children": [
{
"relayID":"1", //开关 ID
"status":"0" //开关状态 0:关 1:开
},
{
"relayID":"2",
"status":"0"
}]
}]
}
请求url:/gd/device/control?deviceNum=12&relayID=1&status=0
deviceNum: 设备编号
relayID: 开关ID
status:0:表示关闭 1:表示打开
返回:
{
"code": 1001,
"msg": "设备不在线",
"data": {
"BControlResult": false,
"Msg": "设备不在线"
}
}