Package io.openems.edge.timedata.test

Class DummyTimedata

java.lang.Object

io.openems.edge.common.component.AbstractOpenemsComponent

io.openems.edge.common.test.AbstractDummyOpenemsComponent<DummyTimedata>

io.openems.edge.timedata.test.DummyTimedata

All Implemented Interfaces:

CommonTimedataService, OpenemsComponent, Timedata

public class DummyTimedata
extends AbstractDummyOpenemsComponent<DummyTimedata>
implements Timedata

Provides a simple, simulated Timedata component that can be used together with the OpenEMS Component test framework.

Nested Class Summary

Nested classes/interfaces inherited from interface io.openems.edge.common.component.OpenemsComponent

OpenemsComponent.ChannelId

Nested classes/interfaces inherited from interface io.openems.edge.timedata.api.Timedata

Timedata.ChannelId

Constructor Summary

Constructors

Constructor	Description
DummyTimedata(String id)

Method Summary

Modifier and Type	Method	Description
void	add(ZonedDateTime timestamp, ChannelAddress channelAddress, com.google.gson.JsonElement value)	Adds a value to the Dummy Timedata.
void	add(ZonedDateTime timestamp, ChannelAddress channelAddress, Integer value)	Adds a value to the Dummy Timedata.
CompletableFuture<Optional<Object>>	getLatestValue(ChannelAddress channelAddress)	Gets the latest known value for the given ChannelAddress.
Timeranges	getResendTimeranges(ChannelAddress notSendChannel, long lastResendTimestamp)	Gets the Timeranges to data which got not send.
SortedMap<ZonedDateTime,SortedMap<ChannelAddress,com.google.gson.JsonElement>>	queryHistoricData(String edgeId, ZonedDateTime fromDate, ZonedDateTime toDate, Set<ChannelAddress> channels, Resolution resolution)	Queries historic data.
SortedMap<ChannelAddress,com.google.gson.JsonElement>	queryHistoricEnergy(String edgeId, ZonedDateTime fromDate, ZonedDateTime toDate, Set<ChannelAddress> channels)	Queries historic energy.
SortedMap<ZonedDateTime,SortedMap<ChannelAddress,com.google.gson.JsonElement>>	queryHistoricEnergyPerPeriod(String edgeId, ZonedDateTime fromDate, ZonedDateTime toDate, Set<ChannelAddress> channels, Resolution resolution)	Queries historic energy per period.
SortedMap<Long,SortedMap<ChannelAddress,com.google.gson.JsonElement>>	queryResendData(ZonedDateTime fromDate, ZonedDateTime toDate, Set<ChannelAddress> channels)	Queries data to resend.
protected DummyTimedata	self()

Methods inherited from class io.openems.edge.common.component.AbstractOpenemsComponent

_channel, activate, activate, addChannel, addChannels, addChannels, alias, channels, deactivate, getComponentContext, id, isEnabled, logDebug, logError, logInfo, logWarn, modified, removeChannel

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.timedata.CommonTimedataService

handleQueryHistoricTimeseriesExportXlxsRequest, queryHistoricData

Methods inherited from interface io.openems.edge.common.component.OpenemsComponent

_channel, _getChannelAs, alias, channel, channel, channels, debugLog, getComponentContext, getState, getStateChannel, hasFaults, id, isEnabled, serviceFactoryPid, servicePid

Constructor Details

DummyTimedata

public DummyTimedata(String id)

Method Details

self

protected DummyTimedata self()

Specified by:

self in class AbstractDummyOpenemsComponent<DummyTimedata>

add

public void add(ZonedDateTime timestamp,
 ChannelAddress channelAddress,
 Integer value)

Adds a value to the Dummy Timedata.

Parameters:

timestamp - the ZonedDateTime

channelAddress - the ChannelAddress

value - the value as Integer

add

public void add(ZonedDateTime timestamp,
 ChannelAddress channelAddress,
 com.google.gson.JsonElement value)

Adds a value to the Dummy Timedata.

Parameters:

timestamp - the ZonedDateTime

channelAddress - the ChannelAddress

