nmea_plus 1.0.8 → 1.0.9

data/lib/nmea_plus/message/ais/vdm_payload/vdm_msg8.rb

@@ -7,7 +7,7 @@ module NMEAPlus
     module AIS
       module VDMPayload
 
-        # Type 8: Binary Broadcast Message
+        # AIS Type 8: Binary Broadcast Message
         class VDMMsg8 < NMEAPlus::Message::AIS::VDMPayload::VDMMsg
 
           payload_reader :designated_area_code, 40, 10, :_u
@@ -41,16 +41,9 @@ module NMEAPlus
             _object_by_name("NMEAPlus::Message::AIS::VDMPayload::VDMMsg8Undefined") # generic
           end
 
-          # Return an object by its class name, or nil if it isn't defined
-          def _object_by_name(class_identifier)
-            Object::const_get(class_identifier).new
-          rescue ::NameError
-            nil
-          end
-
         end
 
-        # Base class for dynamic payloads (subtypes) of AIS VDM message 8
+        # Base class for {VDMMsg8#dp dynamic payload}s (subtypes) of {VDMMsg8 AIS VDM message 8}
         class VDMMsg8DynamicPayload < NMEAPlus::Message::AIS::VDMPayload::Payload; end
 
         # Placeholder for undefined message 8 payload subtypes

data/lib/nmea_plus/message/ais/vdm_payload/vdm_msg9.rb

@@ -4,18 +4,18 @@ module NMEAPlus
   module Message
     module AIS
       module VDMPayload
-        # Type 9: Standard SAR Aircraft Position Report
+        # AIS Type 9: Standard SAR Aircraft Position Report
         class VDMMsg9 < NMEAPlus::Message::AIS::VDMPayload::VDMMsg
 
-          payload_reader :altitude_meters, 38, 12, :_u
+          payload_reader :altitude_meters, 38, 12, :_u, 4095
 
-          payload_reader :speed_over_ground, 50, 10, :_U, 1
+          payload_reader :speed_over_ground, 50, 10, :_U, 1, 1023
           payload_reader :position_10m_accuracy?, 60, 1, :_b
           payload_reader :longitude, 61, 28, :_I, 60 * 10**4, 181
           payload_reader :latitude, 89, 27, :_I, 60 * 10**4, 91
-          payload_reader :course_over_ground, 116, 12, :_U, 1
+          payload_reader :course_over_ground, 116, 12, :_U, 10
           payload_reader :time_stamp, 128, 6, :_u
-          payload_reader :dte?, 142, 1, :_b
+          payload_reader :dte_ready?, 142, 1, :_nb
 
           payload_reader :assigned?, 146, 1, :_b
           payload_reader :raim?, 147, 1, :_b

data/lib/nmea_plus/message/base.rb

@@ -1,17 +1,22 @@
 
 module NMEAPlus
 
-  # The module containing all parsed message types.
-  # @see NMEAPlus::Message::Base
+  # This module contains all parsed NMEA message types, and their subtypes.
+  # @see NMEAPlus::Message::Base Base class for all NMEA-style messages
   module Message
 
-    # The base message type, from which all others inherit
+    # The base NMEA message type, from which all others inherit.  Messages have a prefix character,
+    # fields, and checksum.  This class provides convenience functions for accessing the fields as
+    # the appropriate data type, and logic for constructing multipart messages.
     # @abstract
     class Base
-      # make our own shortcut syntax for message attribute accessors
+      # Enable a shortcut syntax for message attribute accessors, in the style of `attr_accessor` metaprogramming.
+      # This is used to create a named field pointing to a specific indexed field in the payload, optionally applying
+      # a specific formatting function.
       # @param name [String] What the accessor will be called
       # @param field_num [Integer] The index of the field in the payload
       # @param formatter [Symbol] The symbol for the formatting function to apply to the field (optional)
+      # @return [void]
       # @macro [attach] field_reader
       #   @!attribute [r] $1
       #   @return field $2 of the payload, formatted with the function {#$3}
