fitreader 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8e70e256d1754b9d603ebd7c0c0a3e312b14337f
-  data.tar.gz: 6d972f23def9ffb2bce1738bbc892a06a203506d
+  metadata.gz: 6dc32742ab1e01f369d27408f7cab25fcde47e24
+  data.tar.gz: 41f1381a24b1985958e115f3f1033866ad9a005b
 SHA512:
-  metadata.gz: b7c416df560642d9e80b0cab03ff5fc78f74679a7bcb6a778417c2df80a058836534493435e92a2409a645c05bfba23a5c3d44cf19581b3ddd36c3fa73e43558
-  data.tar.gz: 5164ac137fcf5d36abe42520a9c38d6776e609a5294c04262792b0c6758d680da8b27018b95ca1339aae59f740227df0d75f552674704b031e6d2c9b7ba58017
+  metadata.gz: 6b89c5a123826b9a1ff2ae79b5f7be047f9bb35d44af1db1664de2289bde313465635a145b555228559c01d2f1de4f8f051933bd1e39b7e8758019c514fbe535
+  data.tar.gz: 2b9af2f2aa0b6502f8b7465acebed731ee819b207640898b659b16c0514d73e04caacebd04afc5375daa5da2b66fa84bd4e652f0edfc29831c35312204c628b4

data/README.md

@@ -1,8 +1,6 @@
 # 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
+Fitreader is a small gem used for read and decoding FIT files generated by various sports devices. Currently it has only been designed specifically to read files produced by a Garmin Edge 1000. It will probably mostly work out of the box with other file sources, but will probably not work 100% perfectly unless it's a Garmin cycling computer.   
 
 ## Installation
 
@@ -22,20 +20,115 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+To use this gem in a ruby or rails application, simply add
+
+```ruby
+gem 'fitreader'
+```
+
+to the Gemfile and then
+
+```ruby
+require 'fitreader'
+```
+
+to the class you wish to call it from. After that, it's a simple matter of calling
+
+```ruby
+Fitreader.read(path_to_fit_file)
+```
+
+All of the interface and convenience functions can be found in lib/fitreader.rb.
+
+After reading a FIT file, the file header can be inspected by calling
+
+```ruby
+Fitreader.header
+```
+
+A digest of the records found in the file is shown with
+
+```ruby
+Fitreader.available_records
+```
+
+which will return a list similar to the following, showing respectively the global_message_number (as defined in the FIT SDK), the name of the record type, and the number of records parsed
+
+```ruby
+[[0, :file_id, 1],
+ [3, :user_profile, 1],
+ [7, :zones_target, 1],
+ [18, :session, 1],
+ [19, :lap, 1],
+ [20, :record, 2899],
+ [21, :event, 73],
+ [22, :source, 58],
+ [23, :device_info, 14],
+ [34, :activity, 1],
+ [49, :file_creator, 1],
+ [72, :training_file, 1],
+ [104, :battery_info, 40],
+ [147, :sensor_info, 3]]
+```
+
+Armed with this information, we can call
+
+```ruby
+Fitreader.get_message_type filter
+```
+
+where filter is either the global_number or the name supplied by the previous command, for example
+
+```ruby
+Fitreader.get_message_type 18
+Fitreader.get_message_type :session
+```
+
+will both fetch the session record(s) in the form of a MessageType object. This object contains three fields: a definition, an array of records and an array of undefined_records.
+
+The definition contains metadata from a combination of the FIT file itself and the SKD. I will write more detailed information, but basically this information tells us how to interpret the actual data. Of most relevance, it tells us the name and datatype of each field we will find in records of this type.
+
+The records array contains a list or Record objects. A Record object contains a fields array and an error_fields array. The fields array is a list of the actual data contined within this record, for example timestamp, or coordinated, etc. The particular FieldData object includes the name of the field (also found in the definition), along with the raw_value and the processed value which may differ in the case of, for example, a coordinate.
+
+The error_fields array contains any fields defined in the FIT file itself that aren't defined within the SDK. Without the SKD we can most likely never know what the field represents or whether the raw value would need further processing to make sense to us. These are included mostly for debugging and future convenience sake.
+
+The results of this function are probably a lot more data that we generally need, so a convenience function is included that distills the results of the previous call into a more efficient dataset
+
+```ruby
+Fitreader.record_values 20
+Fitreader.record_values :record
+```
+
+This will return an array of hashes, one hash for each record of the specified type. The hashes contain only the field name and value, for example
+
+```ruby
+{:timestamp=>2016-04-09 11:19:51 UTC,
+ :position_lat=>57.711100755259395,
+ :position_long=>11.992837116122246,
+ :distance=>78.94,
+ :altitude=>14.200000000000045,
+ :speed=>3.835,
+ :heart_rate=>103,
+ :cadence=>0,
+ :temperature=>12,
+ :fractional_cadence=>0.0},
+ ```
+
+ Some things to watch out for:
+
+ - speed is recorded as m/s in my files, rather than kph as one might expect.
 
 ## 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.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rspec spec` 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).
