Package io.openems.common.oem

Interface OpenemsEdgeOem

All Known Implementing Classes:
DummyOpenemsEdgeOem, OpenemsEdgeOemImpl
public interface OpenemsEdgeOem

  • Method Details

    • getManufacturer

      String getManufacturer()
      The manufacturer of the device that is running OpenEMS Edge.

      Note: this should be max. 32 ASCII characters long

      Returns:
      the value

    • getManufacturerModel

      String getManufacturerModel()
      The model identifier of the device.

      Note: this should be max. 32 ASCII characters long

      Returns:
      the value

    • getManufacturerOptions

      String getManufacturerOptions()
      The options of the device.

      Note: this should be max. 32 ASCII characters long

      Returns:
      the value

    • getManufacturerVersion

      String getManufacturerVersion()
      The version of the device.

      Note: this should be max. 32 ASCII characters long

      Returns:
      the value

    • getManufacturerSerialNumber

      String getManufacturerSerialNumber()
      The serial number of the device.

      Note: this should be max. 32 ASCII characters long

      Returns:
      the value

    • getManufacturerEmsSerialNumber

      String getManufacturerEmsSerialNumber()
      The Energy-Management-System serial number of the device.

      Note: this should be max. 32 ASCII characters long

      Returns:
      the value

    • getBackendApiUrl

      String getBackendApiUrl()
      The Websocket URL for OpenEMS Backend.

      Note: this value usually starts with "ws://" or "wss://"

      Returns:
      the value

    • getInfluxdbTag

      default String getInfluxdbTag()
      The measurement Tag used to write data to InfluxDB.

      Note: this value defaults to "edge"

      Returns:
      the value

    • getSystemUpdateParams

      OpenemsEdgeOem.SystemUpdateParams getSystemUpdateParams()
      The parameters for the integrated OpenEMS Edge System-Update feature.

      See 'Host' in 'io.openems.edge.common' for details

      Returns:
      the record

    • getAppWebsiteUrl

      String getAppWebsiteUrl(String appId)
      Gets the Website-URL for the given App-ID.
      Parameters:
      appId - the App-ID
      Returns:
      • a proper URL (e.g. https://...)
      • an empty String: App is defined, but no WebsiteUrl is available; or
      • null: App is undefined

    • getKacoBlueplanetHybrid10IdentKey

      default String getKacoBlueplanetHybrid10IdentKey()
      Gets the OEM IdentKey for Kaco.BlueplanetHybrid10.Core.
      Returns:
      the value

    • getEntsoeToken

      default String getEntsoeToken()
      Gets the OEM Token for TimeOfUseTariff.ENTSO-E.
      Returns:
      the value

    • getExchangeRateAccesskey

      default String getExchangeRateAccesskey()
      Gets the OEM Access-Key for Exchangerate.host (used by TimeOfUseTariff.ENTSO-E).
      Returns:
      the value