@@ -41,6 +46,7 @@ module NMEAPlus
       # @return [NMEAPlus::Message] The next part of a multipart message, if available
       attr_accessor :next_part
 
+      # @return [String] The NMEA data type of this message
       field_reader :data_type, 0, nil
 
       # @!parse attr_reader :original
@@ -129,26 +135,27 @@ module NMEAPlus
       # @param dm_string [String] An angular measurement in the form DDMM.MMM
       # @param sign_letter [String] can be N,S,E,W
       # @return [Float] A signed latitude or longitude
-      def _degrees_minutes_to_decimal(dm_string, sign_letter = "")
+      def self.degrees_minutes_to_decimal(dm_string, sign_letter = "")
         return nil if dm_string.nil? || dm_string.empty?
         r = /(\d+)(\d{2}\.\d+)/  # (some number of digits) (2 digits for minutes).(decimal minutes)
         m = r.match(dm_string)
         raw = m.values_at(1)[0].to_f + (m.values_at(2)[0].to_f / 60)
-        _nsew_signed_float(raw, sign_letter)
+        nsew_signed_float(raw, sign_letter)
       end
 
-      # Use cardinal directions to assign positive or negative to mixed_val.
+      # Use cardinal directions to assign positive or negative to mixed_val
       # Of possible directions NSEW (sign_letter) treat N/E as + and S/W as -
       # @param mixed_val [String] input value, can be string or float
       # @param sign_letter [String] can be N,S,E,W, or empty
       # @return [Float] The input value signed as per the sign letter.
-      def _nsew_signed_float(mixed_val, sign_letter = "")
+      def self.nsew_signed_float(mixed_val, sign_letter = "")
         value = mixed_val.to_f
         value *= -1 if !sign_letter.empty? && "SW".include?(sign_letter.upcase)
         value
       end
 
-      # integer or nil
+      # integer or nil.
+      # This function is meant to be passed as a formatter to {field_reader}.
       # @param field [String] the value in the field to be checked
       # @return [Integer] The value in the field or nil
       def _integer(field)
@@ -156,7 +163,8 @@ module NMEAPlus
         field.to_i
       end
 
-      # float or nil
+      # float or nil.
+      # This function is meant to be passed as a formatter to {field_reader}.
       # @param field [String] the value in the field to be checked
       # @return [Float] The value in the field or nil
       def _float(field)
@@ -164,7 +172,8 @@ module NMEAPlus
         field.to_f
       end
 
-      # string or nil
+      # string or nil.
+      # This function is meant to be passed as a formatter to {field_reader}.
       # @param field [String] the value in the field to be checked
       # @return [String] The value in the field or nil
       def _string(field)
@@ -172,7 +181,8 @@ module NMEAPlus
         field
       end
 
-      # hex to int or nil
+      # hex to int or nil.
+      # This function is meant to be passed as a formatter to {field_reader}.
       # @param field [String] the value in the field to be checked
       # @return [Integer] The value in the field or nil
       def _hex_to_integer(field)
@@ -180,7 +190,8 @@ module NMEAPlus
         field.hex
       end
 
-      # utc time or nil (HHMMSS or HHMMSS.SS)
+      # utc time or nil (HHMMSS or HHMMSS.SS).
+      # This function is meant to be passed as a formatter to {field_reader}.
       # @param field [String] the value in the field to be checked
       # @return [Time] The value in the field or nil
       def _utctime_hms(field)
@@ -195,7 +206,8 @@ module NMEAPlus
         end
       end
 
-      # time interval or nil (HHMMSS or HHMMSS.SS)
+      # time interval or nil (HHMMSS or HHMMSS.SS).
+      # This function is meant to be passed as a formatter to {field_reader}.
       # @param field [String] the value in the field to be checked
       # @return [Time] The value in the field or nil
       def _interval_hms(field)
@@ -209,6 +221,7 @@ module NMEAPlus
         end
       end
 
