Package io.openems.edge.battery.api

Interface Battery

All Superinterfaces:

OpenemsComponent, StartStoppable

All Known Subinterfaces:

BatteryFeneconCommercial, BatteryFeneconHome, BatterySoltaroClusterVersionB, BatterySoltaroClusterVersionC, BatterySoltaroSingleRackVersionA, BatterySoltaroSingleRackVersionB, BatterySoltaroSingleRackVersionC, BydBatteryBoxCommercialC130, SimulatorBattery, SoltaroBatteryVersionC, SoltaroCluster

All Known Implementing Classes:

AbstractDummyBattery, BatteryFeneconCommercialImpl, BatteryFeneconHomeImpl, BatterySoltaroClusterVersionBImpl, BatterySoltaroClusterVersionCImpl, BatterySoltaroSingleRackVersionAImpl, BatterySoltaroSingleRackVersionBImpl, BatterySoltaroSingleRackVersionCImpl, BmwBatteryImpl, BydBatteryBoxCommercialC130Impl, DummyBattery, SimulatorBatteryImpl

@ProviderType
public interface Battery
extends StartStoppable, OpenemsComponent

Represents a Battery.

To indicate, that the Battery 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)
• CHARGE_MAX_VOLTAGE, CHARGE_MAX_CURRENT, DISCHARGE_MIN_VOLTAGE and DISCHARGE_MAX_CURRENT are != null

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	Battery.ChannelId

Method Summary

