Package io.openems.common.jsonrpc.request

Class SetChannelValueRequest

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.SetChannelValueRequest

public class SetChannelValueRequest
extends JsonrpcRequest

Sets the write value of a Channel.

 {
   "jsonrpc": "2.0",
   "id": "UUID",
   "method": "setChannelValue",
   "params": {
     "componentId": string,
     "channelId": string,
     "value": any
   }
 }
 

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
SetChannelValueRequest(String componentId, String channelId, com.google.gson.JsonElement value)

Method Summary

Modifier and Type	Method	Description
static SetChannelValueRequest	from(JsonrpcRequest r)	Create SetChannelValueRequest from a template JsonrpcRequest.
ChannelAddress	getChannelAddress()	Gets the ChannelAddress.
String	getChannelId()	Gets the Channel-ID.
String	getComponentId()	Gets the Component-ID.
com.google.gson.JsonObject	getParams()	Gets the params JsonObject of the JsonrpcRequest.
com.google.gson.JsonElement	getValue()	Gets the Value.

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

SetChannelValueRequest

public SetChannelValueRequest(String componentId,
 String channelId,
 com.google.gson.JsonElement value)

Method Details

from

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

Create SetChannelValueRequest from a template JsonrpcRequest.

Parameters:

r - the template JsonrpcRequest

Returns:

the SetChannelValueRequest

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

getChannelId

public String getChannelId()

Gets the Channel-ID.

Returns:

Channel-ID

getChannelAddress

public ChannelAddress getChannelAddress()

Gets the ChannelAddress.

Returns:

ChannelAddress

getValue

public com.google.gson.JsonElement getValue()

Gets the Value.

Returns:

Value