nmea_plus 1.0.0

data/gem/lib/nmea_plus/message/nmea/stn.rb

@@ -0,0 +1,11 @@
+require_relative "base_nmea"
+
+module NMEAPlus
+  module Message
+    module NMEA
+      class STN < NMEAPlus::Message::NMEA::NMEAMessage
+        field_reader :talker_id, 1, :_float
+      end
+    end
+  end
+end

data/gem/lib/nmea_plus/message/nmea/tds.rb

@@ -0,0 +1,11 @@
+require_relative "base_nmea"
+
+module NMEAPlus
+  module Message
+    module NMEA
+      class TDS < NMEAPlus::Message::NMEA::NMEAMessage
+        field_reader :door_spread_distance_meters, 1, :_float
+      end
+    end
+  end
+end

data/gem/lib/nmea_plus/message/nmea/tfi.rb

@@ -0,0 +1,13 @@
+require_relative "base_nmea"
+
+module NMEAPlus
+  module Message
+    module NMEA
+      class TFI < NMEAPlus::Message::NMEA::NMEAMessage
+        field_reader :catch_sensor1, 1, :_integer
+        field_reader :catch_sensor2, 2, :_integer
+        field_reader :catch_sensor3, 3, :_integer
+      end
+    end
+  end
+end

data/gem/lib/nmea_plus/message/nmea/tpc.rb

@@ -0,0 +1,13 @@
+require_relative "base_nmea"
+
+module NMEAPlus
+  module Message
+    module NMEA
+      class TPC < NMEAPlus::Message::NMEA::NMEAMessage
+        field_reader :distance_abeam_meters, 1, :_float
+        field_reader :distance_abaft_meters, 3, :_float
+        field_reader :depth_meters, 5, :_float
+      end
+    end
+  end
+end

data/gem/lib/nmea_plus/message/nmea/tpr.rb

@@ -0,0 +1,13 @@
+require_relative "base_nmea"
+
+module NMEAPlus
+  module Message
+    module NMEA
+      class TPR < NMEAPlus::Message::NMEA::NMEAMessage
+        field_reader :range_meters, 1, :_float
+        field_reader :bearing_degrees, 3, :_float
+        field_reader :depth_meters, 5, :_float
+      end
+    end
+  end
+end

data/gem/lib/nmea_plus/message/nmea/tpt.rb

@@ -0,0 +1,13 @@
+require_relative "base_nmea"
+
+module NMEAPlus
+  module Message
+    module NMEA
+      class TPT < NMEAPlus::Message::NMEA::NMEAMessage
+        field_reader :range_meters, 1, :_float
+        field_reader :bearing_true_degrees, 3, :_float
+        field_reader :depth_meters, 5, :_float
+      end
+    end
+  end
+end

data/gem/lib/nmea_plus/message/nmea/trf.rb

@@ -0,0 +1,28 @@
+require_relative "base_nmea"
+
+module NMEAPlus
+  module Message
+    module NMEA
+      class TRF < NMEAPlus::Message::NMEA::NMEAMessage
+        def utc_time
+          _utc_date_time(@fields[2], @fields[1])
+        end
+
+        def latitude
+          _degrees_minutes_to_decimal(@fields[3], @fields[4])
+        end
+
+        def longitude
+          _degrees_minutes_to_decimal(@fields[5], @fields[6])
+        end
+
+        field_reader :elevation_angle, 7, :_float
+        field_reader :iterations, 8, :_integer
+        field_reader :doppler_intervals, 9, :_integer
+        field_reader :update_distance_nautical_miles, 10, :_float
+        field_reader :satellite, 11, :_integer
+        field_reader :valid?, 12, :_av_boolean
+      end
+    end
+  end
+end

data/gem/lib/nmea_plus/message/nmea/ttm.rb

