fit4ruby 3.3.0 → 3.8.0

data/lib/fit4ruby/GlobalFitMessage.rb

@@ -3,7 +3,7 @@
 #
 # = GlobalFitMessage.rb -- Fit4Ruby - FIT file processing library for Ruby
 #
-# Copyright (c) 2014, 2015 by Chris Schlaeger <cs@taskjuggler.org>
+# Copyright (c) 2014, 2015, 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
@@ -21,7 +21,8 @@ module Fit4Ruby
   # the data fields of the message.
   class GlobalFitMessage
 
-    attr_reader :name, :number, :fields_by_name, :fields_by_number
+    attr_reader :name, :number, :fields_by_name, :fields_by_number,
+      :field_values_by_name
 
     # The Field objects describe the name, type and optional attributes of a
     # FitMessage definition field. It also provides methods to convert field
@@ -38,8 +39,21 @@ module Fit4Ruby
         @opts = opts
       end
 
+      def is_undefined?(value)
+        value == FitDefinitionFieldBase.undefined_value(@type)
+      end
+
+      def is_string?
+        @type == 'string'
+      end
+
+      def is_array?
+        @opts[:array] == true
+      end
+
       def to_machine(value)
-        return nil if value.nil?
+        return nil if value.nil? ||
+          value == FitDefinitionFieldBase.undefined_value(@type)
 
         if @opts.include?(:dict) &&
            (dict = GlobalFitDictionaries[@opts[:dict]])
@@ -51,6 +65,13 @@ module Fit4Ruby
           value *= 180.0 / 2147483648
         when 'date_time'
           value = fit_time_to_time(value)
+        when 'float'
+          if value >= 4294967295.0
+            return nil
+          end
+        end
+        if value.is_a?(Float) && value >= 4294967295.0
+          return nil
         end
         value /= @opts[:scale].to_f if @opts[:scale]
         value -= @opts[:offset] if @opts[:offset]
@@ -133,7 +154,7 @@ module Fit4Ruby
         value
       end
 
-      def to_s(value)
+      def to_s(value = nil)
         return "[no value]" if value.nil?
 
         human_readable = to_human(value)
@@ -167,7 +188,7 @@ module Fit4Ruby
 
       def field(ref_value, type, name, opts = {})
         field = Field.new(type, name, opts)
-        if ref_value.respond_to?('each')
+        if ref_value.respond_to?(:each)
           ref_value.each do |rv|
             @fields[rv] = field
           end
@@ -180,13 +201,13 @@ module Fit4Ruby
       # Select the alternative field based on the actual field values of the
       # FitMessageRecord.
       def select(field_values_by_name)
-        unless (value = field_values_by_name[@ref_field])
+        unless (value_of_referenced_field = field_values_by_name[@ref_field])
           Log.fatal "The selection field #{@ref_field} for the alternative " +
                     "field is undefined in global message #{@message.name}: " +
                     field_values_by_name.inspect
         end
         @fields.each do |ref_value, field|
-          return field if ref_value == value
+          return field if ref_value == value_of_referenced_field
         end
         return @fields[:default] if @fields[:default]
 
@@ -199,7 +220,7 @@ module Fit4Ruby
     # Create a new GlobalFitMessage definition.
     # @param name [String] name of the FIT message
     # @param number [Fixnum] global message number
-    def initialize(name, number)
+    def initialize(name, number, field_values_by_name = {})
       @name = name
       @number = number
       # Field names must be unique. A name always matches a single Field.
@@ -207,13 +228,57 @@ module Fit4Ruby
       # Field numbers are not unique. A group of alternative fields shares the
       # same number and is stored as an AltField. Otherwise as Field.
       @fields_by_number = {}
+      # To generate the proper definition message we need to know the length
+      # of String and Array fields. This is only needed when writing FIT
+      # files.
+      @field_values_by_name = field_values_by_name
     end
 
     # Two GlobalFitMessage objects are considered equal if they have the same
-    # number, name and list of named fields.
+    # number, name and list of named fields. In case they have String or Array
+    # values, they must have identical size.
     def ==(m)
