io.openems.edge.ess.test

Class DummyManagedSymmetricEss

java.lang.Object

io.openems.edge.common.component.AbstractOpenemsComponent

io.openems.edge.ess.test.DummyManagedSymmetricEss

All Implemented Interfaces:

OpenemsComponent, ManagedSymmetricEss, SymmetricEss

Direct Known Subclasses:

DummyManagedAsymmetricEss

public class DummyManagedSymmetricEss
extends AbstractOpenemsComponent
implements ManagedSymmetricEss, SymmetricEss, OpenemsComponent

Provides a simple, simulated ManagedSymmetricEss component that can be used together with the OpenEMS Component test framework.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DummyManagedSymmetricEss.SymmetricApplyPowerRecord

Nested classes/interfaces inherited from interface io.openems.edge.ess.api.ManagedSymmetricEss

ManagedSymmetricEss.ChannelId

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_APPARENT_POWER

Fields inherited from interface io.openems.edge.ess.api.SymmetricEss

POWER_DOC_TEXT

Constructor Summary

Constructors

Modifier	Constructor and Description
	DummyManagedSymmetricEss(java.lang.String id)
	DummyManagedSymmetricEss(java.lang.String id, Power power)
protected	DummyManagedSymmetricEss(java.lang.String id, Power power, ChannelId[] firstInitialChannelIds, ChannelId[]... furtherInitialChannelIds)

Method Summary

Modifier and Type	Method and Description
void	applyPower(int activePower, int reactivePower) Apply the calculated Power.
Power	getPower() Gets an instance of the 'Power' class, which allows to set limitations to Active and Reactive Power.
int	getPowerPrecision() Gets the smallest positive power that can be set (in W, VA or var).
DummyManagedSymmetricEss	withAllowedChargePower(int value) Set ManagedSymmetricEss.ChannelId#ALLOWED_CHARGE_POWER of this DummyManagedSymmetricEss.
DummyManagedSymmetricEss	withAllowedDischargePower(int value) Set ManagedSymmetricEss.ChannelId#ALLOWED_DISCHARGE_POWER of this DummyManagedSymmetricEss.
DummyManagedSymmetricEss	withCapacity(int value) Set SymmetricEss.ChannelId#CAPACITY of this DummyManagedSymmetricEss.
DummyManagedSymmetricEss	withGridMode(GridMode value) Set SymmetricEss.ChannelId#GRID_MODE of this DummyManagedSymmetricEss.
DummyManagedSymmetricEss	withMaxApparentPower(int value) Set SymmetricEss.ChannelId#MAX_APPARENT_POWER of this DummyManagedSymmetricEss.
DummyManagedSymmetricEss	withPowerPrecision(int value) Set Power Precision of this DummyManagedSymmetricEss.
DummyManagedSymmetricEss	withSoc(int value) Set SymmetricEss.ChannelId#SOC of this DummyManagedSymmetricEss.
DummyManagedSymmetricEss	withSymmetricApplyPowerCallback(java.util.function.Consumer<DummyManagedSymmetricEss.SymmetricApplyPowerRecord> callback) Set callback for applyPower() of this DummyManagedSymmetricEss.

Methods inherited from class io.openems.edge.common.component.AbstractOpenemsComponent

_channel, activate, addChannel, addChannels, addChannels, alias, channels, deactivate, getComponentContext, id, isEnabled, logDebug, logError, logInfo, logWarn, modified, removeChannel

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.openems.edge.ess.api.ManagedSymmetricEss

_setAllowedChargePower, _setAllowedChargePower, _setAllowedDischargePower, _setAllowedDischargePower, _setApplyPowerFailed, _setDebugSetActivePower, _setDebugSetActivePower, _setDebugSetReactivePower, _setDebugSetReactivePower, addPowerConstraint, addPowerConstraintAndValidate, createPowerConstraint, getAllowedChargePower, getAllowedChargePowerChannel, getAllowedDischargePower, getAllowedDischargePowerChannel, getApplyPowerFailed, getApplyPowerFailedChannel, getDebugSetActivePower, getDebugSetActivePowerChannel, getDebugSetReactivePower, getDebugSetReactivePowerChannel, getModbusSlaveNatureTable, getSetActivePowerEqualsChannel, getSetActivePowerEqualsWithPidChannel, getSetActivePowerGreaterOrEqualsChannel, getSetActivePowerLessOrEqualsChannel, getSetReactivePowerEqualsChannel, getSetReactivePowerGreaterOrEqualsChannel, getSetReactivePowerLessOrEqualsChannel, getStaticConstraints, setActivePowerEquals, setActivePowerEqualsWithPid, setActivePowerGreaterOrEquals, setActivePowerLessOrEquals, setReactivePowerEquals, setReactivePowerGreaterOrEquals, setReactivePowerLessOrEquals

Methods inherited from interface io.openems.edge.ess.api.SymmetricEss

