atess-server-openapi
  1. OpenAPI-BMS
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 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-BMS

Get the latest real-time data of BCU

Prod Env
https://www.enerclo-atesspower.com
Prod Env
https://www.enerclo-atesspower.com
GET
https://www.enerclo-atesspower.com
/api/v1/bms/bcu-data-last

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

Response Body#

{
    "code": 0,
    "data": {
        "batteryCycleCount": 0,
......
        "vbat": 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
BMS SN
Header Params
Authorization
string 
required
Accept-Language
string 
required
Default:
en

Responses

🟢200OK
application/json
Body
code
integer <int32>
optional
code
data
object (OpenApiBcuDataVo) 
optional
data
batteryCycleCount
integer <int32>
optional
Battery Cycle Counts
bmuDataList
array[object (OpenApiBmuDataVo) {3}] 
optional
BMU Data list
cbat
number <float>
optional
BAT Total Current(A)
cellMaxVolt
number <float>
optional
Cell Max Voltage(V)
cellMinVolt
number <float>
optional
Cell Min voltage(V)
chargeCapacity
number <float>
optional
Total Charging Capacity
deviceNo
integer <int32>
optional
Device Num
deviceSn
string 
optional
SN
dischargeCapacity
number <float>
optional
Total Discharging Capacity
fullCapacity
number <float>
optional
Full Capacity(AH)
hardwareVersion
string 
optional
Hardware Version
insulationVal
integer <int32>
optional
Insulation Value
maxChargeCurr
number <float>
optional
Charge Max Current(A)
maxDischargeCurr
number <float>
optional
Discharge Max Current(A)
maxTemp
number <float>
optional
Max Temperature(℃)
maxTempGroupNum
integer <int32>
optional
Max Temperature Group Num
maxTempNum
integer <int32>
optional
Max Temperature Box Num
maxVoltCell
integer <int32>
optional
Max Voltage Cell Num
maxVoltGroupNum
integer <int32>
optional
Max Voltage Group Num
maxVoltNum
integer <int32>
optional
Max Voltage Box Num
minTemp
number <float>
optional
Min Temperature(℃)
minTempGroupNum
integer <int32>
optional
Min Temperature Group Num
minTempNum
integer <int32>
optional
Min Temperature Box Num
minVoltCell
integer <int32>
optional
Min Voltage Cell Num
minVoltGroupNum
integer <int32>
optional
Min Voltage Group Num
minVoltNum
integer <int32>
optional
Min Voltage Box Num
ratedCapacity
number <float>
optional
Rated Capacity(AH)
relayStatus
integer <int32>
optional
Relay Status
remainCapacity
number <float>
optional
Remain Capacity(AH)
soc
integer <int32>
optional
SOC(%)
softwareVersion
string 
optional
Software Version
soh
integer <int32>
optional
SOH(%)
status
integer <int32>
optional
Battery Status
systemNum
integer <int32>
optional
System Number
time
string 
optional
Time
totalChargeEnergy
number <float>
optional
Total Charging Energy
totalDischargeEnergy
number <float>
optional
Total Discharging Energy
vbat
number <float>
optional
BAT Total Voltage(V)
msg
string 
optional
message
Example
{
    "code": 0,
    "data": {
        "batteryCycleCount": 0,
        "bmuDataList": [
            {
                "cellInfos": [
                    0
                ],
                "maxVolt": 0,
                "minVolt": 0
            }
        ],
        "cbat": 0,
        "cellMaxVolt": 0,
        "cellMinVolt": 0,
        "chargeCapacity": 0,
        "deviceNo": 0,
        "deviceSn": "string",
        "dischargeCapacity": 0,
        "fullCapacity": 0,
        "hardwareVersion": "string",
        "insulationVal": 0,
        "maxChargeCurr": 0,
        "maxDischargeCurr": 0,
        "maxTemp": 0,
        "maxTempGroupNum": 0,
        "maxTempNum": 0,
        "maxVoltCell": 0,
        "maxVoltGroupNum": 0,
        "maxVoltNum": 0,
        "minTemp": 0,
        "minTempGroupNum": 0,
        "minTempNum": 0,
        "minVoltCell": 0,
        "minVoltGroupNum": 0,
        "minVoltNum": 0,
        "ratedCapacity": 0,
        "relayStatus": 0,
        "remainCapacity": 0,
        "soc": 0,
        "softwareVersion": "string",
        "soh": 0,
        "status": 0,
        "systemNum": 0,
        "time": "string",
        "totalChargeEnergy": 0,
        "totalDischargeEnergy": 0,
        "vbat": 0
    },
    "msg": "string"
}
Modified at 2024-03-21 08:49:53
Previous
Get historical data of BCU
Next
Get setting of BUC
Built with