fit4ruby 0.0.1

data/lib/fit4ruby/FitFileId.rb

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby -w
+# encoding: UTF-8
+#
+# = FitFileId.rb -- Fit4Ruby - FIT file processing library for Ruby
+#
+# Copyright (c) 2014 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/Converters'
+require 'fit4ruby/FitDataRecord'
+
+module Fit4Ruby
+
+  class FitFileId < FitDataRecord
+
+    def initialize
+      super('file_id')
+      @serial_number = 1234567890
+      @time_created = Time.now
+      @manufacturer = 'development'
+      @type = 'activity'
+    end
+
+  end
+
+end
+

data/lib/fit4ruby/FitFilter.rb

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby -w
+# encoding: UTF-8
+#
+# = FitFilter.rb -- Fit4Ruby - FIT file processing library for Ruby
+#
+# Copyright (c) 2014 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.
+#
+
+module Fit4Ruby
+
+  class FitFilter < Struct.new(:record_numbers, :record_indexes, :field_names,
+                               :ignore_undef)
+
+    def initialize
+      super
+      self[:ignore_undef] = false
+    end
+
+  end
+
+end
+

data/lib/fit4ruby/FitHeader.rb

@@ -0,0 +1,55 @@
+#!/usr/bin/env ruby -w
+# encoding: UTF-8
+#
+# = FitHeader.rb -- Fit4Ruby - FIT file processing library for Ruby
+#
+# Copyright (c) 2014 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 'bindata'
+require 'fit4ruby/Log'
+
+module Fit4Ruby
+
+  class FitHeader < BinData::Record
+
+    endian :little
+
+    uint8 :header_size, :initial_value => 14
+    uint8 :protocol_version, :initial_value => 16
+    uint16 :profile_version, :initial_value => 1012
+    uint32 :data_size, :initial_value => 0
+    string :data_type, :read_length => 4, :initial_value => '.FIT'
+    uint16 :crc, :initial_value => 0
+
+    def check
+      unless header_size == 14
+        Log.fatal { "Unsupported header size #{@header.header_size}" }
+      end
+      unless data_type == '.FIT'
+        Log.fata { "Unknown file type #{@header.data_type}" }
+      end
+    end
+
+    def dump
+      puts <<"EOT"
+Fit File Header
+  Header Size: #{header_size}
+  Protocol Version: #{protocol_version}
+  Profile Version: #{profile_version}
+  Data Size: #{data_size}
+EOT
+    end
+
+    def end_pos
+      header_size + data_size
+    end
+
+  end
+
+end
+

data/lib/fit4ruby/FitMessageIdMapper.rb

@@ -0,0 +1,53 @@
+#!/usr/bin/env ruby -w
+# encoding: UTF-8
+#
+# = FitMessageIdMapper.rb -- Fit4Ruby - FIT file processing library for Ruby
+#
+# Copyright (c) 2014 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.
+#
+
+module Fit4Ruby
+
+  class FitMessageIdMapper
+
+    class Entry < Struct.new(:global_id, :last_use)
+    end
+
+    def initialize
+      @entries = Array.new(16, nil)
+    end
+
+    def add_global(id)
+      unless (slot = @entries.index { |e| e.nil? })
+        puts @entries.inspect
+        # No more free slots. We have to find the least recently used one.
+        slot = 0
+        0.upto(15) do |i|
+          if i != slot && @entries[slot].last_use > @entries[i].last_use
+            slot = i
+          end
+        end
+      end
+      @entries[slot] = Entry.new(id, Time.now)
+
+      slot
+    end
+
+    def get_local(id)
+      0.upto(15) do |i|
+        if (entry = @entries[i]) && entry.global_id == id
+          entry.last_use = Time.now
+          return i
+        end
+      end
+      nil
+    end
+
+  end
+
+end
+

data/lib/fit4ruby/FitMessageRecord.rb