Modifier and Type	Method	Description
default void	_setCapacity(int value)	Internal method to set the 'nextValue' on Battery.ChannelId.CAPACITY Channel.
default void	_setCapacity(Integer value)	Internal method to set the 'nextValue' on Battery.ChannelId.CAPACITY Channel.
default void	_setChargeMaxCurrent(int value)	Internal method to set the 'nextValue' on Battery.ChannelId.CHARGE_MAX_CURRENT Channel.
default void	_setChargeMaxCurrent(Integer value)	Internal method to set the 'nextValue' on Battery.ChannelId.CHARGE_MAX_CURRENT Channel.
default void	_setChargeMaxVoltage(int value)	Internal method to set the 'nextValue' on Battery.ChannelId.CHARGE_MAX_VOLTAGE Channel.
default void	_setChargeMaxVoltage(Integer value)	Internal method to set the 'nextValue' on Battery.ChannelId.CHARGE_MAX_VOLTAGE Channel.
default void	_setCurrent(int value)	Internal method to set the 'nextValue' on Battery.ChannelId.CURRENT Channel.
default void	_setCurrent(Integer value)	Internal method to set the 'nextValue' on Battery.ChannelId.CURRENT Channel.
default void	_setDischargeMaxCurrent(int value)	Internal method to set the 'nextValue' on Battery.ChannelId.DISCHARGE_MAX_CURRENT Channel.
default void	_setDischargeMaxCurrent(Integer value)	Internal method to set the 'nextValue' on Battery.ChannelId.DISCHARGE_MAX_CURRENT Channel.
default void	_setDischargeMinVoltage(int value)	Internal method to set the 'nextValue' on Battery.ChannelId.DISCHARGE_MIN_VOLTAGE Channel.
default void	_setDischargeMinVoltage(Integer value)	Internal method to set the 'nextValue' on Battery.ChannelId.DISCHARGE_MIN_VOLTAGE Channel.
default void	_setMaxCellTemperature(int value)	Internal method to set the 'nextValue' on Battery.ChannelId.MAX_CELL_TEMPERATURE Channel.
default void	_setMaxCellTemperature(Integer value)	Internal method to set the 'nextValue' on Battery.ChannelId.MAX_CELL_TEMPERATURE Channel.
default void	_setMaxCellVoltage(int value)	Internal method to set the 'nextValue' on Battery.ChannelId.MAX_CELL_VOLTAGE Channel.
default void	_setMaxCellVoltage(Integer value)	Internal method to set the 'nextValue' on Battery.ChannelId.MAX_CELL_VOLTAGE Channel.
default void	_setMinCellTemperature(int value)	Internal method to set the 'nextValue' on Battery.ChannelId.MIN_CELL_TEMPERATURE Channel.
default void	_setMinCellTemperature(Integer value)	Internal method to set the 'nextValue' on Battery.ChannelId.MIN_CELL_TEMPERATURE Channel.
default void	_setMinCellVoltage(int value)	Internal method to set the 'nextValue' on Battery.ChannelId.MIN_CELL_VOLTAGE Channel.
default void	_setMinCellVoltage(Integer value)	Internal method to set the 'nextValue' on Battery.ChannelId.MIN_CELL_VOLTAGE Channel.
default void	_setSoc(int value)	Internal method to set the 'nextValue' on Battery.ChannelId.SOC Channel.
default void	_setSoc(Integer value)	Internal method to set the 'nextValue' on Battery.ChannelId.SOC Channel.
default void	_setSoh(int value)	Internal method to set the 'nextValue' on Battery.ChannelId.SOH Channel.
default void	_setSoh(Integer value)	Internal method to set the 'nextValue' on Battery.ChannelId.SOH Channel.
default void	_setVoltage(int value)	Internal method to set the 'nextValue' on Battery.ChannelId.VOLTAGE Channel.
default void	_setVoltage(Integer value)	Internal method to set the 'nextValue' on Battery.ChannelId.VOLTAGE Channel.
static String	generateDebugLog(Battery battery, AbstractStateMachine<?,?> stateMachine)	Generates a default DebugLog message for Battery implementations with a State-Machine.
default Value<Integer>	getCapacity()	Gets the Capacity in [Wh].
default IntegerReadChannel	getCapacityChannel()	Gets the Channel for Battery.ChannelId.CAPACITY.
default Value<Integer>	getChargeMaxCurrent()	Gets the Charge Max Current in [A].
default IntegerReadChannel	getChargeMaxCurrentChannel()	Gets the Channel for Battery.ChannelId.CHARGE_MAX_CURRENT.
default Value<Integer>	getChargeMaxVoltage()	Gets the Charge Max Voltage in [V].
default IntegerReadChannel	getChargeMaxVoltageChannel()	Gets the Channel for Battery.ChannelId.CHARGE_MAX_VOLTAGE.
default Value<Integer>	getCurrent()	Gets the Current in [mA].
default IntegerReadChannel	getCurrentChannel()	Gets the Channel for Battery.ChannelId.CURRENT.
default Value<Integer>	getDischargeMaxCurrent()	Gets the Discharge Max Current in [A].
default IntegerReadChannel	getDischargeMaxCurrentChannel()	Gets the Channel for Battery.ChannelId.DISCHARGE_MAX_CURRENT.
default Value<Integer>	getDischargeMinVoltage()	Gets the Discharge Min Voltage in [V].
default IntegerReadChannel	getDischargeMinVoltageChannel()	Gets the Channel for Battery.ChannelId.DISCHARGE_MIN_VOLTAGE.
default Value<Integer>	getMaxCellTemperature()	Gets the Maximum Cell Temperature in [degC].
default IntegerReadChannel	getMaxCellTemperatureChannel()	Gets the Channel for Battery.ChannelId.MAX_CELL_TEMPERATURE.
default Value<Integer>	getMaxCellVoltage()	Gets the Maximum Cell Voltage in [mV].
default IntegerReadChannel	getMaxCellVoltageChannel()	Gets the Channel for Battery.ChannelId.MAX_CELL_VOLTAGE.
default Value<Integer>	getMinCellTemperature()	Gets the Minimal Cell Temperature in [degC].
default IntegerReadChannel	getMinCellTemperatureChannel()	Gets the Channel for Battery.ChannelId.MIN_CELL_TEMPERATURE.
default Value<Integer>	getMinCellVoltage()	Gets the Minimum Cell Voltage in [mV].
default IntegerReadChannel	getMinCellVoltageChannel()	Gets the Channel for Battery.ChannelId.MIN_CELL_VOLTAGE.
static ModbusSlaveNatureTable	getModbusSlaveNatureTable(AccessMode accessMode)	Used for Modbus/TCP Api Controller.
default Value<Integer>	getSoc()	Gets the State of Charge in [%], range 0..100 %.
default IntegerReadChannel	getSocChannel()	Gets the Channel for Battery.ChannelId.SOC.
default Value<Integer>	getSoh()	Gets the State of Health in [%], range 0..100 %.
default IntegerReadChannel	getSohChannel()	Gets the Channel for Battery.ChannelId.SOH.
default Value<Integer>	getVoltage()	Gets the Voltage in [V].
default IntegerReadChannel	getVoltageChannel()	Gets the Channel for Battery.ChannelId.VOLTAGE.

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

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 Battery.ChannelId.SOC.

Returns:

the Channel

