nmea_plus 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 14b78eb70f5197e702eda48e3b297cfa9e6aed78
-  data.tar.gz: cc2f08b71f5841d8436f2e53baca38745aa67169
+  metadata.gz: a207c93360fededdabcaff54e1728e9ab275b344
+  data.tar.gz: 1085b632c37d05ef034c64804283d376417f55d5
 SHA512:
-  metadata.gz: f2db86ca89249ba01692b2cd4251eede675e1550defbb0bb80b486fad391e6ed2b1dbcfe9ef08c20b9854d8454510ba429cdb1f56c318d99f62d6e19a41ca2e8
-  data.tar.gz: 33a427ee981915f75cfdbf3f4143ddc2d6349db562f03fb59884f5f7562660c3f59d5f2e781b03addd7f33c1768750aa42fcf6430b39543a8594f02d4e1f2cfe
+  metadata.gz: b8a9716472c3c20a86cf6daaadecc78aa06301d8b3f37b1e9141ec2d05c5135f2dd5f5bc70e5e2f09339e59a0e2fe30c8773805ea18e3aa59887dd5b54f109cf
+  data.tar.gz: 005a20dcb935adb5fd9d0762ed40b94a9c6950ea7dc2b1c8b914fe7631bbb005cc305a825f74b931c25bcb2d97908d87e657393f38c585e0e0973549ad6c1c7c

data/README.md

