nmea_plus 1.0.19 → 1.0.20

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

@@ -0,0 +1,22 @@
+require_relative "base_nmea"
+
+module NMEAPlus
+  module Message
+    module NMEA
+      # SGR - Loran-C Chain Identifier
+      # The unique Loran-C Chain identifier, representing Group Repetition Interval (GRI)
+      class SGR < NMEAPlus::Message::NMEA::NMEAMessage
+        # Chain ID, representing tens of microseconds
+        field_reader :chain_identifier, 1, :_integer
+
+        # GRI, microseconds.
+        # @!parse attr_reader :gri_microseconds
+        # @return [Integer]
+        def gri_microseconds
+          return nil if chain_identifier.nil?
+          chain_identifier * 10
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+require_relative "base_nmea"
+
+module NMEAPlus
+  module Message
+    module NMEA
+      # SIU - Loran-C Stations in Use
+      #
+      # The use of $--GLC is recommended
+      # @see GLC
+      class SIU < NMEAPlus::Message::NMEA::NMEAMessage
+        # Array of flags for stations in use, indexed by station number
+        # @!parse attr_reader :stations_in_use
+        # @return [Array<Boolean>]
+        def stations_in_use
+          # dummy index 0, empty fields indicate stations not in use
+          [false] + (1..8).to_a.map { |x| !(@fields[x].nil? || @fields[x].empty?) }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,66 @@
+require_relative "base_nmea"
+
+module NMEAPlus
+  module Message
+    module NMEA
+      # SLC - Loran-C Status
+      class SLC < NMEAPlus::Message::NMEA::NMEAMessage
+
+        # container for Omega lane indicators
+        class SLCStationReport
+          # Used in lat/lon calculation
+          # @return [Boolean]
+          attr_accessor :used_in_calculation
+
+          # Status: Blink Warning Flag
+          # @return [Boolean]
+          attr_accessor :blink_warning
+
+          # Status: Cycle Lock Warning Flag
+          # @return [Boolean]
+          attr_accessor :cycle_lock_warning
+
+          # Status: SNR Warning Flag
+          # @return [Boolean]
+          attr_accessor :snr_warning
+
+          # SNR value, 000 to 999
+          # @return [Integer]
+          attr_accessor :snr
+
+          # @param arr [Array<String, Integer>] a string and 2 integers
+          def initialize(arr, is_master)
+            @arr = arr
+            @used_in_calculation  = is_master ? true : NMEA::NMEAMessage._av_boolean(arr[0])
+            @blink_warning        = NMEA::NMEAMessage._av_boolean(arr[1])
+            @cycle_lock_warning   = NMEA::NMEAMessage._av_boolean(arr[2])
+            @snr_warning          = NMEA::NMEAMessage._av_boolean(arr[3])
+            @snr                  = arr[4].to_i
+          end
+        end
+
+        # station Status
+        # @!parse attr_reader :master_station
+        # @return [SLCStationReport]
+        def master_station
+          SLCStationReport.new(@fields[0..4], true)
+        end
+
+        # Station statuses.  Master station at index 0, all secondary stations at their index number
+        # @!parse attr_reader :stations
+        # @return [Array<SLCStationReport>]
+        def stations
+          [
+            master_station,
+            SLCStationReport.new(@fields[5..9], false),
+            SLCStationReport.new(@fields[10..14], false),
+            SLCStationReport.new(@fields[15..19], false),
+            SLCStationReport.new(@fields[20..24], false),
+            SLCStationReport.new(@fields[25..29], false)
+          ]
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+require_relative "base_nmea"
+
+module NMEAPlus
+  module Message
+    module NMEA
+      # SNC - Navigation Calculation Basis
+      # Basis for navigation calculations, Great Circle or Rhumb Line.
+      #
+      # Limited utility, no recommended replacement
+      class SNC < NMEAPlus::Message::NMEA::NMEAMessage
+
+        # Basis for navigation calculations, Great Circle or Rhumb Line
+        # @!parse attr_reader :calculation_basis
+        # @return [Symbol]
+        def calculation_basis
+          case @fields[1]
+          when 'G' then :great_circle
+          when 'R' then :rhumb_line
+          end
+        end
+
+        # Description of basis for navigation calculations
+        # @!parse attr_reader :calculation_basis_description
+        # @return [String]
+        def calculation_basis_description
+          case calculation_basis
+          when :great_circle then "Great Circle"
+          when :rhumb_line then "Rhumb Line"
+          end
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+require_relative "base_nmea"
+
+module NMEAPlus
+  module Message
+    module NMEA
+      # SNU - Loran-C SNR Status
+      #
+      # Loran-C warning flag for Signal-To-Noise-Ratio indicating that one or more Loran-C stations being used to produce
+      # Lat/Lon and other navigation data are unreliable.
+      # The use of $--GLC is recommended.
+      # @see GLC
+      class SNU < NMEAPlus::Message::NMEA::NMEAMessage
+        # Warning Flag
+        field_reader :warning_flag, 1, :_av_boolean
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+require_relative "base_nmea"
+
+module NMEAPlus
+  module Message
+    module NMEA
+      # SPS - Loran-C Predicted Signal Strength
+      # Limited utility, no recommended replacement.
+      class SPS < NMEAPlus::Message::NMEA::NMEAMessage
+        # Signal strength, dB
+        field_reader :signal_strength_db, 1, :_float
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+require_relative "base_nmea"
+
+module NMEAPlus
+  module Message
+    module NMEA
+      # SSF - Position Correction Offset
+      #
+      # Amount of offset, and direction of offset, applied to measured position Lat/Lon to produce a displayed position Lat/Lon.
+      # Limited utility, no recommended replacement
+      class SSF < NMEAPlus::Message::NMEA::NMEAMessage
+
+        # Latitude offset, minutes N/S
+        # @!parse attr_reader :latitude_offset_minutes
+        # @return [Float]
+        def latitude_offset_minutes
+          self.class.nsew_signed_float(@fields[1], @fields[2])
+        end
+
+        # Longitude offset, minutes E/W
+        # @!parse attr_reader :longitude_offset_minutes
+        # @return [Float]
+        def longitude_offset_minutes
+          self.class.nsew_signed_float(@fields[3], @fields[4])
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+require_relative "base_nmea"
+
+module NMEAPlus
+  module Message
+    module NMEA
+      # STC - Time Constant
+      class STC < NMEAPlus::Message::NMEA::NMEAMessage
+        field_reader :time_constant, 1, :_integer
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+require_relative "base_nmea"
+
+module NMEAPlus
+  module Message
+    module NMEA
+      # STR - Tracking Reference
+      #
+      # Transmitted prior to a sentence containing velocity-based data to indicate when velocity is measured over-the-ground or
+      # relative to the water.
+      #
+      # The use of appropriate ground or water-referenced approved sentences such as
+      # $--VBW, $--VHW or $--VTG is recommended.
+      # @see VBW
+      # @see VHW
+      # @see VTG
+      class STR < NMEAPlus::Message::NMEA::NMEAMessage
+
+        # @!parse attr_reader :tracking_reference
+        # @return [Symbol]
+        def tracking_reference
+          NMEA::NMEAMessage._av_boolean(@fields[1]) ? :ground : :water
+
+        end
+
+        # Description of tracking reference
+        # @!parse attr_reader :tracking_reference_description
+        # @return [String]
+        def tracking_reference_description
+          case tracking_reference
+          when :ground then "Ground reference"
+          when :water then "Water reference"
+          end
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+require_relative "base_nmea"
+
+module NMEAPlus
+  module Message
+    module NMEA
+      # SYS - Hybrid System Configuration
+      # Limited utility, no recommended replacement
+      class SYS < NMEAPlus::Message::NMEA::NMEAMessage
+
+        # Systems in use
+        # @!parse attr_reader :systems
+        # @return [Array<Symbol>]
+        def systems
+          abbr = {
+            'L' => :loran_c,
+            'O' => :omega,
+            'T' => :transit,
+            'G' => :gps,
+            'D' => :decca
+          }
+
+          # drop blank fields and convert to symbol
+          @fields[1..5].reject(&:empty?).map { |x| abbr[x] }
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+require_relative "base_nmea"
+
+module NMEAPlus
+  module Message
+    module NMEA
+      # TEC - TRANSIT Satellite Error Code & Doppler Count
+      # TRANSIT system is not operational, no recommended replacement.
+      class TEC < NMEAPlus::Message::NMEA::NMEAMessage
+        # Status: Maximum angle
+        field_reader :maximum_angle_flag, 1, :_av_boolean
+
+        # Status: Doppler count
+        field_reader :doppler_count_flag, 2, :_av_boolean
+
+        # Status: Iteration number
+        field_reader :iteration_number_flag, 3, :_av_boolean
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+require_relative "base_nmea"
+
+module NMEAPlus
+  module Message
+    module NMEA
+      # TEP - TRANSIT Satellite Predicted Elevation
+      # TRANSIT system is not operational, no recommended replacement.
+      class TEP < NMEAPlus::Message::NMEA::NMEAMessage
+        # Elevation, degrees
+        field_reader :elevation_degrees, 1, :_float
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+require_relative "base_nmea"
+
+module NMEAPlus
+  module Message
+    module NMEA
+      # TGA - TRANSIT Satellite Antenna & Geoidal Heights
+      # TRANSIT system is not operational, no recommended replacement.
+      class TGA < NMEAPlus::Message::NMEA::NMEAMessage
+        # Antenna height, meters
+        field_reader :antenna_height_meters, 1, :_float
+
+        # Geoidal height, meters
+        field_reader :geoidal_height_meters, 3, :_float
+
+        # Antenna geoidal height, meters
+        field_reader :antenna_geoidal_height_meters, 5, :_float
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+require_relative "base_nmea"
+
+module NMEAPlus
+  module Message
+    module NMEA
+      # TIF - TRANSIT Satellite Initial Flag
+      # TRANSIT system is not operational, no recommended replacement
+      class TIF < NMEAPlus::Message::NMEA::NMEAMessage
+
+        # Satellite Initial Flag
+        # @!parse attr_reader :initial_flag
+        # @return [Symbol]
+        def initial_flag
+          case @fields[1]
+          when 'A' then :normal_operation
+          when 'V' then :set_initialization_data
+          when 'J' then :initialization_data_complete
+          end
+        end
+
+        # Description of initial flag
+        # @!parse attr_reader :initial_flag_description
+        # @return [String]
+        def initial_flag_description
+          case initial_flag
+          when :normal_operation then 'Normal operation'
+          when :set_initialization_data then 'Set initialization data'
+          when :initialization_data_complete then 'Initialization data complete'
+          end
+        end
+
+      end
+    end
+  end
+end

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

@@ -4,30 +4,46 @@ module NMEAPlus
   module Message
     module NMEA
       # TRF - TRANSIT Fix Data
+      # Time, date, position and information related to a TRANSIT fix.
+      # TRANSIT system is not operational, no recommended replacement.
       class TRF < NMEAPlus::Message::NMEA::NMEAMessage
+        # UTC of position fix: Date and time
         # @!parse attr_reader :utc_time
         # @return [Time]
         def utc_time
-          _utc_date_time(@fields[2], @fields[1])
+          self.class._utc_date_time(@fields[2], @fields[1])
         end
 
+        # Latitude, N/S
         # @!parse attr_reader :latitude
         # @return [Float]
         def latitude
           self.class.degrees_minutes_to_decimal(@fields[3], @fields[4])
         end
 
+        # Longitude, E/W
         # @!parse attr_reader :longitude
         # @return [Float]
         def longitude
           self.class.degrees_minutes_to_decimal(@fields[5], @fields[6])
         end
 
+        # Elevation angle
         field_reader :elevation_angle, 7, :_float
+
+        # Number of iterations
         field_reader :iterations, 8, :_integer
+
+        # Number of Doppler intervals
         field_reader :doppler_intervals, 9, :_integer
+
+        # Update distance, nautical miles
         field_reader :update_distance_nautical_miles, 10, :_float
+
+        # Satellite ID
         field_reader :satellite, 11, :_integer
+
+        # Data status
         field_reader :valid?, 12, :_av_boolean
       end
     end

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

@@ -0,0 +1,14 @@
+require_relative "base_nmea"
+
+module NMEAPlus
+  module Message
+    module NMEA
+      # TRP - TRANSIT Satellite Predicted Direction of Rise
+      # TRANSIT system is not operational, no recommended replacement
+      class TRP < NMEAPlus::Message::NMEA::NMEAMessage
+        # Southeasterly = SE, southwesterly = SW
+        field_reader :predicted_rise_direction, 1, :_string
+      end
+    end
+  end
+end