Package io.openems.edge.app.heat

Class HeatPump

java.lang.Object

io.openems.edge.core.appmanager.AbstractOpenemsApp<PROPERTY>

io.openems.edge.core.appmanager.AbstractOpenemsAppWithProps<HeatPump,HeatPump.Property,HeatPump.HeatPumpParameter>

io.openems.edge.app.heat.HeatPump

All Implemented Interfaces:

ComponentManagerSupplier, ComponentUtilSupplier, OpenemsApp

public class HeatPump
extends AbstractOpenemsAppWithProps<HeatPump,HeatPump.Property,HeatPump.HeatPumpParameter>
implements OpenemsApp

Describes a App for a Heat Pump.

  {
    "appId":"App.Heat.HeatPump",
    "alias":""SG-Ready" Wärmepumpe",
    "instanceId": UUID,
    "image": base64,
    "properties":{
        "CTRL_IO_HEAT_PUMP_ID": "ctrlIoHeatPump0",
        "OUTPUT_CHANNEL_1": "io0/Relay2",
        "OUTPUT_CHANNEL_2": "io0/Relay3"
    },
    "dependencies": [
        {
                "key": "RELAY",
                "instanceId": UUID
        }
    ],
    "appDescriptor": {
        "websiteUrl": AppDescriptor.getWebsiteUrl()
    }
  }
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	HeatPump.HeatPumpParameter
static enum	HeatPump.Property

Nested 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

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected ThrowingTriFunction<ConfigurationTarget,Map<HeatPump.Property,com.google.gson.JsonElement>,Language,AppConfiguration,OpenemsError.OpenemsNamedException>	appPropertyConfigurationFactory()	Provides a factory for AppConfigurations.
protected HeatPump	getApp()
AppDescriptor	getAppDescriptor()	Gets the AppDescriptor of the OpenemsApp.
OpenemsAppCardinality	getCardinality()	Gets the OpenemsAppCardinality of the OpenemsApp.
OpenemsAppCategory[]	getCategories()	Gets the OpenemsAppCategory of the OpenemsApp.
ValidatorConfig.Builder	getValidateBuilder()
protected HeatPump.Property[]	propertyValues()

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, 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

HeatPump

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

Method Details

appPropertyConfigurationFactory

protected ThrowingTriFunction<ConfigurationTarget,Map<HeatPump.Property,com.google.gson.JsonElement>,Language,AppConfiguration,OpenemsError.OpenemsNamedException> appPropertyConfigurationFactory()

Description copied from class: AbstractOpenemsApp

Provides a factory for AppConfigurations.

Specified by:

appPropertyConfigurationFactory in class AbstractOpenemsApp<HeatPump.Property>

Returns:

a ThrowingFunction that creates a AppConfiguration from a Map of configuration properties for a given ConfigurationTarget in the specified language.

getAppDescriptor

public AppDescriptor getAppDescriptor()

Description copied from interface: OpenemsApp

Gets the AppDescriptor of the OpenemsApp.

Specified by:

getAppDescriptor in interface OpenemsApp

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

getValidateBuilder

public ValidatorConfig.Builder getValidateBuilder()

Overrides:

getValidateBuilder in class AbstractOpenemsApp<HeatPump.Property>

getCardinality

public OpenemsAppCardinality getCardinality()

Description copied from interface: OpenemsApp

Gets the OpenemsAppCardinality of the OpenemsApp.

Specified by:

getCardinality in interface OpenemsApp

Returns:

the usage

getApp

protected HeatPump getApp()

Specified by:

getApp in class AbstractOpenemsAppWithProps<HeatPump,HeatPump.Property,HeatPump.HeatPumpParameter>

propertyValues

protected HeatPump.Property[] propertyValues()

Specified by:

propertyValues in class AbstractOpenemsApp<HeatPump.Property>