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

Interface BatteryInverterKacoBlueplanetGridsave

All Superinterfaces:

ManagedSymmetricBatteryInverter, ModbusComponent, OpenemsComponent, StartStoppable, SymmetricBatteryInverter

All Known Implementing Classes:

BatteryInverterKacoBlueplanetGridsaveImpl

public interface BatteryInverterKacoBlueplanetGridsave
extends ManagedSymmetricBatteryInverter, SymmetricBatteryInverter, ModbusComponent, OpenemsComponent, StartStoppable

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	BatteryInverterKacoBlueplanetGridsave.ChannelId

Field Summary

Fields

Modifier and Type	Field	Description
static final int	WATCHDOG_TIMEOUT_SECONDS	Sets the KACO watchdog timeout to 60 seconds.
static final 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	_setGridDisconnection(boolean value)	Writes the value to the ChannelId.GRID_DISCONNECTION.
default void	_setInverterCurrentStateFault(boolean value)	Writes the value to the ChannelId.INVERTER_CURRENT_STATE_FAULT.
default void	_setMaxStartTimeout(boolean value)	Internal method to set the 'nextValue' on BatteryInverterKacoBlueplanetGridsave.ChannelId.MAX_START_TIMEOUT Channel.
default void	_setMaxStopTimeout(boolean value)	Internal method to set the 'nextValue' on BatteryInverterKacoBlueplanetGridsave.ChannelId.MAX_STOP_TIMEOUT Channel.
default void	_setRunFailed(boolean value)	Writes the value to the ChannelId.RUN_FAILED.
KacoSunSpecModel.S64201.S64201CurrentState	getCurrentState()	Gets the Current State.
default Channel<Boolean>	getGridDisconnectionChannel()	Gets the Channel for ChannelId.GRID_DISCONNECTION.
default Channel<Boolean>	getInverterCurrentStateFaultChannel()	Gets the Channel for ChannelId.INVERTER_CURRENT_STATE_FAULT.
default Value<Boolean>	getMaxStartTimeout()	Gets the StateChannel for BatteryInverterKacoBlueplanetGridsave.ChannelId.MAX_START_TIMEOUT.
default StateChannel	getMaxStartTimeoutChannel()	Gets the Channel for BatteryInverterKacoBlueplanetGridsave.ChannelId.MAX_START_TIMEOUT.
default Value<Boolean>	getMaxStopTimeout()	Gets the StateChannel for BatteryInverterKacoBlueplanetGridsave.ChannelId.MAX_STOP_TIMEOUT.
default StateChannel	getMaxStopTimeoutChannel()	Gets the Channel for BatteryInverterKacoBlueplanetGridsave.ChannelId.MAX_STOP_TIMEOUT.
default WriteChannel<KacoSunSpecModel.S64201.S64201RequestedState>	getRequestedStateChannel()	Gets the Channel for KacoSunSpecModel.S64201.REQUESTED_STATE.
default Channel<Boolean>	getRunFailedChannel()	Gets the Channel for ChannelId.RUN_FAILED.
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.
boolean	hasFailure()	Checks if the system is in a fault state.
boolean	isRunning()	Checks if the system is in a running state.
boolean	isShutdown()	Checks if the system is in a stop state.
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.bridge.modbus.api.ModbusComponent

_setModbusCommunicationFailed, getModbusCommunicationFailed, getModbusCommunicationFailedChannel, retryModbusCommunication

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, _setDcMaxVoltage, _setDcMaxVoltage, _setDcMinVoltage, _setDcMinVoltage, _setGridMode, _setMaxApparentPower, _setMaxApparentPower, _setReactivePower, _setReactivePower, getActiveChargeEnergy, getActiveChargeEnergyChannel, getActiveDischargeEnergy, getActiveDischargeEnergyChannel, getActivePower, getActivePowerChannel, getDcMaxVoltage, getDcMaxVoltageChannel, getDcMinVoltage, getDcMinVoltageChannel, getGridMode, getGridModeChannel, getMaxApparentPower, getMaxApparentPowerChannel, getReactivePower, getReactivePowerChannel

Field Details

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

Method Details

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

getMaxStartTimeoutChannel

default StateChannel getMaxStartTimeoutChannel()

Gets the Channel for BatteryInverterKacoBlueplanetGridsave.ChannelId.MAX_START_TIMEOUT.

Returns:

the Channel

getMaxStartTimeout

default Value<Boolean> getMaxStartTimeout()

Gets the StateChannel for BatteryInverterKacoBlueplanetGridsave.ChannelId.MAX_START_TIMEOUT.

Returns:

the Channel Value

_setMaxStartTimeout

default void _setMaxStartTimeout(boolean value)

Internal method to set the 'nextValue' on BatteryInverterKacoBlueplanetGridsave.ChannelId.MAX_START_TIMEOUT Channel.

Parameters:

value - the next value

getMaxStopTimeoutChannel

default StateChannel getMaxStopTimeoutChannel()

Gets the Channel for BatteryInverterKacoBlueplanetGridsave.ChannelId.MAX_STOP_TIMEOUT.

Returns:

the Channel

getMaxStopTimeout

default Value<Boolean> getMaxStopTimeout()

Gets the StateChannel for BatteryInverterKacoBlueplanetGridsave.ChannelId.MAX_STOP_TIMEOUT.

Returns:

the Channel Value

_setMaxStopTimeout

default void _setMaxStopTimeout(boolean value)

Internal method to set the 'nextValue' on BatteryInverterKacoBlueplanetGridsave.ChannelId.MAX_STOP_TIMEOUT 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

getInverterCurrentStateFaultChannel

default Channel<Boolean> getInverterCurrentStateFaultChannel()

Gets the Channel for ChannelId.INVERTER_CURRENT_STATE_FAULT.

Returns:

the Channel

_setInverterCurrentStateFault

default void _setInverterCurrentStateFault(boolean value)

Writes the value to the ChannelId.INVERTER_CURRENT_STATE_FAULT.

Parameters:

value - the next value

getRunFailedChannel

default Channel<Boolean> getRunFailedChannel()

Gets the Channel for ChannelId.RUN_FAILED.

Returns:

the Channel

_setRunFailed

default void _setRunFailed(boolean value)

Writes the value to the ChannelId.RUN_FAILED.

Parameters:

value - the next value

getGridDisconnectionChannel

default Channel<Boolean> getGridDisconnectionChannel()

Gets the Channel for ChannelId.GRID_DISCONNECTION.

Returns:

the Channel

_setGridDisconnection

default void _setGridDisconnection(boolean value)

Writes the value to the ChannelId.GRID_DISCONNECTION.

Parameters:

value - the next value

isRunning

boolean isRunning()

Checks if the system is in a running state. This method retrieves the system's global state and determines whether the system is in a running state.

Returns:

true if the system is in a running state, false otherwise.

isShutdown

boolean isShutdown()

Checks if the system is in a stop state. This method retrieves the system's global state and determines whether the system is in a stop state.

Returns:

true if the system is in a stop state, false otherwise.

hasFailure

boolean hasFailure()

Checks if the system is in a fault state. This method retrieves the system's global state and determines whether the system is in a fault state.

Returns:

true if the system is in a fault state, false otherwise.