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,
6 it will certainly switch to a different licence: GPLv2, Apache or MIT e.g..
8 Final goal is to keep the engine publicly accessible and modifiable, still allowing people to load non open-source plugins.
9 The code itself already leverages open-source libraries, including libmicrohttpd & libjson.
11 Finally, whatever license is chosen, it should be compatible with dependencies and automotive industry requirements - as the primary target for this code is AGL.
14 Building Application Framework Binder has been tested under **Ubuntu 16.04 LTS (Xenial Xerus)** or **Fedora 23**, and requires the following libraries:
15 * libmagic ("libmagic-dev" under Ubuntu, "file-devel" under Fedora);
16 * libmicrohttpd >= 0.9.48 (fetch and build from "http://ftp.gnu.org/gnu/libmicrohttpd");
17 * json-c ("libjson-c-dev/devel");
18 * uuid ("uuid-dev/libuuid-devel");
19 * openssl ("libssl-dev/openssl-devel");
20 * systemd >= 222 ("libsystemd-dev/systemd-devel");
22 Optionally, for plugins :
23 * alsa ("libasound2-dev/alsa-devel");
24 * pulseaudio ("libpulse-dev/libpulse-devel");
25 * rtl-sdr >= 0.5.0 ("librtlsdr-dev", or fetch and build from "git://git.osmocom.org/rtl-sdr" under Fedora);
26 * GUPnP ("libglib2.0-dev libgupnp-av-1.0-dev/glib2-devel libgupnp-av-devel");
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 $ LIB_MH_VERSION=0.9.54
52 $ export LIBMICRODEST=/opt/libmicrohttpd-${LIB_MH_VERSION}
53 $ wget https://ftp.gnu.org/gnu/libmicrohttpd/libmicrohttpd-${LIB_MH_VERSION}.tar.gz
54 $ tar -xzf libmicrohttpd-${LIB_MH_VERSION}.tar.gz
55 $ cd libmicrohttpd-${LIB_MH_VERSION}
56 $ ./configure --prefix=${LIBMICRODEST}
58 $ sudo make install-strip
60 $ AFB_DAEMON_DIR=$HOME/app-framework-binder
61 $ git clone https://gerrit.automotivelinux.org/gerrit/src/app-framework-binder ${AFB_DAEMON_DIR}
62 $ cd ${AFB_DAEMON_DIR}
63 $ mkdir -p build; cd build<br />
64 $ export PKG_CONFIG_PATH=${LIBMICRODEST}/lib/pkgconfig
67 $ sudo make install<br />
75 PKG_NAME=app-framework-binder
76 git archive --format=tar.gz --prefix=${PKG_NAME}-${VERSION}/ ${GIT_TAG} -o ${PKG_NAME}_${VERSION}.orig.tar.gz
81 $ ${AFB_DAEMON_DIR}/build/src/afb-daemon --help
82 $ ${AFB_DAEMON_DIR}/build/src/afb-daemon --port=1234 --token='' --ldpaths=${AFB_DAEMON_DIR}/build --sessiondir=/tmp --rootdir=${AFB_DAEMON_DIR}/test
88 $ afb-daemon --verbose --port=<port> --token='' --sessiondir=<working directory> --rootdir=<web directory (index.html)>
93 $ afb-daemon --verbose --port=1234 --token='' --sessiondir=/tmp --rootdir=/srv/www/htdocs --alias=icons:/usr/share/icons
96 ### Directories & Paths
97 Default behaviour is to locate ROOTDIR in $HOME/.AFB
101 Developers are intended to provide a structure containing : API name, corresponding methods/callbacks, and optionally a context and a handle.
102 A handle is a void* structure automatically passed to API callbacks.
103 Callbacks also receive HTTP GET data as well as HTTP POST data, in case a POST method was used.
104 Every method should return a JSON object or NULL in case of error.
106 API plugins can be protected from timeout and other errors. By default this behaviour is deactivated, use --apitimeout to activate it.
108 STATIC AFB_restapi myApis[]= {
109 {"ping" , AFB_SESSION_NONE, (AFB_apiCB)ping, "Ping Function"},
110 {"action1" , AFB_SESSION_CHECK, (AFB_apiCB)action1 , "Action-1"},
111 {"action2" , AFB_SESSION_CHECK, (AFB_apiCB)action2 , "Action-2"},
115 PUBLIC AFB_plugin *pluginRegister () {
116 AFB_plugin *plugin = malloc (sizeof (AFB_plugin));
117 plugin->type = AFB_PLUGIN_JSON;
118 plugin->info = "Plugin Sample";
119 plugin->prefix= "myPlugin";
120 plugin->apis = myApis;
124 ### HTML5 and AngularJS Redirects
126 Binder supports HTML5 redirect mode even with an application baseurl.
127 Default value for application base URL is /opa.
128 See Application Framework HTML5 Client template at https://github.com/iotbzh/afb-client-sample
130 If the Binder receives something like _http://myopa/sample_ when sample is not the homepage of the AngularJS OPA,
131 it will redirect to _http://myopa/#!sample_.
132 This redirect will return the _index.html_ OPA file and will notify AngularJS not to display the homepage, but the sample page.
134 Warning: in order for AngularJS applications to be able to work with both BASEURL="/" and BASEURL="/MyApp/", all page references have to be relative.
136 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.
138 Note: If a resource is not accessible from ROOTDIR then the "--alias" switch should be used, as in: --alias=/icons:/usr/share/icons.
139 Only use alias for external support static files. This should not be used for API and OPA.
144 Javascript plugins. As of today, only C plugins are supported, but JS plugins are on the TODO list.