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, SimulatorEssAsymmetricReacting, SimulatorEssSinglePhaseReacting, SimulatorEssSymmetricReacting, SinglePhaseEss, TeslaPowerwall2Battery

All Known Implementing Classes:

AbstractGenericManagedEss, BoschBpts5HybridEssImpl, DummyHybridEss, DummyManagedAsymmetricEss, DummyManagedSymmetricEss, DummyMetaEss, Edge2EdgeEssImpl, EssAdstecStoraxeImpl, EssClusterImpl, EssFeneconBydContainerImpl, EssFeneconCommercial40Impl, EssGenericManagedSymmetricImpl, EssGenericOffGridImpl, EssGridcon, EssSmaSunnyIslandImpl, FeneconDessEssImpl, FeneconMiniEssImpl, FeneconProEssImpl, GoodWeEssImpl, KacoBlueplanetHybrid10EssImpl, KostalPikoEssImpl, MrGridconOngridImpl, MrGridconOnOffgridImpl, SimulatorEssAsymmetricReactingImpl, SimulatorEssSinglePhaseReactingImpl, SimulatorEssSymmetricReactingImpl, TeslaPowerwall2BatteryImpl

@ProviderType
public interface SymmetricEss
extends OpenemsComponent

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	SymmetricEss.ChannelId

Method Summary

