Package io.openems.edge.timedata.rrd4j

Class Rrd4jReadHandler

java.lang.Object

io.openems.edge.timedata.rrd4j.Rrd4jReadHandler

public class Rrd4jReadHandler
extends Object

Constructor Summary

Constructors

Constructor	Description
Rrd4jReadHandler()

Method Summary

Modifier and Type	Method	Description
protected static List<org.rrd4j.core.Archive>	getArchivesSortedByArcStep(org.rrd4j.core.RrdDb db)	Gets a list of the archives from the given database, sorted by their arc step size ascending.
CompletableFuture<Optional<Object>>	getLatestValue(String rrdDbId, ChannelAddress channelAddress)	Gets the latest known value for the given ChannelAddress.
Timeranges	getResendTimeranges(String rrdDbId, ChannelAddress notSendChannel, long lastResendTimestamp, boolean debugMode)	Gets the Timeranges to data which got not send.
SortedMap<ZonedDateTime,SortedMap<ChannelAddress,com.google.gson.JsonElement>>	queryHistoricData(String rrdDbId, ZonedDateTime fromDate, ZonedDateTime toDate, Set<ChannelAddress> channels, Resolution resolution, boolean debugMode)	Queries historic data.
SortedMap<ChannelAddress,com.google.gson.JsonElement>	queryHistoricEnergy(String rrdDbId, ZonedDateTime fromDate, ZonedDateTime toDate, Set<ChannelAddress> channels, boolean debugMode)	Queries historic energy.
SortedMap<ZonedDateTime,SortedMap<ChannelAddress,com.google.gson.JsonElement>>	queryHistoricEnergyPerPeriod(String rrdDbId, ZonedDateTime fromDate, ZonedDateTime toDate, Set<ChannelAddress> channels, Resolution resolution, boolean debugMode)	Queries historic energy per period.
SortedMap<Long,SortedMap<ChannelAddress,com.google.gson.JsonElement>>	queryResendData(String rrdDbId, ZonedDateTime fromDate, ZonedDateTime toDate, Set<ChannelAddress> channels, boolean debugMode)	Queries data to resend.

Methods inherited from class java.lang.Object

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

Constructor Details

Rrd4jReadHandler

public Rrd4jReadHandler()

Method Details

getArchivesSortedByArcStep

protected static List<org.rrd4j.core.Archive> getArchivesSortedByArcStep(org.rrd4j.core.RrdDb db)
                                                                  throws IOException

Gets a list of the archives from the given database, sorted by their arc step size ascending. The step size can be obtained with Archive.getArcStep().

Parameters:

db - the archives of which database

Returns:

a sorted list of the archives

Throws:

IOException - Thrown in case of I/O error.

getResendTimeranges

public Timeranges getResendTimeranges(String rrdDbId,
 ChannelAddress notSendChannel,
 long lastResendTimestamp,
 boolean debugMode)
                               throws OpenemsError.OpenemsNamedException

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

Parameters:

rrdDbId - the id of the rrdb

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

lastResendTimestamp - the timstamp of the last resend

debugMode - if debugMode is active

Returns:

the Timeranges

Throws:

OpenemsError.OpenemsNamedException - on error

queryResendData

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

Queries data to resend.

Parameters:

rrdDbId - the id of the rrdb

fromDate - the start date

toDate - the end date

channels - the channels to resend

debugMode - if debugMode is active

Returns:

the query result; possibly null

Throws:

OpenemsError.OpenemsNamedException - on error

queryHistoricData

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

Queries historic data.

Parameters:

rrdDbId - the id of the rrdb

fromDate - the From-Date

toDate - the To-Date

channels - the Channels

resolution - the Resolution

debugMode - if debugMode is active

Returns:

the query result; possibly null

Throws:

OpenemsError.OpenemsNamedException

queryHistoricEnergy

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

Queries historic energy.

Parameters:

rrdDbId - the id of the rrdb

fromDate - the From-Date

toDate - the To-Date

channels - the Channels

debugMode - if debugMode is active

Returns:

the query result; possibly null

Throws:

OpenemsError.OpenemsNamedException

queryHistoricEnergyPerPeriod

public SortedMap<ZonedDateTime,SortedMap<ChannelAddress,com.google.gson.JsonElement>> queryHistoricEnergyPerPeriod(String rrdDbId,
 ZonedDateTime fromDate,
 ZonedDateTime toDate,
 Set<ChannelAddress> channels,
 Resolution resolution,
 boolean debugMode)
                                                                                                            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.

Parameters:

rrdDbId - the id of the rrdb

fromDate - the From-Date

toDate - the To-Date

channels - the Channels

resolution - the Resolution

debugMode - if debugMode is active

Returns:

the query result; possibly null

Throws:

OpenemsError.OpenemsNamedException

getLatestValue

public CompletableFuture<Optional<Object>> getLatestValue(String rrdDbId,
 ChannelAddress channelAddress)

Gets the latest known value for the given ChannelAddress.

Parameters:

rrdDbId - the id of the rrdb

channelAddress - the ChannelAddress to be queried

Returns:

the latest known value or Empty