pierre romet / OBD2_freematics

Commit 3cd327b0d076e2fc38145d4044ec6eab91eb8e4c

Authored by yessine kammoun
1 parent 32ab9f55

add GPS description and SD script

Showing 1 changed file with 22 additions and 0 deletions   Show diff stats
Inline Side-by-side
README.md
  Show/Hide comments   View file @3cd327b
... ... @@ -100,6 +100,28 @@ To know the cause of [wake of ESP32](https://docs.espressif.com/projects/esp-idf
100 100 |`int FilterGpsData(char* isoTime, double* res)`|It avoids incoherent points especially when the GPS speed is more than 350 km/h this value could be changed. It calulates also the slope. It returns 1 if a slope can be calculated (It requires two successive points), 0 if it is not possible and -1 if the point is incoherent|
101 101 |`int AddGPSData(char* isoTime,char* p, int* nbr)`|It writes the GPS data collected previously in string pointed by `p`. It returns 1 if a data was written otherwise 0|
102 102  
  103 +### customized_MEMS.h/cpp
  104 +
  105 +|Method|Description|
  106 +|:----:|:---------:|
  107 +|`void init_MEMS_dev(void)`|It initializes the IMU device|
  108 +|`void calibrateMEMS(void)`|It calibrates the IMU device|
  109 +|`int isDataMEMSReady(MEMS_dev* md)`|It checks if an IMU data is ready. It returns 1 if it is the case otherwise 0|
  110 +|`int AddMEMSData(char* isoTime,char* p,int* nbr,int GPS_Stat)`|It writes the IMU data in the string pointed by `p`. It returns 1 if a data is received otherwise 0|
  111 +
  112 +### customized_OBD.h/cpp
  113 +
  114 +|Method|Description|
  115 +|:----:|:---------:|
  116 +|`void init_OBD_dev(void)`|It initializes the OBD device and ensure the connection to the vehicle|
  117 +|`int GetOBDInfo(uint8_t pid, int* val)`|It asks the MPU of the vehicle about the value of a certain data based on OBD pid. If a data is available it returns 1 otherwise 0|
  118 +|`void ErrorOBDCheck(void)`|It checks for OBD errors. For example if the engine is off|
  119 +|`int set_obd(void)`|It is called by `void init_OBD_dev(void)` to ensure connection. It returns 1 if the it done otherwise 0|
  120 +|`int OBD_looping(ObdInfoPid* PIDs, int nbr_elem,int fr_max)`|It is called by the OBD tasks to ask the MPU about certain OBD pids and send data to the SD card|
  121 +|`void CheckObdSpeed(char* label,char* isoTime,int val, int* res)`|Check wether OBD speed leveled off and make ESP32 entreing in deep sleep if the vehicle has stopped|
  122 +
  123 +
  124 +
103 125  
104 126  
105 127  
... ...