aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorRomain Forlot <romain.forlot@iot.bzh>2017-06-20 14:43:28 +0000
committerRomain Forlot <romain.forlot@iot.bzh>2017-06-20 14:43:28 +0000
commit0ac88a39962a3f723fcb5a07c4eb5c6d19e585f9 (patch)
treefeaa1219ffb3a3d08ddda83da681d6f07738290c /docs
parent0d0ba83070e7b6ea9f4e20cdcf855d886f901bc4 (diff)
Review of documentation
Change-Id: I49763cc9264c0121db2950cfee56d69c66d0e4c7 Signed-off-by: Romain Forlot <romain.forlot@iot.bzh>
Diffstat (limited to 'docs')
-rw-r--r--docs/1-Architecture.md4
-rw-r--r--docs/2-Installation.md22
-rw-r--r--docs/3-Usage.md2
3 files changed, 18 insertions, 10 deletions
diff --git a/docs/1-Architecture.md b/docs/1-Architecture.md
index 50cf1f1e..c7cdff32 100644
--- a/docs/1-Architecture.md
+++ b/docs/1-Architecture.md
@@ -1,6 +1,6 @@
# AGL CAN binding architecture proposal
-It's meant to generate from a JSON file describing CAN messages and diagnostic message \(OBD2 for now\), a cpp file to integrate with the project.
+It's meant to generate, from a JSON file describing CAN messages and diagnostic message \(OBD2 for now\), a cpp file to integrate with the project.
Once generated binding is built with it and result will be a widget file to install on an AGL target system.
@@ -22,4 +22,4 @@ It will provides valuable access to the CAN bus by aggregate signals or providin
![Communication between CAN bindings and third applications](images/CAN_bindings_communication.png)
-Last be not least, the low level binding can be shipped as binary only using OpenXC inspired [AGL low level CAN binding Generator](http://github.com/iotbzh/can-config-generator).
+Last but not least, the low level binding can be shipped as binary only using OpenXC inspired [AGL low level CAN binding Generator](http://github.com/iotbzh/can-config-generator).
diff --git a/docs/2-Installation.md b/docs/2-Installation.md
index 13b2cd61..dc792741 100644
--- a/docs/2-Installation.md
+++ b/docs/2-Installation.md
@@ -18,17 +18,17 @@ prepare_meta -f iotbzh -o /xdt -l /home/devel/mirror -p /home/devel/share/propri
/xdt/build/m3ulcb/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/)).
+* (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.
<!-- pagebreak -->
# Getting started
-## Use of CAN config generator
+## CAN config generator usage
### Build requirements
-* CMake version 3.0 or later
+* CMake version 3.3 or later
* G++, Clang++ or any C++11 compliant compiler.
### Compile
@@ -92,7 +92,7 @@ You can use some basic decoder provided by default by the binding which are:
### Generating JSON from Vector CANoe Database
-> **CAUTION** This chapter has not been tested since we haven't necessary automotive tools for that.
+> **CAUTION** This chapter has not been tested since it 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:
@@ -143,19 +143,27 @@ This generator will follow OpenXC support status of the low level CAN signaling
## Compile and install the binding
+### Build requirements
+
+* Kernel >= 4.8
+* CMake version 3.3 or later
+* G++, Clang++ or any C++11 compliant compiler.
+
+### Compile
+
Clone the binding repository, copy the generated file and updated the git submodules.
Execute the following commands from this repository:
```bash
-cd $WD/low-level-can-service/CAN-binder
-cp ${GENERATOR}/build/application-generated.cpp ../low-can-binding/binding
+cd ${WD}/low-level-can-service
+cp ${WD}/low-level-can-generator/build/application-generated.cpp ../low-can-binding/binding
```
### Installation
```bash
-cd $CAN_/CAN-binder
+cd ${WD}/low-level-can-service
mkdir build
cd build
cmake ..
diff --git a/docs/3-Usage.md b/docs/3-Usage.md
index eecf5a8e..c9cf1bf4 100644
--- a/docs/3-Usage.md
+++ b/docs/3-Usage.md
@@ -129,7 +129,7 @@ You can find instructions to use afm-util tool [here](http://docs.iot.bzh/docs/a
But you can't control nor interact with it because you don't know security token that **Application Framework** gaves it at launch.
-So, to test it, it is better to launch the binding manually. In the following example, we will use port **1234** and left empty security token for testing purpose:
+So, to test it, it is better to launch the binding manually. In the following example, it will use port **1234** and left empty security token for testing purpose:
```bash
afb-daemon --binding=/var/lib/afm/applications/low-can-service/4.0/lib/afb-low-can.so --rootdir=/var/lib/afm/applications/low-can-service/4.0/ --port=1234 --token=1