设备接口

Api接口大约 10 分钟约 3032 字

设备接口

查询该设备下授权给我的所有指令

接口地址:/open-api/device/command/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:application/json

接口描述: 分页查询该设备下授权给我的所有指令，接口发送指令V2依赖于此接口的返回结果

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
deviceId	设备id	query	true	integer(int64)
page	查询的当前页面，默认为1	query	false	string
size	每页的记录数，默认为20	query	false	string

请求示例:

/open-api/device/command/list?deviceId=${deviceId}&page=${page}&size=${size}

响应状态:

状态码	说明
200	OK

响应参数:

参数名称	参数说明	类型
code	状态码	integer(int32)
msg	信息说明	string
data	数据值	array
commandId	指令id	integer(int64)
commandName	指令名称	string
productId	产品id	integer(int64)
productKey	产品代码	string
commandType	指令类型：1.参数读取 2.参数设置	integer(int32)
paramList	CommandParamVO对象	array
commandParamId	body	integer
commandId	指令id	integer
paramName	参数名称	string
paramValue	参数值	string
paramType	参数类型	integer
defaultValue	默认值	string
paramUnit	单位	string
scales	倍率：0.1 0.01等，主要用于确定小数位数	string
range	取值范围	string
description	参数说明	string
flag	标记为，标识此参数是否为合并参数	string
paramId	产品参数id	integer
value	参数值(用于发送设置指令那边，映射为用户填的参数值文本框)	string
handlerType	处理器类型：null 不需要特殊处理；1.字典项转换 2.报警代码转换	integer
handlerParam	处理器需要的参数	string

响应示例:

{
  "code": 0,
  "msg": "",
  "data": [
    {
      "commandId": 0,
      //指令id
      "commandName": "",
      //指令名称
      "productId": 0,
      //产品id
      "productKey": "",
      //产品代码
      "commandType": 0,
      //指令类型（1.参数读取 2.参数设置）
      "paramList": [
        {
          "commandParamId": 0,
          "commandId": 0,
          "paramName": "",
          "paramValue": "",
          "paramType": 0,
          "defaultValue": "",
          "paramUnit": "",
          "scales": "",
          "range": "",
          "description": "",
          "flag": "",
          "paramId": 0,
          "paramTypeLabel": "",
          "value": "",
          "handlerType": 0,
          "handlerParam": ""
        }
      ]
    }
  ]
}

发送指令V2

接口地址:/open-api/device/command/v2/send

请求方式:POST

请求数据类型:application/x-www-form-urlencoded,application/json

响应数据类型:application/json

接口描述: 发送指令给设备，依赖于获取指令列表

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
paramValue	测点编号	body	false	string
paramType	数据类型	body	false	integer(int32)
source	固定值READ_MODIFY	body	false	integer(int32)
commandType	指令类型	body	false	integer(int32)
commandId	指令id	body	false	integer(int64)
value	参数值	body	false	string
deviceId	设备id	body	false	integer(int64)
expiredTime	超时时间	body	false	integer(int32)
scales	变比	body	false	string

请求示例:

{
  "paramValue": "",
  //复杂参数 来源于[查询该设备下授权给我的所有指令]中的paramList中paramValue
  "paramType": 0,
  //数据类型
  "source": "READ_MODIFY",
  //固定值READ_MODIFY
  "commandType": 0,
  //指令类型 1.参数读取 2.参数设置
  "commandId": 0,
  //指令id 来源于[获取指令列表]接口
  "value": "",
  //参数值
  "deviceId": 0,
  //要发送的设备id 来源于[取设备列表]接口
  "expiredTime": 0,
  //超时时间
  "scales": ""
  //变比，不同类型设备不同
}

响应状态:

状态码	说明
200	OK

响应参数:

参数名称	参数说明	类型
code	状态码	integer(int32)
msg	信息说明	string
data	body	CommandRunLogVO
commandRunLogId	主键	integer(int64)
commandId	指令id	integer(int64)
deviceId	设备id	integer(int64)
deviceSn	设备序列号	string
status	指令状态：0待发送 -1发送MQ成功 -2发送MQ失败 1发送设备成功 2发送设备失败 3设备接收成功 4设备接收失败 5（成功/升级中） 6（失败/升级完成） 7固件下载中 8固件校验中 9固件升级失败 10错误超过重试次数 11无法获取设备重度次数 12设备不在线	integer(int32)
result	返回结果	string
source	触发来源	string
plantId	电站id	integer(int64)
expiredTime	指令超时时间,单位秒	integer(int32)
commandContent	指令内容：针对透传指令	string
errorCode	升级失败的错误码：0无错误 1下载失败 2校验失败 3升级失败。只有status=9的时候，errorcode才有值	integer(int32)
inParams	输入参数	string
outParams	输出参数	string
tips	提示信息	string
commandName	指令名称	string
commandType	指令类型	integer(int32)
firmwareVersion	固件版本	string
upgrading	指令执行是否正	boolean
sendTime	发送时间	string
returnTime	返回结果时间	string

