1 ### Application Framework Binder
2 This is an undergoing work, publication is only intended for developers to review and provide feedback.
5 As of today, the code is licensed under GLPv3. While no decision as been taken yet, it will certainly switch to a different licence: GPLv2, Apache or MIT e.g..
7 Final goal is to keep the engine publicly accessible and modifiable, still allowing people to load non open-source plugins. The code itself already leverages open-source libraries, including libmicrohttpd & libjson.
9 Finally, whatever license is chosen, it should be compatible with dependencies and automotive industry requirements - as the primary target for this code is AGL.
12 Building Application Framework Binder has been tested under **Ubuntu 16.04 LTS (Xenial Xerus)** or **Fedora 23**, and requires the following libraries:
13 * libmagic ("libmagic-dev" under Ubuntu, "file-devel" under Fedora);
14 * libmicrohttpd >= 0.9.48 (fetch and build from "http://ftp.gnu.org/gnu/libmicrohttpd");
15 * json-c ("libjson-c-dev/devel");
16 * uuid ("uuid-dev/libuuid-devel");
17 * openssl ("libssl-dev/openssl-devel");
18 * systemd >= 222 ("libsystemd-dev/systemd-devel");
20 optionally, for plugins :
21 * alsa ("libasound2-dev/alsa-devel");
22 * pulseaudio ("libpulse-dev/libpulse-devel");
23 * rtl-sdr >= 0.5.0 ("librtlsdr-dev", or fetch and build from "git://git.osmocom.org/rtl-sdr" under Fedora);
24 * GUPnP ("libglib2.0-dev libgupnp-av-1.0-dev/glib2-devel libgupnp-av-devel");
26 Libmicrohttpd should be v49 patched or higher version including patch 5583
27 * Prepatched v49 for AGL is avaliable at http://iot.bzh/download/public/2016/afb-demos/libmicrohttpd-0.9.49-agl.tgz
28 * Bug is described at https://gerrit.automotivelinux.org/gerrit/#/c/5583/
31 and the following tools:
37 To install all dependencies under Ubuntu (excepting libmicrohttpd), please type:
39 $ apt-get install libmagic-dev libjson-c-dev uuid-dev libsystemd-dev libssl-dev libasound2-dev libpulse-dev librtlsdr-dev libglib2.0-dev libgupnp-av-1.0-dev gcc make pkg-config cmake
41 or under Fedora (excepting libmicrohttpd and rtl-sdr):
43 $ dnf install git passwd iproute openssh-server openssh-client openssh-server # Tools needed on top of Docker Minimal Fedora
44 $ dnf install file-devel gcc gdb make pkgconfig cmake # install gcc developement tool chain + cmake
45 $ dnf install file-devel json-c-devel libuuid-devel systemd-devel openssl-devel
46 $ dnf install alsa-lib-devel pulseaudio-libs-devel glib2-devel gupnp-av-devel # optional but require to build audio plugin
49 To build, move to your HOME directory and type:
51 $ export LIBMICRODEST= /opt/libmicrohttpd-0.9.49-agl
52 $ wget http://iot.bzh/download/public/2016/afb-demos/libmicrohttpd-0.9.49-agl.tgz
53 $ tar -xzf libmicrohttpd-0.9.49-agl.tgz
54 $ cd libmicrohttpd-0.9.49-agl
55 $ ./configure --prefix=$LIBMICRODEST
57 $ sudo make install-strip
59 $ git clone https://github.com/iotbzh/afb-daemon.git
61 $ mkdir build; cd build<br />
62 $ export PKG_CONFIG_PATH=$LIBMICRODEST/lib/pkgconfig
65 $ sudo make install<br />
70 $ AFB_DAEMON_DIR=$HOME/afb-daemon
71 $ $AFB_DAEMON_DIR/build/src/afb-daemon --help
72 $ $AFB_DAEMON_DIR/build/src/afb-daemon --port=1234 --token='' --ldpaths=$AFB_DAEMON_DIR/build --sessiondir=/tmp --rootdir=$AFB_DAEMON_DIR/test
78 $ afb-daemon --verbose --port=<port> --token='' --sessiondir=<working directory> --rootdir=<web directory (index.html)>
83 $ afb-daemon --verbose --port=1234 --token='' --sessiondir=/tmp --rootdir=/srv/www/htdocs --alias=icons:/usr/share/icons
86 ### Directories & Paths
87 Default behaviour is to locate ROOTDIR in $HOME/.AFB
91 Developers are intended to provide a structure containing : API name, corresponding methods/callbacks, and optionally a context and a handle.
92 A handle is a void* structure automatically passed to API callbacks. Callbacks also receive HTTP GET data as well as HTTP POST data, in case a POST method was used. Every method should return a JSON object or NULL in case of error.
94 API plugins can be protected from timeout and other errors. By default this behaviour is deactivated, use --apitimeout to activate it.
96 STATIC AFB_restapi myApis[]= {
97 {"ping" , AFB_SESSION_NONE, (AFB_apiCB)ping, "Ping Function"},
98 {"action1" , AFB_SESSION_CHECK, (AFB_apiCB)action1 , "Action-1"},
99 {"action2" , AFB_SESSION_CHECK, (AFB_apiCB)action2 , "Action-2"},
103 PUBLIC AFB_plugin *pluginRegister () {
104 AFB_plugin *plugin = malloc (sizeof (AFB_plugin));
105 plugin->type = AFB_PLUGIN_JSON;
106 plugin->info = "Plugin Sample";
107 plugin->prefix= "myPlugin";
108 plugin->apis = myApis;
112 ### HTML5 and AngularJS Redirects
114 Binder supports HTML5 redirect mode even with an application baseurl. Default value for application base URL is /opa.
115 See Application Framework HTML5 Client template at https://github.com/iotbzh/afb-client-sample
117 If the Binder receives something like _http://myopa/sample_ when sample is not the homepage of the AngularJS OPA, it will redirect to _http://myopa/#!sample_. This redirect will return the _index.html_ OPA file and will notify AngularJS not to display the homepage, but the sample page.
119 Warning: in order for AngularJS applications to be able to work with both BASEURL="/" and BASEURL="/MyApp/", all page references have to be relative.
120 Recommended model is to develop with a BASEURL="/opa" as any application working with a BASEURL will work without, while the opposite is not true.
122 Note: If a resource is not accessible from ROOTDIR then the "--alias" switch should be used, as in: --alias=/icons:/usr/share/icons. Only use alias for external support static files. This should not be used for API and OPA.
127 Javascript plugins. As of today, only C plugins are supported, but JS plugins are on the TODO list.