spektrum-log 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 16e8299a9a5e5c9feef7434e6b06c31215be4d5d
-  data.tar.gz: ad822e2785f70364dca30e805f9f8b03d95be924
+  metadata.gz: 1290e1e85c63b06ca04ff2ddcb1e6e6bc1a078a9
+  data.tar.gz: d844267c31ffe4c308dfd187bb969ade4e8f0d34
 SHA512:
-  metadata.gz: d63ec8893c1647b5e231cfa208b7b4698d2d52bd23d9cf4ae37b69b3019814be57b7631f4ca2c5e371c1805d6ee94a3fb4f81cde5a21454d55b3bdf46912fb0a
-  data.tar.gz: 35794b8e3004dc3751a5657849214d997004e5f9d134011ff08f609348090412953627923a449ae31f6a2bf1062b6ed2f7042d4856b7753f6c1bc983fc28f8b6
+  metadata.gz: a77e5bf2d17d03b7e4d16c9760a16423b7692f02d66f93c3daacee07be052350ddce87168268b6c40a8570a368673773e82e8e9a6ab37429f3b5dab12af8863d
+  data.tar.gz: 6e4baf468c95764744ec1847034a72831ff541d4ee5c4a1c667a6ff479c373a60effc26ae64b73a036d63aff86e6ae25fe1743a05b3868de0f10df31cb3daa3b

data/lib/spektrum-log/flight.rb

@@ -1,23 +1,39 @@
 module Spektrum
   module Log
 
+    # Represents a single recorded flight.  Contains information about the model
+    # flown, duration of the flight, and all data records contained within.
     class Flight
 
       attr_reader :headers, :records
 
+      # Creates a new flight.
+      #
+      # @param headers [Array] array of Header objects read from the file
+      # @param records [Array] array of Record objects read from the file
       def initialize(headers, records)
         @headers = headers
         @records = records
       end
 
+      # Gets the duration of the flight, in seconds.
+      #
+      # @return [Fixnum] duration of the flight, in seconds
       def duration
         @duration ||= ((@records.empty? ? 0 : @records.last.timestamp - @records.first.timestamp) / 256)
       end
 
+      # Determines if this flight has any data.  Models without telemetry
+      # transmitted, but with logging enabled will create empty flights.
+      #
+      # @return [Boolean] true if the flight has no records, false otherwise
       def empty?
         @records.empty?
       end
 
+      # Gets the binding type the flight was flown with.
+      #
+      # @return [String] binding type of the flight, `DSM2`, `DSMX`, etc.
       def bind_type
         @bind_type ||= case @headers.first.raw_data[2].unpack('C')[0]
                        when 0x01..0x02
@@ -29,14 +45,23 @@ module Spektrum
                        end
       end
 
+      # Gets the name of the model for this flight.
+      #
+      # @return [String] model name
       def model_name
         @model_name ||= @headers.first.raw_data[8..18].unpack('Z*')[0].strip
       end
 
+      # Gets the model's index from the transmitter.
+      #
+      # @return [Fixnum] model number
       def model_number
         @model_number ||= (@headers.first.raw_data[0].unpack('C')[0] + 1)
       end
 
+      # Gets the type of model flown.
+      #
+      # @return [String] model type
       def model_type
         @model_type ||= case @headers.first.raw_data[1].unpack('C')[0]
                         when 0x00
@@ -48,6 +73,76 @@ module Spektrum
                         end
       end
 
+      def altimeter_records?
+        any_records? AltimeterRecord
+      end
+
+      def altimeter_records
+        select_records AltimeterRecord
+      end
+
+      def basic_data_records?
+        any_records? BasicDataRecord
+      end
+
+      def basic_data_records
+        select_records BasicDataRecord
+      end
+
+      def flight_log_records?
+        any_records? FlightLogRecord
+      end
+
+      def flight_log_records
+        select_records FlightLogRecord
+      end
+
+      def g_force_records?
+        any_records? GForceRecord
+      end
+
+      def g_force_records
+        select_records GForceRecord
+      end
+
+      def gps1_records?
+        any_records? GPSRecord1
+      end
+
+      def gps1_records
+        select_records GPSRecord1
+      end
+
+      def gps2_records?
+        any_records? GPSRecord2
+      end
+
+      def gps2_records
+        select_records GPSRecord2
+      end
+
+      def speed_records?
+        any_records? SpeedRecord
+      end
+
+      def speed_records
+        select_records SpeedRecord
+      end
+
+      private
+
+      # Determines if there are any records in this flight of the given type.
+      #
+      # @param type [Class] type of record to check for
+      # @return []
+      def any_records?(type)
+        @records.any? { |rec| rec.is_a? type }
+      end
+
+      def select_records(type)
+        @records.select { |rec| rec.is_a? type }
+      end
+
     end
 
   end

data/lib/spektrum-log/headers.rb

@@ -1,16 +1,21 @@
 module Spektrum
   module Log
 
+    # Represents a single header from the telemetry file.
     class Header
 
       attr_reader :raw_data
 
+      # Creates a new header.
+      #
+      # @param [String] raw_data string of data from the data file for this header
       def initialize raw_data
         @raw_data = raw_data
       end
 
     end
 
+    # Helper class to create the correct type of header for the given data.
     class Headers
 
       def self.create raw_data
@@ -20,4 +25,4 @@ module Spektrum
     end
 
   end
-end
+end

data/lib/spektrum-log/records.rb

@@ -1,6 +1,7 @@
 module Spektrum
   module Log
 
+    # Represents a single record from the telemetry file.
     class Record
 
       attr_reader :timestamp
@@ -93,10 +94,16 @@ module Spektrum
         super timestamp, raw_data
       end
 
+      # Gets the receiver pack voltage data.
+      #
+      # @return [Float] rx voltage data, in volts
       def rx_voltage
         raw_rx_voltage / 100.0
       end
 
+      # Determines if there is receiver voltage data contained within.
+      #
+      # @return [Boolean] true if there is rx voltage data, false otherwise
       def rx_voltage?
         raw_rx_voltage != 0x7FFF
       end
@@ -228,6 +235,7 @@ module Spektrum
 
     end
 
+
     class Records
 
       @@types = {

data/lib/spektrum-log/version.rb

@@ -1,5 +1,5 @@
 module Spektrum
   module Log
-    VERSION = "0.0.4"
+    VERSION = "0.0.5"
   end
 end

data/spec/flight_spec.rb

@@ -236,6 +236,20 @@ describe Spektrum::Log::Flight do
 
       its(:model_type) { should eql('Helicopter') }
 
+      its(:altimeter_records?) { should be_false }
+
+      its(:basic_data_records?) { should be_true }
+
+      its(:flight_log_records?) { should be_true }
+
+      its(:g_force_records?) { should be_false }
+
+      its(:gps1_records?) { should be_false }
+
+      its(:gps2_records?) { should be_false }
+
+      its(:speed_records?) { should be_false }
+
     end
 
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spektrum-log
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Nick Veys
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-13 00:00:00.000000000 Z
+date: 2013-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -111,3 +111,4 @@ test_files:
 - spec/flight_spec.rb
 - spec/reader_spec.rb
 - spec/spec_helper.rb
+has_rdoc: