Package io.openems.edge.app.api
Class ModbusTcpApiReadWrite
java.lang.Object
io.openems.edge.core.appmanager.AbstractOpenemsApp<PROPERTY>
io.openems.edge.core.appmanager.AbstractOpenemsAppWithProps<ModbusTcpApiReadWrite,ModbusTcpApiReadWrite.Property,Type.Parameter.BundleParameter>
io.openems.edge.app.api.ModbusTcpApiReadWrite
- All Implemented Interfaces:
ComponentManagerSupplier
,ComponentUtilSupplier
,OpenemsApp
public class ModbusTcpApiReadWrite
extends AbstractOpenemsAppWithProps<ModbusTcpApiReadWrite,ModbusTcpApiReadWrite.Property,Type.Parameter.BundleParameter>
implements OpenemsApp
Describes a App for ReadWrite Modbus/TCP Api.
{
"appId":"App.Api.ModbusTcp.ReadWrite",
"alias":"Modbus/TCP-Api Read-Write",
"instanceId": UUID,
"image": base64,
"properties":{
"CONTROLLER_ID": "ctrlApiModbusTcp0",
"API_TIMEOUT": 60,
"COMPONENT_IDS": ["_sum", ...]
},
"dependencies": [
{
"key": "READ_ONLY",
"instanceId": UUID
}
],
"appDescriptor": {
"websiteUrl": AppDescriptor.getWebsiteUrl()
}
}
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class io.openems.edge.core.appmanager.AbstractOpenemsAppWithProps
AbstractOpenemsAppWithProps.Singleton<T>
-
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
ConstructorsConstructorDescriptionModbusTcpApiReadWrite
(ComponentManager componentManager, org.osgi.service.component.ComponentContext context, org.osgi.service.cm.ConfigurationAdmin cm, ComponentUtil componentUtil) -
Method Summary
Modifier and TypeMethodDescriptionprotected ThrowingTriFunction<ConfigurationTarget,
Map<ModbusTcpApiReadWrite.Property, com.google.gson.JsonElement>, Language, AppConfiguration, OpenemsError.OpenemsNamedException> Provides a factory forAppConfigurations
.protected ModbusTcpApiReadWrite
getApp()
Gets theAppDescriptor
of theOpenemsApp
.Gets theOpenemsAppCardinality
of theOpenemsApp
.Gets theOpenemsAppCategory
of theOpenemsApp
.protected ModbusTcpApiReadWrite.Property[]
Methods inherited from class io.openems.edge.core.appmanager.AbstractOpenemsAppWithProps
flags, getAppAssistant, getAppConfiguration, getBoolean, getBoolean, getEnum, getEnum, getId, getInt, getInt, getJsonArray, getProperties, getStatus, getString, getString, getString, getValidationErrors, getValueOrDefault
Methods inherited from class io.openems.edge.core.appmanager.AbstractOpenemsApp
assertCheckables, base64OfImage, createResourceBundle, fillUpProperties, getAppAssistant, getAppId, getAppPermissions, getComponentManager, getComponentUtil, getComponentWithFactoryId, getId, getImage, getName, getNullableTranslation, getPropertyByName, getShortName, getTranslation, getTranslationBundle, getValidateBuilder, getValidatorConfig, getValueOrDefault, hasProperty, installationValidation, validate
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, getAppPermissions, getImage, getName, getProperties, getShortName, getValidatorConfig, validate
-
Constructor Details
-
ModbusTcpApiReadWrite
public ModbusTcpApiReadWrite(ComponentManager componentManager, org.osgi.service.component.ComponentContext context, org.osgi.service.cm.ConfigurationAdmin cm, ComponentUtil componentUtil)
-
-
Method Details
-
getAppDescriptor
Description copied from interface:OpenemsApp
Gets theAppDescriptor
of theOpenemsApp
.- Specified by:
getAppDescriptor
in interfaceOpenemsApp
- Returns:
- the
AppDescriptor
-
getCategories
Description copied from interface:OpenemsApp
Gets theOpenemsAppCategory
of theOpenemsApp
.- Specified by:
getCategories
in interfaceOpenemsApp
- Returns:
- the category's
-
getCardinality
Description copied from interface:OpenemsApp
Gets theOpenemsAppCardinality
of theOpenemsApp
.- Specified by:
getCardinality
in interfaceOpenemsApp
- Returns:
- the usage
-
appPropertyConfigurationFactory
protected ThrowingTriFunction<ConfigurationTarget,Map<ModbusTcpApiReadWrite.Property, appPropertyConfigurationFactory()com.google.gson.JsonElement>, Language, AppConfiguration, OpenemsError.OpenemsNamedException> Description copied from class:AbstractOpenemsApp
Provides a factory forAppConfigurations
.- Specified by:
appPropertyConfigurationFactory
in classAbstractOpenemsApp<ModbusTcpApiReadWrite.Property>
- Returns:
- a
ThrowingFunction
that creates aAppConfiguration
from aMap
of configuration properties for a givenConfigurationTarget
in the specified language.
-
getApp
-
propertyValues
- Specified by:
propertyValues
in classAbstractOpenemsApp<ModbusTcpApiReadWrite.Property>
-