getSoc

default Value<Integer> getSoc()

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

Returns:

the Channel Value

_setSoc

default void _setSoc(Integer value)

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

Parameters:

value - the next value

_setSoc

default void _setSoc(int value)

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

Parameters:

value - the next value

getSohChannel

default IntegerReadChannel getSohChannel()

Gets the Channel for Battery.ChannelId.SOH.

Returns:

the Channel

getSoh

default Value<Integer> getSoh()

Gets the State of Health in [%], range 0..100 %. See Battery.ChannelId.SOH.

Returns:

the Channel Value

_setSoh

default void _setSoh(Integer value)

Internal method to set the 'nextValue' on Battery.ChannelId.SOH Channel.

Parameters:

value - the next value

_setSoh

default void _setSoh(int value)

Internal method to set the 'nextValue' on Battery.ChannelId.SOH Channel.

Parameters:

value - the next value

getCapacityChannel

default IntegerReadChannel getCapacityChannel()

Gets the Channel for Battery.ChannelId.CAPACITY.

Returns:

the Channel

getCapacity

default Value<Integer> getCapacity()

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

Returns:

the Channel Value

_setCapacity

default void _setCapacity(Integer value)

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

Parameters:

value - the next value

_setCapacity

default void _setCapacity(int value)

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

Parameters:

value - the next value

getDischargeMinVoltageChannel

default IntegerReadChannel getDischargeMinVoltageChannel()

Gets the Channel for Battery.ChannelId.DISCHARGE_MIN_VOLTAGE.

Returns:

the Channel

getDischargeMinVoltage

default Value<Integer> getDischargeMinVoltage()

Gets the Discharge Min Voltage in [V]. See Battery.ChannelId.DISCHARGE_MIN_VOLTAGE.

Returns:

the Channel Value

_setDischargeMinVoltage

default void _setDischargeMinVoltage(Integer value)

Internal method to set the 'nextValue' on Battery.ChannelId.DISCHARGE_MIN_VOLTAGE Channel.

Parameters:

value - the next value

_setDischargeMinVoltage

default void _setDischargeMinVoltage(int value)

Internal method to set the 'nextValue' on Battery.ChannelId.DISCHARGE_MIN_VOLTAGE Channel.

Parameters:

value - the next value

getDischargeMaxCurrentChannel

default IntegerReadChannel getDischargeMaxCurrentChannel()

Gets the Channel for Battery.ChannelId.DISCHARGE_MAX_CURRENT.

Returns:

the Channel

getDischargeMaxCurrent

default Value<Integer> getDischargeMaxCurrent()

Gets the Discharge Max Current in [A]. See Battery.ChannelId.DISCHARGE_MAX_CURRENT.

Returns:

the Channel Value

_setDischargeMaxCurrent

default void _setDischargeMaxCurrent(Integer value)

Internal method to set the 'nextValue' on Battery.ChannelId.DISCHARGE_MAX_CURRENT Channel.

Parameters:

value - the next value

_setDischargeMaxCurrent

default void _setDischargeMaxCurrent(int value)

Internal method to set the 'nextValue' on Battery.ChannelId.DISCHARGE_MAX_CURRENT Channel.

Parameters:

value - the next value

getChargeMaxVoltageChannel

default IntegerReadChannel getChargeMaxVoltageChannel()

Gets the Channel for Battery.ChannelId.CHARGE_MAX_VOLTAGE.

Returns:

the Channel

getChargeMaxVoltage

default Value<Integer> getChargeMaxVoltage()

Gets the Charge Max Voltage in [V]. See Battery.ChannelId.CHARGE_MAX_VOLTAGE.

Returns:

the Channel Value

_setChargeMaxVoltage

default void _setChargeMaxVoltage(Integer value)

Internal method to set the 'nextValue' on Battery.ChannelId.CHARGE_MAX_VOLTAGE Channel.

Parameters:

value - the next value

_setChargeMaxVoltage

default void _setChargeMaxVoltage(int value)

Internal method to set the 'nextValue' on Battery.ChannelId.CHARGE_MAX_VOLTAGE Channel.

Parameters:

value - the next value

getChargeMaxCurrentChannel

default IntegerReadChannel getChargeMaxCurrentChannel()

Gets the Channel for Battery.ChannelId.CHARGE_MAX_CURRENT.

Returns:

the Channel

getChargeMaxCurrent

default Value<Integer> getChargeMaxCurrent()

