Package io.openems.edge.controller.ess.fixstateofcharge.api

Interface FixStateOfCharge

All Superinterfaces:

Controller, OpenemsComponent

All Known Implementing Classes:

AbstractFixStateOfCharge, ControllerEssFixStateOfChargeImpl, ControllerEssPrepareBatteryExtensionImpl

public interface FixStateOfCharge
extends Controller, OpenemsComponent

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	FixStateOfCharge.ChannelId

Method Summary

Modifier and Type	Method	Description
default void	_setAtTargetEpochSeconds(long value)	Internal method to set the 'nextValue' on FixStateOfCharge.ChannelId.AT_TARGET_EPOCH_SECONDS Channel.
default void	_setAtTargetEpochSeconds(Long value)	Internal method to set the 'nextValue' on FixStateOfCharge.ChannelId.AT_TARGET_EPOCH_SECONDS Channel.
default void	_setCtrlIsBlockingEss(boolean value)	Internal method to set the 'nextValue' on FixStateOfCharge.ChannelId.CTRL_IS_BLOCKING_ESS Channel.
default void	_setCtrlIsChargingEss(boolean value)	Internal method to set the 'nextValue' on FixStateOfCharge.ChannelId.CTRL_IS_CHARGING_ESS Channel.
default void	_setCtrlIsDischargingEss(boolean value)	Internal method to set the 'nextValue' on FixStateOfCharge.ChannelId.CTRL_IS_DISCHARGING_ESS Channel.
default void	_setCtrlWasSelfTerminated(boolean value)	Internal method to set the 'nextValue' on FixStateOfCharge.ChannelId.CTRL_WAS_SELF_TERMINATED Channel.
default void	_setDebugRampPower(float value)	Internal method to set the 'nextValue' on FixStateOfCharge.ChannelId.DEBUG_RAMP_POWER Channel.
default void	_setDebugRampPower(Float value)	Internal method to set the 'nextValue' on FixStateOfCharge.ChannelId.DEBUG_RAMP_POWER Channel.
default void	_setDebugSetActivePower(int value)	Internal method to set the 'nextValue' on FixStateOfCharge.ChannelId.DEBUG_SET_ACTIVE_POWER Channel.
default void	_setDebugSetActivePower(Integer value)	Internal method to set the 'nextValue' on FixStateOfCharge.ChannelId.DEBUG_SET_ACTIVE_POWER Channel.
default void	_setDebugSetActivePowerRaw(int value)	Internal method to set the 'nextValue' on FixStateOfCharge.ChannelId.DEBUG_SET_ACTIVE_POWER_RAW Channel.
default void	_setDebugSetActivePowerRaw(Integer value)	Internal method to set the 'nextValue' on FixStateOfCharge.ChannelId.DEBUG_SET_ACTIVE_POWER_RAW Channel.
default void	_setEssCapacity(int value)	Internal method to set the 'nextValue' on FixStateOfCharge.ChannelId.ESS_CAPACITY Channel.
default void	_setEssCapacity(Integer value)	Internal method to set the 'nextValue' on FixStateOfCharge.ChannelId.ESS_CAPACITY Channel.
default void	_setExpectedStartEpochSeconds(long value)	Internal method to set the 'nextValue' on FixStateOfCharge.ChannelId.EXPECTED_START_EPOCH_SECONDS Channel.
default void	_setExpectedStartEpochSeconds(Long value)	Internal method to set the 'nextValue' on FixStateOfCharge.ChannelId.EXPECTED_START_EPOCH_SECONDS Channel.
default void	_setStateMachine(StateMachine.State value)	Internal method to set the 'nextValue' on FixStateOfCharge.ChannelId.STATE_MACHINE Channel.
default Value<Long>	getAtTargetEpochSeconds()	Gets the time when the target SoC was reached as epoch seconds.
default LongReadChannel	getAtTargetEpochSecondsChannel()	Gets the Channel for FixStateOfCharge.ChannelId.AT_TARGET_EPOCH_SECONDS.
default Value<Boolean>	getCtrlIsBlockingEss()	Gets the State Channel as Boolean Value.
default StateChannel	getCtrlIsBlockingEssChannel()	Gets the Channel for FixStateOfCharge.ChannelId.CTRL_IS_BLOCKING_ESS.
default Value<Boolean>	getCtrlIsChargingEss()	Gets the State Channel as Boolean Value.
default StateChannel	getCtrlIsChargingEssChannel()	Gets the Channel for FixStateOfCharge.ChannelId.CTRL_IS_CHARGING_ESS.
default Value<Boolean>	getCtrlIsDischargingEss()	Gets the State Channel as Boolean Value.
default StateChannel	getCtrlIsDischargingEssChannel()	Gets the Channel for FixStateOfCharge.ChannelId.CTRL_IS_DISCHARGING_ESS.
default Value<Boolean>	getCtrlWasSelfTerminated()	Gets the State Channel as Boolean Value.
default StateChannel	getCtrlWasSelfTerminatedChannel()	Gets the Channel for FixStateOfCharge.ChannelId.CTRL_WAS_SELF_TERMINATED.
default Value<Float>	getDebugRampPower()	Gets the debug ramp power in [W].
default FloatReadChannel	getDebugRampPowerChannel()	Gets the Channel for FixStateOfCharge.ChannelId.DEBUG_RAMP_POWER.
default Value<Integer>	getDebugSetActivePower()	Gets the active power limit set in [W].
default IntegerReadChannel	getDebugSetActivePowerChannel()	Gets the Channel for FixStateOfCharge.ChannelId.DEBUG_SET_ACTIVE_POWER.
default Value<Integer>	getDebugSetActivePowerRaw()	Gets the active power limit set in [W].
default IntegerReadChannel	getDebugSetActivePowerRawChannel()	Gets the Channel for FixStateOfCharge.ChannelId.DEBUG_SET_ACTIVE_POWER_RAW.
default Value<Integer>	getEssCapacity()	Gets the Capacity in [Wh].
default IntegerReadChannel	getEssCapacityChannel()	Gets the Channel for FixStateOfCharge.ChannelId.ESS_CAPACITY.
default Value<Long>	getExpectedStartEpochSeconds()	Gets the time when the controller is expected to charge or discharge the ess.
default LongReadChannel	getExpectedStartEpochSecondsChannel()	Gets the Channel for FixStateOfCharge.ChannelId.EXPECTED_START_EPOCH_SECONDS.
default StateMachine.State	getStateMachine()	Gets current state of the StateMachine.
default Channel<StateMachine.State>	getStateMachineChannel()	Gets the Channel for FixStateOfCharge.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 FixStateOfCharge.ChannelId.STATE_MACHINE.

