fit4ruby 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fa9593056b40b9f74f20741669e00d1529b2f565
-  data.tar.gz: 9f91309b08ec8e29dfda1e6ac54b4b1fd944ff0a
+  metadata.gz: 56efcdbb75bdc51a4076b705b5ec9e4a421b384f
+  data.tar.gz: d3e18fcccdd8ce2dc99b9c31f162fdad6e093491
 SHA512:
-  metadata.gz: 7dec612eb68811672c4274237de0c75929035207d97c4ec0402f0209d86c907489dd26f64c46aa4241e7b2d6badcf92f92534e69cf2541d84acddce45a86e448
-  data.tar.gz: cefae5b392d100eec3369b0f8ffd83836b14c2654853e43f0127577707a2a9b685da3ec84d6fab5b7694242947ea1db55ed99ed36d14d586434e06dc43678ddc
+  metadata.gz: 976290330339eb25fbd042b86954d4d8b83b45bcf0459a6fcfa73eca7ed1ec8fda5be43fa223cd7f12210098efeefa51ec25fb2e6ebfc6fc0cdb3dcddeff1bb6
+  data.tar.gz: 2e796850fe1332464e28694ed09f71fb1cfdb903764a1a5b8b0e05c6dad6d06b854965d3248832102625bdade88c3faff5f84837ef2e2e6674e8b0ea3b660f90

data/lib/fit4ruby/Activity.rb

@@ -87,20 +87,43 @@ module Fit4Ruby
       # Records must have consecutively growing timestamps and distances.
       ts = Time.parse('1989-12-31')
       distance = nil
-      @records.each do |r|
+      invalid_records = []
+      @records.each_with_index do |r, idx|
         Log.fatal "Record has no timestamp" unless r.timestamp
         if r.timestamp < ts
           Log.fatal "Record has earlier timestamp than previous record"
         end
         if r.distance
           if distance && r.distance < distance
-            Log.fatal "Record #{r.timestamp} has smaller distance " +
-                      "(#{r.distance}) than an earlier record (#{distance})"
+            # Normally this should be a fatal error as the FIT file is clearly
+            # broken. Unfortunately, the Skiing/Boarding app in the Fenix3
+            # produces such broken FIT files. So we just warn about this
+            # problem and discard the earlier records.
+            Log.error "Record #{r.timestamp} has smaller distance " +
+                      "(#{r.distance}) than an earlier record (#{distance})."
+            # Index of the list record to be discarded.
+            (idx - 1).downto(0) do |i|
+              if (ri = @records[i]).distance > r.distance
+                # This is just an approximation. It looks like the app adds
+                # records to the FIT file for runs that it meant to discard.
+                # Maybe the two successive time start events are a better
+                # criteria. But this workaround works for now.
+                invalid_records << ri
+              else
+                # All broken records have been found.
+                break
+              end
+            end
           end
           distance = r.distance
         end
         ts = r.timestamp
       end
+      unless invalid_records.empty?
+        # Delete all the broken records from the @records Array.
+        Log.warn "Discarding #{invalid_records.length} earlier records"
+        @records.delete_if { |r| invalid_records.include?(r) }
+      end
 
       # Laps must have a consecutively growing message index.
       @laps.each.with_index do |lap, index|
@@ -294,7 +317,7 @@ module Fit4Ruby
     #        certain fields of the FitDataRecord.
     # @return [UserProfile]
     def new_user_profile(field_values = {})
-      new_fit_data_record('user_profile', field_values)
+      new_fit_data_record('old_user_profile', field_values)
     end
 
     # Add a new Event to the Activity.
@@ -376,7 +399,7 @@ module Fit4Ruby
         @device_infos << (record = DeviceInfo.new(field_values))
       when 'data_sources'
         @data_sources << (record = DataSources.new(field_values))
-      when 'user_profile'
+      when 'old_user_profile'
         @user_profiles << (record = UserProfile.new(field_values))
       when 'event'
         @events << (record = Event.new(field_values))

data/lib/fit4ruby/FitDataRecord.rb

@@ -86,10 +86,7 @@ module Fit4Ruby
         v2 = field.fit_to_native(field.native_to_fit(
           fdr.instance_variable_get(ivar_name)))
 
-        unless v1 == v2
-          Log.error "#{name}: #{v1} != #{v2}"
-          return false
-        end
+        return false unless v1 == v2
       end
 
       true

data/lib/fit4ruby/FitFile.rb

