X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=ucs2-afb%2Fucs_apidef.json;h=9d543e29c180e2cc1cff1708dc1142473ffd2d6c;hb=refs%2Fchanges%2F22%2F24722%2F1;hp=9936004e861b9ac589440851ba3657dced1248f8;hpb=475f9d3205488d590c3ee6d61c1a61279102e7b8;p=apps%2Fagl-service-unicens.git diff --git a/ucs2-afb/ucs_apidef.json b/ucs2-afb/ucs_apidef.json index 9936004..9d543e2 100644 --- a/ucs2-afb/ucs_apidef.json +++ b/ucs2-afb/ucs_apidef.json @@ -7,12 +7,13 @@ "version": "1.0", "x-binding-c-generator": { "api": "UNICENS", - "version": 2, - "prefix": "Ucs2", - "postfix": "API", + "version": 3, + "prefix": "ucs2_", + "postfix": "", "start": null , "onevent": null, - "init": null, + "preinit": null, + "init": "ucs2_initbinding", "scope": "", "private": false } @@ -86,6 +87,9 @@ }, "monitor": { "permission": "urn:AGL:permission:UNICENS:public:monitor" + }, + "controller": { + "permission": "urn:AGL:permission:UNICENS:public:controller" } }, "responses": { @@ -102,8 +106,27 @@ } }, "paths": { + "/listconfig": { + "description": "List Config Files", + "get": { + "x-permissions": { + "$ref": "#/components/x-permissions/config" + }, + "parameters": [ + { + "in": "query", + "name": "cfgpath", + "required": false, + "schema": { "type": "string" } + } + ], + "responses": { + "200": {"$ref": "#/components/responses/200"} + } + } + }, "/initialise": { - "description": "Initialise Unicens2 lib from NetworkConfig.XML.", + "description": "configure Unicens2 lib from NetworkConfig.XML.", "get": { "x-permissions": { "$ref": "#/components/x-permissions/config" @@ -121,8 +144,30 @@ } } }, - "/volume": { - "description": "Set Master Volume.", + "/subscribe": { + "description": "Subscribe to network events.", + "get": { + "x-permissions": { + "$ref": "#/components/x-permissions/monitor" + }, + "responses": { + "200": {"$ref": "#/components/responses/200"} + } + } + }, + "/subscriberx": { + "description": "Subscribe to Rx control message events.", + "get": { + "x-permissions": { + "$ref": "#/components/x-permissions/monitor" + }, + "responses": { + "200": {"$ref": "#/components/responses/200"} + } + } + }, + "/writei2c": { + "description": "Writes I2C command to remote node.", "get": { "x-permissions": { "$ref": "#/components/x-permissions/monitor" @@ -130,9 +175,22 @@ "parameters": [ { "in": "query", - "name": "value", + "name": "node", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "in": "query", + "name": "data", "required": true, - "schema": { "type": "integer" } + "schema": { + "type": "array", + "format": "int32" + }, + "style": "simple" } ], "responses": { @@ -140,12 +198,42 @@ } } }, - "/monitor": { - "description": "Subscribe to Unicens Event.", + "/sendmessage": { + "description": "Transmits a control message to a node.", "get": { "x-permissions": { - "$ref": "#/components/x-permissions/monitor" + "$ref": "#/components/x-permissions/controller" }, + "parameters": [ + { + "in": "query", + "name": "node", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "in": "query", + "name": "msgid", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "in": "query", + "name": "data", + "required": false, + "schema": { + "type": "string", + "format": "byte" + }, + "style": "simple" + } + ], "responses": { "200": {"$ref": "#/components/responses/200"} }