postrunner 0.11.0 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d8de6ac38768c84e90eb47ddb49429d7a74160b1
-  data.tar.gz: 7816eba71ed5b6f90eef7d7ae15080c19d548624
+SHA256:
+  metadata.gz: 49a5f5f39dfa3c4aa542ad58f086e6c6a193420274ef291c4a1f5b009665734b
+  data.tar.gz: cccd8e865768fbbd7d7266e4579753ac8ee261f0a35b4551b291e03f4e4684ee
 SHA512:
-  metadata.gz: 3302269a229d363cfc75bbea304879f06c37e8c2e6c1706ebece3ce6b662b02a026315df59e7494de230c5c3cab3fb81b925bd0ef89f4b81b1280805b422b138
-  data.tar.gz: e8179a0afb54a171ba200480cf498523688acffa9f3568b8a2ae1e272a5bdc4c863449c6c43b201dafe6223afeb64f64ca3520799e93317f4aec8114cdcb64f2
+  metadata.gz: 05b6cb51addbb4f366e9779e3d69c3307078b64a0256b82833a8016dcdee64ee4b2347038ba7f8921cd0a7fe530913d6d3eee1b48258935adf71f9ff06c7ec35
+  data.tar.gz: 075c12e07e651813fa59fefb15d4702510679dba7cbe23aaed7f27400655c72e68f913343820b631b514e6a03e3dfde4b9269441fabfe75bdcd5d51f567907db

data/README.md

@@ -2,26 +2,50 @@
 
 PostRunner is an application to manage FIT files such as those
 produced by Garmin products like the Forerunner 620 (FR620), 