@@ -2,6 +2,7 @@
 
 [![Gem Version](https://badge.fury.io/rb/nmea_plus.svg)](https://rubygems.org/gems/nmea_plus)
 [![Build Status](https://travis-ci.org/ifreecarve/nmea_plus.svg)](https://travis-ci.org/ifreecarve/nmea_plus)
+[![Documentation](http://img.shields.io/badge/docs-rdoc.info-blue.svg)](http://rubydoc.org/gems/nmea_plus/frames)
 
 [NMEA Plus](https://github.com/ifreecarve/nmea_plus) is a Ruby gem for parsing and decoding "GPS" messages: NMEA, AIS, and any other similar formats of short messaging typically used by marine equipment.  It provides convenient access (by name) to the fields of each message type, and a stream reader designed for use with Ruby Blocks.
 

data/lib/nmea_plus.rb

@@ -4,6 +4,8 @@ require 'nmea_plus/generated_parser/parser'
 require 'nmea_plus/generated_parser/tokenizer'
 
 # NMEAPlus contains classes for parsing and decoding NMEA and AIS messages.
+# You probably want to check out {NMEAPlus::Message::NMEA::NMEAMessage}
+# and {NMEAPlus::Message::AIS::AISMessage}.
 # @author Ian Katz
 module NMEAPlus
 

data/lib/nmea_plus/message/ais/base_ais.rb

@@ -3,13 +3,20 @@ require_relative "../base"
 
 module NMEAPlus
   module Message
+    # A container for all {AISMessage} types.
     module AIS
 
       class AISMessage < NMEAPlus::Message::Base
+        # NMEA (AIS) message types are 5 characters, the first 2 of which are the talker ID
+        # @!parse attr_accessor :talker
+        # @return [String] The two-character "talker ID" of the message
         def talker
           data_type[0..1]
         end
 
+        # NMEA (AIS) message types are 5 characters (or so), the last of which are the message type
+        # @!parse attr_accessor :message_type
+        # @return [String] The two-character "talker ID" of the message
         def message_type
           data_type[2..-1]
         end

data/lib/nmea_plus/message/ais/vdm.rb

@@ -21,7 +21,6 @@ require_relative "vdm_payload/vdm_msg1"
 require_relative "vdm_payload/vdm_msg5"
 require_relative "vdm_payload/vdm_msg8"
 
-
 module NMEAPlus
   module Message
     module AIS
@@ -33,8 +32,10 @@ module NMEAPlus
         field_reader :raw_ais_payload, 5, :_string
         field_reader :ais_payload_fill_bits, 6, :_integer
 
+        # factory method: find the appropriate message type class and instantiate it
+        # @!parse attr_reader :ais
+        # @return [VDMPayload::VDMMsg]
         def ais
-          # factory method: find the appropriate message type class and instantiate it
           p = full_dearmored_ais_payload
           ret = _payload_container(p[0, 6].to_i(2))
           ret.payload_bitstring = p
@@ -42,7 +43,9 @@ module NMEAPlus
           ret
         end
 
-        # the full encoded payload as it was received
+        # the full encoded payload as it was received -- spanning multiple messages
+        # @!parse attr_reader :full_armored_ais_payload
+        # @return [String]
         def full_armored_ais_payload
           # get the full message and fill bits for the last one
           ptr = self
@@ -56,6 +59,8 @@ module NMEAPlus
         end
 
         # a binary string ("0010101110110") representing the dearmored payload
+        # @!parse attr_reader :full_dearmored_ais_payload
+        # @return [String]
         def full_dearmored_ais_payload
           data = full_armored_ais_payload
           out = ""
@@ -65,8 +70,10 @@ module NMEAPlus
           out
         end
 
+        # Get the fill bits for the last message in the sequence -- the only one that matters
+        # @!parse attr_reader :last_ais_fill_bits
+        # @return [Integer]
         def last_ais_fill_bits
-          # get the fill bits for the last message in the sequence
           ptr = self
           fill_bits = nil
           loop do
@@ -78,6 +85,9 @@ module NMEAPlus
         end
 
         # perform the 6-bit to 8-bit conversion defined in the spec
+        # @param c [String] a character
+        # @param len [Integer] The number of bits to consider
+        # @return [String] a binary encoded string
         def _dearmor6b(c, len = 6)
           val = c.ord
           if val >= 96
@@ -88,6 +98,9 @@ module NMEAPlus
           ret.to_s(2).rjust(6, "0")[0..(len - 1)]
         end
 
+        # Find an appropriate payload container for the payload type, based on its stated message ID
+        # @param message_type_id [String]
+        # @return [NMEAPlus::Message::AIS::VDMPayload::VDMMsg] The parsed payload
         def _payload_container(message_type_id)
           class_identifier = "NMEAPlus::Message::AIS::VDMPayload::VDMMsg#{message_type_id}"
           Object::const_get(class_identifier).new

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

@@ -1,69 +1,111 @@
 class Class
-  # make our own shortcut syntax for payload attributes
-  def payload_reader(name, start_bit, length, formatter, formatter_arg = nil)
-    if formatter_arg.nil?
-      self.class_eval("def #{name};#{formatter}(#{start_bit}, #{length});end")
-    else
-      self.class_eval("def #{name};#{formatter}(#{start_bit}, #{length}, #{formatter_arg});end")
-    end
-  end
 end
 
 module NMEAPlus
   module Message
     module AIS
+      # There are many VDM payload types, and this is their container.  See {VDMMsg}.
       module VDMPayload
+        # The base class for the AIS payload (of {NMEAPlus::Message::AIS::VDM}) which can be of many types.
         class VDMMsg
+          # @return [String] The raw "armored payload" in the original message
           attr_accessor :payload_bitstring
+
+          # @return [Integer] The number of padding characters required to bring the payload to a 6 bit boundary
           attr_accessor :fill_bits
 
+          # make our own shortcut syntax for payload attributes
+          # @param name [String] What the accessor will be called
+          # @param start_bit [Integer] The index of first bit of this field in the payload
+          # @param length [Integer] The number of bits in this field
+          # @param formatter [Symbol] The symbol for the formatting function to apply to the field (optional)
+          # @param formatter_arg Any argument necessary for the formatting function
+          # @macro [attach] payload_reader
+          #   @!attribute [r] $1
+          #   @return The field defined by $3 bits starting at bit $2 of the payload, formatted with the function {#$4}($5)
+          def self.payload_reader(name, start_bit, length, formatter, formatter_arg = nil)
+            if formatter_arg.nil?
+              self.class_eval("def #{name};#{formatter}(#{start_bit}, #{length});end")
+            else
+              self.class_eval("def #{name};#{formatter}(#{start_bit}, #{length}, #{formatter_arg});end")
+            end
+          end
+
           payload_reader :message_type, 0, 6, :_u
           payload_reader :repeat_indicator, 6, 2, :_u
           payload_reader :source_mmsi, 8, 30, :_u
 
-          # lookup table for 6-bit ascii
+          # Convert 6-bit ascii to a character, according to http://catb.org/gpsd/AIVDM.html#_ais_payload_data_types
+          # @param ord [Integer] The 6-bit ascii code
+          # @return [String] the character for that code
           def _6b_ascii(ord)
             '@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\]^_ !"#$%&\'()*+,-./0123456789:;<=>?'[ord]
           end
 
-          # access part of the payload.  if there aren't bytes, there, return nil
+          # Access part of the payload.  If there aren't bytes, there, return nil
           # else execute a block
+          # @param start [Integer] The index of the first bit in the payload field
+          # @param length [Integer] The number of bits in the payload field
+          # @return Nil or whatever is yielded by the block
+          # @yield [String] A binary coded string ("010010101" etc)
           def _access(start, length)
             part = @payload_bitstring[start, length]
             return nil if part.nil? || part.empty?
             yield part
           end
 
-          # convert an entire string from the payload
+          # pull out 6b chunks from the payload, then convert those to their more familar characters
+          # @param start [Integer] The index of the first bit in the payload field
+          # @param length [Integer] The number of bits in the payload field
+          # @return [String]
           def _6b_string(start, length)
-            # pull out 6b chunks from the string, use their value as a lookup into the ascii array
             _bit_slices(start, length, 6).to_a.map(&:join).map { |x| _6b_ascii(x.to_i(2)) }.join
           end
 
+          # pull out 8b chunks from the payload, then convert those to their more familar characters
+          # @param start [Integer] The index of the first bit in the payload field
+          # @param length [Integer] The number of bits in the payload field
+          # @return [String]
           def _8b_data_string(start, length)
             _bit_slices(start, length, 8).to_a.map(&:join).map { |x| x.to_i(2).chr }.join
           end
 
+          # Slice a part of the payload into binary chunks of a given size
+          # @param start [Integer] The index of the first bit in the payload field
+          # @param length [Integer] The number of bits in the payload field
+          # @return [Array<String>] Strings representing binary ("01010101" etc) for each slice
           def _bit_slices(start, length, chunk_size)
             _access(start, length) { |bits| bits.chars.each_slice(chunk_size) }
           end
 
-          # convert a string but trim off the 0s ('@')
+          # convert a 6b string but trim off the 0s ('@')
+          # @param start [Integer] The index of the first bit in the payload field
+          # @param length [Integer] The number of bits in the payload field
+          # @return [String]
           def _6b_string_nullterminated(start, length)
             _6b_string(start, length).split("@", 2)[0]
           end
 
           # directly convert a string to a binary number as you'd read it
+          # @param start [Integer] The index of the first bit in the payload field
+          # @param length [Integer] The number of bits in the payload field
+          # @return [Integer] an unsigned integer value
           def _6b_unsigned_integer(start, length)
             _access(start, length) { |bits| bits.to_i(2) }
           end
 
           # perform a twos complement operation on part of the payload
+          # @param start [Integer] The index of the first bit in the payload field
+          # @param length [Integer] The number of bits in the payload field
+          # @return [Integer] an integer value
           def _6b_twoscomplement(start, length)
             # two's complement: flip bits, then add 1
             _access(start, length) { |bits| bits.tr("01", "10").to_i(2) + 1 }
           end
 
+          # @param start [Integer] The index of the first bit in the payload field
+          # @param length [Integer] The number of bits in the payload field
+          # @return [Integer] an integer value
           def _6b_integer(start, length)
             # MSB is 1 for negative
             twoc = _6b_twoscomplement(start, length)
@@ -71,19 +113,35 @@ module NMEAPlus
           end
 
           # scale an integer by dividing it by 10^decimal_places
+          # @param start [Integer] The index of the first bit in the payload field
+          # @param length [Integer] The number of bits in the payload field
+          # @param decimal_places [Integer] The power of ten to use in scaling the result
+          # @return [Integer] an integer value
           def _6b_integer_scaled(start, length, decimal_places)
             _6b_integer(start, length).to_f / (10 ** decimal_places)
           end
 
           # scale an unsigned integer by dividing it by 10^decimal_places
+          # @param start [Integer] The index of the first bit in the payload field
+          # @param length [Integer] The number of bits in the payload field
+          # @param decimal_places [Integer] The power of ten to use in scaling the result
+          # @return [Integer] an integer value
           def _6b_unsigned_integer_scaled(start, length, decimal_places)
             _6b_unsigned_integer(start, length).to_f / (10.0 ** decimal_places)
           end
 
+          # Get the value of a bit in the payload
+          # @param start [Integer] The index of the first bit in the payload field
+          # @param _ [Integer] Doesn't matter.  Here so signatures match; we hard-code 1 because it's 1 bit.
+          # @return [bool]
           def _6b_boolean(start, _)
             _access(start, 1) { |bits| bits.to_i == 1 }
           end
 
+          # Return a string representing binary
+          # @param start [Integer] The index of the first bit in the payload field
+          # @param length [Integer] The number of bits in the payload field
+          # @return [String] e.g. "0101010101011000"
           def _2b_data_string(start, length)
             _access(start, length)
           end
@@ -100,6 +158,7 @@ module NMEAPlus
 
         end
 
+        # We haven't defined all the AIS payload types, so this is a catch-all
         class VDMMsgUndefined < VDMMsg; end
 
       end

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

@@ -4,10 +4,13 @@ module NMEAPlus
   module Message
     module AIS
       module VDMPayload
+        # CNB - The Common Navigation Block, transmitted by AIS messages 1, 2, and 3.
         class VDMMsgCNB < NMEAPlus::Message::AIS::VDMPayload::VDMMsg
 
           payload_reader :navigational_status, 38, 4, :_u
 
+          # @!parse attr_reader :navigational_status_description
+          # @return [String] the human-readable description of navigational status
           def navigational_status_description
             case navigational_status
             when 0 then return "Under way using engine"
@@ -25,6 +28,9 @@ module NMEAPlus
             end
           end
 
+          # The rate of turn in degrees per minute
+          # @!parse attr_reader :rate_of_turn
+          # @return [Float]
           def rate_of_turn
             ret = _i(42, 8)
             return nil if ret == -128
@@ -34,16 +40,22 @@ module NMEAPlus
           payload_reader :speed_over_ground, 50, 10, :_U, 1
           payload_reader :position_10m_accuracy?, 60, 1, :_b
 
+          # @!parse attr_reader :longitude
+          # @return [Float]
           def longitude
             _I(61, 28, 4) / 60
           end
 
+          # @!parse attr_reader :latitude
+          # @return [Float]
           def latitude
             _U(89, 27, 4) / 60
           end
 
           payload_reader :course_over_ground, 116, 12, :_U, 1
 
+          # @!parse attr_reader :true_heading
+          # @return [Float]
           def true_heading
             ret = _u(128, 9)
             return nil if ret == 511  # means "not available"

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

@@ -22,6 +22,8 @@ module NMEAPlus
           payload_reader :ship_dimension_to_starboard, 264, 6, :_u
           payload_reader :epfd_type, 270, 4, :_e
 
+          # @!parse attr_reader :eta
+          # @return [Time]
           def eta
             now = Time.now
             Time.new(now.year,

data/lib/nmea_plus/message/base.rb

@@ -12,8 +12,8 @@ module NMEAPlus
       # @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)
-      # @!macro [attach] field_reader
-      #   @method $1
+      # @macro [attach] field_reader
+      #   @!attribute [r] $1
       #   @return field $2 of the payload, formatted with the function {#$3}
       def self.field_reader(name, field_num, formatter = nil)
         if formatter.nil?
@@ -149,7 +149,7 @@ module NMEAPlus
       end
 
       # integer or nil
-      # @param field [String] the field index to check
+      # @param field [String] the value in the field to be checked
       # @return [Integer] The value in the field or nil
       def _integer(field)
         return nil if field.nil? || field.empty?
@@ -157,7 +157,7 @@ module NMEAPlus
       end
 
       # float or nil
-      # @param field [String] the field index to check
+      # @param field [String] the value in the field to be checked
       # @return [Float] The value in the field or nil
       def _float(field)
         return nil if field.nil? || field.empty?
@@ -165,7 +165,7 @@ module NMEAPlus
       end
 
       # string or nil
-      # @param field [String] the field index to check
+      # @param field [String] the value in the field to be checked
       # @return [String] The value in the field or nil
       def _string(field)
         return nil if field.nil? || field.empty?
@@ -173,7 +173,7 @@ module NMEAPlus
       end
 
       # hex to int or nil
-      # @param field [String] the field index to check
+      # @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)
         return nil if field.nil? || field.empty?
@@ -181,7 +181,7 @@ module NMEAPlus
       end
 
       # utc time or nil (HHMMSS or HHMMSS.SS)
-      # @param field [String] the field index to check
+      # @param field [String] the value in the field to be checked
       # @return [Time] The value in the field or nil
       def _utctime_hms(field)
         return nil if field.nil? || field.empty?
@@ -196,7 +196,7 @@ module NMEAPlus
       end
 
       # time interval or nil (HHMMSS or HHMMSS.SS)
-      # @param field [String] the field index to check
+      # @param field [String] the value in the field to be checked
       # @return [Time] The value in the field or nil
       def _interval_hms(field)
         return nil if field.nil? || field.empty?
@@ -209,8 +209,8 @@ module NMEAPlus
         end
       end
 
-      # @param d_field [String] the date field index to check
-      # @param t_field [String] the time field index to check
+      # @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
       def _utc_date_time(d_field, t_field)
         return nil if t_field.nil? || t_field.empty?

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

@@ -3,27 +3,42 @@ require_relative "../base"
 
 module NMEAPlus
   module Message
+    # A container for all {NMEAMessage} typs.
     module NMEA
 
+      # The base class for NMEA messages includes a few more NMEA-specific parsing functions
       class NMEAMessage < NMEAPlus::Message::Base
+
+        # NMEA message types are 5 characters, the first 2 of which are the talker ID
+        # @!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
+        # @!parse attr_accessor :message_type
+        # @return [String] The two-character "talker ID" of the message
         def message_type
           data_type[2..-1]
         end
 
-        def _av_boolean(data)
-          case data
+        # Convert a string true/false (encoded as A=true, V=false) to boolean
+        # @param field [String] the value in the field to be checked
+        # @return [bool] The value in the field or nil
+        def _av_boolean(field)
+          case field
           when 'A' then return true
           when 'V' then return false
           end
           nil
         end
 
-        def _10_boolean(data)
-          case data
+        # Convert a string true/false (encoded as 1=true, 0=false) to boolean
+        # @param field [String] the value in the field to be checked
+        # @return [bool] The value in the field or nil
+        def _10_boolean(field)
+          case field
           when '1' then return true
           when '0' then return false
           end

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

@@ -6,10 +6,14 @@ module NMEAPlus
       class BWR < NMEAPlus::Message::NMEA::NMEAMessage
         field_reader :utc_time, 1, :_utctime_hms
 
+        # @!parse attr_reader :waypoint_latitude
+        # @return [Float]
         def waypoint_latitude
           _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])
         end

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

@@ -7,10 +7,14 @@ module NMEAPlus
         field_reader :code, 1, :_string
         field_reader :subcode, 2, :_string
 
+        # @!parse attr_reader :latitude_offset
+        # @return [Float]
         def latitude_offset
           _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])
         end

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

@@ -8,10 +8,14 @@ module NMEAPlus
       class GGA < NMEAPlus::Message::NMEA::NMEAMessage
         field_reader :fix_time, 1, :_utctime_hms
 
+        # @!parse attr_reader :latitude
+        # @return [Float]
         def latitude
           _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])
         end

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

@@ -4,10 +4,15 @@ module NMEAPlus
   module Message
     module NMEA
       class GLL < NMEAPlus::Message::NMEA::NMEAMessage
+
+        # @!parse attr_reader :latitude
+        # @return [Float]
         def latitude
           _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])
         end

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

