Add HRV support. You can use either --all or --hrv to import HRV. (#299)

* Add HRV support. You can use either --all or --hrv to import HRV.

Author: joelgerard

Plugins

@@ -15,6 +15,7 @@
         "weight_start_date"             : "12/31/2019",
         "sleep_start_date"              : "12/31/2019",
         "rhr_start_date"                : "12/31/2019",
+        "hrv_start_date"                : "12/31/2019",
         "monitoring_start_date"         : "12/31/2019",
         "download_latest_activities"    : 25,
         "download_all_activities"       : 1000
@@ -31,7 +32,8 @@
         "sleep"                         : true,
         "rhr"                           : true,
         "weight"                        : true,
-        "activities"                    : true
+        "activities"                    : true,
+        "hrv"                           : true
     },
     "course_views": {
         "steps"                         : []

garmindb/GarminConnectConfig.json.example

@@ -33,7 +33,7 @@
 from .version import format_version, log_version, python_version_check
 
 from .import_monitoring import GarminMonitoringFitData, GarminSleepFitData, GarminSummaryData, GarminUserSettings, GarminSocialProfile, GarminPersonalInformation, GarminWeightData, \
-    GarminSleepData, GarminRhrData, GarminSettingsFitData, GarminHydrationData
+    GarminSleepData, GarminRhrData, GarminSettingsFitData, GarminHydrationData, GarminHrvData
 from .activities_fit_data import GarminActivitiesFitData
 from .garmin_tcx_data import GarminTcxData
 from .garmin_json_data import GarminJsonSummaryData, GarminJsonDetailsData

garmindb/__init__.py

@@ -42,6 +42,7 @@ class Download():
     garmin_connect_usersummary_url = "/usersummary-service/usersummary"
     garmin_connect_daily_summary_url = garmin_connect_usersummary_url + "/daily"
     garmin_connect_daily_hydration_url = garmin_connect_usersummary_url + "/hydration/allData"
+    garmin_connect_hrv_url = "/hrv-service/hrv"
 
     # https://connect.garmin.com/modern/proxy/usersummary-service/usersummary/hydration/allData/2019-11-29
 
@@ -319,3 +320,17 @@ def get_hydration(self, directory_func, date, days, overwrite):
         """Download the hydration data from Garmin Connect and save to a JSON file."""
         root_logger.info("Getting hydration: %s (%d)", date, days)
         self.__get_stat(self.__get_hydration_day, directory_func, date, days, overwrite)
+
+    def __get_hrv_day(self, directory, day, overwrite=False):
+        date_str = day.strftime('%Y-%m-%d')
+        json_filename = f'{directory}/hrv_{date_str}'
+        url = f'{self.garmin_connect_hrv_url}/{date_str}'
+        try:
+            self.save_json_to_file(json_filename, self.garth.connectapi(url), overwrite)
+        except GarthHTTPError as e:
+            root_logger.error("Exception getting daily summary %s", e)
+
+    def get_hrv(self, directory, date, days, overwrite):
+        """Download the heart rate variability (HRV) data from Garmin Connect and save to a JSON file."""
+        root_logger.info("Getting hrv: %s (%d)", date, days)
+        self.__get_stat(self.__get_hrv_day, directory, date, days, overwrite)

garmindb/download.py

@@ -214,6 +214,12 @@ def all_activity_count(self):
     def stat_start_date(self, stat_type):
         """Return a tuple containing the start date and the number of days to fetch stats from."""
         start_date = self.get_node_value('data', stat_type + '_start_date')
+        if start_date is None:
+            # Fallback to a general start date or a reasonable default
+            start_date = self.get_node_value('data', 'start_date')
+        if start_date is None:
+            # If still nothing, default to 20 days ago
+            start_date = datetime.datetime.now().date() - datetime.timedelta(days=20)
         end_date = self.get_node_value_default('data', stat_type + '_end_date', datetime.datetime.now().date())
         days = (end_date - start_date).days
         return (start_date, days)

garmindb/garmin_connect_config_manager.py

@@ -6,7 +6,7 @@
 
 # flake8: noqa
 
-from .garmin_db import GarminDb, Attributes, Device, DeviceInfo, File, Weight, Stress, Sleep, SleepEvents, RestingHeartRate, DailySummary
+from .garmin_db import GarminDb, Attributes, Device, DeviceInfo, File, Weight, Stress, Sleep, SleepEvents, RestingHeartRate, DailySummary, Hrv
 from .monitoring_db import MonitoringDb, MonitoringInfo, MonitoringHeartRate, MonitoringIntensity, MonitoringClimb, Monitoring, \
     MonitoringRespirationRate, MonitoringPulseOx, MonitoringHrvValue, MonitoringHrvStatus
 from .activities_db import ActivitiesDb, Activities, ActivityLaps, ActivityRecords, ActivitiesDevices, ActivitySplits, SportActivities, StepsActivities, \

garmindb/garmindb/__init__.py

@@ -325,6 +325,38 @@ def get_stats(cls, session, start_ts, end_ts):
         }
 
 
