docs/2-Installation.md

   1 # Prerequisites
   2
   3 * An AGL system installed with latest Chinook version \(&gt;3.0.2\).
   4
   5 * Make sure you built the AGL generator else you will not be able to generate custom low-level CAN binding. Generator can be found [here](http://github.com/iotbzh/can-config-generator) with the attached instruction to install and run it.
   6
   7 It will produce a _configuration-generated.cpp_ file to paste in the source, _src/_, directory.
   8
   9 * 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).
  10
  11 To get the correct SDK version installed, you **must** prepare your environment with the **chinook-next** version. To do so, run the following command in your docker image in the step 4 in place of `... [ prepare build environment ] ...`:
  12
  13 > **NOTE** These commands assume that proprietary graphic drivers for Renesas Porter board are located in `/home/devel/share/proprietary-renesas-rcar` directory.
  14
  15 ```bash
  16 $ prepare_meta -f chinook-next -o /xdt -l /home/devel/mirror -p /home/devel/share/proprietary-renesas-rcar/ -t porter -e wipeconfig -e rm_work
  17 $ /xdt/build/agl-init-build-env
  18 ```
  19
  20 * 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/)).
  21
  22 <!-- pagebreak -->
  23
  24 # Getting started
  25
  26 ## Use of CAN config generator
  27
  28 ### Build requirements
  29
  30 * CMake version 3.0 or later
  31 * G++, Clang++ or any C++11 compliant compiler.
  32 * Boost
  33   * filesystem
  34   * program\_options
  35   * system
  36
  37 You can install any of these using your package manager. For instance, inside the iotbzh's docker image, you must enter this command :
  38
  39 ```bash
  40 $ sudo apt-get update
  41 $ sudo apt-get install libboost-system-dev libboost-filesystem-dev libboost-program-options-dev
  42 ```
  43
  44 You may want to install `libboost-all-dev` to get all boost components even if it's not required.
  45
  46 ### Compile
  47
  48 > **CAUTION** It is **very important** that you do not source the SDK environment file to compile this project because some build requirements aren't installed in the AGL SDK for now.
  49
  50 ```bash
  51 $ export PATH=$PATH:/xdt/sdk/sysroots/x86_64-aglsdk-linux/usr/bin
  52 $ export WD=$(pwd)
  53 $ git clone https://github.com/iotbzh/can-config-generator.git
  54 $ cd can-config-generator
  55 $ mkdir -p build
  56 $ cd build
  57 $ cmake -G "Unix Makefiles" ..
  58 $ make
  59 ```
  60
  61 ### Naming convention
  62
  63 We chose a doted naming convention because it's a well know schema.
  64
  65 It separates and organize names into hierarchy. From the left to right, you describe your names using the more common ancestor at the left then more you go to the right the more it will be accurate.
  66
  67 Let's take an example, here is an example about standard PID name following this convention:
  68
  69 ```
  70 engine.load
  71 engine.coolant.temperature
  72 fuel.pressure
  73 intake.manifold.pressure
  74 engine.speed
  75 vehicle.speed
  76 intake.air.temperature
  77 mass.airflow
  78 throttle.position
  79 running.time
  80 EGR.error
  81 fuel.level
  82 barometric.pressure
  83 commanded.throttle.position
  84 ethanol.fuel.percentage
  85 accelerator.pedal.position
  86 hybrid.battery-pack.remaining.life
  87 engine.oil.temperature
  88 engine.torque
  89 ```
  90
  91 > **NOTE** It's recommended that you follow this naming convention to named your CAN signals.
  92 >
  93 > There is only character `*` that is forbidden in names because it's used as wildcard for subscription and unsubscription.
  94 >
  95 > This described in the below chapter.
  96
  97 ### Available decoder
  98
  99 You can use some basic decoder provided by default by the binding which are:
 100
 101 * decoder_t::noopDecoder : Default decoder if not specified, return raw value from signal's bitfield.
 102 * decoder_t::booleanDecoder : Coerces a numerical value to a boolean.
 103 * decoder_t::stateDecoder : Find and return the corresponding string state for a CAN signal's raw integer value.
 104
 105 ### Generating JSON from Vector CANoe Database
 106
 107 > **CAUTION** This chapter has not been tested since we haven't necessary automotive tools for that.
 108
 109 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:
 110
 111 - CAN messages.
 112 - Name of CAN signals within messages and their generic_name.
 113 - Optionnaly name of diagnostic messages and their name.
 114
 115 To install the OpenXC utilities and runs `xml_to_json.py` script:
 116
 117 ```bash
 118 $ sudo pip install openxc
 119 $ cd /usr/local/lib/python2.7/dist-packages/openxc/generator
 120 ```
 121
 122 Assuming the data exported from Vector is in `signals.xml` and your minimal mapping file is `mapping.json`, run the script:
 123
 124 ```bash
 125 $ python -m openxc.utils ./xml_to_json.py signals.xml mapping.json signals.json
 126 ```
 127
 128 The script scans `mapping.json` to identify the CAN messages and signals that you want to use from the XML file. It pulls the neccessary details of the messages (bit position, bit size, offset, etc) and outputs the resulting subset as JSON into the output file, `signals.json`.
 129
 130 The resulting file together with `mapping.json` will work as input to the code generation script.
 131
 132 ### Generate your config file
 133
 134 To generate your config file you just have to run the generator using the `-m` option to specify your JSON file.
 135
 136 ```bash
 137 $ ./can-config-generator -m ../tests/basic.json -o configuration-generated.cpp
 138 ```
 139
 140 If you omit the `-o` option, then code is generated on the stdout.
 141 You also can specify a header and a footer file.
 142 These files must be valid C++ fragment as long as they will be inserted as is.
 143 Use the `-h` option to display help.
 144
 145 > **CAUTION:** Each `diagnostic_message` must define the same `bus` as the binding will use only one bus.
 146
 147 ### Supported OpenXC items
 148
 149 About now, compliance with OpenXC reference is in progress, can-config-generator and CAN\_signaling will implement them soon.
 150 `initializers`, `loopers`, `commands` and `handlers` nodes are ignored for now.
 151
 152 This generator will follow OpenXC support status of the low level CAN signaling binding.
 153
 154 > **NOTE**: The `buses` item will not be supported by this generator because the binding use another way to declare and configure buses. Please refer to the binding's documentation.
 155
 156 ## Compile and install the binding
 157 Clone the binding repository, copy the generated file and updated the git submodules.
 158
 159 Execute the following commands from this repository:
 160
 161 ```bash
 162 $ cd $WD
 163 $ git clone https://github.com/iotbzh/CAN_signaling -b v1.0
 164 $ cd CAN_signaling
 165 $ git submodule init
 166 $ git submodule update
 167 $ cp $WD/can-config-generator/build/configuration-generated.cpp src/
 168 ```
 169
 170 ### Installation using *make install*
 171
 172 With an AGL SDK environment correctly configured and **sourced**, I suggest you to set the TARGET variable in the CMakeLists.txt file located under _src_ directory if you have an AGL target already running in your network.
 173
 174 Then you can directly build and install the binding and source directory on your target system.
 175
 176 Execute these commands to get your binding compile:
 177
 178 ```bash
 179 $ mkdir -p build
 180 $ cd build
 181 $ cmake ..
 182 $ make
 183 ```
 184
 185 And if you have set TARGET variable, you can install it on your AGL system:
 186
 187 ```bash
 188 $ make install
 189 [ 16%] Built target bitfield
 190 [ 27%] Built target isotp
 191 [ 40%] Built target openxc
 192 [ 48%] Built target uds
 193 [ 97%] Built target low-can-binding
 194 [100%] Built target widget
 195 Install the project...
 196 -- Install configuration: ""
 197 true
 198 { "added": "low-can-binding@0.1" }
 199 ```
 200
 201 It's possible that you'll see the following message :
 202
 203 ```bash
 204 Error org.freedesktop.DBus.Error.Failed: "system error"
 205 ```
 206
 207 It's because installation remove the binding before installing it.
 208
 209 If it is the first time that you make the installation then you'll have this message in place of _**true**_.
 210
 211 ### Manual Installation
 212
 213 To install it manually, you need to copy the _low-can-binding.wgt_ file on your target, then from it execute the following commands :
 214
 215 On your host, to copy over the network :
 216
 217 ```bash
 218 $ scp low-can-binding.wgt root@<target_IP>:~
 219 ```
 220
 221 On the target, assuming _**wgt**_ file is in the root home directory:
 222
 223 ```bash
 224 # afm-util install low-can-binding.wgt
 225 { "added": "low-can-binding@0.1" }
 226 ```