@@ -7,10 +7,14 @@ module NMEAPlus
       class GNS < NMEAPlus::Message::NMEA::NMEAMessage
         field_reader :fix_time, 1, :_utctime_hms
 
+        # @!parse attr_reader :latitude
+        # @return [Float]
         def latitude
           _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])
         end

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

@@ -6,10 +6,15 @@ module NMEAPlus
       class GXA < NMEAPlus::Message::NMEA::NMEAMessage
 
         field_reader :fix_time, 1, :_utctime_hms
+
+        # @!parse attr_reader :latitude
+        # @return [Float]
         def latitude
           _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])
         end

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

@@ -6,10 +6,14 @@ module NMEAPlus
     module NMEA
       class HDG < NMEAPlus::Message::NMEA::HDM
 
+        # @!parse attr_reader :magnetic_deviation_degrees
+        # @return [Float]
         def magnetic_deviation_degrees
           _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])
         end

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

@@ -7,10 +7,14 @@ module NMEAPlus
 
         field_reader :blink_warning, 1, :_av_boolean
 
+        # @!parse attr_reader :latitude
+        # @return [Float]
         def latitude
           _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])
         end
@@ -20,6 +24,8 @@ module NMEAPlus
         field_reader :speed_over_ground_knots, 8, :_float
         field_reader :track_made_good_degrees_true, 9, :_float
 
+        # @!parse attr_reader :magnetic_variation_degrees
+        # @return [Float]
         def magnetic_variation_degrees
           _nsew_signed_float(@fields[10], @fields[11])
         end

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

@@ -11,10 +11,14 @@ module NMEAPlus
         field_reader :waypoint_to, 4, :_integer
         field_reader :waypoint_from, 5, :_integer
 
+        # @!parse attr_reader :waypoint_latitude
+        # @return [Float]
         def waypoint_latitude
           _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])
         end

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

@@ -5,16 +5,22 @@ module NMEAPlus
     module NMEA
       class RMC < NMEAPlus::Message::NMEA::NMEAMessage
 
+        # @!parse attr_reader :utc_time
+        # @return [Time]
         def utc_time
           _utc_date_time(@fields[9], @fields[1])
         end
 
         field_reader :active?, 2, :_av_boolean
 
+        # @!parse attr_reader :latitude
+        # @return [Float]
         def latitude
           _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])
         end
@@ -22,6 +28,8 @@ module NMEAPlus
         field_reader :speed_over_ground_knots, 7, :_float
         field_reader :track_made_good_degrees_true, 8, :_float
 
+        # @!parse attr_reader :magnetic_variation_degrees
+        # @return [Float]
         def magnetic_variation_degrees
           _nsew_signed_float(@fields[10], @fields[11])
         end

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