-      @number == m.number && @name == m.name &&
-        @fields_by_name.keys.sort == m.fields_by_name.keys.sort
+      unless @number == m.number && @name == m.name &&
+          @fields_by_name.keys.sort == m.fields_by_name.keys.sort
+        return false
+      end
+
+      unless @field_values_by_name.size == m.field_values_by_name.size
+        return false
+      end
+
+      unless @field_values_by_name.empty?
+        @field_values_by_name.keys.each do |name|
+          a = @field_values_by_name[name]
+          b = m.field_values_by_name[name]
+          if a.class != b.class
+            return false
+          end
+          if a.is_a?(String)
+            if a.bytes.length != b.bytes.length
+              return false
+            end
+          elsif a.is_a?(Array)
+            if a.length != b.length
+              return false
+            end
+          end
+        end
+      end
+
+      true
+    end
+
+    def each_field(field_values)
+      @fields_by_number.each do |number, field|
+        if field.is_a?(AltField)
+          # For alternative fields, we need to look at the value of the
+          # selector field and pick the corresponding Field.
+          field = field.select(field_values)
+        end
+
+        yield(number, field)
+      end
     end
 
     # Define a new Field for this message definition.
@@ -223,6 +288,11 @@ module Fit4Ruby
       register_field_by_number(field, number)
     end
 
+    # Check if a field with the given name already exists?
+    def has_field?(name)
+      return @fields_by_name.include?(name)
+    end
+
     # Define a new set of Field alternatives for this message definition.
     def alt_field(number, ref_field, &block)
       unless @fields_by_name.include?(ref_field)
@@ -250,7 +320,7 @@ module Fit4Ruby
     end
 
     def construct(field_values_by_name)
-      gfm = GlobalFitMessage.new(@name, @number)
+      gfm = GlobalFitMessage.new(@name, @number, field_values_by_name)
 
       @fields_by_number.each do |number, field|
         if field.is_a?(AltField)
@@ -264,7 +334,7 @@ module Fit4Ruby
       gfm
     end
 
-    def write(io, local_message_type, global_fit_message = self)
+    def write(io, local_message_type)
       header = FitRecordHeader.new
       header.normal = 0
       header.message_type = 1
@@ -273,7 +343,7 @@ module Fit4Ruby
 
       definition = FitDefinition.new
       definition.global_message_number = @number
-      definition.setup(global_fit_message)
+      definition.setup(self, @field_values_by_name)
       definition.write(io)
     end
 

data/lib/fit4ruby/GlobalFitMessages.rb

@@ -3,7 +3,7 @@
 #
 # = GlobalFitMessages.rb -- Fit4Ruby - FIT file processing library for Ruby
 #
-# Copyright (c) 2014, 2015 by Chris Schlaeger <cs@taskjuggler.org>
+# Copyright (c) 2014, 2015, 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
@@ -129,8 +129,16 @@ module Fit4Ruby
     field 142, 'uint8', 'undocumented_field_142'
     field 143, 'uint8', 'undocumented_field_143'
     field 144, 'enum', 'true_up_enabled'
+    field 145, 'enum', 'undocumented_field_145'
     field 148, 'enum', 'undocumented_field_148'
     field 149, 'enum', 'undocumented_field_149'
+    field 151, 'enum', 'undocumented_field_151'
+    field 160, 'enum', 'undocumented_field_160'
+    field 163, 'enum', 'undocumented_field_163'
+    field 164, 'uint8', 'undocumented_field_164'
+    field 167, 'string', 'undocumented_field_167'
+    field 168, 'enum', 'undocumented_field_168'
+    field 170, 'uint8', 'undocumented_field_170'
 
     message 3, 'user_profile'
     field 0, 'string', 'friendly_name'
@@ -161,14 +169,20 @@ module Fit4Ruby
     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 37, 'uint16', 'functional_threshold_speed', :scale => 36, :unit => 'm/s'
     field 38, 'uint16', 'undocumented_field_38'
     field 39, 'float32', 'undocumented_field_39'
     field 40, 'float32', 'undocumented_field_40'
     field 41, 'uint32', 'time_last_lthr_update', :type => 'date_time'
     field 42, 'uint32', 'undocumented_field_42'
     field 43, 'enum', 'undocumented_field_43'
+    field 44, 'uint8', 'undocumented_field_44'
+    field 45, 'uint8z', 'undocumented_field_45'
     field 47, 'enum', 'undocumented_field_47'
+    field 52, 'enum', 'undocumented_field_52'
+    field 53, 'uint8', 'undocumented_field_53'
+    field 54, 'uint8', 'undocumented_field_54'
+    field 57, 'enum', 'undocumented_field_57'
     field 253, 'uint32', 'timestamp', :type => 'date_time'
 
     message 5, 'sdm_profile'
@@ -225,6 +239,8 @@ module Fit4Ruby
     field 11, 'enum', 'undocumented_field_11'
     field 12, 'enum', 'undocumented_field_12'
     field 13, 'enum', 'undocumented_field_13'
