fitreader 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8e70e256d1754b9d603ebd7c0c0a3e312b14337f
+  data.tar.gz: 6d972f23def9ffb2bce1738bbc892a06a203506d
+SHA512:
+  metadata.gz: b7c416df560642d9e80b0cab03ff5fc78f74679a7bcb6a778417c2df80a058836534493435e92a2409a645c05bfba23a5c3d44cf19581b3ddd36c3fa73e43558
+  data.tar.gz: 5164ac137fcf5d36abe42520a9c38d6776e609a5294c04262792b0c6758d680da8b27018b95ca1339aae59f740227df0d75f552674704b031e6d2c9b7ba58017

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.12.5

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fitreader.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Richard Brodie
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Richard Brodie
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,41 @@
+# Fitreader
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/fitreader`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fitreader'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fitreader
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/fitreader.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "fitreader"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/fitreader.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fitreader/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fitreader"
+  spec.version       = Fitreader::VERSION
+  spec.authors       = ["Richard Brodie"]
+  spec.email         = ["richard@samsari.org"]
+
+  spec.summary       = %q{Library for reading FIT files generated by Garmin devices.}
+  # spec.description   = %q{TODO: Write a longer description or delete this line.}
+  spec.homepage      = "https://github.com/samsari/fitreader"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  # spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "rspec", "~> 3.5"
+  spec.add_development_dependency "pry"
+
+  spec.add_dependency('bindata')
+end

data/lib/fitreader/definition.rb

@@ -0,0 +1,34 @@
+require 'fitreader/field_definition'
+
+module Fitreader
+  class Definition
+    attr_accessor :name, :global_num, :local_num, :fit_msg, :field_definitions, :num_fields
+    def initialize(msg_num, bytes)
+      @local_num = msg_num
+      @architecture = bytes[1].unpack('C').first
+      @global_num = bytes[2..3].unpack('v').first
+      @fit_msg = Static.message[@global_num]
+      @name = Static.enums[:enum_mesg_num][@global_num]
+      @num_fields = bytes[4].unpack('C').first
+    end
+
+    def field(id)
+      @field_definitions.find { |x| x.def_num == id }
+    end
+
+    def add_fields(bytes)
+      bytes.chars.each_slice(3) do |x|
+        fd = FieldDefinition.new(@global_num, x)
+        (@field_definitions ||= []).push(fd)
+      end
+    end
+
+    def content_length
+      @field_definitions.inject(0){|sum,x| sum + x.size}
+    end
+
+    def message_type
+      Static.message[@global_num]
+    end
+  end
+end

data/lib/fitreader/degraded_record.rb

@@ -0,0 +1,38 @@
+require 'fitreader/field_data'
+require 'fitreader/errors'
+
+module Fitreader
+  class DegradedRecord
+    attr_reader :definition, :fields
+    def initialize(definition, bytes)
+      @definition = definition
+      @fields = {}
+
+      start = 0
+      @definition.field_definitions.each do |f|
+        raw = bytes[start...start+=f.size]
+        b = Static.base[f.base_num]
+        data = unpack_data(f, b, raw)
+        @fields[f.def_num] = data
+      end
+    end
+
+    def unpack_data(f, b, raw)
+      if !b[:unpack_type].nil?
+        if b[:size] != f.size && f.base_num != 7
+          data = []
+          s = 0
+          (f.size/b[:size]).times do |_|
+            data.push(raw[s..s+=b[:size]].unpack(b[:unpack_type]).first)
+          end
+        else
+          data = raw.unpack(b[:unpack_type]).first
+        end
+      elsif f.base_num.zero?
+        data = raw.unpack('C').first
+      else
+        data = raw.split(/\0/)[0]
+      end
+    end
+  end
+end

data/lib/fitreader/errors.rb

@@ -0,0 +1,18 @@
+module Fitreader
+  class UnknownFieldTypeError < RuntimeError
+    attr :field, :definition, :data, :reason
+    def initialize(definition, field, data, reason)
+      @field = field
+      @definition = definition
+      @data = data
+      @reason = reason
+    end
+  end
+
+  class UnknownMessageTypeError < RuntimeError
+    attr :definition
+    def initialize(definition)
+      @definition = definition
+    end
+  end
+end

data/lib/fitreader/field_data.rb

@@ -0,0 +1,58 @@
+module Fitreader
+  class FieldData
+    attr_accessor :id, :raw_value, :value, :name, :valid
+
+    def initialize(id, raw_value, type)
+      @id = id
+      @raw_value = raw_value
+      unless type.nil?
+        process_type(raw_value, type)
+      else
+        puts "nil type #{id} - #{raw_value}"
+      end
+    end
+
+    private
+    def process_type(data, type)
+      @name = type[:name]
+      if type[:type][0..3].to_sym == :enum
+        data = Static.enums[type[:type]][data]
+      elsif type[:type] == :date_time
+        data = process_datetime(data)
+      elsif type[:type] == :local_date_time
+        data = process_local_datetime(data)
+      elsif type[:type] == :coordinates
+        data = process_coord(data)
+      end
+
+      if type[:scale] != 0
+        if data.class == Array
+          data = data.collect{|x| (x*1.0)/type[:scale]}
+        else
+          data = (data*1.0)/type[:scale]
+        end
+      end
+
+      if type[:offset] != 0
+        if data.class == Array
+          data = data.collect{|x| x - type[:offset]}
+        else
+          data = data - type[:offset]
+        end
+      end
+      @value = data
+    end
+
+    def process_local_datetime(data)
+      t = Time.new(1989, 12, 31, 0, 0, 0, '+02:00').utc.to_i
+      Time.at(data+t)
+    end
+    def process_datetime(data)
+      t = Time.new(1989, 12, 31, 0, 0, 0, '+00:00').utc.to_i
+      Time.at(data+t).utc
+    end
+    def process_coord(data)
+      data * ( 180.0 / 2**31 )
+    end
+  end
+end

data/lib/fitreader/field_definition.rb

@@ -0,0 +1,15 @@
+module Fitreader
+  class FieldDefinition
+    attr_accessor :def_num, :size, :base_num
+
+    def initialize(msg_num, bytes)
+      @def_num = bytes[0].unpack('C').first
+      @size = bytes[1].unpack('C').first
+      # @single_byte = bytes[2].unpack('C').first & ENDIAN_ABILITY == 0
+      @base_num = bytes[2].unpack('C').first & BASE_TYPE_NUM
+    end
+
+    ENDIAN_ABILITY = 128
+    BASE_TYPE_NUM = 31
+  end
+end

data/lib/fitreader/file_header.rb

@@ -0,0 +1,17 @@
+class FileHeader
+  attr_accessor :header_size, :protocol_version,
+  :profile_version, :num_records, :valid_file, :crc
+
+  def initialize(bytes)
+    @header_size = bytes[0].unpack('C').first
+    @protocol_version = bytes[1].unpack('C').first
+    @profile_version = bytes[2..3].unpack('v').first
+    @num_records = bytes[4..7].unpack('V').first
+    @valid_file = bytes[8..11] == ".FIT"
+    @crc = bytes[12..13].unpack('v').first
+  end
+
+  def to_s
+    "size: #{header_size}, proto_v: #{protocol_version}, prof_v: #{profile_version}, records: #{num_records}"
+  end
+end

data/lib/fitreader/fitfile.rb

@@ -0,0 +1,61 @@
+require 'fitreader/file_header'
+require 'fitreader/record_header'
+require 'fitreader/definition'
+require 'fitreader/record'
+require 'fitreader/degraded_record'
+require 'fitreader/static'
+
+module Fitreader
+  class FitFile
+    attr_reader :header, :records, :defs, :file, :error_records
+
+    def initialize(path)
+      @file = File.open(path, 'rb')
+      @header = FileHeader.new(@file.read(14))
+      if valid?
+        @defs = {}
+        @records = []
+        @error_records = []
+        while @file.pos < @header.num_records do
+          process_next_record
+        end
+        puts "number of bad records found: #{@error_records.length}"
+      end
+    end
+
+    private
+    def valid?
+      @header.valid_file
+    end
+
+    def process_next_record
+      h = RecordHeader.new(@file.read(1).unpack("C").first)
+      dr = @defs[h.local_num]
+      if h.header_type == :definition
+        dr = Definition.new(h.local_num, @file.read(5))
+        dr.add_fields(@file.read(dr.num_fields*3))
+        @defs[h.local_num] = dr
+      elsif h.header_type == :data
+        unless dr.nil?
+          begin
+            data = @file.read(dr.content_length)
+            datr = Record.new(dr, data)
+            @records.push(datr)
+          rescue UnknownMessageTypeError => error
+            # @error_records.push(error.definition)
+            puts error
+            degraded = DegradedRecord.new(dr, data)
+            @error_records.push degraded
+          end
+        else
+          msg = "no record def found! #{h.local_msg_num}"
+          raise msg
+        end
+      elsif h.header_type == :timestamp
+        raise "timestamp :: msg_num: #{h.local_msg_num}, offset: #{h.timestamp_offset}"
+      else
+        raise "not a valid record"
+      end
+    end
+  end
+end

data/lib/fitreader/record.rb

@@ -0,0 +1,170 @@
+require 'fitreader/field_data'
+require 'fitreader/errors'
+
+module Fitreader
+  class Record
+    attr_reader :definition, :fields, :error_fields
+    def initialize(definition, bytes)
+      @definition = definition
+      @fields = {}
+      @error_fields = {}
+
+      unless @definition.fit_msg.nil?
+        start = 0
+        @definition.field_definitions.each do |f|
+          raw = bytes[start...start+=f.size]
+          b = Static.base[f.base_num]
+          data = unpack_data(f, b, raw)
+          begin
+            process_data(f.def_num, b[:invalid], data)
+          rescue UnknownFieldTypeError => error
+            push_error error.reason, error.field, error.data
+            # puts error unless error.reason == :invalid
+          end
+        end
+
+        if @definition.global_num == 21
+          process_event
+        elsif @definition.global_num == 23
+          process_deviceinfo
+        end
+      else
+        msg = "no known message type: #{@definition.global_num}"
+        raise UnknownMessageTypeError.new(definition), msg, caller
+      end
+    end
+
+    def unpack_data(f, b, raw)
+      if !b[:unpack_type].nil?
+        if b[:size] != f.size && f.base_num != 7
+          data = []
+          s = 0
+          (f.size/b[:size]).times do |_|
+            data.push(raw[s..s+=b[:size]].unpack(b[:unpack_type]).first)
+          end
+        else
+          data = raw.unpack(b[:unpack_type]).first
+        end
+      elsif f.base_num.zero?
+        data = raw.unpack('C').first
+      else
+        data = raw.split(/\0/)[0]
+      end
+    end
+
+    def process_data(fieldDefNum, invalid, data)
+      field_def = @definition.fit_msg[fieldDefNum]
+      unless field_def.nil?
+        # populate invalid
+        if data.is_a?(Array)
+          data = data.select{ |x| x != invalid } if data.is_a?(Array)
+          invalid = data.empty?
+        else
+          invalid = data == invalid
+        end
+
+        unless invalid
+          @fields[fieldDefNum] = FieldData.new(fieldDefNum, data, field_def)
+        else
+          msg = "invalid field data (#{data}) processed for field number [#{fieldDefNum}::#{field_def[:name]}] in message (#{@definition.global_num}::#{@definition.name})"
+          raise UnknownFieldTypeError.new(@definition, fieldDefNum, data, :invalid), msg, caller
+        end
+      else
+        msg = "invalid field [#{fieldDefNum}] encountered for message [#{@definition.global_num}::#{@definition.name}] with data [#{data}]"
+        raise UnknownFieldTypeError.new(@definition, fieldDefNum, data, :unknown), msg, caller
+      end
+    end
+
+    def temporal?
+      fields.key?(253)
+    end
+
+    def push_error(reason, field, data)
+      (@error_fields[reason] ||= {})[field] = data
+    end
+
+    # :file_id 1
+    # :user_profile 1
+    # :zones_target 1
+    # :session 1
+    # :lap 1
+    # :record 2899
+    # :event 73
+    # :source 58
+    # :device_info 14
+    # :activity 1
+    # :file_creator 1
+    # :training_file 1
+    # :battery_info 40
+    # :sensor_info 3
+    def type
+      case @definition.name
+      when :file_id, :user_profile, :zones_target, :session
+        :ride
+      when condition
+        :lap
+      else
+        :time
+      end
+    end
+
+    def get_val(key)
+      if key.class == String
+        f = @fields.values.detect{|v| v.name == key}
+      elsif key.class == Integer
+        f = @fields[key]
+      end
+      return f != nil ? f.value : nil
+    end
+
+    def get_raw(key)
+      if key.class == String
+        f = @fields.values.detect{|v| v.name == key}
+      elsif key.class == Integer
+        f = @fields[key]
+      end
+      return !f.nil? ? f.raw_value : nil
+    end
+
+    def to_s
+      s = "#{name} (#{definition.global_num})\n"
+      @fields.each do |_, v|
+        s += v.to_s
+      end
+      "#{s}\n"
+    end
+
+    private
+    def process_event
+      t = @fields[0]
+      d = @fields[3]
+      d.value = case t.value
+                when :rear_gear_change, :front_gear_change
+                  process_gear_change(d.raw_value)
+                end
+    end
+
+    def process_deviceinfo
+      d = @fields[1]
+      t = @fields[25]
+      if !d.nil? && !t.nil?
+        d.value = case t.value
+                  when :antplus
+                    Static.enums[:antplus_device_type][d.raw_value]
+                  end
+      end
+      d = @fields[4]
+      t = @fields[2]
+      if !d.nil? && !t.nil?
+        d.value = case t.value
+                  when :garmin, :dynastream, :dynastream_oem
+                    Static.enums[:enum_garmin_product][d.raw_value]
+                  end
+      end
+    end
+
+    def process_gear_change(data)
+      [data].pack('V*').unpack('C*')
+    end
+  end
+end

data/lib/fitreader/record_header.rb

@@ -0,0 +1,31 @@
+module Fitreader
+  class RecordHeader
+    attr_accessor :header_type, :local_num,
+    :timestamp_offset, :developer
+
+    def initialize(byte)
+      timstamp_header = byte & TIMESTAMP_RECORD > 0
+      unless timstamp_header
+        @header_type = byte & DEFINITION_MESSAGE > 0 ? :definition : :data
+        @local_num = byte & NORMAL_TYPE
+        if byte & DEVELOPER_DATA == DEVELOPER_DATA
+          @developer = true
+          puts "developer"
+        end
+      else
+        @header_type = :timestamp
+        @local_num = byte & TIMESTAMP_TYPE
+        @timestamp_offset = byte & TIMESTAMP_OFFSET
+        puts "timestamp header: #{@local_msg_num} :: #{@timestamp_offset}"
+      end
+    end
+
+    private
+    TIMESTAMP_RECORD = 0b10000000
+    DEFINITION_MESSAGE = 0b01000000
+    DEVELOPER_DATA = 0b00100000
+    NORMAL_TYPE = 0b00001111
+    TIMESTAMP_TYPE = 0b01100000
+    TIMESTAMP_OFFSET = 0b00011111
+  end
+end