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 $ cd build
  62 $ cmake -G "Unix Makefiles" ..
  63 $ make
  64 ```
  65
  66 ### Naming convention
  67
  68 We chose a doted naming convention because it's a well know schema.
  69
  70 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.
  71
  72 Let's take an example, here is an example about standard PID name following this convention:
  73
  74 ```
  75 engine.load
  76 engine.coolant.temperature
  77 fuel.pressure
  78 intake.manifold.pressure
  79 engine.speed
  80 vehicle.speed
  81 intake.air.temperature
  82 mass.airflow
  83 throttle.position
  84 running.time
  85 EGR.error
  86 fuel.level
  87 barometric.pressure
  88 commanded.throttle.position
  89 ethanol.fuel.percentage
  90 accelerator.pedal.position
  91 hybrid.battery-pack.remaining.life
  92 engine.oil.temperature
  93 engine.torque
  94 ```
  95
  96 > **NOTE** It's recommended that you follow this naming convention to named your CAN signals.
  97 >
  98 > There is only character `*` that is forbidden in names because it's used as wildcard for subscription and unsubscrition.
  99 >
 100 > This described in the below chapter.
 101
 102 ### Generating JSON from Vector CANoe Database
 103
 104 > **CAUTION** This chapter has not been tested since we haven't necessary automotive tools for that.
 105
 106 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:
 107
 108 - CAN messages.
 109 - Name of CAN signals within messages and their generic_name.
 110 - Optionnaly name of diagnostic messages and their name.
 111
 112 To install the OpenXC utilities and runs `xml_to_json.py` script:
 113
 114 ```bash
 115 $ sudo pip install openxc
 116 $ cd /usr/local/lib/python2.7/dist-packages/openxc/generator
 117 ```
 118
 119 Assuming the data exported from Vector is in `signals.xml` and your minimal mapping file is `mapping.json`, run the script:
 120
 121 ```bash
 122 $ python -m openxc.utils ./xml_to_json.py signals.xml mapping.json signals.json
 123 ```
 124
 125 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`.
 126
 127 The resulting file together with `mapping.json` will work as input to the code generation script.
 128
 129 ### Generate your config file
 130
 131 To generate your config file you just have to run the generator using the `-m` option to specify your JSON file.
 132
 133 ```bash
 134 $ ./can-config-generator -m ../tests/basic.json -o configuration-generated.cpp
 135 ```
 136
 137 If you omit the `-o` option, then code is generated on the stdout.
 138 You also can specify a header and a footer file.
 139 These files must be valid C++ fragment as long as they will be inserted as is.
 140 Use the `-h` option to display help.
 141
 142 > **CAUTION:** Each `diagnostic_message` must define the same `bus` as the binding will use only one bus.
 143
 144 ### Supported OpenXC items
 145
 146 About now, compliance with OpenXC reference is in progress, can-config-generator and CAN\_signaling will implement them soon.
 147 `initializers`, `loopers`, `commands` and `handlers` nodes are ignored for now.
 148
 149 This generator will follow OpenXC support status of the low level CAN signaling binding.
 150
 151 > **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.
 152
 153 ## Compile and install the binding
 154
 155 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.
 156
 157 Then you can directly build and install the binding and source directory on your target system.
 158
 159 Execute these commands to get your binding compile :
 160
 161 ```bash
 162 $ mkdir build
 163 $ cd build
 164 $ cmake ..
 165 $ make
 166 ```
 167
 168 And if you have set TARGET variable, you can install it on your AGL system :
 169
 170 ```bash
 171 $ make install
 172 [ 16%] Built target bitfield
 173 [ 27%] Built target isotp
 174 [ 40%] Built target openxc
 175 [ 48%] Built target uds
 176 [ 97%] Built target low-can-binding
 177 [100%] Built target widget
 178 Install the project...
 179 -- Install configuration: ""
 180 true
 181 { "added": "low-can-binding@0.1" }
 182 ```
 183
 184 It's possible that you'll see the following message :
 185
 186 ```bash
 187 Error org.freedesktop.DBus.Error.Failed: "system error"
 188 ```
 189
 190 It's because installation remove the binding before installing it.
 191
 192 If it is the first time that you make the installation then you'll have this message in place of _**true**_.
 193
 194 To install it manually, you need to copy the _low-can-binding.wgt_ file on your target, then from it execute the following commands :
 195
 196 On your host, to copy over the network :
 197
 198 ```bash
 199 $ scp low-can-binding.wgt root@<target_IP>:~
 200 ```
 201
 202 On the target, assuming _**wgt**_ file is in the root home directory :
 203
 204 ```bash
 205 ~# afm-util install low-can-binding.wgt
 206 { "added": "low-can-binding@0.1" }
 207 ```