Updated readmes and general info

Updated the readme of both folders with small explanations removed unnecessary files added some documentation
leka · Nov 23, 2020 · 52d48d2 · 52d48d2
1 parent bcf5238
commit 52d48d2
Show file tree

Hide file tree

Showing 9 changed files with 23 additions and 234 deletions.
diff --git a/LKExp-Sensors-LSM6DSOX-UCF_Analysis/3_decision_tree.txt b/LKExp-Sensors-LSM6DSOX-UCF_Analysis/3_decision_tree.txt
diff --git a/LKExp-Sensors-LSM6DSOX-UCF_Analysis/3_weka_classifier_J48_output.txt b/LKExp-Sensors-LSM6DSOX-UCF_Analysis/3_weka_classifier_J48_output.txt
diff --git a/LKExp-Sensors-LSM6DSOX-UCF_Analysis/README.md b/LKExp-Sensors-LSM6DSOX-UCF_Analysis/README.md
@@ -2,4 +2,17 @@
 
 Small executable used to comment a UCF file based on the documented registers. this aims to ease the ucf comprehension.
 
-> ⚠️ to be written
+⚠️ This project does not work in it's actual state.
+A lot of logic of the UCF is not implemented (registers accessed when page sel, etc).
+The idea was just to give an idea of what could be made in order to simplify UCF analysis.
+
+We are still waiting for STMicroelectronics to give more documentation about the register pages accessed when configuring the LSM6DSOX **Machine Learning Core** as this is the principal piece of missing information right now.
+
+Some of the next steps of this project can be found in the [ToDo](todo.md) file of this project, it's a good starting point to continue working on it.
+
+## How does it work?
+The code reads the CSV files for each register map and creates a dictionnary where the key is the register address.
+
+Once all the logic about the LSM6DSOX register selection is implemented, this project could be able to take as input an UCF file and get rid of redundant commands as well as comment it, allowing easier comprehension.
+
+You can check the [commented file](commented.txt) to get an idea of what could be done.
diff --git a/LKExp-Sensors-LSM6DSOX-UCF_Analysis/registers_address_map.txt b/LKExp-Sensors-LSM6DSOX-UCF_Analysis/registers_address_map.txt
diff --git a/LKExp-Sensors-LSM6DSOX-UCF_Analysis/registers_address_map_embedded_functions.txt b/LKExp-Sensors-LSM6DSOX-UCF_Analysis/registers_address_map_embedded_functions.txt
diff --git a/LKExp-Sensors-LSM6DSOX-UCF_Analysis/src/main b/LKExp-Sensors-LSM6DSOX-UCF_Analysis/src/main
diff --git a/LKExp-Sensors-LSM6DSOX-UCF_Analysis/src/main.cpp b/LKExp-Sensors-LSM6DSOX-UCF_Analysis/src/main.cpp
@@ -1,3 +1,10 @@
+/**
+ * @file main.cpp
+ * @author Maxime Blanc & Samuel Hadjes
+ * @brief Small executable to automatically comment .UCF files
+ * @date 2020-07-03
+ * 
+ */
 #include <fstream>
 #include <iostream>
 #include <string>

diff --git a/LKExp-Sensors-LSM6DSOX-UCF_Analysis/todo.md b/LKExp-Sensors-LSM6DSOX-UCF_Analysis/todo.md
@@ -1,8 +1,8 @@
 ## UCF Analysis todo list
 
 ### code
-- [ ] - write readme.md to explain how it works
-- [ ] - doxygen doc
+- [x] - write readme.md to explain how it works
+- [ ] - doxygen code
 ### documentation
 - [ ] - make a makefile for the program
 - [ ] - remove exec from git

diff --git a/LKExp-Sensors-LSM6DSOX-UCF_to_H_File_Conversion/todo.md b/LKExp-Sensors-LSM6DSOX-UCF_to_H_File_Conversion/todo.md