postrunner 1.0.0 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb8a80028ee50a8f543d589b44fd41523208483a1743d29ec86e37525ff84a13
-  data.tar.gz: 9834c6dc556e9e118fca144a8edd33e9cecc51eb9bc4487d43218973f5dae719
+  metadata.gz: a3573b66dc63e6e6e26ed20c4389a9c4da0ea2aa3a6bba64e5cce363ddbe1531
+  data.tar.gz: 26e721d0ddc3cae1852c7135de1f24d3dc03e32be871c0894c958591ec538f11
 SHA512:
-  metadata.gz: 8544b0aca1e86a9ca4e90aa437684a9fc56ac925cefe115ac9453816d1373242fcf6aa94d86ea779ea947ebb982b318141c45df43197d77a78b2375aeb5f6724
-  data.tar.gz: d5354f1f321685cb7181c75cee537d36695bddb0cecea175cd703de678af9055db10e089740f6719f1c6097e3fc2a2713951ae396b558b3ffc39a5bbfbe9f722
+  metadata.gz: eac508a3916d92e2843e3ff34a454fd357ad35dbcf798178e7bdb555ef9b25f9010d5f647567e1907982bf11adb24c71592d3e3e3af1b3fe46d9c921cb36ea31
+  data.tar.gz: 51994f58aefd6354123655260a45772cc4d7e301d236b76628d27ce2af5370297aecd3c669e2147f8bf0ae91ffcbd5c7c2fbd171bf4fa6eff0a4015f7705a2ef

data/.github/workflows/ruby.yml

@@ -0,0 +1,33 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ ubuntu]
+        ruby: [2.4, 2.5, 2.6, 2.7, 3.0, head]
+    continue-on-error: ${{ endsWith(matrix.ruby, 'head') }}
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+
+    - name: Test with RSpec
+      run: bundle exec rspec

data/README.md

@@ -2,45 +2,93 @@
 
 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
 
