nmea_plus 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cb6a15ea1c4b8d040614ae117703221df082cf53
+  data.tar.gz: 3d738a04a524c69e02c371befc3d1edd9f913a96
+SHA512:
+  metadata.gz: f026b1f759c56c97952ea97b3b7a6190c0930e4cb02486a715cf704eefe5fa8c4f012c19b6b8778dd32be709be95cc671c23f267096635ddcd55d3f2e1d1074c
+  data.tar.gz: 9002792450538ed8f492db5f54707f1631bc44f27acede7a44868b82900755177da03974922565249ebde61b175fd56023aa5cf23878d0141b606dbad891ceb8

data/gem/lib/nmea_plus.rb

@@ -0,0 +1,63 @@
+require 'nmea_plus/version'
+
+require 'nmea_plus/generated_parser/parser'
+require 'nmea_plus/generated_parser/tokenizer'
+
+module NMEAPlus
+  class SourceDecoder
+    attr_accessor :throw_on_parse_fail
+    attr_accessor :throw_on_unrecognized_type  # typically for development
+
+    def initialize(line_reader)
+      unless line_reader.respond_to? :each_line
+        fail ArgumentError, "line_reader must inherit from type IO (or implement each_line)"
+      end
+      @throw_on_parse_fail = false
+      @source = line_reader
+      @decoder = NMEAPlus::Decoder.new
+    end
+
+    # return each parsed message
+    def each_message
+      @source.each_line do |line|
+        if @throw_on_parse_fail
+          yield @decoder.parse(line)
+        else
+          begin
+            y = @decoder.parse(line)
+            yield y
+          rescue
+          end
+        end
+      end
+    end
+
+    # return messages grouped into multipart chains as required
+    def each_complete_message
+      partials = {}
+      each_message do |msg|
+        slot = msg.data_type
+
+        if partials[slot].nil?
+          partials[slot] = msg
+        else
+          # the message was already in there
+          if 1 != (msg.message_number - partials[slot].message_number)
+            # error! just overwrite what was there
+            partials[slot] = msg
+          else
+            partials[slot].add_message_part(msg)
+          end
+        end
+
+        # take action if we've completed the chain
+        maybe_full = partials[slot]
+        if maybe_full.all_messages_received?
+          partials[slot] = nil
+          yield maybe_full
+        end
+      end
+    end
+
+  end
+end

data/gem/lib/nmea_plus/ais_message_factory.rb

@@ -0,0 +1,17 @@
+
+require_relative 'message_factory'
+
+require_relative 'message/ais/vdm'
+
+module NMEAPlus
+  class AISMessageFactory < MessageFactory
+    def self.parent_module
+      "AIS"
+    end
+
+    def self.alternate_data_type(data_type)
+      # match last 3 digits (get rid of talker)
+      data_type[2..4]
+    end
+  end
+end

data/gem/lib/nmea_plus/generated_parser/parser.rb