@@ -36,31 +36,41 @@ module Fit4Ruby
       rescue StandardError => e
         Log.fatal "Cannot open FIT file '#{file_name}': #{e.message}"
       end
-      header = FitHeader.read(io)
-      header.check
-
-      check_crc(io, io.size - 2)
-
-      entity = FitFileEntity.new
-      # This Array holds the raw data of the records that may be needed to
-      # dump a human readable form of the FIT file.
-      records = []
-      # This hash will hold a counter for each record type. The counter is
-      # incremented each time the corresponding record type is found.
-      record_counters = Hash.new { 0 }
-      while io.pos < header.end_pos
-        record = FitRecord.new(definitions)
-        record.read(io, entity, filter, record_counters)
-        records << record if filter
+
+      entities = []
+      while !io.eof?
+        offset = io.pos
+
+        header = FitHeader.read(io)
+        header.check
+
+        check_crc(io, io.pos, offset + header.end_pos)
+
+        entity = FitFileEntity.new
+        # This Array holds the raw data of the records that may be needed to
+        # dump a human readable form of the FIT file.
+        records = []
+        # This hash will hold a counter for each record type. The counter is
+        # incremented each time the corresponding record type is found.
+        record_counters = Hash.new { 0 }
+        while io.pos < offset + header.end_pos
+          record = FitRecord.new(definitions)
+          record.read(io, entity, filter, record_counters)
+          records << record if filter
+        end
+        # Skip the 2 CRC bytes
+        io.seek(2, :CUR)
+
+        header.dump if filter && filter.record_numbers.nil?
+        dump_records(records) if filter
+
+        entity.check
+        entities << entity
       end
 
       io.close
 
-      header.dump if filter && filter.record_numbers.nil?
-      dump_records(records) if filter
-
-      entity.check
-      entity.top_level_record
+      entities[0].top_level_record
     end
 
     def write(file_name, top_level_record)
@@ -93,14 +103,11 @@ module Fit4Ruby
 
     private
 
-    def check_crc(io, end_pos)
-      # Save the current file IO position
-      start_pos = io.pos
-
+    def check_crc(io, start_pos, end_pos)
       crc = compute_crc(io, start_pos, end_pos)
 
       # Read the 2 CRC bytes from the end of the file
-      io.seek(-2, IO::SEEK_END)
+      io.seek(end_pos)
       crc_ref = io.readbyte.to_i | (io.readbyte.to_i << 8)
       io.seek(start_pos)
 

data/lib/fit4ruby/FitHeader.rb

@@ -28,10 +28,10 @@ module Fit4Ruby
 
     def check
       unless header_size == 14
-        Log.fatal { "Unsupported header size #{@header.header_size}" }
+        Log.fatal "Unsupported header size #{header_size}"
       end
       unless data_type == '.FIT'
-        Log.fatal { "Unknown file type #{@header.data_type}" }
+        Log.fatal "Unknown file type #{data_type}"
       end
     end
 

data/lib/fit4ruby/GlobalFitMessages.rb

@@ -28,6 +28,103 @@ module Fit4Ruby
     field 6, 'uint16', 'undocumented_field_6'
     field 7, 'uint32', 'undocumented_field_7'
 