@@ -0,0 +1,77 @@
+#!/usr/bin/env ruby -w
+# encoding: UTF-8
+#
+# = FitMessageRecord.rb -- Fit4Ruby - FIT file processing library for Ruby
+#
+# Copyright (c) 2014 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 'bindata'
+require 'fit4ruby/Log'
+require 'fit4ruby/GlobalFitMessage'
+
+module Fit4Ruby
+
+  class FitMessageRecord
+
+    attr_reader :global_message_number, :name, :message_record
+
+    def initialize(definition)
+      @definition = definition
+      @global_message_number = definition.global_message_number.snapshot
+
+      if (@gfm = GlobalFitMessages[@global_message_number])
+        @name = @gfm.name
+      else
+        @name = "message#{@global_message_number}"
+        Log.warn { "Unknown global message number #{@global_message_number}" }
+      end
+      @message_record = produce(definition)
+    end
+
+    def read(io, activity, filter = nil, fields_dump = nil)
+      @message_record.read(io)
+
+      obj = case @name
+            when 'activity'
+              activity
+            when 'session'
+              activity.new_session
+            when 'record'
+              activity.new_record
+            else
+              nil
+            end
+
+      @definition.fields.each do |field|
+        value = @message_record[field.name].snapshot
+        obj.set(field.name, field.to_machine(value)) if obj
+        if filter && fields_dump &&
+           (filter.field_names.nil? ||
+            filter.field_names.include?(field.name)) &&
+           (value != field.undefined_value || !filter.ignore_undef)
+          fields_dump[field] = value
+        end
+      end
+    end
+
+    private
+
+    def produce(definition)
+      fields = []
+      definition.fields.each do |field|
+        fields << [ field.type, field.name ]
+      end
+
+      BinData::Struct.new(:endian => definition.endian, :fields => fields)
+    end
+
+
+  end
+
+end
+

data/lib/fit4ruby/FitRecord.rb

@@ -0,0 +1,80 @@
+#!/usr/bin/env ruby -w
+# encoding: UTF-8
+#
+# = FitRecord.rb -- Fit4Ruby - FIT file processing library for Ruby
+#
+# Copyright (c) 2014 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/Log'
+require 'fit4ruby/FitRecordHeader'
+require 'fit4ruby/FitDefinition'
+require 'fit4ruby/FitMessageRecord'
+require 'fit4ruby/FitFilter'
+require 'fit4ruby/Activity'
+
+module Fit4Ruby
+
+  class FitRecord
+
+    def initialize(definitions)
+      @definitions = definitions
+      @name = @number = @fields = nil
+    end
+
+    def read(io, activity, filter, record_counters)
+      header = FitRecordHeader.read(io)
+
+      if header.normal?
+        # process normal headers
+        local_message_type = header.local_message_type.snapshot
+        if header.message_type == 1
+          # process definition message
+          definition = FitDefinition.read(io)
+          @definitions[local_message_type] = FitMessageRecord.new(definition)
+        else
+          # process data message
+          definition = @definitions[local_message_type]
+          unless definition
+            Log.fatal "Undefined local message type: #{local_message_type}"
+          end
+          if filter
+            @number = @definitions[local_message_type].global_message_number
+            index = (record_counters[@number] += 1)
+            if (filter.record_numbers.nil? ||
+                filter.record_numbers.include?(@number)) &&
+               (filter.record_indexes.nil? ||
+                filter.record_indexes.include?(index))
+              @name = definition.name
+              @fields = {}
+            end
+          end
+          definition.read(io, activity, filter, @fields)
+        end
+      else
+        # process compressed timestamp header
+        time_offset = header.time_offset
+        Log.fatal "Support for compressed headers not yet implemented"
+      end
+
+      self
+    end
+
+    def dump
+      return unless @fields
+
+      puts "Message #{@number}: #{@name}" unless @fields.empty?
+      @fields.each do |field, value|
+        puts " [#{"%-7s" % field.type(true)}] #{field.name}: " +
+             "#{field.to_s(value)}"
+      end
+    end
+
+  end
+
+end
+

data/lib/fit4ruby/FitRecordHeader.rb

@@ -0,0 +1,39 @@
+#!/usr/bin/env ruby -w
+# encoding: UTF-8
+#
+# = FitRecordHeader.rb -- Fit4Ruby - FIT file processing library for Ruby
+#
+# Copyright (c) 2014 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.
+#
+
+module Fit4Ruby
+
+  class FitRecordHeader < BinData::Record
+
+    bit1 :normal
+
+    bit1 :message_type, :onlyif => :normal?
+    bit2 :reserved, :onlyif => :normal?
+
+    choice :local_message_type, :selection => :normal do
+      bit4 0
+      bit2 1
+    end
+
+    bit5 :time_offset, :onlyif => :compressed?
+
+    def normal?
+      normal == 0
+    end
+
+    def compressed?
+      normal == 1
+    end
+
+  end
+
+end

