Package io.openems.common.jsonrpc.request

Class QueryHistoricTimeseriesEnergyPerPeriodRequest

java.lang.Object

io.openems.common.jsonrpc.base.JsonrpcMessage

io.openems.common.jsonrpc.base.AbstractJsonrpcRequest

io.openems.common.jsonrpc.base.JsonrpcRequest

io.openems.common.jsonrpc.request.QueryHistoricTimeseriesEnergyPerPeriodRequest

public class QueryHistoricTimeseriesEnergyPerPeriodRequest
extends JsonrpcRequest

Represents a JSON-RPC Request for 'queryHistoricTimeseriesEnergyPerPeriod'.

This Request is for use-cases where you want to get the energy for each period (with length '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.

 {
   "jsonrpc": "2.0",
   "id": "UUID",
   "method": "queryHistoricTimeseriesEnergyPerPeriod",
   "params": {
     "fromDate": YYYY-MM-DD,
     "toDate": YYYY-MM-DD,
     "channels": ChannelAddress[],
     "timezone": String,
     "resolution": {
       "value": Number,
       "unit": ChronoUnit
     }
 }
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	METHOD

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

DEFAULT_TIMEOUT_SECONDS, id, NO_TIMEOUT, timeoutOpt

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

JSONRPC_VERSION

Constructor Summary

Constructors

Constructor	Description
QueryHistoricTimeseriesEnergyPerPeriodRequest(ZonedDateTime fromDate, ZonedDateTime toDate, Resolution resolution)

Method Summary

Modifier and Type	Method	Description
static QueryHistoricTimeseriesEnergyPerPeriodRequest	from(JsonrpcRequest r)	Create QueryHistoricTimeseriesEnergyPerPeriodRequest from a template JsonrpcRequest.
TreeSet<ChannelAddress>	getChannels()	Gets the ChannelAddresses.
ZonedDateTime	getFromDate()	Gets the From-Date.
com.google.gson.JsonObject	getParams()	Gets the params JsonObject of the JsonrpcRequest.
Resolution	getResolution()	Gets the requested Resolution in [s].
ZonedDateTime	getToDate()	Gets the To-Date.

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

getId, getTimeout, toJsonObject

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

getFullyQualifiedMethod, getMethod

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

from, from, toString

Methods inherited from class java.lang.Object

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

Field Details

METHOD

public static final String METHOD

See Also:

• Constant Field Values

Constructor Details

QueryHistoricTimeseriesEnergyPerPeriodRequest

public QueryHistoricTimeseriesEnergyPerPeriodRequest(ZonedDateTime fromDate,
 ZonedDateTime toDate,
 Resolution resolution)
                                              throws OpenemsError.OpenemsNamedException

Throws:

OpenemsError.OpenemsNamedException

Method Details

from

public static QueryHistoricTimeseriesEnergyPerPeriodRequest from(JsonrpcRequest r)
                                                          throws OpenemsError.OpenemsNamedException

Create QueryHistoricTimeseriesEnergyPerPeriodRequest from a template JsonrpcRequest.

Parameters:

r - the template JsonrpcRequest

Returns:

the QueryHistoricTimeseriesEnergyPerPeriodRequest

Throws:

OpenemsError.OpenemsNamedException - on parse error

getParams

public com.google.gson.JsonObject getParams()

Description copied from class: AbstractJsonrpcRequest

Gets the params JsonObject of the JsonrpcRequest.

Specified by:

getParams in class AbstractJsonrpcRequest

Returns:

the params as JsonObject

getFromDate

public ZonedDateTime getFromDate()

Gets the From-Date.

Returns:

From-Date

getToDate

public ZonedDateTime getToDate()

Gets the To-Date.

Returns:

To-Date

getChannels

public TreeSet<ChannelAddress> getChannels()

Gets the ChannelAddresses.

Returns:

Set of ChannelAddress

getResolution

public Resolution getResolution()

Gets the requested Resolution in [s].

Returns:

Resolution