Modifier and Type	Method	Description
default void	_setActiveChargeEnergy(long value)	Internal method to set the 'nextValue' on SymmetricEss.ChannelId.ACTIVE_CHARGE_ENERGY Channel.
default void	_setActiveChargeEnergy(Long value)	Internal method to set the 'nextValue' on SymmetricEss.ChannelId.ACTIVE_CHARGE_ENERGY Channel.
default void	_setActiveDischargeEnergy(long value)	Internal method to set the 'nextValue' on SymmetricEss.ChannelId.ACTIVE_DISCHARGE_ENERGY Channel.
default void	_setActiveDischargeEnergy(Long value)	Internal method to set the 'nextValue' on SymmetricEss.ChannelId.ACTIVE_DISCHARGE_ENERGY Channel.
default void	_setActivePower(int value)	Internal method to set the 'nextValue' on SymmetricEss.ChannelId.ACTIVE_POWER Channel.
default void	_setActivePower(Integer value)	Internal method to set the 'nextValue' on SymmetricEss.ChannelId.ACTIVE_POWER Channel.
default void	_setCapacity(int value)	Internal method to set the 'nextValue' on SymmetricEss.ChannelId.CAPACITY Channel.
default void	_setCapacity(Integer value)	Internal method to set the 'nextValue' on SymmetricEss.ChannelId.CAPACITY Channel.
default void	_setGridMode(GridMode value)	Internal method to set the 'nextValue' on SymmetricEss.ChannelId.GRID_MODE Channel.
default void	_setMaxApparentPower(int value)	Internal method to set the 'nextValue' on SymmetricEss.ChannelId.MAX_APPARENT_POWER Channel.
default void	_setMaxApparentPower(Integer value)	Internal method to set the 'nextValue' on SymmetricEss.ChannelId.MAX_APPARENT_POWER Channel.
default void	_setMaxCellTemperature(int value)	Internal method to set the 'nextValue' on SymmetricEss.ChannelId.MAX_CELL_TEMPERATURE Channel.
default void	_setMaxCellTemperature(Integer value)	Internal method to set the 'nextValue' on SymmetricEss.ChannelId.MAX_CELL_TEMPERATURE Channel.
default void	_setMaxCellVoltage(int value)	Internal method to set the 'nextValue' on SymmetricEss.ChannelId.MAX_CELL_VOLTAGE Channel.
default void	_setMaxCellVoltage(Integer value)	Internal method to set the 'nextValue' on SymmetricEss.ChannelId.MAX_CELL_VOLTAGE Channel.
default void	_setMinCellTemperature(int value)	Internal method to set the 'nextValue' on SymmetricEss.ChannelId.MIN_CELL_TEMPERATURE Channel.
default void	_setMinCellTemperature(Integer value)	Internal method to set the 'nextValue' on SymmetricEss.ChannelId.MIN_CELL_TEMPERATURE Channel.
default void	_setMinCellVoltage(int value)	Internal method to set the 'nextValue' on SymmetricEss.ChannelId.MIN_CELL_VOLTAGE Channel.
default void	_setMinCellVoltage(Integer value)	Internal method to set the 'nextValue' on SymmetricEss.ChannelId.MIN_CELL_VOLTAGE Channel.
default void	_setReactivePower(int value)	Internal method to set the 'nextValue' on SymmetricEss.ChannelId.REACTIVE_POWER Channel.
default void	_setReactivePower(Integer value)	Internal method to set the 'nextValue' on SymmetricEss.ChannelId.REACTIVE_POWER Channel.
default void	_setSoc(int value)	Internal method to set the 'nextValue' on SymmetricEss.ChannelId.SOC Channel.
default void	_setSoc(Integer value)	Internal method to set the 'nextValue' on SymmetricEss.ChannelId.SOC Channel.
default Value<Long>	getActiveChargeEnergy()	Gets the Active Charge Energy in [Wh_Σ].
default LongReadChannel	getActiveChargeEnergyChannel()	Gets the Channel for SymmetricEss.ChannelId.ACTIVE_CHARGE_ENERGY.
default Value<Long>	getActiveDischargeEnergy()	Gets the Active Discharge Energy in [Wh_Σ].
default LongReadChannel	getActiveDischargeEnergyChannel()	Gets the Channel for SymmetricEss.ChannelId.ACTIVE_DISCHARGE_ENERGY.
default Value<Integer>	getActivePower()	Gets the Active Power in [W].
default IntegerReadChannel	getActivePowerChannel()	Gets the Channel for SymmetricEss.ChannelId.ACTIVE_POWER.
default Value<Integer>	getCapacity()	Gets the Capacity in [Wh].
default IntegerReadChannel	getCapacityChannel()	Gets the Channel for SymmetricEss.ChannelId.CAPACITY.
default GridMode	getGridMode()	Is the Energy Storage System On-Grid? See SymmetricEss.ChannelId.GRID_MODE.
default Channel<GridMode>	getGridModeChannel()	Gets the Channel for SymmetricEss.ChannelId.GRID_MODE.
default Value<Integer>	getMaxApparentPower()	Gets the Maximum Apparent Power in [VA], range ">= 0".
default IntegerReadChannel	getMaxApparentPowerChannel()	Gets the Channel for SymmetricEss.ChannelId.MAX_APPARENT_POWER.
default Value<Integer>	getMaxCellTemperature()	Gets the Maximum Cell Temperature in [degC].
default IntegerReadChannel	getMaxCellTemperatureChannel()	Gets the Channel for SymmetricEss.ChannelId.MAX_CELL_TEMPERATURE.
default Value<Integer>	getMaxCellVoltage()	Gets the Maximum Cell Voltage in [mV].
default IntegerReadChannel	getMaxCellVoltageChannel()	Gets the Channel for SymmetricEss.ChannelId.MAX_CELL_VOLTAGE.
default Value<Integer>	getMinCellTemperature()	Gets the Minimal Cell Temperature in [degC].
default IntegerReadChannel	getMinCellTemperatureChannel()	Gets the Channel for SymmetricEss.ChannelId.MIN_CELL_TEMPERATURE.
default Value<Integer>	getMinCellVoltage()	Gets the Minimum Cell Voltage in [mV].
default IntegerReadChannel	getMinCellVoltageChannel()	Gets the Channel for SymmetricEss.ChannelId.MIN_CELL_VOLTAGE.
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 SymmetricEss.ChannelId.REACTIVE_POWER.
default Value<Integer>	getSoc()	Gets the State of Charge in [%], range 0..100 %.
default IntegerReadChannel	getSocChannel()	Gets the Channel for SymmetricEss.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

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

getSocChannel

default IntegerReadChannel getSocChannel()

