atess-server-openapi
  1. OpenAPI-HPS
atess-server-openapi
  • Record
  • 1. the first step Authorization
  • 2.the seccond step add Plant
  • 3.the third step add DataLog
  • OpenAPI-BMS
    • Get base info of BCU
      GET
    • Get base info of BCU list
      GET
    • Get historical data of BCU
      GET
    • Get the latest real-time data of BCU
      GET
    • Get setting of BUC
      GET
    • Modify setting of BCU
      PUT
    • Get base info of MBMS
      GET
    • Get base info of MBMS list
      GET
    • Get historical data of MBMS
      GET
    • Get the latest real-time data of MBMS
      GET
    • Get setting of MBMS
      GET
    • Modify setting of MBMS
      PUT
  • OpenAPI-DataLog
    • Get DataLog
    • Add DataLog
    • Delete DataLog
    • Get DataLog list
  • OpenAPI-HPS
    • Get Central type base info of HPS
      GET
    • Get Central type base info of HPS list
      GET
    • Get historical data of Central type HPS
      GET
    • Get the latest real-time data of Central type HPS
      GET
    • Get setting of Central type HPS
      GET
    • Modify setting of Central type HPS
      PUT
    • Get String type base info of HPS
      GET
    • Get String type base info of HPS list
      GET
    • Get historical data of String type HPS
      GET
    • Get the latest real-time data of String type HPS
      GET
    • Get setting of String type HPS
      GET
    • Modify setting of String type HPS
      PUT
  • OpenAPI-PBD
    • Get base info of PBD
    • Get base info of PBD list
    • Get historical data of PBD
    • Get the latest real-time data of PBD
    • Get setting of PBD
    • Modify setting of PBD
  • OpenAPI-PCS
    • Get base info of PCS
    • Get base info of PCS list
    • Get historical data of PCS
    • Get the latest real-time data of PCS
    • Get setting of PCS
    • Modify setting of PCS
  • OpenAPI-Plant
    • Get the basic information of the power station
    • Add power station
    • Modify the basic information of the power station
    • Delete power station
    • Get a list of power stations
  1. OpenAPI-HPS

Get the latest real-time data of Central type HPS

Prod Env
https://www.enerclo-atesspower.com
Prod Env
https://www.enerclo-atesspower.com
GET
https://www.enerclo-atesspower.com
/api/v1/hps/data-last
OpenAPI-HPS

Limit the frequency#

The frequency of acquisition is once every 5 minutes

Request Header#

HeaderValueDescription
Authorization############ your token ############Permission validation
Accept-LanguageenEnglish Message

Request Param#

Method : GET
KeyValue Type
deviceSnString
https://www.enerclo-atesspower.com/api/v1/hps/data-last?deviceSn=xxxxxxx

Response Body#

{
    "code": 0,
    "data": {
        "bipvBuck1": 0,
......
        "vpvwn": 0
    },
    "msg": "operate successfully"
}
code: value 200 is a success, anything else is an exception
data: result data
msg: result message,code=200 is usually empty
codedescription
200succeed
500fail
400not fount
403No access
...Other exceptions

Response Data Description#

The corresponding field in the interface return value, if not specified, indicates that the field exists in all devices of the model. The parameters corresponding to special models are explained as follows.

HPS100HV,HPS150HV models additional parameters#

parameterdevice typedesc
bvbusHPS100HV/HPS150HVBus Voltage
vpvHPS100HV/HPS150HVPV1 Positive Voltage
vpv2HPS100HV/HPS150HVPV1 Negative Voltage
pv1VoltHPS100HV/HPS150HVPV1 Voltage
vpv3HPS100HV/HPS150HVPV2 Positive Voltage
pv2NegVoltHPS100HV/HPS150HVPV2 Negative Voltage
pv2VoltHPS100HV/HPS150HVPV2 Voltage
pv3PosVoltHPS100HV/HPS150HVPV3 Positive Voltage
pv3NegVoltHPS100HV/HPS150HVPV3 Negative Voltage
pv3VoltHPS100HV/HPS150HVPV3 Voltage
ibuck1HPS100HV/HPS150HVPV1 L_Current
ibuck2HPS100HV/HPS150HVPV2 L_Current
bipvBuck3HPS100HV/HPS150HVPV3 L_Current
ppvHPS100HV/HPS150HVPV1 Power
ppv2HPS100HV/HPS150HVPV2 Power
ppv3HPS100HV/HPS150HVPV3 Power
ppv1HPS100HV/HPS150HVTotal PV Power

