atess-server-openapi
  1. OpenAPI-HPS
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
    • Add DataLog
    • Delete DataLog
    • Get DataLog list
  • 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-HPS

Get setting of String type HPS

Prod Env
Prod Env
GET
https://www.enerclo-atesspower.com/api/v1/hps/small-setting
OpenAPI-HPS

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/hps/small-setting?deviceSn=1

Response Body#

{
    "code": 0,
    "data": {
        "batCapacity": 0,
......
        "valleyPeriodTime2": "string"
    },
    "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 (OpenApiStringTypeHpsSettingVo) 
optional
atsComNo
integer <int32>
optional
ATS Communication Station
>= 0<= 256
atsUnitsNum
integer <int32>
optional
ATS Numbers
>= 0<= 10
batCapacity
integer <int32>
optional
Battery Capacity (0~50000 AH)
>= 0<= 5000
batCellVoltSet1
number <float>
optional
Battery cell voltage setting 1 (0~65535(0.001V))
>= 0<= 65.535
batCellVoltSet2
number <float>
optional
Battery cell voltage setting 2 (0~65535(0.001V))
>= 0<= 65.535
batCellVoltSet3
number <float>
optional
Battery cell voltage setting 3 (0~65535(0.001V))
>= 0<= 65.535
batCellVoltSet4
number <float>
optional
Battery cell voltage setting 4 (0~65535(0.001V))
>= 0<= 65.535
batCellVoltSet5
number <float>
optional
Battery cell voltage setting 5 (0~65535(0.001V))
>= 0<= 65.535
batCellsNum
integer <int32>
optional
Battey Group Cells (0~50000)
>= 0<= 5000
batCompenGridSoc
integer <int32>
optional
BAT Compensates Grid SOC (0-100%)
>= 0<= 100
batCompenGridVolt
number <float>
optional
BAT Compensates Grid Voltage (0~50000(0.001V))
>= 0<= 50
batDischargePower1
integer <int32>
optional
Battery discharging power 1 (0~100(1kw))
>= 0<= 100
batDischargePower2
integer <int32>
optional
Battery discharging power 2 (0~100(1kw))
>= 0<= 100
batDischargePower3
integer <int32>
optional
Battery discharging power 3 (0~100(1kw))
>= 0<= 100
batDischargePower4
integer <int32>
optional
Battery discharging power 4 (0~100(1kw))
>= 0<= 100
batDischargePower5
integer <int32>
optional
Battery discharging power 5 (0~100(1kw))
>= 0<= 100
batOcChargeProtect
number <float>
optional
BAT Charge Current Limit (0~10000（0.1A）)
>= 0<= 1000
batOcDischargeProtect
number <float>
optional
BAT Discharge Current Limit (0~10000(0.1A))
>= 0<= 1000
batOverVoltProtect
number <float>
optional
BAT OverVolt Protect (0~50000 (0.001V))
>= 0<= 50
batRacksNum
integer <int32>
optional
Battey Group Num (0~100)
>= 0<= 100
batSaturation
integer <int32>
optional
BAT Saturation (0~10)
>= 0<= 10
batSocSet1
integer <int32>
optional
Battery SOC setting 1 (0~100%)
>= 0<= 100
batSocSet2
integer <int32>
optional
Battery SOC setting 2 (0~100%)
>= 0<= 100
batSocSet3
integer <int32>
optional
Battery SOC setting 3 (0~100%)
>= 0<= 100
batSocSet4
integer <int32>
optional
Battery SOC setting 4 (0~100%)
>= 0<= 100
batSocSet5
integer <int32>
optional
Battery SOC setting 5 (0~100%)
>= 0<= 100
batToNonCriticalEnable
enum<integer> <int32>
optional
BAT to Non-Critical Enable (0: Disable;1: Enable)
Allowed values:
01
batUnderVoltProtect
number <float>
optional
BAT UnderVolt Protect (0~50000 (0.001V))
>= 0<= 50
batUnderVoltWarn
number <float>
optional
BAT UnderVolt Warning (0~50000 (0.001V))
>= 0<= 50
bmsEnable
enum<integer> <int32>
optional
BMS Communication Enable(0: Disable;1: Enable)
Allowed values:
01
bmsVoltJudgeSwitch
enum<integer> <int32>
optional
Select Volt or SOC(0: Disable;1: Enable)
Allowed values:
01
bypassEnable
enum<integer> <int32>
optional
ATS Enable (0: Disable;1: Enable)
Allowed values:
01
chargeRecoveryVolt
number <float>
optional
Charge Stop Voltage(0~50000(0.001V))
>= 0<= 50
checkTime
integer <int32>
optional
Check Time (0~1000 S)
>= 0<= 1000
cutOffVolt
number <float>
optional
Cut-off Voltage (0-50000(0.001v))
>= 0<= 50
dischargeRecoveryVolt
number <float>
optional
Discharge Recovery Voltage (0~50000(0.001V))
>= 0<= 50
exportLimit
enum<integer> <int32>
optional
Anti-reflux Enable(0: Disable;1: Enable)
Allowed values:
01
floatVolt
number <float>
optional
Float Charge Volt (0~50000 (0.001V))
>= 0<= 50
genStartVolt
number <float>
optional
GEN Start Voltage (0~50000(0.001V))
>= 0<= 50
genStopVolt
number <float>
optional
GEN Stop Voltage (0~50000(0.001V))
>= 0<= 50
generatorChargeEnable
enum<integer> <int32>
optional
Generator charge enable(0: Disable;1: Enable)
Allowed values:
01
gridChargePower
number <float>
optional
Grid Charge Power (0.1KW According to the model power limit)
gridPvEnable
enum<integer> <int32>
optional
Grid & PV Charge Enable (0: Disable;1: Enable)
Allowed values:
01
icharge
number <float>
optional
BAT (Dis)Charge Current(0~800 1A)
>= 0<= 800
maxExportToGrid
integer <int32>
optional
Max.Export to Grid (0~500kW)
>= 0<= 500
maxGenChargePower
number <float>
optional
Max.GEN Charge Power (0.1KW According to the model power limit)
maxGenPower
integer <int32>
optional
Max.GEN Power (0~500KW)
>= 0<= 500
maxGridPower
integer <int32>
optional
Max.Import from Grid (0-500KW)
>= 0<= 500
meterComNo
integer <int32>
optional
Meter Com No.
>= 0<= 255
meterComSwitchEnable
enum<integer> <int32>
optional
Meter Com Switch Enable (0: Disable;1: Enable)
Allowed values:
01
meterCtRatio
integer <int32>
optional
Meter CT ratio
>= 0<= 65535
modelSelect
enum<integer> <int32>
optional
Mode
Allowed values:
012345678
multiChargeDisChargeModeTime1
string 
optional
Time period1 (HH:mm-HH:mm)
multiChargeDisChargeModeTime2
string 
optional
Time period2 (HH:mm-HH:mm)
multiChargeDisChargeModeTime3
string 
optional
Time period3 (HH:mm-HH:mm)
multiChargeDisChargeModeTime4
string 
optional
Time period4 (HH:mm-HH:mm)
multiChargeDisChargeModeTime5
string 
optional
Time period5 (HH:mm-HH:mm)
oilMachineEnable
enum<integer> <int32>
optional
DG Enable (0: Disable;1: Enable)
Allowed values:
01
onOff
enum<integer> <int32>
optional
ON/OFF (0: Off;1: On)
Allowed values:
01
parallelEnable
enum<integer> <int32>
optional
Parallel Enable (0: Disable;1: Enable)
Allowed values:
01
parallelRedundant
enum<integer> <int32>
optional
Parallel Redundant (0/1)
Allowed value:
0
parallelUnitNum
integer <int32>
optional
Number of parallel units (0~255)
>= 0<= 255
peakPeriodTime1
string 
optional
Peak time1 (HH:mm-HH:mm)
peakPeriodTime2
string 
optional
Peak time2 (HH:mm-HH:mm)
regularPeriodTime1
string 
optional
Flat time1 (HH:mm-HH:mm)
regularPeriodTime2
string 
optional
Flat time2 (HH:mm-HH:mm)
sharedBatteryEnable
integer <int32>
optional
Shared Battery Enable
>= 0<= 1
socChargeCutOff
integer <int32>
optional
Charge Stop SOC(0-100%)
>= 0<= 100
socDischargeCutOff
integer <int32>
optional
Discharge Stop SOC(0-100%)
>= 0<= 100
socOff
integer <int32>
optional
SOC UP Limit (0~100%)
>= 0<= 100
socOn
integer <int32>
optional
SOC Down Limit (0~100%)
>= 0<= 100
socReDischarge
integer <int32>
optional
Discharge Recovery SOC(0-100%)
>= 0<= 100
startVolt
number <float>
optional
Battery start voltage (0~50000(0.001V))
>= 0<= 50
systemNo
integer <int32>
optional
System ID Sign
>= 0<= 1
trickleChargeSet
number <float>
optional
Trickle charge Set (0.1KW According to the model power limit)
valleyPeriodTime1
string 
optional
Valley time1 (HH:mm-HH:mm)
valleyPeriodTime2
string 
optional
Valley time2 (HH:mm-HH:mm)
msg
string 
optional
message
Example
{
  "code": 0,
  "data": {
    "atsComNo": 0,
    "atsUnitsNum": 0,
    "batCapacity": 0,
    "batCellVoltSet1": 0,
    "batCellVoltSet2": 0,
    "batCellVoltSet3": 0,
    "batCellVoltSet4": 0,
    "batCellVoltSet5": 0,
    "batCellsNum": 0,
    "batCompenGridSoc": 0,
    "batCompenGridVolt": 0,
    "batDischargePower1": 0,
    "batDischargePower2": 0,
    "batDischargePower3": 0,
    "batDischargePower4": 0,
    "batDischargePower5": 0,
    "batOcChargeProtect": 0,
    "batOcDischargeProtect": 0,
    "batOverVoltProtect": 0,
    "batRacksNum": 0,
    "batSaturation": 0,
    "batSocSet1": 0,
    "batSocSet2": 0,
    "batSocSet3": 0,
    "batSocSet4": 0,
    "batSocSet5": 0,
    "batToNonCriticalEnable": 0,
    "batUnderVoltProtect": 0,
    "batUnderVoltWarn": 0,
    "bmsEnable": 0,
    "bmsVoltJudgeSwitch": 0,
    "bypassEnable": 0,
    "chargeRecoveryVolt": 0,
    "checkTime": 0,
    "cutOffVolt": 0,
    "dischargeRecoveryVolt": 0,
    "exportLimit": 0,
    "floatVolt": 0,
    "genStartVolt": 0,
    "genStopVolt": 0,
    "generatorChargeEnable": 0,
    "gridChargePower": 0,
    "gridPvEnable": 0,
    "icharge": 0,
    "maxExportToGrid": 0,
    "maxGenChargePower": 0,
    "maxGenPower": 0,
    "maxGridPower": 0,
    "meterComNo": 0,
    "meterComSwitchEnable": 0,
    "meterCtRatio": 0,
    "modelSelect": 0,
    "multiChargeDisChargeModeTime1": "string",
    "multiChargeDisChargeModeTime2": "string",
    "multiChargeDisChargeModeTime3": "string",
    "multiChargeDisChargeModeTime4": "string",
    "multiChargeDisChargeModeTime5": "string",
    "oilMachineEnable": 0,
    "onOff": 0,
    "parallelEnable": 0,
    "parallelRedundant": 0,
    "parallelUnitNum": 0,
    "peakPeriodTime1": "string",
    "peakPeriodTime2": "string",
    "regularPeriodTime1": "string",
    "regularPeriodTime2": "string",
    "sharedBatteryEnable": 0,
    "socChargeCutOff": 0,
    "socDischargeCutOff": 0,
    "socOff": 0,
    "socOn": 0,
    "socReDischarge": 0,
    "startVolt": 0,
    "systemNo": 0,
    "trickleChargeSet": 0,
    "valleyPeriodTime1": "string",
    "valleyPeriodTime2": "string"
  },
  "msg": "string"
}
Modified at 2024-03-21 10:59:00
Previous
Get the latest real-time data of String type HPS
Next
Modify setting of String type HPS
Built with