nmea_plus 1.0.19 → 1.0.20

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

@@ -0,0 +1,41 @@
+require_relative "base_nmea"
+
+module NMEAPlus
+  module Message
+    module NMEA
+      # TRS - TRANSIT Satellite Operating Status
+      # TRANSIT system is not operational, no recommended replacement.
+      class TRS < NMEAPlus::Message::NMEA::NMEAMessage
+
+        # TRANSIT system operating status
+        # @!parse attr_reader :status
+        # @return [Symbol]
+        def status
+          case @fields[1]
+          when 'A' then :acquiring
+          when 'c' then :calculating
+          when 'e' then :error
+          when 'm' then :message
+          when 'T' then :test
+          when 'U' then :dead_reckoning
+          end
+        end
+
+        # Description of status
+        # @!parse attr_reader :status_description
+        # @return [String]
+        def status_description
+          case status
+          when :acquiring then 'Acquiring'
+          when :calculating then 'Calculating'
+          when :error then 'Error'
+          when :message then 'Message'
+          when :test then 'Test'
+          when :dead_reckoning then 'Dead reckoning'
+          end
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+require_relative "base_nmea"
+
+module NMEAPlus
+  module Message
+    module NMEA
+      # VCD - Current at Selected Depth
+      # Limited utility, no recommended replacement
+      class VCD < NMEAPlus::Message::NMEA::NMEAMessage
+        # Depth, feet
+        field_reader :depth_feet, 1, :_float
+
+        # Depth, meters
+        field_reader :depth_meters, 3, :_float
+
+        # Current, knots
+        field_reader :water_current_speed_knots, 5, :_float
+
+        # Current, meters/second
+        field_reader :water_current_speed_ms, 7, :_float
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+require_relative "base_nmea"
+
+module NMEAPlus
+  module Message
+    module NMEA
+      # VPE - Speed, Dead Reckoned Parallel to True Wind
+      # Limited utility, no recommended replacement.
+      class VPE < NMEAPlus::Message::NMEA::NMEAMessage
+        # Speed, knots, "-" = downwind
+        field_reader :speed_knots, 1, :_float
+
+        # Speed, meters/second, "-" = downwind
+        field_reader :speed_ms, 3, :_float
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+require_relative "base_nmea"
+
+module NMEAPlus
+  module Message
+    module NMEA
+      # VTA - Actual Track
+      # Limited utility, possible use of $--VTG for a portion of the data.
+      class VTA < NMEAPlus::Message::NMEA::NMEAMessage
+        # Track made good, degrees True
+        field_reader :track_degrees_true, 1, :_float
+
+        # Track made good, degrees Magnetic
+        field_reader :track_degrees_magnetic, 3, :_float
+
+        # Speed made good, knots
+        field_reader :speed_made_good_knots, 5, :_float
+
+        # Distance made good, naut. miles
+        field_reader :distance_made_good_nautical_miles, 7, :_float
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+require_relative "base_nmea"
+
+module NMEAPlus
+  module Message
+    module NMEA
+      # VTI - Intended Track
+      # Limited utility, no recommended replacement.
+      class VTI < NMEAPlus::Message::NMEA::NMEAMessage
+        # Intended track, degrees True
+        field_reader :intended_track_degrees_true, 1, :_float
+
+        # Intended track, degrees Magnetic
+        field_reader :intended_track_degrees_magnetic, 3, :_float
+
+        # Speed made good, knots
+        field_reader :speed_made_good_knots, 5, :_float
+
+        # Distance made good, naut. miles
+        field_reader :distance_made_good_nautical_miles, 7, :_float
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+require_relative "base_nmea"
+
+module NMEAPlus
+  module Message
+    module NMEA
+      # VWE - Wind Track Efficiency
+      # Limited utility, no recommended replacement.
+      class VWE < NMEAPlus::Message::NMEA::NMEAMessage
+        # Efficiency, percent
+        field_reader :efficiency_percent, 1, :_float
+      end
+    end
+  end
+end

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

@@ -4,11 +4,24 @@ module NMEAPlus
   module Message
     module NMEA
       # VWR - Relative Wind Speed and Angle