@@ -7,6 +7,9 @@ module NMEAPlus
         field_reader :total_messages, 1, :_integer
         field_reader :message_number, 2, :_integer
         field_reader :mode, 3, :_string
+
+        # @!parse attr_reader :waypoints
+        # @return [Array<Integer>]
         def waypoints
           @fields[4..-1].map(&:to_i)
         end

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

@@ -8,6 +8,8 @@ module NMEAPlus
         field_reader :message_number, 2, :_integer
 
         # returns pairs of frequency, mode
+        # @!parse attr_reader :frequencies
+        # @return [Array<Float>]
         def frequencies
           @fields[3..-1].each_slice(2).to_a.map { |x| [x[0].to_f, x[1]] }
         end

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

@@ -4,14 +4,20 @@ module NMEAPlus
   module Message
     module NMEA
       class TRF < NMEAPlus::Message::NMEA::NMEAMessage
+        # @!parse attr_reader :utc_time
+        # @return [Time]
         def utc_time
           _utc_date_time(@fields[2], @fields[1])
         end
 
+        # @!parse attr_reader :latitude
+        # @return [Float]
         def latitude
           _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])
         end

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

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

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

@@ -4,10 +4,14 @@ module NMEAPlus
   module Message
     module NMEA
       class WPL < NMEAPlus::Message::NMEA::NMEAMessage