+      # Create a Time object from a date and time field
       # @param d_field [String] the date value in the field to be checked
       # @param t_field [String] the time value in the field to be checked
       # @return [Time] The value in the fields, or nil if either is not provided

data/lib/nmea_plus/message/nmea/base_nmea.rb

@@ -3,27 +3,32 @@ require_relative "../base"
 
 module NMEAPlus
   module Message
-    # A container for all {NMEAMessage} typs.
+    # A container for all {NMEAMessage} types.
+    # Most definitions were sourced from http://www.catb.org/gpsd/NMEA.txt
     module NMEA
 
-      # The base class for NMEA messages includes a few more NMEA-specific parsing functions
+      # The base class for NMEA messages includes a few NMEA-specific parsing functions
+      # beyond the base NMEA class.
       class NMEAMessage < NMEAPlus::Message::Base
 
-        # NMEA message types are 5 characters, the first 2 of which are the talker ID
+        # The first two characters of the NMEA message type
         # @!parse attr_accessor :talker
         # @return [String] The two-character "talker ID" of the message
         def talker
           data_type[0..1]
         end
 
-        # NMEA message types are 5 characters (or so), the last of which are the message type
+        # The generic type of the NMEA message.
+        # NMEA message types are 5 characters (or so): the first 2 are the talker ID, and the
+        # remaining characters are the generic message type.
         # @!parse attr_accessor :message_type
-        # @return [String] The two-character "talker ID" of the message
+        # @return [String] The generic part of the NMEA "data type" of the message
         def message_type
           data_type[2..-1]
         end
 
-        # Convert a string true/false (encoded as A=true, V=false) to boolean
+        # Convert a string true/false (encoded as A=true, V=false) to boolean.
+        # This function is meant to be passed as a formatter to {field_reader}.
         # @param field [String] the value in the field to be checked
         # @return [bool] The value in the field or nil
         def _av_boolean(field)
@@ -34,7 +39,8 @@ module NMEAPlus
           nil
         end
 
-        # Convert a string true/false (encoded as 1=true, 0=false) to boolean
+        # Convert a string true/false (encoded as 1=true, 0=false) to boolean.
+        # This function is meant to be passed as a formatter to {field_reader}.
         # @param field [String] the value in the field to be checked
         # @return [bool] The value in the field or nil
         def _10_boolean(field)

data/lib/nmea_plus/message/nmea/bwr.rb

@@ -10,13 +10,13 @@ module NMEAPlus
         # @!parse attr_reader :waypoint_latitude
         # @return [Float]
         def waypoint_latitude
-          _degrees_minutes_to_decimal(@fields[2], @fields[3])
+          self.class.degrees_minutes_to_decimal(@fields[2], @fields[3])
         end
 
         # @!parse attr_reader :waypoint_longitude
         # @return [Float]
         def waypoint_longitude
-          _degrees_minutes_to_decimal(@fields[4], @fields[5])
+          self.class.degrees_minutes_to_decimal(@fields[4], @fields[5])
         end
 
         field_reader :bearing_true, 6, :_float

data/lib/nmea_plus/message/nmea/dtm.rb

@@ -11,13 +11,13 @@ module NMEAPlus
         # @!parse attr_reader :latitude_offset
         # @return [Float]
         def latitude_offset
-          _nsew_signed_float(@fields[3], @fields[4])
+          self.class.nsew_signed_float(@fields[3], @fields[4])
         end
 
         # @!parse attr_reader :longitude_offset
         # @return [Float]
         def longitude_offset
-          _nsew_signed_float(@fields[5], @fields[6])
+          self.class.nsew_signed_float(@fields[5], @fields[6])
         end
 
         field_reader :altitude_meters, 7, :_float

data/lib/nmea_plus/message/nmea/gga.rb

@@ -11,13 +11,13 @@ module NMEAPlus
         # @!parse attr_reader :latitude
         # @return [Float]
         def latitude
