Class DeviceRegistryAasClient
java.lang.Object
de.iip_ecosphere.platform.support.iip_aas.SubmodelClient
de.iip_ecosphere.platform.support.iip_aas.SubmodelElementsCollectionClient
de.iip_ecosphere.platform.deviceMgt.registry.DeviceRegistryAasClient
- All Implemented Interfaces:
DeviceRegistryClient,DeviceRegistryOperations
public class DeviceRegistryAasClient
extends de.iip_ecosphere.platform.support.iip_aas.SubmodelElementsCollectionClient
implements DeviceRegistryClient
An AasClient which implements a
SubmodelElementsCollectionClient and provides easy
access to the registry functions through the AAS.- Author:
- Dennis Pidun, University of Hildesheim
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionRegister a specific device, which can be used for on-boarding.de.iip_ecosphere.platform.support.aas.SubmodelElementCollectionGet a specific device.Set<de.iip_ecosphere.platform.support.aas.SubmodelElementCollection> Collects all aas devices into a set.voidSend a heartbeat to device management.voidremoveDevice(String id) Removes a registered device, which can be used for off-boarding.voidsendTelemetry(String id, String telemetryData) Sends telemetry data to device management.Methods inherited from class de.iip_ecosphere.platform.support.iip_aas.SubmodelElementsCollectionClient
getLogger, getOperation, getProperty, getSubmodelElementCollectionMethods inherited from class de.iip_ecosphere.platform.support.iip_aas.SubmodelClient
checkNotNull, checkString, clear, getOperation, getProperty, getPropertyStringValue, getSubmodel, requestRefresh
-
Constructor Details
-
DeviceRegistryAasClient
public DeviceRegistryAasClient()Creates an instance.
-
-
Method Details
-
getDevices
Description copied from interface:DeviceRegistryClientCollects all aas devices into a set.- Specified by:
getDevicesin interfaceDeviceRegistryClient- Returns:
- a set of SubmodelElementCollections which contain information about the devices.
-
getDevice
Description copied from interface:DeviceRegistryClientGet a specific device.- Specified by:
getDevicein interfaceDeviceRegistryClient- Parameters:
resourceId- the resourceId the device is on- Returns:
- a SubmodelElementCollection containing information about the device
-
addDevice
Description copied from interface:DeviceRegistryOperationsRegister a specific device, which can be used for on-boarding.- Specified by:
addDevicein interfaceDeviceRegistryOperations- Parameters:
id- the id of the new deviceip- the ip of the new device- Returns:
- information about the results of the registration/on-boarding process
- Throws:
ExecutionException- if the operation fails
-
removeDevice
Description copied from interface:DeviceRegistryOperationsRemoves a registered device, which can be used for off-boarding.- Specified by:
removeDevicein interfaceDeviceRegistryOperations- Parameters:
id- the id of the new device- Throws:
ExecutionException- if the operation fails
-
imAlive
Description copied from interface:DeviceRegistryOperationsSend a heartbeat to device management. Should be called in a 10-30 seconds interval by the device.- Specified by:
imAlivein interfaceDeviceRegistryOperations- Parameters:
id- the id of the new device- Throws:
ExecutionException- if the operation fails
-
sendTelemetry
Description copied from interface:DeviceRegistryOperationsSends telemetry data to device management.- Specified by:
sendTelemetryin interfaceDeviceRegistryOperations- Parameters:
id- the id of the devicetelemetryData- the telemetry data (JSON format?)- Throws:
ExecutionException- if the operation fails
-