+      # Wind angle in relation to the vessel's heading and wind speed measured relative to the moving vessel.
+      #
+      # The use of $--MWV is recommended
+      # @see MWV
       class VWR < NMEAPlus::Message::NMEA::NMEAMessage
-        field_reader :wind_direction_degrees, 1, :_float
-        field_reader :wind_direction_bow, 2, :_string
+        # Measured wind angle relative to the vessel, 0 to 180, left/right L/R of vessel heading
+        field_reader :measured_wind_direction_degrees, 1, :_float
+
+        # Left/right L/R of vessel heading
+        field_reader :measured_wind_direction_bow, 2, :_string
+
+        # Measured wind Speed, knots
         field_reader :speed_knots, 3, :_float
+
+        # Wind speed, meters/second
         field_reader :speed_ms, 5, :_float
+
+        # Wind speed, Km/Hr
         field_reader :speed_kmh, 7, :_float
       end
     end

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

@@ -0,0 +1,35 @@
+require_relative "base_nmea"
+
+module NMEAPlus
+  module Message
+    module NMEA
+      # VWT - True Wind Speed and Angle
+      #
+      # True wind angle in relation to the vessel's heading and true wind speed
+      # referenced to the water. True wind is the vector sum of the Relative
+      # (Apparent) wind vector and the vessel's velocity vector relative to the
+      # water along the heading line of the vessel. It represents the wind at
+      # the vessel if it were stationary relative to the water and heading in
+      # the same direction.
+      #
+      # The use of $--MWV is recommended
+      # @see MWV
+      class VWT < NMEAPlus::Message::NMEA::NMEAMessage
+        # Calculated wind angle relative to the vessel, 0 to 180, left/right L/R of vessel heading
+        field_reader :calculated_wind_direction_degrees, 1, :_float
+
+        # left/right L/R of vessel heading
+        field_reader :calculated_wind_direction_bow, 2, :_string
+
+        # Calculated wind Speed, knots
+        field_reader :speed_knots, 3, :_float
+
+        # Wind speed, meters/second
+        field_reader :speed_ms, 5, :_float
+
+        # Wind speed, Km/Hr
+        field_reader :speed_kmh, 7, :_float
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+require_relative "base_nmea"
+
+module NMEAPlus
+  module Message
+    module NMEA
+      # WDC - Distance to Waypoint
+      #
+      # Distance from present position to the specified waypoint.
+      # The use of $--BWC is recommended.
+      # @see BWC
+      class WDC < NMEAPlus::Message::NMEA::NMEAMessage
+        # Distance, nautical miles
+        field_reader :distance_nautical_miles, 1, :_float
+
+        # Waypoint identifier
+        field_reader :waypoint_id, 3, :_string
+      end
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+require_relative "wdc"
+
+module NMEAPlus
+  module Message
+    module NMEA
+      # WDR - Waypoint Distance, Rhumb Line
+      # The use of $--WDC using great circle calculations is recommended.
+      # @see WDC
+      class WDR < NMEAPlus::Message::NMEA::WDC; end
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+require_relative "base_nmea"
+
+module NMEAPlus
+  module Message
+    module NMEA
+      # WFM - Route Following Mode
+      class WFM < NMEAPlus::Message::NMEA::NMEAMessage
+        field_reader :automatic_route_following, 1, :_av_boolean
+      end
+    end
+  end
+end

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

@@ -5,9 +5,16 @@ module NMEAPlus
     module NMEA
       # WNC - Distance - Waypoint to Waypoint
       class WNC < NMEAPlus::Message::NMEA::NMEAMessage
+        # Distance, nautical miles
         field_reader :distance_nautical_miles, 1, :_float
+
+        # Distance, kilometers
         field_reader :distance_kilometers, 3, :_float
+
+        # TO waypoint ID
         field_reader :waypoint_to, 5, :_string
+
+        # FROM waypoint ID
         field_reader :waypoint_from, 6, :_string
       end
     end

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

@@ -0,0 +1,12 @@
+require_relative "wnc"
+
+module NMEAPlus
+  module Message
+    module NMEA
+      # WNR - Waypoint-to-Waypoint Distance, Rhumb Line
+      # The use of $--WNC using great circle calculations is recommended.
+      # @see WNC
+      class WNR < NMEAPlus::Message::NMEA::WNC; end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+require_relative "base_nmea"
+
+module NMEAPlus
+  module Message
+    module NMEA
+      # YWP - Water Propagation Speed
+      # Limited utility, no recommended replacement
+      class YWP < NMEAPlus::Message::NMEA::NMEAMessage
+        # Speed, feet/second
+        field_reader :speed_feet_second, 1, :_float
+
+        # Speed, meters/second
+        field_reader :speed_ms, 3, :_float
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+require_relative "base_nmea"
+
+module NMEAPlus
+  module Message
+    module NMEA
+      # YWS - Water Profile
+      # Limited utility, no recommended replacement
+      class YWS < NMEAPlus::Message::NMEA::NMEAMessage
+        # Salinity, parts/thousand
+        field_reader :salinity_ppt, 1, :_float
+
+        # Chlorinity, parts/thousand
+        field_reader :chlorinity_ppt, 2, :_float
+
+        # Temperature at depth, degrees C
+        field_reader :temperature_celsius, 3, :_float
+
+        # Depth, feet
+        field_reader :depth_feet, 5, :_float
+
+        # Depth, meters
+        field_reader :depth_meters, 7, :_float
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+require_relative "zzu"
+
+module NMEAPlus
+  module Message
+    module NMEA
+      # ZAA - Time, Elapsed/Estimated
+      # Base class for a series of deprecated $--Z-- messages
+      class ZAA < NMEAPlus::Message::NMEA::ZZU
+        # Waypoint ID
+        field_reader :waypoint_id, 3, :_string
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+require_relative "base_nmea"
+
+module NMEAPlus
+  module Message
+    module NMEA
+      # ZCD - Timer
+      # Limited utility, no recommended replacement.
+      class ZCD < NMEAPlus::Message::NMEA::NMEAMessage
+        # Timer initial value, seconds
+        field_reader :initial_time_seconds, 1, :_integer
+
+        # Timer control
+        # @!parse attr_reader :control
+        # @return [Symbol]
+        def control
+          case @fields[2]
+          when '+' then :up
+          when '-' then :down
+          when 'V' then :stop
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+require_relative "zzu"
+
+module NMEAPlus
+  module Message
+    module NMEA
+      # ZEV - Event Timer
+      # Limited utility, no recommended replacement.
+      class ZEV < NMEAPlus::Message::NMEA::ZZU
+        # Timer initial value
+        field_reader :initial_time, 2, :_interval_hms
+
+        # Timer control
+        # @!parse attr_reader :control
+        # @return [Symbol]
+        def control
+          case @fields[3]
+          when '+' then :up
+          when '-' then :down
+          when 'V' then :stop
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+require_relative "zaa"
+
+module NMEAPlus
+  module Message
+    module NMEA
+      # ZFI - Elapsed time from point-of-interest
+      # The use of $--ZFO is recommended.
+      # @see ZFO
+      class ZFI < NMEAPlus::Message::NMEA::ZAA
+        # Elapsed time from waypoint
+        field_reader :elapsed_time, 2, :_interval_hms
+      end
+    end
+  end
+end

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

@@ -6,7 +6,7 @@ module NMEAPlus
       # ZFO - UTC & Time from origin Waypoint
       class ZFO < NMEAPlus::Message::NMEA::NMEAMessage
         field_reader :utc_time, 1, :_utctime_hms
-        # field_reader :elapsed_time, 2, :_interval_hms
+        field_reader :elapsed_time, 2, :_interval_hms
         field_reader :origin_waypoint_id, 3, :_string
       end
     end

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

@@ -0,0 +1,19 @@
+require_relative "zzu"
+
+module NMEAPlus
+  module Message
+    module NMEA
+      # ZLZ - Time of Day
+      # Time of day in hours-minutes-seconds, both with respect to (UTC) and the local time zone.
+      # The use of $--ZDA is recommended
+      # @see ZDA
+      class ZLZ < NMEAPlus::Message::NMEA::ZZU
+        # Local time
+        field_reader :local_time, 2, :_utctime_hms
+
+        # Local zone description, 00 to 12
+        field_reader :zone_description, 3, :_integer
+      end
+    end
+  end
+end