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 setting of BUC

Prod Env
Prod Env
GET
https://www.enerclo-atesspower.com/api/v1/bms/bcu-setting
OpenAPI-BMS

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/bms/bcu-setting?deviceSn=1

Response Body#

{
    "code": 0,
    "data": {
        "batCellNumber": 1,
        "batPackNumber": 1,
        "cellFullChargeVoltage": 3.4,
        "cellFullDischargeVoltage": 3,
        "chargingCurrentCalibrationDenominator": 1,
        "chargingCurrentCalibrationNumerator": 1,
        "currentCalibrationEnable": 0,
        "currentRatio": 1,
        "dischargingCurrentCalibrationDenominator": 1,
        "dischargingCurrentCalibrationNumerator": 1,
        "level1CellVoltHighWarning": 3.4,
        "level1CellVoltLowWarning": 2.8,
        "level1ChargeCurrHighWarning": 0,
        "level1ChargeTEMPHighWarning": 35,
        "level1ChargeTEMPLowWarning": 0,
        "level1DischargeCurrHighWarning": 0,
        "level1DischargeTEMPHighWarning": 35,
        "level1DischargeTEMPLowWarning": 0,
        "level2CellVoltHighFault": 3.5,
        "level2CellVoltLowFault": 2.6,
        "level2ChargeCurrHighFault": 0,
        "level2ChargeTEMPHighFault": 40,
        "level2ChargeTEMPLowFault": -5,
        "level2DischargeCurrHighFault": 0,
        "level2DischargeTEMPHighFault": 40,
        "level2DischargeTEMPLowFault": -10,
        "level3CellVoltHighProtection": 3.6,
        "level3CellVoltLowProtection": 2.4,
        "level3ChargeCurrHighProtection": 0,
        "level3ChargeTEMPHighProtection": 45,
        "level3ChargeTEMPLowProtection": 5,
        "level3DischargeCurrHighProtection": 0,
        "level3DischargeTEMPHighProtection": 45,
        "level3DischargeTEMPLowProtection": -20,
        "pasBalWaitTimeHour": 0.001
    },
    "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 (OpenApiBcuSettingVo) 
optional
batCellNumber
integer <int32>
optional
Bat Cell Number
>= 1<= 42
batPackNumber
integer <int32>
optional
Bat Pack Number
>= 1<= 32
cellFullChargeVoltage
number <float>
optional
Cell Full Charge Voltage(V)
>= 3.4<= 4.2
cellFullDischargeVoltage
number <float>
optional
Cell Full Discharge Voltage(V)
>= 3<= 3.2
chargingCurrentCalibrationDenominator
number <float>
optional
Charging Current Calibration Denominator
>= 1<= 300
chargingCurrentCalibrationNumerator
number <float>
optional
Charging Current Calibration Numerator
>= 1<= 300
currentCalibrationEnable
integer <int32>
optional
Current Calibration Enable
>= 0<= 1
currentRatio
number <float>
optional
Current Ratio
>= 1<= 300
dischargingCurrentCalibrationDenominator
number <float>
optional
Disharging Current Calibration Denominator
>= 1<= 300
dischargingCurrentCalibrationNumerator
number <float>
optional
Disharging Current Calibration Numerator
>= 1<= 300
level1CellVoltHighWarning
number <float>
optional
Level1 CellVolt High Warning(V)
>= 3.4<= 4
level1CellVoltLowWarning
number <float>
optional
Level1 CellVolt Low Warning(V)
>= 2.8<= 3.1
level1ChargeCurrHighWarning
integer <int32>
optional
Level1 ChargeCurr High Warning(A)
>= 0<= 300
level1ChargeTEMPHighWarning
integer <int32>
optional
Level1 Charge TEMP High Warning(℃)
>= 35<= 50
level1ChargeTEMPLowWarning
integer <int32>
optional
Level1 Charge TEMP Low Warning(℃)
>= 0<= 15
level1DischargeCurrHighWarning
integer <int32>
optional
Level1 DischargeCurr High Warning(A)
>= 0<= 300
level1DischargeTEMPHighWarning
integer <int32>
optional
Level1 Discharge TEMP High Warning(℃)
>= 35<= 50
level1DischargeTEMPLowWarning
integer <int32>
optional
Level1 Discharge TEMP Low Warning(℃)
>= 0<= 10
level2CellVoltHighFault
number <float>
optional
Level2 CellVolt High Fault(V)
>= 3.5<= 4.1
level2CellVoltLowFault
number <float>
optional
Level2 CellVolt Low Fault(V)
>= 2.6<= 3
level2ChargeCurrHighFault
integer <int32>
optional
Level2 ChargeCurr High Fault(A)
>= 0<= 300
level2ChargeTEMPHighFault
integer <int32>
optional
Level2 Charge TEMP High Fault(℃)
>= 40<= 55
level2ChargeTEMPLowFault
integer <int32>
optional
Level2 Charge TEMP Low Fault(℃)
>= -5<= 10
level2DischargeCurrHighFault
integer <int32>
optional
Level2 DischargeCurr High Fault(A)
>= 0<= 300
level2DischargeTEMPHighFault
integer <int32>
optional
Level2 Discharge TEMP High Fault(℃)
>= 40<= 55
level2DischargeTEMPLowFault
integer <int32>
optional
Level2 Discharge TEMP Low Fault(℃)
>= -10<= 5
level3CellVoltHighProtection
number <float>
optional
Level3 CellVolt High Protection(V)
>= 3.6<= 4.2
level3CellVoltLowProtection
number <float>
optional
Level3 CellVolt Low Protection(V)
>= 2.4<= 2.9
level3ChargeCurrHighProtection
integer <int32>
optional
Level3 ChargeCurr High Protection(A)
>= 0<= 300
level3ChargeTEMPHighProtection
integer <int32>
optional
Level3 Charge TEMP High Protection(℃)
>= 45<= 65
level3ChargeTEMPLowProtection
enum<integer> <int32>
optional
Level3 Charge TEMP Low Protection(℃)
Allowed value:
5
level3DischargeCurrHighProtection
integer <int32>
optional
Level3 DischargeCurr High Protection(A)
>= 0<= 300
level3DischargeTEMPHighProtection
integer <int32>
optional
Level3 Discharge TEMP High Protection(℃)
>= 45<= 65
level3DischargeTEMPLowProtection
integer <int32>
optional
Level3 Discharge TEMP Low Protection(℃)
>= -20<= 0
pasBalWaitTimeHour
integer <int32>
optional
PasBal WaitTime Hour(h)
>= 0.001<= 1
msg
string 
optional
message
Example
{
  "code": 0,
  "data": {
    "batCellNumber": 1,
    "batPackNumber": 1,
    "cellFullChargeVoltage": 3.4,
    "cellFullDischargeVoltage": 3,
    "chargingCurrentCalibrationDenominator": 1,
    "chargingCurrentCalibrationNumerator": 1,
    "currentCalibrationEnable": 0,
    "currentRatio": 1,
    "dischargingCurrentCalibrationDenominator": 1,
    "dischargingCurrentCalibrationNumerator": 1,
    "level1CellVoltHighWarning": 3.4,
    "level1CellVoltLowWarning": 2.8,
    "level1ChargeCurrHighWarning": 0,
    "level1ChargeTEMPHighWarning": 35,
    "level1ChargeTEMPLowWarning": 0,
    "level1DischargeCurrHighWarning": 0,
    "level1DischargeTEMPHighWarning": 35,
    "level1DischargeTEMPLowWarning": 0,
    "level2CellVoltHighFault": 3.5,
    "level2CellVoltLowFault": 2.6,
    "level2ChargeCurrHighFault": 0,
    "level2ChargeTEMPHighFault": 40,
    "level2ChargeTEMPLowFault": -5,
    "level2DischargeCurrHighFault": 0,
    "level2DischargeTEMPHighFault": 40,
    "level2DischargeTEMPLowFault": -10,
    "level3CellVoltHighProtection": 3.6,
    "level3CellVoltLowProtection": 2.4,
    "level3ChargeCurrHighProtection": 0,
    "level3ChargeTEMPHighProtection": 45,
    "level3ChargeTEMPLowProtection": 5,
    "level3DischargeCurrHighProtection": 0,
    "level3DischargeTEMPHighProtection": 45,
    "level3DischargeTEMPLowProtection": -20,
    "pasBalWaitTimeHour": 0.001
  },
  "msg": "string"
}
Modified at 2024-03-21 08:50:07
Previous
Get the latest real-time data of BCU
Next
Modify setting of BCU
Built with