aboutsummaryrefslogtreecommitdiffstats
path: root/low-can-binding/binding/low-can-apidef.h
blob: a6fe7972552692168e08885a2eefb6779d11e3f1 (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
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
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-can\",\"version\":\"4.0\",\"x-binding-c-generator\":{\"api\":\"low-ca"
    "n\",\"version\":2,\"prefix\":\"\",\"postfix\":\"\",\"start\":null,\"onev"
    "ent\":null,\"init\":\"initv2\",\"scope\":\"\",\"private\":false}},\"serv"
    "ers\":[{\"url\":\"ws://{host}:{port}/api/monitor\",\"description\":\"Low"
    " level CAN API.\",\"variables\":{\"host\":{\"default\":\"localhost\"},\""
    "port\":{\"default\":\"1234\"}},\"x-afb-events\":[{\"$ref\":\"#/component"
    "s/schemas/afb-event\"}]}],\"components\":{\"schemas\":{\"afb-reply\":{\""
    "$ref\":\"#/components/schemas/afb-reply-v2\"},\"afb-event\":{\"$ref\":\""
    "#/components/schemas/afb-event-v2\"},\"afb-reply-v2\":{\"title\":\"Gener"
    "ic response.\",\"type\":\"object\",\"required\":[\"jtype\",\"request\"],"
    "\"properties\":{\"jtype\":{\"type\":\"string\",\"const\":\"afb-reply\"},"
    "\"request\":{\"type\":\"object\",\"required\":[\"status\"],\"properties\""
    ":{\"status\":{\"type\":\"string\"},\"info\":{\"type\":\"string\"},\"toke"
    "n\":{\"type\":\"string\"},\"uuid\":{\"type\":\"string\"},\"reqid\":{\"ty"
    "pe\":\"string\"}}},\"response\":{\"type\":\"object\"}}},\"afb-event-v2\""
    ":{\"type\":\"object\",\"required\":[\"jtype\",\"event\"],\"properties\":"
    "{\"jtype\":{\"type\":\"string\",\"const\":\"afb-event\"},\"event\":{\"ty"
    "pe\":\"string\"},\"data\":{\"type\":\"object\"}}}},\"x-permissions\":{\""
    "monitor\":{\"permission\":\"urn:AGL:permission:low-can:public:monitor\"}"
    ",\"write\":{\"permission\":\"urn:AGL:permission::platform:can:write \"}}"
    ",\"responses\":{\"200\":{\"description\":\"A complex object array respon"
    "se\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/compone"
    "nts/schemas/afb-reply\"}}}}}},\"paths\":{\"/subscribe\":{\"description\""
    ":\"Subscribe to CAN signals events\",\"parameters\":[{\"in\":\"query\",\""
    "name\":\"event\",\"required\":false,\"schema\":{\"type\":\"string\"}}],\""
    "responses\":{\"200\":{\"$ref\":\"#/components/responses/200\"}}},\"/unsu"
    "bscribe\":{\"description\":\"Unsubscribe previously suscribed 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\":\"eve"
    "nt\",\"required\":false,\"schema\":{\"type\":\"string\"}}],\"responses\""
    ":{\"200\":{\"$ref\":\"#/components/responses/200\"}}},\"/list\":{\"descr"
    "iption\":\"get a supported CAN message list\",\"responses\":{\"200\":{\""
    "$ref\":\"#/components/responses/200\"}}},\"/auth\":{\"description\":\"Au"
    "thenticate session to be raise Level Of Assurance.\",\"get\":{\"x-permis"
    "sions\":{\"$ref\":\"#/components/x-permissions/write\"},\"responses\":{\""
    "200\":{\"$ref\":\"#/components/responses/200\"}}}},\"/write\":{\"descrip"
    "tion\":\"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\",\"n"
    "ame\":\"frame\",\"required\":false,\"schema\":{\"type\":\"array\"},\"par"
    "ameters\":[{\"in\":\"query\",\"name\":\"can_id\",\"required\":false,\"sc"
    "hema\":{\"type\":\"string\"}},{\"in\":\"query\",\"name\":\"can_dlc\",\"r"
    "equired\":false,\"schema\":{\"type\":\"string\"}},{\"in\":\"query\",\"na"
    "me\":\"can_data\",\"required\":false,\"schema\":{\"type\":\"string\"}}]}"
    ",{\"in\":\"query\",\"name\":\"signal_name\",\"required\":false,\"schema\""
    ":{\"type\":\"string\"}},{\"in\":\"query\",\"name\":\"signal_value\",\"re"
    "quired\":false,\"schema\":{\"type\":\"integer\"}}],\"responses\":{\"200\""
    ":{\"$ref\":\"#/components/responses/200\"}}}}}}"
;

static const struct afb_auth _afb_auths_v2_low_can[] = {
	afb::auth_permission("urn:AGL:permission::platform:can: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
};