Interface ManagedSymmetricBatteryInverter
- All Superinterfaces:
OpenemsComponent
,StartStoppable
,SymmetricBatteryInverter
- All Known Subinterfaces:
BatteryInverterKacoBlueplanetGridsave
,BatteryInverterRefuStore88k
,BatteryInverterSinexcel
,GoodWeBatteryInverter
,HybridManagedSymmetricBatteryInverter
,OffGridBatteryInverter
- All Known Implementing Classes:
AbstractSunSpecBatteryInverter
,BatteryInverterKacoBlueplanetGridsaveImpl
,BatteryInverterRefuStore88kImpl
,BatteryInverterSinexcelImpl
,DummyManagedSymmetricBatteryInverter
,DummyOffGridBatteryInverter
,GoodWeBatteryInverterImpl
@ProviderType
public interface ManagedSymmetricBatteryInverter
extends SymmetricBatteryInverter, StartStoppable
Represents a Symmetric Battery-Inverter that can be controlled.
To indicate, that the Battery-Inverter is ready for charging/discharging, the following Channels need to be set:
- StartStoppable.ChannelId.START_STOP must be set to 'START'
- No 'Fault'-StateChannels are set (i.e. 'OpenemsComponent.ChannelId.STATE' is invalid input: '<' 3)
-
Nested Class Summary
-
Field Summary
Fields inherited from interface io.openems.edge.batteryinverter.api.SymmetricBatteryInverter
POWER_DOC_TEXT
-
Method Summary
Modifier and TypeMethodDescriptionstatic ModbusSlaveNatureTable
getModbusSlaveNatureTable
(AccessMode accessMode) Used for Modbus/TCP Api Controller.int
Gets the smallest positive power that can be set (in W, VA or var).default BatteryInverterConstraint[]
Gets static Constraints for this Battery-Inverter.default boolean
Gets a boolean if the battery inverter is managed or not.default boolean
Gets a boolean if the battery inverter is able to build a micro-grid in off-grid.void
Run the Battery-Inverter.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
-
getModbusSlaveNatureTable
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
-
run
void run(Battery battery, int setActivePower, int setReactivePower) throws OpenemsError.OpenemsNamedException Run the Battery-Inverter.- bring the Battery-Inverter in the desired state
- apply information from
Battery
as required - set the target Active and Reactive Power.
This is called on ManagedSymmetricEss::applyPower()
- Parameters:
battery
- theBattery
setActivePower
- the active power setpointsetReactivePower
- the reactive power setpoint- Throws:
OpenemsError.OpenemsNamedException
- on error
-
getStaticConstraints
default BatteryInverterConstraint[] getStaticConstraints() throws OpenemsError.OpenemsNamedExceptionGets static Constraints for this Battery-Inverter. Override this method to provide specific Constraints for this Battery-Inverter on every Cycle.- Returns:
- the Constraints
- Throws:
OpenemsException
- on errorOpenemsError.OpenemsNamedException
-
getPowerPrecision
int getPowerPrecision()Gets the smallest positive power that can be set (in W, VA or var). Example:- FENECON Commercial 40 allows setting of power in 100 W steps. It should return 100.
- KACO blueplanet gridsave 50 allows setting of power in 0.1 % of 52 VA. It should return 52 (= 52000 * 0.001)
- Returns:
- the power precision
-
isManaged
default boolean isManaged()Gets a boolean if the battery inverter is managed or not.Returns false if the battery inverter itself is not managed or in a read only mode.
- Returns:
- is managed or not
-
isOffGridPossible
default boolean isOffGridPossible()Gets a boolean if the battery inverter is able to build a micro-grid in off-grid.Returns false if the battery inverter is not able to build a micro-grid.
- Returns:
- is managed or not
-