+    field 15, 'uint16', 'undocumented_field_15'
+    field 16, 'uint32', 'undocumented_field_16'
     field 254, 'uint16', 'message_index'
 
     message 12, 'sport'
@@ -245,6 +261,7 @@ module Fit4Ruby
     field 17, 'enum', 'undocumented_field_17'
     field 18, 'enum', 'undocumented_field_18'
     field 19, 'enum', 'undocumented_field_19', :array => true
+    field 21, 'enum', 'undocumented_field_21'
 
     # Not part of the official ANT SDK doc.
     message 13, 'undocumented_13'
@@ -309,12 +326,20 @@ module Fit4Ruby
     field 65, 'enum', 'undocumented_field_65'
     field 66, 'enum', 'undocumented_field_66'
     field 67, 'enum', 'undocumented_field_67'
+    field 68, 'sint32','undocumented_field_68'
     field 69, 'uint16', 'undocumented_field_69'
     field 70, 'enum', 'undocumented_field_70'
+    field 71, 'enum', 'undocumented_field_71'
+    field 72, 'enum', 'undocumented_field_72'
     field 73, 'sint32', 'undocumented_field_73'
     field 74, 'sint32', 'undocumented_field_74'
     field 75, 'enum', 'undocumented_field_75'
     field 76, 'enum', 'undocumented_field_76'
+    field 78, 'enum', 'undocumented_field_78'
+    field 79, 'enum', 'undocumented_field_79'
+    field 81, 'enum', 'undocumented_field_81'
+    field 82, 'enum', 'undocumented_field_82'
+    field 83, 'enum', 'undocumented_field_83'
     field 254, 'uint16', 'message_index'
 
     message 18, 'session'
@@ -372,7 +397,7 @@ module Fit4Ruby
     field 44, 'uint16', 'pool_length', :scale => 100, :unit => 'm'
     field 45, 'uint16', 'undefined_value_45'
     field 46, 'enum', 'pool_length_unit', :dict => 'display_measure'
-    field 47, 'uint16', 'num_active_length', :unit => 'lengths'
+    field 47, 'uint16', 'num_active_lengths', :unit => 'lengths'
     field 48, 'uint32', 'total_work', :unit => 'J'
     field 57, 'sint8', 'avg_temperature', :unit => 'C'
     field 58, 'sint8', 'max_temperature', :unit => 'C'
@@ -445,6 +470,10 @@ module Fit4Ruby
     field 185, 'uint8', 'undocumented_field_185'
     field 187, 'float32', 'undocumented_field_187'
     field 188, 'enum', 'undocumented_field_188'
+    field 189, 'uint16', 'undocumented_field_189'
+    field 190, 'uint16', 'undocumented_field_190'
+    field 194, 'uint8', 'undocumented_field_194'
+    field 195, 'uint8', 'undocumented_field_195'
     field 253, 'uint32', 'timestamp', :type => 'date_time'
     field 254, 'uint16', 'message_index'
 
@@ -496,7 +525,7 @@ module Fit4Ruby
     field 37, 'uint16', 'avg_stroke_distance', :scale => 100, :unit => 'm'
     field 38, 'enum', 'swim_stroke', :dict => 'swim_stroke'
     field 39, 'enum', 'sub_sport', :dict => 'sub_sport'
-    field 40, 'uint16', 'num_active_length', :unit => 'lengths'
+    field 40, 'uint16', 'num_active_lengths', :unit => 'lengths'
     field 41, 'uint32', 'total_work', :unit => 'J'
     field 50, 'sint8', 'avg_temperature', :unit => 'C'
     field 51, 'sint8', 'max_temperature', :unit => 'C'
@@ -572,6 +601,7 @@ module Fit4Ruby
     field 13, 'sint8', 'temperature', :unit => 'C'
     field 14, 'uint32', 'undefined_field_14'
     field 15, 'uint32', 'undefined_field_15'
+    field 18, 'uint8', 'undefined_field_18'
     field 29, 'uint32', 'accumulated_power', :unit => 'watts'
     field 30, 'uint8', 'left_right_balance', :dict => 'left_right_balance'
     field 39, 'uint16', 'vertical_oscillation', :scale => 10, :unit => 'mm'