@@ -0,0 +1,127 @@
+#
+# DO NOT MODIFY!!!!
+# This file is automatically generated by Racc 1.4.13
+# from Racc grammer file "".
+#
+
+require 'racc/parser.rb'
+
+
+require_relative "../nmea_message_factory"
+require_relative "../ais_message_factory"
+
+module NMEAPlus
+  class Parser < Racc::Parser
+
+module_eval(<<'...end parser.y/module_eval...', 'parser.y', 19)
+
+# override racc's on_error so we can have context in our error messages
+def on_error(t, val, vstack)
+  errcontext = (@ss.pre_match[-10..-1] || @ss.pre_match) +
+                @ss.matched + @ss.post_match[0..9]
+  line_number = @ss.pre_match.lines.count
+  raise ParseError, sprintf("parse error on value %s (%s) " +
+                            "on line %s around \"%s\"",
+                            val.inspect, token_to_str(t) || '?',
+                            line_number, errcontext)
+end
+...end parser.y/module_eval...
+##### State transition tables begin ###
+
+racc_action_table = [
+     2,     3,     6,     5,     4,     7,     8,     9 ]
+
+racc_action_check = [
+     0,     0,     3,     2,     1,     4,     5,     6 ]
+
+racc_action_pointer = [
+    -3,     4,    -2,    -3,     5,     4,     5,   nil,   nil,   nil ]
+
+racc_action_default = [
+    -3,    -3,    -3,    -3,    -3,    -3,    -3,    10,    -1,    -2 ]
+
+racc_goto_table = [
+     1 ]
+
+racc_goto_check = [
+     1 ]
+
+racc_goto_pointer = [
+   nil,     0 ]
+
+racc_goto_default = [
+   nil,   nil ]
+
+racc_reduce_table = [
+  0, 0, :racc_error,
+  3, 7, :_reduce_1,
+  3, 7, :_reduce_2 ]
+
+racc_reduce_n = 3
+
+racc_shift_n = 10
+
+racc_token_table = {
+  false => 0,
+  :error => 1,
+  :CSUM => 2,
+  :CASH => 3,
+  :BANG => 4,
+  :DATA => 5 }
+
+racc_nt_base = 6
+
+racc_use_result_var = true
+
+Racc_arg = [
+  racc_action_table,
+  racc_action_check,
+  racc_action_default,
+  racc_action_pointer,
+  racc_goto_table,
+  racc_goto_check,
+  racc_goto_default,
+  racc_goto_pointer,
+  racc_nt_base,
+  racc_reduce_table,
+  racc_token_table,
+  racc_shift_n,
+  racc_reduce_n,
+  racc_use_result_var ]
+
+Racc_token_to_s_table = [
+  "$end",
+  "error",
+  "CSUM",
+  "CASH",
+  "BANG",
+  "DATA",
+  "$start",
+  "start" ]
+
+Racc_debug_parser = false
+
+##### State transition tables end #####
+
+# reduce 0 omitted
+
+module_eval(<<'.,.,', 'parser.y', 8)
+  def _reduce_1(val, _values, result)
+     result = NMEAPlus::NMEAMessageFactory.create(val[0], val[1], val[2]) 
+    result
+  end
+.,.,
+
+module_eval(<<'.,.,', 'parser.y', 9)
+  def _reduce_2(val, _values, result)
+     result = NMEAPlus::AISMessageFactory.create(val[0], val[1], val[2]) 
+    result
+  end
+.,.,
+
+def _reduce_none(val, _values, result)
+  val[0]
+end
+
+  end   # class Parser
+  end   # module NMEAPlus

data/gem/lib/nmea_plus/generated_parser/tokenizer.rb

@@ -0,0 +1,100 @@
+#--
+# DO NOT MODIFY!!!!
+# This file is automatically generated by rex 1.0.5
+# from lexical definition file "/Users/iakatz/Code Base/nmea_plus/parser/tokenizer.rex".
+#++
+
+
+module NMEAPlus
+class Decoder < Parser  # not indented due to constraints of .rex format
+  require 'strscan'
+
+  class ScanError < StandardError ; end
+
+  attr_reader   :lineno
+  attr_reader   :filename
+  attr_accessor :state
+
+  def scan_setup(str)
+    @ss = StringScanner.new(str)
+    @lineno =  1
+    @state  = nil
+  end
+
+  def action
+    yield
+  end
+
+  def scan_str(str)
+    scan_setup(str)
+    do_parse
+  end
+  alias :scan :scan_str
+
+  def load_file( filename )
+    @filename = filename
+    open(filename, "r") do |f|
+      scan_setup(f.read)
+    end
+  end
+
+  def scan_file( filename )
+    load_file(filename)
+    do_parse
+  end
+
+
+  def next_token
+    return if @ss.eos?
+    
+    # skips empty actions
+    until token = _next_token or @ss.eos?; end
+    token
+  end
+
+  def _next_token
+    text = @ss.peek(1)
+    @lineno  +=  1  if text == "\n"
+    token = case @state
+    when nil
+      case
+      when (text = @ss.scan(/\*[0-9A-F]{2}[\w\n\r]*/i))
+         action { [:CSUM, text[1..2]] }
+
+      when (text = @ss.scan(/\$/i))
+         action { [:CASH, text] }
+
+      when (text = @ss.scan(/!/i))
+         action { [:BANG, text] }
+
+      when (text = @ss.scan(/[^\*]+/i))
+         action { [:DATA, text] }
+
+      else
+        text = @ss.string[@ss.pos .. -1]
+        raise  ScanError, "can not match: '" + text + "'"
+      end  # if
+
+    else
+      raise  ScanError, "undefined state: '" + state.to_s + "'"
+    end  # case state
+    token
+  end  # def _next_token
+
+  def parse(input)
+    @yydebug = true if ENV['DEBUG_RACC']
+    scan_str(input)
+  end
+  def tokenize(input)
+    scan_setup(input)
+    ret = []
+    last_token = nil
+    loop do
+      last_token = next_token
+      break if last_token.nil?
+      ret << last_token
+    end
+    ret
+  end
+  end # class
+end # class

