Adding sensor fusion documents 41/20241/3
authorRamasamy <ram.kannan@samsung.com>
Wed, 30 Apr 2014 04:45:07 +0000 (10:15 +0530)
committerRamasamy <ram.kannan@samsung.com>
Wed, 7 May 2014 04:03:29 +0000 (09:33 +0530)
  - Added readme file for sensor fusion design/octave development

signed-off-by: Ramasamy <ram.kannan@samsung.com>
Change-Id: Iefbb1dbe274deace549f9cfbe34ba117ec7acbdd

src/sensor_fusion/design/readme [new file with mode: 0644]

diff --git a/src/sensor_fusion/design/readme b/src/sensor_fusion/design/readme
new file mode 100644 (file)
index 0000000..2de08d8
--- /dev/null
@@ -0,0 +1,21 @@
+Important Information for developers who would like to contribute:-
+---------------------------------------------------------------------------------
+
+1. GNU Octave version 3.8.0 or above  with GUI support is needed for executing
+   all sensor fusion code in this directory.
+
+2. The folder 'documents' contains the high level design for sensor fusion.
+   Please update any design changes in the documents along with the code changes.
+   (The .pptx documents could be opened and edited using LibreOffice Impress)
+
+3. The folder 'results' contains the output plots for the results for various
+   virtual sensors simulated using Octave.
+
+4. The folder 'lib' contains all the library files that that will be called by
+   the sf_xxx functions.
+
+5. The folder 'data' contains sample data taken from various sensors used on a
+   mobile phone target.
+
+6. Each sf_xxx file will individually simulate a virtual sensor that is developed
+   based on sensor fusion.