X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=README.md;h=844570068157951e1e369f099161d1ed76058744;hb=refs%2Fheads%2Feel;hp=5846f001c5293250f4634e4a0511f34bbb82658c;hpb=241a06586b3602962874e6d2ac09e258ad6173d2;p=src%2Fapp-framework-binder.git diff --git a/README.md b/README.md index 5846f001..84457006 100644 --- a/README.md +++ b/README.md @@ -1,92 +1,139 @@ ### Application Framework Binder -This is an undergoing work, publication is only intended for developers to review and provide feedback. +This is an undergoing work, publication is only intended for developers to review and provide feedback. -### Licence -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. - -Final goal is keep the engine public while allowing people to load non open-source plugins. The code already leverage other opensource -libraries especially libmicrohttpd & libjson. Finally what ever Licence is chosen it should be compatible with dependencies and automotive -industry requirementsas the primary target for this code is AGL. +### License +Apache 2 ### Building - Building Application Framework Binder requires the following libraries: - - * libmagic ("libmagic-dev" under Debian/Ubuntu, "file-devel" under OpenSUSE); - * libmicrohttpd ("libmicrohttpd-dev/devel"); +Building Application Framework Binder has been tested under **Ubuntu 16.04 LTS (Xenial Xerus)** or **Fedora 23**, and requires the following libraries: + * libmagic ("libmagic-dev" under Ubuntu, "file-devel" under Fedora); + * libmicrohttpd >= 0.9.48 (fetch and build from "http://ftp.gnu.org/gnu/libmicrohttpd"); * json-c ("libjson-c-dev/devel"); * uuid ("uuid-dev/libuuid-devel"); + * openssl ("libssl-dev/openssl-devel"); + * systemd >= 222 ("libsystemd-dev/systemd-devel"); - optionally, for plugins : - +Optionally, for plugins : * alsa ("libasound2-dev/alsa-devel"); - * rtl-sdr >= 0.5.0 (fetch and build from "git://git.osmocom.org/rtl-sdr"); + * pulseaudio ("libpulse-dev/libpulse-devel"); + * rtl-sdr >= 0.5.0 ("librtlsdr-dev", or fetch and build from "git://git.osmocom.org/rtl-sdr" under Fedora); + * GUPnP ("libglib2.0-dev libgupnp-av-1.0-dev/glib2-devel libgupnp-av-devel"); - and the following tools: +Libmicrohttpd : + * version >= 0.9.54 +and the following tools: + * gcc; + * make; * pkg-config; * cmake >= 2.8.8. -To install all dependencies under OpenSUSE (except rtl-sdr), please type: - -$ zypper in file-devel libmicrohttpd-devel libjson-c-devel libuuid-devel pkg-config cmake - - To build from the root directory, please type: - -$ mkdir build; cd build
+To install all dependencies under Ubuntu (excepting libmicrohttpd), please type: +``` +$ 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 +``` +or under Fedora (excepting libmicrohttpd and rtl-sdr): +``` +$ dnf install git passwd iproute openssh-server openssh-client openssh-server # Tools needed on top of Docker Minimal Fedora +$ dnf install file-devel gcc gdb make pkgconfig cmake # install gcc developement tool chain + cmake +$ dnf install file-devel json-c-devel libuuid-devel systemd-devel openssl-devel +$ dnf install alsa-lib-devel pulseaudio-libs-devel glib2-devel gupnp-av-devel # optional but require to build audio plugin +``` + + To build, move to your HOME directory and type: +``` +$ LIB_MH_VERSION=0.9.54 +$ export LIBMICRODEST=/opt/libmicrohttpd-${LIB_MH_VERSION} +$ wget https://ftp.gnu.org/gnu/libmicrohttpd/libmicrohttpd-${LIB_MH_VERSION}.tar.gz +$ tar -xzf libmicrohttpd-${LIB_MH_VERSION}.tar.gz +$ cd libmicrohttpd-${LIB_MH_VERSION} +$ ./configure --prefix=${LIBMICRODEST} +$ make +$ sudo make install-strip + +$ AFB_DAEMON_DIR=$HOME/app-framework-binder +$ git clone https://gerrit.automotivelinux.org/gerrit/src/app-framework-binder ${AFB_DAEMON_DIR} +$ cd ${AFB_DAEMON_DIR} +$ mkdir -p build; cd build
+$ export PKG_CONFIG_PATH=${LIBMICRODEST}/lib/pkgconfig $ cmake ..
-$ make; make install
- -### Start +$ make; +$ sudo make install
+``` + +### Archive + +``` +VERSION=2.0 +GIT_TAG=master +PKG_NAME=app-framework-binder +git archive --format=tar.gz --prefix=agl-${PKG_NAME}-${VERSION}/ ${GIT_TAG} -o agl-${PKG_NAME}_${VERSION}.orig.tar.gz +``` + +### Testing/Debug +``` +$ ${AFB_DAEMON_DIR}/build/src/afb-daemon --help +$ ${AFB_DAEMON_DIR}/build/src/afb-daemon --port=1234 --token='' --ldpaths=${AFB_DAEMON_DIR}/build --sessiondir=/tmp --rootdir=${AFB_DAEMON_DIR}/test +``` + +### Starting +``` $ afb-daemon --help +$ afb-daemon --verbose --port= --token='' --sessiondir= --rootdir= +``` ### Example -$ afb-daemon --verbose --rootdir=/home/fulup/.AFB --alias=icons:/usr/share/icons +``` +$ afb-daemon --verbose --port=1234 --token='' --sessiondir=/tmp --rootdir=/srv/www/htdocs --alias=icons:/usr/share/icons +``` -### Directory & Path +### Directories & Paths Default behaviour is to locate ROOTDIR in $HOME/.AFB ### REST API -Developer should mainly provides a structure with APIs name, corresponding methods and optionally some context and a handle. -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 -a post method was used. Every method should return a JSON object or NULL in case of error. +Developers are intended to provide a structure containing : API name, corresponding methods/callbacks, and optionally a context and a handle. +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. -API plugin can be protected from timeout and other errors. By default this behaviour is deactivated, use --apitimeout to activate it. +API plugins can be protected from timeout and other errors. By default this behaviour is deactivated, use --apitimeout to activate it. - STATIC AFB_restapi myApis[]= { - {"ping" , (AFB_apiCB)ping , "Ping Function", NULL}, - {"action1" , (AFB_apiCB)action1 , "Action-1", OptionalHandle}, - {"action2" , (AFB_apiCB)action2 , "Action-2", OptionalHandle}, - {0,0,0} + STATIC AFB_restapi myApis[]= { + {"ping" , AFB_SESSION_NONE, (AFB_apiCB)ping, "Ping Function"}, + {"action1" , AFB_SESSION_CHECK, (AFB_apiCB)action1 , "Action-1"}, + {"action2" , AFB_SESSION_CHECK, (AFB_apiCB)action2 , "Action-2"}, + {NULL} }; - PUBLIC AFB_plugin *pluginRegister (AFB_session *session) { + PUBLIC AFB_plugin *pluginRegister () { AFB_plugin *plugin = malloc (sizeof (AFB_plugin)); - plugin->type = AFB_PLUGIN; + plugin->type = AFB_PLUGIN_JSON; plugin->info = "Plugin Sample"; - plugin->prefix= "myplugin"; + plugin->prefix= "myPlugin"; plugin->apis = myApis; return (plugin); } -### HTML5 and Angular Redirect +### HTML5 and AngularJS Redirects -Binder support HTML5 redirect mode even with an application baseurl. Default value for application base URL is /opa +Binder supports HTML5 redirect mode even with an application baseurl. +Default value for application base URL is /opa. See Application Framework HTML5 Client template at https://github.com/iotbzh/afb-client-sample -If the Binder receive something like http://myopa/sample when sample is not the homepage of the Angular OPA. The the serveur -will redirect to http://myopa/#!sample this redirect will return the Index.html OPA file and will notify angular not to display -the homepage by to goto samplepage. +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. + +Warning: in order for AngularJS applications to be able to work with both BASEURL="/" and BASEURL="/MyApp/", all page references have to be relative. -Warning: in order Angular application to work both with a BASEURL="/" and BASEURL="/MyApp/" every page references have to be relative. -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. +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. -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 -external support static files. They should not be used for API and OPA. +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. -### On going work +### Ongoing work - -- Dynamic load of plugins. While everything is designed to support dynamically loadable plugins, this part is not done yet. - -- Javascript plugins. As today only C plugins are supported, but JS plugins are on the ToDo list. +Javascript plugins. As of today, only C plugins are supported, but JS plugins are on the TODO list.