spektrum-log 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 80e40d14225d2fc99ad38744cbf85752aca4832b
+  data.tar.gz: a15dc90df0edd293bd38bfc852e596063e88ddb8
+SHA512:
+  metadata.gz: 46d5b8afdaefe491852f77fbacc85cf48fb20a93ef33cd437e130ae324dd3c3391819f34a23beacdf129327da13735c27de8caef9a4dab046b1a9ceda24f822c
+  data.tar.gz: 4f46200e10324cf7024f440b1f8430265923aeb212b54c2539ec8716c477756efb0ca0a217ded1c98b08aea300243cdfe51dc571b396dcf2255a77f67e75b389

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.idea

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,7 @@
+rvm:
+ - 1.9.3
+ - 2.0.0
+ - jruby
+
+notifications:
+ disabled: true

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Nick Veys
+
+MIT License
+
+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,35 @@
+# Spektrum::Log [![Build Status](https://travis-ci.org/code-lever/spektrum-log.png)](https://travis-ci.org/code-lever/spektrum-log)
+
+TODO: Write a gem description
+
+Research:
+
+* http://www.rcgroups.com/forums/showthread.php?t=1726960
+* http://www.rcgroups.com/forums/showthread.php?t=1725173
+* http://www.rcgroups.com/forums/showthread.php?t=1725173&page=6#86 -- more refinement
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'spektrum-log'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install spektrum-log
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+task :default => :spec

data/lib/spektrum-log.rb

@@ -0,0 +1,5 @@
+require "spektrum-log/flight"
+require "spektrum-log/headers"
+require "spektrum-log/reader"
+require "spektrum-log/records"
+require "spektrum-log/version"

data/lib/spektrum-log/flight.rb

@@ -0,0 +1,54 @@
+module Spektrum
+  module Log
+
+    class Flight
+
+      attr_reader :headers, :records
+
+      def initialize(headers, records)
+        @headers = headers
+        @records = records
+      end
+
+      def duration
+        @records.empty? ? 0 : @records.last.timestamp - @records.first.timestamp
+      end
+
+      def empty?
+        @records.empty?
+      end
+
+      def bind_type
+        case @headers.first.raw_data[2].unpack('C')[0]
+        when 0x01..0x02
+          'DSM2'
+        when 0x03..0x04
+          'DSMX'
+        else
+          'Unknown'
+        end
+      end
+
+      def model_name
+        @headers.first.raw_data[8..18].unpack('Z*')[0]
+      end
+
+      def model_number
+        @headers.first.raw_data[0].unpack('C')[0] + 1
+      end
+
+      def model_type
+        case @headers.first.raw_data[1].unpack('C')[0]
+        when 0x00
+          'Fixed Wing'
+        when 0x01
+          'Helicopter'
+        else
+          'Unknown'
+        end
+      end
+
+    end
+
+  end
+end

data/lib/spektrum-log/headers.rb

@@ -0,0 +1,23 @@
+module Spektrum
+  module Log
+
+    class Header
+
+      attr_reader :raw_data
+
+      def initialize raw_data
+        @raw_data = raw_data
+      end
+
+    end
+
+    class Headers
+
+      def self.create raw_data
+        Header.new(raw_data)
+      end
+
+    end
+
+  end
+end

data/lib/spektrum-log/reader.rb

@@ -0,0 +1,56 @@
+module Spektrum
+  module Log
+
+    class Reader
+
+      attr_reader :records, :flights
+
+      def initialize filename
+        headers = []
+        headers_complete = false
+        records = []
+        @flights = []
+
+        File.open(filename, 'rb') do |file|
+          loop do
+            first4 = file.read(4)
+            if first4.nil?
+              if headers_complete || !records.empty?
+                # we have records, this is a new entry
+                @flights << Flight.new(headers, records)
+                headers = []
+                records = []
+              end
+              break
+            end
+
+            first = first4.unpack('V')[0]
+            if 0xFFFFFFFF == first
+
+              if headers_complete || !records.empty?
+                # we have records, this is a new entry
+                @flights << Flight.new(headers, records)
+                headers = []
+                records = []
+                headers_complete = false
+              end
+
+              rest = file.read(32)
+              headers << Headers.create(rest)
+
+              headers_complete = rest.unpack('S')[0] == 0x1717
+
+            else
+              type = file.read(1).unpack('C')[0]
+              rest = file.read(15)
+              records << Records.create(type, first, rest)
+            end
+          end
+        end
+
+      end
+
+    end
+
+  end
+end

