docs/2-Installation.md

   1 # Prerequisites
   2
   3 * An AGL system installed with latest Daring Dab version.
   4
   5 * Make sure you built the AGL generator else you will not be able to generate custom low-level CAN binding.
   6
   7 It will produce a _application-generated.cpp_ file to paste in the source, _CAN-binder/low-can-binding/binding/_, 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 **iotbzh** 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 ] ...`:
  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 iotbzh -o /xdt -l /home/devel/mirror -p /home/devel/share/proprietary-renesas-rcar/ -t m3ulcb -e wipeconfig -e rm_work -e cleartemp
  17 /xdt/build/m3ulcb/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
  33 ### Compile
  34
  35 ```bash
  36 source /xdt/sdk/environment-setup-aarch64-agl-linux
  37 export PATH=$PATH:/xdt/sdk/sysroots/x86_64-aglsdk-linux/usr/bin
  38 export WD=$(pwd)
  39 git clone --recursive https://gerrit.automotivelinux.org/gerrit/apps/low-level-can-service
  40 export GENERATOR=${WD}/CAN-signaling/CAN-config-generator
  41 cd ${GENERATOR}
  42 mkdir -p build
  43 cd build
  44 cmake -G "Unix Makefiles" ..
  45 make
  46 ```
  47
  48 ### Naming convention
  49
  50 We chose a doted naming convention because it's a well know schema.
  51
  52 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.
  53
  54 Let's take an example, here is an example about standard PID name following this convention:
  55
  56 ```
  57 engine.load
  58 engine.coolant.temperature
  59 fuel.pressure
  60 intake.manifold.pressure
  61 engine.speed
  62 vehicle.speed
  63 intake.air.temperature
  64 mass.airflow
  65 throttle.position
  66 running.time
  67 EGR.error
  68 fuel.level
  69 barometric.pressure
  70 commanded.throttle.position
  71 ethanol.fuel.percentage
  72 accelerator.pedal.position
  73 hybrid.battery-pack.remaining.life
  74 engine.oil.temperature
  75 engine.torque
  76 ```
  77
  78 > **NOTE** It's recommended that you follow this naming convention to named your CAN signals.
  79 >
  80 > There is only character `*` that is forbidden in names because it's used as wildcard for subscription and unsubscription.
  81 >
  82 > This described in the below chapter.
  83
  84 ### Available decoder
  85
  86 You can use some basic decoder provided by default by the binding which are:
  87
  88 * ***decoder_t::noopDecoder*** : Default decoder if not specified, return raw value from signal's bitfield.
  89 * ***decoder_t::booleanDecoder*** : Coerces a numerical value to a boolean.
  90 * ***decoder_t::stateDecoder***s : Find and return the corresponding string state for a CAN signal's raw integer value.
  91
  92 ### Generating JSON from Vector CANoe Database
  93
  94 > **CAUTION** This chapter has not been tested since we haven't necessary automotive tools for that.
  95
  96 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:
  97
  98 * CAN messages.
  99 * Name of CAN signals within messages and their generic_name.
 100 * Optionnaly name of diagnostic messages and their name.
 101
 102 To install the OpenXC utilities and runs `xml_to_json.py` script:
 103
 104 ```bash
 105 sudo pip install openxc
 106 cd /usr/local/lib/python2.7/dist-packages/openxc/generator
 107 ```
 108
 109 Assuming the data exported from Vector is in `signals.xml` and your minimal mapping file is `mapping.json`, run the script:
 110
 111 ```bash
 112 python -m openxc.utils ./xml_to_json.py signals.xml mapping.json signals.json
 113 ```
 114
 115 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`.
 116
 117 The resulting file together with `mapping.json` will work as input to the code generation script.
 118
 119 ### Generate your config file
 120
 121 To generate your config file you just have to run the generator using the `-m` option to specify your JSON file.
 122
 123 ```bash
 124 ./can-config-generator -m ../tests/basic.json -o application-generated.cpp
 125 ```
 126
 127 If you omit the `-o` option, then code is generated on the stdout.
 128 You also can specify a header and a footer file.
 129 These files must be valid C++ fragment as long as they will be inserted as is.
 130 Use the `-h` option to display help.
 131
 132 > **CAUTION:** Each `diagnostic_message` must define the same `bus` as the binding will use only one bus.
 133
 134 ### Supported OpenXC items
 135
 136 About now, compliance with OpenXC reference is in progress, can-config-generator and CAN\_signaling will implement them soon.
 137 `initializers`, `loopers`, `commands` and `handlers` nodes are ignored for now.
 138
 139 This generator will follow OpenXC support status of the low level CAN signaling binding.
 140
 141 > **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.
 142
 143 ## Compile and install the binding
 144
 145 Clone the binding repository, copy the generated file and updated the git submodules.
 146
 147 Execute the following commands from this repository:
 148
 149 ```bash
 150 cd $WD/low-level-can-service/CAN-binder
 151 cp ${GENERATOR}/build/application-generated.cpp ../low-can-binding/binding
 152 ```
 153
 154 ### Installation
 155
 156 ```bash
 157 cd $WD/low-level-can-service/CAN-binder
 158 mkdir build
 159 cd build
 160 cmake ..
 161 make
 162 make widget
 163 ```
 164
 165 To install it manually, you need to copy the _low-can-service.wgt_ file on your target, then from it execute the following commands :
 166
 167 On your host, to copy over the network :
 168
 169 ```bash
 170 scp low-can-service.wgt root@<target_IP>:~
 171 ```
 172
 173 On the target, assuming _**wgt**_ file is in the root home directory:
 174
 175 ```bash
 176 afm-util install low-can-service.wgt
 177 { "added": "low-can-service@2.0" }
 178 ```