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 [guide](http://docs.iot.bzh/docs/getting_started/en/dev/reference/setup-sdk-environment.html).
  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:
  12
  13 > **NOTE** This command 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 ```
  18
  19 * Check that you updated git submodules, executing the following commands from this repository:
  20
  21 ```bash
  22 $ git clone https://github.com/iotbzh/CAN_signaling
  23 $ cd CAN_signaling
  24 $ git submodule init
  25 $ git submodule update
  26 ```
  27
  28 * 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/)).
  29
  30 # Getting started
  31
  32 ## Use of CAN config generator
  33
  34 ### Build requirements
  35
  36 * CMake version 3.0 or later
  37 * G++, Clang++ or any C++11 complient compiler.
  38 * Boost
  39   * filesystem
  40   * program\_options
  41   * system
  42
  43 You can install any of these using your package manager. For instance, inside the iotbzh's docker image, you must enter this command :
  44
  45 ```bash
  46 $ sudo apt-get update
  47 $ sudo apt-get install libboost-system-dev libboost-filesystem-dev libboost-program-options-dev
  48 ```
  49
  50 You may want to install `libboost-all-dev` to get all boost components even if it's not required.
  51
  52 ### Compile
  53
  54 > **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.
  55
  56 ```bash
  57 $ export PATH=$PATH:/xdt/sdk/sysroots/x86_64-aglsdk-linux/usr/bin
  58 $ git clone https://github.com/iotbzh/can-config-generator.git
  59 $ cd can-config-generator
  60 $ mkdir build
  61 $ cmake -G "Unix Makefiles" ..
  62 ```
  63
  64 ### Naming convention
  65
  66 We chose a doted naming convention because it's a well know schema.
  67
  68 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.
  69
  70 Let's take an example, here is an example about standard PID name following this convention:
  71
  72 ```
  73 engine.load
  74 engine.coolant.temperature
  75 fuel.pressure
  76 intake.manifold.pressure
  77 engine.speed
  78 vehicle.speed
  79 intake.air.temperature
  80 mass.airflow
  81 throttle.position
  82 running.time
  83 EGR.error
  84 fuel.level
  85 barometric.pressure
  86 commanded.throttle.position
  87 ethanol.fuel.percentage
  88 accelerator.pedal.position
  89 hybrid.battery-pack.remaining.life
  90 engine.oil.temperature
  91 engine.torque
  92 ```
  93
  94 > **NOTE** It's recommended that you follow this naming convention to named your CAN signals.
  95 > There is only character `*` that is forbidden in names because it's used as wildcard for subscription and unsubscrition.
  96 > This described in the below chapter.
  97
  98 ### Generating JSON from Vector CANoe Database
  99
 100 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:
 101
 102 - CAN messages.
 103 - Name of CAN signals within messages and their generic_name.
 104 - Optionnaly name of diagnostic messages and their name.
 105
 106 To install the OpenXC utilities and runs `xml_to_json.py` script:
 107
 108 ```bash
 109 $ sudo pip install openxc
 110 $ cd /usr/local/lib/python2.7/dist-packages/openxc-0.13.0-py2.7.egg/openxc/generator
 111 ```
 112
 113 Assuming the data exported from Vector is in `signals.xml` and your minimal mapping file is `mapping.json`, run the script:
 114
 115 ```bash
 116 $ ./xml_to_json.py signals.xml mapping.json signals.json
 117 ```
 118
 119 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`.
 120
 121 The resulting file together with `mapping.json` will work as input to the code generation script.
 122
 123 ### Generate your config file
 124
 125 To generate your config file you just have to run the generator using the `-m` option to specify your JSON file.
 126
 127 ```bash
 128 $ can-config-generator -m ../tests/basic.json -o configuration-generated.cpp
 129 ```
 130
 131 If you omit the `-o` option, then code is generated on the stdout.
 132 You also can specify a header and a footer file.
 133 These files must be valid C++ fragment as long as they will be inserted as is.
 134 Use the `-h` option to display help.
 135
 136 > **CAUTION:** Each `diagnostic_message` must define the same `bus` as the binding will use only one bus.
 137
 138 ### Supported OpenXC items
 139
 140 About now, compliance with OpenXC reference is in progress, can-config-generator and CAN\_signaling will implement them soon.
 141 `initializers`, `loopers`, `commands` and `handlers` nodes are ignored for now.
 142
 143 This generator will follow OpenXC support status of the low level CAN signaling binding.
 144
 145 > **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.
 146
 147 ## Compile and install the binding
 148
 149 With an AGL SDK environment correctly configured and **sourced**, I suggest you to set the TARGET variable in the root CMakeLists.txt file if you have an AGL target already running in your network.
 150
 151 Then you can directly build and install the binding and source directory on your target system.
 152
 153 Execute these commands to get your binding compile :
 154
 155 ```bash
 156 $ mkdir build
 157 $ cd build
 158 $ cmake ..
 159 $ make
 160 ```
 161
 162 And if you have set TARGET variable, you can install it on your AGL system :
 163
 164 ```bash
 165 $ make install
 166 [ 16%] Built target bitfield
 167 [ 27%] Built target isotp
 168 [ 40%] Built target openxc
 169 [ 48%] Built target uds
 170 [ 97%] Built target low-can-binding
 171 [100%] Built target widget
 172 Install the project...
 173 -- Install configuration: ""
 174 true
 175 { "added": "low-can-binding@0.1" }
 176 ```
 177
 178 It's possible that you'll see the following message :
 179
 180 ```bash
 181 Error org.freedesktop.DBus.Error.Failed: "system error"
 182 ```
 183
 184 It's because installation remove the binding before installing it.
 185
 186 If it is the first time that you make the installation then you'll have this message in place of _**true**_.
 187
 188 To install it manually, you need to copy the _low-can-binding.wgt_ file on your target, then from it execute the following commands :
 189
 190 On your host, to copy over the network :
 191
 192 ```bash
 193 $ scp low-can-binding.wgt root@<target_IP>:~
 194 ```
 195
 196 On the target, assuming _**wgt**_ file is in the root home directory :
 197
 198 ```bash
 199 ~# afm-util install low-can-binding.wgt
 200 { "added": "low-can-binding@0.1" }
 201 ```