注意:
- 本接口为对于设备控制指令下发接口的通用描述,如果您的设备已在平台实现设备控制功能,需要获取进一步的指令描述文档后方可操作此接口。
- 单OpenApi账号调用接口的每分钟请求数最大限制:50
| 设备控制指令下发 | | | | |
| —- | —- | —- | —- | —- |
| 接口描述 | 支持通过OpenApi,进行设备控制指令下发 | | | |
| 请求URL | https://api.solarmanpv.com/device/v1.0/remoteControl | | | |
| 请求方式 | post | | | |
| 请求类型 | application/json | | | |
| 返回类型 | / | | | |
| 请求参数 | | | | |
| 参数名 | 数据类型 | 参数类型 | 是否必填 | 描述说明 |
| language | string | query | N | 语言类型,示例值:zh |
| authorization | string | header | Y | accessToken,示例值:eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9 |
| callBackUrl | string | body | Y | 指令结果回调地址 ,示例值:https://www.solarman.cn/
回调结果中的响应参数定义见下文
回调地址请求类型:POST
发送完指令后 ,前60秒每3秒请求一次指令结果,60秒之后每30秒请求一次指令结果,有指令结果后就发起回调, 回调方需要返回“SUCCESS”响应,否则会重新发起回调,超过 600s 仍然无法回调成功则丢弃,不再回调 | | content | string | body | Y | 下发给设备的指令内容 ,示例值:{“inputParam”:[{value:190}]} | | controlCode | string | body | Y | 控制编码 ,示例值:1100,s_kgjsn | | deviceSN | string | body | Y | 设备在平台内的唯一标识 ,示例值:200124137 | | timeoutSeconds | INT | body | N | 控制命令的超时时间,若超过该时间没有收到反馈结果则判定为指令失败。该时间默认600秒。
可自定义输入的范围为10-600秒 | | 响应参数 | | | | | | 参数名 | 数据类型 | 描述说明 | | | | code | string | 信息码 ,示例值:10000 | | | | msg | string | 信息描述 ,示例值:success | | | | success | boolean | 是否成功 ,示例值:true | | | | requestId | string | 请求标识 ,示例值:1d6f6eca9bee4b6483d4af064b659eec | | | | collectionTime | string | 设备最新数据接收时间戳,示例值:1615900034 | | | | connectStatus | INT | 平台定义的设备通讯状态 0:离线 1:在线 | | | | orderId | string | 指令任务的ID | | | | 示例 | | | | | | 请求参数 | {
“controlCode”:”1107,r_kgjsn”,
“deviceSN”:”1800800121-Igen”,
“timeoutSeconds”:120,
“callBackUrl”:”http://localhost:8019/device/v1.0/callback“,
“content”:”{\“inputParam\“:[{\“value\“:\“190\“,\“ext\“:\“\“,\“oValue\“:\“190\“}]}”
} | | | | | 返回值 | {
“code”: null,
“msg”: null,
“success”: true,
“requestId”: “311d34904f1841999f2f58b9b43f8719”,
“collectionTime”:”1615900034”,
“connectStatus”:1,
“orderId”:”19928812”
} | | | |
回调结果-响应参数说明
响应参数 | ||
---|---|---|
参数名 | 数据类型 | 描述说明 |
ack | string | 设备反馈的原始数值,示例值:010302000A3843 |
analysisResult | string | 平台解析后的业务数值,示例值:10 |
content | string | 平台下发的指令内容,示例值:01030BFB0001F7DF |
createTime | string | 指令任务的创建时间,示例值:1615342904000 |
deviceId | string | 设备在平台内的唯一标识 ,示例值:252525 |
deviceSn | string | 设备的唯一标识 ,示例值:12583SS |
orderId | string | 指令任务的ID |
success | boolean | 指令任务的反馈结果,成功:true 失败:false |
updateTime | string | 指令任务的反馈时间,示例值:1615342904000 |
示例 | ||
请求参数 | { “ack”:”010302000A3843”, “analysisResult”:”10”, “content”:”01030BFB0001F7DF”, “createTime”:1615342904000, “deviceId”:205546783, “deviceSn”:”120D70206040057”, “orderId”:1011830, “success”:true, “updateTime”:1615343254000 } |
|
返回值 | SUCCESS |
注意:回调返回值为大写SUCCESS字符串,不需要返回json