X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=docs%2F2-Installation.md;h=784a0623094f76deaf455ac2b56e46ade34d84bb;hb=12e680a3c97a2750c657a8c561a79706f3689149;hp=410bc4b613fe5d868f70b6a141eeeb91df00e235;hpb=aec5f7ddb8f9931e4a65b49949e518c40eda6507;p=apps%2Fagl-service-can-low-level.git

diff --git a/docs/2-Installation.md b/docs/2-Installation.md
index 410bc4b6..784a0623 100644
--- a/docs/2-Installation.md
+++ b/docs/2-Installation.md
@@ -28,7 +28,7 @@ $ /xdt/build/agl-init-build-env
 ### Build requirements
 
 * CMake version 3.0 or later
-* G++, Clang++ or any C++11 complient compiler.
+* G++, Clang++ or any C++11 compliant compiler.
 * Boost
   * filesystem
   * program\_options
@@ -90,13 +90,21 @@ engine.torque
 
 > **NOTE** It's recommended that you follow this naming convention to named your CAN signals.
 >
-> There is only character `*` that is forbidden in names because it's used as wildcard for subscription and unsubscrition.
+> There is only character `*` that is forbidden in names because it's used as wildcard for subscription and unsubscription.
 >
 > This described in the below chapter.
 
+### Available decoder
+
+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 : 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 we 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:
 
@@ -129,16 +137,16 @@ To generate your config file you just have to run the generator using the `-m` o
 $ ./can-config-generator -m ../tests/basic.json -o configuration-generated.cpp
 ```
 
-If you omit the `-o` option, then code is generated on the stdout.  
-You also can specify a header and a footer file.  
-These files must be valid C++ fragment as long as they will be inserted as is.  
+If you omit the `-o` option, then code is generated on the stdout.
+You also can specify a header and a footer file.
+These files must be valid C++ fragment as long as they will be inserted as is.
 Use the `-h` option to display help.
 
 > **CAUTION:** Each `diagnostic_message` must define the same `bus` as the binding will use only one bus.
 
 ### Supported OpenXC items
 
-About now, compliance with OpenXC reference is in progress, can-config-generator and CAN\_signaling will implement them soon.  
+About now, compliance with OpenXC reference is in progress, can-config-generator and CAN\_signaling will implement them soon.
 `initializers`, `loopers`, `commands` and `handlers` nodes are ignored for now.
 
 This generator will follow OpenXC support status of the low level CAN signaling binding.
@@ -152,7 +160,7 @@ Execute the following commands from this repository:
 
 ```bash
 $ cd $WD
-$ git clone https://github.com/iotbzh/CAN_signaling
+$ git clone https://github.com/iotbzh/CAN_signaling -b v1.0
 $ cd CAN_signaling
 $ git submodule init
 $ git submodule update