+    message 2, 'device_settings'
+    field 0, 'uint8', 'active_time_zone'
+    field 1, 'uint32', 'utc_offset'
+    field 2, 'uint32', 'time_offset', :array => true
+    field 3, 'enum', 'undocumented_field_3'
+    field 4, 'enum', 'time_mode', :array => true
+    field 5, 'sint8', 'time_zone_offset', :array => true
+    field 8, 'uint16', 'undocumented_field_8'
+    field 9, 'enum', 'undocumented_field_9'
+    field 10, 'enum', 'undocumented_field_10'
+    field 11, 'enum', 'undocumented_field_11'
+    field 12, 'enum', 'backlight_mode'
+    field 13, 'uint8', 'undocumented_field_13'
+    field 14, 'uint8', 'undocumented_field_14'
+    field 15, 'uint8', 'undocumented_field_15'
+    field 22, 'enum', 'undocumented_field_22'
+    field 26, 'enum', 'undocumented_field_26'
+    field 28, 'enum', 'undocumented_field_28'
+    field 34, 'enum', 'undocumented_field_34'
+    field 35, 'enum', 'undocumented_field_35'
+    field 36, 'enum', 'activity_tracker_enabled'
+    field 38, 'enum', 'undocumented_field_38'
+    field 41, 'enum', 'undocumented_field_41'
+    field 42, 'enum', 'undocumented_field_42'
+    field 43, 'enum', 'undocumented_field_43'
+    field 44, 'enum', 'undocumented_field_44'
+    field 45, 'enum', 'undocumented_field_45'
+    field 46, 'enum', 'move_alert_enabled'
+    field 48, 'enum', 'undocumented_field_48'
+    field 49, 'uint16', 'undocumented_field_49'
+    field 51, 'enum', 'undocumented_field_51'
+    field 52, 'enum', 'undocumented_field_52'
+    field 53, 'enum', 'undocumented_field_53'
+    field 56, 'enum', 'mounting_side'
+    field 58, 'uint16', 'autosync_min_steps'
+    field 59, 'uint16', 'autosync_min_time'
+    field 62, 'enum', 'undocumented_field_62'
+    field 63, 'enum', 'undocumented_field_63'
+    field 64, 'enum', 'undocumented_field_64'
+    field 65, 'enum', 'undocumented_field_65'
+    field 66, 'enum', 'undocumented_field_66'
+    field 67, 'enum', 'undocumented_field_67'
+    field 68, 'enum', 'undocumented_field_68'
+    field 69, 'enum', 'undocumented_field_69'
+    field 80, 'enum', 'lactate_threshold_autodetect_enabled'
+    field 81, 'enum', 'undocumented_field_81'
+    field 82, 'enum', 'undocumented_field_82'
+    field 83, 'enum', 'undocumented_field_83'
+    field 84, 'enum', 'undocumented_field_84'
+    field 85, 'enum', 'undocumented_field_85'
+    field 87, 'enum', 'undocumented_field_87'
+    field 94, 'uint8', 'number_of_screens'
+
+    message 3, 'user_profile'
+    field 1, 'enum', 'gender', :dict => 'gender'
+    field 3, 'uint8', 'height'
+    field 4, 'uint16', 'weight'
+    field 5, 'enum', 'language'
+    field 6, 'enum', 'elev_setting'
+    field 7, 'enum', 'weight_setting'
+    field 8, 'uint8', 'resting_heart_rate'
+    field 12, 'enum', 'hr_setting'
+    field 13, 'enum', 'speed_setting'
+    field 14, 'enum', 'dist_setting'
+    field 17, 'enum', 'activity_class'
+    field 18, 'enum', 'position_setting'
+    field 21, 'enum', 'temperature_setting'
+    field 24, 'uint8', 'undocumented_field_24'
+    field 28, 'uint32', 'wake_time'
+    field 29, 'uint32', 'sleep_time'
+    field 30, 'enum', 'height_setting'
+    field 31, 'uint16', 'user_running_step_length'
+    field 32, 'uint16', 'user_walking_step_length'
+    field 33, 'uint16', 'undocumented_field_33'
+    field 34, 'uint16', 'undocumented_field_34'
+    field 35, 'uint32', 'undocumented_field_35'
+    field 36, 'uint8', 'undocumented_field_36'
+    field 37, 'uint16', 'undocumented_field_37'
+    field 38, 'uint16', 'undocumented_field_38'
+    field 39, 'float32', 'undocumented_field_39'
+    field 40, 'float32', 'undocumented_field_40'
+    field 41, 'uint32', 'undocumented_field_41'
+    field 42, 'uint32', 'undocumented_field_42'
+
+    message 7, 'zones_target'
+    field 1, 'uint8', 'max_heart_rate'
+    field 2, 'uint8', 'threshold_heart_rate'
+    field 3, 'uint16', 'functional_threshold_power'
+    field 5, 'enum', 'hr_zone_calc'
+    field 7, 'enum', 'pwr_zone_calc'
+    field 8, 'uint16', 'undocumented_field_8'
+    field 9, 'enum', 'undocumented_field_9'
+    field 10, 'enum', 'undocumented_field_10'
+    field 11, 'enum', 'undocumented_field_11'
+    field 12, 'enum', 'undocumented_field_12'
+    field 254, 'uint16', 'message_index'
+
     message 12, 'sport'
     field 0, 'enum', 'sport', :dict => 'sport'
     field 1, 'enum', 'sub_sport', :dict => 'sub_sport'
@@ -38,6 +135,45 @@ module Fit4Ruby
     field 10, 'uint8', 'undocumented_field_10', :array => true
     field 11, 'enum', 'undocumented_field_11'
 