@@ -0,0 +1,22 @@
+require_relative "base_nmea"
+
+module NMEAPlus
+  module Message
+    module NMEA
+      class TTM < NMEAPlus::Message::NMEA::NMEAMessage
+        field_reader :target_number, 1, :_integer
+        field_reader :target_distance, 2, :_float
+        field_reader :target_bearing_from_ownship, 3, :_float
+        field_reader :target_bearing_units, 4, :_string
+        field_reader :target_speed, 5, :_float
+        field_reader :target_course, 6, :_float
+        field_reader :target_course_units, 7, :_string
+        field_reader :closest_approach_point_distance, 8, :_float
+        field_reader :closest_approach_point_time, 9, :_float
+        field_reader :target_name, 11, :_string
+        field_reader :target_status, 12, :_string
+        field_reader :reference_target, 13, :_string
+      end
+    end
+  end
+end

data/gem/lib/nmea_plus/message/nmea/vbw.rb

@@ -0,0 +1,16 @@
+require_relative "base_nmea"
+
+module NMEAPlus
+  module Message
+    module NMEA
+      class VBW < NMEAPlus::Message::NMEA::NMEAMessage
+        field_reader :longitudinal_water_speed, 1, :_float
+        field_reader :transverse_water_speed, 2, :_float
+        field_reader :water_speed_valid?, 3, :_av_boolean
+        field_reader :longitudinal_ground_speed, 4, :_float
+        field_reader :transverse_ground_speed, 5, :_float
+        field_reader :ground_speed_valid?, 6, :_av_boolean
+      end
+    end
+  end
+end

data/gem/lib/nmea_plus/message/nmea/vdr.rb

@@ -0,0 +1,13 @@
+require_relative "base_nmea"
+
+module NMEAPlus
+  module Message
+    module NMEA
+      class VDR < NMEAPlus::Message::NMEA::NMEAMessage
+        field_reader :degrees_true, 1, :_float
+        field_reader :degrees_magnetic, 3, :_float
+        field_reader :water_current_speed_knots, 5, :_float
+      end
+    end
+  end
+end

data/gem/lib/nmea_plus/message/nmea/vhw.rb

@@ -0,0 +1,14 @@
+require_relative "base_nmea"
+
+module NMEAPlus
+  module Message
+    module NMEA
+      class VHW < NMEAPlus::Message::NMEA::NMEAMessage
+        field_reader :degrees_true, 1, :_float
+        field_reader :degrees_magnetic, 3, :_float
+        field_reader :water_speed_knots, 5, :_float
+        field_reader :water_speed_kmh, 7, :_float
+      end
+    end
+  end
+end

data/gem/lib/nmea_plus/message/nmea/vlw.rb

@@ -0,0 +1,12 @@
+require_relative "base_nmea"
+
+module NMEAPlus
+  module Message
+    module NMEA
+      class VLW < NMEAPlus::Message::NMEA::NMEAMessage
+        field_reader :total_distance_nautical_miles, 1, :_float
+        field_reader :distance_since_reset_nautical_miles, 3, :_float
+      end
+    end
+  end
+end

data/gem/lib/nmea_plus/message/nmea/vpw.rb

@@ -0,0 +1,12 @@
+require_relative "base_nmea"
+
+module NMEAPlus
+  module Message
+    module NMEA
+      class VPW < NMEAPlus::Message::NMEA::NMEAMessage
+        field_reader :parallel_wind_speed_knots, 1, :_float
+        field_reader :parallel_wind_speed_ms, 3, :_float
+      end
+    end
+  end
+end

data/gem/lib/nmea_plus/message/nmea/vtg.rb

@@ -0,0 +1,41 @@
+require_relative "base_nmea"
+
+module NMEAPlus
+  module Message
+    module NMEA
+      class VTG < NMEAPlus::Message::NMEA::NMEAMessage
+        # whether this is the new format.  docs say check field #2 for value "2"
+        def new_format?
+          'T' == @fields[2]
+        end
+
+        field_reader :track_degrees_true, 1, :_float
+
+        def track_degrees_magnetic
+          f = new_format? ? 3 : 2
+          return nil if @fields[f].nil? || @fields[f].empty?
+          @fields[f].to_f
+        end
+
+        def speed_knots
+          f = new_format? ? 5 : 3
+          return nil if @fields[f].nil? || @fields[f].empty?
+          @fields[f].to_f
+        end
+
+        def speed_kmh
+          f = new_format? ? 7 : 4
+          return nil if @fields[f].nil? || @fields[f].empty?
+          @fields[f].to_f
+        end
+
+        def faa_mode
+          f = new_format? ? 9 : 100
+          return nil if @fields[f].nil? || @fields[f].empty?
+          @fields[f]
+        end
+
+      end
+    end
+  end
+end