data/lib/spektrum-log/records.rb

@@ -0,0 +1,231 @@
+module Spektrum
+  module Log
+
+    class Record
+
+      attr_reader :timestamp
+
+      def initialize timestamp, raw_data
+        @timestamp = timestamp
+        @raw_data = raw_data
+      end
+
+      protected
+
+      def byte_field range
+        @raw_data[range].unpack('C')[0]
+      end
+
+      def hex_byte_field range
+        @raw_data[range].unpack('H*')[0].to_i
+      end
+
+      def two_byte_field range, endian = :big
+        @raw_data[range].unpack(endian == :big ? 'n' : 'v')[0]
+      end
+
+      def four_byte_field range, endian = :big
+        @raw_data[range].unpack(endian == :big ? 'N' : 'V')[0]
+      end
+
+    end
+
+    class AltimeterRecord < Record
+
+      def initialize timestamp, raw_data
+        super timestamp, raw_data
+      end
+
+      def altitude
+        two_byte_field(1..2)
+      end
+
+    end
+
+    class FlightLogRecord < Record
+
+      def initialize timestamp, raw_data
+        super timestamp, raw_data
+      end
+
+      def receiver_voltage
+        volt = two_byte_field(13..14)
+        volt / 100.0
+      end
+
+    end
+
+    class GForceRecord < Record
+
+      def initialize timestamp, raw_data
+        super timestamp, raw_data
+      end
+
+      def x
+        x = two_byte_field(1..2)
+        x
+      end
+
+      def y
+        y = two_byte_field(3..4)
+        y
+      end
+
+      def z
+        z = two_byte_field(5..6)
+        z
+      end
+
+      def x_max
+        x = two_byte_field(7..8)
+        x
+      end
+
+      def y_max
+        y = two_byte_field(9..10)
+        y
+      end
+
+      def z_max
+        z = two_byte_field(11..12)
+        z
+      end
+
+    end
+
+    class GPSRecord1 < Record
+
+      def initialize timestamp, raw_data
+        super timestamp, raw_data
+      end
+
+      def altitude
+        alt = two_byte_field(1..2, :little)
+        alt
+      end
+
+      def latitude
+        a = byte_field(3) # 1/100 degree-second
+        b = byte_field(4) # degree-seconds
+        c = byte_field(5) # degree-minutes
+        d = byte_field(6) # degrees
+        [d, c, b, a]
+      end
+
+      def longitude
+        a = byte_field(7) # 1/100 degree-second
+        b = byte_field(8) # degree-seconds
+        c = byte_field(9) # degree-minutes
+        d = byte_field(10) # degrees
+        [d, c, b, a]
+      end
+
+      def heading
+        head = two_byte_field(11..12, :little)
+        head / 10.0
+      end
+
+    end
+
+    class GPSRecord2 < Record
+
+      def initialize timestamp, raw_data
+        super timestamp, raw_data
+      end
+
+      # :knots, :mph, :kph
+      def speed unit = :knots
+        speed = two_byte_field(1..2, :little)
+        speed = case unit
+        when :knots
+          speed / 10.0
+        when :mph
+          speed * 0.115
+        when :kph
+          speed * 0.185
+        end
+        speed.round(2)
+      end
+
+      def time
+        ax = hex_byte_field(3) # hundredths
+        bx = hex_byte_field(4) # seconds
+        cx = hex_byte_field(5) # minutes
+        dx = hex_byte_field(6) # hours
+
+        [dx, cx, bx + (ax / 100.0)] # hh:mm:ss.sss
+      end
+
+      def sats
+        sats = byte_field(7)
+        sats
+      end
+
+    end
+
+    class MysteryRecord < Record
+
+      def initialize timestamp, raw_data
+        super timestamp, raw_data
+      end
+
+    end
+
+    class SpeedRecord < Record
+
+      def initialize timestamp, raw_data
+        super timestamp, raw_data
+      end
+
+      def speed
+        speed = two_byte_field(1..2)
+        speed
+      end
+
+    end
+
+    class VoltsTemperatureRPMRecord < Record
+
+      def initialize timestamp, raw_data
+        super timestamp, raw_data
+      end
+
+      def rpms pole_count
+        rpm = two_byte_field(1..2)
+        rpm * pole_count
+      end
+
+      def voltage
+        volt = two_byte_field(3..4)
+        volt / 100.0
+      end
+
+      def temperature
+        temp = two_byte_field(5..6)
+        temp
+      end
+
+    end
+
+    class Records
+
+      @@types = {
+          0x11 => SpeedRecord,
+          0x12 => AltimeterRecord,
+          0x14 => GForceRecord,
+          0x16 => GPSRecord1,
+          0x17 => GPSRecord2,
+          0x7E => VoltsTemperatureRPMRecord,
+          0x7F => FlightLogRecord,
+          0xFE => VoltsTemperatureRPMRecord,
+          0xFF => FlightLogRecord,
+      }
+
+      def self.create type, timestamp, raw_data
+        @@types.fetch(type, MysteryRecord).new(timestamp, raw_data)
+      end
+
+    end
+
+  end
+end

