3 * An AGL system installed with latest Daring Dab version with latest Application
4 framework version >= 0.6.
6 * Make sure you built the AGL generator else you will not be able to generate custom low-level CAN binding.
8 It will produce a _application-generated.cpp_ file to paste in the source, _CAN-binder/low-can-binding/binding/_, directory.
10 * 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).
12 If you need to have the graphic stack inside your SDK, you have to prepare your environment with the **iotbzh**, or **Daring Dab** 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 ] ...`:
14 > **NOTE** These commands assume that proprietary graphic drivers for Renesas Porter board are located in _/home/devel/share/proprietary-renesas-rcar_ directory.
17 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
18 /xdt/build/m3ulcb/agl-init-build-env
21 * (Optionnal) 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/)) if you want to connect to a real car through the OBD2 connector.
27 ## CAN config generator usage
29 ### Build requirements
31 * CMake version 3.3 or later
32 * G++, Clang++ or any C++11 compliant compiler.
37 source /xdt/sdk/environment-setup-aarch64-agl-linux
38 export PATH=$PATH:/xdt/sdk/sysroots/x86_64-aglsdk-linux/usr/bin
40 git clone --recursive https://gerrit.automotivelinux.org/gerrit/apps/agl-service-can-low-level -b Renesas_delivery_Q2
41 git clone --recursive https://gerrit.automotivelinux.org/gerrit/apps/low-level-can-generator
42 cd ${WD}/low-level-can-generator
45 cmake -G "Unix Makefiles" ..
51 We chose a doted naming convention because it's a well know schema.
53 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.
55 Let's take an example, here is an example about standard PID name following this convention:
59 engine.coolant.temperature
61 intake.manifold.pressure
64 intake.air.temperature
71 commanded.throttle.position
72 ethanol.fuel.percentage
73 accelerator.pedal.position
74 hybrid.battery-pack.remaining.life
75 engine.oil.temperature
79 > **NOTE** It's recommended that you follow this naming convention to named your CAN signals.
81 > There is only character `*` that is forbidden in names because it's used as wildcard for subscription and unsubscription.
83 > This described in the below chapter.
87 You can use some basic decoder provided by default by the binding which are:
89 * ***decoder_t::decode_noop*** : Default decoder if not specified, return raw value from signal's bitfield.
90 * ***decoder_t::decode_boolean*** : Coerces a numerical value to a boolean.
91 * ***decoder_t::decode_state*** : Find and return the corresponding string state for a CAN signal's raw integer value.
93 ### Generating JSON from Vector CANoe Database
95 > **CAUTION** This chapter has not been tested since it haven't necessary automotive tools for that.
97 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:
100 * Name of CAN signals within messages and their generic_name.
101 * Optionnaly name of diagnostic messages and their name.
103 To install the OpenXC utilities and runs `xml_to_json.py` script:
106 sudo pip install openxc
107 cd /usr/local/lib/python2.7/dist-packages/openxc/generator
110 Assuming the data exported from Vector is in `signals.xml` and your minimal mapping file is `mapping.json`, run the script:
113 python -m openxc.utils ./xml_to_json.py signals.xml mapping.json signals.json
116 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`.
118 The resulting file together with `mapping.json` will work as input to the code generation script.
120 ### Generate your config file
122 To generate your config file you just have to run the generator using the `-m` option to specify your JSON file.
125 ./can-config-generator -m ../tests/basic.json -o application-generated.cpp
128 If you omit the `-o` option, then code is generated on the stdout.
129 You also can specify a header and a footer file.
130 These files must be valid C++ fragment as long as they will be inserted as is.
131 Use the `-h` option to display help.
133 > **CAUTION:** Each `diagnostic_message` must define the same `bus` as the binding will use only one bus.
135 ### Supported OpenXC items
137 About now, compliance with OpenXC reference is in progress, can-config-generator and CAN\_signaling will implement them soon.
138 `initializers`, `loopers`, `commands` and `handlers` nodes are ignored for now.
140 This generator will follow OpenXC support status of the low level CAN signaling binding.
142 > **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.
144 ## Compile and install the binding
146 ### Build requirements
149 * CMake version 3.3 or later
150 * G++, Clang++ or any C++11 compliant compiler.
154 Clone the binding repository, copy the generated file and updated the git submodules.
156 Execute the following commands from this repository:
159 cd ${WD}/agl-service-can-low-level
160 cp ${WD}/low-level-can-generator/build/application-generated.cpp ../low-can-binding/binding
166 cd ${WD}/agl-service-can-low-level
174 To install it manually, you need to copy the _low-can-service.wgt_ file on your target, then from it execute the following commands :
176 On your host, to copy over the network :
179 scp low-can-service.wgt root@<target_IP>:~
182 On the target, assuming _**wgt**_ file is in the root home directory:
185 afm-util install low-can-service.wgt
186 { "added": "low-can-service@4.0" }