nmea_plus 1.0.19 → 1.0.20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f4f010527bee0d7b099f325462192d6a4bec777d
-  data.tar.gz: 3ba3d24e2e9d7c528a715e78bcf75f9a2a8761c7
+  metadata.gz: 192fcfbfc6d0cd90c8aba5b8e96d1c32d3f9f914
+  data.tar.gz: 10a2a3d25d1adcf9bedc62412dc34bf603cb72b8
 SHA512:
-  metadata.gz: 0c8e76585ed77014f380986bb8a096d153bf6623be0bbdfbd4ee995839112441faee45e494a91e23b538803644ed94735e4f4203804c98a879a6591b3d716d3b
-  data.tar.gz: 13822fff593849931ed44fbcfaddee29799cb7c7cb0cea01f28d40449c4f3aa16b2c7f6c71bb558ba6963b087bdec317887ef5b9ac733759f6eda04e71d0a785
+  metadata.gz: 0eaec038db3ae98e857364218759576fe6458aa03d5853dbbd75aae2198d16734cfcaab2b3ca4b15117d047a981af5fa5b84a370c46a7bffb06ed56937b7ef57
+  data.tar.gz: f9f82e8c1f3a87778b8662c1825317032fe9a6d1f22310cd93e7833bbeb92e67cf3a5922f1ffaa2a23c9ad97be5ebcb219f40c4c4956eaf9be68a3f8f85a630e

data/README.md

