Package io.openems.edge.controller.ess.emergencycapacityreserve

Interface ControllerEssEmergencyCapacityReserve

All Superinterfaces:

Controller, OpenemsComponent

All Known Implementing Classes:

ControllerEssEmergencyCapacityReserveImpl

public interface ControllerEssEmergencyCapacityReserve
extends Controller, OpenemsComponent

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	ControllerEssEmergencyCapacityReserve.ChannelId

Method Summary

Modifier and Type	Method	Description
default void	_setActualReserveSoc(Integer value)	Internal method to set the 'nextValue' on ControllerEssEmergencyCapacityReserve.ChannelId.ACTUAL_RESERVE_SOC Channel.
default void	_setDebugRampPower(float value)	Internal method to set the 'nextValue' on ControllerEssEmergencyCapacityReserve.ChannelId.DEBUG_RAMP_POWER Channel.
default void	_setDebugRampPower(Float value)	Internal method to set the 'nextValue' on ControllerEssEmergencyCapacityReserve.ChannelId.DEBUG_RAMP_POWER Channel.
default void	_setDebugSetActivePowerLessOrEquals(int value)	Internal method to set the 'nextValue' on ControllerEssEmergencyCapacityReserve.ChannelId.DEBUG_SET_ACTIVE_POWER_LESS_OR_EQUALS Channel.
default void	_setDebugSetActivePowerLessOrEquals(Integer value)	Internal method to set the 'nextValue' on ControllerEssEmergencyCapacityReserve.ChannelId.DEBUG_SET_ACTIVE_POWER_LESS_OR_EQUALS Channel.
default void	_setDebugTargetPower(float value)	Internal method to set the 'nextValue' on ControllerEssEmergencyCapacityReserve.ChannelId.DEBUG_TARGET_POWER Channel.
default void	_setDebugTargetPower(Float value)	Internal method to set the 'nextValue' on ControllerEssEmergencyCapacityReserve.ChannelId.DEBUG_TARGET_POWER Channel.
default void	_setRangeOfReserveSocOutsideAllowedValue(boolean value)	Internal method to set the 'nextValue' on ControllerEssEmergencyCapacityReserve.ChannelId.RANGE_OF_RESERVE_SOC_OUTSIDE_ALLOWED_VALUE Channel.
default void	_setStateMachine(StateMachine.State value)	Internal method to set the 'nextValue' on ControllerEssEmergencyCapacityReserve.ChannelId.STATE_MACHINE Channel.
default Value<Integer>	getActualReserveSoc()	Gets the SoC value if Reserve SoC is enabled and returns null otherwise.
default IntegerReadChannel	getActualReserveSocChannel()	Gets the Channel for ControllerEssEmergencyCapacityReserve.ChannelId.ACTUAL_RESERVE_SOC.
default Value<Float>	getDebugRampPower()	Gets the debug ramp power in [W].
default FloatReadChannel	getDebugRampPowerChannel()	Gets the Channel for ControllerEssEmergencyCapacityReserve.ChannelId.DEBUG_RAMP_POWER.
default Value<Integer>	getDebugSetActivePowerLessOrEquals()	Gets the debug active power less or equals constraint in [W].
default IntegerReadChannel	getDebugSetActivePowerLessOrEqualsChannel()	Gets the Channel for ControllerEssEmergencyCapacityReserve.ChannelId.DEBUG_SET_ACTIVE_POWER_LESS_OR_EQUALS.
default Value<Float>	getDebugTargetPower()	Gets the debug ramp power in [W].
default FloatReadChannel	getDebugTargetPowerChannel()	Gets the Channel for ControllerEssEmergencyCapacityReserve.ChannelId.DEBUG_TARGET_POWER.
default StateMachine.State	getStateMachine()	Gets current state of the StateMachine.
default Channel<StateMachine.State>	getStateMachineChannel()	Gets the Channel for ControllerEssEmergencyCapacityReserve.ChannelId.STATE_MACHINE.

Methods inherited from interface io.openems.edge.controller.api.Controller

_setRunFailed, getRunFailed, getRunFailedChannel, run

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

_channel, _getChannelAs, alias, channel, channel, channels, debugLog, getComponentContext, getState, getStateChannel, hasFaults, id, isEnabled, serviceFactoryPid, servicePid

Method Details

getStateMachineChannel

default Channel<StateMachine.State> getStateMachineChannel()

Gets the Channel for ControllerEssEmergencyCapacityReserve.ChannelId.STATE_MACHINE.

Returns:

the Channel

getStateMachine

default StateMachine.State getStateMachine()

Gets current state of the StateMachine. See ControllerEssEmergencyCapacityReserve.ChannelId.STATE_MACHINE.

Returns:

the Channel Value