+To install this gem onto your local machine from a clone of the repo, run `bundle exec rake install`.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/fitreader.
+Bug reports and pull requests are welcome on GitHub at https://github.com/samsari/fitreader.
 
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/fitreader.gemspec

@@ -30,9 +30,8 @@ Gem::Specification.new do |spec|
 
   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')
+  # spec.add_dependency('bindata')
 end

data/lib/fitreader/degraded_record.rb

@@ -3,13 +3,12 @@ require 'fitreader/errors'
 
 module Fitreader
   class DegradedRecord
-    attr_reader :definition, :fields
+    attr_reader :fields
     def initialize(definition, bytes)
-      @definition = definition
       @fields = {}
 
       start = 0
-      @definition.field_definitions.each do |f|
+      definition.field_definitions.each do |f|
         raw = bytes[start...start+=f.size]
         b = Static.base[f.base_num]
         data = unpack_data(f, b, raw)

data/lib/fitreader/errors.rb

@@ -10,9 +10,9 @@ module Fitreader
   end
 
   class UnknownMessageTypeError < RuntimeError
-    attr :definition
-    def initialize(definition)
-      @definition = definition
-    end
+    # attr :definition
+    # def initialize(definition)
+    #   @definition = definition
+    # end
   end
 end

data/lib/fitreader/fitfile.rb

@@ -3,23 +3,23 @@ require 'fitreader/record_header'
 require 'fitreader/definition'
 require 'fitreader/record'
 require 'fitreader/degraded_record'
+require 'fitreader/message_type'
 require 'fitreader/static'
 
 module Fitreader
   class FitFile
-    attr_reader :header, :records, :defs, :file, :error_records
+    attr_reader :header, :messages, :file
 
     def initialize(path)
       @file = File.open(path, 'rb')
       @header = FileHeader.new(@file.read(14))
       if valid?
         @defs = {}
-        @records = []
-        @error_records = []
+        @messages = {}
         while @file.pos < @header.num_records do
           process_next_record
         end
-        puts "number of bad records found: #{@error_records.length}"
+        # puts "number of bad records found: #{@error_records.length}"
       end
     end
 
@@ -35,17 +35,18 @@ module Fitreader
         dr = Definition.new(h.local_num, @file.read(5))
         dr.add_fields(@file.read(dr.num_fields*3))
         @defs[h.local_num] = dr
+
+        m = MessageType.new(dr)
+        @messages[dr.global_num] = m
       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
+            @messages[dr.global_num].records.push datr
+          rescue UnknownMessageTypeError
             degraded = DegradedRecord.new(dr, data)
-            @error_records.push degraded
+            @messages[dr.global_num].undefined_records.push degraded
           end
         else
           msg = "no record def found! #{h.local_msg_num}"

data/lib/fitreader/message_type.rb

@@ -0,0 +1,12 @@
+module Fitreader
+  class MessageType
+    attr_reader :definition, :records
+    attr_accessor :undefined_records
+
+    def initialize(definition)
+      @definition = definition
+      @records = []
+      @undefined_records = []
+    end
+  end
+end

data/lib/fitreader/record.rb

@@ -5,32 +5,32 @@ module Fitreader
   class Record
     attr_reader :definition, :fields, :error_fields
     def initialize(definition, bytes)
-      @definition = definition
+      # definition = definition
       @fields = {}
       @error_fields = {}
 
-      unless @definition.fit_msg.nil?
+      unless definition.fit_msg.nil?
         start = 0
-        @definition.field_definitions.each do |f|
+        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)
+            process_data(f.def_num, b[:invalid], data, definition)
           rescue UnknownFieldTypeError => error
             push_error error.reason, error.field, error.data
             # puts error unless error.reason == :invalid
           end
         end
 
-        if @definition.global_num == 21
+        if definition.global_num == 21
           process_event
