Package io.openems.edge.batteryinverter.api

Interface SymmetricBatteryInverter

All Superinterfaces:

OpenemsComponent

All Known Subinterfaces:

BatteryInverterKacoBlueplanetGridsave, BatteryInverterRefuStore88k, BatteryInverterSinexcel, GoodWeBatteryInverter, HybridManagedSymmetricBatteryInverter, ManagedSymmetricBatteryInverter, OffGridBatteryInverter

All Known Implementing Classes:

AbstractSunSpecBatteryInverter, BatteryInverterKacoBlueplanetGridsaveImpl, BatteryInverterRefuStore88kImpl, BatteryInverterSinexcelImpl, DummyManagedSymmetricBatteryInverter, DummyOffGridBatteryInverter, GoodWeBatteryInverterImpl

@ProviderType
public interface SymmetricBatteryInverter
extends OpenemsComponent

Represents a Symmetric Battery-Inverter.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	SymmetricBatteryInverter.ChannelId

Field Summary

Fields

Modifier and Type	Field	Description
static final String	POWER_DOC_TEXT

Method Summary

Modifier and Type	Method	Description
default void	_setActiveChargeEnergy(long value)	Internal method to set the 'nextValue' on SymmetricBatteryInverter.ChannelId.ACTIVE_CHARGE_ENERGY Channel.
default void	_setActiveChargeEnergy(Long value)	Internal method to set the 'nextValue' on SymmetricBatteryInverter.ChannelId.ACTIVE_CHARGE_ENERGY Channel.
default void	_setActiveDischargeEnergy(long value)	Internal method to set the 'nextValue' on SymmetricBatteryInverter.ChannelId.ACTIVE_DISCHARGE_ENERGY Channel.
default void	_setActiveDischargeEnergy(Long value)	Internal method to set the 'nextValue' on SymmetricBatteryInverter.ChannelId.ACTIVE_DISCHARGE_ENERGY Channel.
default void	_setActivePower(int value)	Internal method to set the 'nextValue' on SymmetricBatteryInverter.ChannelId.ACTIVE_POWER Channel.
default void	_setActivePower(Integer value)	Internal method to set the 'nextValue' on SymmetricBatteryInverter.ChannelId.ACTIVE_POWER Channel.
default void	_setGridMode(GridMode value)	Internal method to set the 'nextValue' on SymmetricBatteryInverter.ChannelId.GRID_MODE Channel.
default void	_setMaxApparentPower(int value)	Internal method to set the 'nextValue' on SymmetricBatteryInverter.ChannelId.MAX_APPARENT_POWER Channel.
default void	_setMaxApparentPower(Integer value)	Internal method to set the 'nextValue' on SymmetricBatteryInverter.ChannelId.MAX_APPARENT_POWER Channel.
default void	_setReactivePower(int value)	Internal method to set the 'nextValue' on SymmetricBatteryInverter.ChannelId.REACTIVE_POWER Channel.
default void	_setReactivePower(Integer value)	Internal method to set the 'nextValue' on SymmetricBatteryInverter.ChannelId.REACTIVE_POWER Channel.
default Value<Long>	getActiveChargeEnergy()	Gets the Active Charge Energy in [Wh_Σ].
default LongReadChannel	getActiveChargeEnergyChannel()	Gets the Channel for SymmetricBatteryInverter.ChannelId.ACTIVE_CHARGE_ENERGY.
default Value<Long>	getActiveDischargeEnergy()	Gets the Active Discharge Energy in [Wh_Σ].
default LongReadChannel	getActiveDischargeEnergyChannel()	Gets the Channel for SymmetricBatteryInverter.ChannelId.ACTIVE_DISCHARGE_ENERGY.
default Value<Integer>	getActivePower()	Gets the Active Power in [W].
default IntegerReadChannel	getActivePowerChannel()	Gets the Channel for SymmetricBatteryInverter.ChannelId.ACTIVE_POWER.
default GridMode	getGridMode()	Is the Battery-Inverter On-Grid? See SymmetricBatteryInverter.ChannelId.GRID_MODE.
default Channel<GridMode>	getGridModeChannel()	Gets the Channel for SymmetricBatteryInverter.ChannelId.GRID_MODE.
default Value<Integer>	getMaxApparentPower()	Gets the Maximum Apparent Power in [VA], range ">= 0".
default IntegerReadChannel	getMaxApparentPowerChannel()	Gets the Channel for SymmetricBatteryInverter.ChannelId.MAX_APPARENT_POWER.
static ModbusSlaveNatureTable	getModbusSlaveNatureTable(AccessMode accessMode)	Used for Modbus/TCP Api Controller.
default Value<Integer>	getReactivePower()	Gets the Reactive Power in [var].
default IntegerReadChannel	getReactivePowerChannel()	Gets the Channel for SymmetricBatteryInverter.ChannelId.REACTIVE_POWER.

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

Field Details

POWER_DOC_TEXT

static final String POWER_DOC_TEXT

See Also:

• Constant Field Values

Method Details

getModbusSlaveNatureTable

static ModbusSlaveNatureTable getModbusSlaveNatureTable(AccessMode accessMode)

Used for Modbus/TCP Api Controller. Provides a Modbus table for the Channels of this Component.

Parameters:

accessMode - filters the Modbus-Records that should be shown

Returns:

the ModbusSlaveNatureTable

getGridModeChannel

default Channel<GridMode> getGridModeChannel()

Gets the Channel for SymmetricBatteryInverter.ChannelId.GRID_MODE.

Returns:

the Channel

getGridMode

default GridMode getGridMode()

Is the Battery-Inverter On-Grid? See SymmetricBatteryInverter.ChannelId.GRID_MODE.

Returns:

the Channel Value

_setGridMode

default void _setGridMode(GridMode value)

Internal method to set the 'nextValue' on SymmetricBatteryInverter.ChannelId.GRID_MODE Channel.

Parameters:

value - the next value

getActivePowerChannel

default IntegerReadChannel getActivePowerChannel()

Gets the Channel for SymmetricBatteryInverter.ChannelId.ACTIVE_POWER.

Returns:

the Channel

getActivePower

default Value<Integer> getActivePower()

Gets the Active Power in [W]. Negative values for Charge; positive for Discharge. See SymmetricBatteryInverter.ChannelId.ACTIVE_POWER.

Returns:

the Channel Value

_setActivePower

default void _setActivePower(Integer value)

Internal method to set the 'nextValue' on SymmetricBatteryInverter.ChannelId.ACTIVE_POWER Channel.

Parameters:

value - the next value

_setActivePower

default void _setActivePower(int value)

Internal method to set the 'nextValue' on SymmetricBatteryInverter.ChannelId.ACTIVE_POWER Channel.

Parameters:

value - the next value

getReactivePowerChannel

default IntegerReadChannel getReactivePowerChannel()

Gets the Channel for SymmetricBatteryInverter.ChannelId.REACTIVE_POWER.

Returns:

the Channel

getReactivePower

default Value<Integer> getReactivePower()

Gets the Reactive Power in [var]. See SymmetricBatteryInverter.ChannelId.REACTIVE_POWER.

Returns:

the Channel Value

_setReactivePower

default void _setReactivePower(Integer value)

Internal method to set the 'nextValue' on SymmetricBatteryInverter.ChannelId.REACTIVE_POWER Channel.

Parameters:

value - the next value

_setReactivePower

default void _setReactivePower(int value)

Internal method to set the 'nextValue' on SymmetricBatteryInverter.ChannelId.REACTIVE_POWER Channel.

Parameters:

value - the next value

getMaxApparentPowerChannel

default IntegerReadChannel getMaxApparentPowerChannel()

Gets the Channel for SymmetricBatteryInverter.ChannelId.MAX_APPARENT_POWER.

Returns:

the Channel

getMaxApparentPower

default Value<Integer> getMaxApparentPower()

Gets the Maximum Apparent Power in [VA], range ">= 0". See SymmetricBatteryInverter.ChannelId.MAX_APPARENT_POWER.

Returns:

the Channel Value

_setMaxApparentPower

default void _setMaxApparentPower(Integer value)

Internal method to set the 'nextValue' on SymmetricBatteryInverter.ChannelId.MAX_APPARENT_POWER Channel.

Parameters:

value - the next value

_setMaxApparentPower

default void _setMaxApparentPower(int value)

Internal method to set the 'nextValue' on SymmetricBatteryInverter.ChannelId.MAX_APPARENT_POWER Channel.

Parameters:

value - the next value

getActiveChargeEnergyChannel

default LongReadChannel getActiveChargeEnergyChannel()

Gets the Channel for SymmetricBatteryInverter.ChannelId.ACTIVE_CHARGE_ENERGY.

Returns:

the Channel

getActiveChargeEnergy

default Value<Long> getActiveChargeEnergy()

Gets the Active Charge Energy in [Wh_Σ]. See SymmetricBatteryInverter.ChannelId.ACTIVE_CHARGE_ENERGY.

Returns:

the Channel Value

_setActiveChargeEnergy

default void _setActiveChargeEnergy(Long value)

Internal method to set the 'nextValue' on SymmetricBatteryInverter.ChannelId.ACTIVE_CHARGE_ENERGY Channel.

Parameters:

value - the next value

_setActiveChargeEnergy

default void _setActiveChargeEnergy(long value)

Internal method to set the 'nextValue' on SymmetricBatteryInverter.ChannelId.ACTIVE_CHARGE_ENERGY Channel.

Parameters:

value - the next value

getActiveDischargeEnergyChannel

default LongReadChannel getActiveDischargeEnergyChannel()

Gets the Channel for SymmetricBatteryInverter.ChannelId.ACTIVE_DISCHARGE_ENERGY.

Returns:

the Channel

getActiveDischargeEnergy

default Value<Long> getActiveDischargeEnergy()

Gets the Active Discharge Energy in [Wh_Σ]. See SymmetricBatteryInverter.ChannelId.ACTIVE_DISCHARGE_ENERGY.

Returns:

the Channel Value

_setActiveDischargeEnergy

default void _setActiveDischargeEnergy(Long value)

Internal method to set the 'nextValue' on SymmetricBatteryInverter.ChannelId.ACTIVE_DISCHARGE_ENERGY Channel.

Parameters:

value - the next value

_setActiveDischargeEnergy

default void _setActiveDischargeEnergy(long value)

Internal method to set the 'nextValue' on SymmetricBatteryInverter.ChannelId.ACTIVE_DISCHARGE_ENERGY Channel.

Parameters:

value - the next value