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 and Description
static java.lang.String	METHOD

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

JSONRPC_VERSION

Constructor Summary

Constructors

Constructor and Description
SetChannelValueRequest(java.lang.String componentId, java.lang.String channelId, com.google.gson.JsonElement value)
SetChannelValueRequest(java.util.UUID id, java.lang.String componentId, java.lang.String channelId, com.google.gson.JsonElement value)

Method Summary

Modifier and Type	Method and Description
static SetChannelValueRequest	from(JsonrpcRequest r)
ChannelAddress	getChannelAddress()
java.lang.String	getChannelId()
java.lang.String	getComponentId()
com.google.gson.JsonObject	getParams()
com.google.gson.JsonElement	getValue()

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

getId, toJsonObject

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

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 Detail

METHOD

public static final java.lang.String METHOD

See Also:

Constant Field Values

Constructor Detail

SetChannelValueRequest

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

SetChannelValueRequest

public SetChannelValueRequest(java.util.UUID id,
                              java.lang.String componentId,
                              java.lang.String channelId,
                              com.google.gson.JsonElement value)

Method Detail

from

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

Throws:

OpenemsError.OpenemsNamedException

getParams

public com.google.gson.JsonObject getParams()

Specified by:

getParams in class AbstractJsonrpcRequest

getComponentId

public java.lang.String getComponentId()

getChannelId

public java.lang.String getChannelId()

getChannelAddress

public ChannelAddress getChannelAddress()

getValue

public com.google.gson.JsonElement getValue()