-        elsif @definition.global_num == 23
+        elsif definition.global_num == 23
           process_deviceinfo
         end
       else
-        msg = "no known message type: #{@definition.global_num}"
-        raise UnknownMessageTypeError.new(definition), msg, caller
+        msg = "no known message type: #{definition.global_num}"
+        raise UnknownMessageTypeError.new, msg, caller
       end
     end
 
@@ -52,8 +52,8 @@ module Fitreader
       end
     end
 
-    def process_data(fieldDefNum, invalid, data)
-      field_def = @definition.fit_msg[fieldDefNum]
+    def process_data(fieldDefNum, invalid, data, definition)
+      field_def = definition.fit_msg[fieldDefNum]
       unless field_def.nil?
         # populate invalid
         if data.is_a?(Array)
@@ -66,12 +66,12 @@ module Fitreader
         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
+          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
+        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
 
@@ -98,7 +98,7 @@ module Fitreader
     # :battery_info 40
     # :sensor_info 3
     def type
-      case @definition.name
+      case definition.name
       when :file_id, :user_profile, :zones_target, :session
         :ride
       when condition

data/lib/fitreader/version.rb

@@ -1,3 +1,3 @@
 module Fitreader
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/lib/fitreader.rb

@@ -13,30 +13,38 @@ module Fitreader
   end
 
   def self.available_records
-    @f.records.collect { |x| [x.definition.global_num, x.definition.name] }
-      .group_by { |i| i }
+    @f.messages
+      .select { |x,y| !y.definition.name.nil? }
+      .select { |x,y| !y.records.length.zero? }
+      .collect { |x| [x[0], x[1].definition.name, x[1].records.length] }
       .sort
-      .collect { |k, v| k << v.length }
   end
 
-  def self.filter_by_record(filter)
+  def self.get_message_type(filter)
     if filter.is_a?(Symbol)
-      @f.records.select { |x| x.definition.name == filter }
+      res = @f.messages.find { |_,y| y.definition.name == filter}
+      res[1] unless res.nil?
+      binding.pry
     elsif filter.is_a?(Integer)
-      @f.records.select { |x| x.definition.global_num == filter }
+      @f.messages[filter]
     else
       raise ArgumentError, "needs a string or a symbol"
     end
   end
 
   def self.record_values(filter)
-    records = filter_by_record filter
-    records.collect {|x| x.fields.values.collect{|z| [z.name, z.value]}}.collect{|y| y.to_h}
+    message = get_message_type filter
+    message.records.collect {|x| x.fields.values.collect{|z| [z.name, z.value]}}.collect{|y| y.to_h}
   end
 
-  # def self.error_fields(filter=nil)
-  #   @f.records.
-  # end
+  def self.error_messages
+    @f.messages.select { |_,v| !v.undefined_records.empty? }
+  end
+
+  def self.error_fields(filter)
+    message = get_message_type filter
+    message.records.select{|x| !x.error_fields.empty?}.collect{|y| y.error_fields}
+  end
 
   # def self.filter_by_scope(filter)
   #   valid = Static.scope.include? filter

data/spec/fitreader_interfaces_spec.rb

@@ -0,0 +1,45 @@
+# encoding: utf-8
+require 'fitreader'
+
+describe Fitreader do
+  describe 'has functioning interfaces' do
+    before do
+      @path = File.join(File.dirname(__FILE__), '2016-04-09-13-19-18.fit')
+      Fitreader.read(@path)
+    end
+
+    it 'has a valid header' do
+      expect(Fitreader.header).not_to be_nil
+      expect(Fitreader.header.num_records).to be(89139)
+    end
+
+    it 'has valid records' do
+      expect(Fitreader.available_records).not_to be_nil
+      expect(Fitreader.available_records.length).to be(14)
+    end
+
+    it 'can fetch an existing message by number' do
+      expect(Fitreader.get_message_type 18).to be_a(Fitreader::MessageType)
+    end
+    it 'can fetch an existing message by name' do
+      expect(Fitreader.get_message_type :session).to be_a(Fitreader::MessageType)
+    end
+    it 'cannot fetch a non existing message by number' do
+      expect(Fitreader.get_message_type 1234).to be(nil)
+    end
+    it 'cannot fetch a non existing message by name' do
+      expect(Fitreader.get_message_type :non_existant).to be(nil)
+    end
+
+    it 'can return name-value data' do
+      expect(Fitreader.record_values :session).to be_a(Array)
+    end
+    it 'can return error-fields' do
+      expect(Fitreader.error_fields :record).to be_a(Array)
+    end
+
+    it 'can return error-messages' do
+      expect(Fitreader.error_messages).to be_a(Hash)
+    end
+  end
+end

