diff options
| -rw-r--r-- | CAN-binder/conf.d/config.cmake | 6 | ||||
| -rw-r--r-- | CAN-binder/low-can-binding/CMakeLists.txt | 2 | ||||
| -rw-r--r-- | book.json | 2 | ||||
| -rw-r--r-- | docs/2-Installation.md | 10 | ||||
| -rw-r--r-- | docs/3-Usage.md | 10 | ||||
| -rw-r--r-- | docs/Doc-Revisions.md | 1 | ||||
| -rwxr-xr-x | docs/resources/make_cover.sh | 4 |
7 files changed, 19 insertions, 16 deletions
diff --git a/CAN-binder/conf.d/config.cmake b/CAN-binder/conf.d/config.cmake index 0b0cfa02..527cd261 100644 --- a/CAN-binder/conf.d/config.cmake +++ b/CAN-binder/conf.d/config.cmake @@ -19,7 +19,7 @@ # Project Info # ------------------ set(PROJECT_NAME low-can-service) -set(PROJECT_VERSION "2.0") +set(PROJECT_VERSION "4.0") set(PROJECT_PRETTY_NAME "Low level CAN binding") set(PROJECT_DESCRIPTION "Expose CAN Low Level APIs through AGL Framework") set(PROJECT_URL "https://github.com/iotbzh/CAN_signaling") @@ -71,7 +71,7 @@ set(CMAKE_CXX_FLAGS "-std=c++11") # Print a helper message when every thing is finished # ---------------------------------------------------- -set(CLOSING_MESSAGE "Test with: afb-daemon --rootdir=\$\$(pwd)/package --ldpaths=\$\$(pwd)/package/lib --port=1234 --roothttp=\$\$(pwd)/package/htdocs --tracereq=common --token=\"1\" --verbose") +set(CLOSING_MESSAGE "Test with: afb-daemon --rootdir=\$\$(pwd)/package --binding=\$\$(pwd)/package/lib/afb-low-can.so --port=1234 --tracereq=common --token=\"1\" --verbose") set(WIDGET_MESSAGE "Install widget file using in the target : afm-util install ${PROJECT_NAME}.wgt") # (BUG!!!) as PKG_CONFIG_PATH does not work [should be an env variable] @@ -103,7 +103,7 @@ set(WIDGET_TYPE application/vnd.agl.service) # the WIDGET_ENTRY_POINT "lib" which is the default directory # that holds the bindings. # -set(WIDGET_ENTRY_POINT lib/afs-low-can.so) +set(WIDGET_ENTRY_POINT lib/afb-low-can.so) # Optional dependencies order # --------------------------- diff --git a/CAN-binder/low-can-binding/CMakeLists.txt b/CAN-binder/low-can-binding/CMakeLists.txt index 6f6e11fd..cd38fca3 100644 --- a/CAN-binder/low-can-binding/CMakeLists.txt +++ b/CAN-binder/low-can-binding/CMakeLists.txt @@ -46,7 +46,7 @@ PROJECT_TARGET_ADD(low-can) # Binder exposes a unique public entry point SET_TARGET_PROPERTIES(${TARGET_NAME} PROPERTIES - PREFIX "afs-" + PREFIX "afb-" LABELS "BINDING" LINK_FLAGS ${BINDINGS_LINK_FLAG} OUTPUT_NAME ${TARGET_NAME} @@ -5,7 +5,7 @@ "author": "IoT.Bzh Team", "website": "http://iot.bzh", "published": "June 2017", - "version": "2.0", + "version": "4.0", "gitbook": "3.2.2", "root": "docs", diff --git a/docs/2-Installation.md b/docs/2-Installation.md index 2bf70f4e..a80aa03a 100644 --- a/docs/2-Installation.md +++ b/docs/2-Installation.md @@ -1,6 +1,7 @@ # Prerequisites -* An AGL system installed with latest Daring Dab version. +* An AGL system installed with latest Daring Dab version with latest Application +framework version >= 0.6. * Make sure you built the AGL generator else you will not be able to generate custom low-level CAN binding. @@ -8,7 +9,7 @@ It will produce a _application-generated.cpp_ file to paste in the source, _CAN- * Make sure you already set up the AGL SDK using the following [SDK Quick Setup Guide](http://docs.iot.bzh/docs/getting_started/en/dev/reference/setup-sdk-environment.html). Alternatively, please refer to official guides available on [AGL Developer Site](http://docs.automotivelinux.org/docs/devguides/en/dev/#guides). -To get the correct SDK version installed, you **must** prepare your environment with the **iotbzh** flavor using _prepare_meta_ tool. To do so, run the following command in your docker image in the step 4 in place of `... [ prepare build environment ] ...`: +If you need to have the graphic stack inside your SDK, you have to prepare your environment with the **iotbzh**, or **Daring Dab** flavor using _prepare_meta_ tool. To do so, run the following command in your docker image in the step 4 in place of `... [ prepare build environment ] ...`: > **NOTE** These commands assume that proprietary graphic drivers for Renesas Porter board are located in _/home/devel/share/proprietary-renesas-rcar_ directory. @@ -37,7 +38,8 @@ source /xdt/sdk/environment-setup-aarch64-agl-linux export PATH=$PATH:/xdt/sdk/sysroots/x86_64-aglsdk-linux/usr/bin export WD=$(pwd) git clone --recursive https://gerrit.automotivelinux.org/gerrit/apps/low-level-can-service -export GENERATOR=${WD}/CAN-signaling/CAN-config-generator +git clone --recursive https://gerrit.automotivelinux.org/gerrit/apps/low-level-can-generator +export GENERATOR=${WD}/low-level-can-generator cd ${GENERATOR} mkdir -p build cd build @@ -174,5 +176,5 @@ On the target, assuming _**wgt**_ file is in the root home directory: ```bash afm-util install low-can-service.wgt -{ "added": "low-can-service@2.0" } +{ "added": "low-can-service@4.0" } ``` diff --git a/docs/3-Usage.md b/docs/3-Usage.md index e122adcb..eecf5a8e 100644 --- a/docs/3-Usage.md +++ b/docs/3-Usage.md @@ -121,7 +121,7 @@ hs="can1" You can run the binding using **afm-util** tool, here is the classic way to go : ```bash -afm-util run low-can-service@2.0 +afm-util run low-can-service@4.0 1 ``` @@ -132,14 +132,14 @@ But you can't control nor interact with it because you don't know security token So, to test it, it is better to launch the binding manually. In the following example, we will use port **1234** and left empty security token for testing purpose: ```bash -afb-daemon --ldpaths=/usr/lib/afb:/var/lib/afm/applications/low-can-service/2.0/lib/ --rootdir=/var/lib/afm/applications/low-can-service/2.0/ --port=1234 --token=1 +afb-daemon --binding=/var/lib/afm/applications/low-can-service/4.0/lib/afb-low-can.so --rootdir=/var/lib/afm/applications/low-can-service/4.0/ --port=1234 --token=1 NOTICE: binding [/usr/lib/afb/afb-dbus-binding.so] calling registering function afbBindingV1Register NOTICE: binding /usr/lib/afb/afb-dbus-binding.so loaded with API prefix dbus NOTICE: binding [/usr/lib/afb/authLogin.so] calling registering function afbBindingV1Register NOTICE: binding /usr/lib/afb/authLogin.so loaded with API prefix auth -NOTICE: binding [/var/lib/afm/applications/low-can-service/2.0/libs//low-can-binding.so] calling registering function afbBindingV1Register -NOTICE: binding /var/lib/afm/applications/low-can-service/2.0/libs//low-can-binding.so loaded with API prefix low-can -NOTICE: Waiting port=1234 rootdir=/var/lib/afm/applications/low-can-service/2.0/ +NOTICE: binding [/var/lib/afm/applications/low-can-service/4.0/libs//low-can-binding.so] calling registering function afbBindingV1Register +NOTICE: binding /var/lib/afm/applications/low-can-service/4.0/libs//low-can-binding.so loaded with API prefix low-can +NOTICE: Waiting port=1234 rootdir=/var/lib/afm/applications/low-can-service/4.0/ NOTICE: Browser URL= http:/*localhost:1234 ``` diff --git a/docs/Doc-Revisions.md b/docs/Doc-Revisions.md index 9f30d28a..c371ab41 100644 --- a/docs/Doc-Revisions.md +++ b/docs/Doc-Revisions.md @@ -4,3 +4,4 @@ Document revisions | Date | Version | Designation | Author | |-------------|---------|--------------------------------------|-------------------------| | 20 Mar 2017 | 1.0 | Initial release | R. Forlot [ Iot.bzh ] <br/> S. Douheret [ Iot.bzh ] | +| 20 Jun 2017 | 2.0 | Update documentation with new v4.0 features | R. Forlot [ Iot.bzh ] <br/> S. Douheret [ Iot.bzh ] | diff --git a/docs/resources/make_cover.sh b/docs/resources/make_cover.sh index fef20876..bcbfc1e9 100755 --- a/docs/resources/make_cover.sh +++ b/docs/resources/make_cover.sh @@ -3,8 +3,8 @@ cat cover.svg | sed -e 's/{title}/Low Level CAN binding/' \ -e 's/font-size:87.5px/font-size:50px/g' \ -e 's/{subtitle}//g' \ - -e 's/{version}/Version 1.0/g' \ - -e 's/{date}/March 2017/g' \ + -e 's/{version}/Version 4.0/g' \ + -e 's/{date}/June 2017/g' \ > /tmp/cover.svg # use imagemagick convert tool (cover size must be 1800x2360) |