Package io.openems.edge.core.appmanager.jsonrpc

Class GetApp

java.lang.Object

io.openems.edge.core.appmanager.jsonrpc.GetApp

public class GetApp
extends Object

Gets the available OpenemsApp.

Request:

 {
   "jsonrpc": "2.0",
   "id": "UUID",
   "method": "getApp",
   "params": {}
 }
 

Response:

 {
   "jsonrpc": "2.0",
   "id": "UUID",
   "result": {
     app: {
       "categorys": [{
        "name": string (OpenemsAppCategory enum),
        "readableName": string
       }],
       "cardinality": string (OpenemsAppUsage enum),
       "appId": string,
       "name": string,
       "status": {
        "status": string (OpenemsAppStatus enum),
        "errorCompatibleMessages": string[],
        "errorInstallableMessages": string[]
       },
       "image": string (base64),
       "instanceIds": UUID[],
     }
   }
 }
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GetApp.Request
static class	GetApp.Response

Field Summary

Fields

Modifier and Type	Field	Description
static final String	METHOD

Constructor Summary

Constructors

Constructor	Description
GetApp()

Method Summary

Modifier and Type	Method	Description
static final com.google.gson.JsonObject	createJsonObjectOf(OpenemsApp app, Validator validator, List<OpenemsAppInstance> instantiatedApps, Language language)	Creates a JsonObject of the given OpenemsApp.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

METHOD

public static final String METHOD

See Also:

• Constant Field Values

Constructor Details

GetApp

public GetApp()

Method Details

createJsonObjectOf

public static final com.google.gson.JsonObject createJsonObjectOf(OpenemsApp app,
 Validator validator,
 List<OpenemsAppInstance> instantiatedApps,
 Language language)
                                                           throws OpenemsError.OpenemsNamedException

Creates a JsonObject of the given OpenemsApp.

Also adds the status of the app and the instances of the app.

Parameters:

app - the OpenemsApp

validator - a Validator to get the status of the app OpenemsAppStatus

instantiatedApps - all instances

language - the Language

Returns:

the created JsonObject

Throws:

OpenemsError.OpenemsNamedException - on error