1 ### Application Framework Binder
2 This is an undergoing work, publication is only intended for developers to review and provide feedback.
5 As today the code is under GLPV3, while no decision as been taken yet, it will certainly move under a different licence like GPV2, Apache or MIT.
7 Final goal is keep the engine public while allowing people to load non open-source plugins. The code already leverage other opensource
8 libraries especially libmicrohttpd & libjson. Finally what ever Licence is chosen it should be compatible with dependencies and automotive
9 industry requirementsas the primary target for this code is AGL.
12 Building Application Framework Binder requires the following libraries:
14 * libmagic ("libmagic-dev" under Debian/Ubuntu, "file-devel" under OpenSUSE);
15 * libmicrohttpd ("libmicrohttpd-dev/devel");
16 * json-c ("libjson-c-dev/devel");
18 optionally, for plugins :
20 * rtl-sdr >= 0.5.0 (fetch and build from "git://git.osmocom.org/rtl-sdr");
22 and the following tools:
27 To install all dependencies under OpenSUSE (except rtl-sdr), please type:
29 $ zypper in file-devel libmicrohttpd-devel libjson-c-devel pkg-config cmake
31 To build from the root directory, please type:
33 $ mkdir build; cd build<br />
35 $ make; make install<br />
41 $ afb-daemon --verbose --rootdir=/home/fulup/.AFB --alias=icons:/usr/share/icons
44 Default behaviour is to locate ROOTDIR in $HOME/.AFB
48 Developer should mainly provides a structure with APIs name, corresponding methods and optionally some context and a handle.
49 A handle is a void* structure that it is passed to the api callback. The API receive the query and well as post data, incase
50 a post method was used. Every method should return a JSON object or NULL in case of error.
52 API plugin can be protected from timeout and other errors. By default this behaviour is deactivated, use --apitimeout to activate it.
54 STATIC AFB_restapi myApis[]= {
55 {"ping" , (AFB_apiCB)ping , "Ping Function", NULL},
56 {"action1" , (AFB_apiCB)action1 , "Action-1", OptionalHandle},
57 {"action2" , (AFB_apiCB)action2 , "Action-2", OptionalHandle},
61 PUBLIC AFB_plugin *pluginRegister (AFB_session *session) {
62 AFB_plugin *plugin = malloc (sizeof (AFB_plugin));
63 plugin->type = AFB_PLUGIN;
64 plugin->info = "Plugin Sample";
65 plugin->prefix= "myplugin";
66 plugin->apis = myApis;
70 ### HTML5 and Angular Redirect
72 Binder support HTML5 redirect mode even with an application baseurl. Default value for application base URL is /opa
73 See Application Framework HTML5 Client template at https://github.com/iotbzh/afb-client-sample
75 If the Binder receive something like http://myopa/sample when sample is not the homepage of the Angular OPA. The the serveur
76 will redirect to http://myopa/#!sample this redirect will return the Index.html OPA file and will notify angular not to display
77 the homepage by to goto samplepage.
79 Warning: in order Angular application to work both with a BASEURL="/" and BASEURL="/MyApp/" every page references have to be relative.
80 Recommended model is to develop with a BASEURL="/opa" as any application working with a BASEURL will work without, when the opposite it not true.
82 Note: If a resource is not accessible from ROOTDIR then --alias should be use ex: --alias=/icons:/usr/share/icons. Only alias designed to access
83 external support static files. They should not be used for API and OPA.
88 -- Dynamic load of plugins. While everything is designed to support dynamically loadable plugins, this part is not done yet.
89 -- Javascript plugins. As today only C plugins are supported, but JS plugins are on the ToDo list.