Gets the Charge Max Current in [A]. See Battery.ChannelId.CHARGE_MAX_CURRENT.

Returns:

the Channel Value

_setChargeMaxCurrent

default void _setChargeMaxCurrent(Integer value)

Internal method to set the 'nextValue' on Battery.ChannelId.CHARGE_MAX_CURRENT Channel.

Parameters:

value - the next value

_setChargeMaxCurrent

default void _setChargeMaxCurrent(int value)

Internal method to set the 'nextValue' on Battery.ChannelId.CHARGE_MAX_CURRENT Channel.

Parameters:

value - the next value

getMinCellTemperatureChannel

default IntegerReadChannel getMinCellTemperatureChannel()

Gets the Channel for Battery.ChannelId.MIN_CELL_TEMPERATURE.

Returns:

the Channel

getMinCellTemperature

default Value<Integer> getMinCellTemperature()

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

Returns:

the Channel Value

_setMinCellTemperature

default void _setMinCellTemperature(Integer value)

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

Parameters:

value - the next value

_setMinCellTemperature

default void _setMinCellTemperature(int value)

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

Parameters:

value - the next value

getMaxCellTemperatureChannel

default IntegerReadChannel getMaxCellTemperatureChannel()

Gets the Channel for Battery.ChannelId.MAX_CELL_TEMPERATURE.

Returns:

the Channel

getMaxCellTemperature

default Value<Integer> getMaxCellTemperature()

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

Returns:

the Channel Value

_setMaxCellTemperature

default void _setMaxCellTemperature(Integer value)

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

Parameters:

value - the next value

_setMaxCellTemperature

default void _setMaxCellTemperature(int value)

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

Parameters:

value - the next value

getVoltageChannel

default IntegerReadChannel getVoltageChannel()

Gets the Channel for Battery.ChannelId.VOLTAGE.

Returns:

the Channel

getVoltage

default Value<Integer> getVoltage()

Gets the Voltage in [V]. See Battery.ChannelId.VOLTAGE.

Returns:

the Channel Value

_setVoltage

default void _setVoltage(Integer value)

Internal method to set the 'nextValue' on Battery.ChannelId.VOLTAGE Channel.

Parameters:

value - the next value

_setVoltage

default void _setVoltage(int value)

Internal method to set the 'nextValue' on Battery.ChannelId.VOLTAGE Channel.

Parameters:

value - the next value

getCurrentChannel

default IntegerReadChannel getCurrentChannel()

Gets the Channel for Battery.ChannelId.CURRENT.

Returns:

the Channel

getCurrent

default Value<Integer> getCurrent()

Gets the Current in [mA]. See Battery.ChannelId.CURRENT.

Returns:

the Channel Value

_setCurrent

default void _setCurrent(Integer value)

Internal method to set the 'nextValue' on Battery.ChannelId.CURRENT Channel.

Parameters:

value - the next value

_setCurrent

default void _setCurrent(int value)

Internal method to set the 'nextValue' on Battery.ChannelId.CURRENT Channel.

Parameters:

value - the next value

getMinCellVoltageChannel

default IntegerReadChannel getMinCellVoltageChannel()

Gets the Channel for Battery.ChannelId.MIN_CELL_VOLTAGE.

Returns:

the Channel

getMinCellVoltage

default Value<Integer> getMinCellVoltage()

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

Returns:

the Channel Value

_setMinCellVoltage

default void _setMinCellVoltage(Integer value)

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

Parameters:

value - the next value

_setMinCellVoltage

default void _setMinCellVoltage(int value)

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

Parameters:

value - the next value

getMaxCellVoltageChannel

default IntegerReadChannel getMaxCellVoltageChannel()

Gets the Channel for Battery.ChannelId.MAX_CELL_VOLTAGE.

Returns:

the Channel

getMaxCellVoltage

default Value<Integer> getMaxCellVoltage()

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

Returns:

the Channel Value

_setMaxCellVoltage

default void _setMaxCellVoltage(Integer value)

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

Parameters:

value - the next value

_setMaxCellVoltage

default void _setMaxCellVoltage(int value)

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

Parameters:

value - the next value

generateDebugLog

static String generateDebugLog(Battery battery,
 AbstractStateMachine<?,?> stateMachine)

Generates a default DebugLog message for Battery implementations with a State-Machine.

Parameters:

battery - the Battery

stateMachine - the actual StateMachine (extends AbstractStateMachine)

Returns:

a debug log String