+class Hrv(GarminDb.Base, idbutils.DbObject):
+    """Class representing daily Heart Rate Variability (HRV) data."""
+
+    __tablename__ = 'hrv'
+
+    db = GarminDb
+    table_version = 1
+    _col_units = {
+        'weekly_avg': 'ms',
+        'last_night_avg': 'ms',
+        'last_night_5min_high': 'ms',
+        'baseline_low': 'ms',
+        'baseline_upper': 'ms'
+    }
+
+    day = Column(Date, primary_key=True)
+    weekly_avg = Column(Integer)
+    last_night_avg = Column(Integer)
+    last_night_5min_high = Column(Integer)
+    baseline_low = Column(Integer)
+    baseline_upper = Column(Integer)
+    status = Column(String)
+
+    @classmethod
+    def get_stats(cls, session, start_ts, end_ts):
+        """Return a dictionary of aggregate statistics for the given time period."""
+        return {
+            'hrv_weekly_avg': cls.s_get_col_avg(session, cls.weekly_avg, start_ts, end_ts, ignore_le_zero=True),
+            'hrv_last_night_avg': cls.s_get_col_avg(session, cls.last_night_avg, start_ts, end_ts, ignore_le_zero=True),
+        }
+
+
 class DailySummary(GarminDb.Base, idbutils.DbObject):
     """Class representing a Garmin daily summary."""
 

garmindb/garmindb/garmin_db.py

@@ -13,7 +13,7 @@
 import fitfile
 from idbutils import JsonFileProcessor, Conversions
 
-from .garmindb import GarminDb, Attributes, Weight, Sleep, SleepEvents, RestingHeartRate, DailySummary
+from .garmindb import GarminDb, Attributes, Weight, Sleep, SleepEvents, RestingHeartRate, DailySummary, Hrv
 from .fit_data import FitData
 
 
@@ -479,3 +479,44 @@ def _process_json(self, json_data):
         DailySummary.insert_or_update(
             self.garmin_db, summary, ignore_none=True)
         return 1
+
+
+class GarminHrvData(JsonFileProcessor):
+    """Class for importing JSON formatted Garmin Connect heart rate variability (HRV) data into a database."""
+
+    def __init__(self, db_params, input_dir, latest, debug):
+        """
+        Return an instance of GarminHrvData.
+
+        Parameters:
+        ----------
+        db_params (object): configuration data for accessing the database
+        input_dir (string): directory (full path) to check for HRV data files
+        latest (Boolean): check for latest files only
+        debug (Boolean): enable debug logging
+
+        """
+        super().__init__(r'hrv_\d{4}-\d{2}-\d{2}\.json', input_dir=input_dir, latest=latest, debug=debug)
+        self.garmin_db = GarminDb(db_params)
+        self.conversions = {'calendarDate': self._parse_date}
+
+    def _process_json(self, json_data):
+        hrv_summary = json_data.get('hrvSummary')
+        if hrv_summary is None:
+            return 0
+        day = hrv_summary.get('calendarDate')
+        if day is None:
+            return 0
+        if isinstance(day, str):
+            day = self._parse_date(day)
+        point = {
+            'day': day.date() if hasattr(day, 'date') else day,
+            'weekly_avg': self._get_field(hrv_summary, 'weeklyAvg', int),
+            'last_night_avg': self._get_field(hrv_summary, 'lastNightAvg', int),
+            'last_night_5min_high': self._get_field(hrv_summary, 'lastNight5MinHigh', int),
+            'baseline_low': self._get_field(hrv_summary.get('baseline', {}), 'balancedLow', int),
+            'baseline_upper': self._get_field(hrv_summary.get('baseline', {}), 'balancedUpper', int),
+            'status': self._get_field(hrv_summary, 'status', str)
+        }
+        Hrv.insert_or_update(self.garmin_db, point, ignore_none=True)
+        return 1

