aboutsummaryrefslogtreecommitdiffstats
path: root/ucs2-afb/ucs_apidef.h
blob: 6b8c23aced2ee4a6306e7188defbeeb7e7946951 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
.highlight .hll { background-color: #ffffcc }
.highlight .c { color: #888888 } /* Comment */
.highlight .err { color: #a61717; background-color: #e3d2d2 } /* Error */
.highlight .k { color: #008800; font-weight: bold } /* Keyword */
.highlight .ch { color: #888888 } /* Comment.Hashbang */
.highlight .cm { color: #888888 } /* Comment.Multiline */
.highlight .cp { color: #cc0000; font-weight: bold } /* Comment.Preproc */
.highlight .cpf { color: #888888 } /* Comment.PreprocFile */
.highlight .c1 { color: #888888 } /* Comment.Single */
.highlight .cs { color: #cc0000; font-weight: bold; background-color: #fff0f0 } /* Comment.Special */
.highlight .gd { color: #000000; background-color: #ffdddd } /* Generic.Deleted */
.highlight .ge { font-style: italic } /* Generic.Emph */
.highlight .gr { color: #aa0000 } /* Generic.Error */
.highlight .gh { color: #333333 } /* Generic.Heading */
.highlight .gi { color: #000000; background-color: #ddffdd } /* Generic.Inserted */
.highlight .go { color: #888888 } /* Generic.Output */
.highlight .gp { color: #555555 } /* Generic.Prompt */
.highlight .gs { font-weight: bold } /* Generic.Strong */
.highlight .gu { color: #666666 } /* Generic.Subheading */
.highlight .gt { color: #aa0000 } /* Generic.Traceback */
.highlight .kc { color: #008800; font-weight: bold } /* Keyword.Constant */
.highlight .kd { color: #008800; font-weight: bold } /* Keyword.Declaration */
.highlight .kn { color: #008800; font-weight: bold } /* Keyword.Namespace */
.highlight .kp { color: #008800 } /* Keyword.Pseudo */
.highlight .kr { color: #008800; font-weight: bold } /* Keyword.Reserved */
.highlight .kt { color: #888888; font-weight: bold } /* Keyword.Type */
.highlight .m { color: #0000DD; font-weight: bold } /* Literal.Number */
.highlight .s { color: #dd2200; background-color: #fff0f0 } /* Literal.String */
.highlight .na { color: #336699 } /* Name.Attribute */
.highlight .nb { color: #003388 } /* Name.Builtin */
.highlight .nc { color: #bb0066; font-weight: bold } /* Name.Class */
.highlight .no { color: #003366; font-weight: bold } /* Name.Constant */
.highlight .nd { color: #555555 } /* Name.Decorator */
.highlight .ne { color: #bb0066; font-weight: bold } /* Name.Exception */
.highlight .nf { color: #0066bb; font-weight: bold } /* Name.Function */
.highlight .nl { color: #336699; font-style: italic } /* Name.Label */
.highlight .nn { color: #bb0066; font-weight: bold } /* Name.Namespace */
.highlight .py { color: #336699; font-weight: bold } /* Name.Property */
.highlight .nt { color: #bb0066; font-weight: bold } /* Name.Tag */
.highlight .nv { color: #336699 } /* Name.Variable */
.highlight .ow { color: #008800 } /* Operator.Word */
.highlight .w { color: #bbbbbb } /* Text.Whitespace */
.highlight .mb 
static const char _afb_description_v2_UNICENS[] =
    "{\"openapi\":\"3.0.0\",\"$schema\":\"http:iot.bzh/download/openapi/schem"
    "a-3.0/default-schema.json\",\"info\":{\"description\":\"\",\"title\":\"u"
    "cs2\",\"version\":\"1.0\",\"x-binding-c-generator\":{\"api\":\"UNICENS\""
    ",\"version\":2,\"prefix\":\"ucs2_\",\"postfix\":\"\",\"start\":null,\"on"
    "event\":null,\"preinit\":null,\"init\":\"ucs2_initbinding\",\"scope\":\""
    "\",\"private\":false}},\"servers\":[{\"url\":\"ws://{host}:{port}/api/mo"
    "nitor\",\"description\":\"Unicens2 API.\",\"variables\":{\"host\":{\"def"
    "ault\":\"localhost\"},\"port\":{\"default\":\"1234\"}},\"x-afb-events\":"
    "[{\"$ref\":\"#/components/schemas/afb-event\"}]}],\"components\":{\"sche"
    "mas\":{\"afb-reply\":{\"$ref\":\"#/components/schemas/afb-reply-v2\"},\""
    "afb-event\":{\"$ref\":\"#/components/schemas/afb-event-v2\"},\"afb-reply"
    "-v2\":{\"title\":\"Generic response.\",\"type\":\"object\",\"required\":"
    "[\"jtype\",\"request\"],\"properties\":{\"jtype\":{\"type\":\"string\",\""
    "const\":\"afb-reply\"},\"request\":{\"type\":\"object\",\"required\":[\""
    "status\"],\"properties\":{\"status\":{\"type\":\"string\"},\"info\":{\"t"
    "ype\":\"string\"},\"token\":{\"type\":\"string\"},\"uuid\":{\"type\":\"s"
    "tring\"},\"reqid\":{\"type\":\"string\"}}},\"response\":{\"type\":\"obje"
    "ct\"}}},\"afb-event-v2\":{\"type\":\"object\",\"required\":[\"jtype\",\""
    "event\"],\"properties\":{\"jtype\":{\"type\":\"string\",\"const\":\"afb-"
    "event\"},\"event\":{\"type\":\"string\"},\"data\":{\"type\":\"object\"}}"
    "}},\"x-permissions\":{\"config\":{\"permission\":\"urn:AGL:permission:UN"
    "ICENS:public:initialise\"},\"monitor\":{\"permission\":\"urn:AGL:permiss"
    "ion:UNICENS:public:monitor\"},\"controller\":{\"permission\":\"urn:AGL:p"
    "ermission:UNICENS:public:controller\"}},\"responses\":{\"200\":{\"descri"
    "ption\":\"A complex object array response\",\"content\":{\"application/j"
    "son\":{\"schema\":{\"$ref\":\"#/components/schemas/afb-reply\"}}}}}},\"p"
    "aths\":{\"/listconfig\":{\"description\":\"List Config Files\",\"get\":{"
    "\"x-permissions\":{\"$ref\":\"#/components/x-permissions/config\"},\"par"
    "ameters\":[{\"in\":\"query\",\"name\":\"cfgpath\",\"required\":false,\"s"
    "chema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"$ref\":\"#/com"
    "ponents/responses/200\"}}}},\"/initialise\":{\"description\":\"configure"
    " Unicens2 lib from NetworkConfig.XML.\",\"get\":{\"x-permissions\":{\"$r"
    "ef\":\"#/components/x-permissions/config\"},\"parameters\":[{\"in\":\"qu"
    "ery\",\"name\":\"filename\",\"required\":true,\"schema\":{\"type\":\"str"
    "ing\"}}],\"responses\":{\"200\":{\"$ref\":\"#/components/responses/200\""
    "}}}},\"/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/mo"
    "nitor\"},\"responses\":{\"200\":{\"$ref\":\"#/components/responses/200\""
    "}}}},\"/writei2c\":{\"description\":\"Writes I2C command to remote node."
    "\",\"get\":{\"x-permissions\":{\"$ref\":\"#/components/x-permissions/mon"
    "itor\"},\"parameters\":[{\"in\":\"query\",\"name\":\"node\",\"required\""
    ":true,\"schema\":{\"type\":\"integer\",\"format\":\"int32\"}},{\"in\":\""
    "query\",\"name\":\"data\",\"required\":true,\"schema\":{\"type\":\"array"
    "\",\"format\":\"int32\"},\"style\":\"simple\"}],\"responses\":{\"200\":{"
    "\"$ref\":\"#/components/responses/200\"}}}},\"/sendmessage\":{\"descript"
    "ion\":\"Transmits a control message to a node.\",\"get\":{\"x-permission"
    "s\":{\"$ref\":\"#/components/x-permissions/monitor\"},\"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\":true,\"schema\":{\"ty"
    "pe\":\"array\",\"format\":\"int32\"},\"style\":\"simple\"}],\"responses\""
    ":{\"200\":{\"$ref\":\"#/components/responses/200\"}}}},\"/sendmessageb64"
    "\":{\"description\":\"Transmits a control message to a node.\",\"get\":{"
    "\"x-permissions\":{\"$ref\":\"#/components/x-permissions/controller\"},\""
    "parameters\":[{\"in\":\"query\",\"name\":\"node\",\"required\":true,\"sc"
    "hema\":{\"type\":\"integer\",\"format\":\"int32\"}},{\"in\":\"query\",\""
    "name\":\"msgid\",\"required\":true,\"schema\":{\"type\":\"integer\",\"fo"
    "rmat\":\"int32\"}},{\"in\":\"query\",\"name\":\"data\",\"required\":fals"
    "e,\"schema\":{\"type\":\"string\",\"format\":\"byte\"},\"style\":\"simpl"
    "e\"}],\"responses\":{\"200\":{\"$ref\":\"#/components/responses/200\"}}}"
    "}}}"
;

static const struct afb_auth _afb_auths_v2_UNICENS[] = {
	{ .type = afb_auth_Permission, .text = "urn:AGL:permission:UNICENS:public:initialise" },
	{ .type = afb_auth_Permission, .text = "urn:AGL:permission:UNICENS:public:monitor" },
	{ .type = afb_auth_Permission, .text = "urn:AGL:permission:UNICENS:public:controller" }
};

 void ucs2_listconfig(struct afb_req req);
 void ucs2_initialise(struct afb_req req);
 void ucs2_subscribe(struct afb_req req);
 void ucs2_subscriberx(struct afb_req req);
 void ucs2_writei2c(struct afb_req req);
 void ucs2_sendmessage(struct afb_req req);
 void ucs2_sendmessageb64(struct afb_req req);

static const struct afb_verb_v2 _afb_verbs_v2_UNICENS[] = {
    {
        .verb = "listconfig",
        .callback = ucs2_listconfig,
        .auth = &_afb_auths_v2_UNICENS[0],
        .info = "List Config Files",
        .session = AFB_SESSION_NONE_V2
    },
    {
        .verb = "initialise",
        .callback = ucs2_initialise,
        .auth = &_afb_auths_v2_UNICENS[0],
        .info = "configure Unicens2 lib from NetworkConfig.XML.",
        .session = AFB_SESSION_NONE_V2
    },
    {
        .verb = "subscribe",
        .callback = ucs2_subscribe,
        .auth = &_afb_auths_v2_UNICENS[1],
        .info = "Subscribe to network events.",
        .session = AFB_SESSION_NONE_V2
    },
    {
        .verb = "subscriberx",
        .callback = ucs2_subscriberx,
        .auth = &_afb_auths_v2_UNICENS[1],
        .info = "Subscribe to Rx control message events.",
        .session = AFB_SESSION_NONE_V2
    },
    {
        .verb = "writei2c",
        .callback = ucs2_writei2c,
        .auth = &_afb_auths_v2_UNICENS[1],
        .info = "Writes I2C command to remote node.",
        .session = AFB_SESSION_NONE_V2
    },
    {
        .verb = "sendmessage",
        .callback = ucs2_sendmessage,
        .auth = &_afb_auths_v2_UNICENS[1],
        .info = "Transmits a control message to a node.",
        .session = AFB_SESSION_NONE_V2
    },
    {
        .verb = "sendmessageb64",
        .callback = ucs2_sendmessageb64,
        .auth = &_afb_auths_v2_UNICENS[2],
        .info = "Transmits a control message to a node.",
        .session = AFB_SESSION_NONE_V2
    },
    {
        .verb = NULL,
        .callback = NULL,
        .auth = NULL,
        .info = NULL,
        .session = 0
	}
};

const struct afb_binding_v2 afbBindingV2 = {
    .api = "UNICENS",
    .specification = _afb_description_v2_UNICENS,
    .info = "",
    .verbs = _afb_verbs_v2_UNICENS,
    .preinit = NULL,
    .init = ucs2_initbinding,
    .onevent = NULL,
    .noconcurrency = 0
};