fit4ruby 3.7.0 → 3.8.0

data/lib/fit4ruby/FitTypeDefs.rb

@@ -21,9 +21,9 @@ module Fit4Ruby
     [ 'uint16', 'uint16', 0xFFFF, 2 ],
     [ 'sint32', 'int32', 0x7FFFFFFF, 4 ],
     [ 'uint32', 'uint32', 0xFFFFFFFF, 4 ],
-    [ 'string', 'string', '', 0 ],
+    [ 'string', 'string', 0, 1 ],
     [ 'float32', 'float', 0xFFFFFFFF, 4 ],
-    [ 'float63', 'double', 0xFFFFFFFF, 4 ],
+    [ 'float64', 'double', 0xFFFFFFFFFFFFFFFF, 8 ],
     [ 'uint8z', 'uint8', 0, 1 ],
     [ 'uint16z', 'uint16', 0, 2 ],
     [ 'uint32z', 'uint32', 0, 4 ],

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.
@@ -255,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)
@@ -269,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
@@ -278,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
@@ -1017,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'

data/lib/fit4ruby/Lap.rb

@@ -12,24 +12,30 @@
 
 require 'fit4ruby/FitDataRecord'
 require 'fit4ruby/RecordAggregator'
+require 'fit4ruby/FDR_DevField_Extension'
 
 module Fit4Ruby
 
   class Lap < FitDataRecord
 
     include RecordAggregator
+    include FDR_DevField_Extension
 
     attr_reader :records, :lengths
 
     # Create a new Lap object.
+    # @param top_level_record [FitDataRecord] Top level record that is Lap
+    #        belongs to.
     # @param records [Array of Records] Records to associate with the Lap.
     # @param lengths [Array of Lengths] Lengths to associate with the Lap.
     # @param first_length_index [Fixnum] Index of the first Length in this Lap.
     # @param previous_lap [Lap] Previous Lap on same Session.
     # @param field_values [Hash] Hash that provides initial values for certain
     #        fields.
-    def initialize(records, previous_lap, field_values, first_length_index, lengths)
+    def initialize(top_level_record, records, previous_lap, field_values,
+                   first_length_index, lengths)
       super('lap')
+      @top_level_record = top_level_record
       @lengths = lengths
       @meta_field_units['avg_stride_length'] = 'm'
       @records = records
@@ -51,6 +57,9 @@ module Fit4Ruby
         @total_elapsed_time = records.last.timestamp - @start_time
       end
 
+      # Create instance variables for developer fields
+      create_dev_field_instance_variables
+
       set_field_values(field_values)
     end
 

data/lib/fit4ruby/Record.rb

@@ -3,7 +3,7 @@
 #
 # = Record.rb -- Fit4Ruby - FIT file processing library for Ruby
 #
-# Copyright (c) 2014 by Chris Schlaeger <cs@taskjuggler.org>
+# Copyright (c) 2014, 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
@@ -11,6 +11,7 @@
 #
 
 require 'fit4ruby/FitDataRecord'
+require 'fit4ruby/FDR_DevField_Extension'
 
 module Fit4Ruby
 
@@ -18,13 +19,21 @@ module Fit4Ruby
   # of primary measurements that are associated with a certain timestamp.
   class Record < FitDataRecord
 
+    include FDR_DevField_Extension
+
     # Create a new Record object.
+    # @param fit_entity The FitEntity this record belongs to
     # @param field_values [Hash] Hash that provides initial values for certain
     #        fields.
-    def initialize(field_values = {})
+    def initialize(top_level_record, field_values = {})
       super('record')
+      @top_level_record = top_level_record
       @meta_field_units['pace'] = 'min/km'
       @meta_field_units['run_cadence'] = 'spm'
+
+      # Create instance variables for developer fields
+      create_dev_field_instance_variables
+
       set_field_values(field_values)
     end
 

data/lib/fit4ruby/version.rb

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

data/spec/FitFile_spec.rb

@@ -3,7 +3,7 @@
 #
 # = FitFile_spec.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
@@ -12,115 +12,147 @@
 
 $:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
+#require "super_diff/rspec"
 require 'fit4ruby'
 
 ENV['TZ'] = 'UTC'
 
 describe Fit4Ruby do