-          _degrees_minutes_to_decimal(@fields[2], @fields[3])
+          self.class.degrees_minutes_to_decimal(@fields[2], @fields[3])
         end
 
         # @!parse attr_reader :longitude
         # @return [Float]
         def longitude
-          _degrees_minutes_to_decimal(@fields[4], @fields[5])
+          self.class.degrees_minutes_to_decimal(@fields[4], @fields[5])
         end
 
         field_reader :fix_quality, 6, :_integer

data/lib/nmea_plus/message/nmea/gll.rb

@@ -9,13 +9,13 @@ module NMEAPlus
         # @!parse attr_reader :latitude
         # @return [Float]
         def latitude
-          _degrees_minutes_to_decimal(@fields[1], @fields[2])
+          self.class.degrees_minutes_to_decimal(@fields[1], @fields[2])
         end
 
         # @!parse attr_reader :longitude
         # @return [Float]
         def longitude
-          _degrees_minutes_to_decimal(@fields[3], @fields[4])
+          self.class.degrees_minutes_to_decimal(@fields[3], @fields[4])
         end
 
         field_reader :fix_time, 5, :_utctime_hms

data/lib/nmea_plus/message/nmea/gns.rb

@@ -11,13 +11,13 @@ module NMEAPlus
         # @!parse attr_reader :latitude
         # @return [Float]
         def latitude
-          _degrees_minutes_to_decimal(@fields[2], @fields[3])
+          self.class.degrees_minutes_to_decimal(@fields[2], @fields[3])
         end
 
         # @!parse attr_reader :longitude
         # @return [Float]
         def longitude
-          _degrees_minutes_to_decimal(@fields[4], @fields[5])
+          self.class.degrees_minutes_to_decimal(@fields[4], @fields[5])
         end
 
         field_reader :mode, 6, :_string

data/lib/nmea_plus/message/nmea/gxa.rb

@@ -11,13 +11,13 @@ module NMEAPlus
         # @!parse attr_reader :latitude
         # @return [Float]
         def latitude
-          _degrees_minutes_to_decimal(@fields[2], @fields[3])
+          self.class.degrees_minutes_to_decimal(@fields[2], @fields[3])
         end
 
         # @!parse attr_reader :longitude
         # @return [Float]
         def longitude
-          _degrees_minutes_to_decimal(@fields[4], @fields[5])
+          self.class.degrees_minutes_to_decimal(@fields[4], @fields[5])
         end
 
         field_reader :waypoint_id, 6, :_integer

data/lib/nmea_plus/message/nmea/hdg.rb

@@ -10,13 +10,13 @@ module NMEAPlus
         # @!parse attr_reader :magnetic_deviation_degrees
         # @return [Float]
         def magnetic_deviation_degrees
-          _nsew_signed_float(@fields[2], @fields[3])
+          self.class.nsew_signed_float(@fields[2], @fields[3])
         end
 
         # @!parse attr_reader :magnetic_variation_degrees
         # @return [Float]
         def magnetic_variation_degrees
-          _nsew_signed_float(@fields[4], @fields[5])
+          self.class.nsew_signed_float(@fields[4], @fields[5])
         end
 
       end

data/lib/nmea_plus/message/nmea/rma.rb

@@ -11,13 +11,13 @@ module NMEAPlus
         # @!parse attr_reader :latitude
         # @return [Float]
         def latitude
-          _degrees_minutes_to_decimal(@fields[2], @fields[3])
+          self.class.degrees_minutes_to_decimal(@fields[2], @fields[3])
         end
 
         # @!parse attr_reader :longitude
         # @return [Float]
         def longitude
-          _degrees_minutes_to_decimal(@fields[4], @fields[5])
+          self.class.degrees_minutes_to_decimal(@fields[4], @fields[5])
         end
 
         field_reader :time_difference_a, 6, :_float
