Limit the frequency

The device supports 10 reads per day

Request Header

Header	Value	Description
Authorization	############ your token ############	Permission validation
Accept-Language	en	English Message

Request Param

Method : GET

Key	Value Type
deviceSn	String

https://www.enerclo-atesspower.com/api/v1/hps/big-setting?deviceSn=1

Response Body

{
    "code": 0,
    "data": {
        "atsComNo": 0,
......        
        "valleyPeriodTime5": "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

code	description
200	succeed
500	fail
400	not fount
403	No 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.

HPS100HV,HPS150HV models additional parameters

parameter	device type	desc
sharedBatteryEnable	HPS100HV/HPS150HV	Not supported
cpEnable	HPS100HV/HPS150HV	Not supported
cpNominalPower	HPS100HV/HPS150HV	Not supported

Responses

🟢200OK

*/*

Body

code

integer <int32>

optional

code

data

object (OpenApiCentralTypeHpsSettingVo)

optional

data

atsComNo

integer <int32>

optional

ATS Com No. (0~255)

atsComNoEnable

enum<integer> <int32>

optional

ATS Com No.Enable (0: Disable;1: Enable)

Allowed values:

atsUnitsNum

integer <int32>

optional

ATS units (0~10)

batCapacity

integer <int32>

optional

Battery Capacity (0~50000 AH)

batCellsNum

integer <int32>

optional

No.of Battery Cells (0~50000)

batOcChargeProtect

number <float>

optional

BAT OC Charge Protect (0~10000（0.1A）)

batOcDischargeProtect

number <float>

optional

BAT OC Discharge Protect (0~10000（0.1A）)

batOverVoltProtect

number <float>

optional

BAT OverVolt Protect (0~50000（0.001V）)

batRacksNum

integer <int32>

optional

No.of Battery Racks (0~100)

batSaturation

integer <int32>

optional

BAT Saturation (0~10)

batToNonCriticalEnable

enum<integer> <int32>

optional

BAT to Non-Critical Enable (0: Disable;1: Enable)

Allowed values:

batUnderVoltProtect

number <float>

optional

BAT UnderVolt Protect (0~50000（0.001V）针对每个电池单元)

batUnderVoltWarn

number <float>

optional

BAT UnderVolt Warning (0~50000（0.001V）针对每个电池单元)

bmsEnable

enum<integer> <int32>

optional

BMS Com Enable (0: Disable;1: Enable)

Allowed values:

bmsVoltJudgeSwitch

enum<integer> <int32>

optional

BMS Volt Judge Switch (0: Disable;1: Enable)

Allowed values:

bypassEnable

enum<integer> <int32>

optional

ATS Enable (0: Disable;1: Enable)

Allowed values:

checkTime

string

optional

Check Time (0~1000S)

cpEnable

integer <int32>

optional

PSG Enable

cpNominalPower

integer <int32>

optional

PSG Nominal Power

cutOffVolt

number <float>

optional

Cut-off Voltage (0~50000 针对每个电池单元（0.001V）)

deviceLowPeakTimeSettingVo

object (OpenApiDeviceLowPeakTimeSettingVo)

optional

Low peak season setting

exportLimit

enum<integer> <int32>

optional

Zero Export Enable (0: Disable;1: Enable)

Allowed values:

floatVolt

number <float>

optional

Float Voltage (0~50000（0.001V）针对每个电池单元)

floatingLimitSet

number <float>

optional

Floating Limit Set (0~100针对每个电池单元（0.01V）)

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:

icharge

integer <int32>

optional

BAT Charge Current (0~800 1A)

masterSlaveFlag

integer <int32>

optional

Parallel Address

maxExportToGrid

integer <int32>

optional

Max.Export to Grid (0~500kW)

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

maxGridPower

integer <int32>

optional

Max.Import from Grid (0~500Kw)

meterComNo

integer <int32>

optional

Meter Com No. (0~255)

meterCtRatio

integer <int32>

optional

Meter CT ratio (0~65535)

midPeakPowerSet1

integer <int32>

optional

Mid-peak Power Set1

midPeakPowerSet2

integer <int32>

optional

Mid-peak Power Set2

midPeakPowerSet3

integer <int32>

optional

Mid-peak Power Set3

midPeakPowerSet4

integer <int32>

optional

Mid-peak Power Set4

midPeakPowerSet5

integer <int32>

optional

Mid-peak Power Set5

modelSelect

integer <int32>

optional

Mode

offPeakPowerSet1

integer <int32>

optional

Off-peak Power Set1

offPeakPowerSet2

integer <int32>

optional

Off-peak Power Set2

offPeakPowerSet3

integer <int32>

optional

Off-peak Power Set3

offPeakPowerSet4

integer <int32>

optional

Off-peak Power Set4

offPeakPowerSet5

integer <int32>

optional

Off-peak Power Set5

oilMachineEnable

enum<integer> <int32>

optional

DG Enable (0: Disable;1: Enable)

Allowed values:

onOff

enum<integer> <int32>

optional

ON/OFF (0: Off;1: On)

Allowed values:

onPeakPowerSet1

integer <int32>

optional

On-peak Power Set1 (0~500Kw)

onPeakPowerSet2

integer <int32>

optional

On-peak Power Set2 (0~500Kw)

onPeakPowerSet3

integer <int32>

optional

On-peak Power Set3 (0~500Kw)

onPeakPowerSet4

integer <int32>

optional

On-peak Power Set4 (0~500Kw)

onPeakPowerSet5

integer <int32>

optional

On-peak Power Set5 (0~500Kw)

parallelAddressAutoSwitch

enum<integer> <int32>

optional

Parallel Address Auto Switch (0: Disable;1: Enable)

Allowed values:

parallelEnable

enum<integer> <int32>

optional

Parallel Enable (0: Disable;1: Enable)

Allowed values:

parallelRedundant

enum<integer> <int32>

optional

Parallel Redundant

Allowed values:

parallelUnitNum

integer <int32>

optional

Number of parallel units

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）)

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)

sharedBatteryEnable

enum<integer> <int32>

optional

Battery Share Enable

Allowed values:

socChargeCutOff

integer <int32>

optional

Charge Cut-off SOC (0-100%)

socDischargeCutOff

integer <int32>

optional

Discharge Cut-off SOC (0-100%)

socOff

integer <int32>

optional

GEN Off SOC (0~100%)

socOn

integer <int32>

optional

GEN On SOC (0~100%)

socReDischarge

integer <int32>

optional

Re-discharge SOC (0-100%)

station485

integer <int32>

optional

485 Station (0~65535 bps)

systemNo

integer <int32>

optional

System ID sign (0~100 )

trickleChargeSet

number <float>

optional

Trickle charge Set (0~500(0.1KW))

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)

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,
        "batToNonCriticalEnable": 0,
        "batUnderVoltProtect": 0,
        "batUnderVoltWarn": 0,
        "bmsEnable": 0,
        "bmsVoltJudgeSwitch": 0,
        "bypassEnable": 0,
        "checkTime": "string",
        "cpEnable": 0,
        "cpNominalPower": 0,
        "cutOffVolt": 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,
        "maxGenChargePower": 0,
        "maxGenPower": 0,
        "maxGridPower": 0,
        "meterComNo": 0,
        "meterCtRatio": 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,
        "peakPeriodTime1": "string",
        "peakPeriodTime2": "string",
        "peakPeriodTime3": "string",
        "peakPeriodTime4": "string",
        "peakPeriodTime5": "string",
        "pvChargeToOffGrid": 0,
        "regularPeriodTime1": "string",
        "regularPeriodTime2": "string",
        "regularPeriodTime3": "string",
        "regularPeriodTime4": "string",
        "regularPeriodTime5": "string",
        "sharedBatteryEnable": 0,
        "socChargeCutOff": 0,
        "socDischargeCutOff": 0,
        "socOff": 0,
        "socOn": 0,
        "socReDischarge": 0,
        "station485": 0,
        "systemNo": 0,
        "trickleChargeSet": 0,
        "valleyPeriodTime1": "string",
        "valleyPeriodTime2": "string",
        "valleyPeriodTime3": "string",
        "valleyPeriodTime4": "string",
        "valleyPeriodTime5": "string"
    },
    "msg": "string"
}

Get setting of Central type HPS

Limit the frequency#

Request Header#

Request Param#

Response Body#

Response Data Description#

HPS100HV,HPS150HV models additional parameters#

Request

Responses

Limit the frequency

Request Header

Request Param

Response Body

Response Data Description

HPS100HV,HPS150HV models additional parameters