data/lib/spektrum-log/version.rb

@@ -0,0 +1,5 @@
+module Spektrum
+  module Log
+    VERSION = "0.0.1"
+  end
+end

data/spec/flight_spec.rb

@@ -0,0 +1,233 @@
+require 'spec_helper'
+
+describe Spektrum::Log::Flight do
+
+  context 'data file 1.TLM' do
+
+    let(:reader) { Spektrum::Log::Reader.new(data_file('1.TLM')) }
+
+    context 'flight 1' do
+
+      subject { reader.flights[0] }
+
+      it { should have(4).headers }
+
+      it { should have(191).records }
+
+      its(:duration) { should eql(1148) }
+
+      its(:bind_type) { should eql('DSMX') }
+
+      its(:model_name) { should eql('Stinson') }
+
+      its(:model_number) { should eql(1) }
+
+      its(:model_type) { should eql('Fixed Wing') }
+
+    end
+
+    context 'flight 2' do
+
+      subject { reader.flights[1] }
+
+      it { should have(4).headers }
+
+      it { should have(634).records }
+
+      its(:duration) { should eql(3798) }
+
+    end
+
+    context 'flight 3' do
+
+      subject { reader.flights[2] }
+
+      it { should have(4).headers }
+
+      it { should have(641).records }
+
+      its(:duration) { should eql(3842) }
+
+    end
+
+  end
+
+  context 'data file 2.TLM' do
+
+    let(:reader) { Spektrum::Log::Reader.new(data_file('2.TLM')) }
+
+    context 'flight 1' do
+
+      subject { reader.flights[0] }
+
+      it { should have(5).headers }
+
+      it { should have(260).records }
+
+      its(:duration) { should eql(570) }
+
+    end
+
+  end
+
+  context 'data file 3.TLM' do
+
+    let(:reader) { Spektrum::Log::Reader.new(data_file('3.TLM')) }
+
+    context 'flight 1' do
+
+      subject { reader.flights[0] }
+
+      it { should have(5).headers }
+
+      it { should have(0).records }
+
+      its(:duration) { should eql(0) }
+
+      it { should be_empty }
+
+    end
+
+    context 'flight 2' do
+
+      subject { reader.flights[1] }
+
+      it { should have(5).headers }
+
+      it { should have(0).records }
+
+      its(:duration) { should eql(0) }
+
+      it { should be_empty }
+
+    end
+
+    context 'flight 3' do
+
+      subject { reader.flights[2] }
+
+      it { should have(5).headers }
+
+      it { should have(0).records }
+
+      its(:duration) { should eql(0) }
+
+      it { should be_empty }
+
+    end
+
+    context 'flight 4' do
+
+      subject { reader.flights[3] }
+
+      it { should have(5).headers }
+
+      it { should have(0).records }
+
+      its(:duration) { should eql(0) }
+
+      it { should be_empty }
+
+    end
+
+    context 'flight 5' do
+
+      subject { reader.flights[4] }
+
+      it { should have(5).headers }
+
+      it { should have(0).records }
+
+      its(:duration) { should eql(0) }
+
+      it { should be_empty }
+
+    end
+
+    context 'flight 6' do
+
+      subject { reader.flights[5] }
+
+      it { should have(5).headers }
+
+      it { should have(0).records }
+
+      its(:duration) { should eql(0) }
+
+      it { should be_empty }
+
+    end
+
+    context 'flight 7' do
+
+      subject { reader.flights[6] }
+
+      it { should have(5).headers }
+
+      it { should have(0).records }
+
+      its(:duration) { should eql(0) }
+
+      it { should be_empty }
+
+    end
+
+    context 'flight 8' do
+
+      subject { reader.flights[7] }
+
+      it { should have(5).headers }
+
+      it { should have(0).records }
+
+      its(:duration) { should eql(0) }
+
+      it { should be_empty }
+
+    end
+
+    context 'flight 9' do
+
+      subject { reader.flights[8] }
+
+      it { should have(5).headers }
+
+      it { should have(23155).records }
+
+      its(:duration) { should eql(148365) }
+
+      it { should_not be_empty }
+
+    end
+
+  end
+
+  context 'data file 4.TLM' do
+
+    let(:reader) { Spektrum::Log::Reader.new(data_file('4.TLM')) }
+
+    context 'flight 1' do
+
+      subject { reader.flights[0] }
+
+      it { should have(5).headers }
+
+      it { should have(5440).records }
+
+      it { should_not be_empty }
+
+      its(:duration) { should eql(16325) }
+
+      its(:bind_type) { should eql('DSMX') }
+
+      its(:model_name) { should eql('Goblin 700') }
+
+      its(:model_number) { should eql(5) }
+
+      its(:model_type) { should eql('Helicopter') }
+
+    end
+
+  end
+
+end