Request

Query Params
deviceSn
string 
required
PCS SN
Header Params
Authorization
string 
required
Token
CompanyType
string 
optional
客制化
Accept-Language
string 
required
Default:
en

Responses

🟢200成功
*/*
OK
Body
code
integer <int32>
optional
code
data
object (OpenApiCentralTypeHpsDataVo) 
optional
atsBypass
integer <int32>
optional
ATS/Bypass250
bactivePower
number <float>
optional
Bypass P (kW)
bapparentPower
number <float>
optional
Bypass S (KVA)
bipvBuck3
string 
optional
PV3 L_Current
bmsStatus
integer <int32>
optional
BMS battery status
bmsSystemStatus
integer <int32>
optional
BMS system status
bmsVoltStatus
integer <int32>
optional
BMS high voltage relay status
breactivePower
number <float>
optional
Bypass Q (Kvar)
bvbus
string 
optional
Bus Voltage
bypassFreq
number <float>
optional
Bypass Freq (Hz)
capacity
integer <int32>
optional
Battery SOC(%)
checkTime
number <float>
optional
Check Time (s)
cpActivePower
number <float>
optional
PSG Power
cpPowerLimit
number <float>
optional
PSG Limit Power
dailyEnergyFromMeter
number <float>
optional
D.Import from Meter (kWh)
dailyEnergyToMeter
number <float>
optional
D.Export to Meter (kWh)
dailyNonCriticalEnergy
number <float>
optional
D.Non-Critical Load Energy(kWh)
deviceSn
string 
optional
SN
dgActivePower
number <float>
optional
GEN P (kW)
dgApparentPower
number <float>
optional
GEN S (KVA)
dgCurrentU
number <float>
optional
GEN Current U
dgCurrentV
number <float>
optional
GEN Current V
dgCurrentW
number <float>
optional
GEN Current W
dgGridSelect
integer <int32>
optional
DG_Grid_Select
dgReactivePower
number <float>
optional
GEN Q (Kvar)
dgTodayIntakePower
number <float>
optional
D.GEN Export (kWh)
dgTodayIntakeTime
number <float>
optional
D.GEN Export Time (Min)
dgTotalIntakePower
number <float>
optional
T.GEN Export (kWh)
dgTotalIntakeTime
number <float>
optional
T.GEN Export Time (Min)
ebatChargeTimeTotal
number <double>
optional
T.BAT ChargeTime (H)
ebatChargeTotal
number <double>
optional
T.BAT Charge (kWh)
ebatDischargeTimeTotal
number <double>
optional
T.BAT DischarTime (H)
ebatDischargeTotal
number <double>
optional
T.BAT Discharge (kWh)
echargeTimeToday
number <float>
optional
D.BAT CharTime (kWh)
echargeToday
number <float>
optional
D.BAT Charge (kWh)
edischargeTimeToday
number <float>
optional
D.BAT DischarTime (kWh)
edischargeToday
number <float>
optional
D.BAT Discharge (kWh)
egridTimeToday
number <float>
optional
D.Import Grid Time (Min)
egridTimeTotal
number <double>
optional
T.Import Grid Time (H)
egridToday
number <float>
optional
D.Import from Grid (kWh)
egridTotal
number <double>
optional
T.Import from Grid (kWh)
eloadTimeToday
number <float>
optional
Daily.Load Time (Min)
eloadTimeTotal
number <double>
optional
Total.Load Time (H)
eloadToday
number <float>
optional
D.Load Energy (kWh)
eloadTotal
number <double>
optional
T.Load Energy (kWh)
epvTimeToday
number <double>
optional
Daily.PV Time (Min)
epvTimeTotal
number <double>
optional
Total.PV Time (H)
epvToday
number <float>
optional
Daily.PV Energy (kWh)
epvTotal
number <double>
optional
Total.PV Energy (kWh)
etoGridTimeToday
number <float>
optional
D.Export Grid Time (Min)
etoGridTimeTotal
number <double>
optional
T.Export Grid Time (H)
etoGridToday
number <float>
optional
D.Export to Grid (kWh)
etoGridTotal
number <double>
optional
T.Export to Grid (kWh)
fac
number <float>
optional
Output Freq (Hz)
gvpvuv
number <float>
optional
Grid Voltage UV (V)
gvpvvw
number <float>
optional
Grid Voltage VW (V)
gvpvwu
number <float>
optional
Grid Voltage WU (V)
ibat
number <float>
optional
BAT Current (A)
ibuck1
number <float>
optional
Buck Current 1 (A)
ibuck2
number <float>
optional
Buck Current 2 (A)
ipv
number <float>
optional
PV Current (A)
ipva
number <float>
optional
Inductive Current A (A)
ipvb
number <float>
optional
Inductive Current B (A)
ipvc
number <float>
optional
Inductive Current C (A)
ipvu
number <float>
optional
Grid Current U (A)
ipvv
number <float>
optional
Grid Current U (A)
ipvw
number <float>
optional
Grid Current W (A)
loadActivePower
number <float>
optional
Load P (kW)
loadApparentPower
number <float>
optional
Load S (KVA)
loadIu
number <float>
optional
Load Current U (A)
loadIv
number <float>
optional
Load Current V (A)
loadIw
number <float>
optional
Load Current W (A)
loadPf
number <float>
optional
Load PF
loadReactivePower
number <float>
optional
Load Q (Kvar)
maxChargeCurr
number <float>
optional
BMS Max.Charge current(A)
maxDischargeCurr
number <float>
optional
BMS Max.Discharge current
maxTemp
number <float>
optional
Max.Temperature (°C)
maxTempGroup
integer <int32>
optional
ax.Temp Rack No.
maxTempNum
integer <int32>
optional
Max.Temp Module No.
maxVolt
number <float>
optional
Max.Cell Voltage (V)
maxVoltCell
integer <int32>
optional
MaxCellVoltModuleNo.
maxVoltGroup
integer <int32>
optional
Max.Volt Rack No.
maxVoltNum
integer <int32>
optional
Max.Cell Voltage No.
meterCurrentU
number <float>
optional
Meter Current U
meterCurrentV
number <float>
optional
Meter Current V
meterCurrentW
number <float>
optional
Meter Current W
meterPower
number <float>
optional
Meter P(kW)
meterQ
number <float>
optional
Meter Q
meterS
number <float>
optional
Meter S
minTemp
number <float>
optional
Min Temperature (°C)
minTempGroup
integer <int32>
optional
Min.Temp Rack No.
minTempNum
integer <int32>
optional
Min.Temp Module No.
minVolt
number <float>
optional
Min.Cell Voltage(V)
minVoltCell
integer <int32>
optional
Min.CellVoltModuleNo.
minVoltGroup
integer <int32>
optional
Min.Volt Rack No.
minVoltNum
integer <int32>
optional
Min.Cell Voltage No.
mvpv
number <float>
optional
Cell Voltage (V)
nonCriticalLoad
number <float>
optional
Non-Critical Load (kW)
outvu
number <float>
optional
Output Voltage U (V)
outvv
number <float>
optional
Output Voltage V (V)
outvw
number <float>
optional
Output Voltage W (V)
pac
number <float>
optional
BAT Power (kW)
pf
number <float>
optional
Power Factor
ppv
number <float>
optional
PV Power (kW)
ppv1
string 
optional
Total PV Power
ppv2
string 
optional
PV2 Power
ppv3
string 
optional
PV3 Power
pv1Volt
string 
optional
PV1 Voltage
pv2NegVolt
string 
optional
PV2 Negative Voltage
pv2Volt
string 
optional
PV2 Voltage
pv3NegVolt
string 
optional
PV3 Negative Voltage
pv3PosVolt
string 
optional
PV3 Positive Voltage
pv3Volt
string 
optional
PV3 Voltage
runModel
integer <int32>
optional
Operation mode
scrTemp
number <float>
optional
SCR Temp (°C)
status
integer <int32>
optional
Status
systemNo
integer <int32>
optional
System ID sign
temp
number <float>
optional
Ambient Temp (°C)
temp1
number <float>
optional
IGBT Temp (°C)
temp3
number <float>
optional
Buck Module Temp (°C)
temp4
number <float>
optional
Max.T & L Temp (°C)
time
string 
optional
Time
totalEnergyFromMeter
number <float>
optional
T.Import from Meter (kWh)
totalEnergyToMeter
number <float>
optional
T.Export to Meter (kWh)
totalNonCriticalEnergy
number <double>
optional
T.Non-Critical Load Energy(kWh)
vbat
number <float>
optional
BAT Voltage (V)
vpv
number <float>
optional
PV Voltage (V)
vpv2
string 
optional
PV1 Negative Voltage
vpv3
string 
optional
PV2 Positive Voltage
vpvuv
number <float>
optional
Output Voltage UV (V)
vpvvw
number <float>
optional
Output Voltage VW (V)
vpvwu
number <float>
optional
Output Voltage WU (V)
msg
string 
optional
message
Example
{
    "code": 0,
    "data": {
        "atsBypass": 0,
        "bactivePower": 0,
        "bapparentPower": 0,
        "bipvBuck3": "string",
        "bmsStatus": 0,
        "bmsSystemStatus": 0,
        "bmsVoltStatus": 0,
        "breactivePower": 0,
        "bvbus": "string",
        "bypassFreq": 0,
        "capacity": 0,
        "checkTime": 0,
        "cpActivePower": 0,
        "cpPowerLimit": 0,
        "dailyEnergyFromMeter": 0,
        "dailyEnergyToMeter": 0,
        "dailyNonCriticalEnergy": 0,
        "deviceSn": "string",
        "dgActivePower": 0,
        "dgApparentPower": 0,
        "dgCurrentU": 0,
        "dgCurrentV": 0,
        "dgCurrentW": 0,
        "dgGridSelect": 0,
        "dgReactivePower": 0,
        "dgTodayIntakePower": 0,
        "dgTodayIntakeTime": 0,
        "dgTotalIntakePower": 0,
        "dgTotalIntakeTime": 0,
        "ebatChargeTimeTotal": 0,
        "ebatChargeTotal": 0,
        "ebatDischargeTimeTotal": 0,
        "ebatDischargeTotal": 0,
        "echargeTimeToday": 0,
        "echargeToday": 0,
        "edischargeTimeToday": 0,
        "edischargeToday": 0,
        "egridTimeToday": 0,
        "egridTimeTotal": 0,
        "egridToday": 0,
        "egridTotal": 0,
        "eloadTimeToday": 0,
        "eloadTimeTotal": 0,
        "eloadToday": 0,
        "eloadTotal": 0,
        "epvTimeToday": 0,
        "epvTimeTotal": 0,
        "epvToday": 0,
        "epvTotal": 0,
        "etoGridTimeToday": 0,
        "etoGridTimeTotal": 0,
        "etoGridToday": 0,
        "etoGridTotal": 0,
        "fac": 0,
        "gvpvuv": 0,
        "gvpvvw": 0,
        "gvpvwu": 0,
        "ibat": 0,
        "ibuck1": 0,
        "ibuck2": 0,
        "ipv": 0,
        "ipva": 0,
        "ipvb": 0,
        "ipvc": 0,
        "ipvu": 0,
        "ipvv": 0,
        "ipvw": 0,
        "loadActivePower": 0,
        "loadApparentPower": 0,
        "loadIu": 0,
        "loadIv": 0,
        "loadIw": 0,
        "loadPf": 0,
        "loadReactivePower": 0,
        "maxChargeCurr": 0,
        "maxDischargeCurr": 0,
        "maxTemp": 0,
        "maxTempGroup": 0,
        "maxTempNum": 0,
        "maxVolt": 0,
        "maxVoltCell": 0,
        "maxVoltGroup": 0,
        "maxVoltNum": 0,
        "meterCurrentU": 0,
        "meterCurrentV": 0,
        "meterCurrentW": 0,
        "meterPower": 0,
        "meterQ": 0,
        "meterS": 0,
        "minTemp": 0,
        "minTempGroup": 0,
        "minTempNum": 0,
        "minVolt": 0,
        "minVoltCell": 0,
        "minVoltGroup": 0,
        "minVoltNum": 0,
        "mvpv": 0,
        "nonCriticalLoad": 0,
        "outvu": 0,
        "outvv": 0,
        "outvw": 0,
        "pac": 0,
        "pf": 0,
        "ppv": 0,
        "ppv1": "string",
        "ppv2": "string",
        "ppv3": "string",
        "pv1Volt": "string",
        "pv2NegVolt": "string",
        "pv2Volt": "string",
        "pv3NegVolt": "string",
        "pv3PosVolt": "string",
        "pv3Volt": "string",
        "runModel": 0,
        "scrTemp": 0,
        "status": 0,
        "systemNo": 0,
        "temp": 0,
        "temp1": 0,
        "temp3": 0,
        "temp4": 0,
        "time": "string",
        "totalEnergyFromMeter": 0,
        "totalEnergyToMeter": 0,
        "totalNonCriticalEnergy": 0,
        "vbat": 0,
        "vpv": 0,
        "vpv2": "string",
        "vpv3": "string",
        "vpvuv": 0,
        "vpvvw": 0,
        "vpvwu": 0
    },
    "msg": "string"
}
Previous
Get historical data of Central type HPS
Next
Get setting of Central type HPS
Built with