fit4ruby 3.9.0 → 3.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f0a74c755c07cbbcfd9b17b9efeb16a62696fd9076c9ece178e00e51b3ce075
-  data.tar.gz: 81ee48cea068828a6ad08c5f4f274270ec96179159e585ecc9068eccbf1be3a4
+  metadata.gz: d40c0fc77ae8184b42aa80643dfb6b0f036b3eab7f37bdb8ee66b76a9feaafc5
+  data.tar.gz: 6e8ce1d3472e67a3c7ba58200fdf6b395e009349e68dca0618a92b3176f8ff19
 SHA512:
-  metadata.gz: 0f140497b1f269075e912da5988238db3a279ef5baf20e4ce29f3b960307c3b87a4ada116283f17f5965a7e0e25e9b3e5bcdce7306b14ae49cb16d837692b239
-  data.tar.gz: 829a3ff7cee37f26218915d8370a0dd44fe6c24152c634f073fb0d25a543c3e50783188fe81f6d5cbbb00af42974eba1aed51f59ee25a108718773b7a65f8ad8
+  metadata.gz: 366a5e5b4f55ee4918c822e26eda16d6381a1e872b8af68504283def72f096e00717dc68f9bd52403d8e6662c4e2aff83d12d26e201d568794bca407513b5bd8
+  data.tar.gz: a4eda75c90f65d26b9786570ee0fa07e578a3d627996170385411305b17a7a9697b043de70b335e485f3ca5780cdb0157506d34212ab0c54947c4111fb951fbf

data/README.md

@@ -10,7 +10,7 @@ me comments and patches. It was developed to form the back-end of
 
 ## Supported Devices
 
-Tested devices: Garmin FR620
+Tested devices: Garmin FR620, Fenix 3, Fenix 5, Fenix 5X, Fenix 6X
 
 Other Garmin devices that generate FIT files may work as well. Since I
 don't have any other devices, I can't add support for them.

data/lib/fit4ruby/Activity.rb

@@ -30,6 +30,8 @@ require 'fit4ruby/HRV'
 require 'fit4ruby/HeartRateZones'
 require 'fit4ruby/Event'
 require 'fit4ruby/PersonalRecords'
+require 'fit4ruby/Workout'
+require 'fit4ruby/WorkoutStep'
 
 module Fit4Ruby
 
@@ -54,6 +56,8 @@ module Fit4Ruby
       :epo_data,
       :user_profiles,
       :user_data,
+      :workouts,
+      :workout_steps,
       :sensor_settings,
       :developer_data_ids,
       :field_descriptions,
@@ -405,6 +409,22 @@ module Fit4Ruby
       new_fit_data_record('user_profile', field_values)
     end
 
+    # Add a new Workout to the Activity.
+    # @param field_values [Hash] A Hash that provides initial values for
+    #        certain fields of the FitDataRecord.
+    # @return [UserProfile]
+    def new_workout(field_values = {})
+      new_fit_data_record('workout', field_values)
+    end
+
+    # Add a new WorkoutSet to the Activity.
+    # @param field_values [Hash] A Hash that provides initial values for
+    #        certain fields of the FitDataRecord.
+    # @return [UserProfile]
+    def new_workout_set(field_values = {})
+      new_fit_data_record('workout_set', field_values)
+    end
+
     # Add a new PhysiologicalMetrics to the Activity.
     # @param field_values [Hash] A Hash that provides initial values for
     #        certain fields of the FitDataRecord.
@@ -522,6 +542,10 @@ module Fit4Ruby
         @data_sources << (record = DataSources.new(field_values))
       when 'user_data'
         @user_data << (record = UserData.new(field_values))
+      when 'workout'
+        @workouts << (record = Workout.new(field_values))
+      when 'workout_step'
+        @workout_steps << (record = WorkoutStep.new(field_values))
       when 'user_profile'
         @user_profiles << (record = UserProfile.new(field_values))
       when 'physiological_metrics'

data/lib/fit4ruby/FitDataRecord.rb

@@ -3,7 +3,7 @@
 #
 # = FitDataRecord.rb -- Fit4Ruby - FIT file processing library for Ruby
 #
