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 -
Method Summary
Modifier and TypeMethodDescriptiondefault Flag[]
flags()
GetsFlags
for thisOpenemsApp
.getAppAssistant
(User user) Gets theAppAssistant
for thisOpenemsApp
.getAppConfiguration
(ConfigurationTarget target, com.google.gson.JsonObject config, Language language) Gets theAppConfiguration
needed for theOpenemsApp
.Gets theAppDescriptor
of theOpenemsApp
.getAppId()
Gets the unique App-ID of theOpenemsApp
.Gets theOpenemsAppPermissions
of thisOpenemsApp
.Gets theOpenemsAppCardinality
of theOpenemsApp
.Gets theOpenemsAppCategory
of theOpenemsApp
.getImage()
Gets the image of theOpenemsApp
in Base64 encoding.Gets the name of theOpenemsApp
.Gets allOpenemsAppPropertyDefinition
of the app.getShortName
(Language language) Gets the short name of theOpenemsApp
.Gets theValidatorConfig
of thisOpenemsApp
.void
validate
(OpenemsAppInstance instance) Validate theOpenemsApp
.
-
Field Details
-
FALLBACK_IMAGE
- See Also:
-
-
Method Details
-
getAppAssistant
Gets theAppAssistant
for thisOpenemsApp
.- Parameters:
user
- theUser
- 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
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
-
getCategories
OpenemsAppCategory[] getCategories()Gets theOpenemsAppCategory
of theOpenemsApp
.- Returns:
- the category's
-
getImage
String getImage()Gets the image of theOpenemsApp
in Base64 encoding.- Returns:
- a image representing the
OpenemsApp
-
getName
Gets the name of theOpenemsApp
.- Parameters:
language
- the language of the name- Returns:
- a human readable name
-
getShortName
Gets the short name of theOpenemsApp
.- Parameters:
language
- the language of the name- Returns:
- a human readable short name; can be null
-
getCardinality
OpenemsAppCardinality getCardinality()Gets theOpenemsAppCardinality
of theOpenemsApp
.- Returns:
- the usage
-
getProperties
OpenemsAppPropertyDefinition[] getProperties()Gets allOpenemsAppPropertyDefinition
of the app.- Returns:
- the
OpenemsAppPropertyDefinitions
- Throws:
UnsupportedOperationException
- if not implemented
-
getValidatorConfig
ValidatorConfig getValidatorConfig()Gets theValidatorConfig
of thisOpenemsApp
.- Returns:
- the ValidatorConfig
-
getAppPermissions
OpenemsAppPermissions getAppPermissions()Gets theOpenemsAppPermissions
of thisOpenemsApp
.- Returns:
- the permissions
-
flags
GetsFlags
for thisOpenemsApp
. 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
Validate theOpenemsApp
.- Parameters:
instance
- the app instance- Throws:
OpenemsError.OpenemsNamedException
-