data/gem/lib/nmea_plus/message/nmea/vwr.rb

@@ -0,0 +1,15 @@
+require_relative "base_nmea"
+
+module NMEAPlus
+  module Message
+    module NMEA
+      class VWR < NMEAPlus::Message::NMEA::NMEAMessage
+        field_reader :wind_direction_degrees, 1, :_float
+        field_reader :wind_direction_bow, 2, :_string
+        field_reader :speed_knots, 3, :_float
+        field_reader :speed_ms, 5, :_float
+        field_reader :speed_kmh, 7, :_float
+      end
+    end
+  end
+end

data/gem/lib/nmea_plus/message/nmea/wcv.rb

@@ -0,0 +1,12 @@
+require_relative "base_nmea"
+
+module NMEAPlus
+  module Message
+    module NMEA
+      class WCV < NMEAPlus::Message::NMEA::NMEAMessage
+        field_reader :velocity_knots, 1, :_float
+        field_reader :waypoint_id, 3, :_string
+      end
+    end
+  end
+end

data/gem/lib/nmea_plus/message/nmea/wnc.rb

@@ -0,0 +1,14 @@
+require_relative "base_nmea"
+
+module NMEAPlus
+  module Message
+    module NMEA
+      class WNC < NMEAPlus::Message::NMEA::NMEAMessage
+        field_reader :distance_nautical_miles, 1, :_float
+        field_reader :distance_kilometers, 3, :_float
+        field_reader :waypoint_to, 5, :_string
+        field_reader :waypoint_from, 6, :_string
+      end
+    end
+  end
+end

data/gem/lib/nmea_plus/message/nmea/wpl.rb

@@ -0,0 +1,19 @@
+require_relative "base_nmea"
+
+module NMEAPlus
+  module Message
+    module NMEA
+      class WPL < NMEAPlus::Message::NMEA::NMEAMessage
+        def latitude
+          _degrees_minutes_to_decimal(@fields[1], @fields[2])
+        end
+
+        def longitude
+          _degrees_minutes_to_decimal(@fields[3], @fields[4])
+        end
+
+        field_reader :name, 5, :_string
+      end
+    end
+  end
+end

data/gem/lib/nmea_plus/message/nmea/xdr.rb

@@ -0,0 +1,14 @@
+require_relative "base_nmea"
+
+module NMEAPlus
+  module Message
+    module NMEA
+      class XDR < NMEAPlus::Message::NMEA::NMEAMessage
+        field_reader :type, 1, :_string
+        field_reader :measurement, 2, :_float
+        field_reader :measurement_unit, 3, :_string
+        field_reader :name, 4, :_string
+      end
+    end
+  end
+end

data/gem/lib/nmea_plus/message/nmea/xte.rb

@@ -0,0 +1,16 @@
+require_relative "base_nmea"
+
+module NMEAPlus
+  module Message
+    module NMEA
+      class XTE < NMEAPlus::Message::NMEA::NMEAMessage
+        field_reader :no_general_warning?, 1, :_av_boolean
+        field_reader :no_cyclelock_warning?, 2, :_av_boolean
+        field_reader :cross_track_error, 3, :_float
+        field_reader :direction_to_steer, 4, :_string
+        field_reader :cross_track_units, 5, :_string
+        field_reader :faa_mode, 6, :_string
+      end
+    end
+  end
+end

data/gem/lib/nmea_plus/message/nmea/xtr.rb

@@ -0,0 +1,12 @@
+require_relative "base_nmea"
+
+module NMEAPlus
+  module Message
+    module NMEA
+      class XTR < NMEAPlus::Message::NMEA::NMEAMessage
+        field_reader :cross_track_error, 1, :_float
+        field_reader :direction_to_steer, 2, :_string
+      end
+    end
+  end
+end

data/gem/lib/nmea_plus/message/nmea/zda.rb