value - the value as JsonElement

queryHistoricData

public SortedMap<ZonedDateTime,SortedMap<ChannelAddress,com.google.gson.JsonElement>> queryHistoricData(String edgeId,
 ZonedDateTime fromDate,
 ZonedDateTime toDate,
 Set<ChannelAddress> channels,
 Resolution resolution)
                                                                                                 throws OpenemsError.OpenemsNamedException

Description copied from interface: CommonTimedataService

Queries historic data.

Specified by:

queryHistoricData in interface CommonTimedataService

Parameters:

edgeId - the Edge-ID; or null query all

fromDate - the From-Date

toDate - the To-Date

channels - the Channels

resolution - the Resolution

Returns:

the query result; possibly null

Throws:

OpenemsError.OpenemsNamedException

queryHistoricEnergy

public SortedMap<ChannelAddress,com.google.gson.JsonElement> queryHistoricEnergy(String edgeId,
 ZonedDateTime fromDate,
 ZonedDateTime toDate,
 Set<ChannelAddress> channels)
                                                                          throws OpenemsError.OpenemsNamedException

Description copied from interface: CommonTimedataService

Queries historic energy.

Specified by:

queryHistoricEnergy in interface CommonTimedataService

Parameters:

edgeId - the Edge-ID; or null query all

fromDate - the From-Date

toDate - the To-Date

channels - the Channels

Returns:

the query result; possibly null

Throws:

OpenemsError.OpenemsNamedException

queryHistoricEnergyPerPeriod

public SortedMap<ZonedDateTime,SortedMap<ChannelAddress,com.google.gson.JsonElement>> queryHistoricEnergyPerPeriod(String edgeId,
 ZonedDateTime fromDate,
 ZonedDateTime toDate,
 Set<ChannelAddress> channels,
 Resolution resolution)
                                                                                                            throws OpenemsError.OpenemsNamedException

Description copied from interface: CommonTimedataService

Queries historic energy per period.

This is for use-cases where you want to get the energy for each period (with Resolution) per Channel, e.g. to visualize energy in a histogram chart. For each period the energy is calculated by subtracting first value of the period from the last value of the period.

Specified by:

queryHistoricEnergyPerPeriod in interface CommonTimedataService

Parameters:

edgeId - the Edge-ID; or null query all

fromDate - the From-Date

toDate - the To-Date

channels - the Channels

resolution - the Resolution

Returns:

the query result; possibly null

Throws:

OpenemsError.OpenemsNamedException

queryResendData

public SortedMap<Long,SortedMap<ChannelAddress,com.google.gson.JsonElement>> queryResendData(ZonedDateTime fromDate,
 ZonedDateTime toDate,
 Set<ChannelAddress> channels)
                                                                                      throws OpenemsError.OpenemsNamedException

Description copied from interface: Timedata

Queries data to resend.

Specified by:

queryResendData in interface Timedata

Parameters:

fromDate - the start date

toDate - the end date

channels - the channels to resend

Returns:

the query result; possibly null

Throws:

OpenemsError.OpenemsNamedException - on error

getLatestValue

public CompletableFuture<Optional<Object>> getLatestValue(ChannelAddress channelAddress)

Description copied from interface: Timedata

Gets the latest known value for the given ChannelAddress.

Specified by:

getLatestValue in interface Timedata

Parameters:

channelAddress - the ChannelAddress to be queried

Returns:

the latest known value or Empty

getResendTimeranges

public Timeranges getResendTimeranges(ChannelAddress notSendChannel,
 long lastResendTimestamp)
                               throws OpenemsError.OpenemsNamedException

Description copied from interface: Timedata

Gets the Timeranges to data which got not send. The not send data gets determined with the notSendChannel and the lastResendTimestamp.

Specified by:

getResendTimeranges in interface Timedata

Parameters:

notSendChannel - the channel with the timestamps where the data got not send

lastResendTimestamp - the timestamp of the last resend; negativ if there is no lastResendTimestamp

Returns:

the Timeranges

Throws:

OpenemsError.OpenemsNamedException - on error