Package io.openems.edge.core.componentmanager.jsonrpc

Class ChannelExportXlsxRequest

java.lang.Object

io.openems.common.jsonrpc.base.JsonrpcMessage

io.openems.common.jsonrpc.base.AbstractJsonrpcRequest

io.openems.common.jsonrpc.base.JsonrpcRequest

io.openems.edge.core.componentmanager.jsonrpc.ChannelExportXlsxRequest

public class ChannelExportXlsxRequest
extends JsonrpcRequest

Exports Channels with current value and metadata to an Excel (xlsx) file.

 {
   "jsonrpc": "2.0",
   "id": "UUID",
   "method": "channelExportXlsx",
   "params": {
        "componentId": string
   }
 }
 

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
ChannelExportXlsxRequest(String componentId)

Method Summary

Modifier and Type	Method	Description
static ChannelExportXlsxRequest	from(JsonrpcRequest r)	Create ChannelExportXlsxRequest from a template JsonrpcRequest.
String	getComponentId()	Gets the Component-ID.
com.google.gson.JsonObject	getParams()	Gets the params JsonObject of the JsonrpcRequest.

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

ChannelExportXlsxRequest

public ChannelExportXlsxRequest(String componentId)

Method Details

from

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

Create ChannelExportXlsxRequest from a template JsonrpcRequest.

Parameters:

r - the template JsonrpcRequest

Returns:

the ChannelExportXlsxRequest

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

getComponentId

public String getComponentId()

Gets the Component-ID.

Returns:

Component-ID