nmea_plus 1.0.0

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

@@ -0,0 +1,65 @@
+require_relative 'vdm_msg'
+
+module NMEAPlus
+  module Message
+    module AIS
+      module VDMPayload
+        class VDMMsgCNB < NMEAPlus::Message::AIS::VDMPayload::VDMMsg
+
+          payload_reader :navigational_status, 38, 4, :_u
+
+          def navigational_status_description
+            case navigational_status
+            when 0 then return "Under way using engine"
+            when 1 then return "At anchor"
+            when 2 then return "Not under command"
+            when 3 then return "Restricted manoeuverability"
+            when 4 then return "Constrained by her draught"
+            when 5 then return "Moored"
+            when 6 then return "Aground"
+            when 7 then return "Engaged in Fishing"
+            when 8 then return "Under way sailing"
+            when 14 then return "AIS-SART active"
+            else
+              return "undefined"
+            end
+          end
+
+          def rate_of_turn
+            ret = _i(42, 8)
+            return nil if ret == -128
+            (_I(42, 8, 3) / 4.733) ** 2
+          end
+
+          payload_reader :speed_over_ground, 50, 10, :_U, 1
+          payload_reader :position_10m_accuracy?, 60, 1, :_b
+
+          def longitude
+            _I(61, 28, 4) / 60
+          end
+
+          def latitude
+            _U(89, 27, 4) / 60
+          end
+
+          payload_reader :course_over_ground, 116, 12, :_U, 1
+
+          def true_heading
+            ret = _u(128, 9)
+            return nil if ret == 511  # means "not available"
+            ret
+          end
+
+          payload_reader :time_stamp, 137, 6, :_u
+          payload_reader :special_manoeuvre, 143, 2, :_e
+          payload_reader :raim?, 148, 1, :_b
+
+        end
+
+        class VDMMsg1 < VDMMsgCNB; end
+        class VDMMsg2 < VDMMsgCNB; end
+        class VDMMsg3 < VDMMsgCNB; end
+      end
+    end
+  end
+end

data/gem/lib/nmea_plus/message/ais/vdm_payload/vdm_msg5.rb

@@ -0,0 +1,38 @@
+require_relative 'vdm_msg'
+
+module NMEAPlus
+  module Message
+    module AIS
+      module VDMPayload
+        class VDMMsg5 < NMEAPlus::Message::AIS::VDMPayload::VDMMsg
+
+          payload_reader :ais_version, 38, 2, :_u
+          payload_reader :imo_number, 40, 30, :_u
+          payload_reader :callsign, 70, 42, :_t
+          payload_reader :name, 112, 120, :_t
+          payload_reader :ship_cargo_type, 232, 8, :_e
+          payload_reader :ship_dimension_to_bow, 240, 9, :_u
+          payload_reader :ship_dimension_to_stern, 249, 9, :_u
+          payload_reader :ship_dimension_to_port, 258, 6, :_u
+          payload_reader :ship_dimension_to_starboard, 264, 6, :_u
+          payload_reader :epfd_type, 270, 4, :_e
+
+          def eta
+            now = Time.now
+            Time.new(now.year,
+                     _u(274, 4),
+                     _u(278, 5),
+                     _u(283, 5),
+                     _u(288, 6),
+                     0)
+          end
+
+          payload_reader :static_draught, 294, 8, :_U, 1
+          payload_reader :destination, 302, 120, :_t
+          payload_reader :dte?, 422, 1, :_b
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+require_relative 'vdm_msg'
+
+module NMEAPlus
+  module Message
+    module AIS
+      module VDMPayload
+        class VDMMsg8 < NMEAPlus::Message::AIS::VDMPayload::VDMMsg
+          payload_reader :designated_area_code, 40, 10, :_u
+          payload_reader :functional_id, 50, 6, :_u
+          payload_reader :application_data_2b, 56, 952, :_d
+          payload_reader :application_data_6b, 56, 952, :_6b_string
+          payload_reader :application_data_8b, 56, 952, :_8b_data_string
+
+          payload_reader :ais_version, 38, 2, :_u
+          payload_reader :imo_number, 40, 30, :_u
+          payload_reader :callsign, 70, 42, :_t
+          payload_reader :name, 112, 120, :_t
+          payload_reader :ship_cargo_type, 232, 8, :_e
+          payload_reader :ship_dimension_to_bow, 240, 9, :_u
+          payload_reader :ship_dimension_to_stern, 249, 9, :_u
+          payload_reader :ship_dimension_to_port, 258, 6, :_u
+          payload_reader :ship_dimension_to_starboard, 264, 6, :_u
+          payload_reader :epfd_type, 270, 4, :_e
+
+          def eta
+            now = Time.now
+            Time.new(now.year,
+                     _u(274, 4),
+                     _u(278, 5),
+                     _u(283, 5),
+                     _u(288, 6),
+                     0)
+          end
+
+          payload_reader :static_draught, 294, 8, :_U, 1
+          payload_reader :destination, 302, 120, :_t
+          payload_reader :dte?, 422, 1, :_b
+
+        end
+      end
+    end
+  end
+end

