Package io.openems.edge.batteryinverter.kaco.blueplanetgridsave

Interface KacoBlueplanetGridsave

All Superinterfaces:

ManagedSymmetricBatteryInverter, OpenemsComponent, StartStoppable, SymmetricBatteryInverter

All Known Implementing Classes:

KacoBlueplanetGridsaveImpl

public interface KacoBlueplanetGridsave
extends ManagedSymmetricBatteryInverter, SymmetricBatteryInverter, OpenemsComponent, StartStoppable

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	KacoBlueplanetGridsave.ChannelId

Field Summary

Fields

Modifier and Type	Field	Description
static int	RETRY_COMMAND_MAX_ATTEMPTS	Retry x attempts for set-command.
static int	RETRY_COMMAND_SECONDS	Retry set-command after x Seconds, e.g.
static int	WATCHDOG_TIMEOUT_SECONDS	Sets the KACO watchdog timeout to 60 seconds.
static int	WATCHDOG_TRIGGER_SECONDS	The watchdog gets triggered every WATCHDOG_TRIGGER_CYCLES seconds.

Fields inherited from interface io.openems.edge.batteryinverter.api.SymmetricBatteryInverter

POWER_DOC_TEXT

Method Summary

Modifier and Type	Method	Description
default void	_setMaxStartAttempts(java.lang.Boolean value)	Internal method to set the 'nextValue' on KacoBlueplanetGridsave.ChannelId.MAX_START_ATTEMPTS Channel.
default void	_setMaxStopAttempts(java.lang.Boolean value)	Internal method to set the 'nextValue' on KacoBlueplanetGridsave.ChannelId.MAX_STOP_ATTEMPTS Channel.
KacoSunSpecModel.S64201.S64201CurrentState	getCurrentState()	Gets the Current State.
default Value<java.lang.Boolean>	getMaxStartAttempts()	Gets the StateChannel for KacoBlueplanetGridsave.ChannelId.MAX_START_ATTEMPTS.
default StateChannel	getMaxStartAttemptsChannel()	Gets the Channel for KacoBlueplanetGridsave.ChannelId.MAX_START_ATTEMPTS.
default Value<java.lang.Boolean>	getMaxStopAttempts()	Gets the StateChannel for KacoBlueplanetGridsave.ChannelId.MAX_STOP_ATTEMPTS.
default StateChannel	getMaxStopAttemptsChannel()	Gets the Channel for KacoBlueplanetGridsave.ChannelId.MAX_STOP_ATTEMPTS.
default WriteChannel<KacoSunSpecModel.S64201.S64201RequestedState>	getRequestedStateChannel()	Gets the Channel for KacoSunSpecModel.S64201.REQUESTED_STATE.
StartStop	getStartStopTarget()	Gets the target Start/Stop mode from config or StartStop-Channel.
<T extends Channel<?>> T	getSunSpecChannelOrError(SunSpecPoint point)	Get the Channel for the given Point or throw an error if it is not available.
default void	setRequestedState(KacoSunSpecModel.S64201.S64201RequestedState value)	Writes the value to the KacoSunSpecModel.S64201.REQUESTED_STATE Register.

Methods inherited from interface io.openems.edge.batteryinverter.api.ManagedSymmetricBatteryInverter

getPowerPrecision, getStaticConstraints, isManaged, isOffGridPossible, 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

Methods inherited from interface io.openems.edge.common.startstop.StartStoppable

_setStartStop, getStartStop, getStartStopChannel, isStarted, isStopped, setStartStop, start, stop

Methods inherited from interface io.openems.edge.batteryinverter.api.SymmetricBatteryInverter

_setActiveChargeEnergy, _setActiveChargeEnergy, _setActiveDischargeEnergy, _setActiveDischargeEnergy, _setActivePower, _setActivePower, _setGridMode, _setMaxApparentPower, _setMaxApparentPower, _setReactivePower, _setReactivePower, getActiveChargeEnergy, getActiveChargeEnergyChannel, getActiveDischargeEnergy, getActiveDischargeEnergyChannel, getActivePower, getActivePowerChannel, getGridMode, getGridModeChannel, getMaxApparentPower, getMaxApparentPowerChannel, getReactivePower, getReactivePowerChannel

