ruby-gps 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 16bbfb313f9945b300c9fd352de126e1ffe869d98ad3ae7aec7f2e196ec72e28
+  data.tar.gz: 8701cb221f89141aee9beea05f6c9d04860e628e97f35a314f1cd08731f71f1f
+SHA512:
+  metadata.gz: 786fd55095f2b19cc5aef507ae50de65022b6f9b70a475564702d25be4f67767cdbc1ed4a2fa40945b7b353d4a7705c27662a0bb268e32fc4d6a6a31ca86d200
+  data.tar.gz: 3ce9fc1152771455ff1f4531e949c23c7e1fa1ad03a08958ef652f69909e5917743f1ae0ce22be17663d4dfc551fc5c6612836513133fb28229288b9e99873da

data/lib/gps.rb

@@ -0,0 +1,2 @@
+require_relative 'gps/nmea'
+require_relative 'gps/device'

data/lib/gps/device.rb

@@ -0,0 +1,163 @@
+module Gps
+  class Device
+    attr_accessor :last_datetime # Updates any time a sentence has a datetime
+
+    def initialize(filename, track_datetime=true)
+      @callbacks = {}
+      @track_datetime = track_datetime
+      @filename = filename
+      @file = File.open(filename, 'rb')
+    end
+
+    def self.open(filename, &block)
+      device = Device.new filename
+      block.call device
+      device.close
+    end
+
+    def close
+      @file.close if @file
+    end
+
+    def each_line(&block)
+      @file.each_line do |line|
+        line.strip!
+        next if line.empty?
+        block.call line
+      end
+    end
+
+    def each_sentence(&block)
+      each_line do |line|
+        s = Nmea::Sentence.parse line
+        next if s.nil?
+        update_datetime s if @track_datetime
+        block.call s
+      end
+    end
+
+    def each_coordinates(&block)
+      each_sentence do |sentence|
+        block.call sentence.lat_long_dec if sentence.has_coordinates?
+      end
+    end
+
+    # Rewind file if not a character device
+    def rewind
+      @file.rewind unless File.chardev?(@file.path)
+    end
+
+    # Begin fetch process with callbacks
+    def start
+      @stopped = false
+      each_sentence do |sentence|
+        break if @stopped
+
+        if @callbacks[:coordinates] && sentence.has_coordinates?
+          @callbacks[:coordinates].each do |block|
+            block.call sentence.lat_long_dec
+          end
+        end
+
+
+        if @callbacks[:datetime] && sentence.has_datetime?
+          @callbacks[:datetime].each do |block|
+            block.call sentence.datetime
+          end
+        end
+
+        if @callbacks[:speed_knots] && sentence.respond_to?(:speed_knots)
+          @callbacks[:speed_knots].each do |block|
+            block.call sentence.speed_knots if sentence.speed_knots
+          end
+        end
+
+        if @callbacks[:speed_kmh] && sentence.respond_to?(:speed_kmh)
+          @callbacks[:speed_kmh].each do |block|
+            block.call sentence.speed_kmh if sentence.speed_kmh
+          end
+        end
+
+        if @callbacks[:altitude] && sentence.respond_to?(:altitude)
+          @callbacks[:altitude].each do |block|
+            block.call sentence.altitude if sentence.altitude
+          end
+        end
+
+        if @callbacks[:true_track] && sentence.respond_to?(:true_track)
+          @callbacks[:true_track].each do |block|
+            block.call sentence.true_track if sentence.true_track
+          end
+        end
+
+        if @callbacks[:magnetic_track] && sentence.respond_to?(:magnetic_track)
+          @callbacks[:magnetic_track].each do |block|
+            block.call sentence.magnetic_track if sentence.magnetic_track
+          end
+        end
+      end
+
+      if @callbacks[:complete]
+        @callbacks[:complete].each(&:call)
+      end
+    end
+
+    def start_async
+      Thread.new(&method(:start))
+    end
+
+    def stop
+      @stopped = true
+    end
+
+    def on_coordinates(&block)
+      callbacks[:coordinates] ||= []
+      callbacks[:coordinates] << block
+    end
+
+    def on_datetime(&block)
+      callbacks[:datetime] ||= []
+      callbacks[:datetime] << block
+    end
+
+    def on_speed_knots(&block)
+      callbacks[:speed_knots] ||= []
+      callbacks[:speed_knots] << block
+    end
+
+    def on_speed_kmh(&block)
+      callbacks[:speed_kmh] ||= []
+      callbacks[:speed_kmh] << block
+    end
+
+    def on_altitude(&block)
+      callbacks[:altitude] ||= []
+      callbacks[:altitude] << block
+    end
+
+    def on_complete(&block)
+      callbacks[:complete] ||= []
+      callbacks[:complete] << block
+    end
+
+    def on_true_track(&block)
+      callbacks[:true_track] ||= []
+      callbacks[:true_track] << block
+    end
+
+    def on_magnetic_track(&block)
+      callbacks[:magnetic_track] ||= []
+      callbacks[:magnetic_track] << block
+    end
+
+    private
+
+    attr_reader :callbacks
+
+    def update_datetime(sentence)
+      if sentence.respond_to? :datetime
+        @last_datetime = sentence.datetime
+      end
+    end
+  end
+end

