Package io.openems.common.timedata

Interface CommonTimedataService

All Known Subinterfaces:

BackendTimedata, SimulatorApp, SimulatorTimedata, Timedata, Timedata, TimedataInfluxDb, TimedataManager, TimedataRrd4j

All Known Implementing Classes:

AggregatedInflux, DummyTimedata, SimulatorAppImpl, SimulatorTimedataImpl, TimedataDummy, TimedataInfluxDb, TimedataInfluxDbImpl, TimedataManagerImpl, TimedataRrd4jImpl, TimedataTimescaleDb

public interface CommonTimedataService

Method Summary

Modifier and Type	Method	Description
static Resolution	calculateResolution(ZonedDateTime fromDate, ZonedDateTime toDate)	Calculates the time Resolution for the period.
default QueryHistoricTimeseriesExportXlsxResponse	handleQueryHistoricTimeseriesExportXlxsRequest(String edgeId, QueryHistoricTimeseriesExportXlxsRequest request, Language language)	Handles a QueryHistoricTimeseriesExportXlxsRequest.
default SortedMap<ZonedDateTime,SortedMap<ChannelAddress,com.google.gson.JsonElement>>	queryHistoricData(String edgeId, QueryHistoricTimeseriesDataRequest request)	Queries historic data.
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.

Method Details

handleQueryHistoricTimeseriesExportXlxsRequest

default QueryHistoricTimeseriesExportXlsxResponse handleQueryHistoricTimeseriesExportXlxsRequest(String edgeId,
 QueryHistoricTimeseriesExportXlxsRequest request,
 Language language)
                                                                                          throws OpenemsError.OpenemsNamedException

Handles a QueryHistoricTimeseriesExportXlxsRequest. Exports historic data to an Excel file.

Parameters:

edgeId - the Edge-ID

request - the QueryHistoricTimeseriesExportXlxsRequest request

language - the Language

Returns:

the QueryHistoricTimeseriesExportXlsxResponse

Throws:

OpenemsError.OpenemsNamedException - on error

calculateResolution

static Resolution calculateResolution(ZonedDateTime fromDate,
 ZonedDateTime toDate)

Calculates the time Resolution for the period.

Parameters:

fromDate - the From-Date

toDate - the To-Date

Returns:

the resolution

queryHistoricData

default SortedMap<ZonedDateTime,SortedMap<ChannelAddress,com.google.gson.JsonElement>> queryHistoricData(String edgeId,
 QueryHistoricTimeseriesDataRequest request)
                                                                                                  throws OpenemsError.OpenemsNamedException

Queries historic data. The 'resolution' of the query is calculated dynamically according to the length of the period.

Parameters:

edgeId - the Edge-ID

request - the QueryHistoricTimeseriesDataRequest

Returns:

the query result; possibly null

Throws:

OpenemsError.OpenemsNamedException

queryHistoricData

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.

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

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

Queries historic energy.

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

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.

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