_setStateMachine

default void _setStateMachine(StateMachine.State value)

Internal method to set the 'nextValue' on ControllerEssEmergencyCapacityReserve.ChannelId.STATE_MACHINE Channel.

Parameters:

value - the next value

getDebugSetActivePowerLessOrEqualsChannel

default IntegerReadChannel getDebugSetActivePowerLessOrEqualsChannel()

Gets the Channel for ControllerEssEmergencyCapacityReserve.ChannelId.DEBUG_SET_ACTIVE_POWER_LESS_OR_EQUALS.

Returns:

the Channel

getDebugSetActivePowerLessOrEquals

default Value<Integer> getDebugSetActivePowerLessOrEquals()

Gets the debug active power less or equals constraint in [W]. See ControllerEssEmergencyCapacityReserve.ChannelId.DEBUG_SET_ACTIVE_POWER_LESS_OR_EQUALS.

Returns:

the Channel Value

_setDebugSetActivePowerLessOrEquals

default void _setDebugSetActivePowerLessOrEquals(Integer value)

Internal method to set the 'nextValue' on ControllerEssEmergencyCapacityReserve.ChannelId.DEBUG_SET_ACTIVE_POWER_LESS_OR_EQUALS Channel.

Parameters:

value - the next value

_setDebugSetActivePowerLessOrEquals

default void _setDebugSetActivePowerLessOrEquals(int value)

Internal method to set the 'nextValue' on ControllerEssEmergencyCapacityReserve.ChannelId.DEBUG_SET_ACTIVE_POWER_LESS_OR_EQUALS Channel.

Parameters:

value - the next value

getDebugTargetPowerChannel

default FloatReadChannel getDebugTargetPowerChannel()

Gets the Channel for ControllerEssEmergencyCapacityReserve.ChannelId.DEBUG_TARGET_POWER.

Returns:

the Channel

getDebugTargetPower

default Value<Float> getDebugTargetPower()

Gets the debug ramp power in [W]. See ControllerEssEmergencyCapacityReserve.ChannelId.DEBUG_TARGET_POWER.

Returns:

the Channel Value

_setDebugTargetPower

default void _setDebugTargetPower(Float value)

Internal method to set the 'nextValue' on ControllerEssEmergencyCapacityReserve.ChannelId.DEBUG_TARGET_POWER Channel.

Parameters:

value - the next value

_setDebugTargetPower

default void _setDebugTargetPower(float value)

Internal method to set the 'nextValue' on ControllerEssEmergencyCapacityReserve.ChannelId.DEBUG_TARGET_POWER Channel.

Parameters:

value - the next value

getDebugRampPowerChannel

default FloatReadChannel getDebugRampPowerChannel()

Gets the Channel for ControllerEssEmergencyCapacityReserve.ChannelId.DEBUG_RAMP_POWER.

Returns:

the Channel

getDebugRampPower

default Value<Float> getDebugRampPower()

Gets the debug ramp power in [W]. See ControllerEssEmergencyCapacityReserve.ChannelId.DEBUG_RAMP_POWER.

Returns:

the Channel Value

_setDebugRampPower

default void _setDebugRampPower(Float value)

Internal method to set the 'nextValue' on ControllerEssEmergencyCapacityReserve.ChannelId.DEBUG_RAMP_POWER Channel.

Parameters:

value - the next value

_setDebugRampPower

default void _setDebugRampPower(float value)

Internal method to set the 'nextValue' on ControllerEssEmergencyCapacityReserve.ChannelId.DEBUG_RAMP_POWER Channel.

Parameters:

value - the next value

_setRangeOfReserveSocOutsideAllowedValue

default void _setRangeOfReserveSocOutsideAllowedValue(boolean value)

Internal method to set the 'nextValue' on ControllerEssEmergencyCapacityReserve.ChannelId.RANGE_OF_RESERVE_SOC_OUTSIDE_ALLOWED_VALUE Channel.

Parameters:

value - the next value

getActualReserveSocChannel

default IntegerReadChannel getActualReserveSocChannel()

Gets the Channel for ControllerEssEmergencyCapacityReserve.ChannelId.ACTUAL_RESERVE_SOC.

Returns:

the Channel

_setActualReserveSoc

default void _setActualReserveSoc(Integer value)

Internal method to set the 'nextValue' on ControllerEssEmergencyCapacityReserve.ChannelId.ACTUAL_RESERVE_SOC Channel.

Parameters:

value - the next value

getActualReserveSoc

default Value<Integer> getActualReserveSoc()

Gets the SoC value if Reserve SoC is enabled and returns null otherwise. See ControllerEssEmergencyCapacityReserve.ChannelId.ACTUAL_RESERVE_SOC.

Returns:

the Channel Value