@@ -28,7 +28,7 @@ module NMEAPlus
         # @!parse attr_reader :magnetic_variation_degrees
         # @return [Float]
         def magnetic_variation_degrees
-          _nsew_signed_float(@fields[10], @fields[11])
+          self.class.nsew_signed_float(@fields[10], @fields[11])
         end
 
       end

data/lib/nmea_plus/message/nmea/rmb.rb

@@ -15,13 +15,13 @@ module NMEAPlus
         # @!parse attr_reader :waypoint_latitude
         # @return [Float]
         def waypoint_latitude
-          _degrees_minutes_to_decimal(@fields[6], @fields[7])
+          self.class.degrees_minutes_to_decimal(@fields[6], @fields[7])
         end
 
         # @!parse attr_reader :waypoint_longitude
         # @return [Float]
         def waypoint_longitude
-          _degrees_minutes_to_decimal(@fields[8], @fields[9])
+          self.class.degrees_minutes_to_decimal(@fields[8], @fields[9])
         end
 
         field_reader :range_to_destination_nautical_miles, 10, :_float

data/lib/nmea_plus/message/nmea/rmc.rb

@@ -17,13 +17,13 @@ module NMEAPlus
         # @!parse attr_reader :latitude
         # @return [Float]
         def latitude
-          _degrees_minutes_to_decimal(@fields[3], @fields[4])
+          self.class.degrees_minutes_to_decimal(@fields[3], @fields[4])
         end
 
         # @!parse attr_reader :longitude
         # @return [Float]
         def longitude
-          _degrees_minutes_to_decimal(@fields[5], @fields[6])
+          self.class.degrees_minutes_to_decimal(@fields[5], @fields[6])
         end
 
         field_reader :speed_over_ground_knots, 7, :_float
@@ -32,7 +32,7 @@ module NMEAPlus
         # @!parse attr_reader :magnetic_variation_degrees
         # @return [Float]
         def magnetic_variation_degrees
-          _nsew_signed_float(@fields[10], @fields[11])
+          self.class.nsew_signed_float(@fields[10], @fields[11])
         end
 
         field_reader :faa_mode, 12, :_string

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

@@ -14,13 +14,13 @@ module NMEAPlus
         # @!parse attr_reader :latitude
         # @return [Float]
         def latitude
-          _degrees_minutes_to_decimal(@fields[3], @fields[4])
+          self.class.degrees_minutes_to_decimal(@fields[3], @fields[4])
         end
 
         # @!parse attr_reader :longitude
         # @return [Float]
         def longitude
-          _degrees_minutes_to_decimal(@fields[5], @fields[6])
+          self.class.degrees_minutes_to_decimal(@fields[5], @fields[6])
         end
 
         field_reader :elevation_angle, 7, :_float

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

@@ -8,13 +8,13 @@ module NMEAPlus
         # @!parse attr_reader :latitude
         # @return [Float]
         def latitude
-          _degrees_minutes_to_decimal(@fields[1], @fields[2])
+          self.class.degrees_minutes_to_decimal(@fields[1], @fields[2])
         end
 
         # @!parse attr_reader :longitude
         # @return [Float]
         def longitude
-          _degrees_minutes_to_decimal(@fields[3], @fields[4])
+          self.class.degrees_minutes_to_decimal(@fields[3], @fields[4])
         end
 
         field_reader :name, 5, :_string

data/lib/nmea_plus/nmea_message_factory.rb

@@ -95,7 +95,9 @@ module NMEAPlus
 end
 =end
 
-  # Defines a factory for NMEA messages, which will all use {NMEAPlus::Message::NMEA::NMEAMessage} as their base
+  # Defines a factory for NMEA messages, which will all use {NMEAPlus::Message::NMEA::NMEAMessage} as their base.
+  # The factory extracts the NMEA data type (prefixed by a 2-character "talker ID"), and looks for a class with
+  # that name within the NMEA message namespace.
   class NMEAMessageFactory < MessageFactory
 
     # @return [String] The name of the parent module: NMEA