gudbjartur22/clinx02-androidpebble
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md - added description of code structure

Browse Source
This commit is contained in:
Graham Jones
2023-12-21 12:34:42 +00:00
committed by GitHub
parent bf637150a8
commit 1f4f750bd6
1 changed files with 10 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@@ -56,6 +56,16 @@ Installation
Note that the Garmin watch app needs to be installed separately - see the (web site)[https://www.openseizuredetector.org.uk/?page_id=1128] for details.
Code Structure
--------------
- StartUpActivity is the entry point (This is the view that shows the checklist of things initialising, then exits)
- SdServer is started by StartUpActivity
- This creates an instance of SdDataSource for the particular data source in use (Garmin, BLE, Phone)
- SdDataSource collects data from the watch, and when a set of data is available, it calls the doAnalysis function to do the seizure detection.
- SdServer deals with raising the alarms based on the analysis results.
- SdServer also details with logging to the Data Sharing system.
- MainActivity provides a front end to view what is going on with SdServer
Licence
=======
My code is licenced under the GNU Public Licence - for associated libraries