+  before(:each) do
+    File.delete(fit_file) if File.exist?(fit_file)
+    expect(File.exist?(fit_file)).to be false
+  end
+
+  after(:each) { File.delete(fit_file) }
+
   let(:fit_file) { 'test.fit' }
-  let(:timestamp) { Time.now }
-  let(:activity) do
-    ts = timestamp
-    a = Fit4Ruby::Activity.new
-    a.total_timer_time = 30 * 60.0
-    a.new_user_data({ :age => 33, :height => 1.78, :weight => 73.0,
-                      :gender => 'male', :activity_class => 4.0,
-                      :max_hr => 178 })
-
-    a.new_event({ :event => 'timer', :event_type => 'start_time' })
-    a.new_device_info({ :timestamp => ts,
-                        :device_index => 0, :manufacturer => 'garmin',
-                        :garmin_product => 'fenix3',
-                        :serial_number => 123456789 })
-    a.new_device_info({ :timestamp => ts,
-                        :device_index => 1, :manufacturer => 'garmin',
-                        :garmin_product => 'fenix3_gps'})
-    a.new_device_info({ :timestamp => ts,
-                        :device_index => 2, :manufacturer => 'garmin',
-                        :garmin_product => 'hrm_run',
-                        :battery_status => 'ok' })
-    a.new_device_info({ :timestamp => ts,
-                        :device_index => 3, :manufacturer => 'garmin',
-                        :garmin_product => 'sdm4',
-                        :battery_status => 'ok' })
-    a.new_data_sources({ :timestamp => ts, :distance => 1,
-                         :speed => 1, :cadence => 3, :elevation => 1,
-                         :heart_rate => 2 })
-    laps = 0
-    0.upto(a.total_timer_time / 60) do |mins|
-      ts += 60
-      a.new_record({
-        :timestamp => ts,
-        :position_lat => 51.5512 - mins * 0.0008,
-        :position_long => 11.647 + mins * 0.002,
-        :distance => 200.0 * mins,
-        :altitude => (100 + mins * 0.5).to_i,
-        :speed => 3.1,
-        :vertical_oscillation => 9 + mins * 0.02,
-        :stance_time => 235.0 * mins * 0.01,
-        :stance_time_percent => 32.0,
-        :heart_rate => 140 + mins,
-        :cadence => 75,
-        :activity_type => 'running',
-        :fractional_cadence => (mins % 2) / 2.0
-      })
+  # Round the timestamp to seconds. This is what the file format can store. A
+  # higher resolution would create errors during comparions.
+  let(:timestamp) { Time.at(Time.now.to_i) }
+  let(:user_data) do
+    {
+      :age => 33, :height => 1.78, :weight => 73.0,
+      :gender => 'male', :activity_class => 4.0,
+      :max_hr => 178
+    }
+  end
+  let(:user_profile) do
+    {
+      :friendly_name => 'Fast Runner',
+      :gender => 'male',
+      :age => 33,
+      :height => 1.78,
+      :weight => 73.0,
+      :resting_heart_rate => 43
+    }
+  end
+  def device_info_fenix3(ts)
+    {
+      :timestamp => ts,
+      :device_index => 0, :manufacturer => 'garmin',
+      :garmin_product => 'fenix3',
+      :serial_number => 123456789
+    }
+  end
+  def device_info_fenix3_gps(ts)
+    {
+      :timestamp => ts,
+      :device_index => 1, :manufacturer => 'garmin',
+      :garmin_product => 'fenix3_gps'
+    }
+  end
+  def device_info_hrm_run(ts, bs = 'ok')
+    {
+      :timestamp => ts,
+      :device_index => 2, :manufacturer => 'garmin',
+      :garmin_product => 'hrm_run',
+      :battery_status => bs
+    }
+  end
+  def device_info_sdm4(ts)
+    {
+      :timestamp => timestamp,
+      :device_index => 3, :manufacturer => 'garmin',
+      :garmin_product => 'sdm4',
+      :battery_status => 'ok'
+    }
+  end
+
+  context 'running activity' do
+    let(:activity) do
+      ts = timestamp
+      a = Fit4Ruby::Activity.new
+      a.total_timer_time = 30 * 60.0
+      a.new_user_data(user_data)
+      a.new_user_profile(user_profile)
+
+      a.new_event({ :event => 'timer', :event_type => 'start_time' })
+      a.new_device_info(device_info_fenix3(ts))
+      a.new_device_info(device_info_fenix3_gps(ts))
+      a.new_device_info(device_info_hrm_run(ts))
+      a.new_device_info(device_info_sdm4(ts))
+      a.new_data_sources({ :timestamp => ts, :distance => 1,
+                           :speed => 1, :cadence => 3, :elevation => 1,
+                           :heart_rate => 2 })
+      laps = 0
+      0.upto(a.total_timer_time / 60) do |mins|
+        ts += 60
+        a.new_record({
+          :timestamp => ts,
+          :position_lat => 51.5512 - mins * 0.0008,
+          :position_long => 11.647 + mins * 0.002,
+          :distance => 200.0 * mins,
+          :altitude => (100 + mins * 0.5).to_i,
+          :speed => 3.1,
+          :vertical_oscillation => 9 + mins * 0.02,
+          :stance_time => 235.0 * mins * 0.01,
+          :stance_time_percent => 32.0,
+          :heart_rate => 140 + mins,
+          :cadence => 75,
+          :activity_type => 'running',
+          :fractional_cadence => (mins % 2) / 2.0
+        })
 
-      if mins > 0 && mins % 5 == 0
-        a.new_lap({ :timestamp => ts, :sport => 'running',
-                    :message_index => laps, :total_cycles => 195 })
-        laps += 1
+        if mins > 0 && mins % 5 == 0
+          a.new_lap({ :timestamp => ts, :sport => 'running',
+                      :message_index => laps, :total_cycles => 195 })
+          laps += 1
+        end
       end
-    end
-    a.new_session({ :timestamp => ts, :sport => 'running' })
-    a.new_event({ :timestamp => ts, :event => 'recovery_time',
-                  :event_type => 'marker',
-                  :recovery_time => 2160 })
-    a.new_event({ :timestamp => ts, :event => 'vo2max',
-                  :event_type => 'marker', :vo2max => 52 })
-    a.new_event({ :timestamp => ts, :event => 'timer',
-                  :event_type => 'stop_all' })
-    ts += 1
-    a.new_device_info({ :timestamp => ts,
-                        :device_index => 0, :manufacturer => 'garmin',
-                        :garmin_product => 'fenix3',
-                        :serial_number => 123456789 })
-    a.new_device_info({ :timestamp => ts,
-                        :device_index => 1, :manufacturer => 'garmin',
-                        :garmin_product => 'fenix3_gps'})
-    a.new_device_info({ :timestamp => ts,
-                        :device_index => 2, :manufacturer => 'garmin',
-                        :garmin_product => 'hrm_run',
-                        :battery_status => 'low' })
-    a.new_device_info({ :timestamp => ts,
-                        :device_index => 3, :manufacturer => 'garmin',
-                        :garmin_product => 'sdm4',
-                        :battery_status => 'ok' })
-    ts += 120
-    a.new_event({ :timestamp => ts, :event => 'recovery_hr',
-                  :event_type => 'marker', :recovery_hr => 132 })
-
-    a.aggregate
-    a
-  end
+      a.new_session({ :timestamp => ts, :sport => 'running' })
+      a.new_event({ :timestamp => ts, :event => 'recovery_time',
+                    :event_type => 'marker',
+                    :recovery_time => 2160 })
+      a.new_event({ :timestamp => ts, :event => 'vo2max',
+                    :event_type => 'marker', :vo2max => 52 })
+      a.new_event({ :timestamp => ts, :event => 'timer',
+                    :event_type => 'stop_all' })
+      ts += 1
+      a.new_device_info(device_info_fenix3(ts))
+      a.new_device_info(device_info_fenix3_gps(ts))
+      a.new_device_info(device_info_hrm_run(ts, 'low'))
+      a.new_device_info(device_info_sdm4(ts))
+      ts += 120
+      a.new_event({ :timestamp => ts, :event => 'recovery_hr',
+                    :event_type => 'marker', :recovery_hr => 132 })
 
-  before do
-    File.delete(fit_file) if File.exist?(fit_file)
-    expect(File.exist?(fit_file)).to be false
-  end
+      a.aggregate
+      a
+    end
 
-  after { File.delete(fit_file) }
+    it 'should write an Activity FIT file and read it back' do
+      Fit4Ruby.write(fit_file, activity)
+      expect(File.exist?(fit_file)).to be true
 
