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
All Methods Instance Methods Abstract Methods Modifier and Type Method Description AppAssistant
getAppAssistant(Language language)
Gets theAppAssistant
for thisOpenemsApp
.AppConfiguration
getAppConfiguration(ConfigurationTarget target, com.google.gson.JsonObject config, Language language)
Gets theAppConfiguration
needed for theOpenemsApp
.AppDescriptor
getAppDescriptor()
Gets theAppDescriptor
of theOpenemsApp
.java.lang.String
getAppId()
Gets the unique App-ID of theOpenemsApp
.OpenemsAppCardinality
getCardinality()
Gets theOpenemsAppCardinality
of theOpenemsApp
.OpenemsAppCategory[]
getCategorys()
Gets theOpenemsAppCategory
of theOpenemsApp
.java.lang.String
getImage()
Gets the image of theOpenemsApp
in Base64 encoding.java.lang.String
getName(Language language)
Gets the name of theOpenemsApp
.ValidatorConfig
getValidatorConfig()
Gets theValidatorConfig
of thisOpenemsApp
.void
validate(OpenemsAppInstance instance)
Validate theOpenemsApp
.
-
-
-
Field Detail
-
FALLBACK_IMAGE
static final java.lang.String FALLBACK_IMAGE
- See Also:
- Constant Field Values
-
-
Method Detail
-
getAppAssistant
AppAssistant getAppAssistant(Language language)
Gets theAppAssistant
for thisOpenemsApp
.- Parameters:
language
- the language of theAppAssistant
- Returns:
- the AppAssistant
-
getAppConfiguration
AppConfiguration getAppConfiguration(ConfigurationTarget target, com.google.gson.JsonObject config, Language language) throws OpenemsError.OpenemsNamedException
Gets theAppConfiguration
needed for theOpenemsApp
.- Parameters:
target
- theConfigurationTarget
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 theOpenemsApp
.- Returns:
- a unique PID, usually the
ComponentConstants.COMPONENT_NAME
of the OSGi Component provider.
-
getAppDescriptor
AppDescriptor getAppDescriptor()
Gets theAppDescriptor
of theOpenemsApp
.- Returns:
- the
AppDescriptor
-
getCategorys
OpenemsAppCategory[] getCategorys()
Gets theOpenemsAppCategory
of theOpenemsApp
.- Returns:
- the category's
-
getImage
java.lang.String getImage()
Gets the image of theOpenemsApp
in Base64 encoding.- Returns:
- a image representing the
OpenemsApp
-
getName
java.lang.String getName(Language language)
Gets the name of theOpenemsApp
.- Parameters:
language
- the language of the name- Returns:
- a human readable name
-
getCardinality
OpenemsAppCardinality getCardinality()
Gets theOpenemsAppCardinality
of theOpenemsApp
.- Returns:
- the usage
-
getValidatorConfig
ValidatorConfig getValidatorConfig()
Gets theValidatorConfig
of thisOpenemsApp
.- Returns:
- the ValidatorConfig
-
validate
void validate(OpenemsAppInstance instance) throws OpenemsError.OpenemsNamedException
Validate theOpenemsApp
.- Parameters:
instance
- the app instance- Throws:
OpenemsError.OpenemsNamedException
-
-