data/lib/gps/nmea.rb

@@ -0,0 +1,12 @@
+module Gps
+  module Nmea
+    require_relative 'nmea/sentence'
+    require_relative 'nmea/gga'
+    require_relative 'nmea/gll'
+    require_relative 'nmea/gsv'
+    require_relative 'nmea/gsa'
+    require_relative 'nmea/vtg'
+    require_relative 'nmea/rmc'
+    require_relative 'nmea/zda'
+  end
+end

data/lib/gps/nmea/gga.rb

@@ -0,0 +1,34 @@
+require 'time'
+
+module Gps
+  module Nmea
+    class Gga < Sentence
+      attr_accessor :time, :time_str, :latitude, :latitude_direction, :longitude,
+                    :longitude_direction, :fix_quality, :num_satellites, :hdop,
+                    :altitude, :altitude_unit, :age_of_diff
+
+      def initialize(line)
+        @line = line
+        fill_parts
+        fill_data
+      end
+
+      private
+
+      def fill_data
+        @time_str = Sentence.time_part_to_str @parts[0]
+        @time = Time.parse time_str
+        @latitude = @parts[1].to_f
+        @latitude_direction = @parts[2]
+        @longitude = @parts[3].to_f
+        @longitude_direction = @parts[4]
+        @fix_quality = @parts[5].to_i
+        @num_satellites = @parts[6].to_i
+        @hdop = @parts[7].to_f
+        @altitude = @parts[8].to_f
+        @altitude_unit = @parts[9]
+        @age_of_diff = @parts[10].to_f
+      end
+    end
+  end
+end

data/lib/gps/nmea/gll.rb

@@ -0,0 +1,22 @@
+module Gps
+  module Nmea
+    class Gll < Sentence
+      attr_accessor :latitude, :latitude_direction, :longitude, :longitude_direction
+
+      def initialize(line)
+        @line = line
+        fill_parts
+        fill_data
+      end
+
+      private
+      
+      def fill_data
+        @latitude = @parts[0].to_f
+        @latitude_direction = @parts[1]
+        @longitude = @parts[2].to_f
+        @longitude_direction = @parts[3]
+      end
+    end
+  end
+end

data/lib/gps/nmea/gsa.rb

@@ -0,0 +1,27 @@
+module Gps
+  module Nmea
+    class Gsa < Sentence
+      attr_accessor :forced, :mode, :sv_id, :pdop, :hdop, :vdop
+
+      def initialize(line)
+        @line = line
+        fill_parts
+        fill_data
+      end
+
+      private
+      
+      def fill_data
+        @forced = @parts[0] == 'M'
+        @mode = @parts[1].to_i
+        @sv_id = 0
+        (2..13).each do |i|
+          @sv_id += ((12 - i) * 100) * @parts[i].to_i
+        end
+        @pdop = @parts[14].to_f
+        @hdop = @parts[15].to_f
+        @vdop = @parts[16].to_f
+      end
+    end
+  end
+end