garmindb/import_monitoring.py

@@ -18,6 +18,7 @@ class Statistics(enum.Enum):
     rhr = 5
     weight = 6
     activities = 7
+    hrv = 8
 
     @classmethod
     def from_string(cls, string):

garmindb/statistics.py

@@ -20,7 +20,7 @@
 import glob
 
 from garmindb import python_version_check, log_version, format_version
-from garmindb.garmindb import GarminDb, Attributes, Sleep, Weight, RestingHeartRate, MonitoringDb, MonitoringHeartRate, ActivitiesDb, GarminSummaryDb
+from garmindb.garmindb import GarminDb, Attributes, Sleep, Weight, RestingHeartRate, Hrv, MonitoringDb, MonitoringHeartRate, ActivitiesDb, GarminSummaryDb
 from garmindb.summarydb import SummaryDb
 
 from garmindb import Download, Copy, Analyze
@@ -50,6 +50,7 @@ class GarminDbMain():
         Statistics.sleep                 : GarminDb,
         Statistics.rhr                   : GarminDb,
         Statistics.weight                : GarminDb,
+        Statistics.hrv                   : GarminDb,
         Statistics.activities            : ActivitiesDb
     }
 
@@ -159,6 +160,14 @@ def download_data(self, overwrite, latest, stats):
                 download.get_rhr(rhr_dir, date, days, overwrite)
                 root_logger.info("Saved rhr files for %s (%d) to %s for processing", date, days, rhr_dir)
 
+        if Statistics.hrv in stats:
+            date, days = self.__get_date_and_days(GarminDb(self.gc_config.get_db_params()), latest, Hrv, Hrv.day, 'hrv')
+            if days > 0:
+                hrv_dir = self.gc_config.get_rhr_dir() # HRV tends to be in the same place as RHR or monitoring
+                root_logger.info("Date range to update: %s (%d) to %s", date, days, hrv_dir)
+                download.get_hrv(hrv_dir, date, days, overwrite)
+                root_logger.info("Saved hrv files for %s (%d) to %s for processing", date, days, hrv_dir)
+
 
     def import_data(self, debug, latest, stats):
         """Import previously downloaded Garmin data into the database."""
@@ -221,6 +230,13 @@ def import_data(self, debug, latest, stats):
             if grhrd.file_count() > 0:
                 grhrd.process()
 
+        if Statistics.hrv in stats:
+            from garmindb import GarminHrvData
+            hrv_dir = self.gc_config.get_rhr_dir()
+            ghrvd = GarminHrvData(self.gc_config.get_db_params(), hrv_dir, latest, debug)
+            if ghrvd.file_count() > 0:
+                ghrvd.process()
+
         if Statistics.activities in stats:
             activities_dir = self.gc_config.get_activities_dir()
             # Tcx fields are less precise than the JSON files, so load Tcx first and overwrite with better JSON values.
@@ -313,6 +329,7 @@ def main(argv):
     stats_group.add_argument("-a", "--activities", help="Download and/or import activities data.", dest='stats', action='append_const', const=Statistics.activities)
     stats_group.add_argument("-m", "--monitoring", help="Download and/or import monitoring data.", dest='stats', action='append_const', const=Statistics.monitoring)
     stats_group.add_argument("-r", "--rhr", help="Download and/or import resting heart rate data.", dest='stats', action='append_const', const=Statistics.rhr)
+    stats_group.add_argument("--hrv", help="Download and/or import heart rate variability data.", dest='stats', action='append_const', const=Statistics.hrv)
     stats_group.add_argument("-s", "--sleep", help="Download and/or import sleep data.", dest='stats', action='append_const', const=Statistics.sleep)
     stats_group.add_argument("-w", "--weight", help="Download and/or import weight data.", dest='stats', action='append_const', const=Statistics.weight)
     modifiers_group = parser.add_argument_group('Modifiers')