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 ### Licence
   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.
   6
   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.
  10
  11 ### Building
  12  Building Application Framework Binder requires the following libraries:
  13
  14  * libmagic ("libmagic-dev" under Debian/Ubuntu, "file-devel" under OpenSUSE);
  15  * libmicrohttpd ("libmicrohttpd-dev/devel");
  16  * json-c ("libjson-c-dev/devel");
  17  * uuid ("uuid-dev/libuuid-devel");
  18
  19  optionally, for plugins :
  20
  21  * alsa ("libasound2-dev/alsa-devel");
  22  * rtl-sdr >= 0.5.0 (fetch and build from "git://git.osmocom.org/rtl-sdr");
  23
  24  and the following tools:
  25
  26  * pkg-config;
  27  * cmake >= 2.8.8.
  28
  29 To install all dependencies under OpenSUSE (except rtl-sdr), please type:
  30
  31 $ zypper in file-devel libmicrohttpd-devel libjson-c-devel libuuid-devel pkg-config cmake
  32
  33  To build from the root directory, please type:
  34
  35 $ mkdir build; cd build<br />
  36 $ cmake ..<br />
  37 $ make; make install<br />
  38
  39 ### Start
  40 $ afb-daemon --help
  41
  42 ### Example
  43 $ afb-daemon --verbose --rootdir=/home/fulup/.AFB --alias=icons:/usr/share/icons
  44
  45 ### Directory & Path
  46 Default behaviour is to locate ROOTDIR in $HOME/.AFB
  47
  48 ### REST API
  49
  50 Developer should mainly provides a structure with APIs name, corresponding methods and optionally some context and a handle.
  51 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
  52 a post method was used. Every method should return a JSON object or NULL in case of error.
  53
  54 API plugin can be protected from timeout and other errors. By default this behaviour is deactivated, use --apitimeout to activate it.
  55
  56         STATIC  AFB_restapi myApis[]= {
  57           {"ping"     , (AFB_apiCB)ping    , "Ping Function", NULL},
  58           {"action1"  , (AFB_apiCB)action1 , "Action-1", OptionalHandle},
  59           {"action2"  , (AFB_apiCB)action2 , "Action-2", OptionalHandle},
  60           {0,0,0}
  61         };
  62
  63         PUBLIC AFB_plugin *pluginRegister (AFB_session *session) {
  64             AFB_plugin *plugin = malloc (sizeof (AFB_plugin));
  65             plugin->type  = AFB_PLUGIN;
  66             plugin->info  = "Plugin Sample";
  67             plugin->prefix= "myplugin";
  68             plugin->apis  = myApis;
  69             return (plugin);
  70         }
  71
  72 ### HTML5 and Angular Redirect
  73
  74 Binder support HTML5 redirect mode even with an application baseurl. Default value for application base URL is /opa
  75 See Application Framework HTML5 Client template at https://github.com/iotbzh/afb-client-sample
  76
  77 If the Binder receive something like http://myopa/sample when sample is not the homepage of the Angular OPA. The the serveur
  78 will redirect to http://myopa/#!sample this redirect will return the Index.html OPA file and will notify angular not to display
  79 the homepage by to goto samplepage.
  80
  81 Warning: in order Angular application to work both with a BASEURL="/" and BASEURL="/MyApp/" every page references have to be relative.
  82 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.
  83
  84 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
  85 external support static files. They should not be used for API and OPA.
  86
  87
  88 ### On going work
  89
  90  -- Dynamic load of plugins. While everything is designed to support dynamically loadable plugins, this part is not done yet.
  91  -- Javascript plugins. As today only C plugins are supported, but JS plugins are on the ToDo list.
  92