converter: Fix to_hex conversion

[apps/agl-service-can-low-level.git] / docs / 2-Installation.md

diff --git a/docs/2-Installation.md b/docs/2-Installation.md
index 13b2cd6..fd6360b 100644 (file)
--- a/docs/2-Installation.md
+++ b/docs/2-Installation.md
@@ -7,7 +7,7 @@ framework version >= 0.6.
 
 It will produce a _application-generated.cpp_ file to paste in the source, _CAN-binder/low-can-binding/binding/_, directory.
 
-* 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).
+* Make sure you already set up the AGL SDK using the following [Download or Build Your SDK Installer](../../../getting_started/reference/getting-started/app-workflow-sdk.html). Alternatively, please refer to official guides available on [AGL Developer Site](../../../devguides).
 
 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 ] ...`:
 
@@ -18,17 +18,17 @@ prepare_meta -f iotbzh -o /xdt -l /home/devel/mirror -p /home/devel/share/propri
 /xdt/build/m3ulcb/agl-init-build-env
 ```
 
-* An [USB CAN adapter](http://shop.8devices.com/usb2can) connected to connector through the [right cable](http://www.mouser.fr/ProductDetail/EasySync/OBD-M-DB9-F-ES/)).
+* (Optionnal) An [USB CAN adapter](https://shop.8devices.com/index.php?route=product/product&path=67&product_id=54) connected to connector through the [right cable](https://www.mouser.fr/ProductDetail/EasySync/OBD-M-DB9-F-ES?qs=pLQRQR43dtrcAQQLCUAIxA%3D%3D) if you want to connect to a real car through the OBD2 connector.
 
 <!-- pagebreak -->
 
 # Getting started
 
-## Use of CAN config generator
+## CAN config generator usage
 
 ### Build requirements
 
-* CMake version 3.0 or later
+* CMake version 3.3 or later
 * G++, Clang++ or any C++11 compliant compiler.
 
 ### Compile
@@ -37,7 +37,7 @@ prepare_meta -f iotbzh -o /xdt -l /home/devel/mirror -p /home/devel/share/propri
 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 -b Renesas_delivery_Q2
+git clone --recursive https://gerrit.automotivelinux.org/gerrit/apps/agl-service-can-low-level -b Renesas_delivery_Q2
 git clone --recursive https://gerrit.automotivelinux.org/gerrit/apps/low-level-can-generator
 cd ${WD}/low-level-can-generator
 mkdir -p build
@@ -86,13 +86,13 @@ engine.torque
 
 You can use some basic decoder provided by default by the binding which are:
 
-* ***decoder_t::noopDecoder*** : Default decoder if not specified, return raw value from signal's bitfield.
-* ***decoder_t::booleanDecoder*** : Coerces a numerical value to a boolean.
-* ***decoder_t::stateDecoder***s : Find and return the corresponding string state for a CAN signal's raw integer value.
+* ***decoder_t::decode_noop*** : Default decoder if not specified, return raw value from signal's bitfield.
+* ***decoder_t::decode_boolean*** : Coerces a numerical value to a boolean.
+* ***decoder_t::decode_state*** : Find and return the corresponding string state for a CAN signal's raw integer value.
 
 ### Generating JSON from Vector CANoe Database
 
-> **CAUTION** This chapter has not been tested since we haven't necessary automotive tools for that.
+> **CAUTION** This chapter has not been tested since it haven't necessary automotive tools for that.
 
 If you use CANoe to store your `gold standard` CAN signal definitions, you may be able to use the OpenXC `xml_to_json.py` script to make your JSON for you. First, export the Canoe .dbc file as XML - you can do this with Vector CANdb++. Next, create a JSON file according to the format defined above, but only define:
 
@@ -143,19 +143,27 @@ This generator will follow OpenXC support status of the low level CAN signaling
 
 ## Compile and install the binding
 
+### Build requirements
+
+* Kernel >= 4.8
+* CMake version 3.3 or later
+* G++, Clang++ or any C++11 compliant compiler.
+
+### Compile
+
 Clone the binding repository, copy the generated file and updated the git submodules.
 
 Execute the following commands from this repository:
 
 ```bash
-cd $WD/low-level-can-service/CAN-binder
-cp ${GENERATOR}/build/application-generated.cpp ../low-can-binding/binding
+cd ${WD}/agl-service-can-low-level
+cp ${WD}/low-level-can-generator/build/application-generated.cpp ../low-can-binding/binding
 ```
 
 ### Installation
 
 ```bash
-cd $CAN_/CAN-binder
+cd ${WD}/agl-service-can-low-level
 mkdir build
 cd build
 cmake ..