-# Copyright (c) 2014, 2015, 2020 by Chris Schlaeger <cs@taskjuggler.org>
+# Copyright (c) 2014, 2015, 2020, 2021 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,7 @@ module Fit4Ruby
     include Converters
     include BDFieldNameTranslator
 
-    RecordOrder = [ 'user_data', 'user_profile',
+    RecordOrder = [ 'user_data', 'user_profile', 'workout', 'workout_set',
                     'device_info', 'data_sources', 'event',
                     'record', 'lap', 'length', 'session', 'heart_rate_zones',
                     'personal_records' ]

data/lib/fit4ruby/GlobalFitDictionaries.rb

@@ -3,7 +3,7 @@
 #
 # = GlobalFitDictionaries.rb -- Fit4Ruby - FIT file processing library for Ruby
 #
-# Copyright (c) 2014 by Chris Schlaeger <cs@taskjuggler.org>
+# Copyright (c) 2014, 2021 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
@@ -714,6 +714,9 @@ module Fit4Ruby
     entry 1, 'rest'
     entry 2, 'warmup'
     entry 3, 'cooldown'
+    entry 4, 'recovery'
+    entry 5, 'interval'
+    entry 6, 'other'
 
     dict 'hr_zone_calc'
     entry 0, 'custom'
@@ -933,6 +936,36 @@ module Fit4Ruby
     entry 17, 'hiking'
     entry 18, 'multisport'
     entry 19, 'paddling'
+    entry 20, 'flying'
+    entry 21, 'e_biking'
+    entry 22, 'motorcycling'
+    entry 23, 'boating'
+    entry 24, 'driving'
+    entry 25, 'golf'
+    entry 26, 'hang_gliding'
+    entry 27, 'horseback_riding'
+    entry 28, 'hunting'
+    entry 29, 'fishing'
+    entry 30, 'inline_skating'
+    entry 31, 'rock_climbing'
+    entry 32, 'sailing'
+    entry 33, 'ice_skating'
+    entry 34, 'sky_diving'
+    entry 35, 'snowshoeing'
+    entry 36, 'snowmobiling'
+    entry 37, 'stand_up_paddleboarding'
+    entry 38, 'surfing'
+    entry 39, 'wakeboarding'
+    entry 40, 'water_skiing'
+    entry 41, 'kayaking'
+    entry 42, 'rafting'
+    entry 43, 'windsurfing'
+    entry 44, 'kitesurfing'
+    entry 45, 'tactical'
+    entry 46, 'jumpmaster'
+    entry 47, 'boxing'
+    entry 48, 'floor_climbing'
+    entry 53, 'diving'
     entry 254, 'all'
 
     dict 'swim_stroke'
@@ -1023,6 +1056,79 @@ module Fit4Ruby
     entry 2, 'maintaining'
     entry 3, 'up'
 
+    dict 'wkt_step_duration'
+    entry 0, 'time'
+    entry 1, 'distance'
+    entry 2, 'hr_less_than'
+    entry 3, 'hr_greater_than'
+    entry 4, 'calories'
+    entry 5, 'open'
+    entry 6, 'repeat_until_steps_cmplt'
+    entry 7, 'repeat_until_time'
+    entry 8, 'repeat_until_distance'
+    entry 9, 'repeat_until_calories'
+    entry 10, 'repeat_until_hr_less_than'
+    entry 11, 'repeat_until_hr_greater_than'
+    entry 12, 'repeat_until_power_less_than'
+    entry 13, 'repeat_until_power_greater_than'
+    entry 14, 'power_less_than'
+    entry 15, 'power_greater_than'
+    entry 16, 'training_peaks_tss'
+    entry 17, 'repeat_until_power_last_lap_less_than'
+    entry 18, 'repeat_until_max_power_last_lap_less_than'
+    entry 19, 'power_3s_less_than'
+    entry 20, 'power_10s_less_than'
+    entry 21, 'power_30s_less_than'
+    entry 22, 'power_3s_greater_than'
+    entry 23, 'power_10s_greater_than'
+    entry 24, 'power_30s_greater_than'
+    entry 25, 'power_lap_less_than'
+    entry 26, 'power_lap_greater_than'
+    entry 27, 'repeat_until_training_peaks_tss'
+    entry 28, 'repetition_time'
+    entry 29, 'reps'
+    entry 31, 'time_only'
+
+    dict 'wkt_step_target'
+    entry 0, 'speed'
+    entry 1, 'heart_rate'
+    entry 2, 'open'
+    entry 3, 'cadence'
+    entry 4, 'power'
+    entry 5, 'grade'
+    entry 6, 'resistance'
+    entry 7, 'power_3s'
+    entry 8, 'power_10s'
+    entry 9, 'power_30s'
+    entry 10, 'power_lap'
+    entry 11, 'swim_stroke'
+    entry 12, 'speed_lap'
+    entry 13, 'heart_rate_lap'
+
+    dict 'workout_capabilities'
+    entry 0x1, 'interval'
+    entry 0x2, 'custom'
+    entry 0x4, 'fitness_equipment'
+    entry 0x8, 'firstbeat'
+    entry 0x10, 'new_leaf'
+    entry 0x20, 'tcx'
+    entry 0x80, 'speed'
+    entry 0x100, 'heart_rate'
+    entry 0x200, 'distance'
+    entry 0x400, 'cadence'
+    entry 0x800, 'power'
+    entry 0x1000, 'grade'
+    entry 0x2000, 'resistance'
+    entry 0x4000, 'protected'
+
+    dict 'workout_equipment'
+    entry 0, 'none'
+    entry 1, 'swim_fins'
+    entry 2, 'swim_kickboard'
+    entry 3, 'swim_paddles'
+    entry 4, 'swim_pull_buoy'
+    entry 5, 'swim_snorkel'
+
   end
 
 end

data/lib/fit4ruby/GlobalFitMessages.rb

@@ -3,7 +3,7 @@
 #
 # = GlobalFitMessages.rb -- Fit4Ruby - FIT file processing library for Ruby
 #
-# Copyright (c) 2014, 2015, 2020 by Chris Schlaeger <cs@taskjuggler.org>
+# Copyright (c) 2014, 2015, 2020, 2021 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
@@ -461,19 +461,23 @@ module Fit4Ruby
     field 169, 'uint16', 'undocumented_field_169'
     field 170, 'uint16', 'undocumented_field_170'
     field 177, 'uint16', 'undocumented_field_177'
-    field 178, 'uint16', 'undocumented_field_178'
+    field 178, 'uint16', 'est_sweat_loss', :unit => 'ml' # guessed
     field 179, 'uint16', 'undocumented_field_179'
     field 180, 'uint16', 'undocumented_field_180'
-    field 181, 'float32', 'undocumented_field_181'
-    field 183, 'uint16', 'undocumented_field_183'
+    field 181, 'float32', 'total_grit', :unit => 'kGrit'
+    field 182, 'float32', 'total_flow', :unit => 'Flow'
+    field 183, 'uint16', 'jump_count'
     field 184, 'enum', 'undocumented_field_184'
     field 185, 'uint8', 'undocumented_field_185'
-    field 187, 'float32', 'undocumented_field_187'
+    field 186, 'float32', 'avg_grit', :unit => 'kGrit'
+    field 187, 'float32', 'avg_flow', :unit => 'Flow'
     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 199, 'uint8', 'total_fractional_ascent', :scale => 100, :unit => 'm'
+    field 200, 'uint8', 'total_fractional_descent', :scale => 100, :unit => 'm'
     field 253, 'uint32', 'timestamp', :type => 'date_time'
     field 254, 'uint16', 'message_index'
 
@@ -745,6 +749,48 @@ module Fit4Ruby
     # counter.
     field 2, 'byte', 'undocumented_field_2', :array => true
 
+    message 26, 'workout'
+    field 4, 'enum', 'sport', :dict => 'sport'
+    field 5, 'uint32z', 'capabilities', :dict => 'workout_capabilities'
+    field 6, 'uint16', 'num_valid_step'
+    field 8, 'string', 'wkt_name'
+    field 11, 'enum', 'sub_sport', :dict => 'sub_sport'
+    field 14, 'uint16', 'pool_length', :scale => 100, :unit => 'm'
+    field 15, 'enum', 'pool_length_unit'
+
+    message 27, 'workout_step'
+    field 0, 'string', 'wkt_step_name'
+    field 1, 'enum', 'duration_type', :dict => 'wkt_step_duration'
+    alt_field 2, 'duration_type' do
+     field :default, 'uint32', 'duration_value'
+     field 'distance', 'uint32', 'duration_distance', :scale => 100, :unit => 'm'
+     field 'time', 'uint32', 'duration_time', :scale => 1000, :unit => 's'
+     field 'repeat_until_steps_cmplt', 'uint32', 'duration_reps'
+    end
+    field 3, 'enum', 'target_type', :dict => 'wkt_step_target'
+    alt_field 4, 'target_type' do
+      field :default, 'uint32', 'target_value'
+      field 'speed', 'uint32', 'target_speed_zone'
+      field 'cadence', 'uint32', 'target_cadence_zone'
+      field 'power', 'uint32', 'target_power_zone'
+    end
+    alt_field 5, 'target_type' do
+      field :default, 'uint32', 'custom_target_value_low'
+      field 'speed', 'uint32', 'custom_target_speed_low', :scale => 1000, :unit => 'm/s'
+    end
+    alt_field 6, 'target_type' do
+      field :default, 'uint32', 'custom_target_value_high'
+      field 'speed', 'uint32', 'custom_target_speed_high', :scale => 1000, :unit => 'm/s'
+    end
+    field 7, 'enum', 'intensity', :dict => 'intensity'
+    field 8, 'string', 'notes'
+    field 9, 'enum', 'equipment', :dict => 'workout_equipment'
+    field 10, 'uint16', 'exercise_category'
+    field 11, 'uint16', 'exercise_name'
+    field 12, 'uint16', 'exercise_weight', :scale => 100, :unit => 'kg'
+    field 13, 'uint16', 'weight_display_unit'
+    field 254, 'uint16', 'message_index'
+
     # Message 29 is just a guess. It's not officially documented.
     # Found in LCTNS.FIT on Fenix 3
     message 29, 'location'

data/lib/fit4ruby/Workout.rb

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby -w
+# encoding: UTF-8
+#
+# = Workout.rb -- Fit4Ruby - FIT file processing library for Ruby
+#
+# Copyright (c) 2021 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
+# published by the Free Software Foundation.
+#
+
+require 'fit4ruby/FitDataRecord'
+
+module Fit4Ruby
+
+  class Workout < FitDataRecord
+
+    def initialize(field_values = {})
+      super('workout')
+      set_field_values(field_values)
+    end
+
+    def check(index)
+    end
+
+  end
+
+end
+
+

data/lib/fit4ruby/WorkoutStep.rb

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby -w
+# encoding: UTF-8
+#
+# = WorkoutStep.rb -- Fit4Ruby - FIT file processing library for Ruby
+#
+# Copyright (c) 2021 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
+# published by the Free Software Foundation.
+#
+
+require 'fit4ruby/FitDataRecord'
+
+module Fit4Ruby
+
+  class WorkoutStep < FitDataRecord
+
+    def initialize(field_values = {})
+      super('workout_step')
+      set_field_values(field_values)
+    end
+
+    def check(index)
+    end
+
+  end
+
+end
+
+
+

data/lib/fit4ruby/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fit4ruby
 version: !ruby/object:Gem::Version
-  version: 3.9.0
+  version: 3.10.0
 platform: ruby
 authors:
 - Chris Schlaeger
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-17 00:00:00.000000000 Z
+date: 2022-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bindata
@@ -164,6 +164,8 @@ files:
 - lib/fit4ruby/TrainingStatus.rb
 - lib/fit4ruby/UserData.rb
 - lib/fit4ruby/UserProfile.rb
+- lib/fit4ruby/Workout.rb
+- lib/fit4ruby/WorkoutStep.rb
 - lib/fit4ruby/version.rb
 - spec/FileNameCoder_spec.rb
 - spec/FitFile_spec.rb
@@ -176,7 +178,7 @@ homepage: https://github.com/scrapper/fit4ruby
 licenses:
 - GNU GPL version 2
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -191,8 +193,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
-signing_key: 
+rubygems_version: 3.2.32
+signing_key:
 specification_version: 4
 summary: Library to read and write GARMIN FIT files.
 test_files: