Package io.openems.common.jsonrpc.request

Class SetGridConnScheduleRequest

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

public class SetGridConnScheduleRequest
extends JsonrpcRequest

Represents a JSON-RPC Request for 'setGridConnSchedule'.

 {
   "jsonrpc": "2.0",
   "id": "UUID",
   "method": "setGridConnSchedule",
   "params": {
     "id": "edgeId",
     "schedule": [{
       "startTimestamp": 1542464697, // epoch in seconds
       "duration": 900, // in seconds
       "activePowerSetPoint": 0 // in Watt
     }]
   }
 }
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SetGridConnScheduleRequest.GridConnSchedule

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
SetGridConnScheduleRequest(String edgeId)
SetGridConnScheduleRequest(String edgeId, List<SetGridConnScheduleRequest.GridConnSchedule> schedule)

Method Summary

Modifier and Type	Method	Description
void	addScheduleEntry(SetGridConnScheduleRequest.GridConnSchedule scheduleEntry)	Add a SetGridConnScheduleRequest.GridConnSchedule entry.
static SetGridConnScheduleRequest	from(JsonrpcRequest r)	Create SetGridConnScheduleRequest from a template JsonrpcRequest.
String	getEdgeId()	Gets the Edge-ID.
com.google.gson.JsonObject	getParams()	Gets the params JsonObject of the JsonrpcRequest.
List<SetGridConnScheduleRequest.GridConnSchedule>	getSchedule()	Gets the list of SetGridConnScheduleRequest.GridConnSchedule entries.

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

SetGridConnScheduleRequest

public SetGridConnScheduleRequest(String edgeId)

SetGridConnScheduleRequest

public SetGridConnScheduleRequest(String edgeId,
 List<SetGridConnScheduleRequest.GridConnSchedule> schedule)

Method Details

from

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

Create SetGridConnScheduleRequest from a template JsonrpcRequest.

Parameters:

r - the template JsonrpcRequest

Returns:

the SetGridConnScheduleRequest

Throws:

OpenemsError.OpenemsNamedException - on parse error

addScheduleEntry

public void addScheduleEntry(SetGridConnScheduleRequest.GridConnSchedule scheduleEntry)

Add a SetGridConnScheduleRequest.GridConnSchedule entry.

Parameters:

scheduleEntry - GridConnSchedule entry

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

getEdgeId

public String getEdgeId()

Gets the Edge-ID.

Returns:

Edge-ID

getSchedule

public List<SetGridConnScheduleRequest.GridConnSchedule> getSchedule()

Gets the list of SetGridConnScheduleRequest.GridConnSchedule entries.

Returns:

entries