pierre romet / OBD2_freematics

Commit 2db07fd69158d63ada4a5b64abb6f4a926fed2f4

Authored by yessine kammoun
1 parent 1ea09fee

push wiki

Showing 1 changed file with 12 additions and 11 deletions   Show diff stats
Inline Side-by-side
README.md
  Show/Hide comments   View file @2db07fd
... ... @@ -2,7 +2,7 @@
2 2  
3 3 ## Introduction
4 4  
5   - The goal of this project is to develop a kind of datalogger collecting different peaces of information from OBD-II (On-board diagnostics), GPS, and IMU (Inertial measurement unit) and to store them into a CSV file in an SD card.
  5 +The goal of this project is to develop a kind of datalogger collecting different peaces of information from OBD-II (On-board diagnostics), GPS, and IMU (Inertial measurement unit) and to store them into a CSV file in an SD card.
6 6 The developped datalogger has to meet certain requirements to operate. These are:
7 7  
8 8 * [Freematics ONE+](https://freematics.com/products/freematics-one-plus/) board.
... ... @@ -12,25 +12,26 @@ The developped datalogger has to meet certain requirements to operate. These are
12 12  
13 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 fullfil all the needs above, you clone the depository then you load the `./FreematicsOBD/datalogger/simple_obd_test.ino` using
16 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 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,
19 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.
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.
  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 22  
23 23 ## How to visualize the collected data ?
24 24  
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
  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
26 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.
27 27  
28   - To plot a magnitude you can follow the examples given in the script file.
29   - Example of launching the python script: `python3 script_gps.py 27.CSV Trajet.html`.
30   - ![Example of visualized GPS points](path.png)
  28 +To plot a magnitude you can follow the examples given in the script file.
  29 +Example of launching the python script: `python3 script_gps.py 27.CSV Trajet.html`.
  30 +
  31 +![Example of visualized GPS points](path.png)
31 32  
32 33  
33   - ![Example of plotting OBD Speed](PID_SPEED.png)
  34 +![Example of plotting OBD Speed](PID_SPEED.png)
34 35  
35 36  
36 37 ## Gettig started with code
... ...