+### Mounting the watch
+
+Watches that expose their data as FAT file system. Typically after connecting
+your garmin watch, they are mount automatically if you have installed the
+udev package.
+
+For watches that expose their data via MTP (Media Transfer Procotol). For
+Debian buster running `sudo apt install jmtpfs mtp-tools` will install the
+needed packages.
+
+`mkdir /tmp/forerunner; jmtpfs  /tmp/forerunner`
+
+This has been tested with a Garmin Forerunner 945.
+
+For more information about MTP under Windows have a look at the
+[Garmin FAQ](https://support.garmin.com/?faq=Itl8M6ARrh4gBQMHFqdqK8)
+
 ### Importing FIT files
 
 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
+mount it as a disk drive. Only devices that expose their data as FAT or MTP 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.
 
+* for USB-FAT
 ```
 $ postrunner import /run/media/$USER/GARMIN/GARMIN/ACTIVITY/
 ```
-    
-The above command assumes that your device is mounted as
-/run/media/$USER. Please replace $USER with your login name and the
-path with the path to your device. Files that have been imported
-previously will not be imported again. 
+The above command assumes that your device is mounted as /run/media/$USER.
+Please replace $USER with your login name and the path with the path to
+your device.
+
+* for MTP (assuming you mounted it as described above)
+```
+$ postrunner import /tmp/forerunner/Primary/GARMIN/Activity
+```
+
+* Note
+Files that have been imported previously will not be imported again.
 
 ### Viewing FIT file data on the console
 
@@ -128,7 +176,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/Rakefile

@@ -1,24 +1,9 @@
-$:.unshift File.join(File.dirname(__FILE__))
-
-# Add the lib directory to the search path if it isn't included already
-lib = File.expand_path('../lib', __FILE__)
-$:.unshift lib unless $:.include?(lib)
-
+#!/usr/bin/env ruby
+require_relative 'lib/postrunner/version'
+require 'rake'
+require 'rspec'
 require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-require 'rake/clean'
-require 'yard'
-YARD::Rake::YardocTask.new
-
-Dir.glob( 'tasks/*.rake').each do |fn|
-  begin 
-    load fn;
-  rescue LoadError
-    puts "#{fn.split('/')[1]} tasks unavailable: #{$!}"
-  end
-end
-
-task :default  => :spec
-task :test => :spec
+require 'rspec/core/rake_task'
 
-desc 'Run all unit and spec tests'
+RSpec::Core::RakeTask.new(:spec)
+ 

data/lib/postrunner/Activity.rb

@@ -65,6 +65,37 @@ module PostRunner
       'hiking' => 'Hiking',
       'multisport' => 'Multisport',
       'paddling' => 'Paddling',
+      'training' => 'Training',
+      'flying' => 'Flying',
+      'e_biking' => 'E-Biking',
+      'motorcycling' => 'Motor Cycling',
+      'boating' => 'Boating',
+      'driving' => 'Driving',
+      'golf' => 'Golf',
+      'hang_gliding' => 'Hang Gliding',
+      'horseback_riding' => 'Horseback Riding',
+      'hunting' => 'Hunting',
+      'fishing' => 'Fishing',
+      'inline_skating' => 'Inline Skating',
+      'rock_climbing' => 'Rock Climbing',
+      'sailing' => 'Sailing',
+      'ice_skating' => 'Ice Skating',
+      'sky_diving' => 'Sky Diving',
+      'snowshoeing' => 'Snowshoeing',
+      'snowmobiling' => 'Snowmobiling',
+      'stand_up_paddleboarding' => 'Stand Up Paddleboarding',
+      'surfing' => 'Surfing',
+      'wakeboarding' => 'Wakeboarding',
+      'water_skiing' => 'Water Skiing',
+      'kayaking' => 'Kayaking',
+      'rafting' => 'Rafting',
+      'windsurfing' => 'Windsurfing',
+      'kitesurfing' => 'Kitesurfing',
+      'tactical' => 'Tactical',
+      'jumpmaster' => 'Jumpmaster',
+      'boxing' => 'Boxing',
+      'floor_climbing' => 'Floor Climbing',
+      'diving' => 'Diving',
       'all' => 'All'
     }
     ActivitySubTypes = {
@@ -95,7 +126,43 @@ module PostRunner
       'challenge' => 'Challenge',
       'indoor_skiing' => 'Indoor Skiing',
       'cardio_training' => 'Cardio Training',
+      'e_bike_fitness' => 'E Bike Fittness',
+      'bmx' => 'BMX',
+      'casual_walking' => 'Casual Walking',
+      'speed_walking' => 'Speed Walking',
+      'bike_to_run_transition' => 'Bike to Run Transition',
+      'run_to_bike_transition' => 'Run to Bike Transition',
+      'swim_to_bike_transition' => 'Swim to Bike Transition',
+      'atv' => 'ATV',
+      'motocross' => 'Motocross',
+      'backcountry' => 'Backcountry',
+      'resort' => 'Resort',
+      'rc_drone' => 'RC Drone',
+      'wingsuit' => 'Wingsuite',
+      'whitewater' => 'Whitemaster',
+      'skate_skiing' => 'Skate Skiing',
+      'yoga' => 'Yoga',
+      'pilates' => 'Pilates',
+      'indoor_running' => 'Indoor Running',
+      'gravel_cycling' => 'Gravel Cycling',
+      'e_bike_mountain' => 'E-Bike Mountain',
+      'commuting' => 'Commuting',
+      'mixed_surface' => 'Mixed Surface',
+      'navigate' => 'Navigate',
+      'track_me' => 'Track Me',
+      'map' => 'Map',
+      'single_gas_diving' => 'Single Gas Diving',
+      'multi_gas_diving' => 'Multi Gas Diving',
+      'gauge_diving' => 'Gauge Diving',
+      'apnea_diving' => 'Apnea Diving',
+      'apnea_hunting' => 'Apnea Hunting',
       'virtual_activity' => 'Virtual Activity',
+      'obstacle' => 'Obstacle',
+      'breathing' => 'Breating',
+      'sail_race' => 'Sail Race',
+      'ultra' => 'Ultra',
+      'indoor_climbing' => 'Indoor Climbing',
+      'bouldering' => 'Bouldering',
       'all' => 'All'
     }
 

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',
@@ -127,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',
@@ -157,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',
@@ -229,7 +261,7 @@ EOT
     end
 
     def java_script
-      s = "$(function() {\n"
+      s = "$(document).ready(function() {\n"
 
       s << tooltip_div
       @charts.each do |chart|

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/FitFileStore.rb

@@ -144,7 +144,9 @@ module PostRunner
 
       # Generate a String that uniquely identifies the device that generated
       # the FIT file.
-      id = extract_fit_file_id(fit_entity)
+      unless (id = extract_fit_file_id(fit_entity))
+        return nil
+      end
       long_uid = "#{id[:numeric_manufacturer]}-" +
         "#{id[:numeric_product]}-#{id[:serial_number]}"
 
@@ -502,46 +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,
-              :numeric_manufacturer => di.numeric_manufacturer,
-              :numeric_product => di.numeric_product,
-              :serial_number => di.serial_number
-            }
-          end
+      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
-        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
-        end
-        fid.serial_number ||= 0
-
-        return {
-          :manufacturer => fid.manufacturer,
-          :product => fid.garmin_product || fid.product,
-          :numeric_manufacturer => di.numeric_manufacturer,
-          :numeric_product => di.numeric_product,
-          :serial_number => fid.serial_number
-        }
       end