data/lib/gps/nmea/gsv.rb

@@ -0,0 +1,26 @@
+module Gps
+  module Nmea
+    class Gsv < Sentence
+      attr_accessor :num_messages, :message_num, :total_svs, :sv_prn,
+                    :elevation, :azimuth, :snr
+
+      def initialize(line)
+        @line = line
+        fill_parts
+        fill_data
+      end
+
+      private
+
+      def fill_data
+        @num_messages = @parts[0].to_i
+        @message_num = @parts[1].to_i
+        @total_svs = @parts[2].to_i
+        @sv_prn = @parts[3].to_i
+        @elevation = @parts[4].to_i
+        @azimuth = @parts[5].to_i
+        @snr = @parts[6].to_i
+      end
+    end
+  end
+end

data/lib/gps/nmea/has_datetime.rb

@@ -0,0 +1,15 @@
+require 'date'
+
+module Gps
+  module Nmea
+    module HasDatetime
+      attr_accessor :date_str, :time_str, :datetime
+
+      def update_datetime
+        if @date_str && @time_str
+          @datetime = DateTime.iso8601 "#{@date_str}T#{@time_str}Z"
+        end
+      end
+    end
+  end
+end

data/lib/gps/nmea/rmc.rb

@@ -0,0 +1,36 @@
+require_relative 'has_datetime'
+
+module Gps
+  module Nmea
+    class Rmc < Sentence
+      include HasDatetime
+
+      attr_accessor :data_status, :latitude, :latitude_direction,
+                    :longitude, :longitude_direction, :speed_knots, :true_track,
+                    :variation, :variation_direction
+
+      def initialize(line)
+        @line = line
+        fill_parts
+        fill_data
+        update_datetime
+      end
+
+      private
+
+      def fill_data
+        @time_str = Sentence.time_part_to_str @parts[0]
+        @data_status = @parts[1]
+        @latitude = @parts[2]
+        @latitude_direction = @parts[3]
+        @longitude = @parts[4]
+        @longitude_direction = @parts[5]
+        @speed_knots = @parts[6]
+        @true_track = @parts[7]
+        @date_str = Sentence.date_part_to_str @parts[8]
+        @variation = @parts[9]
+        @variation_direction = @parts[10]
+      end
+    end
+  end
+end

data/lib/gps/nmea/sentence.rb

