diff options
| author |   Romain Forlot <romain.forlot@iot.bzh> | 2017-06-19 16:14:48 +0000 |
|---|---|---|
| committer | Romain Forlot <romain.forlot@iot.bzh> | 2017-06-19 16:30:26 +0000 |
| commit | c70baaeb249f0e1dc5c9e14344e60afe68d64698 (patch) | |
| tree | 5f9cb0fe6b33405556081d878a9f39be0e9f5d2a | |
| parent | 686079f69c60571219ad5c77b2e024fb58d6e446 (diff) | |
Update documentation.
Change-Id: I0dfdb6d9461073ed021663aed4d2f36040fb1356
Signed-off-by: Romain Forlot <romain.forlot@iot.bzh>
| -rw-r--r-- | docs/1-Architecture.md | 6 | ||||
| -rw-r--r-- | docs/2-Installation.md | 18 | ||||
| -rw-r--r-- | docs/3-Usage.md | 17 |
3 files changed, 21 insertions, 20 deletions
diff --git a/docs/1-Architecture.md b/docs/1-Architecture.md index 487c467..d92fea9 100644 --- a/docs/1-Architecture.md +++ b/docs/1-Architecture.md @@ -1,6 +1,8 @@ # AGL VIWI HIGH-CAN binding architecture -This binding is intended to act between low-level binding(s) and clients. It builds ViWi resources as defined in a json configuration file, and implements subscribe/unsubscribe/get verbs for the clients. Each ViWi resource can be composed of several elements, for which subscriptions will be made to the low-level binding with configurable frequencies or filters. +This binding is intended to act between low-level binding(s) and clients. It builds ViWi resources as defined in a json configuration file. It implements subscribe/unsubscribe/get verbs for the clients accordingly with protocol specification. + +Each ViWi resource can be composed of several elements, for which subscriptions will be made to the low-level binding with configurable frequencies or filters.  @@ -12,7 +14,7 @@ ViWi (Volkswagen Infotainment Web Interface) protocol defines a serie of objects Each object is assigned with a unique URI. -The depth of the URI tree is limited to 3, i.e. /service/resource>/element/, for instance **/car/doors/3901a278-ba17-44d6-9aef-f7ca67c04840**. +The depth of the URI tree is limited to 3, i.e. _/service/resource>/element/_, for instance **/car/doors/3901a278-ba17-44d6-9aef-f7ca67c04840**. To retrieve the list of elements for a given resource, one can use the get command, for instance **get /car/doors/**. diff --git a/docs/2-Installation.md b/docs/2-Installation.md index a5e1265..184334a 100644 --- a/docs/2-Installation.md +++ b/docs/2-Installation.md @@ -5,7 +5,7 @@ Low CAN binding must be installed. Prerequisites are the same. ```bash -$ git clone https://gerrit.automotivelinux.org/gerrit/apps/low-level-can-service +$ git clone --recursive https://gerrit.automotivelinux.org/gerrit/apps/low-level-can-service ``` ## Clone and build high level binding @@ -19,7 +19,7 @@ $ git clone https://gerrit.automotivelinux.org/gerrit/apps/low-level-can-service ```bash $ export WD=$(pwd) -$ git clone https://github.com/iotbzh/high-level-viwi-service.git +$ git clone --recusive https://github.com/iotbzh/high-level-viwi-service.git ``` ### Build @@ -32,17 +32,3 @@ $ cmake .. $ make ``` -## Launching - -The Json high level configuration file *high.json* must be placed in the directory where you launch afb-daemon. - -```bash -$ cp $WD/high-level-viwi-service/high.json $WD -$ cd $WD -``` -Natively under linux you can launch afb-daemon with the low-level and high-level bindings with a command like: - -```bash -$ cd $WD -$ afb-daemon --rootdir=$WD/low-level-can-service/CAN-binder/build/package --ldpaths=$WD/low-level-can-service/CAN-binder/build/package/lib:$WD/high-level-viwi-service/build/high-can-binding --port=1234 --tracereq=common --token=1 --verbose -``` diff --git a/docs/3-Usage.md b/docs/3-Usage.md index 6f49430..662e5f7 100644 --- a/docs/3-Usage.md +++ b/docs/3-Usage.md @@ -1,8 +1,12 @@ + + # Usage -## JSon configuration file +## JSON configuration file This file must be named *high.json*, and must accessible from afb-daemon. + + The json configuration file consists in 2 sections: ### Definitions section @@ -94,9 +98,18 @@ For instance: ### Launch the binder together with the two bindings +The Json high level configuration file *high.json* must be placed in the directory where you launch afb-daemon. + +```bash +$ cp $WD/high-level-viwi-service/high.json $WD + cd $WD +``` + +Then you can natively under linux you can launch afb-daemon with the low-level and high-level bindings with a command like: + ```bash $ cd $WD -$ afb-daemon --rootdir=$WD/low-level-can-service/CAN-binder/build/package --ldpaths=$WD/low-level-can-service/CAN-binder/build/package/lib:$WD/high-level-viwi-service/build/high-can-binding --port=1234 --tracereq=common --token=1 --verbose +$ afb-daemon --rootdir=$WD/low-level-can-service/CAN-binder/build/package --binding=$WD/low-level-can-service/CAN-binder/build/package/lib/afb-low-can.so --binding=$WD/high-level-viwi-service/build/package/lib/afb-high-can.so --port=1234 --tracereq=common --token=1 --verbose ``` ### Use afb-client-demo to test high level binding |