nmea_gps 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fa3fef3d96dff44cb620276abc67d7e7eab832f0
+  data.tar.gz: c5ed23427e8805430ce9392035a149f8d1c74f3e
+SHA512:
+  metadata.gz: 40adfabfbbfcf6167565709b84634dfb3c8d0cffcd82bbe9f9a00b3b557df3016aed4064639259deef1864dafd206a3ad6208d8cbee616fbff9c2ab52e9272df
+  data.tar.gz: 29ddd56de23382fd20364a607b234efa347ae430ab1e6b515411ec00cdffb869965d5ed6811110f7e308287197426c0333bc48d546b42772fb4b2780f24fd708

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in nmea_gps.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,18 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rsspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separetly)
+#  * 'just' rspec: 'rspec'
+guard :rspec, cmd: 'bundle exec rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 ore
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,80 @@
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'nmea_gps'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nmea_gps
+
+## Usage
+
+```ruby
+
+# create a serialport to your GPS receiver
+# you should know how to open a connection between your GPS device
+# mine runs on `9600 baudrate`, `8bit`, `1stop bit`, `none parity`
+serialport = SerialPort.new("/dev/cu.your_whatever_device", 9600, 8, 1, SerialPort::NONE)
+
+# you should know about your GPS receiver's update Hz(how often it will update logs 10Hz = 10 times per sec.)
+# if you don't know leave it blank.  It will at least update every sec.
+gps = Nmea::Gps.new serialport update_hz: 10
+
+# this will be called automatically!!
+gps.rmc do |rmc|
+  p rmc.time
+  p rmc.latitude
+  p rmc.longitude
+  p rmc.heading
+  p rmc.date
+end
+
+# start the tracking
+gps.track!
+
+# you can also have
+# gps.gga do |gga|
+#   ..
+# end
+# gps.gll do |gll|
+#   ..
+# end
+# gps.gsa do |gsa|
+#   ..
+# end
+# gps.vtg do |vtg|
+#   ..
+# end
+# gps.zda do |zda|
+#   ..
+# end
+# 
+# this one gets multiple Gsv objects
+# gps.gsv do |gsvs|
+#   p gsvs.count
+#   ..
+# end
+
+# do your other works
+# ..
+# ..
+# ..
+
+# when you want to stop callbacks, you can call this
+# gps.stop!
+# then close the connection
+# serialport.close
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/nmea_gps/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+

data/lib/nmea_gps/config.rb

@@ -0,0 +1,11 @@
+module Nmea
+  class Config
+    class << self
+      attr_accessor :time_zone
+
+      def time_zone_list
+        TZInfo::Timezone.all_identifiers
+      end
+    end
+  end
+end

data/lib/nmea_gps/gps.rb

@@ -0,0 +1,82 @@
+module Nmea
+
+  class Gps
+    TALKER_ID = "GP"
+
+    def initialize(serial_port, update_hz: 1)
+      self.callbacks        = {}
+      self.gps_serial_port  = serial_port
+      self.update_hz        = 1.second.to_f / update_hz.to_i
+    end
+
+    Dir[Pathname(__FILE__).join("../sentences/*.rb")].collect do |path|
+      Pathname(path).basename(".rb").to_s
+    end.each do |sentence|
+      define_method(sentence) do |&block|
+        self.callbacks[__callee__] = block
+      end
+    end
+
+    def track!
+      self.track_thread = Thread.new do 
+        loop do 
+          callback!
+          frequency
+        end
+      end
+    end
+
+    def stop!
+      self.track_thread.kill if self.track_thread.respond_to? :kill
+    end
+
+    protected
+      attr_accessor :gps_serial_port, :update_hz, :callbacks, :track_thread
+
+    private
+
+      def hz
+        self.update_hz
+      end
+
+      def frequency
+        sleep hz
+      end
+
+      def line_set
+        Hash.new{|hash, key| hash[key] = [] }.tap do |set|
+          loop do 
+            line = self.gps_serial_port.gets("\r\n").strip
+            #                   %w[ GLL RMC VTG GGA GSA GSV ZDA].join.chars.uniq.sort.join
+            return unless match = line.match(/\A\$#{TALKER_ID}([ACDGLMRSTVZ]{3})/)
+            
+            sentence = match[1].downcase.to_sym
+            set[sentence] << line
+            break if sentence == :gga
+          end
+        end
+      end
+
+      def callback!
+        this_set = line_set
+        this_set.keys.each do |sentence|
+          this_callback = self.callbacks[sentence]
+          next unless this_callback
+
+          target_class = "Nmea::Gps::#{sentence.to_s.camelcase}".constantize
+
+          object = if sentence == :gsv
+                  this_set[sentence].sort.collect do |line|
+                    target_class.new line
+                  end
+                else
+                  target_class.new(this_set[sentence].first)
+                end
+
+          this_callback.call object
+        end
+      end
+
+
+  end
+end

data/lib/nmea_gps/sentence_base.rb

@@ -0,0 +1,37 @@
+module Nmea
+  class Gps
+
+    class SentenceBase
+
+      STATUSES = {
+        "A" => :valid,
+        "V" => :invalid,
+      }
+
+      MODES = {
+        "A" => :autonomous,
+        "N" => :no_fix,
+        "D" => :dgps,
+        "E" => :dr,
+      }
+
+
+      def initialize(line)
+        @line = line
+      end
+
+      def name
+        raise "override this method"
+      end
+
+      def raw_data
+        _, *data = self.line.split("*").first.split(",")
+        data
+      end
+
+      protected
+        attr_reader :line
+
+    end
+  end
+end

data/lib/nmea_gps/sentences/gga.rb

@@ -0,0 +1,70 @@
+module Nmea
+  class Gps
+
+    class Gga < SentenceBase
+      include Nmea::UtcTimeable, Nmea::DddFormatable
+
+      QUALITIES = {
+        0 => :invalid,
+        1 => :gps_sps_fix,
+        2 => :dgps_fix,
+        3 => :gps_pps_fix,
+      }
+
+      def name
+        "Global positioning system fixed data"
+      end
+
+      def time
+        hhmmss_to_local_time raw_data[0]
+      end
+
+      def latitude
+        dmm_to_ddd raw_data[1], raw_data[2]
+      end
+
+      def longitude
+        dmm_to_ddd raw_data[3], raw_data[4]
+      end
+
+      def quality
+        QUALITIES[raw_data[5].to_i]
+      end
+
+      def number_of_satellites
+        raw_data[6].to_i
+      end
+      alias :satellites :number_of_satellites
+
+      # http://en.wikipedia.org/wiki/Dilution_of_precision_%28GPS%29
+      def horizontal_dilution_of_precision
+        raw_data[7].to_f
+      end
+      alias :hdop :horizontal_dilution_of_precision
+
+      def altitude_in_meters
+        raw_data[8].to_f
+      end
+      alias :altitude :altitude_in_meters
+
+      def height_of_geoid_above_wgs84_ellipsoid
+        raw_data[10].to_f
+      end
+      alias :height_of_geoid :height_of_geoid_above_wgs84_ellipsoid
+
+      def time_in_seconds_since_last_dgps_update
+        raw_data[12].to_i
+      end
+      alias :last_dgps_update :time_in_seconds_since_last_dgps_update
+
+      def dgps_station_id
+        raw_data[13].to_s
+      end
+
+      def checksum
+        raw_data[14].to_s
+      end
+
+    end
+  end
+end

data/lib/nmea_gps/sentences/gll.rb

@@ -0,0 +1,34 @@
+module Nmea
+  class Gps
+
+    class Gll < SentenceBase
+      include Nmea::UtcTimeable, Nmea::DddFormatable
+
+      def name
+        "Geographic position—latitude/longitude"
+      end
+
+      def latitude
+        dmm_to_ddd raw_data[0], raw_data[1]
+      end
+
+      def longitude
+        dmm_to_ddd raw_data[2], raw_data[3]
+      end
+
+      def time
+        hhmmss_to_local_time raw_data[4]
+      end
+
+      def status
+        STATUSES[raw_data[5]]
+      end
+
+      def mode
+        MODES[raw_data[6]]
+      end
+
+    end
+  end
+end
+

data/lib/nmea_gps/sentences/gsa.rb

@@ -0,0 +1,57 @@
+module Nmea
+  class Gps
+
+    class Gsa < SentenceBase
+
+      MODE_SELECTIONS = {
+        "M" => :manual,
+        "A" => :automatic,
+      }
+
+      MODES = {
+        "1" => :fix_not_available,
+        "2" => :fix_2D,
+        "3" => :fix_3D,
+      }
+
+      def name
+        "GNSS DOP and active satellites"
+      end
+
+      def mode_selection
+        MODE_SELECTIONS[raw_data[0]]
+      end
+
+      def mode
+        MODES[raw_data[1]]
+      end
+
+      def ids_of_svs_used_in_position_fix(at = :all)
+        ids = raw_data[2..13]
+        return ids if at == :all
+        
+        id = ids[at.to_i - 1]
+        return nil if id.blank?
+
+        id.to_i
+      end
+      alias :svs_ids :ids_of_svs_used_in_position_fix
+
+      def position_dilution_of_precision
+        raw_data[14].to_f
+      end
+      alias :pdop :position_dilution_of_precision
+
+      def horizontal_dilution_of_precision
+        raw_data[15].to_f
+      end
+      alias :hdop :horizontal_dilution_of_precision
+
+      def vertical_dilution_of_precision
+        raw_data[16].to_f
+      end
+      alias :vdop :vertical_dilution_of_precision
+
+    end
+  end
+end

data/lib/nmea_gps/sentences/gsv.rb

@@ -0,0 +1,34 @@
+module Nmea
+  class Gps
+
+    class Gsv < SentenceBase
+      def name
+        "GNSS satellites in view"
+      end
+      
+      def number_of_message
+        raw_data[0].to_i
+      end
+
+      def message_number
+        raw_data[1].to_i
+      end
+
+      def number_of_satellites_in_view
+        raw_data[2].to_i
+      end
+
+      def satellites
+        raw_data[3..-1].each_slice(4).collect do |slice|
+          OpenStruct.new.tap do |satellite|
+            satellite.id                    = slice.first.to_i
+            satellite.elevation             = slice[1].to_i
+            satellite.azinmuth              = slice[2].to_i
+            satellite.signal_to_noise_ratio = satellite.snr = slice.last.to_i
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/nmea_gps/sentences/rmc.rb

@@ -0,0 +1,65 @@
+module Nmea
+  class Gps
+
+    class Rmc < SentenceBase
+      include Nmea::UtcTimeable, Nmea::DddFormatable
+
+      def name
+        "Recommended minimum specific GNSS data"
+      end
+
+      def time
+        hhmmss_to_local_time raw_data[0]
+      end
+
+      def status
+        STATUSES[raw_data[1]]
+      end
+
+      def latitude
+        dmm_to_ddd raw_data[2], raw_data[3]
+      end
+
+      def longitude
+        dmm_to_ddd raw_data[4], raw_data[5]
+      end
+
+      def knot_per_hour
+        raw_data[6].to_f
+      end
+
+      def km_per_hour
+        knot_per_hour * 1.85200
+      end
+
+      def mile_per_hour
+        knot_per_hour * 1.15077945
+      end
+
+      def heading
+        raw_data[7].to_f
+      end
+
+      def date
+        _, day, month, year = raw_data[8].match(/(\d{2})(\d{2})(\d{2})/).to_a
+        Date.parse("#{year}/#{month}/#{day}")
+      end
+
+      def magnetic_variation
+        return nil if raw_data[9].blank?
+        raw_data[9].to_f
+      end
+
+      def magnetic_variation_direction
+        return nil if raw_data[10].blank?
+        raw_data[10].to_f
+      end
+
+      def mode
+        MODES[raw_data[11]]
+      end
+
+
+    end
+  end
+end

data/lib/nmea_gps/sentences/vtg.rb

@@ -0,0 +1,27 @@
+module Nmea
+  class Gps
+
+    class Vtg < SentenceBase
+      def name
+        "Course over ground and ground speed"
+      end
+
+      def true_course
+        raw_data[0].to_f
+      end
+
+      def magnetic_course
+        return if raw_data[2].blank?
+        raw_data[2].to_f
+      end
+
+      def knot_per_hour
+        raw_data[4].to_f
+      end
+
+      def km_per_hour
+        raw_data[6].to_f
+      end
+    end
+  end
+end

data/lib/nmea_gps/sentences/zda.rb

@@ -0,0 +1,31 @@
+module Nmea
+  class Gps
+
+    class Zda < SentenceBase
+      include Nmea::UtcTimeable
+
+      def name
+        "Date and Time"
+      end
+
+      def time
+        hhmmss_to_local_time raw_data[0]
+      end
+
+      def date
+        Date.parse("#{raw_data[3]}/#{raw_data[2]}/#{raw_data[1]}")
+      end
+
+      def local_zone_hours
+        return if raw_data[4].blank?
+        raw_data[4].to_i
+      end
+
+      def local_zone_minutes
+        return if raw_data[5].blank?
+        raw_data[5].to_i
+      end
+
+    end
+  end
+end

data/lib/nmea_gps/version.rb

@@ -0,0 +1,3 @@
+module NmeaGps
+  VERSION = "0.0.1"
+end

data/lib/nmea_gps.rb

@@ -0,0 +1,40 @@
+require "pathname"
+require "serialport"
+require "ostruct"
+
+require 'active_support'
+require 'active_support/core_ext'
+Time.zone = "UTC"
+
+require "nmea_gps/version"
+require "nmea_gps/config"
+require "nmea_gps/gps"
+
+require "nmea_gps/sentence_base"
+Dir[Pathname(__FILE__).join("../sentences/*.rb")].each {|file| require file }
+
+module Nmea
+
+  module UtcTimeable
+    protected
+      def hhmmss_to_local_time(text)
+        hh, mm, ss = text.chars.each_slice(2).collect{|chars| chars.join }
+        utc_today = Time.zone.today
+        Time.zone.local(utc_today.year, utc_today.month, utc_today.day, hh, mm, ss).
+          in_time_zone(Nmea::Config.time_zone)
+      end
+  end
+
+  module DddFormatable
+    protected
+      def dmm_to_ddd(dmm, direction)
+        dmm = dmm.to_f / 100
+        integer = dmm.to_i
+        decimal = dmm % 1
+
+        (integer + decimal / 60  * 100.0) * ("NE".include?(direction) ? 1 : -1)
+      end
+  end
+
+end
+