-  it 'should write an Activity FIT file and read it back' do
-    Fit4Ruby.write(fit_file, activity)
-    expect(File.exist?(fit_file)).to be true
+      b = Fit4Ruby.read(fit_file)
+      expect(b.laps.count).to eq 6
+      expect(b.lengths.count).to eq 0
+      expect(b.export).to eq(activity.export)
+    end
 
-    b = Fit4Ruby.read(fit_file)
-    expect(b.laps.count).to eq 6
-    expect(b.lengths.count).to eq 0
-    expect(b.inspect).to eq(activity.inspect)
   end
 
-  context 'activity with Lengths' do
+  context 'swimming activity' do
     let(:activity) do
       ts = timestamp
       laps = 0
@@ -128,9 +160,7 @@ describe Fit4Ruby do
       a = Fit4Ruby::Activity.new
 
       a.total_timer_time = 30 * 60.0
-      a.new_device_info({ :timestamp => ts,
-        :device_index => 0, :manufacturer => 'garmin',
-        :serial_number => 123456789 })
+      a.new_device_info(device_info_fenix3(ts))
 
       0.upto(a.total_timer_time / 60) do |mins|
         ts += 60
@@ -144,6 +174,7 @@ describe Fit4Ruby do
           lengths += 1
         end
       end
+      a.aggregate
       a
     end
 
@@ -156,9 +187,76 @@ describe Fit4Ruby do
       expect(b.lengths.count).to eq 6
       expect(b.laps.select { |l| l.sport == 'swimming' }.count).to eq 6
       expect(b.lengths.select { |l| l.total_strokes == 45 }.count).to eq 6
-      expect(b.inspect).to eq(activity.inspect)
+      expect(b.export).to eq(activity.export)
+    end
+
+  end
+
+  context 'activity with developer fields' do
+    let(:activity) do
+      ts = timestamp
+      laps = 0
+      lengths = 0
+      a = Fit4Ruby::Activity.new
+
+      a.total_timer_time = 30 * 60.0
+      a.new_device_info(device_info_fenix3(ts))
+      a.new_developer_data_id({
+        application_id: [ 24, 251, 44, 240, 26, 75, 67, 13,
+                          173, 102, 152, 140, 132, 116, 33, 244 ],
+        application_version: 77
+      })
+      a.new_field_description({
+        developer_data_index: 0,
+        field_definition_number: 0,
+        fit_base_type_id: 132,
+        field_name: 'Power',
+        units: 'Watts',
+        native_mesg_num: 20,
+        native_field_num: 7
+      })
+      a.new_data_sources({ :timestamp => ts, :distance => 1,
+                           :speed => 1, :cadence => 3, :elevation => 1,
+                           :heart_rate => 2 })
+      laps = 0
+      0.upto(a.total_timer_time / 60) do |mins|
+        ts += 60
+        a.new_record({
+          :timestamp => ts,
+          :position_lat => 51.5512 - mins * 0.0008,
+          :position_long => 11.647 + mins * 0.002,
+          :distance => 200.0 * mins,
+          :altitude => (100 + mins * 0.5).to_i,
+          :speed => 3.1,
+          :vertical_oscillation => 9 + mins * 0.02,
+          :stance_time => 235.0 * mins * 0.01,
+          :stance_time_percent => 32.0,
+          :heart_rate => 140 + mins,
+          :cadence => 75,
+          :activity_type => 'running',
+          :fractional_cadence => (mins % 2) / 2.0,
+          :Power_18FB2CF01A4B430DAD66988C847421F4 => 240
+        })
+
+        if mins > 0 && mins % 5 == 0
+          a.new_lap({ :timestamp => ts, :sport => 'running',
+                      :message_index => laps, :total_cycles => 195 })
+          laps += 1
+        end
+      end
+      a.aggregate
+      a
     end
 
+    it 'should write an Activity FIT file and read it back' do
+      Fit4Ruby.write(fit_file, activity)
+      expect(File.exist?(fit_file)).to be true
+
+      # This currently does not work as the saving of developer fields is not
+      # yet implemented.
+      #b = Fit4Ruby.read(fit_file)
+      #expect(b.export).to eq(activity.export)
+    end
   end
 
 end