Package de.iip_ecosphere.platform.ecsRuntime.deviceAas

Class YamlDeviceAasProvider

java.lang.Object

de.iip_ecosphere.platform.ecsRuntime.deviceAas.DeviceAasProvider

de.iip_ecosphere.platform.ecsRuntime.deviceAas.YamlDeviceAasProvider

public class YamlDeviceAasProvider
extends DeviceAasProvider

Creates an AAS for this device, deploys it to the platform AAS server and returns the address of the AAS. This may be useful for devices that do not provide an AAS by themselves. Resolution sequence:

1. Classpath, nameplate.yml
2. src/test/resources/nameplate.yml (for testing)
3. Classpath, deviceId.yml

Based on BaSyx / Generic Frame for Technical Data for Industrial Equipment in Manufacturing (Version 1.1) and for address a bit of ZVEI Digital Nameplate for industrial equipment V1.0.

Author:

Holger Eichelberger, SSE

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	YamlDeviceAasProvider.Descriptor	Implements the JSL descriptor.

Field Summary

Fields

Modifier and Type	Field	Description
private String	aasAddress
static final String	NAME_PROPERTY_PRODUCTIMAGE
static final String	SUBMODEL_NAMEPLATE

Constructor Summary

Constructors

Constructor	Description
YamlDeviceAasProvider()

Method Summary

Modifier and Type	Method	Description
String	getDeviceAasAddress()	Returns the device AAS address for this device.
String	getIdShort()	Returns the short ID of the device AAS.
String	getURN()	Returns the URN of the device AAS.
static de.iip_ecosphere.platform.support.iip_aas.NameplateSetup	obtainNameplateSetup()	Preliminary way to find the nameplate YML.

Methods inherited from class de.iip_ecosphere.platform.ecsRuntime.deviceAas.DeviceAasProvider

getInstance

Methods inherited from class java.lang.Object

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

Field Details

SUBMODEL_NAMEPLATE

public static final String SUBMODEL_NAMEPLATE

See Also:

• Constant Field Values

NAME_PROPERTY_PRODUCTIMAGE

public static final String NAME_PROPERTY_PRODUCTIMAGE

See Also:

• Constant Field Values

aasAddress

private String aasAddress

Constructor Details

YamlDeviceAasProvider

public YamlDeviceAasProvider()

Method Details

getURN

public String getURN()

Description copied from class: DeviceAasProvider

Returns the URN of the device AAS.

Specified by:

getURN in class DeviceAasProvider

Returns:

the (envisioned) URN, may be null, if there is no AAS

getIdShort

public String getIdShort()

Description copied from class: DeviceAasProvider

Returns the short ID of the device AAS.

Specified by:

getIdShort in class DeviceAasProvider

Returns:

the (envisioned) short ID, may be null, if there is no AAS

getDeviceAasAddress

public String getDeviceAasAddress()

Description copied from class: DeviceAasProvider

Returns the device AAS address for this device.

Specified by:

getDeviceAasAddress in class DeviceAasProvider

Returns:

the device AAS address, may be null if there is no AAS

obtainNameplateSetup

public static de.iip_ecosphere.platform.support.iip_aas.NameplateSetup obtainNameplateSetup()
                                                                                     throws IOException

Preliminary way to find the nameplate YML.

Returns:

the setup representing the nameplate YML

Throws:

IOException - if the setup file cannot be read