nmea_plus 1.0.19 → 1.0.20

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

@@ -0,0 +1,39 @@
+require_relative "base_nmea"
+
+module NMEAPlus
+  module Message
+    module NMEA
+      # GDA - Dead Reckoning Positions
+      #
+      # The use of waypoint location $--WPL (for past positions) or $--GLL (for present position) followed by time tag $--ZDA
+      # is recommended for reporting past or present waypoint times; $--WPL followed by $--ZTG is recommended for
+      # estimated time.
+      # @see WPL
+      # @see GLL
+      # @see ZDA
+      # @see ZTG
+      class GDA < NMEAPlus::Message::NMEA::NMEAMessage
+
+        # UTC of position fix
+        field_reader :fix_time, 1, :_utctime_hms
+
+        # Latitude - N/S
+        # @!parse attr_reader :latitude
+        # @return [Float]
+        def latitude
+          self.class.degrees_minutes_to_decimal(@fields[2], @fields[3])
+        end
+
+        # Longitude - E/W
+        # @!parse attr_reader :longitude
+        # @return [Float]
+        def longitude
+          self.class.degrees_minutes_to_decimal(@fields[4], @fields[5])
+        end
+
+        # Waypoint ID
+        field_reader :waypoint_id, 6, :_string
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+require_relative "gda"
+
+module NMEAPlus
+  module Message
+    module NMEA
+      # GDF - Dead Reckoning Positions
+      #
+      # The use of waypoint location $--WPL (for past positions) or $--GLL (for present position) followed by time tag $--ZDA
+      # is recommended for reporting past or present waypoint times; $--WPL followed by $--ZTG is recommended for
+      # estimated time.
+      # @see WPL
+      # @see GLL
+      # @see ZDA
+      # @see ZTG
+      class GDF < NMEAPlus::Message::NMEA::GDA
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+require_relative "gda"
+
+module NMEAPlus
+  module Message
+    module NMEA
+      # GDP - Dead Reckoning Positions
+      #
+      # The use of waypoint location $--WPL (for past positions) or $--GLL (for present position) followed by time tag $--ZDA
+      # is recommended for reporting past or present waypoint times; $--WPL followed by $--ZTG is recommended for
+      # estimated time.
+      # @see WPL
+      # @see GLL
+      # @see ZDA
+      # @see ZTG
+      class GDP < NMEAPlus::Message::NMEA::GDA
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+require_relative "gda"
+
+module NMEAPlus
+  module Message
+    module NMEA
+      # GLA - Loran-C Positions
+      # Same fields as GDA
+      #
+      # The use of waypoint location $--WPL (for past positions) or $--GLL (for present position) followed by time tag $--ZDA
+      # is recommended for reporting past or present waypoint times; $--WPL followed by $--ZTG is recommended for
+      # estimated time.
+      # @see WPL
+      # @see GLL
+      # @see ZDA
+      # @see ZTG
+      class GLA < NMEAPlus::Message::NMEA::GDA
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+require_relative "gda"
+
+module NMEAPlus
+  module Message
+    module NMEA
+      # GLF - Loran-C Determined Positions
+      #
+      # The use of waypoint location $--WPL (for past positions) or $--GLL (for present position) followed by time tag $--ZDA
+      # is recommended for reporting past or present waypoint times; $--WPL followed by $--ZTG is recommended for
+      # estimated time.
+      # @see WPL
+      # @see GLL
+      # @see ZDA
+      # @see ZTG
+      class GLF < NMEAPlus::Message::NMEA::GDA
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+require_relative "gda"
+
+module NMEAPlus
+  module Message
+    module NMEA
+      # GLP - Loran-C Determined Positions
+      #
+      # The use of waypoint location $--WPL (for past positions) or $--GLL (for present position) followed by time tag $--ZDA
+      # is recommended for reporting past or present waypoint times; $--WPL followed by $--ZTG is recommended for
+      # estimated time.
+      # @see WPL
+      # @see GLL
+      # @see ZDA
+      # @see ZTG
+      class GLP < NMEAPlus::Message::NMEA::GDA
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+require_relative "gda"
+
+module NMEAPlus
+  module Message
+    module NMEA
+      # GOA - OMEGA Positions
+      # Same fields as GDA
+      #
+      # The use of waypoint location $--WPL (for past positions) or $--GLL (for present position) followed by time tag $--ZDA
+      # is recommended for reporting past or present waypoint times; $--WPL followed by $--ZTG is recommended for
+      # estimated time.
+      # @see WPL
+      # @see GLL
+      # @see ZDA
+      # @see ZTG
+      class GOA < NMEAPlus::Message::NMEA::GDA
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+require_relative "gda"
+
+module NMEAPlus
+  module Message
+    module NMEA
+      # GOF - Omega Determined Positions
+      #
+      # The use of waypoint location $--WPL (for past positions) or $--GLL (for present position) followed by time tag $--ZDA
+      # is recommended for reporting past or present waypoint times; $--WPL followed by $--ZTG is recommended for
+      # estimated time.
+      # @see WPL
+      # @see GLL
+      # @see ZDA
+      # @see ZTG
+      class GOF < NMEAPlus::Message::NMEA::GDA
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+require_relative "gda"
+
+module NMEAPlus
+  module Message
+    module NMEA
+      # GOP - Omega Determined Positions
+      #
+      # The use of waypoint location $--WPL (for past positions) or $--GLL (for present position) followed by time tag $--ZDA
+      # is recommended for reporting past or present waypoint times; $--WPL followed by $--ZTG is recommended for
+      # estimated time.
+      # @see WPL
+      # @see GLL
+      # @see ZDA
+      # @see ZTG
+      class GOP < NMEAPlus::Message::NMEA::GDA
+      end
+    end
+  end
+end

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

@@ -4,11 +4,23 @@ module NMEAPlus
   module Message
     module NMEA
       # GTD - Geographic Location in Time Differences
+      # Loran-C Time Difference (TD) lines of position for present vessel position.
+      # The use of $--GLC is recommended
+      # @see GLC
       class GTD < NMEAPlus::Message::NMEA::NMEAMessage
+        # TD 1, micro-seconds
         field_reader :difference1, 1, :_float
+
+        # TD 2, micro-seconds
         field_reader :difference2, 2, :_float
+
+        # TD 3, micro-seconds
         field_reader :difference3, 3, :_float
+
+        # TD 4, micro-seconds
         field_reader :difference4, 4, :_float
+
+        # TD 5, micro-seconds
         field_reader :difference5, 5, :_float
       end
     end

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

@@ -1,26 +1,22 @@
-require_relative "base_nmea"
+require_relative "gda"
 
 module NMEAPlus
   module Message
     module NMEA
       # GXA - TRANSIT Position - Latitude/Longitude
-      class GXA < NMEAPlus::Message::NMEA::NMEAMessage
-
-        field_reader :fix_time, 1, :_utctime_hms
-
-        # @!parse attr_reader :latitude
-        # @return [Float]
-        def latitude
-          self.class.degrees_minutes_to_decimal(@fields[2], @fields[3])
-        end
-
-        # @!parse attr_reader :longitude
-        # @return [Float]
-        def longitude
-          self.class.degrees_minutes_to_decimal(@fields[4], @fields[5])
-        end
-
-        field_reader :waypoint_id, 6, :_integer
+      #
+      # Location and time of TRANSIT fix at waypoint "c--c".
+      # TRANSIT system is not operational, no recommended replacement.
+      #
+      # The use of waypoint location $--WPL (for past positions) or $--GLL (for present position) followed by time tag $--ZDA
+      # is recommended for reporting past or present waypoint times; $--WPL followed by $--ZTG is recommended for
+      # estimated time.
+      # @see WPL
+      # @see GLL
+      # @see ZDA
+      # @see ZTG
+      class GXA < NMEAPlus::Message::NMEA::GDA
+        # Satellite number
         field_reader :satellite, 7, :_integer
       end
     end

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

@@ -0,0 +1,19 @@
+require_relative "gxa"
+
+module NMEAPlus
+  module Message
+    module NMEA
+      # GXF - TRANSIT Determined Positions
+      #
+      # The use of waypoint location $--WPL (for past positions) or $--GLL (for present position) followed by time tag $--ZDA
+      # is recommended for reporting past or present waypoint times; $--WPL followed by $--ZTG is recommended for
+      # estimated time.
+      # @see WPL
+      # @see GLL
+      # @see ZDA
+      # @see ZTG
+      class GXF < NMEAPlus::Message::NMEA::GXA
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+require_relative "gxa"
+
+module NMEAPlus
+  module Message
+    module NMEA
+      # GXP - TRANSIT Determined Positions
+      #
+      # The use of waypoint location $--WPL (for past positions) or $--GLL (for present position) followed by time tag $--ZDA
+      # is recommended for reporting past or present waypoint times; $--WPL followed by $--ZTG is recommended for
+      # estimated time.
+      # @see WPL
+      # @see GLL
+      # @see ZDA
+      # @see ZTG
+      class GXP < NMEAPlus::Message::NMEA::GXA
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+require_relative "base_nmea"
+
+module NMEAPlus
+  module Message
+    module NMEA
+      # HCC - Compass Heading
+      # Vessel compass heading, which differs from magnetic heading by the amount of uncorrected magnetic deviation.
+      #
+      # The use of $--HDG is recommended.
+      # @see HCC
+      class HCC < NMEAPlus::Message::NMEA::NMEAMessage
+        # Compass heading, degrees
+        field_reader :compass_heading_degrees, 1, :_float
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+require_relative "hdm"
+
+module NMEAPlus
+  module Message
+    module NMEA
+      # HCD - Heading and Deviation
+      # Actual vessel magnetic heading, indicated compass heading and the difference (deviation) between them.
+      #
+      # Easterly deviation (E) subtracts from Compass Heading
+      # Westerly deviation (W) adds to Compass Heading
+      #
+      # The use of $--HDG is recommended.
+      # @see HDG
+      class HCD < NMEAPlus::Message::NMEA::HDM
+        # Compass heading, degrees
+        field_reader :compass_heading_degrees, 3, :_float
+
+        # Magnetic deviation, degrees E/W
+        # @!parse attr_reader :magnetic_deviation_degrees
+        # @return [Float]
+        def magnetic_deviation_degrees
+          self.class.nsew_signed_float(@fields[5], @fields[6])
+        end
+
+      end
+    end
+  end
+end

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

@@ -1,4 +1,3 @@
-require_relative "base_nmea"
 require_relative "hdm"
 
 module NMEAPlus

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

@@ -4,7 +4,12 @@ module NMEAPlus
   module Message
     module NMEA
       # HDM - Heading - Magnetic
+      # Actual vessel heading in degrees Magnetic.
+      #
+      # The use of $--HDG is recommended.
+      # @see HDG
       class HDM < NMEAPlus::Message::NMEA::NMEAMessage
+        # Magnetic heading, degrees
         field_reader :magnetic_heading_degrees, 1, :_float
       end
     end

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

@@ -4,7 +4,9 @@ module NMEAPlus
   module Message
     module NMEA
       # HDT - Heading - True
+      # Actual vessel heading in degrees True produced by any device or system producing true heading
       class HDT < NMEAPlus::Message::NMEA::NMEAMessage
+        # Heading, degrees True
         field_reader :true_heading_degrees, 1, :_float
       end
     end

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

@@ -0,0 +1,11 @@
+require_relative "hdt"
+
+module NMEAPlus
+  module Message
+    module NMEA
+      # HTC - Heading, True
+      # Actual vessel heading in degrees True produced by any device or system producing true heading
+      class HTC < NMEAPlus::Message::NMEA::HDT; end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+require_relative "base_nmea"
+
+module NMEAPlus
+  module Message
+    module NMEA
+      # HVD - Magnetic Variation, Automatic
+      #
+      # Magnetic variation, automatically derived (calculated or from a data base)
+      #
+      # The use of $--HDG is recommended.
+      # @see HDG
+      class HVD < NMEAPlus::Message::NMEA::NMEAMessage
+        # Magnetic variation, degrees E/W
+        # @!parse attr_reader :magnetic_variation_degrees
+        # @return [Float]
+        def magnetic_variation_degrees
+          self.class.nsew_signed_float(@fields[1], @fields[2])
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+require_relative "hvd"
+
+module NMEAPlus
+  module Message
+    module NMEA
+      # HVM - Magnetic Variation, Manually Set
+      #
+      # Magnetic variation, manually entered
+      #
+      # The use of $--HDG is recommended.
+      # @see HDG
+      class HVM < NMEAPlus::Message::NMEA::HVD; end
+    end
+  end
+end