+
+      Log.error "Fit entity has no device info section"
+      return nil
     end
 
     def register_device(long_uid)

data/lib/postrunner/Main.rb

@@ -310,6 +310,7 @@ EOT
       handle_version_update
       import_legacy_archive
 
+      retval = 0
       case (cmd = args.shift)
       when 'check'
         if args.empty?
@@ -334,7 +335,9 @@ EOT
         # is given, use the current date.
         @ffs.monthly_report(day_in_localtime(args, '%Y-%m-01'))
       when 'delete'
-        process_activities(args, :delete)
+        unless process_activities(args, :delete)
+          retval = 1
+        end
       when 'dump'
         @filter = Fit4Ruby::FitFilter.new unless @filter
         process_files_or_activities(args, :dump)
@@ -344,9 +347,13 @@ EOT
         if args.empty?
           # If we have no file or directory for the import command, we get the
           # most recently used directory from the runtime config.
-          process_files([ @db['config']['import_dir']  ], :import)
+          unless process_files([ @db['config']['import_dir']  ], :import)
+            retval = 1
+          end
         else
-          process_files(args, :import)
+          unless process_files(args, :import)
+            retval = 1
+          end
           if args.length == 1 && Dir.exists?(args[0])
             # If only one directory was specified as argument we store the
             # directory for future use.
@@ -361,7 +368,9 @@ EOT
         unless (@name = args.shift)
           Log.abort 'You must provide a new name for the activity'
         end
-        process_activities(args, :rename)
+        unless process_activities(args, :rename)
+          retval = 1
+        end
       when 'set'
         unless (@attribute = args.shift)
           Log.abort 'You must specify the attribute you want to change'
@@ -369,7 +378,9 @@ EOT
         unless (@value = args.shift)
           Log.abort 'You must specify the new value for the attribute'
         end
-        process_activities(args, :set)
+        unless process_activities(args, :set)
+          retval = 1
+        end
       when 'show'
         if args.empty?
           @ffs.show_list_in_browser
@@ -378,12 +389,18 @@ EOT
           # given day in a browser.
           @ffs.show_monitoring(args[0])
         else
-          process_activities(args, :show)
+          unless process_activities(args, :show)
+            retval = 1
+          end
         end
       when 'sources'
-        process_activities(args, :sources)
+        unless process_activities(args, :sources)
+          retval = 1
+        end
       when 'summary'
-        process_activities(args, :summary)
+        unless process_activities(args, :summary)
+          retval = 1
+        end
       when 'units'
         change_unit_system(args)
       when 'htmldir'
@@ -399,7 +416,7 @@ EOT
       # Ensure that all updates are written to the database.
       @db.sync
 
-      0
+      retval
     end
 
     def help
@@ -409,11 +426,13 @@ EOT
     def process_files_or_activities(files_or_activities, command)
       files_or_activities.each do |foa|
         if foa[0] == ':'
-          process_activities([ foa ], command)
+          return false unless process_activities([ foa ], command)
         else
-          process_files([ foa ], command)
+          return false unless process_files([ foa ], command)
         end
       end
+
+      true
     end
 
     def process_activities(activity_refs, command)
@@ -426,15 +445,19 @@ EOT
           activities = @ffs.find(a_ref[1..-1])
           if activities.empty?
             Log.warn "No matching activities found for '#{a_ref}'"
-            return
+            return false
+          end
+          activities.each do |a|
+            unless process_activity(a, command)
+              return false
+            end
           end
-          activities.each { |a| process_activity(a, command) }
         else
           Log.abort "Activity references must start with ':': #{a_ref}"
         end
       end
 
-      nil
+      true
     end
 
     def process_files(files_or_dirs, command)
@@ -445,12 +468,14 @@ EOT
       files_or_dirs.each do |fod|
         if File.directory?(fod)
           Dir.glob(File.join(fod, '*.FIT'), File::FNM_CASEFOLD).each do |file|
-            process_file(file, command)
+            return false unless process_file(file, command)
           end
         else
-          process_file(fod, command)
+          return false unless process_file(fod, command)
         end
       end
+
+      true
     end
 
     # Process a single FIT file according to the given command.
@@ -597,7 +622,6 @@ EOT
 
     def handle_version_update
       if @db['config']['version'] != VERSION
-        puts "Work needed"
         from_version = Gem::Version.new(@db['config']['version'])
         to_version = Gem::Version.new(VERSION)