data/spec/fitreader_readfile_spec.rb

@@ -0,0 +1,17 @@
+require 'fitreader'
+
+describe Fitreader do
+  describe 'read fit file' do
+    before do
+      @path = File.join(File.dirname(__FILE__), '2016-04-09-13-19-18.fit')
+    end
+
+    it 'test file exists' do
+      expect(File.exist?(@path)).to eql(true)
+    end
+
+    it 'parses file without exceptions' do
+      expect { Fitreader.read(@path) }.not_to raise_error
+    end
+  end
+end

data/spec/fitreader_static_spec.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+require 'fitreader'
+
+describe Fitreader::Static do
+  it 'const is loaded' do
+    expect(Fitreader::Static.enums.class).to eql(Hash)
+  end
+
+  it 'const has data' do
+    expect(Fitreader::Static.enums[:enum_file][1]).to eql(:device)
+  end
+
+  it 'scope is readable' do
+    expect(Fitreader::Static.scope).to include(:ride)
+    expect(Fitreader::Static.scope).not_to include(:bike)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fitreader
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Richard Brodie
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-25 00:00:00.000000000 Z
+date: 2016-12-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,20 +66,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: bindata
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: 
 email:
 - richard@samsari.org
@@ -105,6 +91,7 @@ files:
 - lib/fitreader/field_definition.rb
 - lib/fitreader/file_header.rb
 - lib/fitreader/fitfile.rb
+- lib/fitreader/message_type.rb
 - lib/fitreader/record.rb
 - lib/fitreader/record_header.rb
 - lib/fitreader/sdk/constants.yml
@@ -113,7 +100,9 @@ files:
 - lib/fitreader/version.rb
 - schema
 - spec/2016-04-09-13-19-18.fit
-- spec/fitreader_spec.rb
+- spec/fitreader_interfaces_spec.rb
+- spec/fitreader_readfile_spec.rb
+- spec/fitreader_static_spec.rb
 - test/fitreader_test.rb
 - test/test_helper.rb
 homepage: https://github.com/samsari/fitreader
@@ -142,6 +131,8 @@ specification_version: 4
 summary: Library for reading FIT files generated by Garmin devices.
 test_files:
 - spec/2016-04-09-13-19-18.fit
-- spec/fitreader_spec.rb
+- spec/fitreader_interfaces_spec.rb
+- spec/fitreader_readfile_spec.rb
+- spec/fitreader_static_spec.rb
 - test/fitreader_test.rb
 - test/test_helper.rb

data/spec/fitreader_spec.rb

@@ -1,55 +0,0 @@
-# encoding: utf-8
-require 'fitreader'
-
-describe Fitreader::Static do
-  it 'const is loaded' do
-    expect(Fitreader::Static.enums.class).to eql(Hash)
-  end
-
-  it 'const has data' do
-    expect(Fitreader::Static.enums[:enum_file][1]).to eql(:device)
-  end
-
-  it 'scope is readable' do
-    expect(Fitreader::Static.scope).to include(:ride)
-    expect(Fitreader::Static.scope).not_to include(:bike)
-  end
-end
-
-describe Fitreader do
-  describe 'read fit file' do
-    before do
-      @path = File.join(File.dirname(__FILE__), '2016-04-09-13-19-18.fit')
-    end
-
-    it 'test file exists' do
-      expect(File.exist?(@path)).to eql(true)
-    end
-
-    it 'parses file without exceptions' do
-      expect { Fitreader.read(@path) }.not_to raise_error
-    end
-  end
-
-  describe 'has functioning interfaces' do
-    before do
-      @path = File.join(File.dirname(__FILE__), '2016-04-09-13-19-18.fit')
-      Fitreader.read(@path)
-    end
-
-    it 'has a valid header' do
-      expect(Fitreader.header).not_to be_nil
-      expect(Fitreader.header.num_records).to be(89139)
-    end
-
-    it 'has valid records' do
-      expect(Fitreader.available_records).not_to be_nil
-      expect(Fitreader.available_records.length).to be(14)
-      binding.pry
-    end
-
-    it 'can return name-value data' do
-      expect(Fitreader.record_values :session).to be(Array)
-    end
-  end
-end