Package net.solarnetwork.domain.datum

Interface EnergyStorageDatum

All Superinterfaces:

Datum

public interface EnergyStorageDatum
extends Datum

Standardized API for energy storage system related datum to implement.

Version:

2.1

Author:

matt

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AVAILABLE_WATT_HOURS_KEY	An instantaneous sample key for getAvailableEnergy() values.
static final String	CAPACITY_WATT_HOURS_KEY	An status sample key for getEnergyCapacity() values.
static final String	PERCENTAGE_KEY	Deprecated. since 2.1 use STATE_OF_CHARGE_PERCENTAGE_KEY
static final String	STATE_OF_CHARGE_PERCENTAGE_KEY	An instantaneous sample key for getAvailableEnergyPercentage() values.
static final String	STATE_OF_HEALTH_PERCENTAGE_KEY	An instantaneous sample key for getStateOfHealthPercentage() values.

Fields inherited from interface net.solarnetwork.domain.datum.Datum

DATUM_TYPE_PROPERTY, DATUM_TYPES_PROPERTY, OP_STATE, OP_STATES, REVERSE_ACCUMULATING_SUFFIX_KEY, SOURCE_ID, TIMESTAMP

Method Summary

Modifier and Type	Method	Description
default Long	getAvailableEnergy()	Get the available energy of the storage system, in Wh.
default Float	getAvailableEnergyPercentage()	Get the percentage of energy capacity available in the storage.
default Long	getEnergyCapacity()	Get the energy capacity of the storage system, in Wh.
default Float	getStateOfHealthPercentage()	Get a percentage of storage "health" in terms of practical total capacity right now versus theoretical total capacity when the storage was manufactured.

Methods inherited from interface net.solarnetwork.domain.datum.Datum

asSampleOperations, asSimpleMap, copyWithId, copyWithSamples, getKind, getObjectId, getSampleData, getSourceId, getTimestamp

Field Details

STATE_OF_CHARGE_PERCENTAGE_KEY

static final String STATE_OF_CHARGE_PERCENTAGE_KEY

An instantaneous sample key for getAvailableEnergyPercentage() values.

Since:

2.1

See Also:

• Constant Field Values

PERCENTAGE_KEY

@Deprecated
static final String PERCENTAGE_KEY

Deprecated.

since 2.1 use STATE_OF_CHARGE_PERCENTAGE_KEY

An instantaneous sample key for getAvailableEnergyPercentage() values.

See Also:

• Constant Field Values

STATE_OF_HEALTH_PERCENTAGE_KEY

static final String STATE_OF_HEALTH_PERCENTAGE_KEY

An instantaneous sample key for getStateOfHealthPercentage() values.

Since:

2.1

See Also:

• Constant Field Values

AVAILABLE_WATT_HOURS_KEY

static final String AVAILABLE_WATT_HOURS_KEY

An instantaneous sample key for getAvailableEnergy() values.

See Also:

• Constant Field Values

CAPACITY_WATT_HOURS_KEY

static final String CAPACITY_WATT_HOURS_KEY

An status sample key for getEnergyCapacity() values.

Since:

2.1

See Also:

• Constant Field Values

Method Details

getAvailableEnergyPercentage

default Float getAvailableEnergyPercentage()

Get the percentage of energy capacity available in the storage.

The getAvailableEnergy() value divided by this value, represents the total energy capacity of the storage.

Returns:

the available energy as a percentage of the total capacity of the storage

getStateOfHealthPercentage

default Float getStateOfHealthPercentage()

Get a percentage of storage "health" in terms of practical total capacity right now versus theoretical total capacity when the storage was manufactured.

Returns:

the total energy capacity now as a percentage of the theoretical total capacity of the storage when manufactured

Since:

2.1

getAvailableEnergy

default Long getAvailableEnergy()

Get the available energy of the storage system, in Wh.

Returns:

the available energy of the storage

getEnergyCapacity

default Long getEnergyCapacity()

Get the energy capacity of the storage system, in Wh.

Returns:

the energy capacity of the storage

Since:

2.1