Returns:

the Channel

getStateMachine

default StateMachine.State getStateMachine()

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

Returns:

the Channel Value

_setStateMachine

default void _setStateMachine(StateMachine.State value)

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

Parameters:

value - the next value

getDebugSetActivePowerChannel

default IntegerReadChannel getDebugSetActivePowerChannel()

Gets the Channel for FixStateOfCharge.ChannelId.DEBUG_SET_ACTIVE_POWER.

Returns:

the Channel

getDebugSetActivePower

default Value<Integer> getDebugSetActivePower()

Gets the active power limit set in [W]. See FixStateOfCharge.ChannelId.DEBUG_SET_ACTIVE_POWER.

Returns:

the Channel Value

_setDebugSetActivePower

default void _setDebugSetActivePower(Integer value)

Internal method to set the 'nextValue' on FixStateOfCharge.ChannelId.DEBUG_SET_ACTIVE_POWER Channel.

Parameters:

value - the next value

_setDebugSetActivePower

default void _setDebugSetActivePower(int value)

Internal method to set the 'nextValue' on FixStateOfCharge.ChannelId.DEBUG_SET_ACTIVE_POWER Channel.

Parameters:

value - the next value

getDebugSetActivePowerRawChannel

default IntegerReadChannel getDebugSetActivePowerRawChannel()

