Package io.openems.backend.core.timedatamanager

Class TimedataManagerImpl

java.lang.Object

io.openems.backend.common.component.AbstractOpenemsBackendComponent

io.openems.backend.core.timedatamanager.TimedataManagerImpl

All Implemented Interfaces:

BackendTimedata, TimedataManager, CommonTimedataService

public class TimedataManagerImpl
extends AbstractOpenemsBackendComponent
implements TimedataManager

Constructor Summary

Constructors

Constructor	Description
TimedataManagerImpl()

Method Summary

Modifier and Type	Method	Description
void	activate(io.openems.backend.core.timedatamanager.Config config)	Activates the component.
protected void	addTimedata(Timedata timedata)
SortedMap<ChannelAddress,com.google.gson.JsonElement>	queryFirstValueBefore(String edgeId, ZonedDateTime date, Set<ChannelAddress> channels)	Queries the latest values which are before the given ZonedDateTime.
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.
protected void	removeTimedata(Timedata timedata)
void	write(String edgeId, AggregatedDataNotification data)	Sends the data points to the Timedata service.
void	write(String edgeId, ResendDataNotification data)	Sends the data points to the Timedata service.
void	write(String edgeId, TimestampedDataNotification data)	Sends the data points to the Timedata service.

Methods inherited from class io.openems.backend.common.component.AbstractOpenemsBackendComponent

getName, logDebug, logDebug, logError, logError, logInfo, logInfo, logWarn, logWarn

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

Constructor Details

TimedataManagerImpl

public TimedataManagerImpl()

Method Details

addTimedata

protected void addTimedata(Timedata timedata)

removeTimedata

protected void removeTimedata(Timedata timedata)

activate

public void activate(io.openems.backend.core.timedatamanager.Config config)

Activates the component.

Parameters:

config - the Configuration

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

Queries historic data.

The TimedataManager implementation never returns null, but throws an Exception instead

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

Queries historic energy.

The TimedataManager implementation never returns null, but throws an Exception instead

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

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.

The TimedataManager implementation never returns null, but throws an Exception instead

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

queryFirstValueBefore

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

Description copied from interface: BackendTimedata

Queries the latest values which are before the given ZonedDateTime.

Specified by:

queryFirstValueBefore in interface BackendTimedata

Parameters:

edgeId - the id of the edge

date - the bounding date exclusive

channels - the channels

Returns:

the channel values

Throws:

OpenemsError.OpenemsNamedException - on error

write

public void write(String edgeId,
 AggregatedDataNotification data)

Description copied from interface: BackendTimedata

Sends the data points to the Timedata service.

Specified by:

write in interface BackendTimedata

Parameters:

edgeId - The unique Edge-ID

data - Table of timestamp (epoch in milliseconds), Channel-Address and the Channel value as AggregatedData. Sorted by timestamp.

write

public void write(String edgeId,
 TimestampedDataNotification data)

Description copied from interface: BackendTimedata

Sends the data points to the Timedata service.

Specified by:

write in interface BackendTimedata

Parameters:

edgeId - The unique Edge-ID

data - Table of timestamp (epoch in milliseconds), Channel-Address and the Channel value as JsonElement. Sorted by timestamp.

write

public void write(String edgeId,
 ResendDataNotification data)

Description copied from interface: BackendTimedata

Sends the data points to the Timedata service.

Specified by:

write in interface BackendTimedata

Parameters:

edgeId - The unique Edge-ID

data - Table of timestamp (epoch in milliseconds), Channel-Address and the Channel value as ResendData. Sorted by timestamp.