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

Get setting of PCS

Prod Env
https://www.enerclo-atesspower.com
Prod Env
https://www.enerclo-atesspower.com
GET
https://www.enerclo-atesspower.com
/api/v1/pcs/setting
OpenAPI-PCS

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

Response Body#

{
    "code": 0,
    "data": {
        "atsComNo": 0,
......
        "voltRef": 0
    },
    "msg": "string"
}
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

Response Data Description#

The corresponding field in the interface return value, if not specified, indicates that the field exists in all devices of the model. The parameters corresponding to special models are explained as follows.

PCS whose dtc is 215xx models additional parameters#

parameterdevice typedesc
modelSelectDTC：215XX0:Standard Mode;1:Back-up Mode;2:Smart Time
rtfUnitsDTC：215XXrtf Units

Request

Query Params
deviceSn
string 
required
PCS SN
Header Params
Authorization
string 
required
Accept-Language
string 
required
Default:
en

Responses

🟢200OK
application/json
Body
code
integer <int32>
optional
code
data
object (OpenApiPcsSettingsVo) 
optional
atsComNo
integer <int32>
optional
Bypass Station number (0~255)
>= 0<= 255
atsComNoEnable
enum<integer> <int32>
optional
Bypass Station number Enable (0: Disable;1: Enable)
Allowed values:
01
atsUnitsNum
integer <int32>
optional
Bypass Number Set (0~10)
>= 0<= 10
batCapacity
integer <int32>
optional
Battery Capacity (0~50000AH)
>= 0<= 5000
batCellsNum
integer <int32>
optional
No. of Battery Cells (0~50000)
>= 0<= 50
batOcChargeProtect
number <float>
optional
BAT OC Charge Protect (0~10000(0.1A))
>= 0<= 1000
batOcDischargeProtect
number <float>
optional
BAT OC Discharge Protect (0~10000(0.1A))
>= 0<= 1000
batOverVoltProtect
number <float>
optional
BAT OverVolt Protect (0~50000(0.001V))
>= 0<= 50
batRacksNum
integer <int32>
optional
No.of Battey Racks (0~100)
>= 0<= 100
batSaturation
integer <int32>
optional
BAT Saturation (0~10)
>= 0<= 10
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 Com Enable (0: Disable;1: Enable)
Allowed values:
01
bmsVoltJudgeSwitch
enum<integer> <int32>
optional
BMS Volt Judge Switch (0: Disable;1: Enable)
Allowed values:
01
bypassEnable
enum<integer> <int32>
optional
Bypass Cabinet Enable (0: Disable;1: Enable)
Allowed values:
01
bypassModelSelect
enum<integer> <int32>
optional
Bypass Model Select
Allowed values:
12345678
bypassShareEnable
enum<integer> <int32>
optional
Bypass Share Enable (0: Disable;1: Enable;2)
Allowed values:
01
checkTime
integer <int32>
optional
Check Time (0~1000S)
>= 0<= 1000
cpEnable
enum<integer> <int32>
optional
CP Enable (0: Disable;1: Enable)
Allowed values:
01
cpNominalPower
integer <int32>
optional
CP Nominal Power (0~1000Kw)
>= 0<= 1000
cutOffVolt
number <float>
optional
Cut-off Voltage (0-50000(0.001V))
>= 0<= 50
dcSoftContactorEnable
enum<integer> <int32>
optional
DC Soft Contactor Enable (0: Disable;1: Enable)
Allowed values:
01
deviceLowPeakTimeSettingVo
object (OpenApiDeviceLowPeakTimeSettingVo) 
optional
exportLimit
enum<integer> <int32>
optional
Zero Export Enable (0: Disable;1: Enable)
Allowed values:
01
floatVolt
number <float>
optional
Float Voltage (0~50000(0.001V))
>= 0<= 50
floatingLimitSet
number <float>
optional
Floating Limit Set (0-100(0.01V))
>= 0<= 10
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
integer <int32>
optional
BAT Charge Current (0-800A)
>= 0<= 800
masterSlaveFlag
integer <int32>
optional
Parallel Address (0~255)
>= 0<= 255
maxExportToGrid
integer <int32>
optional
Max.Export to Grid (0~500kW)
>= 0<= 500
maxGenPower
integer <int32>
optional
Max.GEN Power (0~500KW)
>= 0<= 500
maxGridPower
integer <int32>
optional
Max.Import from Grid (0-500KW)
>= 0<= 500
midPeakPowerSet1
integer <int32>
optional
Mid-peak Power Set1 (1~500Kw)
>= 0<= 500
midPeakPowerSet2
integer <int32>
optional
Mid-peak Power Set2 (1~500Kw)
>= 0<= 500
midPeakPowerSet3
integer <int32>
optional
Mid-peak Power Set3 (1~500Kw)
>= 0<= 500
midPeakPowerSet4
integer <int32>
optional
Mid-peak Power Set4 (1~500Kw)
>= 0<= 500
midPeakPowerSet5
integer <int32>
optional
Mid-peak Power Set5 (1~500Kw)
>= 0<= 500
modelSelect
enum<integer> <int32>
optional
Mode
Allowed values:
0123456789101112
offPeakPowerSet1
integer <int32>
optional
Off-peak Power Set1 (1~500Kw)
>= 0<= 500
offPeakPowerSet2
integer <int32>
optional
Off-peak Power Set2 (1~500Kw)
>= 0<= 500
offPeakPowerSet3
integer <int32>
optional
Off-peak Power Set3 (1~500Kw)
>= 0<= 500
offPeakPowerSet4
integer <int32>
optional
Off-peak Power Set4 (1~500Kw)
>= 0<= 500
offPeakPowerSet5
integer <int32>
optional
Off-peak Power Set5 (1~500Kw)
>= 0<= 500
oilMachineEnable
enum<integer> <int32>
optional
DG Enable (0: Disable;1: Enable)
Allowed values:
01
onOff
enum<string> 
optional
ON/OFF (0: Off;1: On)
Allowed values:
01
onPeakPowerSet1
integer <int32>
optional
On-peak Power Set1 (1~500Kw)
>= 0<= 500
onPeakPowerSet2
integer <int32>
optional
On-peak Power Set2 (1~500Kw)
>= 0<= 500
onPeakPowerSet3
integer <int32>
optional
On-peak Power Set3 (1~500Kw)
>= 0<= 500
onPeakPowerSet4
integer <int32>
optional
On-peak Power Set4 (1~500Kw)
>= 0<= 500
onPeakPowerSet5
integer <int32>
optional
On-peak Power Set5 (1~500Kw)
>= 0<= 500
parallelAddressAutoSwitch
enum<integer> <int32>
optional
Parallel Address Auto Switch (0: Disable;1: Enable)
Allowed values:
01
parallelEnable
enum<integer> <int32>
optional
Parallel Enable (0: Disable;1: Enable;2)
Allowed values:
01
parallelRedundant
enum<integer> <int32>
optional
Parallel Redundant (0/1)
Allowed values:
01
parallelUnitNum
integer <int32>
optional
Number of parallel units (0~255)
>= 0<= 255
pbd250Enable
enum<integer> <int32>
optional
PBD250 Enable (0: Disable;1: Enable)
Allowed values:
01
pbdParallelNumSet
integer <int32>
optional
PBD Parallel Number Set (0~100)
>= 0<= 100
peakPeriodTime1
string 
optional
On-peak time1 (HH:mm-HH:mm)
peakPeriodTime2
string 
optional
On-peak time2 (HH:mm-HH:mm)
peakPeriodTime3
string 
optional
On-peak time3 (HH:mm-HH:mm)
peakPeriodTime4
string 
optional
On-peak time4 (HH:mm-HH:mm)
peakPeriodTime5
string 
optional
On-peak time5 (HH:mm-HH:mm)
pvChargeToOffGrid
number <float>
optional
PV Charge to Off-Grid (0-50000(0.001V))
>= 0<= 50
regularPeriodTime1
string 
optional
Mid-peak time1 (HH:mm-HH:mm)
regularPeriodTime2
string 
optional
Mid-peak time2 (HH:mm-HH:mm)
regularPeriodTime3
string 
optional
Mid-peak time3 (HH:mm-HH:mm)
regularPeriodTime4
string 
optional
Mid-peak time4 (HH:mm-HH:mm)
regularPeriodTime5
string 
optional
Mid-peak time5 (HH:mm-HH:mm)
socChargeCutOff
integer <int32>
optional
Charge Cut-off SOC (0-100%)
>= 0<= 100
socDischargeCutOff
integer <int32>
optional
Discharge Cut-off SOC (0-100%)
>= 0<= 100
socOff
integer <int32>
optional
GEN Off SOC (0-100%)
>= 0<= 100
socOn
integer <int32>
optional
GEN On SOC (0-100%)
>= 0<= 100
socReDischarge
integer <int32>
optional
Re-discharge SOC (0-100%)
>= 0<= 100
station485
integer <int32>
optional
485 Station (0~65535 bps)
>= 0<= 65535
systemBatCurrSampleEnable
enum<integer> <int32>
optional
System BAT Current Sample Enable (0: Disable;1: Enable)
Allowed values:
01
systemNo
integer <int32>
optional
System ID sign (0~100 )
trickleChargeSet
number <float>
optional
Trickle charge Set (0~500(0.1KW))
>= 0<= 50
valleyPeriodTime1
string 
optional
Off-peak time1 (HH:mm-HH:mm)
valleyPeriodTime2
string 
optional
Off-peak time2 (HH:mm-HH:mm)
valleyPeriodTime3
string 
optional
Off-peak time3 (HH:mm-HH:mm)
valleyPeriodTime4
string 
optional
Off-peak time4 (HH:mm-HH:mm)
valleyPeriodTime5
string 
optional
Off-peak time5 (HH:mm-HH:mm)
voltRef
integer <int32>
optional
Voltage Reference (0~800V)
>= 0<= 800
msg
string 
optional
message
Example
{
    "code": 0,
    "data": {
        "atsComNo": 0,
        "atsComNoEnable": 0,
        "atsUnitsNum": 0,
        "batCapacity": 0,
        "batCellsNum": 0,
        "batOcChargeProtect": 0,
        "batOcDischargeProtect": 0,
        "batOverVoltProtect": 0,
        "batRacksNum": 0,
        "batSaturation": 0,
        "batUnderVoltProtect": 0,
        "batUnderVoltWarn": 0,
        "bmsEnable": 0,
        "bmsVoltJudgeSwitch": 0,
        "bypassEnable": 0,
        "bypassModelSelect": 1,
        "bypassShareEnable": 0,
        "checkTime": 0,
        "cpEnable": 0,
        "cpNominalPower": 0,
        "cutOffVolt": 0,
        "dcSoftContactorEnable": 0,
        "deviceLowPeakTimeSettingVo": {
            "offSeasonSaturdayMidPeak1": "string",
            "offSeasonSaturdayMidPeak2": "string",
            "offSeasonSaturdayMidPeak3": "string",
            "offSeasonSaturdayMidPeak4": "string",
            "offSeasonSaturdayMidPeak5": "string",
            "offSeasonSaturdayOffPeak1": "string",
            "offSeasonSaturdayOffPeak2": "string",
            "offSeasonSaturdayOffPeak3": "string",
            "offSeasonSaturdayOffPeak4": "string",
            "offSeasonSaturdayOffPeak5": "string",
            "offSeasonSaturdayOnPeak1": "string",
            "offSeasonSaturdayOnPeak2": "string",
            "offSeasonSaturdayOnPeak3": "string",
            "offSeasonSaturdayOnPeak4": "string",
            "offSeasonSaturdayOnPeak5": "string",
            "offSeasonSundayMidPeak1": "string",
            "offSeasonSundayMidPeak2": "string",
            "offSeasonSundayMidPeak3": "string",
            "offSeasonSundayMidPeak4": "string",
            "offSeasonSundayMidPeak5": "string",
            "offSeasonSundayOffPeak1": "string",
            "offSeasonSundayOffPeak2": "string",
            "offSeasonSundayOffPeak3": "string",
            "offSeasonSundayOffPeak4": "string",
            "offSeasonSundayOffPeak5": "string",
            "offSeasonSundayOnPeak1": "string",
            "offSeasonSundayOnPeak2": "string",
            "offSeasonSundayOnPeak3": "string",
            "offSeasonSundayOnPeak4": "string",
            "offSeasonSundayOnPeak5": "string",
            "offSeasonTime1": "string",
            "offSeasonTime2": "string",
            "offSeasonTime3": "string",
            "offSeasonTime4": "string",
            "offSeasonWorkMidPeak1": "string",
            "offSeasonWorkMidPeak2": "string",
            "offSeasonWorkMidPeak3": "string",
            "offSeasonWorkMidPeak4": "string",
            "offSeasonWorkMidPeak5": "string",
            "offSeasonWorkOffPeak1": "string",
            "offSeasonWorkOffPeak2": "string",
            "offSeasonWorkOffPeak3": "string",
            "offSeasonWorkOffPeak4": "string",
            "offSeasonWorkOffPeak5": "string",
            "offSeasonWorkOnPeak1": "string",
            "offSeasonWorkOnPeak2": "string",
            "offSeasonWorkOnPeak3": "string",
            "offSeasonWorkOnPeak4": "string",
            "offSeasonWorkOnPeak5": "string",
            "peakSeasonSaturdayMidPeak1": "string",
            "peakSeasonSaturdayMidPeak2": "string",
            "peakSeasonSaturdayMidPeak3": "string",
            "peakSeasonSaturdayMidPeak4": "string",
            "peakSeasonSaturdayMidPeak5": "string",
            "peakSeasonSaturdayOffPeak1": "string",
            "peakSeasonSaturdayOffPeak2": "string",
            "peakSeasonSaturdayOffPeak3": "string",
            "peakSeasonSaturdayOffPeak4": "string",
            "peakSeasonSaturdayOffPeak5": "string",
            "peakSeasonSaturdayOnPeak1": "string",
            "peakSeasonSaturdayOnPeak2": "string",
            "peakSeasonSaturdayOnPeak3": "string",
            "peakSeasonSaturdayOnPeak4": "string",
            "peakSeasonSaturdayOnPeak5": "string",
            "peakSeasonSundayMidPeak1": "string",
            "peakSeasonSundayMidPeak2": "string",
            "peakSeasonSundayMidPeak3": "string",
            "peakSeasonSundayMidPeak4": "string",
            "peakSeasonSundayMidPeak5": "string",
            "peakSeasonSundayOffPeak1": "string",
            "peakSeasonSundayOffPeak2": "string",
            "peakSeasonSundayOffPeak3": "string",
            "peakSeasonSundayOffPeak4": "string",
            "peakSeasonSundayOffPeak5": "string",
            "peakSeasonSundayOnPeak1": "string",
            "peakSeasonSundayOnPeak2": "string",
            "peakSeasonSundayOnPeak3": "string",
            "peakSeasonSundayOnPeak4": "string",
            "peakSeasonSundayOnPeak5": "string",
            "peakSeasonTime1": "string",
            "peakSeasonTime2": "string",
            "peakSeasonTime3": "string",
            "peakSeasonTime4": "string",
            "peakSeasonWorkMidPeak1": "string",
            "peakSeasonWorkMidPeak2": "string",
            "peakSeasonWorkMidPeak3": "string",
            "peakSeasonWorkMidPeak4": "string",
            "peakSeasonWorkMidPeak5": "string",
            "peakSeasonWorkOffPeak1": "string",
            "peakSeasonWorkOffPeak2": "string",
            "peakSeasonWorkOffPeak3": "string",
            "peakSeasonWorkOffPeak4": "string",
            "peakSeasonWorkOffPeak5": "string",
            "peakSeasonWorkOnPeak1": "string",
            "peakSeasonWorkOnPeak2": "string",
            "peakSeasonWorkOnPeak3": "string",
            "peakSeasonWorkOnPeak4": "string",
            "peakSeasonWorkOnPeak5": "string"
        },
        "exportLimit": 0,
        "floatVolt": 0,
        "floatingLimitSet": 0,
        "gridChargePower": 0,
        "gridPvEnable": 0,
        "icharge": 0,
        "masterSlaveFlag": 0,
        "maxExportToGrid": 0,
        "maxGenPower": 0,
        "maxGridPower": 0,
        "midPeakPowerSet1": 0,
        "midPeakPowerSet2": 0,
        "midPeakPowerSet3": 0,
        "midPeakPowerSet4": 0,
        "midPeakPowerSet5": 0,
        "modelSelect": 0,
        "offPeakPowerSet1": 0,
        "offPeakPowerSet2": 0,
        "offPeakPowerSet3": 0,
        "offPeakPowerSet4": 0,
        "offPeakPowerSet5": 0,
        "oilMachineEnable": 0,
        "onOff": "0",
        "onPeakPowerSet1": 0,
        "onPeakPowerSet2": 0,
        "onPeakPowerSet3": 0,
        "onPeakPowerSet4": 0,
        "onPeakPowerSet5": 0,
        "parallelAddressAutoSwitch": 0,
        "parallelEnable": 0,
        "parallelRedundant": 0,
        "parallelUnitNum": 0,
        "pbd250Enable": 0,
        "pbdParallelNumSet": 0,
        "peakPeriodTime1": "string",
        "peakPeriodTime2": "string",
        "peakPeriodTime3": "string",
        "peakPeriodTime4": "string",
        "peakPeriodTime5": "string",
        "pvChargeToOffGrid": 0,
        "regularPeriodTime1": "string",
        "regularPeriodTime2": "string",
        "regularPeriodTime3": "string",
        "regularPeriodTime4": "string",
        "regularPeriodTime5": "string",
        "socChargeCutOff": 0,
        "socDischargeCutOff": 0,
        "socOff": 0,
        "socOn": 0,
        "socReDischarge": 0,
        "station485": 0,
        "systemBatCurrSampleEnable": 0,
        "systemNo": 0,
        "trickleChargeSet": 0,
        "valleyPeriodTime1": "string",
        "valleyPeriodTime2": "string",
        "valleyPeriodTime3": "string",
        "valleyPeriodTime4": "string",
        "valleyPeriodTime5": "string",
        "voltRef": 0
    },
    "msg": "string"
}
Previous
Get the latest real-time data of PCS
Next
Modify setting of PCS
Built with