data/gem/lib/nmea_plus/message/ais/base_ais.rb

@@ -0,0 +1,20 @@
+
+require_relative "../base"
+
+module NMEAPlus
+  module Message
+    module AIS
+
+      class AISMessage < NMEAPlus::Message::Base
+        def talker
+          data_type[0..1]
+        end
+
+        def message_type
+          data_type[2..-1]
+        end
+
+      end
+    end
+  end
+end

data/gem/lib/nmea_plus/message/ais/vdm.rb

@@ -0,0 +1,100 @@
+require_relative "base_ais"
+
+require_relative "vdm_payload/vdm_msg1"
+require_relative "vdm_payload/vdm_msg5"
+require_relative "vdm_payload/vdm_msg8"
+
+=begin boilerplate for vdm payload objects
+require_relative 'vdm_msg'
+
+module NMEAPlus
+  module Message
+    module AIS
+      module VDMPayload
+        class VDMMsg5 < NMEAPlus::Message::AIS::VDMPayload::VDMMsg
+
+        end
+      end
+    end
+  end
+end
+
+=end
+
+module NMEAPlus
+  module Message
+    module AIS
+      class VDM < NMEAPlus::Message::AIS::AISMessage
+        field_reader :total_messages, 1, :_integer
+        field_reader :message_number, 2, :_integer
+        field_reader :message_id, 3, :_string
+        field_reader :channel_code, 4, :_string
+        field_reader :raw_ais_payload, 5, :_string
+        field_reader :ais_payload_fill_bits, 6, :_integer
+
+        def ais
+          # factory method: find the appropriate message type class and instantiate it
+          p = full_dearmored_ais_payload
+          ret = _payload_container(p[0, 6].to_i(2))
+          ret.payload_bitstring = p
+          ret.fill_bits = last_ais_fill_bits
+          ret
+        end
+
+        # the full encoded payload as it was received
+        def full_armored_ais_payload
+          # get the full message and fill bits for the last one
+          ptr = self
+          ret = ""
+          loop do
+            ret << ptr.raw_ais_payload
+            break if ptr.next_part.nil?
+            ptr = ptr.next_part
+          end
+          ret
+        end
+
+        # a binary string ("0010101110110") representing the dearmored payload
+        def full_dearmored_ais_payload
+          data = full_armored_ais_payload
+          out = ""
+          # dearmor all but the last byte, then apply the fill bits to the last byte
+          data[0..-2].each_char { |c| out << _dearmor6b(c) }
+          out << _dearmor6b(data[-1], 6 - last_ais_fill_bits)
+          out
+        end
+
+        def last_ais_fill_bits
+          # get the fill bits for the last message in the sequence
+          ptr = self
+          fill_bits = nil
+          loop do
+            fill_bits = ptr.ais_payload_fill_bits
+            break if ptr.next_part.nil?
+            ptr = ptr.next_part
+          end
+          fill_bits.to_i
+        end
+
+        # perform the 6-bit to 8-bit conversion defined in the spec
+        def _dearmor6b(c, len = 6)
+          val = c.ord
+          if val >= 96
+            ret = val - 56
+          else
+            ret = val - 48
+          end
+          ret.to_s(2).rjust(6, "0")[0..(len - 1)]
+        end
+
+        def _payload_container(message_type_id)
+          class_identifier = "NMEAPlus::Message::AIS::VDMPayload::VDMMsg#{message_type_id}"
+          Object::const_get(class_identifier).new
+        rescue ::NameError
+          class_identifier = "NMEAPlus::Message::AIS::VDMPayload::VDMMsgUndefined" # generic
+          Object::const_get(class_identifier).new
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,99 @@
+class Class
+  # make our own shortcut syntax for payload attributes
+  def payload_reader(name, start_bit, length, formatter, formatter_arg = nil)
+    if formatter_arg.nil?
+      self.class_eval("def #{name};#{formatter}(#{start_bit}, #{length});end")
+    else
+      self.class_eval("def #{name};#{formatter}(#{start_bit}, #{length}, #{formatter_arg});end")
+    end
+  end
+end
+
+module NMEAPlus
+  module Message
+    module AIS
+      module VDMPayload
+        class VDMMsg
+          attr_accessor :payload_bitstring
+          attr_accessor :fill_bits
+
+          payload_reader :message_type, 0, 6, :_u
+          payload_reader :repeat_indicator, 6, 2, :_u
+          payload_reader :source_mmsi, 8, 30, :_u
+
+          # lookup table for 6-bit ascii
+          def _6b_ascii(ord)
+            '@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\]^_ !"#$%&\'()*+,-./0123456789:;<=>?'[ord]
+          end
+
+          # convert an entire string from the payload
+          def _6b_string(start, length)
+            # pull out 6b chunks from the string, use their value as a lookup into the ascii array
+            _bit_slices(start, length, 6).to_a.map(&:join).map { |x| _6b_ascii(x.to_i(2)) }.join
+          end
+
+          def _8b_data_string(start, length)
+            _bit_slices(start, length, 8).to_a.map(&:join).map { |x| x.to_i(2).chr }.join
+          end
+
+          def _bit_slices(start, length, chunk_size)
+            @payload_bitstring[start, length].chars.each_slice(chunk_size)
+          end
+
+          # convert a string but trim off the 0s ('@')
+          def _6b_string_nullterminated(start, length)
+            _6b_string(start, length).split("@", 2)[0]
+          end
+
+          # directly convert a string to a binary number as you'd read it
+          def _6b_unsigned_integer(start, length)
+            @payload_bitstring[start, length].to_i(2)
+          end
+
+          # perform a twos complement operation on part of the payload
+          def _6b_twoscomplement(start, length)
+            # two's complement: flip bits, then add 1
+            @payload_bitstring[start, length].tr("01", "10").to_i(2) + 1
+          end
+
+          def _6b_integer(start, length)
+            # MSB is 1 for negative
+            _6b_twoscomplement(start, length) * (@payload_bitstring[start] == 0 ? 1 : -1)
+          end
+
+          # scale an integer by dividing it by 10^decimal_places
+          def _6b_integer_scaled(start, length, decimal_places)
+            _6b_integer(start, length).to_f / (10 ** decimal_places)
+          end
+
+          # scale an unsigned integer by dividing it by 10^decimal_places
+          def _6b_unsigned_integer_scaled(start, length, decimal_places)
+            _6b_unsigned_integer(start, length).to_f / (10.0 ** decimal_places)
+          end
+
+          def _6b_boolean(start, _)
+            @payload_bitstring[start].to_i == 1
+          end
+
+          def _2b_data_string(start, length)
+            @payload_bitstring[start, length]
+          end
+
+          # use shorthand for data types as defined in http://catb.org/gpsd/AIVDM.html
+          alias_method :_u, :_6b_unsigned_integer
+          alias_method :_U, :_6b_unsigned_integer_scaled
+          alias_method :_i, :_6b_integer
+          alias_method :_I, :_6b_integer_scaled
+          alias_method :_b, :_6b_boolean
+          alias_method :_e, :_6b_unsigned_integer
+          alias_method :_t, :_6b_string_nullterminated
+          alias_method :_d, :_2b_data_string
+
+        end
+
+        class VDMMsgUndefined < VDMMsg; end
+
+      end
+    end
+  end
+end