响应示例:

{
  "code": 0,
  "msg": "",
  "data": {
    "commandRunLogId": 0,
    "commandId": 0,
    "deviceId": 0,
    "deviceSn": "",
    "status": 0,
    "result": "",
    "source": "",
    "plantId": 0,
    "expiredTime": 0,
    "commandContent": "",
    "errorCode": 0,
    "inParams": "",
    "outParams": "",
    "tips": "",
    "commandName": "",
    "commandType": 0,
    "firmwareVersion": "",
    "upgrading": true,
    "sendTime": "",
    "returnTime": ""
  }
}

设备实时数据

接口地址:/open-api/device/data

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:application/json

接口描述: 查询设备实时数据，批量查询以,分割设备sn号,目前最多20个

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
deviceSnStr	设备sn号	query	true	string

响应状态:

状态码	说明
200	OK

响应参数:

参数名称	参数说明	类型
code	状态码	integer(int32)
msg	信息说明	string
data	数据值	array
deviceSn	设备Sn	string
alias	设备别名	string
deviceType	设备类型	integer(int32)
deviceType2	设备类型2	integer(int32)
deviceId	设备id	string
firstReportTime	设备首次上电日期	string(date-time)
lastReportTime	设备最后上电日期	string(date-time)
status	设备状态	integer(int32)
alertCodes	报警代码(公共信息 => 报警代码含义)	string
productKey	产品代码	string
realData	设备实时数据	array
fieldCode	字段代码	string
fieldUnitName	字段值的单位名称	string
fieldName	字段名称	string
data	字段值	object

响应示例:

{
  "code": 0,
  "msg": "",
  "data": [
    {
      "deviceSn": "",
      "alias": "",
      "deviceType": 0,
      "deviceType2": 0,
      "deviceId": "",
      "firstReportTime": "",
      "lastReportTime": "",
      "status": 1,
      "alertCodes": "",
      "productKey": "",
      "realData": [
        {
          "fieldCode": "",
          "fieldUnitName": "",
          "fieldName": "",
          "data": {}
        }
      ]
    }
  ]
}

查询设备历史数据

接口地址:/open-api/device/history

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:application/json

接口描述: 查询设备历史数据

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
deviceId	设备Id	query	true	integer(int64)
searchType	查询周期: 1.小时级数据（默认值）2.天级数据3.月级数据4.年级数据	query	true	integer(int32)
time	开始时间（yyyyMMdd）1.小时级数据，time为指定日期 2.天级数据，time为指定月任意一天3.月级数据，time为指定年任意一天4.年级数据，time为任意一天	query	true	string

响应状态:

状态码	说明
200	OK

响应参数:

参数名称	参数说明	类型
code	状态码	integer(int32)
msg	信息说明	string
data
deviceId	电站Id	integer(int64)
values	设备历史数据集	array
time	时间	string
electric	发电量	number
unit	单位	string
timestamp	时间戳	integer

响应示例:

{
  "code": 0,
  "msg": "",
  "data": {
    "deviceId": 0,
    "values": [
      {
        "time": "",
        "electric": 0,
        "unit": "",
        "timestamp": 0
      }
    ]
  }
}

设备列表分页查询(停止维护)

接口地址:/open-api/device/page

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:application/json

接口描述: 设备列表分页查询

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
page	查询的当前页面，默认为1	query	false	string
size	每页的记录数，默认为20	query	false	string

响应状态:

状态码	说明
200	OK

响应参数:

参数名称	参数说明	类型
code	状态码	integer(int32)
msg	信息说明	string
data	数据值	array
deviceId	设备ID	integer(int64)
deviceType	设备类型: 1.采集器 2.逆变器 3.电表 4.EPM 5.气象仪	integer(int32)
deviceType2	(涉及比较大差异性定义)设备类型2: 与 devicetype 关联, 逆变器: 01.单相机 02.三相机 03.储能机, 采集器: 01.采集棒, 02.一对多采集器	integer(int32)
deviceSn	设备SN	string
firstReportTime	设备首次上电日期	string(date-time)
lastReportTime	设备最后上电日期	string(date-time)
upDeviceId	设备上级连接父设备	integer(int64)
plantId	设备当前实时关联的电站ID	integer(int64)
createTime	记录创建时间	string(date-time)
status	设备状态: 01.正常 02.离线 3.报警 4.故障 5.自定义报警	integer(int32)
upDeviceSn	父设备sn	string
productKey	产品代码	string
alias	设备别名	string