+    # Not part of the official ANT SDK doc.
+    message 13, 'undocumented_13'
+    field 1, 'enum', 'undocumented_field_1'
+    field 2, 'uint16', 'undocumented_field_2'
+    field 3, 'enum', 'undocumented_field_3'
+    field 4, 'uint32', 'undocumented_field_4'
+    field 5, 'sint32', 'undocumented_field_5'
+    field 6, 'sint32', 'undocumented_field_6'
+    field 7, 'enum', 'undocumented_field_7'
+    field 8, 'uint16', 'undocumented_field_8'
+    field 11, 'uint8', 'undocumented_field_11'
+    field 12, 'enum', 'undocumented_field_12'
+    field 13, 'enum', 'undocumented_field_13'
+    field 14, 'enum', 'undocumented_field_14'
+    field 15, 'enum', 'undocumented_field_15'
+    field 16, 'enum', 'undocumented_field_16'
+    field 21, 'enum', 'undocumented_field_21'
+    field 22, 'uint16', 'undocumented_field_22'
+    field 23, 'enum', 'undocumented_field_23'
+    field 24, 'enum', 'undocumented_field_24'
+    field 27, 'enum', 'undocumented_field_27'
+    field 28, 'enum', 'undocumented_field_28'
+    field 29, 'enum', 'undocumented_field_29'
+    field 30, 'enum', 'undocumented_field_30'
+    field 31, 'uint32', 'undocumented_field_31'
+    field 32, 'uint16', 'undocumented_field_32'
+    field 33, 'uint32', 'undocumented_field_33'
+    field 34, 'enum', 'undocumented_field_34'
+    field 35, 'enum', 'undocumented_field_35'
+    field 36, 'enum', 'undocumented_field_36'
+    field 37, 'enum', 'undocumented_field_37'
+    field 38, 'uint8', 'undocumented_field_38'
+    field 39, 'uint8', 'undocumented_field_39'
+    field 40, 'enum', 'undocumented_field_40'
+    field 41, 'sint32', 'undocumented_field_41'
+    field 42, 'uint8', 'undocumented_field_42'
+    field 46, 'enum', 'undocumented_field_46'
+    field 254, 'uint16', 'message_index'
+
     message 18, 'session'
     field 0, 'enum', 'event', :dict => 'event'
     field 1, 'enum', 'event_type', :dict => 'event_type'
@@ -336,6 +472,7 @@ module Fit4Ruby
     field 21, 'uint16z', 'ant_device_number'
     field 22, 'enum', 'ant_network', :dict => 'ant_network'
     field 23, 'uint8', 'undocumented_field_23'
+    field 24, 'uint32z', 'undocumented_field_24'
     field 25, 'enum', 'source_type', :dict => 'source_type'
     field 253, 'uint32', 'timestamp', :type => 'date_time'
 
@@ -435,7 +572,7 @@ module Fit4Ruby
     field 0, 'uint16', 'time', :array => true, :scale => 1000, :unit => 's'
 
     # Not part of the official ANT SDK doc
-    message 79, 'user_profile'
+    message 79, 'old_user_profile'
     field 0, 'uint16', 'metmax', :scale => 1000, :unit => 'MET' # VO2max / 3.5
     field 1, 'uint8', 'age', :unit => 'years'
     field 2, 'uint8', 'height', :scale => 100, :unit => 'm'
@@ -479,6 +616,8 @@ module Fit4Ruby
     field 5, 'uint16', 'resting_metabolic_rate', :unit => 'kcal/day'
     # Just a guess, not officially documented
     field 7, 'uint32', 'goal_cycles', :array => true
+    # Showed up in Fenix3HR firmware 3.84. Haven't seen a value yet.
+    field 8, 'enum', 'undocumented_field_8', :array => true
     field 253, 'uint32', 'timestamp', :type => 'date_time'
 
     # Not part of the official ANT SDK doc
@@ -539,11 +678,72 @@ module Fit4Ruby
     field 5, 'sint32', 'undocumented_field_5'
     field 253, 'uint32', 'timestamp', :type => 'date_time'
 
+    # Not part of the official ANT SDK doc.
+    message 147, 'undocumented_147'
+    field 0, 'uint32z', 'undocumented_field_0'
+    field 1, 'uint8', 'undocumented_field_1'
+    field 2, 'string', 'undocumented_field_2'
+    field 3, 'enum', 'undocumented_field_3'
+    field 4, 'enum', 'undocumented_field_4'
+    field 5, 'enum', 'undocumented_field_5'
+    field 6, 'enum', 'undocumented_field_6'
+    field 7, 'enum', 'undocumented_field_7'
+    field 8, 'uint8', 'undocumented_field_8'
+    field 9, 'uint8', 'undocumented_field_9'
+    field 10, 'uint16', 'undocumented_field_10'
+    field 11, 'uint16', 'undocumented_field_11'
+    field 12, 'uint8', 'undocumented_field_12'
+    field 13, 'uint32', 'undocumented_field_13'
+    field 14, 'uint8', 'undocumented_field_14'
+    field 15, 'uint8', 'undocumented_field_15'
+    field 16, 'uint8', 'undocumented_field_16'
+    field 17, 'uint8z', 'undocumented_field_17'
+    field 18, 'uint8z', 'undocumented_field_18'
+    field 19, 'uint8z', 'undocumented_field_19'
+    field 20, 'uint8z', 'undocumented_field_20'
+    field 21, 'uint16', 'undocumented_field_21'
+    field 24, 'enum', 'undocumented_field_24'
+    field 31, 'uint8', 'undocumented_field_31'
+    field 32, 'uint16', 'undocumented_field_32'
+    field 33, 'uint16', 'undocumented_field_33'
+    field 34, 'uint16', 'undocumented_field_34'
+    field 35, 'uint16', 'undocumented_field_35'
+    field 36, 'enum', 'undocumented_field_36'
+    field 37, 'enum', 'undocumented_field_37'
+    field 38, 'enum', 'undocumented_field_38'
+    field 39, 'enum', 'undocumented_field_39'
+    field 40, 'uint16z', 'undocumented_field_40'
+    field 41, 'uint8', 'undocumented_field_41'
+    field 42, 'enum', 'undocumented_field_42'
+    field 43, 'enum', 'undocumented_field_43'
+    field 44, 'uint8z', 'undocumented_field_44'
+    field 45, 'enum', 'undocumented_field_45'
+    field 46, 'enum', 'undocumented_field_46'
+    field 47, 'enum', 'undocumented_field_47'
+    field 254, 'uint16', 'message_index'
+
+    # Not part of the official ANT SDK doc.
     message 211, 'undocumented_211'
     field 0, 'uint8', 'undocumented_field_0'
     field 1, 'uint8', 'undocumented_field_1'
     field 253, 'uint32', 'timestamp', :type => 'date_time'
 
+    # Not part of the official ANT SDK doc.
+    message 216, 'undocumented_216'
+    field 0, 'uint16', 'undocumented_field_0'
+    field 1, 'uint16', 'undocumented_field_1'
+    field 2, 'uint32', 'undocumented_field_2'
+    field 5, 'uint32', 'undocumented_field_5'
+    field 6, 'uint8', 'undocumented_field_6'
+    field 9, 'uint16', 'undocumented_field_9'
+    field 10, 'enum', 'undocumented_field_10'
+    field 11, 'uint8', 'undocumented_field_11'
+    field 12, 'uint8', 'undocumented_field_12'
+    field 13, 'uint8', 'undocumented_field_13'
+    field 14, 'enum', 'undocumented_field_14'
+    field 15, 'uint16', 'undocumented_field_15'
+    field 253, 'uint32', 'timestamp', :type => 'date_time'
+
   end
 
 end

data/lib/fit4ruby/RecordAggregator.rb

@@ -162,9 +162,10 @@ module Fit4Ruby
         end
       end
 
-      @avg_stance_time = total_stance_time / stance_time_count
-      @avg_stance_time_percent = total_stance_time_percent /
-        stance_time_percent_count
+      @avg_stance_time = stance_time_count > 0 ?
+        total_stance_time / stance_time_count : 0
+      @avg_stance_time_percent = stance_time_percent_count > 0 ?
+        total_stance_time_percent / stance_time_percent_count : 0
     end
 
   end

data/lib/fit4ruby/UserProfile.rb

@@ -14,14 +14,14 @@ require 'fit4ruby/FitDataRecord'
 
 module Fit4Ruby
 
-  # This class corresponds to the user_profile FIT message.
+  # This class corresponds to the old_user_profile FIT message.
   class UserProfile < FitDataRecord
 
     # Create a new UserProfile object.
     # @param field_values [Hash] Hash that provides initial values for certain
     #        fields.
     def initialize(field_values = {})
-      super('user_profile')
+      super('old_user_profile')
       set_field_values(field_values)
     end
 

data/lib/fit4ruby/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fit4ruby
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Chris Schlaeger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-04 00:00:00.000000000 Z
+date: 2017-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bindata