Gets the Channel for SymmetricEss.ChannelId.SOC.

Returns:

the Channel

getSoc

default Value<Integer> getSoc()

Gets the State of Charge in [%], range 0..100 %. See SymmetricEss.ChannelId.SOC.

Returns:

the Channel Value

_setSoc

default void _setSoc(Integer value)

Internal method to set the 'nextValue' on SymmetricEss.ChannelId.SOC Channel.

Parameters:

value - the next value

_setSoc

default void _setSoc(int value)

Internal method to set the 'nextValue' on SymmetricEss.ChannelId.SOC Channel.

Parameters:

value - the next value

getCapacityChannel

default IntegerReadChannel getCapacityChannel()

Gets the Channel for SymmetricEss.ChannelId.CAPACITY.

Returns:

the Channel

getCapacity

default Value<Integer> getCapacity()

Gets the Capacity in [Wh]. See SymmetricEss.ChannelId.CAPACITY.

Returns:

the Channel Value

_setCapacity

default void _setCapacity(Integer value)

Internal method to set the 'nextValue' on SymmetricEss.ChannelId.CAPACITY Channel.

Parameters:

value - the next value

_setCapacity

default void _setCapacity(int value)

Internal method to set the 'nextValue' on SymmetricEss.ChannelId.CAPACITY Channel.

Parameters:

value - the next value

getGridModeChannel

default Channel<GridMode> getGridModeChannel()

Gets the Channel for SymmetricEss.ChannelId.GRID_MODE.

Returns:

the Channel

getGridMode

default GridMode getGridMode()

Is the Energy Storage System On-Grid? See SymmetricEss.ChannelId.GRID_MODE.

Returns:

the Channel Value

_setGridMode

default void _setGridMode(GridMode value)

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

Parameters:

value - the next value

getActivePowerChannel

default IntegerReadChannel getActivePowerChannel()

Gets the Channel for SymmetricEss.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 SymmetricEss.ChannelId.ACTIVE_POWER.

Returns:

the Channel Value

_setActivePower

default void _setActivePower(Integer value)

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

Parameters:

value - the next value

_setActivePower

default void _setActivePower(int value)

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

Parameters:

value - the next value

getReactivePowerChannel

default IntegerReadChannel getReactivePowerChannel()

Gets the Channel for SymmetricEss.ChannelId.REACTIVE_POWER.

Returns:

the Channel

getReactivePower

default Value<Integer> getReactivePower()

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

Returns:

the Channel Value

_setReactivePower

default void _setReactivePower(Integer value)

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

Parameters:

value - the next value

_setReactivePower

default void _setReactivePower(int value)

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

Parameters:

value - the next value

getMaxApparentPowerChannel

default IntegerReadChannel getMaxApparentPowerChannel()

Gets the Channel for SymmetricEss.ChannelId.MAX_APPARENT_POWER.

Returns:

the Channel

getMaxApparentPower

default Value<Integer> getMaxApparentPower()

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

Returns:

the Channel Value

_setMaxApparentPower

default void _setMaxApparentPower(Integer value)

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

Parameters:

value - the next value

_setMaxApparentPower

default void _setMaxApparentPower(int value)

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

Parameters:

value - the next value

getActiveChargeEnergyChannel

default LongReadChannel getActiveChargeEnergyChannel()

Gets the Channel for SymmetricEss.ChannelId.ACTIVE_CHARGE_ENERGY.

Returns:

the Channel

getActiveChargeEnergy

default Value<Long> getActiveChargeEnergy()

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

Returns:

the Channel Value

_setActiveChargeEnergy

default void _setActiveChargeEnergy(Long value)

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

Parameters:

value - the next value

_setActiveChargeEnergy

default void _setActiveChargeEnergy(long value)

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

Parameters:

value - the next value

getActiveDischargeEnergyChannel

default LongReadChannel getActiveDischargeEnergyChannel()

Gets the Channel for SymmetricEss.ChannelId.ACTIVE_DISCHARGE_ENERGY.

Returns:

the Channel

getActiveDischargeEnergy

