智电平台开放接口文档
API鉴权
申请接入
我司向用户开放接口调用,由用户系统内自定义一对openKey和openSecret,
openKey 账号
openSecret 密钥
遵循接口规范调用
鉴权
所有api接口调用,HTTP Header(头)里加参数'Authorization':
Authorization: ${Authorization}
${Authorization}格式定义为:basic=${basic}&sign=${sign}
其中:
${basic}=base64(openKey:openSecret),base64编码。
${sign}=md5(params),md5加密,32位大写。
(1) params为请求参数按key的ASCII码自然升序拼接,每个参数都采用key=value形式,参数之间使用'&'作为分隔符,
(2) 若无入参,则传固定数值md5(zhuowen=electric),即0155FB5B3C1D28EE3D1DC1A52B9ECE1C
(3) 若为url path传参,则没有key,此时将key固定为“param”,即md5(param=${value})
例如:
openKey=zhuowen
openSecret=8a8da85ab1a410141df56612d4c325696
参数部分 eqpNumber=90878888,pathAddr=1,startTime=2018-08,endTime=2020-05
则:
${basic}=base64(zhuowen:8a8da85ab1a410141df56612d4c325696),即${basic}=emh1b3dlbjo4YThkYTg1YWIxYTQxMDE0MWRmNTY2MTJkNGMzMjU2OTY=
${sign}=md5(endTime=2020-05&eqpNumber=90878888&pathAddr=1&startTime=2018-08),即${sign}=EE68C10812702FCD054FECC01E879D6F
Header中Authorization完整传参即为:
Authorization: basic=emh1b3dlbjo4YThkYTg1YWIxYTQxMDE0MWRmNTY2MTJkNGMzMjU2OTY=&sign=EE68C10812702FCD054FECC01E879D6F
API列表
查询设备列表
请求方式:GET
URL: ${OpenAPI}/electric/open/v1/eqp/list
请求参数
参数名称 | 参数类型 | 是否必须 | 说明 |
---|---|---|---|
返回值(JSON格式数据)
参数名称 | 参数类型 | 说明 |
---|---|---|
code | int | 错误码,0表示成功,详见附录3.4 |
msg | String | 错误消息描述,“success”表示成功 |
data | String | 数据对象,详见data描述 |
data描述 | ||
list | JSON | 对象JSON数组,详见对象描述 |
对象描述 | ||
id | int | 设备id |
eqpNumber | String | 设备号 |
eqpType | String | 设备类型,详见附录3.1 |
eqpModel | String | 设备型号 |
softVersion | String | 软件版本号 |
hardVersion | String | 硬件版本号 |
eqpName | String | 设备名 |
eqpStatus | String | 设备在线状态,0-离线 1-在线 |
createTime | Long | 设备创建时间,GMT+8 |
请求示例
GET ${OpenAPI}/electric/open/v1/eqp/list? HTTP/1.1
返回示例
{
"code": 0,
"msg": "success",
"data": [
{
"id": 1,
"eqpNumber": "90878888",
"eqpType": "2",
"eqpModel": "ZW1-T485",
"softVersion": "0.08",
"hardVersion": "1.00",
"eqpName": "0032",
"eqpStatus": "1",
"createTime": 1603098717
},
{
"id": 2,
"eqpNumber": "90878889",
"eqpType": "1",
"eqpModel": null,
"softVersion": null,
"hardVersion": null,
"eqpName": null,
"eqpStatus": "0",
"createTime": 1604395249
}
]
}
添加设备
请求方式:POST
URL: ${OpenAPI}/electric/open/v1/eqp/save
请求参数
Body参数(JSON格式)
参数名称 | 参数类型 | 是否必须 | 说明 |
---|---|---|---|
eqpNumber | String | 是 | 设备号 |
eqpType | String | 是 | 设备类型,详见附录3.1 |
eqpModel | String | 否 | 设备型号 |
eqpName | String | 否 | 设备名称 |
返回值(JSON格式数据)
参数名称 | 参数类型 | 说明 |
---|---|---|
code | int | 错误码,0表示成功,详见附录3.4 |
msg | String | 错误消息描述,“success”表示成功 |
data | String | 数据对象,详见data描述 |
data描述 |
请求示例
POST ${OpenAPI}/electric/open/v1/eqp/save HTTP/1.1
返回示例
{
"code": 8001,
"msg": "already exists",
"data": null
}
删除设备
请求方式:DELETE
URL: ${OpenAPI}/electric/open/v1/eqp/delete/{eqpNumber}
请求参数
PATH参数
参数名称 | 参数类型 | 是否必须 | 说明 |
---|---|---|---|
eqpNumber | String | 是 | 设备号 |
返回值(JSON格式数据)
参数名称 | 参数类型 | 说明 |
---|---|---|
code | int | 错误码,0表示成功,详见附录3.4 |
msg | String | 错误消息描述,“success”表示成功 |
data | String | 数据对象,详见data描述 |
data描述 |
请求示例
DELETE ${OpenAPI}/electric/open/v1/eqp/delete/90878888 HTTP/1.1
返回示例
{
"code": 0,
"msg": "success",
"data": null
}
查询线路列表
请求方式:GET
URL: ${OpenAPI}/electric/open/v1/eqp/path/list
请求参数
URL参数
参数名称 | 参数类型 | 是否必须 | 说明 |
---|---|---|---|
eqpNumber | String | 是 | 设备号 |
返回值(JSON格式数据)
参数名称 | 参数类型 | 说明 |
---|---|---|
code | int | 错误码,0表示成功,详见附录3.4 |
msg | String | 错误消息描述,“success”表示成功 |
data | String | 数据对象,详见data描述 |
data描述 | ||
list | JSON | 对象JSON数组,详见对象描述 |
对象描述 | ||
id | int | 设备id |
eqpNumber | String | 设备号 |
pathAddr | int | 线路地址 |
pathStatus | String | 线路状态 open-合闸 close-分闸 |
pathType | String | 线路类型 220-单相 380-三相 |
pathModel | String | 线路型号 |
switchMode | String | 开关模式 0-正常 1-远程锁控 |
isTotal | String | 是否总路 0-否 1-是 |
isLeak | String | 是否支持漏保 0-否 1-是 |
pathName | String | 线路名称 |
createTime | Long | 设备创建时间,GMT+8 |
请求示例
GET ${OpenAPI}/electric/open/v1/eqp/path/list? HTTP/1.1
返回示例
{
"code": 0,
"msg": "success",
"data": [
{
"id": 1,
"eqpNumber": "90878888",
"pathAddr": 1,
"pathStatus": "close",
"pathType": "220",
"pathModel": "ZWB1-16/1P",
"switchMode": "0",
"isTotal": "0",
"isLeak": "1",
"pathName": "线路1",
"createTime": "2020-12-12 12:12:12"
},
{
"id": 2,
"eqpNumber": "90878888",
"pathAddr": 2,
"pathStatus": "open",
"pathType": "380",
"pathModel": "ZWB1LE-80/3P",
"switchMode": "0",
"isTotal": "1",
"isLeak": "1",
"pathName": "线路2",
"createTime": "2020-12-12 12:12:12"
}
]
}
添加线路
请求方式:POST
URL: ${OpenAPI}/electric/open/v1/eqp/path/save
请求参数
Body传参JSON格式数据
参数名称 | 参数类型 | 是否必须 | 说明 |
---|---|---|---|
eqpNumber | String | 是 | 设备号 |
pathAddr | int | 是 | 线路地址, 1,2,3...依次排列 |
isLeak | String | 是 | 是否支持漏保 |
isTotal | String | 是 | 是否总路 |
pathModel | String | 否 | 线路型号 |
pathName | String | 否 | 线路名称 |
返回值(JSON格式数据)
参数名称 | 参数类型 | 说明 |
---|---|---|
code | int | 错误码,0表示成功,详见附录3.4 |
msg | String | 错误消息描述,“success”表示成功 |
data | String | 数据对象,详见data描述 |
data描述 |
请求示例
POST ${OpenAPI}/electric/open/v1/eqp/path/save HTTP/1.1
返回示例
{
"code": 0,
"msg": "success",
"data": null
}
删除线路
请求方式:DELETE
URL: ${OpenAPI}/electric/open/v1/eqp/path/delete
请求参数
Body参数(JSON格式)
参数名称 | 参数类型 | 是否必须 | 说明 |
---|---|---|---|
eqpNumber | String | 是 | 设备号 |
pathAddr | int | 是 | 线路地址 |
返回值(JSON格式数据)
参数名称 | 参数类型 | 说明 |
---|---|---|
code | int | 错误码,0表示成功,详见附录3.4 |
msg | String | 错误消息描述,“success”表示成功 |
data | String | 数据对象,详见data描述 |
data描述 |
请求示例
DELETE ${OpenAPI}/electric/open/v1/eqp/delete/90878888 HTTP/1.1
返回示例
{
"code": 0,
"msg": "success",
"data": null
}
查询线路实时数据
请求方式:GET
URL: ${OpenAPI}/electric/open/v1/eqp/path/realtime
请求参数
URL参数
参数名称 | 参数类型 | 是否必须 | 说明 |
---|---|---|---|
eqpNumber | String | 是 | 设备号 |
pathAddr | String | 是 | 线路地址 |
返回值(JSON格式数据)
参数名称 | 参数类型 | 说明 |
---|---|---|
code | int | 错误码,0表示成功,详见附录3.4 |
msg | String | 错误消息描述,“success”表示成功 |
data | String | 数据对象,详见data描述 |
data描述 | ||
pathAddr | int | 线路地址 |
pathStatus | String | 线路分合闸状态,open-合闸 close-分闸 |
pathType | String | 线路类型,220-单相 380-三相 |
softVersion | String | 软件版本号 |
hardVersion | String | 硬件版本号 |
单相数据描述 | ||
g_A | String | 开关电流,单位A,精度0.01 |
g_T | String | 开关温度,单位:摄氏度,精度:0.1 |
g_V | String | 开关电压(入线),单位:V, 精度:0.1 |
g_P | String | 开关有功功率,单位:W |
g_VAR | String | 开关无功功率,单位:var |
g_LA | String | 开关漏电流,单位:mA, 精度:0.01 |
g_PF | String | 功率因数 |
g_F | String | 频率(入线),单位:Hz |
g_E | String | 电量,单位:kW·h |
三相开关数据 | ||
g_A | String | 开关电流,单位:A, 精度:0.01 |
g_T | String | 开关温度,单位:摄氏度,精度:0.1 |
g_V | String | 开关电压,单位:V, 精度:0.1 |
g_P | String | 开关有功功率,单位:W |
g_VAR | String | 开关无功功率,单位:var |
g_LA | String | 开关漏电流,单位:mA, 精度:0.01 |
g_PF | String | 功率因数 |
g_F | String | 频率,单位:Hz |
g_E | String | 电量,单位:kW·h |
a_A | String | A相电流,单位:A, 精度:0.01 |
a_T | String | A相温度,单位:摄氏度,精度:0.1 |
a_V | String | A相电压,单位:V, 精度:0.1 |
a_P | String | A相有功功率,单位:W |
b_A | String | B相电流,单位:A, 精度:0.01 |
b_T | String | B相温度,单位:摄氏度,精度:0.1 |
b_V | String | B相电压,单位:V, 精度:0.1 |
b_P | String | B相有功功率,单位:W |
c_A | String | C相电流,单位:A, 精度:0.01 |
c_T | String | C相温度,单位:摄氏度,精度:0.1 |
c_V | String | C相电压,单位:V, 精度:0.1 |
c_P | String | C相有功功率,单位:W |
请求示例
GET ${OpenAPI}/electric/open/v1/eqp/path/realtime?eqpNumber=90878888&pathAddr=1 HTTP/1.1
返回示例
{
"code": 0,
"msg": "success",
"data": {
"pathAddr": 1,
"pathStatus": "close",
"pathType": "380",
"softVersion": "0.02",
"hardVersion": "0.01",
"g_A": "0.00",
"g_T": "26.8",
"g_P": "0",
"g_V": "0.01",
"a_T": "26.8",
"a_A": "0.00",
"b_A": "0.00",
"a_P": "0",
"c_P": "0",
"a_V": "0.01",
"b_V": "0.01",
"c_T": "23.7",
"c_V": "0.01",
"b_P": "0",
"c_A": "0.00",
"b_T": "24.2",
"g_VAR": "0",
"g_LA": "0.00",
"g_PF": "655.35",
"g_E": "0.0",
"g_F": "0.0"
}
}
查询使能设置信息
请求方式:GET
URL: ${OpenAPI}/electric/open/v1/eqp/path/alarm/settings
请求参数
URL参数
参数名称 | 参数类型 | 是否必须 | 说明 |
---|---|---|---|
eqpNumber | String | 是 | 设备号 |
pathAddr | String | 是 | 线路地址 |
type | String | 否 | 类型,1-报警 2-预警,默认为1 |
返回值(JSON格式数据)
参数名称 | 参数类型 | 说明 |
---|---|---|
code | int | 错误码,0表示成功,详见附录3.4 |
msg | String | 错误消息描述,“success”表示成功 |
data | String | 数据对象,详见data描述 |
data描述 | ||
T_P_V | String | 过功使能值 |
T_P_E | String | 过功使能开启状态, Y-开启 N-关闭 |
T_C_V | String | 过流使能值 |
T_C_E | String | 过流使能开启状态, Y-开启 N-关闭 |
T_T_V | String | 过温使能值 |
T_T_E | String | 过温使能开启状态, Y-开启 N-关闭 |
T_LC_V | String | 漏电使能值 |
T_LC_E | String | 漏电使能开启状态, Y-开启 N-关闭 |
T_V_V | String | 过压使能值 |
T_V_E | String | 过压使能开启状态, Y-开启 N-关闭 |
L_V_V | String | 欠压使能值 |
L_V_E | String | 欠压使能开启状态, Y-开启 N-关闭 |
请求示例
GET ${OpenAPI}/electric/open/v1/eqp/path/alarm/settings?eqpNumber=90878888&pathAddr=1&type=2 HTTP/1.1
返回示例
{
"code": 0,
"msg": "success",
"data": {
"T_P_V": "15900",
"L_V_V": "190",
"L_V_E": "N",
"T_T_E": "Y",
"T_C_V": "66",
"T_C_E": "Y",
"T_P_E": "Y",
"T_LC_V": "30",
"T_T_V": "70",
"T_LC_E": "N",
"T_V_E": "Y",
"T_V_V": "250"
}
}
查询报警列表
请求方式:GET
URL: ${OpenAPI}/electric/open/v1/eqp/alarm/list
请求参数
URL参数
参数名称 | 参数类型 | 是否必须 | 说明 |
---|---|---|---|
eqpNumber | String | 是 | 设备号 |
pathAddr | String | 是 | 线路地址 |
startTime | String | 否 | 查询开始时间,格式为yyyy-MM-dd HH:mm:ss |
endTime | String | 否 | 查询结束时间,格式为yyyy-MM-dd HH:mm:ss |
current | String | 否 | 分页参数,当前页,默认为1 |
size | String | 否 | 分页参数,每页大小,默认为10 |
type | String | 否 | 类型,1-报警 2-预警 |
返回值(JSON格式数据)
参数名称 | 参数类型 | 说明 |
---|---|---|
code | int | 错误码,0表示成功 |
msg | String | 错误消息描述,“success”表示成功 |
data | String | 数据对象,详见data描述 |
data描述 | ||
total | int | 总数 |
size | int | 每页大小 |
totalPage | int | 总页数 |
current | int | 当前页 |
list | JSON | 对象JSON数组,详见对象描述 |
对象描述 | ||
id | int | 记录id |
eqpNumber | String | 设备号 |
pathAddr | int | 线路地址 |
alarmTime | String | 报警发生时间,格式yyyy-MM-dd HH:mm:ss |
alarmTimeDay | String | 报警发生日期,格式yyyy-MM-dd |
alarmTimeHour | String | 报警所属小时,24小时制 |
type | String | 类型,1-报警 2-预警 |
alarmType | String | 报警类型,详见附录3.3 |
alarmTypeName | String | 报警类型名称 |
pathType | String | 线路类型, 220-单相 380-三相 |
请求示例
GET ${OpenAPI}/electric/open/v1/eqp/alarm/list?eqpNumber=90878888&pathAddr=3&type=2&startTime=2020-09-02 13:28:43&endTime=2020-11-02 13:28:43¤t=1&size=4 HTTP/1.1
返回示例
{
"code": 0,
"msg": "success",
"data": {
"total": 12,
"size": 4,
"totalPage": 3,
"current": 1,
"list": [
{
"id": 1,
"eqpNumber": "90878888",
"pathAddr": 3,
"alarmTime": "2020-10-29 13:46:36",
"alarmTimeDay": "2020-10-29",
"alarmTimeHour": "13",
"type": "2",
"alarmType": "10",
"alarmTypeName": "过压预警",
"pathType": "220"
},
{
"id": 2,
"eqpNumber": "90878888",
"pathAddr": 3,
"alarmTime": "2020-10-29 13:46:36",
"alarmTimeDay": "2020-10-29",
"alarmTimeHour": "13",
"type": "1",
"alarmType": "9",
"alarmTypeName": "过压报警",
"pathType": "220"
},
{
"id": 3,
"eqpNumber": "90878888",
"pathAddr": 3,
"alarmTime": "2020-10-29 13:46:36",
"alarmTimeDay": "2020-10-29",
"alarmTimeHour": "13",
"type": "2",
"alarmType": "8",
"alarmTypeName": "过流预警",
"pathType": "220"
},
{
"id": 4,
"eqpNumber": "90878888",
"pathAddr": 3,
"alarmTime": "2020-10-29 13:46:36",
"alarmTimeDay": "2020-10-29",
"alarmTimeHour": "13",
"type": "1",
"alarmType": "7",
"alarmTypeName": "过流报警",
"pathType": "220"
}
]
}
}
查询设备日用电量
请求方式:GET
URL: ${OpenAPI}/electric/open/v1/eqp/energy/day
请求参数
URL参数
参数名称 | 参数类型 | 是否必须 | 说明 |
---|---|---|---|
eqpNumber | String | 是 | 设备号 |
day | String | 是 | 查询日期,格式yyyy-MM-dd |
返回值(JSON格式数据)
参数名称 | 参数类型 | 说明 |
---|---|---|
code | int | 错误码,0表示成功,详见附录3.4 |
msg | String | 错误消息描述,“success”表示成功 |
data | String | 数据对象,详见data描述 |
data描述 | ||
list | JSON | 对象JSON数组,详见对象描述 |
对象描述 | ||
key | String | 此处为线路地址 |
value | String | 此处为电量值 |
请求示例
GET ${OpenAPI}/electric/open/v1/eqp/energy/day?eqpNumber=90878888&day=2020-10-22 HTTP/1.1
返回示例
{
"code": 0,
"msg": "success",
"data": [
{
"key": "1",
"value": "0.0"
},
{
"key": "2",
"value": "0.0"
},
{
"key": "3",
"value": "0.0"
}
]
}
查询设备小时用电量
请求方式:GET
URL: ${OpenAPI}/electric/open/v1/eqp/energy/hour
请求参数
URL参数
参数名称 | 参数类型 | 是否必须 | 说明 |
---|---|---|---|
eqpNumber | String | 是 | 设备号 |
day | String | 是 | 查询日期,格式yyyy-MM-dd |
hour | String | 是 | 小时,24小时制 |
返回值(JSON格式数据)
参数名称 | 参数类型 | 说明 |
---|---|---|
code | int | 错误码,0表示成功,详见附录3.4 |
msg | String | 错误消息描述,“success”表示成功 |
data | String | 数据对象,详见data描述 |
data描述 | ||
list | JSON | 对象JSON数组,详见对象描述 |
对象描述 | ||
key | String | 此处为线路地址 |
value | String | 此处为电量值 |
请求示例
GET ${OpenAPI}/electric/open/v1/eqp/energy/hour?eqpNumber=90878888&day=2020-10-22&hour=12 HTTP/1.1
返回示例
{
"code": 0,
"msg": "success",
"data": [
{
"key": "1",
"value": "0.0"
},
{
"key": "2",
"value": "0.0"
},
{
"key": "3",
"value": "0.0"
}
]
}
查询设备日最大温度
请求方式:GET
URL: ${OpenAPI}/electric/open/v1/eqp/temperature/day
请求参数
URL参数
参数名称 | 参数类型 | 是否必须 | 说明 |
---|---|---|---|
eqpNumber | String | 是 | 设备号 |
day | String | 是 | 查询日期,格式yyyy-MM-dd |
返回值(JSON格式数据)
参数名称 | 参数类型 | 说明 |
---|---|---|
code | int | 错误码,0表示成功,详见附录3.4 |
msg | String | 错误消息描述,“success”表示成功 |
data | String | 数据对象,详见data描述 |
data描述 | ||
list | JSON | 对象JSON数组,详见对象描述 |
对象描述 | ||
key | String | 此处为线路地址 |
value | String | 此处为温度值 |
请求示例
GET ${OpenAPI}/electric/open/v1/eqp/temperature/day?eqpNumber=90878888&day=2020-10-22 HTTP/1.1
返回示例
{
"code": 0,
"msg": "success",
"data": [
{
"key": "1",
"value": "0.0"
},
{
"key": "2",
"value": "0.0"
},
{
"key": "3",
"value": "0.0"
}
]
}
查询设备小时最大温度
请求方式:GET
URL: ${OpenAPI}/electric/open/v1/eqp/temperature/hour
请求参数
URL参数
参数名称 | 参数类型 | 是否必须 | 说明 |
---|---|---|---|
eqpNumber | String | 是 | 设备号 |
day | String | 是 | 查询日期,格式yyyy-MM-dd |
hour | String | 是 | 小时,24小时制 |
返回值(JSON格式数据)
参数名称 | 参数类型 | 说明 |
---|---|---|
code | int | 错误码,0表示成功,详见附录3.4 |
msg | String | 错误消息描述,“success”表示成功 |
data | String | 数据对象,详见data描述 |
data描述 | ||
list | JSON | 对象JSON数组,详见对象描述 |
对象描述 | ||
key | String | 此处为线路地址 |
value | String | 此处为温度值 |
请求示例
GET ${OpenAPI}/electric/open/v1/eqp/temperature/hour?eqpNumber=90878888&day=2020-10-22&hour=12 HTTP/1.1
返回示例
{
"code": 0,
"msg": "success",
"data": [
{
"key": "1",
"value": "0.0"
},
{
"key": "2",
"value": "0.0"
},
{
"key": "3",
"value": "0.0"
}
]
}
查询设备日平均电压
请求方式:GET
URL: ${OpenAPI}/electric/open/v1/eqp/voltage/day
请求参数
URL参数
参数名称 | 参数类型 | 是否必须 | 说明 |
---|---|---|---|
eqpNumber | String | 是 | 设备号 |
day | String | 是 | 查询日期,格式yyyy-MM-dd |
返回值(JSON格式数据)
参数名称 | 参数类型 | 说明 |
---|---|---|
code | int | 错误码,0表示成功,详见附录3.4 |
msg | String | 错误消息描述,“success”表示成功 |
data | String | 数据对象,详见data描述 |
data描述 | ||
list | JSON | 对象JSON数组,详见对象描述 |
对象描述 | ||
key | String | 此处为线路地址 |
value | String | 此处为电压值 |
请求示例
GET ${OpenAPI}/electric/open/v1/eqp/voltage/day?eqpNumber=90878888&day=2020-10-22 HTTP/1.1
返回示例
{
"code": 0,
"msg": "success",
"data": [
{
"key": "1",
"value": "0.0"
},
{
"key": "2",
"value": "0.0"
},
{
"key": "3",
"value": "0.0"
}
]
}
查询设备小时平均电压
请求方式:GET
URL: ${OpenAPI}/electric/open/v1/eqp/voltage/hour
请求参数
URL参数
参数名称 | 参数类型 | 是否必须 | 说明 |
---|---|---|---|
eqpNumber | String | 是 | 设备号 |
day | String | 是 | 查询日期,格式yyyy-MM-dd |
hour | String | 是 | 小时,24小时制 |
返回值(JSON格式数据)
参数名称 | 参数类型 | 说明 |
---|---|---|
code | int | 错误码,0表示成功,详见附录3.4 |
msg | String | 错误消息描述,“success”表示成功 |
data | String | 数据对象,详见data描述 |
data描述 | ||
list | JSON | 对象JSON数组,详见对象描述 |
对象描述 | ||
key | String | 此处为线路地址 |
value | String | 此处为电压值 |
请求示例
GET ${OpenAPI}/electric/open/v1/eqp/voltage/hour?eqpNumber=90878888&day=2020-10-22&hour=12 HTTP/1.1
返回示例
{
"code": 0,
"msg": "success",
"data": [
{
"key": "1",
"value": "0.0"
},
{
"key": "2",
"value": "0.0"
},
{
"key": "3",
"value": "0.0"
}
]
}
控制指令接口
说明:控制指令由远程服务下发设备执行,不保证一致性
请求方式:POST
URL: ${OpenAPI}/electric/open/v1/eqp/cmd
请求参数
Body参数(JSON格式)
参数名称 | 参数类型 | 是否必须 | 说明 |
---|---|---|---|
eqpNumber | String | 是 | 设备号 |
pathAddr | String | 是 | 线路地址 |
cmd | String | 是 | 控制指令类型,详见附录3.2 |
控制参数 | 见下文控制参数 |
控制指令 | 参数名称 | 参数类型 | 说明 |
---|---|---|---|
分合闸 | |||
eqpNumber | String | 设备号 | |
pathAddr | int | 线路地址 | |
operation | String | 操作 open-合闸 close-分闸 | |
手动漏保自检 | |||
eqpNumber | String | 设备号 | |
pathAddr | int | 线路地址 | |
报警使能设置(未保证执行成功率,建议其他key每次只传一个) | |||
T_P_E | String | 过功报警使能开启, Y-开启 N-关闭 | |
T_C_E | String | 过流报警使能开启, Y-开启 N-关闭 | |
T_LC_E | String | 漏电报警使能开启, Y-开启 N-关闭 | |
T_T_E | String | 过温报警使能开启, Y-开启 N-关闭 | |
T_V_E | String | 过压报警使能开启, Y-开启 N-关闭 | |
L_V_E | String | 欠压报警使能开启, Y-开启 N-关闭 | |
T_P_V | String | 过功报警使能值 | |
T_C_V | String | 过流报警使能值 | |
T_T_V | String | 过温报警使能值 | |
T_V_V | String | 过压报警使能值 | |
L_V_V | String | 欠压报警使能值 | |
预警使能设置(未保证执行成功率,建议其他key每次只传一个) | |||
T_P_E | String | 过功预警使能开启, Y-开启 N-关闭 | |
T_C_E | String | 过流预警使能开启, Y-开启 N-关闭 | |
T_LC_E | String | 漏电预警使能开启, Y-开启 N-关闭 | |
T_T_E | String | 过温预警使能开启, Y-开启 N-关闭 | |
T_V_E | String | 过压预警使能开启, Y-开启 N-关闭 | |
L_V_E | String | 欠压预警使能开启, Y-开启 N-关闭 | |
T_P_V | String | 过功预警使能值 | |
T_C_V | String | 过流预警使能值 | |
T_T_V | String | 过温预警使能值 | |
T_V_V | String | 过压预警使能值 | |
L_V_V | String | 欠压预警使能值 |
返回值(JSON格式数据)
参数名称 | 参数类型 | 说明 |
---|---|---|
code | int | 错误码,0表示成功,详见附录3.4 |
msg | String | 错误消息描述,“success”表示成功 |
data | String | 此处为空字符串 |
请求示例
{
"eqpType": "4",
"operation": "close",
"eqpNumber": "1515acds",
"pathAddr": "1"
}
返回示例
{
"code": 0,
"msg": "success",
"data": ""
}
附录
设备类型
类型 | 说明 |
---|---|
1 | NB-IoT通讯主机 |
2 | RS485通讯主机 |
3 | 蓝牙通讯主机 |
4 | 以太网通讯主机 |
5 | WiFi通讯主机 |
6 | 电力线载波通讯主机 |
7 | 4G通讯主机 |
控制指令类型
类型 | 说明 |
---|---|
SET-OC | 线路分合闸 |
SET-LEAK | 手动漏保自检 |
SET-ALARM | 报警使能设置 |
SET-WARN | 预警使能设置 |
报警类型
类型 | 说明 |
---|---|
0 | 短路报警 |
1 | 漏电报警 |
2 | 漏电预警 |
3 | 过功报警 |
4 | 过功预警 |
5 | 过温报警 |
6 | 过温预警 |
7 | 过流报警 |
8 | 过流预警 |
9 | 过压报警 |
10 | 过压预警 |
11 | 欠压报警 |
12 | 欠压预警 |
错误码
状态码(code) | 错误提示(msg) | 说明 |
---|---|---|
0 | success | 请求成功 |
1002 | Method not supported | 请求方式不支持,请检查接口请求方式 |
8001 | Service unavailable | 服务不可用 |
8002 | Auth failed | 鉴权失败,请检查鉴权或者签名 |
8003 | Invalid parameters | 参数请求无效 |
通讯电源产品调试说明
485通讯+电源
1.1操作步骤
(1)首先通讯电源接通AC 220V供电,然后使用USB转485串口工具线将通讯电源与上位机(电脑)连接。
USB转485串口工具线:
连接方法:
(2)打开串口调试助手(下载地址见附录), 对外通信RS485(9600-N-8-1),串口调试助手设置如下图:
(3)可选中自动发送校验位 , 选择CRC16 for MODBUS。
(4)在此处按照modbus协议指令调试即可(详见卓文科技485通讯协议)。
Wi-Fi通讯+电源
1 操作步骤
1.1 连接方式。
(1) WIFI通讯电源采用小型化模组WIFI模块,采用一体化的设计,485接口为预留。通讯电源采用AC 220V供电。
(2)操作步骤
①长按通讯电源橘红色按钮。
②等待SYS灯灭后,松手(大概3-5s)。
③等待BUS灯常亮。
④手机连接到WIFI (2.4GHz) 打开配置app(下载地址见附录)。
⑤配置app输入当前手机连接的wifi密码, 点确认开始配置,等待配置完成。
⑥等待SYS灯灭后,BUS灯再次亮起后,表示WIFI连接成功。
注意事项:
1、需要给应用定位权限,否则无法使用WiFi配置
2、WiFi配置需使用2.4G频段,5G频段无法配置主机
3、使用WiFi无密码时,不需要输入密码即可设置
4、最多同时配置5台设备
5、主机配置成功后,重启过程中不能断电及使用重启按键
6、ios在配置主机过程中退出WiFi配置界面会自动取消配置
7、配置成功后,需要手动添加设备
以太网通讯+电源
1 操作步骤
1.1 连接方式
以太网通讯电源采用小型化以太网模组,采用一体化的设计。通讯电源采用AC 220V供电。
1.2 网络配置
①将通讯电源和安装了上位机软件(NetModuleConfig)的电脑处于同一局域网下,或通讯电源与电脑用网线直连。
②打开NetModuleConfig。
③选择本机网络适配器。
④点击搜索设备。
⑤选中双击要修改的设备。
⑥自行修改网络参数。
⑦配置设备参数。
⑧操作完成,可利用网络调试助手(见附录)或直接对接协议开始调试。
四 指示灯说明
1.3功能特点
(1)为整个设备电子端提供电源。
(2)多种通讯方式,向下子设备通讯功能、向上连接云平台,提供传输数据,数据计算分析存储功能。
(3)mcu自带时钟,确保脱网计时精准。
1.4技术参数
输入电压 | 90VAC~264VAC 50HZ |
---|---|
最大功耗 | 0.5W |
输出电压 | 12VDC |
最大输出电流 | 0.85A |
通讯方式 | 485、wifi、以太网通讯方式 |
工具下载
串口调试助手下载地址:
网络调试助手下载地址:
WIFI配置手机app下载地址:
以太网配置工具下载地址:
卓文科技-固件升级手册
485主机固件升级
1.说明
适用于485主机(第二代)固件升级
工具:J-Flash V5.00K
2.烧录说明
l 断开强电
l 正确连接设备
3.接线图
4.烧录步骤
4.1打开J-Flash
4.2设置参数
4.2.1选择CPU
4.2.2选择烧录方式
4.3选择固件
4.4建立连接
4.5烧录
4.6断开连接
单相空开1P2P-固件升级
1.说明
适用于 单项空开-2P
工具:
采用STC官方的“STC ISP 下载软件”;
下载地址:
2.升级说明
l 断开强电
l 接线端子接入左侧
3.接线图
3.1升级线制作
4.升级步骤
4.1打开STC-ISP
4.2根据实际情况选择串口号
4.3选择RS485控制
4.4点击下载/编程,开始升级
三相空开3P4P-固件升级
1.说明
适用于三相空开通过RS485接口升级固件使用。
工具:SecureCRT
2.升级说明
l 断开强电
l 接入左侧接线端子
3.接线图
3.1升级线制作
4.操作步骤
4.1打开 SecureCRT
4.2将LOCK开关拨到LOCK 位置
4.3按住RESERT 按钮,上电
4.4打开串口
4.4.1选择 File -> Connect
4.4.2新建 Session
4.4.3选择串口,Serial
4.4.4根据实际情况,选择串口号
4.4.5设置串口参数
4.4.6完成串口信息配置
4.4.7打开串口
4.5升级固件
4.5.1Transfer -> Send Ymodem
4.5.2选则固件,后缀为:.bin
4.5.3等待升级完成,关闭串口