data/gem/lib/nmea_plus/message/base.rb

@@ -0,0 +1,172 @@
+
+class Class
+  # make our own shortcut syntax for message attributes
+  def field_reader(name, field_num, formatter = nil)
+    if formatter.nil?
+      self.class_eval("def #{name};@fields[#{field_num}];end")
+    else
+      self.class_eval("def #{name};#{formatter}(@fields[#{field_num}]);end")
+    end
+  end
+end
+
+module NMEAPlus
+  module Message
+    class Base
+      attr_accessor :prefix
+      attr_reader :payload
+      attr_reader :fields
+      attr_accessor :checksum
+      attr_accessor :interpreted_data_type
+      attr_accessor :next_part
+
+      field_reader :data_type, 0, nil
+
+      def original
+        "#{prefix}#{payload}*#{checksum}"
+      end
+
+      def payload=(val)
+        @payload = val
+        @fields = val.split(',', -1)
+      end
+
+      def checksum_ok?
+        calculated_checksum.upcase == checksum.upcase
+      end
+
+      def all_checksums_ok?
+        return false unless checksum_ok?
+        return true if @next_part.nil?
+        @next_part.all_checksums_ok?
+      end
+
+      def calculated_checksum
+        "%02x" % @payload.each_byte.map(&:ord).reduce(:^)
+      end
+
+      # many messages override these fields
+      def total_messages
+        1
+      end
+
+      # sequence number
+      def message_number
+        1
+      end
+
+      # create a linked list (O(n) implementation; message parts assumed to be < 10) of message parts
+      def add_message_part(msg)
+        if @next_part.nil?
+          @next_part = msg
+        else
+          @next_part.add_message_part(msg)
+        end
+      end
+
+      def all_messages_received?
+        total_messages == highest_contiguous_index
+      end
+
+      def highest_contiguous_index
+        _highest_contiguous_index(0)
+      end
+
+      def _highest_contiguous_index(last_index)
+        mn = message_number # just in case this is expensive to compute
+        return last_index if mn - last_index != 1      # indicating a skip or restart
+        return mn if @next_part.nil?                   # indicating we're the last message
+        @next_part._highest_contiguous_index(mn)       # recurse down
+      end
+
+      ######################### Conversion functions
+
+      # convert DDMM.MMM to single decimal value.
+      # sign_letter can be N,S,E,W
+      def _degrees_minutes_to_decimal(dm_string, sign_letter = "")
+        return nil if dm_string.nil? || dm_string.empty?
+        r = /(\d+)(\d{2}\.\d+)/  # (some number of digits) (2 digits for minutes).(decimal minutes)
+        m = r.match(dm_string)
+        raw = m.values_at(1)[0].to_f + (m.values_at(2)[0].to_f / 60)
+        _nsew_signed_float(raw, sign_letter)
+      end
+
+      # Use cardinal directions to assign positive or negative to mixed_val
+      # mixed_val can be string or float
+      # Of possible directions NSEW (sign_letter) treat N/E as + and S/W as -
+      def _nsew_signed_float(mixed_val, sign_letter = "")
+        value = mixed_val.to_f
+        value *= -1 if !sign_letter.empty? && "SW".include?(sign_letter.upcase)
+        value
+      end
+
+      # integer or nil
+      def _integer(field)
+        return nil if field.nil? || field.empty?
+        field.to_i
+      end
+
+      # float or nil
+      def _float(field)
+        return nil if field.nil? || field.empty?
+        field.to_f
+      end
+
+      # string or nil
+      def _string(field)
+        return nil if field.nil? || field.empty?
+        field
+      end
+
+      # hex to int or nil
+      def _hex_to_integer(field)
+        return nil if field.nil? || field.empty?
+        field.hex
+      end
+
+      # utc time or nil (HHMMSS or HHMMSS.SS)
+      def _utctime_hms(field)
+        return nil if field.nil? || field.empty?
+        re_format = /(\d{2})(\d{2})(\d{2}(\.\d+)?)/
+        now = Time.now
+        begin
+          hms = re_format.match(field)
+          Time.new(now.year, now.month, now.day, hms[1].to_i, hms[2].to_i, hms[3].to_f)
+        rescue
+          nil
+        end
+      end
+
+      # time interval or nil (HHMMSS or HHMMSS.SS)
+      def _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)
+        rescue
+          nil
+        end
+      end
+
+      def _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?
+
+        # get formats and time
+        time_format = /(\d{2})(\d{2})(\d{2}(\.\d+)?)/
+        date_format = /(\d{2})(\d{2})(\d{2})/
+
+        # crunch numbers
+        begin
+          dmy = date_format.match(d_field)
+          hms = time_format.match(t_field)
+          Time.new(2000 + dmy[3].to_i, dmy[2].to_i, dmy[1].to_i, hms[1].to_i, hms[2].to_i, hms[3].to_f)
+        rescue
+          nil
+        end
+      end
+
+    end
+  end
+end