default Value<Long> getActiveDischargeEnergy()

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

Returns:

the Channel Value

_setActiveDischargeEnergy

default void _setActiveDischargeEnergy(Long value)

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

Parameters:

value - the next value

_setActiveDischargeEnergy

default void _setActiveDischargeEnergy(long value)

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

Parameters:

value - the next value

getMinCellVoltageChannel

default IntegerReadChannel getMinCellVoltageChannel()

Gets the Channel for SymmetricEss.ChannelId.MIN_CELL_VOLTAGE.

Returns:

the Channel

getMinCellVoltage

default Value<Integer> getMinCellVoltage()

Gets the Minimum Cell Voltage in [mV]. See SymmetricEss.ChannelId.MIN_CELL_VOLTAGE.

Returns:

the Channel Value

_setMinCellVoltage

default void _setMinCellVoltage(Integer value)

Internal method to set the 'nextValue' on SymmetricEss.ChannelId.MIN_CELL_VOLTAGE Channel.

Parameters:

value - the next value

_setMinCellVoltage

default void _setMinCellVoltage(int value)

Internal method to set the 'nextValue' on SymmetricEss.ChannelId.MIN_CELL_VOLTAGE Channel.

Parameters:

value - the next value

getMaxCellVoltageChannel

default IntegerReadChannel getMaxCellVoltageChannel()

Gets the Channel for SymmetricEss.ChannelId.MAX_CELL_VOLTAGE.

Returns:

the Channel

getMaxCellVoltage

default Value<Integer> getMaxCellVoltage()

Gets the Maximum Cell Voltage in [mV]. See SymmetricEss.ChannelId.MAX_CELL_VOLTAGE.

Returns:

the Channel Value

_setMaxCellVoltage

default void _setMaxCellVoltage(Integer value)

Internal method to set the 'nextValue' on SymmetricEss.ChannelId.MAX_CELL_VOLTAGE Channel.

Parameters:

value - the next value

_setMaxCellVoltage

default void _setMaxCellVoltage(int value)

Internal method to set the 'nextValue' on SymmetricEss.ChannelId.MAX_CELL_VOLTAGE Channel.

Parameters:

value - the next value

getMinCellTemperatureChannel

default IntegerReadChannel getMinCellTemperatureChannel()

Gets the Channel for SymmetricEss.ChannelId.MIN_CELL_TEMPERATURE.

Returns:

the Channel

getMinCellTemperature

default Value<Integer> getMinCellTemperature()

Gets the Minimal Cell Temperature in [degC]. See SymmetricEss.ChannelId.MIN_CELL_TEMPERATURE.

Returns:

the Channel Value

_setMinCellTemperature

default void _setMinCellTemperature(Integer value)

Internal method to set the 'nextValue' on SymmetricEss.ChannelId.MIN_CELL_TEMPERATURE Channel.

Parameters:

value - the next value

_setMinCellTemperature

default void _setMinCellTemperature(int value)

Internal method to set the 'nextValue' on SymmetricEss.ChannelId.MIN_CELL_TEMPERATURE Channel.

Parameters:

value - the next value

getMaxCellTemperatureChannel

default IntegerReadChannel getMaxCellTemperatureChannel()

Gets the Channel for SymmetricEss.ChannelId.MAX_CELL_TEMPERATURE.

Returns:

the Channel

getMaxCellTemperature

default Value<Integer> getMaxCellTemperature()

Gets the Maximum Cell Temperature in [degC]. See SymmetricEss.ChannelId.MAX_CELL_TEMPERATURE.

Returns:

the Channel Value

_setMaxCellTemperature

default void _setMaxCellTemperature(Integer value)

Internal method to set the 'nextValue' on SymmetricEss.ChannelId.MAX_CELL_TEMPERATURE Channel.

Parameters:

value - the next value

_setMaxCellTemperature

default void _setMaxCellTemperature(int value)

Internal method to set the 'nextValue' on SymmetricEss.ChannelId.MAX_CELL_TEMPERATURE Channel.

Parameters:

value - the next value