fit4ruby 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2cf519ee70f6b6337d1954ae6073ffa16e268953
-  data.tar.gz: e823bcb9ea3857f7900e4e3e08a4bb97a057145a
+  metadata.gz: 012c8c74873a9ce1d703e72c75e14019d480db0f
+  data.tar.gz: 32137198f2a8a87dc473c7bdc0c3bdc978a9e31c
 SHA512:
-  metadata.gz: a92c584b15630e0cdd8c0d18ceed90214f84413df8246776c15a69f3ed685768015e2f9be70f9dd62cda5f12fb459022203fe8d55f3d34d117f07914e4530272
-  data.tar.gz: 3b11fec1a502086756ff02a3d206aa64350ce0be86245bc71bbaf816d402c20b0dd0917635996368331de0ddda211786042b93e6ead52e762a1005727ddd39f7
+  metadata.gz: b5c6653686b550a201b71ad021af82d79cc03b092fceda5441fd286c0a3e34ff2c7f2291b35aa5f8ed3c740060953a47b63ef1c2c895a8571cf09a0464566640
+  data.tar.gz: bb3b5778604e1f342163fd751c3e3beccb09c3aa8ddcebb5deb7274c1623e6d194408b54486f34837d80645aa471e5c2132236551d5bf4c8ff2fc1f3864f3a07

data/lib/fit4ruby/Activity.rb

@@ -36,6 +36,7 @@ module Fit4Ruby
     #        certain fields of the FitDataRecord.
     def initialize(field_values = {})
       super('activity')
+      @meta_field_units['total_gps_distance'] = 'm'
       @num_sessions = 0
 
       @file_id = FileId.new
@@ -59,7 +60,7 @@ module Fit4Ruby
     # Perform some basic logical checks on the object and all references sub
     # objects. Any errors will be reported via the Log object.
     def check
-      unless @timestamp && @timestamp >= Time.parse('1990-01-01')
+      unless @timestamp && @timestamp >= Time.parse('1990-01-01T00:00:00+00:00')
         Log.error "Activity has no valid timestamp"
       end
       unless @total_timer_time
@@ -71,6 +72,12 @@ module Fit4Ruby
                   "FIT file."
       end
       @sessions.each { |s| s.check(self) }
+      # Laps must have a consecutively growing message index.
+      @laps.each.with_index do |lap, index|
+        unless lap.message_index == index
+          Log.error "Lap #{index} has wrong message_index #{lap.message_index}"
+        end
+      end
     end
 
     # Convenience method that aggregates all the distances from the included
@@ -81,6 +88,48 @@ module Fit4Ruby
       d
     end
 
+    # Total distance convered by this activity purely computed by the GPS
+    # coordinates. This may differ from the distance computed by the device as
+    # it can be based on a purely calibrated footpod.
+    def total_gps_distance
+      timer_stops = []
+      # Generate a list of all timestamps where the timer was stopped.
+      @events.each do |e|
+        if e.event == 'timer' && e.event_type == 'stop_all'
+          timer_stops << e.timestamp
+        end
+      end
+
+      # The first record of a FIT file can already have a distance associated
+      # with it. The GPS location of the first record is not where the start
+      # button was pressed. This introduces a slight inaccurcy when computing
+      # the total distance purely on the GPS coordinates found in the records.
+      d = 0.0
+      last_lat = last_long = nil
+
+      # Iterate over all the records and accumlate the distances between the
+      # neiboring coordinates.
+      @records.each do |r|
+        if (lat = r.position_lat) && (long = r.position_long)
+          if last_lat && last_long
+            d += Fit4Ruby::GeoMath.distance(last_lat, last_long,
+                                            lat, long)
+          end
+          if timer_stops[0] == r.timestamp
+            # If a stop event was found for this record timestamp we clear the
+            # last_* values so that the distance covered while being stopped
+            # is not added to the total.
+            last_lat = last_long = nil
+            timer_stops.shift
+          else
+            last_lat = lat
+            last_long = long
+          end
+        end
+      end
+      d
+    end
+
     # Call this method to update the aggregated data fields stored in Lap and
     # Session objects.
     def aggregate

data/lib/fit4ruby/Converters.rb

@@ -68,11 +68,11 @@ module Fit4Ruby
     end
 
     def time_to_fit_time(t)
-      (t - Time.parse('1989-12-31')).to_i
+      (t - Time.parse('1989-12-31T00:00:00+00:00')).to_i
     end
 
     def fit_time_to_time(ft)
-      Time.parse('1989-12-31') + ft.to_i
+      Time.parse('1989-12-31T00:00:00+00:00') + ft.to_i
     end
 
   end

