Package de.iip_ecosphere.platform.deviceMgt.registry

Interface DeviceRegistryOperations

All Known Subinterfaces:
DeviceRegistry, DeviceRegistryClient
All Known Implementing Classes:
AbstractDeviceRegistry, DeviceRegistryAasClient, DeviceRegistryProxy
public interface DeviceRegistryOperations
A service provider interface for registering devices in the IIP-Ecosphere platform and interact with them. All methods listed here are intended to be called by the devices via aas.
Author:
Dennis Pidun, University of Hildesheim

  • Method Details

    • addDevice

      DeviceRegistrationResponse addDevice(String id, String ip) throws ExecutionException
      Register a specific device, which can be used for on-boarding.
      Parameters:
      id - the id of the new device
      ip - the ip of the new device
      Returns:
      information about the results of the registration/on-boarding process
      Throws:
      ExecutionException - if the operation fails

    • removeDevice

      void removeDevice(String id) throws ExecutionException
      Removes a registered device, which can be used for off-boarding.
      Parameters:
      id - the id of the new device
      Throws:
      ExecutionException - if the operation fails

    • imAlive

      void imAlive(String id) throws ExecutionException
      Send a heartbeat to device management. Should be called in a 10-30 seconds interval by the device.
      Parameters:
      id - the id of the new device
      Throws:
      ExecutionException - if the operation fails

    • sendTelemetry

      void sendTelemetry(String id, String telemetryData) throws ExecutionException
      Sends telemetry data to device management.
      Parameters:
      id - the id of the device
      telemetryData - the telemetry data (JSON format?)
      Throws:
      ExecutionException - if the operation fails