pierre romet / OBD2_freematics

Commit 3803578093cdc45987444c3fe775268de8ed5bc5

Authored by yessine kammoun
1 parent 2db07fd6

add getting started with codde

Showing 1 changed file with 5 additions and 6 deletions   Show diff stats
Inline Side-by-side
@@ -12,17 +12,16 @@ The developped datalogger has to meet certain requirements to operate. These are @@ -12,17 +12,16 @@ The developped datalogger has to meet certain requirements to operate. These are
12 12
13 ## How to run the project ? 13 ## How to run the project ?
14 14
15 -Once you fullfil all the needs above, you clone the depository then you load the `./FreematicsOBD/datalogger/simple_obd_test.ino` using 15 +Once you fulfill all the needs above, you clone the depository then you load the `./FreematicsOBD/datalogger/simple_obd_test.ino` using
16 the Freematics Arduino Builder. You choose the appropirate target board. Tick `Rebuild Core` and `Rebuild Llibs`. Finally, connect your board to the computer, click on refresh then click on the last added serial port to upload the project. 16 the Freematics Arduino Builder. You choose the appropirate target board. Tick `Rebuild Core` and `Rebuild Llibs`. Finally, connect your board to the computer, click on refresh then click on the last added serial port to upload the project.
17 -Now, you can connect the device to the OBD port of the vehicle. Turn on the engine and wait until you hear a bip from the board buzzer. At this time, the board is ready to collect information. If the buzzer does not work, you just reconnect the board and wait again.  
18 -If you want to see the data wriiten in SD card in real time and visualize them on your screen. You may need a longer USB wire. However, 17 +Now, you can connect the device to the OBD port of the vehicle. Turn on the engine and wait until you hear a beep from the board buzzer. At this time, the board is ready to collect information. If the buzzer does not work, you just reconnect the board and wait again.
  18 +If you want to see the data written in SD card in real time and visualize them on your screen. You may need a longer USB wire. However,
19 you need to set `USE_SERIAL` to 1 (otherwise 0) which exists in the `./FreematicsOBD/datalogger/simple_obd_test.h`. 19 you need to set `USE_SERIAL` to 1 (otherwise 0) which exists in the `./FreematicsOBD/datalogger/simple_obd_test.h`.
20 If you want to collect just GPS and IMU data while cycling you can power the board with a power bank. You will need to set `USE_OBD` to 1 (otherwise 0) which exists in the same header file. 20 If you want to collect just GPS and IMU data while cycling you can power the board with a power bank. You will need to set `USE_OBD` to 1 (otherwise 0) which exists in the same header file.
21 -In order to avoid collecting data during traffic jumps you can set `SLEEP_STOP` to 1 (otherwise 0). This make the board go in deep sleep for 5s.  
22 - 21 +In order to avoid collecting data during traffic jumps you can set `SLEEP_STOP` to 1 (otherwise 0). This makes the board go to deep sleep for 5s.
23 ## How to visualize the collected data ? 22 ## How to visualize the collected data ?
24 23
25 -To plot some magnitudes or the path you can use the python script. This script needs two arguments. The first one is the name of the CSV file. The second one is html file which can be opened with a navigator and see the journey path. You can also reduce the number of points 24 +To plot some magnitudes or the path, you can use the python script. This script needs two arguments. The first one is the name of the CSV file. The second one is HTML file which can be opened with a navigator and see the journey path. You can also reduce the number of points
26 drawn on the map by uncommenting the call of rdp function. This one has a parameter called epsilon. The bigger epsilon is the lesser points you get. 25 drawn on the map by uncommenting the call of rdp function. This one has a parameter called epsilon. The bigger epsilon is the lesser points you get.
27 26
28 To plot a magnitude you can follow the examples given in the script file. 27 To plot a magnitude you can follow the examples given in the script file.