响应示例:

{
  "code": 0,
  "msg": "",
  "data": [
    {
      "deviceId": 0,
      "deviceType": 0,
      "deviceType2": 0,
      "deviceSn": "",
      "firstReportTime": "",
      "lastReportTime": "",
      "upDeviceId": 0,
      "plantId": 0,
      "createTime": "",
      "status": 0,
      "upDeviceSn": "",
      "productKey": "",
      "alias": ""
    }
  ]
}

设备列表分页查询V2(推荐)

接口地址:/open-api/device/pageV2

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:application/json

接口描述: 设备列表分页查询，回传数据包含总数、页码等分页信息

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
page	查询的当前页面，默认为1	query	false	string
size	每页的记录数，默认为20	query	false	string
deviceSn	设备sn	query	false	string
deviceType	设备类型	query	false	integer

响应状态:

状态码	说明
200	OK

响应参数:

参数名称	参数说明	类型
code	状态码	integer(int32)
msg	信息说明	string
data	数据值	object
totalCount	总数	integer
totalPages	总页数	integer
currentPage	当前页	integer
pageSize	每页数量	integer
records	数据值	array
deviceId	设备ID	integer(int64)
deviceType	设备类型: 1.采集器 2.逆变器 3.电表 4.EPM 5.气象仪	integer(int32)
deviceType2	(涉及比较大差异性定义)设备类型2: 与 devicetype 关联, 逆变器: 01.单相机 02.三相机 03.储能机, 采集器: 01.采集棒, 02.一对多采集器	integer(int32)
deviceSn	设备SN	string
firstReportTime	设备首次上电日期	string(datetime)
lastReportTime	设备最后上电日期	string(datetime)
upDeviceId	设备上级连接父设备	integer(int64)
plantId	设备当前实时关联的电站ID	integer(int64)
createTime	记录创建时间	string(datetime)
status	设备状态: 01.正常 02.离线 3.报警 4.故障 5.自定义报警	integer(int32)
upDeviceSn	父设备sn	string
productKey	产品代码	string
alias	设备别名	string

响应示例:

{
  "code": 0,
  "msg": "",
  "data": {
    "totalCount": 10,
    "totalPages": 1,
    "currentPage": 1,
    "pageSize": 20,
    "records": [
      {
        "deviceId": 0,
        "deviceType": 0,
        "deviceType2": 0,
        "deviceSn": "",
        "firstReportTime": "",
        "lastReportTime": "",
        "upDeviceId": 0,
        "plantId": 0,
        "createTime": "",
        "status": 0,
        "upDeviceSn": "",
        "productKey": "",
        "alias": ""
      }
    ]
  }
}

获取采集器sim卡信息

接口地址:/open-api/device/sim/{deviceSn}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:application/json

接口描述: 通过采集器设备sn号获取所关联的sim卡信息

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
deviceSn	设备sn号	path	true	string

响应状态:

状态码	说明
200	OK

响应参数:

参数名称	参数说明	类型
code	状态码	integer(int32)
msg	信息说明	string
data	body	SimInfoVO
simInfoId	主键	integer(int64)
simNo	卡号	string
telephone	手机号码	string
expireTime	到期时间	string(date-time)
belongCompany	所属运营商	integer(int32)
belongCompanyName	所属运营商	string
simType	卡类型(1：4g 2:wifi)	integer(int32)
collectorSn	关联采集器sn号	string
collectorName	关联采集器名称	string
collectorId	关联采集器id	integer(int64)
belongSystemName	所在系统	string
isCollector	是否关联采集器（0：否 1：是）	integer(int32)
expireStatus	到期状态： 1已到期 2未到期	integer(int32)

响应示例:

{
  "code": 0,
  "msg": "",
  "data": {
    "simInfoId": 0,
    "simNo": "",
    "telephone": "",
    "expireTime": "",
    "belongCompany": 0,
    "belongCompanyName": "",
    "simType": 0,
    "collectorSn": "",
    "collectorName": "",
    "collectorId": 0,
    "belongSystemName": "",
    "isCollector": 0,
    "expireStatus": 0
  }
}

设备接口

# 设备接口

# 查询该设备下授权给我的所有指令

# 发送指令V2

# 设备实时数据

# 查询设备历史数据

# 设备列表分页查询(停止维护)

# 设备列表分页查询V2(推荐)

# 获取采集器sim卡信息

设备接口

查询该设备下授权给我的所有指令

发送指令V2

设备实时数据

查询设备历史数据

设备列表分页查询(停止维护)

设备列表分页查询V2(推荐)

获取采集器sim卡信息