Updated the user guide with the HRV tracking functionality

vtrifonov-esfiddle · Nov 4, 2018 · b525593 · b525593
1 parent e4d5f4e
commit b525593
Show file tree

Hide file tree

Showing 14 changed files with 42 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -32,9 +32,7 @@ A Garmin Connect IQ meditation app that tracks as an activity the heart rate, HR
     - HRV
 
 ![Session picker demo](userGuideScreenshots/sessionPickerDemo.gif)
-![Session demo](userGuideScreenshots/sessionDemo.gif)
 ![Session demo detailed](userGuideScreenshots/sessionDetailedDemo.gif)
-![Session in-progress explained](userGuideScreenshots/sessionInProgressExplained.png)
 
 ## Supported Devices
 - Vivoactive 3, Vivoactive 3 Music 

diff --git a/UserGuide.md b/UserGuide.md
@@ -13,7 +13,7 @@
     - pNN20 - % of successive beat-to-beat intervals that differ by more than 20 ms
     - pNN50 - % of successive beat-to-beat intervals that differ by more than 50 ms
     - beat-to-beat interval - reading coming directly from the watch sensor
-    - HRV Successive Differences - difference between current and previous beat-to-beat intervals
+    - HRV Successive Differences - difference between the current and previous beat-to-beat intervals
     - SDRR - [Standard Deviation](https://en.wikipedia.org/wiki/Standard_deviation) of beat-to-beat intervals 
       - calculated from the first and last 5 min of the session
     - HRV RMSSD 30 Sec Window - RMSSD calculated for consecutive 30 second intervals    
@@ -29,6 +29,11 @@
     - Stress
     - HRV
 
+
+![Session picker demo](userGuideScreenshots/sessionPickerDemo.gif)
+![Session demo detailed](userGuideScreenshots/sessionDetailedDemo.gif)
+
+
 ## How to Use
 ### 1. Starting a session
 
@@ -46,6 +51,10 @@
     - you can hide them per alert by selecting transparent color from the [Interval Alerts settings menu](#2-configuring-a-session)
 - time elapsed 
 - current HR
+- current HRV Successive Difference 
+  - difference between the current and previous beat-to-beat intervals measured in milliseconds
+  - shows only when HRV tracking is on
+  - **to get good HRV readings you need to minimise wrist movement**
 
 The meditation session finishes once you press the stop button.
 
@@ -59,13 +68,9 @@ The meditation session finishes once you press the stop button.
 
 1.4. If you are in single session mode (the default) at the end you see the Summary Screen (for Multi-Session mode see the next section **1.5**). Swipe up/down (Vivoactive 3) or press page up/down buttons to see the summary stats of HR, Stress and HRV. Go back from this view to exit the app.
 
-![Summary HR](userGuideScreenshots/summaryHr.png)
-![Summary stress](userGuideScreenshots/summaryStress.png)
-![Summary HRV RMSSD](userGuideScreenshots/summaryHrvRmssd.png)
-![Summary HRV pNNx](userGuideScreenshots/summaryHrvPnnx.png)
-![Summary HRV SDRR](userGuideScreenshots/summaryHrvSdrr.png)
+![Session Summary Detailed Demo](userGuideScreenshots/sessionSummaryDetailedDemo.gif)
 
-1.5 If you are in multi-session mode (determined by [Global Settings](#4-global-settings) -> [Multi-Session](#44-multi-session)) then you go back to the session picker screen. From there you can start another session. Once you finished your session you can go back from the session picker screen to enter the Sessions Summary view.
+1.5 If you are in multi-session mode (determined by [Global Settings](#4-global-settings) -> [Multi-Session](#44-multi-session)) then you go back to the session picker screen. From there you can start another session. Once you finish your session you can go back from the session picker screen to enter the Sessions Summary view.
 
 ![Summary Rollup](userGuideScreenshots/summaryRollup.png)
 
@@ -94,6 +99,21 @@ The meditation session finishes once you press the stop button.
     - Color - the color of the current interval alert used in the graphical controls. Select different colors for each alert to differentiate them during meditation. Select transparent color if you don't want to see visual marks for the alert during meditation
     - Vibe Pattern - shorter or longer patterns ranging from pulsating or continuous
 - Activity Type - ability to save the session as **Meditating** or **Yoga**. You can configure default activity type for new sessions from the Global Settings ([see section 4](#4-global-settings)).
+- HRV Tracking - determines if HRV and stress are tracked
+  - ON (Default) - tracks stress and the following HRV metrics
+    - RMSSD
+    - HRV Successive Differences
+  - On Detailed - tracks extra stress and HRV metrics in addition to the **On** option
+    - RMSSD
+    - HRV Successive Differences
+    - pNN20 
+    - pNN50
+    - beat-to-beat interval
+    - SDRR First 5 min of the session
+    - SDRR Last 5 min of the session
+    - RMSSD 30 Sec Window
+    - HR from heartbeat
+    - HR Peaks 10 Sec Window
 
 2.3 Delete - deletes a session after asking for confirmation
 
@@ -109,6 +129,19 @@ On this screen you can see the applicable settings for the selected session
 - time - total duration of the session
 - vibe pattern
 - interval alert triggers - the graph in the middle of the screen represents the relative alert triger time compared to the total session time
+- HRV indicator
+  - ![Off](userGuideScreenshots/hrvIndicatorOff.png) Off - indicates that stress and HRV are turned off
+  - ![Waiting HRV](userGuideScreenshots/hrvIndicatorWaitingHrv.png) Waiting HRV 
+    - the hardware sensor does not detect HRV
+    - you can start the session but you will have missing HRV data
+  - ![HRV Ready](userGuideScreenshots/hrvIndicatorReady.png) HRV Ready 
+    - the hardware sensor detects HRV
+    - the session tracks default HRV and Stress metrics
+    - **the session can be recored with reliable HRV data provided you minimize wrist movement**
+  - ![HRV Ready Detailed](userGuideScreenshots/hrvIndicatorReadyDetailed.png) HRV Ready 
+    - the hardware sensor detects HRV
+    - the session tracks extended HRV and Stress metrics
+    - **the session can be recored with reliable HRV data provided you minimize wrist movement**
 
 ![Session picker yoga explained](userGuideScreenshots/sessionPickerYogaExplained.png)
 
@@ -122,6 +155,8 @@ To change the settings hold the menu button (for Vivoactive 3 hold on the screen
 
 #### 4.1 HRV Tracking
 
+This setting provides the default **HRV Tracking** for new sessions.
+
 - **On** - tracks default HRV metrics and Stress
     - RMSSD
     - Successive Differences

diff --git a/userGuideScreenshots/hrvIndicatorOff.png b/userGuideScreenshots/hrvIndicatorOff.png
diff --git a/userGuideScreenshots/hrvIndicatorReady.png b/userGuideScreenshots/hrvIndicatorReady.png
diff --git a/userGuideScreenshots/hrvIndicatorReadyDetailed.png b/userGuideScreenshots/hrvIndicatorReadyDetailed.png
diff --git a/userGuideScreenshots/hrvIndicatorWaitingHrv.png b/userGuideScreenshots/hrvIndicatorWaitingHrv.png
diff --git a/userGuideScreenshots/sessionInProgressExplained.png b/userGuideScreenshots/sessionInProgressExplained.png
diff --git a/userGuideScreenshots/sessionPickerYogaExplained.png b/userGuideScreenshots/sessionPickerYogaExplained.png
diff --git a/userGuideScreenshots/sessionSummaryDetailedDemo.gif b/userGuideScreenshots/sessionSummaryDetailedDemo.gif
diff --git a/userGuideScreenshots/summaryHr.png b/userGuideScreenshots/summaryHr.png
diff --git a/userGuideScreenshots/summaryHrvPnnx.png b/userGuideScreenshots/summaryHrvPnnx.png
diff --git a/userGuideScreenshots/summaryHrvRmssd.png b/userGuideScreenshots/summaryHrvRmssd.png
diff --git a/userGuideScreenshots/summaryHrvSdrr.png b/userGuideScreenshots/summaryHrvSdrr.png
diff --git a/userGuideScreenshots/summaryStress.png b/userGuideScreenshots/summaryStress.png