diff options
| author |   CorentinLGS <corentinlgs@gmail.com> | 2018-08-07 14:23:11 +0200 |
|---|---|---|
| committer |   Romain Forlot <romain.forlot@iot.bzh> | 2018-12-13 15:02:55 +0100 |
| commit | 80ec58eac2bd1da4236b59c0f0c1042c50d99790 (patch) | |
| tree | ce622f3888d340ff44049401de4822c417e631fe /docs/controller.md | |
| parent | 80596c5dddf5174f485a963eac8fc7d1a1058e22 (diff) | |
Controller: Converted README to a gitbook version.
-Split the README into a gitbook documentation.
Change-Id: Iacf94e94d15606d68c925885dac5233d828f29b7
Signed-off-by: CorentinLGS <corentinlgs@gmail.com>
Diffstat (limited to 'docs/controller.md')
| -rw-r--r-- | docs/controller.md | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/docs/controller.md b/docs/controller.md new file mode 100644 index 0000000..4012455 --- /dev/null +++ b/docs/controller.md @@ -0,0 +1,28 @@ +# Controller + +* Object: Generic Controller to handle Policy,Small Business Logic, Glue in between components, ... +* Status: Release Candidate +* Author: Fulup Ar Foll fulup@iot.bzh +* Date : May-2018 + +## Features + +* Create a controller application from a JSON config file +* Each control (eg: navigation, multimedia, ...) is a suite of actions. When all actions succeed control is granted, if one fails control access is denied. +* Actions can either be: + * Invocation of an other binding API, either internal or external (eg: a policy service, Alsa UCM, ...) + * C routines from a user provided plugin (eg: policy routine, proprietary code, ...) + * Lua script function. Lua provides access to every AGL appfw functionality and can be extended by plugins written in C. + +## Installation + +* Controller can easily be included as a git submodule in any AGL service or application binder. +* Dependencies: the only dependencies are AGL application framework (https://gerrit.automotivelinux.org/gerrit/p/src/app-framework-binder.git) and app-afb-helpers-submodule (https://gerrit.automotivelinux.org/gerrit/p/apps/app-afb-helpers-submodule.git). +* Controller relies on Lua-5.3, when not needed Lua might be removed at compilation time. + +## Monitoring + +* The default test HTML page expect the monitoring HTML page to be accessible under /monitoring with the --monitoring option. +* The monitoring HTML pages are installed with the app framework binder in a subdirectory called monitoring. +* You can add other HTML pages with the alias options e.g. afb-daemon --port=1234 --monitoring --alias=/path1/to/htmlpages:/path2/to/htmlpages --ldpaths=. --workdir=. --roothttp=../htdocs +* The monitoring is accessible at http://localhost:1234/monitoring.
\ No newline at end of file |