README.md

   1 ### Application Framework Binder
   2 This is an undergoing work, publication is only intended for developers to review and provide feedback.
   3
   4 ### License
   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..
   6
   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.
   8
   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.
  10
  11 ### Building
  12 Building Application Framework Binder requires the following libraries:
  13  * libmagic ("libmagic-dev" under Debian/Ubuntu, "file-devel" under OpenSUSE);
  14  * libmicrohttpd ("libmicrohttpd-dev/devel");
  15  * json-c ("libjson-c-dev/devel");
  16  * uuid ("uuid-dev/libuuid-devel");
  17  * dbus ("libdbus-1-dev/dbus-1-devel");
  18
  19 optionally, for plugins :
  20  * alsa ("libasound2-dev/alsa-devel");
  21  * pulseaudio ("libpulse-dev/libpulse-devel");
  22  * rtl-sdr >= 0.5.0 (fetch and build from "git://git.osmocom.org/rtl-sdr");
  23
  24 and the following tools:
  25  * pkg-config;
  26  * cmake >= 2.8.8.
  27
  28 To install all dependencies under OpenSUSE (excepting rtl-sdr), please type:
  29 ```
  30 $ zypper in file-devel libmicrohttpd-devel libjson-c-devel libuuid-devel dbus-1-devel alsa-devel libpulse-devel pkg-config cmake
  31 ```
  32
  33  To build, move to the root directory and type:
  34 ```
  35 $ mkdir build; cd build<br />
  36 $ cmake ..<br />
  37 $ make; make install<br />
  38 ```
  39
  40 ### Starting
  41 ```
  42 $ afb-daemon --help
  43 $ afb-daemon --verbose --port=<port> --token='' --sessiondir=<working directory> --rootdir=<web directory (index.html)>
  44 ```
  45
  46 ### Example
  47 ```
  48 $ afb-daemon --verbose --port=1234 --token='' --sessiondir=/tmp --rootdir=/srv/www/htdocs --alias=icons:/usr/share/icons
  49 ```
  50
  51 ### Directories & Paths
  52 Default behaviour is to locate ROOTDIR in $HOME/.AFB
  53
  54 ### REST API
  55
  56 Developers are intended to provide a structure containing : API name, corresponding methods/callbacks, and optionally a context and a handle.
  57 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.
  58
  59 API plugins can be protected from timeout and other errors. By default this behaviour is deactivated, use --apitimeout to activate it.
  60
  61         STATIC AFB_restapi myApis[]= {
  62           {"ping"    , AFB_SESSION_NONE,  (AFB_apiCB)ping,     "Ping Function"},
  63           {"action1" , AFB_SESSION_CHECK, (AFB_apiCB)action1 , "Action-1"},
  64           {"action2" , AFB_SESSION_CHECK, (AFB_apiCB)action2 , "Action-2"},
  65           {NULL}
  66         };
  67
  68         PUBLIC AFB_plugin *pluginRegister () {
  69             AFB_plugin *plugin = malloc (sizeof (AFB_plugin));
  70             plugin->type  = AFB_PLUGIN_JSON;
  71             plugin->info  = "Plugin Sample";
  72             plugin->prefix= "myPlugin";
  73             plugin->apis  = myApis;
  74             return (plugin);
  75         }
  76
  77 ### HTML5 and AngularJS Redirects
  78
  79 Binder supports HTML5 redirect mode even with an application baseurl. Default value for application base URL is /opa.
  80 See Application Framework HTML5 Client template at https://github.com/iotbzh/afb-client-sample
  81
  82 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.
  83
  84 Warning: in order for AngularJS applications to be able to work with both BASEURL="/" and BASEURL="/MyApp/", all page references have to be relative.
  85 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.
  86
  87 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.
  88
  89
  90 ### Ongoing work
  91
  92 Javascript plugins. As of today, only C plugins are supported, but JS plugins are on the TODO list.
  93