It will produce a _configuration-generated.cpp_ file to paste in the source, _src/_, directory.
-* 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).
+* 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).
-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:
+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 ] ...`:
-```bash
-$ 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
-```
-
-* Check that you updated git submodules, executing the following commands from this repository:
+> **NOTE** These commands assume that proprietary graphic drivers for Renesas Porter board are located in `/home/devel/share/proprietary-renesas-rcar` directory.
```bash
-$ git submodule init
-$ git submodule update
+$ 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
+$ /xdt/build/agl-init-build-env
```
* 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/)).
+<!-- pagebreak -->
+
# Getting started
## Use of CAN config generator
You can install any of these using your package manager. For instance, inside the iotbzh's docker image, you must enter this command :
```bash
-$ sudo apt-get install cmake libboost-system-dev libboost-filesystem-dev libboost-program-options-dev
+$ sudo apt-get update
+$ sudo apt-get install libboost-system-dev libboost-filesystem-dev libboost-program-options-dev
```
You may want to install `libboost-all-dev` to get all boost components even if it's not required.
### Compile
-> **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.
+> **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.
```bash
+$ export PATH=$PATH:/xdt/sdk/sysroots/x86_64-aglsdk-linux/usr/bin
+$ export WD=$(pwd)
$ git clone https://github.com/iotbzh/can-config-generator.git
-Cloning into 'can-config-generator'...
-remote: Counting objects: 74, done.
-remote: Compressing objects: 100% (42/42), done.
-remote: Total 74 (delta 30), reused 67 (delta 27), pack-reused 0
-Unpacking objects: 100% (74/74), done.
-Checking connectivity... done.
-
-<b>devel@bsp-devkit:~/projects/$</b> cd can-config-generator
-<b>devel@bsp-devkit:~/projects/can-config-generator/(master)$</b> mkdir build
-<b>devel@bsp-devkit:~/projects/can-config-generator/build(master)$</b> cmake -G "Unix Makefiles" ..
--- The C compiler identification is GNU 4.9.2
--- The CXX compiler identification is GNU 4.9.2
--- Check for working C compiler: /usr/bin/cc
--- Check for working C compiler: /usr/bin/cc -- works
--- Detecting C compiler ABI info
--- Detecting C compiler ABI info - done
--- Check for working CXX compiler: /usr/bin/c++
--- Check for working CXX compiler: /usr/bin/c++ -- works
--- Detecting CXX compiler ABI info
--- Detecting CXX compiler ABI info - done
--- Boost version: 1.55.0
--- Found the following Boost libraries:
--- program_options
--- filesystem
--- system
--- Configuring done
--- Generating done
--- Build files have been written to: /home/devel/projects/can-config-generator/build
-<b>devel@bsp-devkit:~/projects/can-config-generator/build(master)$</b> make
-Scanning dependencies of target can-config-generator
-[ 12%] Building CXX object CMakeFiles/can-config-generator.dir/src/main.cpp.o
-[ 25%] Building CXX object CMakeFiles/can-config-generator.dir/src/openxc/message_set.cpp.o
-[ 37%] Building CXX object CMakeFiles/can-config-generator.dir/src/openxc/can_bus.cpp.o
-[ 50%] Building CXX object CMakeFiles/can-config-generator.dir/src/openxc/can_message.cpp.o
-[ 62%] Building CXX object CMakeFiles/can-config-generator.dir/src/openxc/command.cpp.o
-[ 75%] Building CXX object CMakeFiles/can-config-generator.dir/src/openxc/diagnostic_message.cpp.o
-[ 87%] Building CXX object CMakeFiles/can-config-generator.dir/src/openxc/mapping.cpp.o
-[100%] Building CXX object CMakeFiles/can-config-generator.dir/src/openxc/signal.cpp.o
-Linking CXX executable can-config-generator
-[100%] Built target can-config-generator
+$ cd can-config-generator
+$ mkdir -p build
+$ cd build
+$ cmake -G "Unix Makefiles" ..
+$ make
```
### Naming convention
-We choose a doted naming convention because it's a well know schema.
+We chose a doted naming convention because it's a well know schema.
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.
```
> **NOTE** It's recommended that you follow this naming convention to named your CAN signals.
+>
> There is only character `*` that is forbidden in names because it's used as wildcard for subscription and unsubscrition.
+>
> This described in the below chapter.
### Generating JSON from Vector CANoe Database
-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:
+> **CAUTION** This chapter has not been tested since we haven't necessary automotive tools for that.
+
+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:
- CAN messages.
- Name of CAN signals within messages and their generic_name.
```bash
$ sudo pip install openxc
-$ cd /usr/local/lib/python2.7/dist-packages/openxc-0.13.0-py2.7.egg/openxc/generator
+$ cd /usr/local/lib/python2.7/dist-packages/openxc/generator
```
Assuming the data exported from Vector is in `signals.xml` and your minimal mapping file is `mapping.json`, run the script:
```bash
-$ ./xml_to_json.py signals.xml mapping.json signals.json
+$ python -m openxc.utils ./xml_to_json.py signals.xml mapping.json signals.json
```
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`.
To generate your config file you just have to run the generator using the `-m` option to specify your JSON file.
```bash
-$ can-config-generator -m ../tests/basic.json -o configuration-generated.cpp
+$ ./can-config-generator -m ../tests/basic.json -o configuration-generated.cpp
```
If you omit the `-o` option, then code is generated on the stdout.
> **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.
## Compile and install the binding
+Clone the binding repository, copy the generated file and updated the git submodules.
-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.
+Execute the following commands from this repository:
+
+```bash
+$ cd $WD
+$ git clone https://github.com/iotbzh/CAN_signaling
+$ cd CAN_signaling
+$ git submodule init
+$ git submodule update
+$ cp $WD/can-config-generator/build/configuration-generated.cpp src/
+```
+
+### Installation using *make install*
+
+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.
Then you can directly build and install the binding and source directory on your target system.
-Execute these commands to get your binding compile :
+Execute these commands to get your binding compile:
```bash
-$ mkdir build
+$ mkdir -p build
$ cd build
$ cmake ..
$ make
```
-And if you have set TARGET variable, you can install it on your AGL system :
+And if you have set TARGET variable, you can install it on your AGL system:
```bash
$ make install
If it is the first time that you make the installation then you'll have this message in place of _**true**_.
+### Manual Installation
+
To install it manually, you need to copy the _low-can-binding.wgt_ file on your target, then from it execute the following commands :
On your host, to copy over the network :
$ scp low-can-binding.wgt root@<target_IP>:~
```
-On the target, assuming _**wgt**_ file is in the root home directory :
+On the target, assuming _**wgt**_ file is in the root home directory:
```bash
-~# afm-util install low-can-binding.wgt
+# afm-util install low-can-binding.wgt
{ "added": "low-can-binding@0.1" }
```
Code Review / apps / agl-service-can-low-level.git / blobdiff