Package net.solarnetwork.node.service

Interface DeviceInfoProvider

All Known Subinterfaces:
DatumDataSource, MultiDatumDataSource
All Known Implementing Classes:
LocationDatumDataSource
public interface DeviceInfoProvider
API for something that can provide device info.
Since:
1.90
Version:
1.0
Author:
matt

  • Method Summary

    Modifier and Type
    Method
    Description
    default boolean
    canPublishDeviceInfo()
    Get the publish setting for the device info.
    default net.solarnetwork.domain.DeviceInfo
    deviceInfo()
    Get a DeviceInfo instance.
    default String
    deviceInfoSourceId()
    Get the source ID to publish device info under.

  • Method Details

    • deviceInfo

      default net.solarnetwork.domain.DeviceInfo deviceInfo()
      Get a DeviceInfo instance.

      This method returns null. Extending classes must override to provide device info metadata.

      Returns:
      the device info, or null if none available

    • deviceInfoSourceId

      default String deviceInfoSourceId()
      Get the source ID to publish device info under.

      This method returns null. Extending classes must override to provide a source ID value if they wish to publish device info metadata.

      Returns:
      the source ID to publish device info metadata to

    • canPublishDeviceInfo

      default boolean canPublishDeviceInfo()
      Get the publish setting for the device info.
      Returns:
      true if the device info can be published, typically as metadata; defaults to true