Interface DeviceInfo

All Known Implementing Classes:
BasicDeviceInfo

public interface DeviceInfo
Static information about a device, such as manufacturer name, model number, and so on.

All properties are considered optional, and methods may return null if a property is not known.

Since:
1.75
Version:
1.0
Author:
matt
  • Field Details

    • DEVICE_INFO_METADATA_KEY

      static final String DEVICE_INFO_METADATA_KEY
      A property metadata key to use for device info data.
      See Also:
  • Method Details

    • getName

      String getName()
      Get the name of the device.
      Returns:
      the name
    • getManufacturer

      String getManufacturer()
      Get the name of the manufacturer.
      Returns:
      the manufacturer
    • getModelName

      String getModelName()
      Get the model name.
      Returns:
      the model name
    • getVersion

      String getVersion()
      Get the model revision.
      Returns:
      the version
    • getSerialNumber

      String getSerialNumber()
      Get the device serial number.
      Returns:
      the device serial number
    • getManufactureDate

      LocalDate getManufactureDate()
      Get the device manufacture date.
      Returns:
      the manufacture date
    • getDeviceAddress

      String getDeviceAddress()
      Get a deployment-specific location identifier, such as IP address or Modbus unit ID.
      Returns:
      the device address