Package io.openems.common.oem

Class DummyOpenemsEdgeOem

java.lang.Object

io.openems.common.oem.DummyOpenemsEdgeOem

All Implemented Interfaces:

OpenemsEdgeOem

Direct Known Subclasses:

OpenemsEdgeOemImpl

public class DummyOpenemsEdgeOem
extends Object
implements OpenemsEdgeOem

A default OpenemsEdgeOem for OpenEMS Edge.

Nested Class Summary

Nested classes/interfaces inherited from interface io.openems.common.oem.OpenemsEdgeOem

OpenemsEdgeOem.SystemUpdateParams

Constructor Summary

Constructors

Constructor	Description
DummyOpenemsEdgeOem()

Method Summary

Modifier and Type	Method	Description
static void	assertAllWebsiteUrlsSet(OpenemsEdgeOem oem)	Helper method for JUnit tests.
String	getAppWebsiteUrl(String appId)	Gets the Website-URL for the given App-ID.
String	getBackendApiUrl()	The Websocket URL for OpenEMS Backend.
String	getInfluxdbTag()	The measurement Tag used to write data to InfluxDB.
String	getManufacturer()	The manufacturer of the device that is running OpenEMS Edge.
String	getManufacturerEmsSerialNumber()	The Energy-Management-System serial number of the device.
String	getManufacturerModel()	The model identifier of the device.
String	getManufacturerOptions()	The options of the device.
String	getManufacturerSerialNumber()	The serial number of the device.
String	getManufacturerVersion()	The version of the device.
OpenemsEdgeOem.SystemUpdateParams	getSystemUpdateParams()	The parameters for the integrated OpenEMS Edge System-Update feature.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.openems.common.oem.OpenemsEdgeOem

getEntsoeToken, getExchangeRateAccesskey, getKacoBlueplanetHybrid10IdentKey

Constructor Details

DummyOpenemsEdgeOem

public DummyOpenemsEdgeOem()

Method Details

getManufacturer

public String getManufacturer()

Description copied from interface: OpenemsEdgeOem

The manufacturer of the device that is running OpenEMS Edge.

Note: this should be max. 32 ASCII characters long

Specified by:

getManufacturer in interface OpenemsEdgeOem

Returns:

the value

getManufacturerModel

public String getManufacturerModel()

Description copied from interface: OpenemsEdgeOem

The model identifier of the device.

Note: this should be max. 32 ASCII characters long

Specified by:

getManufacturerModel in interface OpenemsEdgeOem

Returns:

the value

getManufacturerOptions

public String getManufacturerOptions()

Description copied from interface: OpenemsEdgeOem

The options of the device.

Note: this should be max. 32 ASCII characters long

Specified by:

getManufacturerOptions in interface OpenemsEdgeOem

Returns:

the value

getManufacturerVersion

public String getManufacturerVersion()

Description copied from interface: OpenemsEdgeOem

The version of the device.

Note: this should be max. 32 ASCII characters long

Specified by:

getManufacturerVersion in interface OpenemsEdgeOem

Returns:

the value

getManufacturerSerialNumber

public String getManufacturerSerialNumber()

Description copied from interface: OpenemsEdgeOem

The serial number of the device.

Note: this should be max. 32 ASCII characters long

Specified by:

getManufacturerSerialNumber in interface OpenemsEdgeOem

Returns:

the value

getManufacturerEmsSerialNumber

public String getManufacturerEmsSerialNumber()

Description copied from interface: OpenemsEdgeOem

The Energy-Management-System serial number of the device.

Note: this should be max. 32 ASCII characters long

Specified by:

getManufacturerEmsSerialNumber in interface OpenemsEdgeOem

Returns:

the value

getBackendApiUrl

public String getBackendApiUrl()

Description copied from interface: OpenemsEdgeOem

The Websocket URL for OpenEMS Backend.

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

Specified by:

getBackendApiUrl in interface OpenemsEdgeOem

Returns:

the value

getInfluxdbTag

public String getInfluxdbTag()

Description copied from interface: OpenemsEdgeOem

The measurement Tag used to write data to InfluxDB.

Note: this value defaults to "edge"

Specified by:

getInfluxdbTag in interface OpenemsEdgeOem

Returns:

the value

getSystemUpdateParams

public OpenemsEdgeOem.SystemUpdateParams getSystemUpdateParams()

Description copied from interface: OpenemsEdgeOem

The parameters for the integrated OpenEMS Edge System-Update feature.

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

Specified by:

getSystemUpdateParams in interface OpenemsEdgeOem

Returns:

the record

getAppWebsiteUrl

public String getAppWebsiteUrl(String appId)

Description copied from interface: OpenemsEdgeOem

Gets the Website-URL for the given App-ID.

Specified by:

getAppWebsiteUrl in interface OpenemsEdgeOem

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

assertAllWebsiteUrlsSet

public static void assertAllWebsiteUrlsSet(OpenemsEdgeOem oem)
                                    throws OpenemsException

Helper method for JUnit tests. Tests if the given OpenemsEdgeOem provides the same Website-URLs as DummyOpenemsEdgeOem - (i.e. all are not-null. See getAppWebsiteUrl(String)

Parameters:

oem - the OpenemsEdgeOem

Throws:

OpenemsException