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 setting 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/setting
OpenAPI-PBD

Limit the frequency#

The device supports 10 reads per day

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/setting?deviceSn=xxxxxxxxxx

Response Body#

{
    "code": 0,
    "data": {
        "batCellsNum": 0,
......
        "vstart": 300
    },
    "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
deviceSn
Header Params
Authorization
string 
required
Accept-Language
string 
required
Default:
en

Responses

🟢200OK
application/json
Body
code
integer <int32>
optional
code
data
object (OpenApiPbdSettingsVo) 
optional
batCellsNum
integer <int32>
optional
Battery Cells (0~50000(0.001V))
>= 0<= 50000
batCurrCablibEnable
enum<integer> <int32>
optional
Calibration Enable (0: Disable;1: Enable)
Allowed values:
01
batOverVoltProtect
number <float>
optional
OverVolt_Fault (0~50000(0.001V))
>= 0<= 50
batRacksNum
integer <int32>
optional
Batteries (0~100)
>= 0<= 100
batUnderVoltProtect
number <float>
optional
UnderVolt_Fault (0~50000(0.001V))
>= 0<= 50
batUnderVoltWarn
number <float>
optional
Batt_Undervolt_Warning (0~50000(0.001V))
>= 0<= 50
bmsEnable
enum<integer> <int32>
optional
BMS Communication Enable (0: Disable;1: Enable)
Allowed values:
01
checkTime
integer <int32>
optional
Check Time (0~1000S)
>= 0<= 1000
emsEnable
enum<integer> <int32>
optional
EMS Mode Enable (0: Disable;1: Enable)
Allowed values:
01
floatVolt
number <float>
optional
Floating Charge Volt (0~50000(0.001V))
>= 0<= 50
ioutInductorMax
integer <int32>
optional
Out Inductor Curr Up Limit (0~500A)
>= 0<= 500
ioutMax
integer <int32>
optional
Out Curr Up Limit (0~500A)
>= 0<= 500
ipvLMax
integer <int32>
optional
PV Inductor Curr Up Limit (0~500A)
>= 0<= 500
ipvMax
integer <int32>
optional
Max.PV Current (0~500A)
>= 0<= 500
masterSlaveFlag
integer <int32>
optional
Parallel address (0~255)
>= 0<= 255
onOff
enum<string> 
optional
ON/OFF (0: Off;1: On)
Allowed values:
01
outPowerMax
integer <int32>
optional
Out Power Up Limit (0~120%)
>= 0<= 120
outputPowerSet
integer <int32>
optional
Out Power Setting (0~500kW)
>= 0<= 500
parallelEnable
enum<integer> <int32>
optional
Parallel Enable (0: Disable;1: Enable)
Allowed values:
01
pbdParallelNumSet
integer <int32>
optional
PBD Parallel Machine Number Setting (0~100)
powerStart
number <float>
optional
PV Start Power (0~500(0.1kW))
>= 0<= 50
startVolt
number <float>
optional
Start Volt (0~50000(0.001V))
>= 0<= 50
systemNo
integer <int32>
optional
System ID sign (0~100)
>= 0<= 100
vmpptMax
number <float>
optional
Max.MPPT Voltage (3000~15000(0.1V))
>= 300<= 1500
vmpptMin
number <float>
optional
Min.MPPT Voltage (3000~15000(0.1V))
>= 300<= 1500
voutMax
number <float>
optional
Max.Output Voltage (2000~10000(0.1V))
>= 200<= 1000
voutMin
number <float>
optional
Min.Output Voltage (2000~10000(0.1V))
>= 200<= 1000
vpvMax
number <float>
optional
Max.PV Voltage (2000~10000(0.1V))
>= 200<= 1000
vstart
number <float>
optional
PV Start Voltage (3000~8500(0.1V))
>= 300<= 850
msg
string 
optional
message
Example
{
    "code": 0,
    "data": {
        "batCellsNum": 0,
        "batCurrCablibEnable": 0,
        "batOverVoltProtect": 0,
        "batRacksNum": 0,
        "batUnderVoltProtect": 0,
        "batUnderVoltWarn": 0,
        "bmsEnable": 0,
        "checkTime": 0,
        "emsEnable": 0,
        "floatVolt": 0,
        "ioutInductorMax": 0,
        "ioutMax": 0,
        "ipvLMax": 0,
        "ipvMax": 0,
        "masterSlaveFlag": 0,
        "onOff": "0",
        "outPowerMax": 0,
        "outputPowerSet": 0,
        "parallelEnable": 0,
        "pbdParallelNumSet": 0,
        "powerStart": 0,
        "startVolt": 0,
        "systemNo": 0,
        "vmpptMax": 300,
        "vmpptMin": 300,
        "voutMax": 200,
        "voutMin": 200,
        "vpvMax": 200,
        "vstart": 300
    },
    "msg": "string"
}
Previous
Get the latest real-time data of PBD
Next
Modify setting of PBD
Built with