aboutsummaryrefslogtreecommitdiffstats
path: root/low-can-binding/binding/low-can-apidef.h
diff options
context:
space:
mode:
Diffstat (limited to 'low-can-binding/binding/low-can-apidef.h')
-rw-r--r--low-can-binding/binding/low-can-apidef.h134
1 files changed, 134 insertions, 0 deletions
diff --git a/low-can-binding/binding/low-can-apidef.h b/low-can-binding/binding/low-can-apidef.h
new file mode 100644
index 00000000..6f6ec926
--- /dev/null
+++ b/low-can-binding/binding/low-can-apidef.h
@@ -0,0 +1,134 @@
+
+static const char _afb_description_v2_low_can[] =
+ "{\"openapi\":\"3.0.0\",\"$schema\":\"http:iot.bzh/download/openapi/schem"
+ "a-3.0/default-schema.json\",\"info\":{\"description\":\"\",\"title\":\"l"
+ "ow-level-can-service\",\"version\":\"4.0\",\"x-binding-c-generator\":{\""
+ "api\":\"low-can\",\"version\":2,\"prefix\":\"\",\"postfix\":\"\",\"start"
+ "\":null,\"onevent\":null,\"init\":\"initv2\",\"scope\":\"\",\"private\":"
+ "false}},\"servers\":[{\"url\":\"ws://{host}:{port}/api/monitor\",\"descr"
+ "iption\":\"Low level CAN API.\",\"variables\":{\"host\":{\"default\":\"l"
+ "ocalhost\"},\"port\":{\"default\":\"1234\"}},\"x-afb-events\":[{\"$ref\""
+ ":\"#/components/schemas/afb-event\"}]}],\"components\":{\"schemas\":{\"a"
+ "fb-reply\":{\"$ref\":\"#/components/schemas/afb-reply-v2\"},\"afb-event\""
+ ":{\"$ref\":\"#/components/schemas/afb-event-v2\"},\"afb-reply-v2\":{\"ti"
+ "tle\":\"Generic response.\",\"type\":\"object\",\"required\":[\"jtype\","
+ "\"request\"],\"properties\":{\"jtype\":{\"type\":\"string\",\"const\":\""
+ "afb-reply\"},\"request\":{\"type\":\"object\",\"required\":[\"status\"],"
+ "\"properties\":{\"status\":{\"type\":\"string\"},\"info\":{\"type\":\"st"
+ "ring\"},\"token\":{\"type\":\"string\"},\"uuid\":{\"type\":\"string\"},\""
+ "reqid\":{\"type\":\"string\"}}},\"response\":{\"type\":\"object\"}}},\"a"
+ "fb-event-v2\":{\"type\":\"object\",\"required\":[\"jtype\",\"event\"],\""
+ "properties\":{\"jtype\":{\"type\":\"string\",\"const\":\"afb-event\"},\""
+ "event\":{\"type\":\"string\"},\"data\":{\"type\":\"object\"}}}},\"x-perm"
+ "issions\":{\"monitor\":{\"permission\":\"urn:AGL:permission:low-can:publ"
+ "ic:monitor\"},\"write\":{\"permission\":\"urn:AGL:permission:low-can:pla"
+ "tform:write\"}},\"responses\":{\"200\":{\"description\":\"A complex obje"
+ "ct array response\",\"content\":{\"application/json\":{\"schema\":{\"$re"
+ "f\":\"#/components/schemas/afb-reply\"}}}}}},\"paths\":{\"/subscribe\":{"
+ "\"description\":\"Subscribe to CAN signals events\",\"parameters\":[{\"i"
+ "n\":\"query\",\"name\":\"event\",\"required\":false,\"schema\":{\"type\""
+ ":\"string\"}}],\"responses\":{\"200\":{\"$ref\":\"#/components/responses"
+ "/200\"}}},\"/unsubscribe\":{\"description\":\"Unsubscribe previously sus"
+ "cribed signals.\",\"parameters\":[{\"in\":\"query\",\"name\":\"event\",\""
+ "required\":false,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200"
+ "\":{\"$ref\":\"#/components/responses/200\"}}},\"/get\":{\"description\""
+ ":\"get a current value of CAN message\",\"parameters\":[{\"in\":\"query\""
+ ",\"name\":\"event\",\"required\":false,\"schema\":{\"type\":\"string\"}}"
+ "],\"responses\":{\"200\":{\"$ref\":\"#/components/responses/200\"}}},\"/"
+ "list\":{\"description\":\"get a supported CAN message list\",\"responses"
+ "\":{\"200\":{\"$ref\":\"#/components/responses/200\"}}},\"/auth\":{\"des"
+ "cription\":\"Authenticate session to be raise Level Of Assurance.\",\"ge"
+ "t\":{\"x-permissions\":{\"$ref\":\"#/components/x-permissions/write\"},\""
+ "responses\":{\"200\":{\"$ref\":\"#/components/responses/200\"}}}},\"/wri"
+ "te\":{\"description\":\"Write a CAN messages to the CAN bus.\",\"get\":{"
+ "\"x-permissions\":{\"LOA\":1},\"parameters\":[{\"in\":\"query\",\"name\""
+ ":\"bus_name\",\"required\":false,\"schema\":{\"type\":\"string\"}},{\"in"
+ "\":\"query\",\"name\":\"frame\",\"required\":false,\"schema\":{\"type\":"
+ "\"array\"},\"parameters\":[{\"in\":\"query\",\"name\":\"can_id\",\"requi"
+ "red\":false,\"schema\":{\"type\":\"string\"}},{\"in\":\"query\",\"name\""
+ ":\"can_dlc\",\"required\":false,\"schema\":{\"type\":\"string\"}},{\"in\""
+ ":\"query\",\"name\":\"can_data\",\"required\":false,\"schema\":{\"type\""
+ ":\"string\"}}]},{\"in\":\"query\",\"name\":\"signal_name\",\"required\":"
+ "false,\"schema\":{\"type\":\"string\"}},{\"in\":\"query\",\"name\":\"sig"
+ "nal_value\",\"required\":false,\"schema\":{\"type\":\"integer\"}}],\"res"
+ "ponses\":{\"200\":{\"$ref\":\"#/components/responses/200\"}}}}}}"
+;
+#ifdef __cplusplus
+#include <afb/afb-binding>
+#endif
+/*static const struct afb_auth _afb_auths_v2_low_can[] = {
+ { .type = afb_auth_Permission, .text = "urn:AGL:permission:low-can:platform:write", .next = NULL}
+};*/
+
+const struct afb_auth _afb_auths_v2_low_can[] = {afb::auth_permission("urn:AGL:permission:low-can:platform:write")};
+
+ void subscribe(struct afb_req req);
+ void unsubscribe(struct afb_req req);
+ void get(struct afb_req req);
+ void list(struct afb_req req);
+ void auth(struct afb_req req);
+ void write(struct afb_req req);
+
+static const struct afb_verb_v2 _afb_verbs_v2_low_can[] = {
+ {
+ .verb = "subscribe",
+ .callback = subscribe,
+ .auth = NULL,
+ .info = "Subscribe to CAN signals events",
+ .session = AFB_SESSION_NONE_V2
+ },
+ {
+ .verb = "unsubscribe",
+ .callback = unsubscribe,
+ .auth = NULL,
+ .info = "Unsubscribe previously suscribed signals.",
+ .session = AFB_SESSION_NONE_V2
+ },
+ {
+ .verb = "get",
+ .callback = get,
+ .auth = NULL,
+ .info = "get a current value of CAN message",
+ .session = AFB_SESSION_NONE_V2
+ },
+ {
+ .verb = "list",
+ .callback = list,
+ .auth = NULL,
+ .info = "get a supported CAN message list",
+ .session = AFB_SESSION_NONE_V2
+ },
+ {
+ .verb = "auth",
+ .callback = auth,
+ .auth = &_afb_auths_v2_low_can[0],
+ .info = "Authenticate session to be raise Level Of Assurance.",
+ .session = AFB_SESSION_NONE_V2
+ },
+ {
+ .verb = "write",
+ .callback = write,
+ .auth = NULL,
+ .info = "Write a CAN messages to the CAN bus.",
+ .session = AFB_SESSION_LOA_1_V2
+ },
+ {
+ .verb = NULL,
+ .callback = NULL,
+ .auth = NULL,
+ .info = NULL,
+ .session = 0
+ }
+};
+
+const struct afb_binding_v2 afbBindingV2 = {
+ .api = "low-can",
+ .specification = _afb_description_v2_low_can,
+ .info = "",
+ .verbs = _afb_verbs_v2_low_can,
+ .preinit = NULL,
+ .init = initv2,
+ .onevent = NULL,
+ .noconcurrency = 0
+};
+