data/lib/fit4ruby/GlobalFitDictList.rb

@@ -0,0 +1,68 @@
+#!/usr/bin/env ruby -w
+# encoding: UTF-8
+#
+# = GlobalFitDictList.rb -- Fit4Ruby - FIT file processing library for Ruby
+#
+# Copyright (c) 2014 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/Log'
+
+module Fit4Ruby
+
+  class GlobalFitDict
+
+    def initialize
+      @entries = {}
+    end
+
+    def entry(number, name)
+      if @entries.include?(number)
+        Log.fatal "Entry #{number} has already been defined"
+      end
+      @entries[number] = name
+    end
+
+    def name(number)
+      @entries[number]
+    end
+
+    def value_by_name(name)
+      @entries.invert[name]
+    end
+
+  end
+
+  class GlobalFitDictList
+
+    def initialize(&block)
+      @current_dict = nil
+      @dicts = {}
+      instance_eval(&block) if block_given?
+    end
+
+    def dict(name)
+      if @dicts.include?(name)
+        Log.fatal "Dictionary #{name} has already been defined"
+      end
+      @dicts[name] = @current_dict = GlobalFitDict.new
+    end
+
+    def entry(number, name)
+      unless @current_dict
+        Log.fatal "You must define a dictionary first"
+      end
+      @current_dict.entry(number, name)
+    end
+
+    def [](name)
+      @dicts[name]
+    end
+
+  end
+
+end

data/lib/fit4ruby/GlobalFitDictionaries.rb