@@ -598,6 +628,12 @@ module Fit4Ruby
     field 71, 'uint8', 'right_power_phase', :scale => 0.7111111, :unit => 'degrees', :array => true
     field 72, 'uint8', 'right_power_phase_peak', :scale => 0.7111111, :unit => 'degrees', :array => true
     field 73, 'uint32', 'enhanced_speed', :scale => 1000, :unit => 'm/s'
+    field 74, 'uint32', 'undefined_value_74'
+    field 75, 'uint32', 'undefined_value_75'
+    field 76, 'uint32', 'undefined_value_76'
+    field 77, 'uint32', 'undefined_value_77'
+    field 79, 'uint32', 'undefined_value_79'
+    field 80, 'uint32', 'undefined_value_80'
     field 78, 'uint32', 'enhanced_elevation', :scale => 5, :offset => 500, :unit => 'm'
     field 83, 'uint16', 'vertical_ratio', :scale => 100, :unit => '%' # guessed
     field 84, 'uint16', 'gct_balance', :scale => 100, :unit => '%' # guessed
@@ -605,6 +641,13 @@ module Fit4Ruby
     field 87, 'uint16', 'undefined_value_87' # first seen on F3 FW6.80
     field 88, 'uint16', 'undefined_value_88' # first seen on F3HR FW3.60
     field 90, 'sint8', 'performance_condition' # guessed
+    field 100, 'sint32', 'undocumented_field_100'
+    field 101, 'sint32', 'undocumented_field_101'
+    field 107, 'enum', 'undocumented_field_107'
+    field 116, 'uint16', 'undocumented_field_116'
+    field 108, 'uint16', 'respiration_rate', :scale => 100, :unit => 'brpm' # guessed
+    field 135, 'uint8', 'undocumented_field_135'
+    field 136, 'uint8', 'undocumented_field_136'
     field 253, 'uint32', 'timestamp', :type => 'date_time'
 
     message 21, 'event'
@@ -808,7 +851,7 @@ module Fit4Ruby
     field 10, 'uint8', 'avg_resting_heart_rate', :unit => 'bpm'
     field 11, 'uint16', 'running_lactate_threshold_heart_rate', :unit => 'bpm'
     field 12, 'uint16', 'functional_threshold_power', :unit => 'W'
-    field 13, 'uint16', 'undocumented_field_13'
+    field 13, 'uint16', 'functional_threshold_speed', :scale => 36, :unit => 'm/s'
     field 14, 'uint8', 'undocumented_field_14'
     field 15, 'uint8', 'undocumented_field_15'
     field 16, 'uint32', 'undocumented_field_16'
@@ -816,12 +859,14 @@ module Fit4Ruby
     field 18, 'sint32', 'undocumented_field_18'
     field 19, 'sint32', 'undocumented_field_19'
     field 20, 'uint16', 'undocumented_field_20'
+    field 21, 'sint32', 'undocumented_field_21'
+    field 22, 'sint32', 'undocumented_field_22'
     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 2, 'uint32', 'start_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'
@@ -833,6 +878,8 @@ module Fit4Ruby
     field 12, 'enum', 'length_type', :dict => 'length_type'
     field 18, 'uint16', 'player_score'
     field 19, 'uint16', 'opponent_score'
+    field 20, 'uint16', 'stroke_count', :unit => 'counts'
+    field 21, 'uint16', 'zone_count', :unit => 'counts'
     field 253, 'uint32', 'timestamp', :type => 'date_time'
     field 254, 'uint16', 'message_index'
 
@@ -901,8 +948,8 @@ module Fit4Ruby
     field 12, 'enum', 'undocumented_field_12'
     field 13, 'uint8', 'undocumented_field_13'
     field 14, 'uint16', 'running_lactate_threshold_heart_rate', :unit => 'bpm'
-    field 15, 'uint16', 'running_lactate_threshold_speed', :scale => 1000, :unit => 'm/s'
-    field 16, 'uint16', 'undocumented_field_16' # very correlated to 14 and 15
+    field 15, 'uint16', 'undocumented_field_15'
+    field 16, 'uint16', 'running_lactate_threshold_speed', :scale => 36, :unit => 'm/s'
     field 17, 'sint8', 'performance_condition'
     field 18, 'uint8', 'undocumented_field_18'
     field 19, 'uint8', 'undocumented_field_19'
@@ -928,6 +975,12 @@ module Fit4Ruby
     field 39, 'sint32', 'undocumented_field_39'
     field 40, 'sint32', 'undocumented_field_40'
     field 41, 'enum', 'undocumented_field_41'
