Package io.openems.edge.core.appmanager

Interface OpenemsApp

All Known Implementing Classes:

AbstractEnumOpenemsApp, AbstractMeterApp, AbstractOpenemsApp, AbstractOpenemsAppWithProps, AbstractPvInverter, AlpitronicEvcs, AwattarHourly, CarloGavazziMeter, CombinedHeatAndPower, DezonyEvcs, EvcsCluster, FeneconHome, FeneconHome20, FeneconHome30, FroniusPvInverter, GridOptimizedCharge, HardyBarthEvcs, HeatingElement, HeatPump, IesKeywattEvcs, JanitzaMeter, KacoPvInverter, KdkMeter, KebaEvcs, KMtronic8Channel, KostalPvInverter, ManualRelayControl, MicrocareSdm630Meter, ModbusTcpApiReadOnly, ModbusTcpApiReadWrite, MqttApi, PeakShaving, PhaseAccuratePeakShaving, PrepareBatteryExtension, RestJsonApiReadOnly, RestJsonApiReadWrite, SelfConsumptionOptimization, SmaPvInverter, SocomecMeter, SolarEdgePvInverter, StromdaoCorrently, ThresholdControl, Tibber

public interface OpenemsApp

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FALLBACK_IMAGE

Method Summary

Modifier and Type	Method	Description
default Flag[]	flags()	Gets Flags for this OpenemsApp.
AppAssistant	getAppAssistant(User user)	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.
String	getAppId()	Gets the unique App-ID of the OpenemsApp.
OpenemsAppPermissions	getAppPermissions()	Gets the OpenemsAppPermissions of this OpenemsApp.
OpenemsAppCardinality	getCardinality()	Gets the OpenemsAppCardinality of the OpenemsApp.
OpenemsAppCategory[]	getCategories()	Gets the OpenemsAppCategory of the OpenemsApp.
String	getImage()	Gets the image of the OpenemsApp in Base64 encoding.
String	getName(Language language)	Gets the name of the OpenemsApp.
OpenemsAppPropertyDefinition[]	getProperties()	Gets all OpenemsAppPropertyDefinition of the app.
String	getShortName(Language language)	Gets the short name of the OpenemsApp.
ValidatorConfig	getValidatorConfig()	Gets the ValidatorConfig of this OpenemsApp.
void	validate(OpenemsAppInstance instance)	Validate the OpenemsApp.

Field Details

FALLBACK_IMAGE

static final String FALLBACK_IMAGE

See Also:

• Constant Field Values

Method Details

getAppAssistant

AppAssistant getAppAssistant(User user)

Gets the AppAssistant for this OpenemsApp.

Parameters:

user - the User

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

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

getCategories

OpenemsAppCategory[] getCategories()

Gets the OpenemsAppCategory of the OpenemsApp.

Returns:

the category's

getImage

String getImage()

Gets the image of the OpenemsApp in Base64 encoding.

Returns:

a image representing the OpenemsApp

getName

String getName(Language language)

Gets the name of the OpenemsApp.

Parameters:

language - the language of the name

Returns:

a human readable name

getShortName

String getShortName(Language language)

Gets the short name of the OpenemsApp.

Parameters:

language - the language of the name

Returns:

a human readable short name; can be null

getCardinality

OpenemsAppCardinality getCardinality()

Gets the OpenemsAppCardinality of the OpenemsApp.

Returns:

the usage

getProperties

OpenemsAppPropertyDefinition[] getProperties()

Gets all OpenemsAppPropertyDefinition of the app.

Returns:

the OpenemsAppPropertyDefinitions

Throws:

UnsupportedOperationException - if not implemented

getValidatorConfig

ValidatorConfig getValidatorConfig()

Gets the ValidatorConfig of this OpenemsApp.

Returns:

the ValidatorConfig

getAppPermissions

OpenemsAppPermissions getAppPermissions()

Gets the OpenemsAppPermissions of this OpenemsApp.

Returns:

the permissions

flags

default Flag[] flags()

Gets Flags for this OpenemsApp. A Flag could be anything that would describe the app more.

Flags may be specific for Monitoring e. g. only show the app after a key was entered (Flags.SHOW_AFTER_KEY_REDEEM).

Returns:

an array of Flags

validate

void validate(OpenemsAppInstance instance)
       throws OpenemsError.OpenemsNamedException

Validate the OpenemsApp.

Parameters:

instance - the app instance

Throws:

OpenemsError.OpenemsNamedException