Package io.openems.edge.battery.api

Enum Class Battery.ChannelId

java.lang.Object

java.lang.Enum<Battery.ChannelId>

io.openems.edge.battery.api.Battery.ChannelId

All Implemented Interfaces:

ChannelId, Serializable, Comparable<Battery.ChannelId>, Constable

Enclosing interface:

Battery

public static enum Battery.ChannelId
extends Enum<Battery.ChannelId>
implements ChannelId

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Nested classes/interfaces inherited from interface io.openems.edge.common.channel.ChannelId

ChannelId.ChannelIdImpl

Enum Constant Summary

Enum Constants

Enum Constant	Description
CAPACITY	Capacity of battery.
CHARGE_MAX_CURRENT	Maximum current for charging.
CHARGE_MAX_VOLTAGE	Maximal voltage for charging.
CURRENT	Current of battery.
DISCHARGE_MAX_CURRENT	Maximum current for discharging.
DISCHARGE_MIN_VOLTAGE	Minimal voltage for discharging.
MAX_CELL_TEMPERATURE	Maximum Cell Temperature.
MAX_CELL_VOLTAGE	Maximum cell voltage.
MIN_CELL_TEMPERATURE	Minimal Cell Temperature.
MIN_CELL_VOLTAGE	Minimal cell voltage.
SOC	State of Charge.
SOH	State of Health.
VOLTAGE	Voltage of battery.

Method Summary

Modifier and Type	Method	Description
Doc	doc()	Gets the Channel Doc for this ChannelId.
static Battery.ChannelId	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Battery.ChannelId[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.openems.edge.common.channel.ChannelId

id, name

Enum Constant Details

SOC

public static final Battery.ChannelId SOC

State of Charge.

• Interface: Battery
• Type: Integer
• Unit: %
• Range: 0..100

SOH

public static final Battery.ChannelId SOH

State of Health.

• Interface: Battery
• Type: Integer
• Unit: %
• Range: 0..100

VOLTAGE

public static final Battery.ChannelId VOLTAGE

Voltage of battery.

• Interface: Battery
• Type: Integer
• Unit: V

CURRENT

public static final Battery.ChannelId CURRENT

Current of battery.

• Interface: Battery
• Type: Integer
• Unit: A

CAPACITY

public static final Battery.ChannelId CAPACITY

Capacity of battery.

• Interface: Battery
• Type: Integer
• Unit: Wh

CHARGE_MAX_VOLTAGE

public static final Battery.ChannelId CHARGE_MAX_VOLTAGE

Maximal voltage for charging.

• Interface: Battery
• Type: Integer
• Unit: V

CHARGE_MAX_CURRENT

public static final Battery.ChannelId CHARGE_MAX_CURRENT

Maximum current for charging.

• Interface: Battery
• Type: Integer
• Unit: A
• Usually positive, negative for force discharge mode

DISCHARGE_MIN_VOLTAGE

public static final Battery.ChannelId DISCHARGE_MIN_VOLTAGE

Minimal voltage for discharging.

• Interface: Battery
• Type: Integer
• Unit: V

DISCHARGE_MAX_CURRENT

public static final Battery.ChannelId DISCHARGE_MAX_CURRENT

Maximum current for discharging.

• Interface: Battery
• Type: Integer
• Unit: A
• Usually positive, negative for force charge mode

MIN_CELL_TEMPERATURE

public static final Battery.ChannelId MIN_CELL_TEMPERATURE

Minimal Cell Temperature.

• Interface: Battery
• Type: Integer
• Unit: Celsius

MAX_CELL_TEMPERATURE

public static final Battery.ChannelId MAX_CELL_TEMPERATURE

Maximum Cell Temperature.

• Interface: Battery
• Type: Integer
• Unit: Celsius
• Range: (-50)..100

MIN_CELL_VOLTAGE

public static final Battery.ChannelId MIN_CELL_VOLTAGE

Minimal cell voltage.

• Interface: Battery
• Type: Integer
• Unit: mV

MAX_CELL_VOLTAGE

public static final Battery.ChannelId MAX_CELL_VOLTAGE

Maximum cell voltage.

• Interface: Battery
• Type: Integer
• Unit: mV

Method Details

values

public static Battery.ChannelId[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static Battery.ChannelId valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

doc

public Doc doc()

Description copied from interface: ChannelId

Gets the Channel Doc for this ChannelId.

Specified by:

doc in interface ChannelId

Returns:

the Channel-Doc