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 String 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-small
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-small?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

Request

Query Params
deviceSn
string 
required
PCS SN
Header Params
Authorization
string 
required
Accept-Language
string 
required
Default:
en

Responses

🟢200OK
application/json
Body
code
integer <int32>
optional
code
data
object (OpenApiStringTypeHpsDataVo) 
optional
bipvBuck1
number <float>
optional
PV1 Inductive Current (A)
bipvBuck2
number <float>
optional
PV2 Inductive Current (A)
bipvBuck3
number <float>
optional
PV3 Inductive Current (A)
bmsStatus
integer <int32>
optional
BMS battery status
bmsVoltStatus
integer <int32>
optional
BMS high voltage relay status
bvbus
number <float>
optional
DC BUS Voltage(V)
bvbusNega
number <float>
optional
BUS -Voltage(V)
bvbusPosi
number <float>
optional
BUS + Voltage(V)
bypassFreq
number <float>
optional
Grid Freq (Hz)
checkTime
number <float>
optional
Grid Freq (Hz)
deviceSn
string 
optional
SN
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)
effectiveness
number <float>
optional
Efficiency（%）
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)
gactivePower
number <float>
optional
Grid P (kW)
gapparentPower
number <float>
optional
Grid S (KVA)
greactivePower
number <float>
optional
Grid Q (Kvar)
gvpvu
number <float>
optional
Grid Voltage U(V)
gvpvv
number <float>
optional
Grid Voltage V(V)
gvpvw
number <float>
optional
Grid Voltage W(V)
inductorCurr
number <float>
optional
BAT Inductive 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 V (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(A)
maxTemp
number <float>
optional
Max.Temperature (°C)
maxTempGroup
integer <int32>
optional
Max.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.
meterPower
number <float>
optional
Meter power (kW)
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)
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)
ppv
number <float>
optional
PV1 Power (kW)
ppv1
number <float>
optional
PV Total Power (kW)
ppv2
number <float>
optional
PV2 Power (kW)
ppv3
number <float>
optional
PV3 Power (kW)
runModel
integer <int32>
optional
Operation mode
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)
temp2
number <float>
optional
DC Temp (°C)
temp4
number <float>
optional
Max.T & L Temp (°C)
time
string 
optional
Time
vbat
number <float>
optional
BAT Voltage (V)
vpv
number <float>
optional
PV1 Voltage (V)
vpv2
number <float>
optional
PV2 Voltage (V)
vpv3
number <float>
optional
PV3 Voltage (V)
vpvun
number <float>
optional
Invert Voltage U (V)
vpvvn
number <float>
optional
Invert Voltage V (V)
vpvwn
number <float>
optional
Invert Voltage W (V)
msg
string 
optional
message
Example
{
    "code": 0,
    "data": {
        "bipvBuck1": 0,
        "bipvBuck2": 0,
        "bipvBuck3": 0,
        "bmsStatus": 0,
        "bmsVoltStatus": 0,
        "bvbus": 0,
        "bvbusNega": 0,
        "bvbusPosi": 0,
        "bypassFreq": 0,
        "checkTime": 0,
        "deviceSn": "string",
        "ebatChargeTimeTotal": 0,
        "ebatChargeTotal": 0,
        "ebatDischargeTimeTotal": 0,
        "ebatDischargeTotal": 0,
        "echargeTimeToday": 0,
        "echargeToday": 0,
        "edischargeTimeToday": 0,
        "edischargeToday": 0,
        "effectiveness": 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,
        "gactivePower": 0,
        "gapparentPower": 0,
        "greactivePower": 0,
        "gvpvu": 0,
        "gvpvv": 0,
        "gvpvw": 0,
        "inductorCurr": 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,
        "meterPower": 0,
        "minTemp": 0,
        "minTempGroup": 0,
        "minTempNum": 0,
        "minVolt": 0,
        "minVoltCell": 0,
        "minVoltGroup": 0,
        "minVoltNum": 0,
        "mvpv": 0,
        "outvu": 0,
        "outvv": 0,
        "outvw": 0,
        "pac": 0,
        "ppv": 0,
        "ppv1": 0,
        "ppv2": 0,
        "ppv3": 0,
        "runModel": 0,
        "status": 0,
        "systemNo": 0,
        "temp": 0,
        "temp1": 0,
        "temp2": 0,
        "temp4": 0,
        "time": "string",
        "vbat": 0,
        "vpv": 0,
        "vpv2": 0,
        "vpv3": 0,
        "vpvun": 0,
        "vpvvn": 0,
        "vpvwn": 0
    },
    "msg": "string"
}
Previous
Get historical data of String type HPS
Next
Get setting of String type HPS
Built with