Package io.openems.edge.batteryinverter.api

Interface OffGridBatteryInverter

All Superinterfaces:

ManagedSymmetricBatteryInverter, OpenemsComponent, StartStoppable, SymmetricBatteryInverter

All Known Subinterfaces:

BatteryInverterSinexcel

All Known Implementing Classes:

BatteryInverterSinexcelImpl, DummyOffGridBatteryInverter

@ProviderType
public interface OffGridBatteryInverter
extends ManagedSymmetricBatteryInverter, SymmetricBatteryInverter, StartStoppable, OpenemsComponent

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	OffGridBatteryInverter.ChannelId
static enum	OffGridBatteryInverter.TargetGridMode

Field Summary

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

POWER_DOC_TEXT

Method Summary

Modifier and Type	Method	Description
default void	_setInverterState(Boolean value)	Internal method to set the 'nextValue' on OffGridBatteryInverter.ChannelId.INVERTER_STATE Channel.
default void	_setOffGridFrequency(int value)	Internal method to set the 'nextValue' on OffGridBatteryInverter.ChannelId.OFF_GRID_FREQUENCY Channel.
default void	_setOffGridFrequency(Integer value)	Internal method to set the 'nextValue' on OffGridBatteryInverter.ChannelId.OFF_GRID_FREQUENCY Channel.
default Value<Boolean>	getInverterState()	Gets the StateChannel for OffGridBatteryInverter.ChannelId.INVERTER_STATE.
default BooleanReadChannel	getInverterStateChannel()	Gets the Channel for OffGridBatteryInverter.ChannelId.INVERTER_STATE.
default Value<Integer>	getOffGridFrequency()	Gets the * OffGridBatteryInverter.ChannelId.OFF_GRID_FREQUENCY.
default IntegerReadChannel	getOffGridFrequencyChannel()	Gets the Channel for invalid reference ChannelId#FREQUENCY .
default IntegerWriteChannel	getSetOffGridFrequencyChannel()	Gets the Channel for OffGridBatteryInverter.ChannelId.OFF_GRID_FREQUENCY.
void	setTargetGridMode(OffGridBatteryInverter.TargetGridMode targetGridMode)	Tells the Battery-Inverter to go to ON_GRID or OFF_GRID mode.
default void	setTargetOffGridFrequency(Integer value)	Sets an Off Grid Frequency set point in [Hz].

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

Method Details

getOffGridFrequencyChannel

default IntegerReadChannel getOffGridFrequencyChannel()

Gets the Channel for

invalid reference

ChannelId#FREQUENCY

.

Returns:

the Channel

getOffGridFrequency

default Value<Integer> getOffGridFrequency()

Gets the * OffGridBatteryInverter.ChannelId.OFF_GRID_FREQUENCY.

Returns:

the Channel Value

_setOffGridFrequency

default void _setOffGridFrequency(Integer value)

Internal method to set the 'nextValue' on OffGridBatteryInverter.ChannelId.OFF_GRID_FREQUENCY Channel.

Parameters:

value - the next value

_setOffGridFrequency

default void _setOffGridFrequency(int value)

Internal method to set the 'nextValue' on OffGridBatteryInverter.ChannelId.OFF_GRID_FREQUENCY Channel.

Parameters:

value - the next value

getSetOffGridFrequencyChannel

default IntegerWriteChannel getSetOffGridFrequencyChannel()

Gets the Channel for OffGridBatteryInverter.ChannelId.OFF_GRID_FREQUENCY.

Returns:

the Channel

setTargetOffGridFrequency

default void setTargetOffGridFrequency(Integer value)
                                throws OpenemsError.OpenemsNamedException

Sets an Off Grid Frequency set point in [Hz]. See

invalid reference

ChannelId#SET_ACTIVE_POWER_EQUALS

.

Parameters:

value - the next write value

Throws:

OpenemsError.OpenemsNamedException - on error

getInverterStateChannel

default BooleanReadChannel getInverterStateChannel()

Gets the Channel for OffGridBatteryInverter.ChannelId.INVERTER_STATE.

Returns:

the Channel

getInverterState

default Value<Boolean> getInverterState()

Gets the StateChannel for OffGridBatteryInverter.ChannelId.INVERTER_STATE.

Returns:

the Channel Value

_setInverterState

default void _setInverterState(Boolean value)

Internal method to set the 'nextValue' on OffGridBatteryInverter.ChannelId.INVERTER_STATE Channel.

Parameters:

value - the next value

setTargetGridMode

void setTargetGridMode(OffGridBatteryInverter.TargetGridMode targetGridMode)

Tells the Battery-Inverter to go to ON_GRID or OFF_GRID mode. Be sure to call this method before you call StartStoppable.start().

Parameters:

targetGridMode - the OffGridBatteryInverter.TargetGridMode