_setActiveChargeEnergy, _setActiveChargeEnergy, _setActiveDischargeEnergy, _setActiveDischargeEnergy, _setActivePower, _setActivePower, _setCapacity, _setCapacity, _setGridMode, _setMaxApparentPower, _setMaxApparentPower, _setMaxCellTemperature, _setMaxCellTemperature, _setMaxCellVoltage, _setMaxCellVoltage, _setMinCellTemperature, _setMinCellTemperature, _setMinCellVoltage, _setMinCellVoltage, _setReactivePower, _setReactivePower, _setSoc, _setSoc, getActiveChargeEnergy, getActiveChargeEnergyChannel, getActiveDischargeEnergy, getActiveDischargeEnergyChannel, getActivePower, getActivePowerChannel, getCapacity, getCapacityChannel, getGridMode, getGridModeChannel, getMaxApparentPower, getMaxApparentPowerChannel, getMaxCellTemperature, getMaxCellTemperatureChannel, getMaxCellVoltage, getMaxCellVoltageChannel, getMinCellTemperature, getMinCellTemperatureChannel, getMinCellVoltage, getMinCellVoltageChannel, getReactivePower, getReactivePowerChannel, getSoc, getSocChannel

Methods inherited from interface io.openems.edge.common.component.OpenemsComponent

_channel, _getChannelAs, alias, channel, channel, channels, debugLog, getComponentContext, getState, getStateChannel, hasFaults, id, isEnabled, logDebug, logError, logInfo, logWarn, serviceFactoryPid, servicePid, updateConfigurationProperty, updateReferenceFilter

Field Detail

MAX_APPARENT_POWER

public static final int MAX_APPARENT_POWER

See Also:

Constant Field Values

Constructor Detail

DummyManagedSymmetricEss

protected DummyManagedSymmetricEss(java.lang.String id,
                                   Power power,
                                   ChannelId[] firstInitialChannelIds,
                                   ChannelId[]... furtherInitialChannelIds)

DummyManagedSymmetricEss

public DummyManagedSymmetricEss(java.lang.String id,
                                Power power)

DummyManagedSymmetricEss

public DummyManagedSymmetricEss(java.lang.String id)

Method Detail

getPower

public Power getPower()

Description copied from interface: ManagedSymmetricEss

Gets an instance of the 'Power' class, which allows to set limitations to Active and Reactive Power.

Specified by:

getPower in interface ManagedSymmetricEss

Returns:

the Power instance

getPowerPrecision

public int getPowerPrecision()

Description copied from interface: ManagedSymmetricEss

Gets the smallest positive power that can be set (in W, VA or var). Example:

• FENECON Commercial 40 allows setting of power in 100 W steps. It should return 100.
• KACO blueplanet gridsave 50 allows setting of power in 0.1 % of 52 VA. It should return 52 (= 52000 * 0.001)

Specified by:

getPowerPrecision in interface ManagedSymmetricEss

Returns:

the power precision

withSoc

public DummyManagedSymmetricEss withSoc(int value)

Set SymmetricEss.ChannelId#SOC of this DummyManagedSymmetricEss.

Parameters:

value - the state-of-charge

Returns:

myself

withCapacity

public DummyManagedSymmetricEss withCapacity(int value)

Set SymmetricEss.ChannelId#CAPACITY of this DummyManagedSymmetricEss. *

Parameters:

value - the capacity

Returns:

myself

withGridMode

public DummyManagedSymmetricEss withGridMode(GridMode value)

Set SymmetricEss.ChannelId#GRID_MODE of this DummyManagedSymmetricEss. *

Parameters:

value - the GridMode

Returns:

myself

withMaxApparentPower

public DummyManagedSymmetricEss withMaxApparentPower(int value)

Set SymmetricEss.ChannelId#MAX_APPARENT_POWER of this DummyManagedSymmetricEss. *

Parameters:

value - the max apparent power

Returns:

myself

withAllowedChargePower

public DummyManagedSymmetricEss withAllowedChargePower(int value)

Set ManagedSymmetricEss.ChannelId#ALLOWED_CHARGE_POWER of this DummyManagedSymmetricEss. *

Parameters:

value - the allowed charge power

Returns:

myself

withAllowedDischargePower

public DummyManagedSymmetricEss withAllowedDischargePower(int value)

Set ManagedSymmetricEss.ChannelId#ALLOWED_DISCHARGE_POWER of this DummyManagedSymmetricEss. *

Parameters:

value - the allowed discharge power

Returns:

myself

withPowerPrecision

public DummyManagedSymmetricEss withPowerPrecision(int value)

Set Power Precision of this DummyManagedSymmetricEss.

Parameters:

value - the power precision

Returns:

myself

withSymmetricApplyPowerCallback

public DummyManagedSymmetricEss withSymmetricApplyPowerCallback(java.util.function.Consumer<DummyManagedSymmetricEss.SymmetricApplyPowerRecord> callback)

Set callback for applyPower() of this DummyManagedSymmetricEss.

Parameters:

callback - the callback

Returns:

myself

applyPower

public void applyPower(int activePower,
                       int reactivePower)

Description copied from interface: ManagedSymmetricEss

Apply the calculated Power.

Careful: do not adjust activePower and reactivePower in this method, e.g. setting it to zero on error. The purpose of this method is solely to apply the calculated power to the ESS. If you need to constrain the allowed power, add Constraints using the ManagedSymmetricEss.getStaticConstraints() method.

Specified by:

applyPower in interface ManagedSymmetricEss

Parameters:

activePower - the active power in [W]

reactivePower - the reactive power in [var]