@@ -2,7 +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://www.rubydoc.info/gems/nmea_plus/1.0.19)
+[![Documentation](http://img.shields.io/badge/docs-rdoc.info-blue.svg)](http://www.rubydoc.info/gems/nmea_plus/1.0.20)
 
 [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.
 
@@ -86,12 +86,31 @@ end
 
 ## NMEA (GPS) Parsing
 
-This gem was coded to accept the standard NMEA messages defined in the unoffical spec found here:
-http://www.catb.org/gpsd/NMEA.txt
+This gem was coded to accept the standard NMEA messages defined in the official and unoffical specs found here:
+
+* http://www.catb.org/gpsd/NMEA.txt
+* http://www.nmea.org/Assets/100108_nmea_0183_sentences_not_recommended_for_new_designs.pdf
 
 Because the message types are standard, if no override is found for a particular talker ID then the message will parse according to the command (the last 3 characters) of the data type.  In other words, `$GPGLL` will use the general `GLL` message type.  Currently, the following standard message types are supported:
 
-> AAM, ALM, APA, APB, BOD, BWC, BWR, BWW, DBK, DBS, DBT, DCN, DPT, DTM, FSI, GBS, GGA, GLC, GLL, GNS, GRS, GSA, GST, GSV, GTD, GXA, HDG, HDM, HDT, HFB, HSC, ITS, LCD, MSK, MSS, MTW, MWV, OLN, OSD, R00, RMA, RMB, RMC, ROT, RPM, RSA, RSD, RTE, SFI, STN, TDS, TFI, TPC, TPR, TPT, TRF, TTM, VBW, VDR, VHW, VLW, VPW, VTG, VWR, WCV, WNC, WPL, XDR, XTE, XTR, ZDA, ZFO, ZTG
+> AAM, ALM, APA, APB,
+> BEC, BER, BOD, BPI, BWC, BWR, BWW,
+> DBK, DBS, DBT, DCN, DPT, DRU, DTM,
+> FSI,
+> GBS, GDA, GDF, GDP, GGA, GLA, GLC, GLF, GLL, GLP, GOA, GOF, GOP, GNS, GRS, GSA, GST, GSV, GTD, GXA, GXF, GXP,
+> HCC, HCD, HDG, HDM, HDT, HFB, HSC, HTC, HVD, HVM,
+> IMA, ITS,
+> LCD,
+> MDA, MHU, MMB, MSK, MSS, MTA, MTW, MWH, MWS, MWV,
+> OLN, OLW, OMP, ONZ, OSD,
+> Rnn (R00, R01, ...), RMA, RMB, RMC, RNN, ROT, RPM, RSA, RSD, RTE,
+> SBK, SCD, SCY, SDB, SFI, SGD, SGR, SIU, SLC, SNC, SNU, SPS, SSF, STC, STN, STR, SYS
+> TDS, TEC, TEP, TFI, TGA, TIF, TPC, TPR, TPT, TRF, TRP, TRS, TTM,
+> VBW, VCD, VDR, VHW, VLW, VPE, VPW, VTA, VTG, VTI, VWE, VWR, VWT
+> WCV, WDC, WDR, WFM, WNC, WNR, WPL,
+> XDR, XTE, XTR,
+> YWP, YWS,
+> ZCD, ZDA, ZEV, ZFI, ZFO, ZLZ, ZPI, ZTA, ZTE, ZTG, ZTI, ZWP, ZZU
 
 Support for proprietary NMEA messages is also possible.  PASHR is included as proof-of-concept.
 

data/lib/nmea_plus/ais_message_factory.rb

@@ -2,6 +2,7 @@
 require_relative 'message_factory'
 
 require_relative 'message/ais/vdm'
+require_relative 'message/ais/vdo'
 
 module NMEAPlus
 
@@ -19,9 +20,7 @@ module NMEAPlus
     # @return [Array] Array of data_type strings that we will attempt to use in decoding the message
     def self.alternate_data_type(data_type)
       # match last 3 digits (get rid of talker)
-      ret = [data_type[2..4]]
-      ret << "VDM" if data_type == "AIVDO"
-      ret
+      [data_type[2..4]]
     end
   end
 end

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

@@ -0,0 +1,14 @@
+require_relative "vdm"
+
+module NMEAPlus
+  module Message
+    module AIS
+
+      # VDO - Ownship Vessel Data Message
+      # This message type thinly wraps AIS payloads.
+      # @see NMEAPlus::Message::AIS::VDMPayload::VDMMsg
+      class VDO < NMEAPlus::Message::AIS::VDM
+      end
+    end
+  end
+end

data/lib/nmea_plus/message/base.rb

@@ -13,6 +13,14 @@ module NMEAPlus
       # 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.
+      #
+      #  The formatting function MUST be a static method on this class.  This is a limitation caused by the desire
+      #  to both (1) expose the formatters outside this class, and (2) use them for metaprogramming without the
+      #  having to name the entire function.  field_reader is a static method, so if not for the fact that
+      #  `self.class.methods.include? formatter` fails to work for class methods in this context (unlike
+      #  `self.methods.include?`, which properly finds instance methods), I would allow either one and just
+      #  conditionally `self.class_eval` the proper definition
+      #
       # @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)
@@ -24,7 +32,7 @@ module NMEAPlus
         if formatter.nil?
           self.class_eval("def #{name};@fields[#{field_num}];end")
         else
-          self.class_eval("def #{name};#{formatter}(@fields[#{field_num}]);end")
+          self.class_eval("def #{name};self.class.#{formatter}(@fields[#{field_num}]);end")
         end
       end
 
@@ -158,7 +166,7 @@ module NMEAPlus
       # 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)
+      def self._integer(field)
         return nil if field.nil? || field.empty?
         field.to_i
       end
@@ -167,7 +175,7 @@ module NMEAPlus
       # 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)
+      def self._float(field)
         return nil if field.nil? || field.empty?
         field.to_f
       end
@@ -176,7 +184,7 @@ module NMEAPlus
       # 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)
+      def self._string(field)
         return nil if field.nil? || field.empty?
         field
       end
@@ -185,7 +193,7 @@ module NMEAPlus
       # 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)
+      def self._hex_to_integer(field)
         return nil if field.nil? || field.empty?
         field.hex
       end
@@ -194,7 +202,7 @@ module NMEAPlus
       # 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)
+      def self._utctime_hms(field)
         return nil if field.nil? || field.empty?
         re_format = /(\d{2})(\d{2})(\d{2}(\.\d+)?)/
         now = Time.now
@@ -210,12 +218,12 @@ module NMEAPlus
       # 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)
+      def self._interval_hms(field)
         return nil if field.nil? || field.empty?
         re_format = /(\d{2})(\d{2})(\d{2}(\.\d+)?)/
         begin
           hms = re_format.match(field)
-          Time.new(0, 0, 0, hms[1].to_i, hms[2].to_i, hms[3].to_f, '+00:00')
+          Time.new(0, 1, 1, hms[1].to_i, hms[2].to_i, hms[3].to_f, '+00:00')
         rescue
           nil
         end
@@ -225,7 +233,7 @@ module NMEAPlus
       # @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)
+      def self._utc_date_time(d_field, t_field)
         return nil if t_field.nil? || t_field.empty?
         return nil if d_field.nil? || d_field.empty?
 

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

@@ -4,16 +4,40 @@ module NMEAPlus
   module Message
     module NMEA
       # APA - Autopilot Sentence "A"
+      #
+      # Commonly used by autopilots this sentence contains navigation receiver warning flag status, cross-track-error, waypoint
+      # arrival status and initial bearing from origin waypoint to the destination waypoint for the active navigation leg of the
+      # journey.
+      # Use of $--APB with additional data fields of heading-to-steer and bearing from present position to destination is
+      # recommended.
+      # @see APB
       class APA < NMEAPlus::Message::NMEA::NMEAMessage
+        # Data Status: "OR" of Loran-C Blink and SNR warning flags
         field_reader :no_general_warning?, 1, :_av_boolean
+
+        # Data status: Loran-C Cycle Lock warning flag
         field_reader :no_cyclelock_warning?, 2, :_av_boolean
+
+        # Magnitude of XTE (cross-track-error)
         field_reader :cross_track_error, 3, :_float
+
+        # Direction to steer, L/R
         field_reader :direction_to_steer, 4, :_string
+
+        # XTE units, nautical miles
         field_reader :cross_track_units, 5, :_string
+
+        # Status: arrival circle entered
         field_reader :arrival_circle_entered?, 6, :_av_boolean
+
+        # Status: perpendicular passed at waypoint
         field_reader :perpendicular_passed?, 7, :_av_boolean
+
+        # Bearing origin to destination, Mag.
         field_reader :bearing_origin_to_destination, 8, :_float
         field_reader :compass_type, 9, :_string
+
+        # Destination waypoint ID
         field_reader :destination_waypoint_id, 10, :_string
       end
     end

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

@@ -31,7 +31,7 @@ module NMEAPlus
         # 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)
+        def self._av_boolean(field)
           case field
           when 'A' then return true
           when 'V' then return false
@@ -43,7 +43,7 @@ module NMEAPlus
         # 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)
+        def self._10_boolean(field)
           case field
           when '1' then return true
           when '0' then return false

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

@@ -0,0 +1,12 @@
+require_relative "bwr"
+
+module NMEAPlus
+  module Message
+    module NMEA
+      # BEC - Bearing & Distance, Great Circle
+      # Same fields as BWR
+      class BEC < NMEAPlus::Message::NMEA::BWR
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+require_relative "bwr"
+
+module NMEAPlus
+  module Message
+    module NMEA
+      # BER - Bearing & Distance to Waypoint, Dead Reckoning, Rhumb Line
+      # Same fields as BWR
+      #
+      # Time (UTC) and distance & bearing to, and location of, a specified waypoint from present position:
+      # Calculated along the rhumb line from a dead reckoned present position. The use of
+      # $--BEC using great circle calculations is recommended.
+      # @see BEC
+      class BER < NMEAPlus::Message::NMEA::BWR
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+require_relative "bwr"
+
+module NMEAPlus
+  module Message
+    module NMEA
+      # BPI - Bearing & Distance to Point of Interest
+      # Same fields as BWR
+      #
+      # Time (UTC) and distance & bearing to, and location of, a specified waypoint from present position:
+      # BPI: Calculated along a great circle path from a measured present position. Redundant with
+      # BWC, the use of $--BWC is recommended.
+      # @see BWC
+      class BPI < NMEAPlus::Message::NMEA::BWR
+      end
+    end
+  end
+end

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

@@ -5,23 +5,33 @@ module NMEAPlus
     module NMEA
       # BWR - Bearing and Distance to Waypoint - Rhumb Line
       class BWR < NMEAPlus::Message::NMEA::NMEAMessage
+        # UTC of observation
         field_reader :utc_time, 1, :_utctime_hms
 
+        # Waypoint latitude, N/S
         # @!parse attr_reader :waypoint_latitude
         # @return [Float]
         def waypoint_latitude
           self.class.degrees_minutes_to_decimal(@fields[2], @fields[3])
         end
 
+        # Waypoint longitude, E/W
         # @!parse attr_reader :waypoint_longitude
         # @return [Float]
         def waypoint_longitude
           self.class.degrees_minutes_to_decimal(@fields[4], @fields[5])
         end
 
+        # Bearing, degrees True
         field_reader :bearing_true, 6, :_float
+
+        # Bearing, degrees Magnetic
         field_reader :bearing_magnetic, 8, :_float
+
+        # Distance, nautical miles
         field_reader :nautical_miles, 10, :_float
+
+        # Waypoint ID
         field_reader :waypoint_id, 12, :_string
 
       end

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

@@ -4,9 +4,18 @@ module NMEAPlus
   module Message
     module NMEA
       # DBK - Depth Below Keel
+      #
+      # Water depth referenced to the vessel's keel
+      # The use of $--DPT is recommended
+      # @see DPT
       class DBK < NMEAPlus::Message::NMEA::NMEAMessage
+        # Water depth, feet
         field_reader :depth_feet, 1, :_float
+
+        # Water depth, Meters
         field_reader :depth_meters, 3, :_float
+
+        # Water depth, Fathoms
         field_reader :depth_fathoms, 5, :_float
       end
     end

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

@@ -5,6 +5,10 @@ module NMEAPlus
   module Message
     module NMEA
       # DBS - Depth Below Surface
+      #
+      # Water depth referenced to the water surface
+      # The use of $--DPT is recommended
+      # @see DPT
       class DBS < NMEAPlus::Message::NMEA::DBK
       end
     end

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

@@ -3,24 +3,70 @@ require_relative "base_nmea"
 module NMEAPlus
   module Message
     module NMEA
-      # DCN - Decca Position
+      # DCN - DECCA Position
+      #
+      # Status and lines-of-position for a specified DECCA chain.
       class DCN < NMEAPlus::Message::NMEA::NMEAMessage
+        # DECCA chain identifier
         field_reader :decca_chain_id, 1, :_integer
+
+        # Red zone identifier, number-letter
         field_reader :red_zone_id, 2, :_string
+
+        # Red line of position (LOP)
         field_reader :red_position_line, 3, :_float
+
+        # Status: Red-master line, true = Valid, false = Data not valid
         field_reader :red_master_line_ok?, 4, :_av_boolean
+
+        # Green zone identifier, number-letter
         field_reader :green_zone_id, 5, :_string
+
+        # Green line of position (LOP)
         field_reader :green_position_line, 6, :_float
+
+        # Status: Green-master line, true = Valid, false = Data not valid
         field_reader :green_master_line_ok?, 7, :_av_boolean
+
+        # Purple zone identifier, number-letter
         field_reader :purple_zone_id, 8, :_string
+
+        # Purple line of position (LOP)
         field_reader :purple_position_line, 9, :_float
+
+        # Status: Purple-master line, true = Valid, false = Data not valid
         field_reader :purple_master_line_ok?, 10, :_av_boolean
+
+        # Red-line navigation use
         field_reader :use_red_line_navigation?, 11, :_av_boolean
+
+        # Green-line navigation use
         field_reader :use_green_line_navigation?, 12, :_av_boolean
+
+        # Purple-line navigation use
         field_reader :use_purple_line_navigation?, 13, :_av_boolean
+
+        # Position uncertainty, n. miles
         field_reader :position_uncertainty, 14, :_float
         field_reader :position_uncertainty_units, 15, :_string
+
+        # Fix data basis:
+        #
+        # 1 = Normal pattern
+        # 2 = Lane identification pattern
+        # 3 = Lane identification transmissions
         field_reader :fix_data_basis, 16, :_integer
+
+        # @!parse attr_reader :fix_data_basis_description
+        # @return [String]
+        def fix_data_basis_description
+          case fix_data_basis
+          when 1 then return "Normal pattern"
+          when 2 then return "Lane identification pattern"
+          when 3 then return "Lane identification transmissions"
+          end
+          nil
+        end
       end
     end
   end

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

@@ -0,0 +1,33 @@
+require_relative "base_nmea"
+
+module NMEAPlus
+  module Message
+    module NMEA
+      # DRU - Dual Doppler Auxiliary Data
+      #
+      # Depth, turn rate and % RPM in support of Doppler velocity systems.
+      # The use of $--DPT is recommended for depth data,
+      # $--RPM for shaft rotation and
+      # $--ROT for rate of turn.
+      # @see DPT
+      # @see RPM
+      # @see ROT
+      class DRU < NMEAPlus::Message::NMEA::NMEAMessage
+        # Depth, meters
+        field_reader :depth_meters, 1, :_float
+
+        # Status: Depth
+        field_reader :depth_valid?, 2, :_av_boolean
+
+        # Rate of turn, degrees per minute, "-" = port
+        field_reader :rate_of_turn_starboard_degrees_per_minute, 3, :_float
+
+        # Status: Rate of turn
+        field_reader :rate_of_turn_valid?, 4, :_av_boolean
+
+        # Propeller shaft rotation, % of maximum, "-" = astern
+        field_reader :rotation_percentage, 5, :_float
+      end
+    end
+  end
+end