Field Detail

WATCHDOG_TIMEOUT_SECONDS

static final int WATCHDOG_TIMEOUT_SECONDS

Sets the KACO watchdog timeout to 60 seconds.

See Also:

Constant Field Values

WATCHDOG_TRIGGER_SECONDS

static final int WATCHDOG_TRIGGER_SECONDS

The watchdog gets triggered every WATCHDOG_TRIGGER_CYCLES seconds. This must be less than WATCHDOG_TIMEOUT_SECONDS.

See Also:

Constant Field Values

RETRY_COMMAND_SECONDS

static final int RETRY_COMMAND_SECONDS

Retry set-command after x Seconds, e.g. for starting battery or battery-inverter.

See Also:

Constant Field Values

RETRY_COMMAND_MAX_ATTEMPTS

static final int RETRY_COMMAND_MAX_ATTEMPTS

Retry x attempts for set-command.

See Also:

Constant Field Values

Method Detail

getStartStopTarget

StartStop getStartStopTarget()

Gets the target Start/Stop mode from config or StartStop-Channel.

Returns:

StartStop

getSunSpecChannelOrError

<T extends Channel<?>> T getSunSpecChannelOrError(SunSpecPoint point)
                                           throws OpenemsException

Get the Channel for the given Point or throw an error if it is not available.

Type Parameters:

T - the Channel type

Parameters:

point - the SunSpec Point

Returns:

the optional Channel

Throws:

OpenemsException - if Channel is not available

getCurrentState

KacoSunSpecModel.S64201.S64201CurrentState getCurrentState()

Gets the Current State.

Returns:

the KacoSunSpecModel.S64201.S64201CurrentState

getMaxStartAttemptsChannel

default StateChannel getMaxStartAttemptsChannel()

Gets the Channel for KacoBlueplanetGridsave.ChannelId.MAX_START_ATTEMPTS.

Returns:

the Channel

getMaxStartAttempts

default Value<java.lang.Boolean> getMaxStartAttempts()

Gets the StateChannel for KacoBlueplanetGridsave.ChannelId.MAX_START_ATTEMPTS.

Returns:

the Channel Value

_setMaxStartAttempts

default void _setMaxStartAttempts(java.lang.Boolean value)

Internal method to set the 'nextValue' on KacoBlueplanetGridsave.ChannelId.MAX_START_ATTEMPTS Channel.

Parameters:

value - the next value

getMaxStopAttemptsChannel

default StateChannel getMaxStopAttemptsChannel()

Gets the Channel for KacoBlueplanetGridsave.ChannelId.MAX_STOP_ATTEMPTS.

Returns:

the Channel

getMaxStopAttempts

default Value<java.lang.Boolean> getMaxStopAttempts()

Gets the StateChannel for KacoBlueplanetGridsave.ChannelId.MAX_STOP_ATTEMPTS.

Returns:

the Channel Value

_setMaxStopAttempts

default void _setMaxStopAttempts(java.lang.Boolean value)

Internal method to set the 'nextValue' on KacoBlueplanetGridsave.ChannelId.MAX_STOP_ATTEMPTS Channel.

Parameters:

value - the next value

getRequestedStateChannel

default WriteChannel<KacoSunSpecModel.S64201.S64201RequestedState> getRequestedStateChannel()
                                                                                     throws OpenemsException

Gets the Channel for KacoSunSpecModel.S64201.REQUESTED_STATE.

Returns:

the Channel

Throws:

OpenemsException - on error

setRequestedState

default void setRequestedState(KacoSunSpecModel.S64201.S64201RequestedState value)
                        throws OpenemsError.OpenemsNamedException

Writes the value to the KacoSunSpecModel.S64201.REQUESTED_STATE Register.

Parameters:

value - the next value

Throws:

OpenemsError.OpenemsNamedException - on error