Battery (OpenEMS Javadoc)

All Superinterfaces:

OpenemsComponent, StartStoppable

All Known Subinterfaces:

BatteryBoxC130, ClusterVersionC, FeneconHomeBattery, SingleRackVersionB, SingleRackVersionC, SoltaroBatteryVersionC, SoltaroCluster

All Known Implementing Classes:

BatteryBoxC130Impl, BatteryDummy, BmwBatteryImpl, ClusterVersionB, ClusterVersionCImpl, DummyBattery, FeneconHomeBatteryImpl, SingleRack, SingleRackVersionBImpl, SingleRackVersionCImpl
```
@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 < 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 and Description

static class Battery.ChannelId

Nested Classes
Modifier and Type	Interface and Description
`static class`	`Battery.ChannelId`

Method Summary

All Methods Static Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default void`	`_setCapacity(int value)` Internal method to set the 'nextValue' on `Battery.ChannelId.CAPACITY` Channel.
`default void`	`_setCapacity(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.Integer value)` Internal method to set the 'nextValue' on `Battery.ChannelId.VOLTAGE` Channel.
`default Value<java.lang.Integer>`	`getCapacity()` Gets the Capacity in [Wh].
`default IntegerReadChannel`	`getCapacityChannel()` Gets the Channel for `Battery.ChannelId.CAPACITY`.
`default Value<java.lang.Integer>`	`getChargeMaxCurrent()` Gets the Charge Max Current in [A].
`default IntegerReadChannel`	`getChargeMaxCurrentChannel()` Gets the Channel for `Battery.ChannelId.CHARGE_MAX_CURRENT`.
`default Value<java.lang.Integer>`	`getChargeMaxVoltage()` Gets the Charge Max Voltage in [V].
`default IntegerReadChannel`	`getChargeMaxVoltageChannel()` Gets the Channel for `Battery.ChannelId.CHARGE_MAX_VOLTAGE`.
`default Value<java.lang.Integer>`	`getCurrent()` Gets the Current in [mA].
`default IntegerReadChannel`	`getCurrentChannel()` Gets the Channel for `Battery.ChannelId.CURRENT`.
`default Value<java.lang.Integer>`	`getDischargeMaxCurrent()` Gets the Discharge Max Current in [A].
`default IntegerReadChannel`	`getDischargeMaxCurrentChannel()` Gets the Channel for `Battery.ChannelId.DISCHARGE_MAX_CURRENT`.
`default Value<java.lang.Integer>`	`getDischargeMinVoltage()` Gets the Discharge Min Voltage in [V].
`default IntegerReadChannel`	`getDischargeMinVoltageChannel()` Gets the Channel for `Battery.ChannelId.DISCHARGE_MIN_VOLTAGE`.
`default Value<java.lang.Integer>`	`getMaxCellTemperature()` Gets the Maximum Cell Temperature in [degC].
`default IntegerReadChannel`	`getMaxCellTemperatureChannel()` Gets the Channel for `Battery.ChannelId.MAX_CELL_TEMPERATURE`.
`default Value<java.lang.Integer>`	`getMaxCellVoltage()` Gets the Maximum Cell Voltage in [mV].
`default IntegerReadChannel`	`getMaxCellVoltageChannel()` Gets the Channel for `Battery.ChannelId.MAX_CELL_VOLTAGE`.
`default Value<java.lang.Integer>`	`getMinCellTemperature()` Gets the Minimal Cell Temperature in [degC].
`default IntegerReadChannel`	`getMinCellTemperatureChannel()` Gets the Channel for `Battery.ChannelId.MIN_CELL_TEMPERATURE`.
`default Value<java.lang.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)` Gets the `ModbusSlaveNatureTable` for `StartStoppable` used by the Modbus/TCP Slave API.
`default Value<java.lang.Integer>`	`getSoc()` Gets the State of Charge in [%], range 0..100 %.
`default IntegerReadChannel`	`getSocChannel()` Gets the Channel for `Battery.ChannelId.SOC`.
`default Value<java.lang.Integer>`	`getSoh()` Gets the State of Health in [%], range 0..100 %.
`default IntegerReadChannel`	`getSohChannel()` Gets the Channel for `Battery.ChannelId.SOH`.
`default Value<java.lang.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.startstop.StartStoppable
_setStartStop, getStartStop, getStartStopChannel, isStarted, isStopped, setStartStop, start, stop

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, updateConfigurationProperty, updateReferenceFilter

- Method Detail
  - getModbusSlaveNatureTable
```
static ModbusSlaveNatureTable getModbusSlaveNatureTable(AccessMode accessMode)
```
    Description copied from interface: StartStoppable
    
    Gets the ModbusSlaveNatureTable for StartStoppable used by the Modbus/TCP Slave API.
    
    Specified by:
    
    getModbusSlaveNatureTable in interface OpenemsComponent
    
    Specified by:
    
    getModbusSlaveNatureTable in interface StartStoppable
    
    Parameters:
    
    accessMode - the AccessMode
    
    Returns:
    
    the ModbusSlaveNatureTable
  - getSocChannel
```
default IntegerReadChannel getSocChannel()
```
    Gets the Channel for Battery.ChannelId.SOC.
    
    Returns:
    
    the Channel
  - getSoc
```
default Value<java.lang.Integer> getSoc()
```
    Gets the State of Charge in [%], range 0..100 %. See Battery.ChannelId.SOC.
    
    Returns:
    
    the Channel Value
  - _setSoc
```
default void _setSoc(java.lang.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<java.lang.Integer> getSoh()
```
    Gets the State of Health in [%], range 0..100 %. See Battery.ChannelId.SOH.
    
    Returns:
    
    the Channel Value
  - _setSoh
```
default void _setSoh(java.lang.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<java.lang.Integer> getCapacity()
```
    Gets the Capacity in [Wh]. See Battery.ChannelId.CAPACITY.
    
    Returns:
    
    the Channel Value
  - _setCapacity
```
default void _setCapacity(java.lang.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<java.lang.Integer> getDischargeMinVoltage()
```
    Gets the Discharge Min Voltage in [V]. See Battery.ChannelId.DISCHARGE_MIN_VOLTAGE.
    
    Returns:
    
    the Channel Value
  - _setDischargeMinVoltage
```
default void _setDischargeMinVoltage(java.lang.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<java.lang.Integer> getDischargeMaxCurrent()
```
    Gets the Discharge Max Current in [A]. See Battery.ChannelId.DISCHARGE_MAX_CURRENT.
    
    Returns:
    
    the Channel Value
  - _setDischargeMaxCurrent
```
default void _setDischargeMaxCurrent(java.lang.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<java.lang.Integer> getChargeMaxVoltage()
```
    Gets the Charge Max Voltage in [V]. See Battery.ChannelId.CHARGE_MAX_VOLTAGE.
    
    Returns:
    
    the Channel Value
  - _setChargeMaxVoltage
```
default void _setChargeMaxVoltage(java.lang.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<java.lang.Integer> getChargeMaxCurrent()
```
    Gets the Charge Max Current in [A]. See Battery.ChannelId.CHARGE_MAX_CURRENT.
    
    Returns:
    
    the Channel Value
  - _setChargeMaxCurrent
```
default void _setChargeMaxCurrent(java.lang.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<java.lang.Integer> getMinCellTemperature()
```
    Gets the Minimal Cell Temperature in [degC]. See Battery.ChannelId.MIN_CELL_TEMPERATURE.
    
    Returns:
    
    the Channel Value
  - _setMinCellTemperature
```
default void _setMinCellTemperature(java.lang.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<java.lang.Integer> getMaxCellTemperature()
```
    Gets the Maximum Cell Temperature in [degC]. See Battery.ChannelId.MAX_CELL_TEMPERATURE.
    
    Returns:
    
    the Channel Value
  - _setMaxCellTemperature
```
default void _setMaxCellTemperature(java.lang.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<java.lang.Integer> getVoltage()
```
    Gets the Voltage in [V]. See Battery.ChannelId.VOLTAGE.
    
    Returns:
    
    the Channel Value
  - _setVoltage
```
default void _setVoltage(java.lang.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<java.lang.Integer> getCurrent()
```
    Gets the Current in [mA]. See Battery.ChannelId.CURRENT.
    
    Returns:
    
    the Channel Value
  - _setCurrent
```
default void _setCurrent(java.lang.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<java.lang.Integer> getMinCellVoltage()
```
    Gets the Minimum Cell Voltage in [mV]. See Battery.ChannelId.MIN_CELL_VOLTAGE.
    
    Returns:
    
    the Channel Value
  - _setMinCellVoltage
```
default void _setMinCellVoltage(java.lang.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<java.lang.Integer> getMaxCellVoltage()
```
    Gets the Maximum Cell Voltage in [mV]. See Battery.ChannelId.MAX_CELL_VOLTAGE.
    
    Returns:
    
    the Channel Value
  - _setMaxCellVoltage
```
default void _setMaxCellVoltage(java.lang.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

Interface Battery

Nested Class Summary

Method Summary

Methods inherited from interface io.openems.edge.common.startstop.StartStoppable

Methods inherited from interface io.openems.edge.common.component.OpenemsComponent

Method Detail

getModbusSlaveNatureTable

getSocChannel

getSoc

_setSoc

_setSoc

getSohChannel

getSoh

_setSoh

_setSoh

getCapacityChannel

getCapacity

_setCapacity

_setCapacity

getDischargeMinVoltageChannel

getDischargeMinVoltage

_setDischargeMinVoltage

_setDischargeMinVoltage

getDischargeMaxCurrentChannel

getDischargeMaxCurrent

_setDischargeMaxCurrent

_setDischargeMaxCurrent

getChargeMaxVoltageChannel

getChargeMaxVoltage

_setChargeMaxVoltage

_setChargeMaxVoltage

getChargeMaxCurrentChannel

getChargeMaxCurrent

_setChargeMaxCurrent

_setChargeMaxCurrent

getMinCellTemperatureChannel

getMinCellTemperature

_setMinCellTemperature

_setMinCellTemperature

getMaxCellTemperatureChannel

getMaxCellTemperature

_setMaxCellTemperature

_setMaxCellTemperature

getVoltageChannel

getVoltage

_setVoltage

_setVoltage

getCurrentChannel

getCurrent

_setCurrent

_setCurrent

getMinCellVoltageChannel

getMinCellVoltage

_setMinCellVoltage

_setMinCellVoltage

getMaxCellVoltageChannel

getMaxCellVoltage

_setMaxCellVoltage

_setMaxCellVoltage