Added README file

2015-11-14 23:16:38 +00:00
parent 9619375b49
commit c4712c19e8
1 changed files with 48 additions and 0 deletions
--- a/README.md
+++ b/README.md
@@ -0,0 +1,48 @@
+OpenSeizureDetector - Pebble Version
+====================================
+
+This seizure detector uses a (Pebble)[http://getpebble.com] smart watch.
+The watch has an accelerometer and vibrator motor and a bluetooth radio
+to talk to another computer.  Most importantly, it comes with instructions to
+write code for it on the manufacturers (web site)[http://developer.getpebble.com].   
+
+So it sounds like an ideal platform for an accelerometer based seizure detector
+similar to the Arduino based one I made in 2013.
+
+Principle of Operation
+======================
+It is based on an accelerometer monitoring movement.  It uses a fourier
+transform to extract the frequency spectrum of the movement, and monitors
+movements in a given frequency band.   The idea is that it will detect the
+rhythmic movements associated with a seizure, but not normal day to day
+activities.
+
+If the acceleration within the given frequency band is more than a
+threshod value, it starts a timer.  If the acceleration remains above
+the threshold for a given period, it issues a warning beep.
+If it remains above the threshold for a longer specified period, the unit
+alarms (continuous tone rather than beep).
+
+
+Licence
+=======
+My code is licenced under the GNU Public Licence - for associated libraries 
+please see Credits below.
+
+Credits
+=======
+The following libraries are used:
+* (SYLT-FFT)[https://github.com/stg/SYLT-FFT] by D. Taylor.
+* (NanoHTTPD)[https://github.com/NanoHttpd/nanohttpd]
+* (jQuery)[http://jquery.org]
+* (jBeep)[http://www.ultraduz.com.br]
+* (Chartjs)[http://www.chartjs.org]
+* (MPAndroidChart)[https://github.com/PhilJay/MPAndroidChart]
+
+Logo based on ["Star of life2" by Verdy p - Own work. Licensed under Public Domain via Wikimedia Commons](http://commons.wikimedia.org/wiki/File:Star_of_life2.svg#mediaviewer/File:Star_of_life2.svg).
+
+Other icons crated using http://romannurik.github.io/AndroidAssetStudio.
+
+
+
+Graham Jones, 01 March 2015.  (grahamjones139+sd@gmail.com)