Package io.openems.edge.ess.api
Interface SymmetricEss
- All Superinterfaces:
OpenemsComponent
- All Known Subinterfaces:
AsymmetricEss
,BoschBpts5HybridEss
,EssCluster
,EssFeneconBydContainer
,EssFeneconCommercial40
,EssGenericManagedSymmetric
,EssGenericOffGrid
,EssSmaSunnyIsland
,FeneconDessEss
,FeneconMiniEss
,FeneconProEss
,GenericManagedEss
,GoodWeEss
,HybridEss
,KostalPikoEss
,ManagedAsymmetricEss
,ManagedSinglePhaseEss
,ManagedSymmetricEss
,MetaEss
,MrGridconOngrid
,MrGridconOnOffgrid
,OffGridEss
,SamsungEss
,SimulatorEssAsymmetricReacting
,SimulatorEssSinglePhaseReacting
,SimulatorEssSymmetricReacting
,SinglePhaseEss
,TeslaPowerwall2Battery
- All Known Implementing Classes:
AbstractDummyManagedSymmetricEss
,AbstractDummySymmetricEss
,AbstractGenericManagedEss
,BoschBpts5HybridEssImpl
,DummyHybridEss
,DummyManagedAsymmetricEss
,DummyManagedSymmetricEss
,DummyMetaEss
,DummySymmetricEss
,Edge2EdgeEssImpl
,EssAdstecStoraxeImpl
,EssClusterImpl
,EssFeneconBydContainerImpl
,EssFeneconCommercial40Impl
,EssGenericManagedSymmetricImpl
,EssGenericOffGridImpl
,EssGridcon
,EssSmaSunnyIslandImpl
,FeneconDessEssImpl
,FeneconMiniEssImpl
,FeneconProEssImpl
,GoodWeEssImpl
,KacoBlueplanetHybrid10EssImpl
,KostalPikoEssImpl
,MrGridconOngridImpl
,MrGridconOnOffgridImpl
,SamsungEssImpl
,SimulatorEssAsymmetricReactingImpl
,SimulatorEssSinglePhaseReactingImpl
,SimulatorEssSymmetricReactingImpl
,TeslaPowerwall2BatteryImpl
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptiondefault void
_setActiveChargeEnergy
(long value) Internal method to set the 'nextValue' onSymmetricEss.ChannelId.ACTIVE_CHARGE_ENERGY
Channel.default void
_setActiveChargeEnergy
(Long value) Internal method to set the 'nextValue' onSymmetricEss.ChannelId.ACTIVE_CHARGE_ENERGY
Channel.default void
_setActiveDischargeEnergy
(long value) Internal method to set the 'nextValue' onSymmetricEss.ChannelId.ACTIVE_DISCHARGE_ENERGY
Channel.default void
_setActiveDischargeEnergy
(Long value) Internal method to set the 'nextValue' onSymmetricEss.ChannelId.ACTIVE_DISCHARGE_ENERGY
Channel.default void
_setActivePower
(int value) Internal method to set the 'nextValue' onSymmetricEss.ChannelId.ACTIVE_POWER
Channel.default void
_setActivePower
(Integer value) Internal method to set the 'nextValue' onSymmetricEss.ChannelId.ACTIVE_POWER
Channel.default void
_setCapacity
(int value) Internal method to set the 'nextValue' onSymmetricEss.ChannelId.CAPACITY
Channel.default void
_setCapacity
(Integer value) Internal method to set the 'nextValue' onSymmetricEss.ChannelId.CAPACITY
Channel.default void
_setGridMode
(GridMode value) Internal method to set the 'nextValue' onSymmetricEss.ChannelId.GRID_MODE
Channel.default void
_setMaxApparentPower
(int value) Internal method to set the 'nextValue' onSymmetricEss.ChannelId.MAX_APPARENT_POWER
Channel.default void
_setMaxApparentPower
(Integer value) Internal method to set the 'nextValue' onSymmetricEss.ChannelId.MAX_APPARENT_POWER
Channel.default void
_setMaxCellTemperature
(int value) Internal method to set the 'nextValue' onSymmetricEss.ChannelId.MAX_CELL_TEMPERATURE
Channel.default void
_setMaxCellTemperature
(Integer value) Internal method to set the 'nextValue' onSymmetricEss.ChannelId.MAX_CELL_TEMPERATURE
Channel.default void
_setMaxCellVoltage
(int value) Internal method to set the 'nextValue' onSymmetricEss.ChannelId.MAX_CELL_VOLTAGE
Channel.default void
_setMaxCellVoltage
(Integer value) Internal method to set the 'nextValue' onSymmetricEss.ChannelId.MAX_CELL_VOLTAGE
Channel.default void
_setMinCellTemperature
(int value) Internal method to set the 'nextValue' onSymmetricEss.ChannelId.MIN_CELL_TEMPERATURE
Channel.default void
_setMinCellTemperature
(Integer value) Internal method to set the 'nextValue' onSymmetricEss.ChannelId.MIN_CELL_TEMPERATURE
Channel.default void
_setMinCellVoltage
(int value) Internal method to set the 'nextValue' onSymmetricEss.ChannelId.MIN_CELL_VOLTAGE
Channel.default void
_setMinCellVoltage
(Integer value) Internal method to set the 'nextValue' onSymmetricEss.ChannelId.MIN_CELL_VOLTAGE
Channel.default void
_setReactivePower
(int value) Internal method to set the 'nextValue' onSymmetricEss.ChannelId.REACTIVE_POWER
Channel.default void
_setReactivePower
(Integer value) Internal method to set the 'nextValue' onSymmetricEss.ChannelId.REACTIVE_POWER
Channel.default void
_setSoc
(int value) Internal method to set the 'nextValue' onSymmetricEss.ChannelId.SOC
Channel.default void
Internal method to set the 'nextValue' onSymmetricEss.ChannelId.SOC
Channel.Gets the Active Charge Energy in [Wh_Σ].default LongReadChannel
Gets the Channel forSymmetricEss.ChannelId.ACTIVE_CHARGE_ENERGY
.Gets the Active Discharge Energy in [Wh_Σ].default LongReadChannel
Gets the Channel forSymmetricEss.ChannelId.ACTIVE_DISCHARGE_ENERGY
.Gets the Active Power in [W].default IntegerReadChannel
Gets the Channel forSymmetricEss.ChannelId.ACTIVE_POWER
.Gets the Capacity in [Wh].default IntegerReadChannel
Gets the Channel forSymmetricEss.ChannelId.CAPACITY
.default GridMode
Is the Energy Storage System On-Grid? SeeSymmetricEss.ChannelId.GRID_MODE
.Gets the Channel forSymmetricEss.ChannelId.GRID_MODE
.Gets the Maximum Apparent Power in [VA], range ">= 0".default IntegerReadChannel
Gets the Channel forSymmetricEss.ChannelId.MAX_APPARENT_POWER
.Gets the Maximum Cell Temperature in [degC].default IntegerReadChannel
Gets the Channel forSymmetricEss.ChannelId.MAX_CELL_TEMPERATURE
.Gets the Maximum Cell Voltage in [mV].default IntegerReadChannel
Gets the Channel forSymmetricEss.ChannelId.MAX_CELL_VOLTAGE
.Gets the Minimal Cell Temperature in [degC].default IntegerReadChannel
Gets the Channel forSymmetricEss.ChannelId.MIN_CELL_TEMPERATURE
.Gets the Minimum Cell Voltage in [mV].default IntegerReadChannel
Gets the Channel forSymmetricEss.ChannelId.MIN_CELL_VOLTAGE
.static ModbusSlaveNatureTable
getModbusSlaveNatureTable
(AccessMode accessMode) Used for Modbus/TCP Api Controller.Gets the Reactive Power in [var].default IntegerReadChannel
Gets the Channel forSymmetricEss.ChannelId.REACTIVE_POWER
.getSoc()
Gets the State of Charge in [%], range 0..100 %.default IntegerReadChannel
Gets the Channel forSymmetricEss.ChannelId.SOC
.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
-
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
-
getSocChannel
Gets the Channel forSymmetricEss.ChannelId.SOC
.- Returns:
- the Channel
-
getSoc
Gets the State of Charge in [%], range 0..100 %. SeeSymmetricEss.ChannelId.SOC
.- Returns:
- the Channel
Value
-
_setSoc
Internal method to set the 'nextValue' onSymmetricEss.ChannelId.SOC
Channel.- Parameters:
value
- the next value
-
_setSoc
default void _setSoc(int value) Internal method to set the 'nextValue' onSymmetricEss.ChannelId.SOC
Channel.- Parameters:
value
- the next value
-
getCapacityChannel
Gets the Channel forSymmetricEss.ChannelId.CAPACITY
.- Returns:
- the Channel
-
getCapacity
Gets the Capacity in [Wh]. SeeSymmetricEss.ChannelId.CAPACITY
.- Returns:
- the Channel
Value
-
_setCapacity
Internal method to set the 'nextValue' onSymmetricEss.ChannelId.CAPACITY
Channel.- Parameters:
value
- the next value
-
_setCapacity
default void _setCapacity(int value) Internal method to set the 'nextValue' onSymmetricEss.ChannelId.CAPACITY
Channel.- Parameters:
value
- the next value
-
getGridModeChannel
Gets the Channel forSymmetricEss.ChannelId.GRID_MODE
.- Returns:
- the Channel
-
getGridMode
Is the Energy Storage System On-Grid? SeeSymmetricEss.ChannelId.GRID_MODE
.- Returns:
- the Channel
Value
-
_setGridMode
Internal method to set the 'nextValue' onSymmetricEss.ChannelId.GRID_MODE
Channel.- Parameters:
value
- the next value
-
getActivePowerChannel
Gets the Channel forSymmetricEss.ChannelId.ACTIVE_POWER
.- Returns:
- the Channel
-
getActivePower
Gets the Active Power in [W]. Negative values for Charge; positive for Discharge. SeeSymmetricEss.ChannelId.ACTIVE_POWER
.- Returns:
- the Channel
Value
-
_setActivePower
Internal method to set the 'nextValue' onSymmetricEss.ChannelId.ACTIVE_POWER
Channel.- Parameters:
value
- the next value
-
_setActivePower
default void _setActivePower(int value) Internal method to set the 'nextValue' onSymmetricEss.ChannelId.ACTIVE_POWER
Channel.- Parameters:
value
- the next value
-
getReactivePowerChannel
Gets the Channel forSymmetricEss.ChannelId.REACTIVE_POWER
.- Returns:
- the Channel
-
getReactivePower
Gets the Reactive Power in [var]. SeeSymmetricEss.ChannelId.REACTIVE_POWER
.- Returns:
- the Channel
Value
-
_setReactivePower
Internal method to set the 'nextValue' onSymmetricEss.ChannelId.REACTIVE_POWER
Channel.- Parameters:
value
- the next value
-
_setReactivePower
default void _setReactivePower(int value) Internal method to set the 'nextValue' onSymmetricEss.ChannelId.REACTIVE_POWER
Channel.- Parameters:
value
- the next value
-
getMaxApparentPowerChannel
Gets the Channel forSymmetricEss.ChannelId.MAX_APPARENT_POWER
.- Returns:
- the Channel
-
getMaxApparentPower
Gets the Maximum Apparent Power in [VA], range ">= 0". SeeSymmetricEss.ChannelId.MAX_APPARENT_POWER
.- Returns:
- the Channel
Value
-
_setMaxApparentPower
Internal method to set the 'nextValue' onSymmetricEss.ChannelId.MAX_APPARENT_POWER
Channel.- Parameters:
value
- the next value
-
_setMaxApparentPower
default void _setMaxApparentPower(int value) Internal method to set the 'nextValue' onSymmetricEss.ChannelId.MAX_APPARENT_POWER
Channel.- Parameters:
value
- the next value
-
getActiveChargeEnergyChannel
Gets the Channel forSymmetricEss.ChannelId.ACTIVE_CHARGE_ENERGY
.- Returns:
- the Channel
-
getActiveChargeEnergy
Gets the Active Charge Energy in [Wh_Σ]. SeeSymmetricEss.ChannelId.ACTIVE_CHARGE_ENERGY
.- Returns:
- the Channel
Value
-
_setActiveChargeEnergy
Internal method to set the 'nextValue' onSymmetricEss.ChannelId.ACTIVE_CHARGE_ENERGY
Channel.- Parameters:
value
- the next value
-
_setActiveChargeEnergy
default void _setActiveChargeEnergy(long value) Internal method to set the 'nextValue' onSymmetricEss.ChannelId.ACTIVE_CHARGE_ENERGY
Channel.- Parameters:
value
- the next value
-
getActiveDischargeEnergyChannel
Gets the Channel forSymmetricEss.ChannelId.ACTIVE_DISCHARGE_ENERGY
.- Returns:
- the Channel
-
getActiveDischargeEnergy
Gets the Active Discharge Energy in [Wh_Σ]. SeeSymmetricEss.ChannelId.ACTIVE_DISCHARGE_ENERGY
.- Returns:
- the Channel
Value
-
_setActiveDischargeEnergy
Internal method to set the 'nextValue' onSymmetricEss.ChannelId.ACTIVE_DISCHARGE_ENERGY
Channel.- Parameters:
value
- the next value
-
_setActiveDischargeEnergy
default void _setActiveDischargeEnergy(long value) Internal method to set the 'nextValue' onSymmetricEss.ChannelId.ACTIVE_DISCHARGE_ENERGY
Channel.- Parameters:
value
- the next value
-
getMinCellVoltageChannel
Gets the Channel forSymmetricEss.ChannelId.MIN_CELL_VOLTAGE
.- Returns:
- the Channel
-
getMinCellVoltage
Gets the Minimum Cell Voltage in [mV]. SeeSymmetricEss.ChannelId.MIN_CELL_VOLTAGE
.- Returns:
- the Channel
Value
-
_setMinCellVoltage
Internal method to set the 'nextValue' onSymmetricEss.ChannelId.MIN_CELL_VOLTAGE
Channel.- Parameters:
value
- the next value
-
_setMinCellVoltage
default void _setMinCellVoltage(int value) Internal method to set the 'nextValue' onSymmetricEss.ChannelId.MIN_CELL_VOLTAGE
Channel.- Parameters:
value
- the next value
-
getMaxCellVoltageChannel
Gets the Channel forSymmetricEss.ChannelId.MAX_CELL_VOLTAGE
.- Returns:
- the Channel
-
getMaxCellVoltage
Gets the Maximum Cell Voltage in [mV]. SeeSymmetricEss.ChannelId.MAX_CELL_VOLTAGE
.- Returns:
- the Channel
Value
-
_setMaxCellVoltage
Internal method to set the 'nextValue' onSymmetricEss.ChannelId.MAX_CELL_VOLTAGE
Channel.- Parameters:
value
- the next value
-
_setMaxCellVoltage
default void _setMaxCellVoltage(int value) Internal method to set the 'nextValue' onSymmetricEss.ChannelId.MAX_CELL_VOLTAGE
Channel.- Parameters:
value
- the next value
-
getMinCellTemperatureChannel
Gets the Channel forSymmetricEss.ChannelId.MIN_CELL_TEMPERATURE
.- Returns:
- the Channel
-
getMinCellTemperature
Gets the Minimal Cell Temperature in [degC]. SeeSymmetricEss.ChannelId.MIN_CELL_TEMPERATURE
.- Returns:
- the Channel
Value
-
_setMinCellTemperature
Internal method to set the 'nextValue' onSymmetricEss.ChannelId.MIN_CELL_TEMPERATURE
Channel.- Parameters:
value
- the next value
-
_setMinCellTemperature
default void _setMinCellTemperature(int value) Internal method to set the 'nextValue' onSymmetricEss.ChannelId.MIN_CELL_TEMPERATURE
Channel.- Parameters:
value
- the next value
-
getMaxCellTemperatureChannel
Gets the Channel forSymmetricEss.ChannelId.MAX_CELL_TEMPERATURE
.- Returns:
- the Channel
-
getMaxCellTemperature
Gets the Maximum Cell Temperature in [degC]. SeeSymmetricEss.ChannelId.MAX_CELL_TEMPERATURE
.- Returns:
- the Channel
Value
-
_setMaxCellTemperature
Internal method to set the 'nextValue' onSymmetricEss.ChannelId.MAX_CELL_TEMPERATURE
Channel.- Parameters:
value
- the next value
-
_setMaxCellTemperature
default void _setMaxCellTemperature(int value) Internal method to set the 'nextValue' onSymmetricEss.ChannelId.MAX_CELL_TEMPERATURE
Channel.- Parameters:
value
- the next value
-