data/spec/reader_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe Spektrum::Log::Reader do
+
+  context 'data file 1.TLM' do
+
+    subject { Spektrum::Log::Reader.new(data_file('1.TLM')) }
+
+    it { should have(3).flights }
+
+  end
+
+  context 'data file 2.TLM' do
+
+    subject { Spektrum::Log::Reader.new(data_file('2.TLM')) }
+
+    it { should have(312).flights }
+
+  end
+
+  context 'data file 3.TLM' do
+
+    subject { Spektrum::Log::Reader.new(data_file('3.TLM')) }
+
+    it { should have(12).flights }
+
+  end
+
+  context 'data file 4.TLM' do
+
+    subject { Spektrum::Log::Reader.new(data_file('4.TLM')) }
+
+    it { should have(1).flights }
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require 'spektrum-log'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end
+
+def data_file(name)
+  "#{File.dirname(__FILE__)}/../data/#{name}"
+end

data/spektrum-log.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/spektrum-log/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Nick Veys"]
+  gem.email         = ["nveys@aramisgroup.com"]
+  gem.description   = %q{Read and interpret Spektrum TLM log files.}
+  gem.summary       = %q{Spektrum TLM log file reader}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "spektrum-log"
+  gem.require_paths = ["lib"]
+  gem.version       = Spektrum::Log::VERSION
+
+  gem.add_development_dependency 'rspec', '~> 2.12'
+  gem.add_development_dependency 'rake', '~> 10.0'
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: spektrum-log
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Nick Veys
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Read and interpret Spektrum TLM log files.
+email:
+- nveys@aramisgroup.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- data/1.TLM
+- data/2.TLM
+- data/3.TLM
+- data/4.TLM
+- lib/spektrum-log.rb
+- lib/spektrum-log/flight.rb
+- lib/spektrum-log/headers.rb
+- lib/spektrum-log/reader.rb
+- lib/spektrum-log/records.rb
+- lib/spektrum-log/version.rb
+- spec/flight_spec.rb
+- spec/reader_spec.rb
+- spec/spec_helper.rb
+- spektrum-log.gemspec
+homepage: ''
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Spektrum TLM log file reader
+test_files:
+- spec/flight_spec.rb
+- spec/reader_spec.rb
+- spec/spec_helper.rb