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

Get the latest real-time data of PBD

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

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

Response Body#

{
    "code": 0,
    "data": {
        "bipvBuck1": 0,
......
        "vpv5": 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
PBD SN
Example:
UMD0D23202
Header Params
Authorization
string 
required
Accept-Language
string 
required
Default:
en

Responses

🟢200OK
application/json
Body
code
integer <int32>
optional
code
data
object (OpenApiPbdDataVo) 
optional
data
bipvBuck1
integer <int32>
optional
PV1 Inductive Current(A)
bipvBuck2
integer <int32>
optional
PV2 Inductive current(A)
bipvBuck3
integer <int32>
optional
PV3 Inductive current(A)
bipvBuck4
integer <int32>
optional
PV4 Inductive current(A)
bipvBuck5
integer <int32>
optional
PV5 Inductive current(A)
bmsStatus
integer <int32>
optional
BMS battery status
bmsSystemStatus
integer <int32>
optional
BMS system status
bmsVoltStatus
integer <int32>
optional
BMS high voltage relay status
bvbus
integer <int32>
optional
DC BUS Voltage(V)
capacity
integer <int32>
optional
Battery SOC(%)
checkTime
number <float>
optional
Check Time(s)
datetimeOffset
string 
optional
Date-time offsets
deviceSn
string 
optional
SN
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)
epvTimeToday
number <double>
optional
PV daily power generation time(Min)
epvTimeTotal
number <double>
optional
PV total power generation(kWh)
epvToday
number <float>
optional
PV daily power generation(kWh)
epvTotal
number <double>
optional
PV total power generation(kWh)
ibat
integer <int32>
optional
Battery Current(A)
ipv
integer <int32>
optional
PV1 DC Current(A)
ipv2dc
integer <int32>
optional
PV2 DC Current(A)
ipv3
integer <int32>
optional
PV3 DC Current(A)
ipv4
integer <int32>
optional
PV4 DC Current(A)
ipv5
integer <int32>
optional
PV5 DC Current(A)
maxChargeCurr
integer <int32>
optional
BMS Max.Charge current(A)
maxDischargeCurr
integer <int32>
optional
BMS Max.Discharge current(A)
maxTemp
integer <int32>
optional
BMS maximum temperature(°C)
maxTempGroup
integer <int32>
optional
BMS maximum temperature rack number
maxTempNum
integer <int32>
optional
Max. temperature box no. of BMS
maxVolt
number <float>
optional
Maximum cell voltage(V)
maxVoltCell
integer <int32>
optional
Maximum voltage box no. of BMS
maxVoltGroup
integer <int32>
optional
Maximum voltage rack No. of BMS
maxVoltNum
integer <int32>
optional
Maximum voltage number of BMS unit
minTemp
integer <int32>
optional
BMS minimum temperature(°C)
minTempGroup
integer <int32>
optional
BMS minimum temperature rack number
minTempNum
integer <int32>
optional
BMS minimum temperature box No
minVolt
number <float>
optional
Minimum cell voltage(V)
minVoltCell
integer <int32>
optional
BMS unit minimum voltage box No
minVoltGroup
integer <int32>
optional
BMS minimum voltage rack number
minVoltNum
integer <int32>
optional
BMS unit minimum voltage number
mvpv
number <float>
optional
Cell Voltage (V)
outDailyDischarge
number <float>
optional
Output daily discharge(kWh)
outInductanceCurr1
integer <int32>
optional
Output Inductive1 Current(A)
outInductanceCurr2
integer <int32>
optional
Output Inductive2 Current(A)
outInductanceTemp
integer <int32>
optional
OUT Inductive temperature(°C)
outPower
integer <int32>
optional
Output power(kW)
outTemp
integer <int32>
optional
OUT Module temperature(°C)
outTotalDischarge
number <float>
optional
Output total discharge(kWh)
outi
integer <int32>
optional
Output Current(A)
outv
integer <int32>
optional
Output voltage(V)
pac
integer <int32>
optional
Battery power(kW)
pcsBatChargingPower
integer <int32>
optional
PCS battery charging power(kW)
pcsOutputPower
integer <int32>
optional
PCS output power(kW)
ppv
integer <int32>
optional
PV1 power(kW)
ppv1
integer <int32>
optional
Total PV power(kW)
ppv2
integer <int32>
optional
PV2 power(kW)
ppv3
integer <int32>
optional
PV3 power(kW)
ppv4
integer <int32>
optional
PV4 power(kW)
ppv5
integer <int32>
optional
PV5 power(kW)
pvInductanceTemp
integer <int32>
optional
PV Inductive temperature(°C)
pvTemp
integer <int32>
optional
PV Module temperature(°C)
runModel
integer <int32>
optional
Operation mode
status
integer <int32>
optional
Status
systemNo
integer <int32>
optional
System ID sign
temp
integer <int32>
optional
Ambient temperature(°C)
time
string 
optional
Time
vbat
integer <int32>
optional
Battery Voltage(V)
vpv
integer <int32>
optional
PV1 Voltage(V)
vpv2
integer <int32>
optional
PV2 Voltage(V)
vpv3
integer <int32>
optional
PV3 Voltage(V)
vpv4
integer <int32>
optional
PV4 Voltage(V)
vpv5
integer <int32>
optional
PV5 Voltage(V)
msg
string 
optional
message
Example
{
    "code": 0,
    "data": {
        "bipvBuck1": 0,
        "bipvBuck2": 0,
        "bipvBuck3": 0,
        "bipvBuck4": 0,
        "bipvBuck5": 0,
        "bmsStatus": 0,
        "bmsSystemStatus": 0,
        "bmsVoltStatus": 0,
        "bvbus": 0,
        "capacity": 0,
        "checkTime": 0,
        "datetimeOffset": "string",
        "deviceSn": "string",
        "ebatChargeTimeTotal": 0,
        "ebatChargeTotal": 0,
        "ebatDischargeTimeTotal": 0,
        "ebatDischargeTotal": 0,
        "echargeTimeToday": 0,
        "echargeToday": 0,
        "edischargeTimeToday": 0,
        "edischargeToday": 0,
        "epvTimeToday": 0,
        "epvTimeTotal": 0,
        "epvToday": 0,
        "epvTotal": 0,
        "ibat": 0,
        "ipv": 0,
        "ipv2dc": 0,
        "ipv3": 0,
        "ipv4": 0,
        "ipv5": 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,
        "outDailyDischarge": 0,
        "outInductanceCurr1": 0,
        "outInductanceCurr2": 0,
        "outInductanceTemp": 0,
        "outPower": 0,
        "outTemp": 0,
        "outTotalDischarge": 0,
        "outi": 0,
        "outv": 0,
        "pac": 0,
        "pcsBatChargingPower": 0,
        "pcsOutputPower": 0,
        "ppv": 0,
        "ppv1": 0,
        "ppv2": 0,
        "ppv3": 0,
        "ppv4": 0,
        "ppv5": 0,
        "pvInductanceTemp": 0,
        "pvTemp": 0,
        "runModel": 0,
        "status": 0,
        "systemNo": 0,
        "temp": 0,
        "time": "string",
        "vbat": 0,
        "vpv": 0,
        "vpv2": 0,
        "vpv3": 0,
        "vpv4": 0,
        "vpv5": 0
    },
    "msg": "string"
}
Modified at 2024-03-21 09:19:02
Previous
Get historical data of PBD
Next
Get setting of PBD
Built with