-Forerunner 25 (FR25), Fenix 3, Fenix 3HR and Fenix 5. It allows you to
-import the files from the device and analyze the data. In addition to
-the common features like plotting pace, heart rates, elevation and
-other captured values it also provides a heart rate variability (HRV)
-analysis. It can also update satellite orbit prediction (EPO) data on
-the device to speed-up GPS fix times.  It is an offline alternative to
-Garmin Connect. The software has been developed and tested on Linux
-but should work on other operating systems as well.
+Forerunner 25 (FR25), Fenix 3, Fenix 3HR, Fenix 5, Fenix 5+ or Fenix6.
+It allows you to import the files from the device and analyze the
+data. In addition to the common features like plotting pace, heart
+rates, elevation and other captured values it also provides a heart
+rate variability (HRV) analysis. It can also update satellite orbit
+prediction (EPO) data on the device to speed-up GPS fix times.
+Unfortunately, the download mechanism for CPE files used by the
+devices with GPS chipsets from Sony is still unknown and hence
+unsupported. Postrunner is an offline alternative to Garmin Connect.
+The software has been developed and tested on Linux but should work on
+other operating systems as well.
 
 ## Installation
 
 PostRunner is a [http://www.ruby-lang.org](Ruby) application. You need
-to have a Ruby 2.0 or later runtime environment installed.  This
+to have a Ruby 2.4 or later runtime environment installed.  This
 application was developed and tested on Linux but may work on other
-operating systems as well.
+operating systems as well. You can either install it as root for all
+users on the computer or as a particular user for just this user.
+
+### System-wide installation as root user
 
 ```
 $ gem install postrunner
 ```
 
+On some Linux distributions using sudo might resolve in permission
+problems as the installed packages are not readable for normal users.
+This typically results in 'cannot load such file' type error messages. 
+
+### Installation as non-privileged user
+
+```
+gem install --user-install postrunner
+```
+
+This will install PostRunner and all dependency packages in your .gem
+directory. You then need to add the binary path to your PATH variable
+in your .profile or .bashrc or .whatever file. The path is typically
+.gem/ruby/<version>/bin. Watch out, on some Linux distributions the
+version number of ruby gets added to the binary name, e. g.
+postrunner.ruby2.7. You can use a symbolic link or alias to safe some
+typing.
+
 ## Usage
 
 ### Importing FIT files
@@ -29,7 +53,7 @@ $ gem install postrunner
 To get started you need to connect your device to your computer and
 mount it as a disk drive. Only devices that expose their data as FAT file
 system are supported. Older devices use proprietary drivers and are
-not supported by postrunner. Once the device is mounted find out the
+not supported by PostRunner. Once the device is mounted find out the
 full path to the directory that contains your FIT files. You can then
 import all files on the device.
 
@@ -128,7 +152,7 @@ $ postrunner show :1
 ## Contributing
 
 PostRunner is currently work in progress. It does some things I want
-with files from my Garmin FR620. It's certainly possible to do more
+with files from my Garmin devices. It's certainly possible to do more
 things and support more devices. Patches are welcome!
 
 1. Fork it ( https://github.com/scrapper/postrunner/fork )

data/lib/postrunner/Activity.rb

@@ -380,7 +380,7 @@ module PostRunner
     end
 
     def activity_sub_type
-      ActivitySubTypes[@sub_sport] || 'Undefined "#{@sub_sport}"'
+      ActivitySubTypes[@sub_sport] || "Undefined #{@sub_sport}"
     end
 
     def distance(timestamp, unit_system)

data/lib/postrunner/ActivitySummary.rb

@@ -316,7 +316,7 @@ module PostRunner
           if zone.type == 18
             total_time = 0.0
             if zone.time_in_hr_zone
-              zone.time_in_hr_zone.each { |tiz| total_time += tiz }
+              zone.time_in_hr_zone.each { |tiz| total_time += tiz if tiz }
             end
             break if total_time <= 0.0
             if zone.heart_rate_zones
@@ -354,12 +354,22 @@ module PostRunner
     def local_value(fdr, field, format, units)
       unit = units[@unit_system]
       value = fdr.get_as(field, unit)
+      if value.nil? && field == 'avg_speed'
+        # New fit files used 'enhanced_avg_speed' instead of the older
+        # 'avg_speed'.
+        value = fdr.get_as('enhanced_avg_speed', unit)
+      end
       return '-' unless value
       "#{format % [value, unit]}"
     end
 
     def pace(fdr, field, show_unit = true)
       speed = fdr.get(field)
+      if speed.nil? && field == 'avg_speed'
+        # New fit files used 'enhanced_avg_speed' instead of the older
+        # 'avg_speed'.
+        speed = fdr.get('enhanced_avg_speed')
+      end
       case @unit_system
       when :metric
         "#{speedToPace(speed)}#{show_unit ? ' min/km' : ''}"

data/lib/postrunner/ActivityView.rb

@@ -53,7 +53,8 @@ module PostRunner
     def generate_html(doc)
       doc.unique(:activityview_style) {
         doc.head {
-          [ 'jquery/jquery-2.1.1.min.js', 'flot/jquery.flot.js',
+          [ 'jquery/jquery-3.5.1.min.js', 'flot/jquery.flot.js',
+            #'flot/jquery.flot.time.js' ].each do |js|
             'flot/jquery.flot.time.js' ].each do |js|
             doc.script({ 'language' => 'javascript',
                          'type' => 'text/javascript', 'src' => js })

data/lib/postrunner/ChartView.rb

@@ -30,7 +30,7 @@ module PostRunner
           :unit => select_unit('min/km'),
           :graph => :line_graph,
           :colors => '#0A7BEE',
-          :show => @sport == 'running' || @sport == 'multisport',
+          :show => @sport == 'running' || @sport == 'multisport'
         },
         {
           :id => 'speed',
@@ -40,9 +40,17 @@ module PostRunner
           :colors => '#0A7BEE',
           :show => @sport != 'running'
         },
+        {
+          :id => 'Power_18FB2CF01A4B430DAD66988C847421F4',
+          :label => 'Power',
+          :unit => select_unit('Watts'),
+          :graph => :line_graph,
+          :colors => '#FFAC2E',
+          :show => @sport == 'running' || @sport == 'multisport'
+        },
         {
           :id => 'altitude',
-          :label => 'Elevation',
+          :label => 'Altitude',
           :unit => select_unit('m'),
           :graph => :line_graph,
           :colors => '#5AAA44',
@@ -73,6 +81,14 @@ module PostRunner
           :colors => '#900000',
           :show => false
         },
+        {
+          :id => 'respiration_rate',
+          :label => 'Respiration Rate',
+          :unit => 'brpm',
+          :graph => :line_graph,
+          :colors => '#9cd6ef',
+          :show => true
+        },
         {
           :id => 'performance_condition',
           :label => 'Performance Condition',
@@ -119,6 +135,22 @@ module PostRunner
                        [ '#FF5558', nil ] ],
           :show => @sport == 'running' || @sport == 'multisport'
         },
+        {
+          :id => 'Form_Power_18FB2CF01A4B430DAD66988C847421F4',
+          :label => 'Form Power',
+          :unit => select_unit('Watts'),
+          :graph => :line_graph,
+          :colors => '#CBBB58',
+          :show => @sport == 'running' || @sport == 'multisport'
+        },
+        {
+          :id => 'Leg_Spring_Stiffness_18FB2CF01A4B430DAD66988C847421F4',
+          :label => 'Leg Spring Stiffness',
+          :unit => select_unit('kN/m'),
+          :graph => :line_graph,
+          :colors => '#358C88',
+          :show => @sport == 'running' || @sport == 'multisport'
+        },
         {
           :id => 'stance_time',
           :label => 'Ground Contact Time',
@@ -149,6 +181,14 @@ module PostRunner
           :colors => '#A88BBB',
           :show => @sport == 'cycling'
         },
+        {
+          :id => "Air_Power_18FB2CF01A4B430DAD66988C847421F4",
+          :label => 'Air Power',
+          :unit => select_unit('Watts'),
+          :graph => :line_graph,
+          :colors => '#919498',
+          :show => @sport == 'running' || @sport == 'multisport'
+        },
         {
           :id => 'temperature',
           :label => 'Temperature',
@@ -221,7 +261,7 @@ EOT
     end
 
     def java_script
-      s = "$(function() {\n"
+      s = "$(document).ready(function() {\n"
 
       s << tooltip_div
       @charts.each do |chart|
@@ -295,7 +335,18 @@ EOT
             # finish the line and start a new one later.
             data_set << [ (last_timestamp - start_time + 1).to_i * 1000, nil ]
           end
-          if (value = r.get_as(chart[:id], chart[:unit] || ''))
+          value = r.get_as(chart[:id], chart[:unit] || '')
+          if value.nil? && chart[:id] == 'speed'
+            # If speed field doesn't exist the value might be in the
+            # enhanced_speed field.
+            value = r.get_as('enhanced_speed', chart[:unit] || '')
+          end
+          if value.nil? && chart[:id] == 'altitude'
+            # If altitude field doesn't exist the value might be in the
+            # enhanced_elevation field.
+            value = r.get_as('enhanced_elevation', chart[:unit] || '')
+          end
+          if value
             if chart[:id] == 'pace'
               # Slow speeds lead to very large pace values that make the graph
               # hard to read. We cap the pace at 20.0 min/km to keep it

data/lib/postrunner/DailyMonitoringView.rb

@@ -44,7 +44,7 @@ module PostRunner
     def generate_html(doc)
       doc.unique(:dailymonitoringview_style) {
         doc.head {
-          [ 'jquery/jquery-2.1.1.min.js', 'flot/jquery.flot.js',
+          [ 'jquery/jquery-3.5.1.min.js', 'flot/jquery.flot.js',
             'flot/jquery.flot.time.js' ].each do |js|
             doc.script({ 'language' => 'javascript',
                          'type' => 'text/javascript', 'src' => js })

data/lib/postrunner/DeviceList.rb

@@ -126,6 +126,19 @@ module PostRunner
           t.new_row
         end
 
+        if (ant_id = device.ant_id)
+          t.cell('ANT ID:')
+          t.cell(ant_id)
+          t.new_row
+        end
+
+        if ant_id && (sensor_settings = find_settings_by_ant_id(ant_id)) &&
+            (calibration_factor = sensor_settings.calibration_factor)
+          t.cell('Calibration Factor')
+          t.cell('%.1f' % calibration_factor)
+          t.new_row
+        end
+
         if (rx_ok = device.rx_packets_ok) && (rx_err = device.rx_packets_err)
           t.cell('Packet Errors:')
           t.cell('%d%%' % ((rx_err.to_f / (rx_ok + rx_err)) * 100).to_i)
@@ -148,6 +161,14 @@ module PostRunner
       tables
     end
 
+    private
+
+    def find_settings_by_ant_id(ant_id)
+      @fit_activity.sensor_settings.find do |sensor|
+        sensor.ant_id == ant_id
+      end
+    end
+
   end
 
 end

data/lib/postrunner/EventList.rb

@@ -75,7 +75,7 @@ module PostRunner
       case event.event
       when 'timer'
         name = "Timer (#{event.event_type.gsub(/_/, ' ')})"
-        value = event.timer_trigger
+        value = '-'
       when 'course_point'
         name = 'Course Point'
         value = event.message_index
@@ -121,12 +121,19 @@ module PostRunner
       when 'comm_timeout'
         name 'Communication timeout'
         value = event.comm_timeout
+      when 'off_course'
+        name = 'Off Course'
+        value = '-'
       when 'recovery_hr'
         name = 'Recovery heart rate'
         value = "#{event.recovery_hr} bpm"
       when 'recovery_time'
         name = 'Recovery time'
-        value = "#{secsToDHMS(event.recovery_time * 60)}"
+        if event.recovery_time
+          value = "#{secsToDHMS(event.recovery_time * 60)}"
+        else
+          value = '-'
+        end
       when 'recovery_info'
         name = 'Recovery info'
         mins = event.recovery_info
@@ -140,6 +147,9 @@ module PostRunner
       when 'lactate_threshold_speed'
         name = 'Lactate Threshold Pace'
         value = pace(event, 'lactate_threshold_speed')
+      when 'functional_threshold_power'
+        name = 'Functional Threshold Power'
+        value = "#{event.functional_threshold_power} W"
       else
         name = event.event
         value = event.data

data/lib/postrunner/FFS_Activity.rb

@@ -253,7 +253,7 @@ module PostRunner
     end
 
     def activity_sub_type
-      ActivitySubTypes[@sub_sport] || 'Undefined'
+      ActivitySubTypes[@sub_sport] || "Undefined #{@sub_sport}"
     end
 
     def distance(timestamp, unit_system)

data/lib/postrunner/FFS_Device.rb

@@ -3,7 +3,7 @@
 #
 # = FFS_Device.rb -- PostRunner - Manage the data from your Garmin sport devices.
 #
-# Copyright (c) 2015, 2016, 2018 by Chris Schlaeger <cs@taskjuggler.org>
+# Copyright (c) 2015, 2016, 2018, 2020 by Chris Schlaeger <cs@taskjuggler.org>
 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of version 2 of the GNU General Public License as
@@ -83,7 +83,8 @@ module PostRunner
           return nil
         end
       else
-        # Don't add the entity if has deleted before and overwrite isn't true.
+        # Don't add the entity if it has deleted before and overwrite isn't
+        # true.
         path = @store['file_store'].fit_file_dir(File.basename(fit_file_name),
                                                  long_uid, type)
         fq_fit_file_name = File.join(path, File.basename(fit_file_name))

data/lib/postrunner/FitFileStore.rb

@@ -44,7 +44,7 @@ module PostRunner
     # Setup non-persistent variables.
     def restore
       @data_dir = @store['config']['data_dir']
-      # Ensure that we have an Array in the store to hold all known devices.
+      # Ensure that we have a Hash in the store to hold all known devices.
       @store['devices'] = @store.new(PEROBS::Hash) unless @store['devices']
 
       @devices_dir = File.join(@data_dir, 'devices')
@@ -69,8 +69,58 @@ module PostRunner
     end
 
     # Version upgrade logic.
-    def handle_version_update
-      # Nothing here so far.
+    def handle_version_update(from_version, to_version)
+      if from_version <= Gem::Version.new('0.12.0')
+        # PostRunner up until version 0.12.0 was using a long_uid with
+        # manufacturer name and product name. This was a bad idea since unknown
+        # devices were resolved to their numerical ID. In case the unknown ID
+        # was later added to the dictionary in fit4ruby version update, it
+        # resolved to its name and the device was recognized as a new device.
+        # Versions after 0.12.0 only use the numerical versions for the device
+        # long_uid and directory names.
+        uid_remap = {}
+        @store['devices'].each do |uid, device|
+          old_uid = uid
+
+          if (first_activity = device.activities.first)
+            first_activity.load_fit_file
+            if  (fit_activity = first_activity.fit_activity)
+              if (device_info = fit_activity.device_infos.first)
+                new_uid = "#{device_info.numeric_manufacturer}-" +
+                  "#{device_info.numeric_product}-#{device_info.serial_number}"
+
+                uid_remap[old_uid] = new_uid
+                puts first_activity.fit_file_name
+              end
+            end
+          end
+        end
+
+        @store.transaction do
+          pwd = Dir.pwd
+          base_dir_name = @store['config']['devices_dir']
+          Dir.chdir(base_dir_name)
+
+          uid_remap.each do |old_uid, new_uid|
+            if Dir.exist?(old_uid) && !Dir.exist?(new_uid) &&
+                !File.symlink?(old_uid)
+              # Rename the directory from the old (string) scheme to the
+              # new numeric scheme.
+              FileUtils.mv(old_uid, new_uid)
+              # Create a symbolic link with that points the old name to
+              # the new name.
+              File.symlink(new_uid, old_uid)
+            end
+
+            # Now update the long_uid in the FFS_Device object
+            @store['devices'][new_uid] = device = @store['devices'][old_uid]
+            device.long_uid = new_uid
+            @store['devices'].delete(old_uid)
+          end
+
+          Dir.chdir(pwd)
+        end
+      end
     end
 
     # Add a file to the store.
@@ -94,8 +144,11 @@ module PostRunner
 
       # Generate a String that uniquely identifies the device that generated
       # the FIT file.
-      id = extract_fit_file_id(fit_entity)
-      long_uid = "#{id[:manufacturer]}-#{id[:product]}-#{id[:serial_number]}"
+      unless (id = extract_fit_file_id(fit_entity))
+        return nil
+      end
+      long_uid = "#{id[:numeric_manufacturer]}-" +
+        "#{id[:numeric_product]}-#{id[:serial_number]}"
 
       # Make sure the device that created the FIT file is properly registered.
       device = register_device(long_uid)
@@ -187,6 +240,7 @@ module PostRunner
       @store['records'].generate_html_reports
       generate_html_index_pages
     end
+
     # Determine the right directory for the given FIT file. The resulting path
     # looks something like /home/user/.postrunner/devices/garmin-fenix3-1234/
     # activity/5A.
@@ -450,42 +504,23 @@ module PostRunner
         return nil
       end
 
-      if fid.manufacturer == 'garmin' &&
-         fid.garmin_product == 'fr920xt'
-        # Garmin Fenix3 with firmware before 6.80 is reporting 'fr920xt' in
-        # the file_id section but 'fenix3' in the first device_info section.
-        # To tell the Fenix3 apart from the FR920XT we need to look into the
-        # device_info section for all devices with a garmin_product of
-        # 'fr920xt'.
-        fit_entity.device_infos.each do |di|
-          if di.device_index == 0
-            return {
-              :manufacturer => di.manufacturer,
-              :product => di.garmin_product || di.product,
-              :serial_number => di.serial_number
-            }
-          end
-        end
-        Log.error "Fit entity has no device info for 0"
-        return nil
-      else
-        # And for all properly developed devices we can just look at the
-        # file_id section.
-        if fid.manufacturer.nil? ||
-           fid.manufacturer[0..'Undocumented value'.length - 1] ==
-           'Undocumented value'
-          Log.error "Cannot store FIT files for unknown manufacturer " +
-            fid.manufacturer
-          return nil
+      fit_entity.device_infos.each do |di|
+        # Not all FIT file have indexed device sections. In case the device
+        # index is nil we'll take the first entry.
+        if (di.device_index.nil? || di.device_index == 0) &&
+            di.numeric_manufacturer && di.numeric_product
+          return {
+            :manufacturer => di.manufacturer,
+            :product => di.garmin_product || di.product,
+            :numeric_manufacturer => di.numeric_manufacturer,
+            :numeric_product => di.numeric_product,
+            :serial_number => di.serial_number || 0
+          }
         end
-        fid.serial_number ||= 0
-
-        return {
-          :manufacturer => fid.manufacturer,
-          :product => fid.garmin_product || fid.product,
-          :serial_number => fid.serial_number
-        }
       end
+
+      Log.error "Fit entity has no device info section"
+      return nil
     end
 
     def register_device(long_uid)
@@ -502,7 +537,8 @@ module PostRunner
           @store.new(FFS_Device, short_uid, long_uid)
 
         # Create the directory to store the FIT files of this device.
-        create_directory(File.join(@devices_dir, long_uid), long_uid)
+        create_directory(File.join(@devices_dir, long_uid),
+                         long_uid)
       end
 
       @store['devices'][long_uid]