atess-server-openapi
  1. OpenAPI-PCS
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
      GET
    • Add DataLog
      POST
    • Delete DataLog
      DELETE
    • Get DataLog list
      GET
  • 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
    • Get base info of PCS list
      GET
    • Get historical data of PCS
      GET
    • Get the latest real-time data of PCS
      GET
    • Get setting of PCS
      GET
    • Modify setting of PCS
      PUT
  • 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-PCS

Get the latest real-time data of PCS

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

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/pcs/data-last?deviceSn=xxxxxxx

Response Body#

{
    "code": 0,
    "data": {
        "atsBypass": 0,
......
        "vpvwu": 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.

PCS whose dtc is 215xx models additional parameters#

parameterdevice typedesc
runModelDTC:215XX4:Back-up Mode;5:Standard Mode
rtfPowerDTC:215XXRTF Power(kW)
rtfDemandPowerDTC:215XXRTF Demand(kW)
rtfStateDTC:215XXRTF State
rtfPowerLimitDTC:215XXRTF Power Limit(kW)

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 (OpenApiPcsDataVo) 
optional
atsBypass
integer <int32>
optional
ATS/Bypass
bactivePower
number <float>
optional
Bypass active power(kW)
bapparentPower
number <float>
optional
Bypass apparent power(KVA)
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 reactive power(kvar)
bvbus
number <float>
optional
DC BUS voltage(V)
bypassFreq
number <float>
optional
Bypass frequency(Hz)
capacity
integer <int32>
optional
Battery SOC(%)
checkTime
number <float>
optional
Check Time(s)
cpActivePower
number <float>
optional
CP active power(kW)
cpPowerLimit
number <float>
optional
CP power limit(kW)
cpcu
number <float>
optional
CP current U(A)
cpcv
number <float>
optional
CP current V(A)
cpcw
number <float>
optional
CP current W(A)
dailyPowerGridInverter
number <float>
optional
Daily power generation of PV inverter(kWh)
deviceSn
string 
optional
SN
dgActivePower
number <float>
optional
DG active power(kW)
dgApparentPower
number <float>
optional
DG apparent power(kVA)
dgCurrentU
number <float>
optional
DG Bypass currentU (A)
dgCurrentV
number <float>
optional
DG Bypass currentV (A)
dgCurrentW
number <float>
optional
DG Bypass currentW (A)
dgGridSelect
integer <int32>
optional
DG_Grid_Select
dgReactivePower
number <float>
optional
DG reactive power(Kvar)
dgTodayIntakePower
number <float>
optional
Daily import capacity from DG(kWh)
dgTodayIntakeTime
number <float>
optional
Daily import time from DG(Min)
dgTotalIntakePower
number <float>
optional
Total import capacity from DG(kWh)
dgTotalIntakeTime
number <float>
optional
Total import time from DG(Min)
dryContactState
integer <int32>
optional
dry contact state
ebatChargeTimeTotal
number <double>
optional
Total battery charge time(H)
ebatChargeTotal
number <double>
optional
Total charge capacity of battery(kWh)
ebatDischargeTimeTotal
number <double>
optional
Total battery discharge time(H)
ebatDischargeTotal
number <double>
optional
Total discharge capacity of battery(kWh)
echargeTimeToday
number <float>
optional
Battery daily charge time(Min)
echargeToday
number <float>
optional
Battery daily charge capacity(kWh)
edischargeTimeToday
number <float>
optional
Battery daily discharge time(Min)
edischargeToday
number <float>
optional
Battery daily discharge capacity(kWh)
egridTimeToday
number <float>
optional
Daily import time from Grid(Min)
egridTimeTotal
number <double>
optional
Total import time from Grid(H)
egridToday
number <float>
optional
Daily import capacity from Grid (kWh)
egridTotal
number <double>
optional
Total import capacity from Grid(kWh)
eloadTimeToday
number <float>
optional
Daily power time of load(Min)
eloadTimeTotal
number <double>
optional
Total power consumption time of load(H)
eloadToday
number <float>
optional
Daily power consumption of load(kWh)
eloadTotal
number <double>
optional
Total load consumption(kWh)
epvTimeToday
number <double>
optional
PV daily power generation time(Min)
epvTimeTotal
number <double>
optional
PV total power generation time(H)
epvToday
number <float>
optional
PV daily power generation(kWh)
epvTotal
number <double>
optional
PV total power generation(kWh)
etoGridTimeToday
number <float>
optional
Daily export time to Grid(Min)
etoGridTimeTotal
number <double>
optional
Total export time to Grid(H)
etoGridToday
number <float>
optional
Daily export capacity to Grid(kWh)
etoGridTotal
number <double>
optional
Total export capacity to Grid(kWh)
fac
number <float>
optional
Output frequency(Hz)
gvpvuv
number <float>
optional
Grid bypass voltage UV(V)
gvpvvw
number <float>
optional
Grid bypass voltage VW(V)
gvpvwu
number <float>
optional
Grid bypass voltage WU(V)
ibat
number <float>
optional
DC 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 Bypass currentU (A)
ipvv
number <float>
optional
Grid Bypass currentV (A)
ipvw
number <float>
optional
Grid Bypass currentW (A)
loadActivePower
number <float>
optional
Load active power(kW)
loadApparentPower
number <float>
optional
Load apparent power(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 power factor
loadReactivePower
number <float>
optional
Load reactive power(kvar)
maxChargeCurr
number <float>
optional
BMS Max.Charge current
maxDischargeCurr
number <float>
optional
BMS Max.Discharge current
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.
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)
outActivePower
number <float>
optional
Output active power(kW)
outApparentPower
number <float>
optional
Output apparent power(kVA)
outReactivePower
number <float>
optional
Output reactive power(kvar)
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
System battery power(kW)
pbdOutputPower
number <float>
optional
PBD output power(kW)
pcsDcPower
number <float>
optional
DC power(kW)
pf
number <float>
optional
Power Factor
runModel
integer <int32>
optional
Operation mode
status
integer <int32>
optional
Status
sysBatteryCurr
number <float>
optional
system battery current(A)
systemNo
integer <int32>
optional
System ID sign
temp
number <float>
optional
Ambient temperature (°C)
temp1
number <float>
optional
IGBT Temp (°C)
temp4
number <float>
optional
Max.T & L Temp (°C)
time
string 
optional
Time
totalPowerGridInverter
number <float>
optional
Total power generation of PV inverter(kWh)
vacu
number <float>
optional
Output currentU(A)
vacv
number <float>
optional
Output currentV(A)
vacw
number <float>
optional
Output currentW(A)
vbat
number <float>
optional
Battery voltage(V)
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,
        "bmsStatus": 0,
        "bmsSystemStatus": 0,
        "bmsVoltStatus": 0,
        "breactivePower": 0,
        "bvbus": 0,
        "bypassFreq": 0,
        "capacity": 0,
        "checkTime": 0,
        "cpActivePower": 0,
        "cpPowerLimit": 0,
        "cpcu": 0,
        "cpcv": 0,
        "cpcw": 0,
        "dailyPowerGridInverter": 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,
        "dryContactState": 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,
        "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,
        "minTemp": 0,
        "minTempGroup": 0,
        "minTempNum": 0,
        "minVolt": 0,
        "minVoltCell": 0,
        "minVoltGroup": 0,
        "minVoltNum": 0,
        "mvpv": 0,
        "outActivePower": 0,
        "outApparentPower": 0,
        "outReactivePower": 0,
        "outvu": 0,
        "outvv": 0,
        "outvw": 0,
        "pac": 0,
        "pbdOutputPower": 0,
        "pcsDcPower": 0,
        "pf": 0,
        "runModel": 0,
        "status": 0,
        "sysBatteryCurr": 0,
        "systemNo": 0,
        "temp": 0,
        "temp1": 0,
        "temp4": 0,
        "time": "string",
        "totalPowerGridInverter": 0,
        "vacu": 0,
        "vacv": 0,
        "vacw": 0,
        "vbat": 0,
        "vpvuv": 0,
        "vpvvw": 0,
        "vpvwu": 0
    },
    "msg": "string"
}
Previous
Get historical data of PCS
Next
Get setting of PCS
Built with