Gets the Channel for FixStateOfCharge.ChannelId.DEBUG_SET_ACTIVE_POWER_RAW.

Returns:

the Channel

getDebugSetActivePowerRaw

default Value<Integer> getDebugSetActivePowerRaw()

Gets the active power limit set in [W]. See FixStateOfCharge.ChannelId.DEBUG_SET_ACTIVE_POWER_RAW.

Returns:

the Channel Value

_setDebugSetActivePowerRaw

default void _setDebugSetActivePowerRaw(Integer value)

Internal method to set the 'nextValue' on FixStateOfCharge.ChannelId.DEBUG_SET_ACTIVE_POWER_RAW Channel.

Parameters:

value - the next value

_setDebugSetActivePowerRaw

default void _setDebugSetActivePowerRaw(int value)

Internal method to set the 'nextValue' on FixStateOfCharge.ChannelId.DEBUG_SET_ACTIVE_POWER_RAW Channel.

Parameters:

value - the next value

getDebugRampPowerChannel

default FloatReadChannel getDebugRampPowerChannel()

Gets the Channel for FixStateOfCharge.ChannelId.DEBUG_RAMP_POWER.

Returns:

the Channel

getDebugRampPower

default Value<Float> getDebugRampPower()

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

Returns:

the Channel Value

_setDebugRampPower

default void _setDebugRampPower(Float value)

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

Parameters:

value - the next value

_setDebugRampPower

default void _setDebugRampPower(float value)

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

Parameters:

value - the next value

getEssCapacityChannel

default IntegerReadChannel getEssCapacityChannel()

Gets the Channel for FixStateOfCharge.ChannelId.ESS_CAPACITY.

Returns:

the Channel

getEssCapacity

default Value<Integer> getEssCapacity()

Gets the Capacity in [Wh]. See FixStateOfCharge.ChannelId.ESS_CAPACITY.

Returns:

the Channel Value

_setEssCapacity

default void _setEssCapacity(Integer value)

Internal method to set the 'nextValue' on FixStateOfCharge.ChannelId.ESS_CAPACITY Channel.

Parameters:

value - the next value

_setEssCapacity

default void _setEssCapacity(int value)

Internal method to set the 'nextValue' on FixStateOfCharge.ChannelId.ESS_CAPACITY Channel.

Parameters:

value - the next value

getAtTargetEpochSecondsChannel

default LongReadChannel getAtTargetEpochSecondsChannel()

Gets the Channel for FixStateOfCharge.ChannelId.AT_TARGET_EPOCH_SECONDS.

Returns:

the Channel

getAtTargetEpochSeconds

default Value<Long> getAtTargetEpochSeconds()

Gets the time when the target SoC was reached as epoch seconds. See FixStateOfCharge.ChannelId.AT_TARGET_EPOCH_SECONDS.

Returns:

the Channel Value

_setAtTargetEpochSeconds

default void _setAtTargetEpochSeconds(Long value)

Internal method to set the 'nextValue' on FixStateOfCharge.ChannelId.AT_TARGET_EPOCH_SECONDS Channel.

Parameters:

value - the next value

_setAtTargetEpochSeconds

default void _setAtTargetEpochSeconds(long value)

Internal method to set the 'nextValue' on FixStateOfCharge.ChannelId.AT_TARGET_EPOCH_SECONDS Channel.

Parameters:

value - the next value

getExpectedStartEpochSecondsChannel

default LongReadChannel getExpectedStartEpochSecondsChannel()

Gets the Channel for FixStateOfCharge.ChannelId.EXPECTED_START_EPOCH_SECONDS.

Returns:

the Channel

getExpectedStartEpochSeconds

default Value<Long> getExpectedStartEpochSeconds()

Gets the time when the controller is expected to charge or discharge the ess. See FixStateOfCharge.ChannelId.EXPECTED_START_EPOCH_SECONDS.

Returns:

the Channel Value

_setExpectedStartEpochSeconds

default void _setExpectedStartEpochSeconds(Long value)

Internal method to set the 'nextValue' on FixStateOfCharge.ChannelId.EXPECTED_START_EPOCH_SECONDS Channel.

Parameters:

value - the next value

_setExpectedStartEpochSeconds

default void _setExpectedStartEpochSeconds(long value)

Internal method to set the 'nextValue' on FixStateOfCharge.ChannelId.EXPECTED_START_EPOCH_SECONDS Channel.

Parameters:

value - the next value

getCtrlIsBlockingEssChannel

default StateChannel getCtrlIsBlockingEssChannel()

Gets the Channel for FixStateOfCharge.ChannelId.CTRL_IS_BLOCKING_ESS.

Returns:

the Channel

getCtrlIsBlockingEss

default Value<Boolean> getCtrlIsBlockingEss()

Gets the State Channel as Boolean Value. See FixStateOfCharge.ChannelId.CTRL_IS_BLOCKING_ESS.

Returns:

the Channel Value

_setCtrlIsBlockingEss

default void _setCtrlIsBlockingEss(boolean value)

Internal method to set the 'nextValue' on FixStateOfCharge.ChannelId.CTRL_IS_BLOCKING_ESS Channel.

Parameters:

value - the next value

getCtrlIsChargingEssChannel

default StateChannel getCtrlIsChargingEssChannel()

Gets the Channel for FixStateOfCharge.ChannelId.CTRL_IS_CHARGING_ESS.

Returns:

the Channel

getCtrlIsChargingEss

default Value<Boolean> getCtrlIsChargingEss()

Gets the State Channel as Boolean Value. See FixStateOfCharge.ChannelId.CTRL_IS_CHARGING_ESS.

Returns:

the Channel Value

_setCtrlIsChargingEss

default void _setCtrlIsChargingEss(boolean value)

Internal method to set the 'nextValue' on FixStateOfCharge.ChannelId.CTRL_IS_CHARGING_ESS Channel.

Parameters:

value - the next value

getCtrlIsDischargingEssChannel

default StateChannel getCtrlIsDischargingEssChannel()

Gets the Channel for FixStateOfCharge.ChannelId.CTRL_IS_DISCHARGING_ESS.

Returns:

the Channel

getCtrlIsDischargingEss

default Value<Boolean> getCtrlIsDischargingEss()

Gets the State Channel as Boolean Value. See FixStateOfCharge.ChannelId.CTRL_IS_DISCHARGING_ESS.

Returns:

the Channel Value

_setCtrlIsDischargingEss

default void _setCtrlIsDischargingEss(boolean value)

Internal method to set the 'nextValue' on FixStateOfCharge.ChannelId.CTRL_IS_DISCHARGING_ESS Channel.

Parameters:

value - the next value

getCtrlWasSelfTerminatedChannel

default StateChannel getCtrlWasSelfTerminatedChannel()

Gets the Channel for FixStateOfCharge.ChannelId.CTRL_WAS_SELF_TERMINATED.

Returns:

the Channel

getCtrlWasSelfTerminated

default Value<Boolean> getCtrlWasSelfTerminated()

Gets the State Channel as Boolean Value. See FixStateOfCharge.ChannelId.CTRL_WAS_SELF_TERMINATED.

Returns:

the Channel Value

_setCtrlWasSelfTerminated

default void _setCtrlWasSelfTerminated(boolean value)

Internal method to set the 'nextValue' on FixStateOfCharge.ChannelId.CTRL_WAS_SELF_TERMINATED Channel.

Parameters:

value - the next value