Package io.openems.edge.app.api

Class MqttApi

java.lang.Object

io.openems.edge.core.appmanager.AbstractOpenemsApp<MqttApi.Property>

io.openems.edge.core.appmanager.AbstractEnumOpenemsApp<MqttApi.Property>

io.openems.edge.app.api.MqttApi

All Implemented Interfaces:

ComponentManagerSupplier, ComponentUtilSupplier, OpenemsApp

public class MqttApi
extends AbstractEnumOpenemsApp<MqttApi.Property>
implements OpenemsApp

Describes a App for MQTT Api.

  {
    "appId":"App.Api.Mqtt",
    "alias":"MQTT-Api",
    "instanceId": UUID,
    "image": base64,
    "properties":{
        "CONTROLLER_ID": "ctrlControllerApiMqtt0",
        "USERNAME": "username",
        "PASSWORD": "******",
        "CLIENT_ID": "edge0",
        "URI": "tcp://localhost:1883"
    },
    "appDescriptor": {
        "websiteUrl": AppDescriptor.getWebsiteUrl()
    }
  }
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	MqttApi.Property

Field Summary

Fields inherited from class io.openems.edge.core.appmanager.AbstractOpenemsApp

cm, componentContext, componentManager, componentUtil

Fields inherited from interface io.openems.edge.core.appmanager.OpenemsApp

FALLBACK_IMAGE

Constructor Summary

Constructors

Constructor	Description
MqttApi(ComponentManager componentManager, org.osgi.service.component.ComponentContext context, org.osgi.service.cm.ConfigurationAdmin cm, ComponentUtil componentUtil)

Method Summary

Modifier and Type	Method	Description
protected ThrowingTriFunction<ConfigurationTarget,EnumMap<MqttApi.Property,com.google.gson.JsonElement>,Language,AppConfiguration,OpenemsError.OpenemsNamedException>	appConfigurationFactory()
AppAssistant	getAppAssistant(Language language)
AppDescriptor	getAppDescriptor(OpenemsEdgeOem oem)	Gets the AppDescriptor 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.
protected Class<MqttApi.Property>	getPropertyClass()

Methods inherited from class io.openems.edge.core.appmanager.AbstractEnumOpenemsApp

appPropertyConfigurationFactory, getId, getValueOrDefault, propertyValues

Methods inherited from class io.openems.edge.core.appmanager.AbstractOpenemsApp

base64OfImage, createResourceBundle, fillUpProperties, getAppAssistant, getAppConfiguration, getAppId, getComponentManager, getComponentUtil, getComponentWithFactoryId, getId, getImage, getName, getNullableTranslation, getProperties, getPropertyByName, getShortName, getTranslation, getTranslationBundle, getValidateBuilder, getValidatorConfig, getValueOrDefault, hasProperty, installationValidation

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.openems.edge.core.appmanager.OpenemsApp

flags, getAppAssistant, getAppConfiguration, getAppId, getImage, getName, getProperties, getShortName, getValidatorConfig

Constructor Details

MqttApi

public MqttApi(ComponentManager componentManager,
 org.osgi.service.component.ComponentContext context,
 org.osgi.service.cm.ConfigurationAdmin cm,
 ComponentUtil componentUtil)

Method Details

getAppAssistant

public AppAssistant getAppAssistant(Language language)

Overrides:

getAppAssistant in class AbstractOpenemsApp<MqttApi.Property>

getAppDescriptor

public AppDescriptor getAppDescriptor(OpenemsEdgeOem oem)

Description copied from interface: OpenemsApp

Gets the AppDescriptor of the OpenemsApp.

Specified by:

getAppDescriptor in interface OpenemsApp

Parameters:

oem - the OpenemsEdgeOem

Returns:

the AppDescriptor

getCategories

public OpenemsAppCategory[] getCategories()

Description copied from interface: OpenemsApp

Gets the OpenemsAppCategory of the OpenemsApp.

Specified by:

getCategories in interface OpenemsApp

Returns:

the category's

getCardinality

public OpenemsAppCardinality getCardinality()

Description copied from interface: OpenemsApp

Gets the OpenemsAppCardinality of the OpenemsApp.

Specified by:

getCardinality in interface OpenemsApp

Returns:

the usage

appConfigurationFactory

protected ThrowingTriFunction<ConfigurationTarget,EnumMap<MqttApi.Property,com.google.gson.JsonElement>,Language,AppConfiguration,OpenemsError.OpenemsNamedException> appConfigurationFactory()

Specified by:

appConfigurationFactory in class AbstractEnumOpenemsApp<MqttApi.Property>

getPropertyClass

protected Class<MqttApi.Property> getPropertyClass()

Specified by:

getPropertyClass in class AbstractEnumOpenemsApp<MqttApi.Property>

getAppPermissions

public OpenemsAppPermissions getAppPermissions()

Description copied from interface: OpenemsApp

Gets the OpenemsAppPermissions of this OpenemsApp.

Specified by:

getAppPermissions in interface OpenemsApp

Overrides:

getAppPermissions in class AbstractOpenemsApp<MqttApi.Property>

Returns:

the permissions