data/lib/fit4ruby/GlobalFitDictionaries.rb

@@ -67,6 +67,9 @@ module Fit4Ruby
     entry 5, 'critical'
 
     dict 'device_type'
+    entry 0, 'position' # Just a guess
+    entry 3, 'acceleration' # Just a guess
+    entry 4, 'barometric_pressure' # Just a guess
     entry 1, 'antfs'
     entry 11, 'bike_power'
     entry 12, 'environment_sensor_legacy'
@@ -159,8 +162,15 @@ module Fit4Ruby
     dict 'garmin_product'
     entry 8, 'hrm_run_single_byte_product_id'
     entry 1551, 'fenix'
+    # The Fenix3 is rumored to have a Mediatek MT3333 GPS chipset. Not sure if
+    # that would be a beter name.
+    entry 1620, 'fenix3_gps' # Just a guess
     entry 1623, 'fr620'
     entry 1632, 'fr220'
+    # The FR620 is rumored to have a MediaTek MT3339 GPS chipset while the
+    # FR920XT is rumored to have a MT3333. Not sure why they have the same ID
+    # in the FIT file for the GPS device.
+    entry 1689, 'fr620_fr920xt_gps' # Just a guess
     entry 1752, 'hrm_run'
     entry 1765, 'fr920xt'
     entry 1928, 'fr620_japan'
@@ -208,6 +218,10 @@ module Fit4Ruby
     entry 0x3FFF, 'mask'
     entry 0x8000, 'right'
 
+    dict 'length_type'
+    entry 0, 'idle'
+    entry 1, 'active'
+
     dict 'manufacturer'
     entry 1, 'garmin'
     entry 2, 'garmin_fr405_antfs'

data/lib/fit4ruby/GlobalFitMessages.rb

@@ -26,6 +26,7 @@ module Fit4Ruby
     field 4, 'uint32', 'time_created', :type => 'date_time'
     field 5, 'uint16', 'number'
     field 6, 'uint16', 'undocumented_field_6'
+    field 7, 'uint32', 'undocumented_field_7'
 
     message 12, 'sport'
     field 0, 'enum', 'sport', :dict => 'sport'
@@ -253,13 +254,14 @@ module Fit4Ruby
     field 4, 'uint8', 'event_group'
     field 253, 'uint32', 'timestamp', :type => 'date_time'
 
-    # Possibly the status of the sensors; Not documented in FIT SDK
-    message 22, 'sensor_status'
-    field 0, 'uint8', 'undocumented_field_0' # 1 - 5 or no value seen
-    field 1, 'uint8', 'undocumented_field_1' # Always identical to field 0
-    field 2, 'uint8', 'undocumented_field_2' # 1 - 5 or no value seen
-    field 3, 'uint8', 'undocumented_field_3' # 1, 3, 5 or no value seen
-    field 4, 'uint8', 'undocumented_field_4' # 1 - 3 or no value seen
+    # Possibly which device is used as metering source.
+    # Not documented in FIT SDK, so these are all guesses right now.
+    message 22, 'metering_devices'
+    field 0, 'uint8', 'speed'
+    field 1, 'uint8', 'distance'
+    field 2, 'uint8', 'cadence'
+    field 3, 'uint8', 'altitude'
+    field 4, 'uint8', 'heart_rate'
     field 5, 'enum', 'undocumented_field_5' # 0 or 3 seen
     field 6, 'uint8', 'undocumented_field_6' # First found in FR920XT
     field 14, 'uint8', 'undocumented_field_14' # First found in FR920XT
@@ -336,7 +338,7 @@ module Fit4Ruby
     field 0, 'enum', 'device_index'
     field 1, 'uint16', 'calories', :unit => 'kcal'
     field 2, 'uint32', 'distance', :scale => 100, :unit => 'm'
-    field 5, 'enum', 'activity_type'
+    field 5, 'enum', 'activity_type', :dict => 'activity_type'
     alt_field 3, 'activity_type' do
       field :default, 'uint32', 'cycles', :scale => 2, :unit => 'cycles'
       field [ 'walking', 'running' ], 'uint32', 'steps', :unit => 'steps'
@@ -351,7 +353,7 @@ module Fit4Ruby
     field 11, 'uint16', 'local_timestamp'
     field 19, 'uint16', 'active_calories', :unit => 'kcal'
     field 24, 'byte', 'current_activity_type_intensity', :type => 'activity_intensity'
-    field 26, 'uint16', 'timestamp16', :unit => 's'
+    field 26, 'uint16', 'timestamp_16', :unit => 's'
     field 29, 'uint16', 'duration_min', :unit => 'min'
     field 253, 'uint32', 'timestamp', :type => 'date_time'
 