@@ -0,0 +1,111 @@
+module Gps
+  module Nmea
+    class Sentence
+      attr_accessor :line
+
+      def self.parse(line)
+        case
+        when line.start_with?('$GPGGA')
+          Gga.new line
+        when line.start_with?('$GPGLL')
+          Gll.new line
+        when line.start_with?('$GPGSV')
+          Gsv.new line
+        when line.start_with?('$GPGSA')
+          Gsa.new line
+        when line.start_with?('$GPVTG')
+          Vtg.new line
+        when line.start_with?('$GPRMC')
+          Rmc.new line
+        else
+          nil
+        end
+      end
+
+      def self.time_part_to_str(time_part)
+        "#{time_part[0..1]}:#{time_part[2..3]}:#{time_part[4..5]}"
+      end
+
+      def self.date_part_to_str(date_part)
+        century = date_part[4..5].to_i > 70 ? 1900 : 2000
+        "#{century + date_part[4..5].to_i}-#{date_part[2..3]}-#{date_part[0..1]}"
+      end
+
+      def checksum_valid?
+        get_checksum == generate_checksum
+      end
+
+      def get_checksum
+        line.split(',')[-1].split('*')[1].to_i 16
+      end
+
+      def generate_checksum
+        data = line.gsub('$', '').split('*')[0]
+        res = 0
+        data.split('').each do |c|
+          res ^= c.ord
+        end
+        res
+      end
+
+      def lat_dec
+        return nil if @latitude.nil?
+        return nil if @latitude_direction.nil?
+
+        lat, lat_dec = @latitude.to_s.split '.'
+        lat = lat.rjust 4, '0'
+        res = lat[0..1].to_i + ("#{lat[2..3]}.#{lat_dec}".to_f / 60.0)
+        res *= -1 if @latitude_direction == 'S'
+        res
+      end
+
+      def long_dec
+        return nil if @longitude.nil?
+        return nil if @longitude_direction.nil?
+
+        long, long_dec = @longitude.to_s.split '.'
+        long = long.rjust 5, '0'
+        res = long[0..2].to_i + ("#{long[3..4]}.#{long_dec}".to_f / 60.0)
+        res *= -1 if @longitude_direction == 'W'
+        res
+      end
+
+      def lat_long_dec
+        return nil unless has_coordinates?
+        "#{lat_dec} #{long_dec}"
+      end
+
+      def to_h
+        self.class.instance_methods(false)
+          .reject { |a| a.to_s.end_with? '=' }
+          .map { |a| [a.to_s, self.send(a)] }
+          .to_h.merge({ type: self.class.to_s.split('::').last.upcase })
+      end
+
+      def to_json(pretty=false)
+        require 'json'
+        if pretty
+          JSON.pretty_generate to_h
+        else
+          to_h.to_json
+        end
+      end
+
+      def has_coordinates?
+        !(@latitude.nil? || @longitude.nil? ||
+            @latitude_direction.nil? || @longitude_direction.nil?)
+      end
+
+      def has_datetime?
+        respond_to? :datetime
+      end
+
+      protected
+
+      def fill_parts
+        @parts = @line.split(',')[1..]
+        @parts[-1].gsub! /\*.+$/, ''
+      end
+    end
+  end
+end

data/lib/gps/nmea/vtg.rb

@@ -0,0 +1,22 @@
+module Gps
+  module Nmea
+    class Vtg < Sentence
+      attr_accessor :true_track, :magnetic_track, :speed_knots, :speed_kmh
+
+      def initialize(line)
+        @line = line
+        fill_parts
+        fill_data
+      end
+
+      private
+      
+      def fill_data
+        @true_track = @parts[0].to_f
+        @magnetic_track = @parts[2].to_f
+        @speed_knots = @parts[4].to_f
+        @speed_kmh = @parts[6].to_f
+      end
+    end
+  end
+end

data/lib/gps/nmea/zda.rb

@@ -0,0 +1,28 @@
+module Gps
+  module Nmea
+    class Zda < Sentence
+      attr_accessor :hour, :minute, :second, :day, :month, :year,
+                    :local_zone_desc, :local_zone_minutes
+
+      def initialize(line)
+        @line = line
+        fill_parts
+        fill_data
+      end
+
+      private
+
+      def fill_data
+        hms = @parts[0]
+        @hour = hms[0..1].to_i
+        @minute = hms[2..3].to_i
+        @second = hms[4..5].to_i
+        @day = @parts[1].to_i
+        @month = @parts[2].to_i
+        @year = @parts[3].to_i
+        @local_zone_desc = @parts[4].to_i
+        @local_zone_minutes = @parts[5].to_i
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: ruby-gps
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Nikola Miljkovic
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-06-16 00:00:00.000000000 Z
+dependencies: []
+description: 
+email: nikomil@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/gps.rb
+- lib/gps/device.rb
+- lib/gps/nmea.rb
+- lib/gps/nmea/gga.rb
+- lib/gps/nmea/gll.rb
+- lib/gps/nmea/gsa.rb
+- lib/gps/nmea/gsv.rb
+- lib/gps/nmea/has_datetime.rb
+- lib/gps/nmea/rmc.rb
+- lib/gps/nmea/sentence.rb
+- lib/gps/nmea/vtg.rb
+- lib/gps/nmea/zda.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: GPS utilities for Ruby
+test_files: []