Package io.openems.edge.core.appmanager

Interface OpenemsApp

All Known Implementing Classes:

AbstractEvcsApp, AbstractMeterApp, AbstractOpenemsApp, AbstractPvInverter, AwattarHourly, CarloGavazziMeter, CombinedHeatAndPower, EvcsCluster, FeneconHome, FroniusPvInverter, GridOptimizedCharge, HardyBarthEvcs, HeatingElement, HeatPump, IesKeywattEvcs, JanitzaMeter, KacoPvInverter, KebaEvcs, KMtronic8Channel, KostalPvInverter, ManualRelayControl, ModbusTcpApiReadOnly, ModbusTcpApiReadWrite, MqttApi, RestJsonApiReadOnly, RestJsonApiReadWrite, SelfConsumptionOptimization, SmaPvInverter, SocomecMeter, SolarEdgePvInverter, StromdaoCorrently, ThresholdControl, Tibber

public interface OpenemsApp

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	FALLBACK_IMAGE

Method Summary

Modifier and Type	Method	Description
AppAssistant	getAppAssistant(Language language)	Gets the AppAssistant for this OpenemsApp.
AppConfiguration	getAppConfiguration(ConfigurationTarget target, com.google.gson.JsonObject config, Language language)	Gets the AppConfiguration needed for the OpenemsApp.
AppDescriptor	getAppDescriptor()	Gets the AppDescriptor of the OpenemsApp.
java.lang.String	getAppId()	Gets the unique App-ID of the OpenemsApp.
OpenemsAppCardinality	getCardinality()	Gets the OpenemsAppCardinality of the OpenemsApp.
OpenemsAppCategory[]	getCategorys()	Gets the OpenemsAppCategory of the OpenemsApp.
java.lang.String	getImage()	Gets the image of the OpenemsApp in Base64 encoding.
java.lang.String	getName(Language language)	Gets the name of the OpenemsApp.
ValidatorConfig	getValidatorConfig()	Gets the ValidatorConfig of this OpenemsApp.
void	validate(OpenemsAppInstance instance)	Validate the OpenemsApp.

Field Detail

FALLBACK_IMAGE

static final java.lang.String FALLBACK_IMAGE

See Also:

Constant Field Values

Method Detail

getAppAssistant

AppAssistant getAppAssistant(Language language)

Gets the AppAssistant for this OpenemsApp.

Parameters:

language - the language of the AppAssistant

Returns:

the AppAssistant

getAppConfiguration

AppConfiguration getAppConfiguration(ConfigurationTarget target,
                                     com.google.gson.JsonObject config,
                                     Language language)
                              throws OpenemsError.OpenemsNamedException

Gets the AppConfiguration needed for the OpenemsApp.

Parameters:

target - the ConfigurationTarget

config - the configured app 'properties'

language - the language of the configuration

Returns:

the app Configuration

Throws:

OpenemsError.OpenemsNamedException

getAppId

java.lang.String getAppId()

Gets the unique App-ID of the OpenemsApp.

Returns:

a unique PID, usually the ComponentConstants.COMPONENT_NAME of the OSGi Component provider.

getAppDescriptor

AppDescriptor getAppDescriptor()

Gets the AppDescriptor of the OpenemsApp.

Returns:

the AppDescriptor

getCategorys

OpenemsAppCategory[] getCategorys()

Gets the OpenemsAppCategory of the OpenemsApp.

Returns:

the category's

getImage

java.lang.String getImage()

Gets the image of the OpenemsApp in Base64 encoding.

Returns:

a image representing the OpenemsApp

getName

java.lang.String getName(Language language)

Gets the name of the OpenemsApp.

Parameters:

language - the language of the name

Returns:

a human readable name

getCardinality

OpenemsAppCardinality getCardinality()

Gets the OpenemsAppCardinality of the OpenemsApp.

Returns:

the usage

getValidatorConfig

ValidatorConfig getValidatorConfig()

Gets the ValidatorConfig of this OpenemsApp.

Returns:

the ValidatorConfig

validate

void validate(OpenemsAppInstance instance)
       throws OpenemsError.OpenemsNamedException

Validate the OpenemsApp.

Parameters:

instance - the app instance

Throws:

OpenemsError.OpenemsNamedException