@@ -383,6 +385,24 @@ module Fit4Ruby
     field 9, 'uint16', 'undocumented_field_9' # maybe activity measurement
     field 253, 'uint32', 'timestamp', :type => 'date_time'
 
+    message 101, 'length'
+    field 0, 'enum', 'event', :dict => 'event'
+    field 1, 'enum', 'event_type', :dict => 'event_type'
+    field 2, 'uint32', 'date_time', :type => 'date_time'
+    field 3, 'uint32', 'total_elapsed_time', :scale => 1000, :unit => 's'
+    field 4, 'uint32', 'total_timer_time', :scale => 1000, :unit => 's'
+    field 5, 'uint16', 'total_strokes', :unit => 'strokes'
+    field 6, 'uint16', 'avg_speed', :scale => 1000, :unit => 'm/s'
+    field 7, 'enum', 'swim_stroke', :dict => 'swim_stroke'
+    field 9, 'uint8', 'avg_swimming_cadence', :unit => 'strokes/min'
+    field 10, 'uint8', 'event_group'
+    field 11, 'uint16', 'total_calories', :unit => 'kcal'
+    field 12, 'enum', 'length_type', :dict => 'length_type'
+    field 18, 'uint16', 'player_score'
+    field 19, 'uint16', 'opponent_score'
+    field 253, 'uint32', 'timestamp', :type => 'date_time'
+    field 254, 'uint16', 'message_index'
+
     message 103, 'monitoring_info'
     field 0, 'uint32', 'local_time', :type => 'date_time'
     field 1, 'enum', 'activity_type', :array => true, :dict => 'activity_type'

data/lib/fit4ruby/Monitoring_B.rb

@@ -45,6 +45,37 @@ module Fit4Ruby
     # Perform some basic logical checks on the object and all references sub
     # objects. Any errors will be reported via the Log object.
     def check
+      last_timestamp = ts_16_offset = nil
+
+      # The timestamp_16 is a 2 byte time stamp value that is used instead of
+      # the 4 byte timestamp field for monitoring records that have
+      # current_activity_type_intensity values with an activity type of 6. The
+      # value seems to be in seconds, but the 0 value reference does not seem
+      # to be included in the file. However, it can be approximated using the
+      # surrounding timestamp values.
+      @monitorings.each do |record|
+        if ts_16_offset
+          # We have already found the offset. Adjust all timestamps according
+          # to 'offset + timestamp_16'
+          if record.timestamp_16
+            record.timestamp = ts_16_offset + record.timestamp_16
+          end
+        else
+          # We are still looking for the offset.
+          if record.timestamp_16 && last_timestamp
+            # We have a previous timestamp and found the first record with a
+            # timestamp_16 value set. We assume that the timestamp of this
+            # record is one minute after the previously found timestamp.
+            # That's just a guess. Who knows what the Garmin engineers were
+            # thinking here?
+            ts_16_offset = last_timestamp + 60 - record.timestamp_16
+            record.timestamp = ts_16_offset + record.timestamp_16
+          else
+            # Just save the timestamp of the current record.
+            last_timestamp = record.timestamp
+          end
+        end
+      end
     end
 
     # Create a new FitDataRecord.

data/lib/fit4ruby/Session.rb

@@ -13,6 +13,7 @@
 require 'fit4ruby/Converters'
 require 'fit4ruby/FitDataRecord'
 require 'fit4ruby/RecordAggregator'
+require 'fit4ruby/GeoMath'
 
 module Fit4Ruby
 

data/lib/fit4ruby/version.rb

@@ -1,4 +1,4 @@
 module Fit4Ruby
   # The version number of the library.
-  VERSION = '0.0.6'
+  VERSION = '0.0.7'
 end

data/spec/FitFile_spec.rb

@@ -26,6 +26,7 @@ describe Fit4Ruby do
     a.new_device_info({ :device_index => 1, :manufacturer => 'development',
                         :battery_status => 'ok' })
     ts = Time.now
+    laps = 0
     0.upto(a.total_timer_time / 60) do |mins|
       ts += 60
       a.new_record({
@@ -46,7 +47,8 @@ describe Fit4Ruby do
 
       if mins > 0 && mins % 5 == 0
         a.new_lap({ :timestamp => ts, :sport => 'running',
-                    :total_cycles => 195 })
+                    :message_index => laps, :total_cycles => 195 })
+        laps += 1
       end
     end
     a.new_session({ :timestamp => ts, :sport => 'running' })

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fit4ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Chris Schlaeger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-11 00:00:00.000000000 Z
+date: 2015-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bindata