Package io.openems.common.jsonrpc.notification

Class TimestampedDataNotification

java.lang.Object

io.openems.common.jsonrpc.base.JsonrpcMessage

io.openems.common.jsonrpc.base.AbstractJsonrpcRequest

io.openems.common.jsonrpc.base.JsonrpcNotification

io.openems.common.jsonrpc.notification.TimestampedDataNotification

public class TimestampedDataNotification
extends JsonrpcNotification

Represents a JSON-RPC Notification for timestamped data sent from Edge to Backend.

 {
   "jsonrpc": "2.0",
   "method": "timestampedData",
   "params": {
     [timestamp: epoch in milliseconds]: {
       [channelAddress]: String | Number
     }
   }
 }
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	METHOD

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

JSONRPC_VERSION

Constructor Summary

Constructors

Constructor	Description
TimestampedDataNotification()

Method Summary

Modifier and Type	Method	Description
void	add(long timestamp, String address, com.google.gson.JsonElement value)	Add a timestamped value.
void	add(long timestamp, Map<String,com.google.gson.JsonElement> data)	Add timestamped data.
static TimestampedDataNotification	from(JsonrpcNotification n)	Parses a JsonrpcNotification to a TimestampedDataNotification.
com.google.common.collect.TreeBasedTable<Long,String,com.google.gson.JsonElement>	getData()
com.google.gson.JsonObject	getParams()	Gets the params JsonObject of the JsonrpcRequest.

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

getFullyQualifiedMethod, getMethod, toJsonObject

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

TimestampedDataNotification

public TimestampedDataNotification()

Method Details

from

public static TimestampedDataNotification from(JsonrpcNotification n)
                                        throws OpenemsError.OpenemsNamedException

Parses a JsonrpcNotification to a TimestampedDataNotification.

Parameters:

n - the JsonrpcNotification

Returns:

the TimestampedDataNotification

Throws:

OpenemsError.OpenemsNamedException - on error

add

public void add(long timestamp,
 Map<String,com.google.gson.JsonElement> data)

Add timestamped data.

Parameters:

timestamp - the timestamp epoch in milliseconds

data - a map of Channel-Address to JsonElement value

add

public void add(long timestamp,
 String address,
 com.google.gson.JsonElement value)

Add a timestamped value.

Parameters:

timestamp - the timestamp epoch in milliseconds

address - the Channel-Address

value - the JsonElement value

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

getData

public com.google.common.collect.TreeBasedTable<Long,String,com.google.gson.JsonElement> getData()