Merge pull request #8 from brnkl/documentation

Documentation

1 files changed, 76 insertions, 0 deletions

diff --git a/readme.md b/readme.md
index e69de29..3aa0175 100644
--- a/readme.md
+++ b/readme.md
@@ -0,0 +1,76 @@
+MangOH Motion Service
+======
+This application is designed to operate on a [MongOH Red](https://mangoh.io/mangoh-red-new) WP85 board. Using **general input output** this project uses pthreads to probe the onboard bmi160 chip intermittently in order to detect a significant motion on the board.
+
+## Prerequisites
+
+When cloning use ``git clone https://github.com/brnkl/motion-service.git``.
+
+
+## Building
+Compile the project using 
+
+wp85: 	``make wp85``
+
+## Setting Variables
+To change the sensitivity of impact detection you must edit the `motionMonitor/motionMonitor.c` file.
+The Accelerometer measures acceleration in 3 dimensions, X, Y, and Z. These dimensions of acceleration are recorded and the magnitude of their resulting vector is calculated using ``double impactMagnitude = sqrt(x * x + y * y + z * z);``. As visualized in the image below.
+
+![Magnitude](https://www.intmath.com/vectors/img/235-3D-vector.png)
+
+
+`#define DEFAULT_THRESHOLD_MS2 17` determines the magnitude of the resulting vector that will trigger the application to detect a sudden impact. 
+
+If adjusting the value of `DEFAUTL_THRESHOLD_MS2` keep in mind that gravity implies a motionless magnitude of -9.8m/s^2.
+
+## Bindings 
+App.adef
+```
+...
+bindings:
+{
+  myClientApp.myComponent.brnkl_motion -> motionService.brnkl_motion
+}
+...
+```
+Component.cdef
+```
+...
+requires:
+{
+  api:
+  {
+    brnkl_motion.api
+  }
+}
+...
+```
+
+## Example 
+For getting the current acceleration
+```C
+struct Acceleration{
+	double x;
+	double y;
+	double z;
+};
+
+struct Acceleration v = value;
+
+le_result_t result = brnkl_motion_getCurrentAccleration(&v->x, &v->y, &v->z);
+```
+To get a list of all recent impacts. 
+
+```
+  double xAcc[N_MAX_IMPACT_VALUES], yAcc[N_MAX_IMPACT_VALUES], zAcc[N_MAX_IMPACT_VALUES];
+  
+  uint64_t timestamps[N_MAX_IMPACT_VALUES];
+  
+  size_t xSize = N_MAX_IMPACT_VALUES, ySize = N_MAX_IMPACT_VALUES,
+         zSize = N_MAX_IMPACT_VALUES, timestampsSize = N_MAX_IMPACT_VALUES;
+  
+  le_result_t r = brnkl_motion_getSuddenImpact(
+      xAcc, &xSize, yAcc, &ySize, zAcc, &zSize, timestamps, &timestampsSize);
+  
+```
+