@@ -0,0 +1,23 @@
+require_relative "base_nmea"
+
+module NMEAPlus
+  module Message
+    module NMEA
+      class ZDA < NMEAPlus::Message::NMEA::NMEAMessage
+        def utc_time
+
+          re_format = /(\d{2})(\d{2})(\d{2}(\.\d+)?)/
+          hms = re_format.match(@fields[1])
+          begin
+            tz_h = @fields[5].to_i
+            tz = "%s%0.02d:%0.02d" % [tz_h >= 0 ? '+' : '', tz_h, @fields[6].to_i]
+            Time.new(@fields[4].to_i, @fields[3].to_i, @fields[2].to_i,
+                     hms[1].to_i, hms[2].to_i, hms[3].to_f, tz)
+          rescue
+            nil
+          end
+        end
+      end
+    end
+  end
+end

data/gem/lib/nmea_plus/message/nmea/zfo.rb

@@ -0,0 +1,13 @@
+require_relative "base_nmea"
+
+module NMEAPlus
+  module Message
+    module NMEA
+      class ZFO < NMEAPlus::Message::NMEA::NMEAMessage
+        field_reader :utc_time, 1, :_utctime_hms
+        # field_reader :elapsed_time, 2, :_interval_hms
+        field_reader :origin_waypoint_id, 3, :_string
+      end
+    end
+  end
+end

data/gem/lib/nmea_plus/message/nmea/ztg.rb

@@ -0,0 +1,13 @@
+require_relative "base_nmea"
+
+module NMEAPlus
+  module Message
+    module NMEA
+      class ZTG < NMEAPlus::Message::NMEA::NMEAMessage
+        field_reader :utc_time, 1, :_utctime_hms
+        # field_reader :remaining_time, 2, :_interval_hms
+        field_reader :destination_waypoint_id, 3, :_string
+      end
+    end
+  end
+end

data/gem/lib/nmea_plus/message_factory.rb

@@ -0,0 +1,68 @@
+
+module NMEAPlus
+
+  # meant to be extended.  Creates message classes with a common prefix and variable suffix
+  class MessageFactory
+
+    # factory class must be extended
+    def self.parent_module
+      "FIXME_parent_module"
+    end
+
+    # a way to override the data_type (e.g. __AAM) with GPAAM to get a match
+    # whatever factory extends this class should override this method
+    def self.alternate_data_type(data_type)
+      data_type # in basic implementation, there is no alternative.
+    end
+
+    # check whether a given object exists.  this will work for all consts but shhhhhhhhh
+    def self.message_class_exists?(class_identifier)
+      Object::const_get(class_identifier)
+      return true
+    rescue ::NameError
+      return false
+    end
+
+    # shortcut for the full name to a message class
+    def self.message_class_name(data_type)
+      "NMEAPlus::Message::#{self.parent_module}::#{data_type}"
+    end
+
+    # use the actual type if we have it, else try an alternate (and let it fail there)
+    def self.best_match_for_data_type(data_type)
+      return data_type if self.message_class_exists?(self.message_class_name(data_type))
+      self.alternate_data_type(data_type)
+    end
+
+    # get a message class through reflection
+    def self.dynamically_get_message_object(class_identifier)
+      Object::const_get(class_identifier).new
+    rescue ::NameError => e
+      raise ::NameError, "Couldn't instantiate a #{class_identifier} object: #{e}"
+    end
+
+    # Choose what class to create, and create it based on the first of the (unsplitted) fields
+    #
+    def self.create(message_prefix, fields, checksum)
+      # get the data type and adjust it if necessary (e.g. support for NMEA standard sentences like __AAM)
+      data_type = fields.split(',', 2)[0].upcase  # assumed to be 'GPGGA', etc
+      interpreted_type = self.best_match_for_data_type(data_type)
+      class_name = self.message_class_name(interpreted_type)
+
+      # create message and make sure it's the right type
+      message = self.dynamically_get_message_object(class_name)
+      unless message.is_a? NMEAPlus::Message::Base
+        fail ArgumentError, "Undefined message type #{data_type} (classname #{class_name})"
+      end
+
+      # assign its data and return it
+      message.checksum = checksum
+      message.payload = fields
+      message.prefix = message_prefix
+      message.interpreted_data_type = interpreted_type
+      message
+    end
+
+  end
+
+end