Package io.openems.common.jsonrpc.response

Class QueryHistoricTimeseriesExportXlsxResponse

java.lang.Object

io.openems.common.jsonrpc.base.JsonrpcMessage

io.openems.common.jsonrpc.base.JsonrpcResponse

io.openems.common.jsonrpc.base.JsonrpcResponseSuccess

io.openems.common.jsonrpc.response.Base64PayloadResponse

io.openems.common.jsonrpc.response.QueryHistoricTimeseriesExportXlsxResponse

public class QueryHistoricTimeseriesExportXlsxResponse
extends Base64PayloadResponse

Represents a JSON-RPC Response for 'queryHistoricTimeseriesExportXlxs'.

 {
   "jsonrpc": "2.0",
   "id": "UUID",
   "result": {
     "payload": Base64-String
   }
 }
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	QueryHistoricTimeseriesExportXlsxResponse.Channel
protected static class	QueryHistoricTimeseriesExportXlsxResponse.XlsxUtils

Field Summary

Fields

Modifier and Type	Field	Description
static Set<ChannelAddress>	ENERGY_CHANNELS	All Energy Channels, i.e.
static Set<ChannelAddress>	POWER_CHANNELS	All Power Channels, i.e.

Fields inherited from class io.openems.common.jsonrpc.base.JsonrpcMessage

JSONRPC_VERSION

Constructor Summary

Constructors

Constructor	Description
QueryHistoricTimeseriesExportXlsxResponse(UUID id, String edgeId, ZonedDateTime fromDate, ZonedDateTime toDate, SortedMap<ZonedDateTime,SortedMap<ChannelAddress,com.google.gson.JsonElement>> historicData, SortedMap<ChannelAddress,com.google.gson.JsonElement> historicEnergy, Language language)	Constructs a QueryHistoricTimeseriesExportXlsxResponse.

Method Summary

Methods inherited from class io.openems.common.jsonrpc.response.Base64PayloadResponse

getPayload, getResult

Methods inherited from class io.openems.common.jsonrpc.base.JsonrpcResponseSuccess

from, toJsonObject

Methods inherited from class io.openems.common.jsonrpc.base.JsonrpcResponse

from, getId

Methods inherited from class io.openems.common.jsonrpc.base.JsonrpcMessage

toString

Methods inherited from class java.lang.Object

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

Field Details

POWER_CHANNELS

public static Set<ChannelAddress> POWER_CHANNELS

All Power Channels, i.e. Channels that are exported per channel and timestamp.

ENERGY_CHANNELS

public static Set<ChannelAddress> ENERGY_CHANNELS

All Energy Channels, i.e. exported with one value per channel.

Constructor Details

QueryHistoricTimeseriesExportXlsxResponse

public QueryHistoricTimeseriesExportXlsxResponse(UUID id,
 String edgeId,
 ZonedDateTime fromDate,
 ZonedDateTime toDate,
 SortedMap<ZonedDateTime,SortedMap<ChannelAddress,com.google.gson.JsonElement>> historicData,
 SortedMap<ChannelAddress,com.google.gson.JsonElement> historicEnergy,
 Language language)
                                          throws IOException,
OpenemsError.OpenemsNamedException

Constructs a QueryHistoricTimeseriesExportXlsxResponse.

While constructing, the actual Excel file is generated as payload of the JSON-RPC Response.

Parameters:

id - the JSON-RPC ID

edgeId - the Edge-ID

fromDate - the start date of the export

toDate - the end date of the export

historicData - the power data per channel and timestamp

historicEnergy - the energy data, one value per channel

language - the Language

Throws:

IOException - on error

OpenemsError.OpenemsNamedException - on error