+    field 42, 'uint8', 'undocumented_field_42'
+    field 43, 'sint16', 'undocumented_field_43'
+    field 44, 'sint16', 'undocumented_field_44'
+    field 45, 'sint16', 'undocumented_field_45'
+    field 46, 'uint8', 'undocumented_field_46'
+    field 48, 'uint32', 'undocumented_field_48'
     field 253, 'uint32', 'timestamp', :type => 'date_time'
 
     # Not part of the official ANT SDK doc. The message name is guessed and
@@ -964,7 +1017,7 @@ module Fit4Ruby
     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 21, 'uint16', 'wheel_size', :unit => 'mm'
     field 25, 'uint16', 'undocumented_field_25'
     field 26, 'uint16', 'undocumented_field_26'
     field 27, 'uint8', 'undocumented_field_27'
@@ -992,7 +1045,12 @@ module Fit4Ruby
     field 48, 'enum', 'undocumented_field_48'
     field 50, 'uint8', 'undocumented_field_50'
     field 51, 'enum', 'undocumented_field_51'
-    field 52, 'uint8', 'undocumented_field_52'
+    # The type of this field changed from 'uint8' to 'enum' in more recent
+    # devices. No idea why and what the proper selection field should be.
+    alt_field 52, 'undocumented_field_51' do
+      field :default, 'uint8', 'undocumented_field_52_0'
+      field 0, 'enum', 'undocumented_field_52_1'
+    end
     field 53, 'uint8', 'undocumented_field_53'
     field 54, 'enum', 'undocumented_field_54'
     field 55, 'uint16', 'undocumented_field_55'
@@ -1008,8 +1066,14 @@ module Fit4Ruby
     field 65, 'uint32', 'undocumented_field_65'
     field 70, 'uint32', 'undocumented_field_70'
     field 71, 'enum', 'undocumented_field_71'
+    field 73, 'uint16z', 'undocumented_field_73'
     field 254, 'uint16', 'message_index'
 
+    # Not part of the official ANT SDK doc.
+    message 160, 'undocumented_160'
+    field 3, 'uint32', 'undocumented_field_3'
+    field 4, 'uint32', 'undocumented_field_4'
+
     # Not part of the official ANT SDK doc.
     message 188, 'undocumented_188'
     field 0, 'enum', 'undocumented_field_0'
@@ -1120,6 +1184,7 @@ module Fit4Ruby
     message 269, 'undocumented_269'
     field 0, 'uint8', 'undocumented_field_0'
     field 1, 'uint8', 'undocumented_field_1'
+    field 2, 'uint8', 'undocumented_field_2'
     field 253, 'uint32', 'timestamp', :type => 'date_time'
 
     # Not part of the official ANT SDK doc.
@@ -1152,6 +1217,35 @@ module Fit4Ruby
     field 252, 'uint8', 'undocumented_field_252'
     field 253, 'uint32', 'timestamp', :type => 'date_time'
 
+    # Not part of the official ANT SDK doc.
+    message 325, 'undocumented_325'
+    field 0, 'uint8', 'undocumented_field_0'
+    field 1, 'uint8', 'undocumented_field_1'
+    field 2, 'uint8', 'undocumented_field_2'
+    field 3, 'uint8', 'undocumented_field_3'
+    field 4, 'uint8', 'undocumented_field_4'
+    field 5, 'uint8', 'undocumented_field_5'
+    field 253, 'uint32', 'timestamp', :type => 'date_time'
+
+    # Not part of the official ANT SDK doc.
+    message 326, 'undocumented_326'
+    field 0, 'uint32', 'undocumented_field_0'
+    field 1, 'uint32', 'undocumented_field_1'
+    field 253, 'uint32', 'timestamp', :type => 'date_time'
+
+    # Not part of the official ANT SDK doc.
+    message 327, 'undocumented_327'
+    field 0, 'uint8', 'undocumented_field_0'
+    field 1, 'uint8', 'undocumented_field_1'
+    field 2, 'uint8', 'undocumented_field_2'
+    field 3, 'uint32', 'undocumented_field_3'
+    field 4, 'uint32', 'undocumented_field_4'
+    field 5, 'uint32', 'undocumented_field_5'
+    field 6, 'enum', 'undocumented_field_6'
+    field 251, 'byte', 'undocumented_field_251'
+    field 252, 'uint8', 'undocumented_field_252'
+    field 253, 'uint32', 'timestamp', :type => 'date_time'
+
     # Not part of the official ANT SDK doc.
     message 1024, 'undocumented_1024'
     field 0, 'enum', 'undocumented_field_0'