@@ -0,0 +1,302 @@
+#!/usr/bin/env ruby -w
+# encoding: UTF-8
+#
+# = GlobalFitDictionaries.rb -- Fit4Ruby - FIT file processing library for Ruby
+#
+# Copyright (c) 2014 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/GlobalFitDictList'
+
+module Fit4Ruby
+
+  GlobalFitDictionaries = GlobalFitDictList.new do
+
+    dict 'activity_type'
+    entry 0, 'generic'
+    entry 1, 'running'
+    entry 2, 'cycling'
+    entry 3, 'transition'
+    entry 4, 'fitness_equipment'
+    entry 5, 'swimming'
+    entry 6, 'walking'
+    entry 254, 'all'
+
+    dict 'battery_status'
+    entry 1, 'new'
+    entry 2, 'good'
+    entry 3, 'ok'
+    entry 4, 'low'
+    entry 5, 'critical'
+
+    dict 'device_type'
+    entry 1, 'antfs'
+    entry 11, 'bike_power'
+    entry 12, 'environment_sensor_legacy'
+    entry 13, 'multi_sport_speed_distance'
+    entry 14, 'control'
+    entry 17, 'fitness_equipment'
+    entry 18, 'blood_pressure'
+    entry 19, 'geocache_node'
+    entry 20, 'light_electric_vehicle'
+    entry 25, 'env_sensor'
+    entry 26, 'racquet'
+    entry 30, 'running_dynamics' # Just a guess
+    entry 119, 'weight_scale'
+    entry 120, 'heart_rate'
+    entry 121, 'bike_speed_cadence'
+    entry 122, 'bike_cadence'
+    entry 123, 'bike_speed'
+    entry 124, 'stride_speed_distance'
+
+    dict 'event'
+    entry 0, 'timer'
+    entry 3, 'workout'
+    entry 4, 'workout_step'
+    entry 5, 'power_down'
+    entry 6, 'power_up'
+    entry 7, 'off_course'
+    entry 8, 'session'
+    entry 9, 'lap'
+    entry 10, 'course_point'
+    entry 11, 'battery'
+    entry 12, 'virtual_partner_pace'
+    entry 13, 'hr_high_alert'
+    entry 14, 'hr_low_alert'
+    entry 15, 'speed_high_alert'
+    entry 16, 'speed_low_alert'
+    entry 17, 'cad_high_alert'
+    entry 18, 'cad_low_alert'
+    entry 19, 'power_high_alert'
+    entry 20, 'power_low_alert'
+    entry 21, 'recovery_hr'
+    entry 22, 'battery_low'
+    entry 23, 'time_duration_alert'
+    entry 24, 'distance_duration_alert'
+    entry 25, 'calorie_duration_alert'
+    entry 26, 'activity'
+    entry 27, 'fitness_equipment'
+    entry 28, 'length'
+    entry 32, 'user_marker'
+    entry 33, 'sport_point'
+    entry 36, 'calibration'
+    entry 37, 'vo2max' # guess
+    entry 38, 'recovery_time' # guess (in minutes)
+    entry 42, 'front_gear_change'
+    entry 43, 'rear_gear_change'
+
+    dict 'event_type'
+    entry 0, 'start_time'
+    entry 1, 'stop'
+    entry 2, 'consecutive_depreciated'
+    entry 3, 'marker'
+    entry 4, 'stop_all'
+    entry 5, 'begin_depreciated'
+    entry 6, 'end_depreciated'
+    entry 7, 'end_all_depreciated'
+    entry 8, 'stop_disable'
+    entry 9, 'stop_disable_all'
+
+    dict 'file'
+    entry 1, 'device'
+    entry 2, 'settings'
+    entry 3, 'sport'
+    entry 4, 'activity'
+    entry 5, 'workout'
+    entry 6, 'course_point'
+    entry 7, 'schedules'
+    entry 9, 'weight_scale'
+    entry 10, 'totals'
+    entry 11, 'goals'
+    entry 14, 'blood_pressure'
+    entry 15, 'monitoring_a'
+    entry 20, 'activity_summary'
+    entry 28, 'monitoring_daily'
+    entry 32, 'monitoring_b'
+
+    dict 'gender'
+    entry 0, 'female'
+    entry 1, 'male'
+
+    dict 'intensity'
+    entry 0, 'active'
+    entry 1, 'rest'
+    entry 2, 'warmup'
+    entry 3, 'cooldown'
+
+    dict 'lap_trigger'
+    entry 0, 'manual'
+    entry 1, 'time'
+    entry 2, 'distance'
+    entry 3, 'position_start'
+    entry 4, 'position_lap'
+    entry 5, 'position_waypoint'
+    entry 6, 'position_marked'
+    entry 7, 'session_end'
+    entry 8, 'fitness_equipment'
+
+    dict 'manufacturer'
+    entry 1, 'Garmin'
+    entry 2, 'garmin_fr405_antfs'
+    entry 3, 'zephyr'
+    entry 4, 'dayton'
+    entry 5, 'idt'
+    entry 6, 'srm'
+    entry 7, 'quarq'
+    entry 8, 'ibike'
+    entry 9, 'saris'
+    entry 10, 'spark_hk'
+    entry 11, 'tanita'
+    entry 12, 'echowell'
+    entry 13, 'dynastream_oem'
+    entry 14, 'nautilus'
+    entry 15, 'dynastream'
+    entry 16, 'timex'
+    entry 17, 'metrigear'
+    entry 18, 'xelic'
+    entry 19, 'beurer'
+    entry 20, 'cardiosport'
+    entry 21, 'a_and_d'
+    entry 22, 'hmm'
+    entry 23, 'suunto'
+    entry 24, 'thita_elektronik'
+    entry 25, 'gpulse'
+    entry 26, 'clean_mobile'
+    entry 27, 'pedal_brain'
+    entry 28, 'peaksware'
+    entry 29, 'saxonar'
+    entry 30, 'lemond_fitness'
+    entry 31, 'dexcom'
+    entry 32, 'wahoo_fitness'
+    entry 33, 'octane_fitness'
+    entry 34, 'archinoetics'
+    entry 35, 'the_hurt_box'
+    entry 36, 'citizen_systems'
+    entry 37, 'magellan'
+    entry 38, 'osynce'
+    entry 39, 'holux'
+    entry 40, 'concept2'
+    entry 42, 'one_giant_leap'
+    entry 43, 'ace_sensor'
+    entry 44, 'brim_brothers'
+    entry 45, 'xplova'
+    entry 46, 'perception_digital'
+    entry 47, 'bf1systems'
+    entry 48, 'pioneer'
+    entry 49, 'spantec'
+    entry 50, 'metalogics'
+    entry 51, '4iiiis'
+    entry 52, 'seiko_epson'
+    entry 53, 'seiko_epson_oem'
+    entry 54, 'ifor_powell'
+    entry 55, 'maxwell_guider'
+    entry 56, 'star_trac'
+    entry 57, 'breakaway'
+    entry 58, 'alatech_technology_ltd'
+    entry 59, 'mio_technology_europe'
+    entry 60, 'rotor'
+    entry 61, 'geonaute'
+    entry 62, 'id_bike'
+    entry 63, 'specialized'
+    entry 64, 'wtek'
+    entry 65, 'physical_enterprises'
+    entry 66, 'north_pole_engineering'
+    entry 67, 'bkool'
+    entry 68, 'cateye'
+    entry 69, 'stages_cycling'
+    entry 70, 'sigmasport'
+    entry 71, 'tomtom'
+    entry 72, 'peripedal'
+    entry 73, 'wattbike'
+    entry 74, 'moxy'
+    entry 77, 'ciclosport'
+    entry 78, 'powerbahn'
+    entry 79, 'acorn_projects_aps'
+    entry 80, 'lifebeam'
+    entry 81, 'bontrager'
+    entry 82, 'wellgo'
+    entry 83, 'scosche'
+    entry 84, 'magura'
+    entry 85, 'woodway'
+    entry 86, 'elite'
+    entry 255, 'development'
+    entry 5759, 'actigraphcorp'
+
+    dict 'session_trigger'
+    entry 0, 'activity_end'
+    entry 1, 'manual'
+    entry 2, 'auto_multi_sport'
+    entry 3, 'fitness_equipment'
+
+    dict 'sport'
+    entry 0, 'generic'
+    entry 1, 'running'
+    entry 2, 'cycling'
+    entry 3, 'transition'
+    entry 4, 'fitness_equipment'
+    entry 5, 'swimming'
+    entry 6, 'basketball'
+    entry 7, 'soccer'
+    entry 8, 'tennis'
+    entry 9, 'american_football'
+    entry 10, 'training'
+    entry 11, 'walking'
+    entry 12, 'cross_country_skiing'
+    entry 13, 'alpine_skiing'
+    entry 14, 'snowboarding'
+    entry 15, 'rowing'
+    entry 16, 'mountaineering'
+    entry 17, 'hiking'
+    entry 18, 'multisport'
+    entry 19, 'paddling'
+    entry 254, 'all'
+
+    dict 'sub_sport'
+    entry 0, 'generic'
+    entry 1, 'treadmill'
+    entry 2, 'street'
+    entry 3, 'trail'
+    entry 4, 'track'
+    entry 5, 'spin'
+    entry 6, 'indoor_cycling'
+    entry 7, 'road'
+    entry 8, 'mountain'
+    entry 9, 'downhill'
+    entry 10, 'recumbent'
+    entry 11, 'cyclocross'
+    entry 12, 'hand_cycling'
+    entry 13, 'track_cycling'
+    entry 14, 'indoor_rowing'
+    entry 15, 'elliptical'
+    entry 16, 'stair_climbing'
+    entry 17, 'lap_swimming'
+    entry 18, 'open_water'
+    entry 19, 'flexibility_training'
+    entry 20, 'strength_training'
+    entry 21, 'warm_up'
+    entry 22, 'match'
+    entry 23, 'exercise'
+    entry 24, 'challenge'
+    entry 25, 'indoor_skiing'
+    entry 26, 'cardio_training'
+    entry 254, 'all'
+
+    dict 'product'
+    entry 8, 'hrm_run_single_byte_product_id'
+    entry 1623, 'fr620'
+    entry 1632, 'fr220'
+    entry 1752, 'hrm_run'
+    entry 1928, 'fr620_japan'
+    entry 1929, 'fr620_china'
+    entry 1930, 'fr220_japan'
+    entry 1931 , 'fr220_china'
+    entry 10007, 'sdm4'
+
+  end
+
+end
+