data/gem/lib/nmea_plus/message/nmea/aam.rb

@@ -0,0 +1,17 @@
+
+require_relative "base_nmea"
+
+module NMEAPlus
+  module Message
+    module NMEA
+
+      class AAM < NMEAPlus::Message::NMEA::NMEAMessage
+        field_reader :arrival_circle_entered?, 1, :_av_boolean
+        field_reader :waypoint_passed?, 2, :_av_boolean
+        field_reader :arrival_circle_radius, 3, :_float
+        field_reader :arrival_circle_radius_units, 4, :_string
+        field_reader :waypoint_id, 5, :_string
+      end
+    end
+  end
+end

data/gem/lib/nmea_plus/message/nmea/alm.rb

@@ -0,0 +1,25 @@
+require_relative "base_nmea"
+
+module NMEAPlus
+  module Message
+    module NMEA
+      class ALM < NMEAPlus::Message::NMEA::NMEAMessage
+        field_reader :total_messages, 1, :_integer
+        field_reader :message_number, 2, :_integer
+        field_reader :satellite_prn, 3, :_integer
+        field_reader :gps_week, 4, :_integer
+        field_reader :sv_health, 5, :_hex_to_integer
+        field_reader :eccentricity, 6, :_hex_to_integer
+        field_reader :reference_time, 7, :_hex_to_integer
+        field_reader :inclination_angle, 8, :_hex_to_integer
+        field_reader :ascension_rate, 9, :_hex_to_integer
+        field_reader :semimajor_axis_root, 10, :_hex_to_integer
+        field_reader :perigee_argument, 11, :_hex_to_integer
+        field_reader :ascension_node_longitude, 12, :_hex_to_integer
+        field_reader :mean_anomaly, 13, :_hex_to_integer
+        field_reader :f0_clock, 14, :_hex_to_integer
+        field_reader :f1_clock, 15, :_hex_to_integer
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+require_relative "base_nmea"
+
+module NMEAPlus
+  module Message
+    module NMEA
+      class APA < NMEAPlus::Message::NMEA::NMEAMessage
+        field_reader :no_general_warning?, 1, :_av_boolean
+        field_reader :no_cyclelock_warning?, 2, :_av_boolean
+        field_reader :cross_track_error, 3, :_float
+        field_reader :direction_to_steer, 4, :_string
+        field_reader :cross_track_units, 5, :_string
+        field_reader :arrival_circle_entered?, 6, :_av_boolean
+        field_reader :perpendicular_passed?, 7, :_av_boolean
+        field_reader :bearing_origin_to_destination, 8, :_float
+        field_reader :compass_type, 9, :_string
+        field_reader :destination_waypoint_id, 10, :_string
+      end
+    end
+  end
+end

data/gem/lib/nmea_plus/message/nmea/apb.rb

@@ -0,0 +1,14 @@
+require_relative "base_nmea"
+
+module NMEAPlus
+  module Message
+    module NMEA
+      class APB < NMEAPlus::Message::NMEA::APA
+        field_reader :bearing_position_to_destination, 11, :_float
+        field_reader :bearing_position_to_destination_compass_type, 12, :_string
+        field_reader :heading_to_waypoint, 13, :_float
+        field_reader :heading_to_waypoint_compass_type, 14, :_string
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+
+require_relative "../base"
+
+module NMEAPlus
+  module Message
+    module NMEA
+
+      class NMEAMessage < NMEAPlus::Message::Base
+        def talker
+          data_type[0..1]
+        end
+
+        def message_type
+          data_type[2..-1]
+        end
+
+        def _av_boolean(data)
+          case data
+          when 'A' then return true
+          when 'V' then return false
+          end
+          nil
+        end
+
+        def _10_boolean(data)
+          case data
+          when '1' then return true
+          when '0' then return false
+          end
+          nil
+        end
+
+      end
+    end
+  end
+end

data/gem/lib/nmea_plus/message/nmea/bod.rb

@@ -0,0 +1,14 @@
+require_relative "base_nmea"
+
+module NMEAPlus
+  module Message
+    module NMEA
+      class BOD < NMEAPlus::Message::NMEA::NMEAMessage
+        field_reader :bearing_true, 1, :_float
+        field_reader :bearing_magnetic, 3, :_float
+        field_reader :waypoint_to, 5, :_string
+        field_reader :waypoint_from, 6, :_string
+      end
+    end
+  end
+end