+        # @!parse attr_reader :latitude
+        # @return [Float]
         def latitude
           _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])
         end

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

@@ -4,8 +4,10 @@ module NMEAPlus
   module Message
     module NMEA
       class ZDA < NMEAPlus::Message::NMEA::NMEAMessage
-        def utc_time
 
+        # @!parse attr_reader :utc_time
+        # @return [Time]
+        def utc_time
           re_format = /(\d{2})(\d{2})(\d{2}(\.\d+)?)/
           hms = re_format.match(@fields[1])
           begin

data/lib/nmea_plus/nmea_message_factory.rb

@@ -79,6 +79,8 @@ require_relative 'message/nmea/ztg'
 # proprietary
 require_relative 'message/nmea/pashr'
 
+module NMEAPlus
+
 =begin boilerplate for message definitions
 require_relative 'base_nmea'
 
@@ -93,8 +95,6 @@ module NMEAPlus
 end
 =end
 
-module NMEAPlus
-
   # Defines a factory for NMEA messages, which will all use {NMEAPlus::Message::NMEA::NMEAMessage} as their base
   class NMEAMessageFactory < MessageFactory
 

data/lib/nmea_plus/version.rb

@@ -1,3 +1,3 @@
 module NMEAPlus
-  VERSION = '1.0.3'
+  VERSION = '1.0.4'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nmea_plus
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - Ian Katz