nmea_gps 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 057dc086fbc62478f210459a628ca8837798717e
-  data.tar.gz: 4b4bdd5adf65ae06517a9c78db1ec70d1e8bd432
+  metadata.gz: 07cb0192771b8e1e90ea379ecb8ae3493ec37788
+  data.tar.gz: 020a505200c28173a4614717dcbac765ff9311a8
 SHA512:
-  metadata.gz: a8d32f4bdce6f704592d7be01c7ff2a2e00d1b342813649b65a16946de5daf3b540bfc8d922a2663230a304235d60ac68726e2f082f8ccf7710f968db36cadf3
-  data.tar.gz: 6d108b7a93ceed09b3050e36d75a92a0f1353293f20260769828759eb219f989c2741c64c6cc37da142bbe340586fac0e4323b748acac4a48f5a35390ea6b159
+  metadata.gz: 553f60e8a1047a338ddadae3cb042c0909b144f6ea836451690b4d34f78c7393b6a7040e612e6ec6541fcc9776a05494589874fa26c9817fd182b656414ede4c
+  data.tar.gz: 7d544a2e0931dfd50e5435cdc914b00a025ad5a01fa287d957e0f90172c03b193cf301f9045da87c1350784a024d59874371390118d07539953209faf523c9b5

data/README.md

@@ -35,12 +35,22 @@ gps = Nmea::Gps.new serialport update_hz: 10
 
 # this will be called automatically!!
 gps.rmc do |rmc|
+  # you will get a sentence object as a parameter
+  # for gsv callback, it will be an array containing multiple gsv objects [gsv, gsv, gsv]
   p rmc.time
   p rmc.latitude
   p rmc.longitude
   p rmc.heading
   p rmc.date
 end
+# sentences > https://github.com/github0013/nmea_gps/tree/master/lib/nmea_gps/sentences
+# you have a callback on each sentence such as gga, gll ..., 
+
+# built-in error callback (catch errors in the internal thread)
+gps.error do |exception|
+  p exception.message
+  puts exception.backtrace.join "\n"
+end
 
 # start the tracking
 gps.track!
@@ -79,6 +89,9 @@ gps.track!
 # serialport.close
 ```
 
+## sentences
+[click here](https://github.com/github0013/nmea_gps/tree/master/lib/nmea_gps/sentences) for details
+
 ## Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/nmea_gps/fork )

data/lib/nmea_gps/gps.rb

@@ -3,15 +3,15 @@ module Nmea
   class Gps
     TALKER_ID = "GP"
 
-    def initialize(serial_port, update_hz: 1)
+    def initialize(serial_port, hz: 1)
       self.callbacks        = {}
       self.gps_serial_port  = serial_port
-      self.update_hz        = 1.second.to_f / update_hz.to_i
+      self.update_hz        = 1.second.to_f / (hz.to_i.zero? ? 1 : hz.to_i)
     end
 
     Dir[Pathname(__FILE__).join("../sentences/*.rb")].collect do |path|
       Pathname(path).basename(".rb").to_s
-    end.each do |sentence|
+    end.tap{|array| array << "error" }.each do |sentence|
       define_method(sentence) do |&block|
         self.callbacks[__callee__] = block
       end
@@ -31,36 +31,47 @@ module Nmea
     end
 
     protected
-      attr_accessor :gps_serial_port, :update_hz, :callbacks, :track_thread
+      attr_accessor :gps_serial_port, :update_hz, :callbacks, :track_thread, :initial_sentence
 
     private
 
-      def hz
-        self.update_hz
-      end
-
       def frequency
-        sleep hz
+        sleep self.update_hz
       end
 
-      def line_set
+      def sentences_in_a_cycle
         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
-            next unless match = line.match(/\A\$#{TALKER_ID}([ACDGLMRSTVZ]{3})/)
-            
-            sentence = match[1].downcase.to_sym
-            set[sentence] << line
-            break if sentence == :gga
+          catch(:done_one_cycle) do
+            loop do 
+              ensure_sentence do |sentence, line|
+                set[sentence] << line
+              end
+            end
           end
         end
       end
 
+      def ensure_sentence
+        yield *@buffer if @buffer
+
+        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
+        if sentence == self.initial_sentence
+          @buffer = [sentence, line]
+          throw :done_one_cycle 
+        end
+
+        yield sentence, line
+
+        self.initial_sentence ||= sentence unless sentence == :gsv 
+      end
+
       def callback!
-        this_set = line_set
+        this_set = sentences_in_a_cycle
         this_set.keys.each do |sentence|
-          # TODO: error handling
           begin
             this_callback = self.callbacks[sentence]
             next unless this_callback
@@ -77,10 +88,12 @@ module Nmea
 
             this_callback.call object
           rescue => ex
-            puts "#{ex.message} sentence:#{sentence} / #{this_set[sentence]}"
-            puts ex.backtrace.join "\n"
+            self.callbacks[:error].call ex
           end
         end
+
+      rescue => ex
+        self.callbacks[:error].call ex
       end
 
 

data/lib/nmea_gps/version.rb

@@ -1,3 +1,3 @@
 module NmeaGps
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/lib/nmea_gps/gps_spec.rb

@@ -10,28 +10,20 @@ require 'nmea_gps/sentences/zda'
 
 describe Nmea::Gps do
   let(:serial_port){ double("serial_port") }
-  let(:update_hz){ 1 }
-  let(:gps){ Nmea::Gps.new serial_port, update_hz: update_hz }
-
-  describe "hz" do
-    subject{ gps.send :hz }
-    it{ expect(subject).to eq 1 }
-
-    context "10Hz" do 
-      let(:update_hz){ 10 }
-      it{ expect(subject).to eq 0.1 }
-    end
-  end
+  let(:hz){ 1 }
+  let(:how_long_to_sleep){ nil }
+  let(:gps){ Nmea::Gps.new serial_port, hz: hz }
 
   describe "frequency" do
-    before{ expect(gps).to receive(:sleep).with(hz).at_least 1 }
+    before{ expect(gps).to receive(:sleep).with(how_long_to_sleep).at_least 1 }
     
-    let(:hz){ 1 / 1 }
+    let(:hz){ 1 }
+    let(:how_long_to_sleep){ 1 }
     it{ gps.send :frequency }
 
     context "10Hz" do
-      let(:update_hz){ 10 }
-      let(:hz){ 1 / 10.0 }
+      let(:hz){ 10 }
+      let(:how_long_to_sleep){ 0.1 }
       it{ gps.send :frequency }
     end
   end
@@ -47,23 +39,24 @@ describe Nmea::Gps do
     it{ expect(gps).to respond_to :zda }
   end
 
-  describe "line_set" do
+  describe "sentences_in_a_cycle" do
     before do
-      allow(serial_port).to receive(:gets).and_return *lines.collect{|line| "#{line}\r\n" }
+      allow(serial_port).to receive(:gets).and_return *sentences.collect{|sentence| "#{sentence}\r\n" }
     end
 
-    subject{ gps.send :line_set }
+    subject{ gps.send :sentences_in_a_cycle }
 
-    context "single line" do
-      let(:lines) do
+    context "single sentence" do
+      let(:sentences) do
         ["$GPGGA,075800.000,3357.7401,N,13112.3701,E,2,9,1.04,-3.6,M,27.5,M,0000,0000*74"]
       end
       it{ expect(subject.keys).to eq [:gga] }
     end
 
-    context "multiple lines" do
-      let(:lines) do
+    context "multiple sentences" do
+      let(:sentences) do
         [
+          "$GPGGA,075800.000,3357.7401,N,13112.3701,E,2,9,1.04,-3.6,M,27.5,M,0000,0000*74",
           "$GPGLL,3539.51480,N,13944.72598,E,075247.000,A,A*5D",
           "$GPGSA,A,3,24,26,05,13,21,12,15,18,,,,,1.29,0.97,0.86*00",
           "$GPGSV,3,1,11,24,70,198,52,15,63,016,,50,47,156,38,21,44,270,39*78",
@@ -97,7 +90,7 @@ describe Nmea::Gps do
 
   describe "callback!" do
     before do
-      allow(gps).to receive(:line_set).and_return(
+      allow(gps).to receive(:sentences_in_a_cycle).and_return(
         {
           gga: ["$GPGGA,075800.000,3357.7401,N,13112.3701,E,2,9,1.04,-3.6,M,27.5,M,0000,0000*74"],
           gsv: [
@@ -109,14 +102,14 @@ describe Nmea::Gps do
       )
     end
 
-    it "single line callback" do 
+    it "single sentence callback" do 
       gps.gga do |gga|
         expect(gga.class).to eq Nmea::Gps::Gga
       end
       gps.send :callback!
     end
 
-    it "multiple line callback" do
+    it "multiple sentence callback" do
       gps.gsv do |gsvs|
         expect(gsvs.count).to eq 3
         expect(gsvs.first.class).to eq Nmea::Gps::Gsv

data/spec/lib/nmea_gps/sentences/gga_spec.rb

@@ -1,5 +1,6 @@
 require 'spec_helper'
 require 'nmea_gps/sentences/gga'
+Time.zone = "UTC"
 
 describe Nmea::Gps::Gga do
   let(:line){ "$GPGGA,075247.000,3539.51480,N,13944.72598,E,1,8,0.97,-15.6,M,27.5,M,13,X*44" }

data/spec/lib/nmea_gps/sentences/gll_spec.rb

@@ -1,5 +1,6 @@
 require 'spec_helper'
 require 'nmea_gps/sentences/gll'
+Time.zone = "UTC"
 
 describe Nmea::Gps::Gll do
   let(:line){ "$GPGLL,3539.51480,N,13944.72598,E,075247.000,A,A*5D" }

data/spec/lib/nmea_gps/sentences/rmc_spec.rb

@@ -1,5 +1,6 @@
 require 'spec_helper'
 require 'nmea_gps/sentences/rmc'
+Time.zone = "UTC"
 
 describe Nmea::Gps::Rmc do
   let(:line){ "$GPRMC,075333.000,A,3539.51480,N,13944.72598,E,32.84,151.55,171214,,,A*68" }

data/spec/lib/nmea_gps/sentences/zda_spec.rb

@@ -1,5 +1,6 @@
 require 'spec_helper'
 require 'nmea_gps/sentences/zda'
+Time.zone = "UTC"
 
 describe Nmea::Gps::Zda do
   let(:line){ "$GPZDA,075936.000,17,12,2014,,*5A" }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nmea_gps
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - ore
@@ -151,7 +151,6 @@ files:
 - lib/nmea_gps/version.rb
 - nmea_gps.gemspec
 - spec/ddd_formatable_spec.rb
-- spec/lib/gps_spec.rb
 - spec/lib/nmea_gps/gps_spec.rb
 - spec/lib/nmea_gps/sentence_base_spec.rb
 - spec/lib/nmea_gps/sentences/gga_spec.rb
@@ -190,7 +189,6 @@ specification_version: 4
 summary: NMEA GPS logs to trigger a callback on each NMEA 0183 sentence.
 test_files:
 - spec/ddd_formatable_spec.rb
-- spec/lib/gps_spec.rb
 - spec/lib/nmea_gps/gps_spec.rb
 - spec/lib/nmea_gps/sentence_base_spec.rb
 - spec/lib/nmea_gps/sentences/gga_spec.rb

data/spec/lib/gps_spec.rb

@@ -1,97 +0,0 @@
-require 'spec_helper'
-require 'nmea_gps/gps'
-
-describe Nmea::Gps do
-  let(:serial_port){ double("serial_port") }
-  let(:update_hz){ 1 }
-  let(:gps){ Nmea::Gps.new serial_port, update_hz: update_hz }
-
-  describe "hz" do
-    subject{ gps.send :hz }
-    it{ expect(subject).to eq 1 }
-
-    context "10Hz" do 
-      let(:update_hz){ 10 }
-      it{ expect(subject).to eq 0.1 }
-    end
-  end
-
-  describe "frequency" do
-    let(:hz){ 1 / 1 }
-    before{ allow(Kernel).to receive(:sleep).with(hz) }
-    it{ expect{ gps.send :frequency }.not_to raise_error }
-
-    context "10Hz" do
-      let(:hz){ 1 / 10 }
-      it{ expect{ gps.send :frequency }.not_to raise_error }
-    end
-  end
-
-  describe "dynamic sentence methods" do
-    it{ expect(gps).to respond_to :gga }
-    it{ expect(gps).to respond_to :gll }
-    it{ expect(gps).to respond_to :gsa }
-    it{ expect(gps).to respond_to :gsv }
-    it{ expect(gps).to respond_to :rmc }
-    it{ expect(gps).to respond_to :gga }
-    it{ expect(gps).to respond_to :vtg }
-    it{ expect(gps).to respond_to :zda }
-  end
-
-  describe "line_set" do
-    before do
-      allow(serial_port).to receive(:gets).and_return *lines.collect{|line| "#{line}\r\n" }
-    end
-
-    subject{ gps.send :line_set }
-
-    context "single" do
-      let(:lines){ ["$GPGGA,075247.000,3539.51480,N,13944.72598,E,1,8,0.97,-15.6,M,27.5,M,13,X*44"] }
-
-      it{ expect(subject.keys).to eq [:gga] }
-      it{ expect(subject.values).to eq [lines] }
-    end
-
-    context "multiple lines", focus: true do 
-      let(:lines) do
-        [
-          "$GPGLL,3539.51480,N,13944.72598,E,075247.000,A,A*5D",
-          "$GPGSA,A,3,24,26,05,13,21,12,15,18,,,,,1.29,0.97,0.86*00",
-          "$GPGSV,3,1,11,24,70,198,52,15,63,016,,50,47,156,38,21,44,270,39*78",
-          "$GPGSV,3,2,11,18,40,314,30,26,27,058,46,05,19,124,42,12,09,159,35*73",
-          "$GPGSV,3,3,11,13,07,067,35,28,07,041,15,22,05,309,28*42",
-          "$GPRMC,075333.000,A,3539.51480,N,13944.72598,E,32.84,151.55,171214,,,A*68",
-          "$GPVTG,93.98,T,,M,32.84,N,60.85,K,D*05",
-          "$GPZDA,075936.000,17,12,2014,,*5A",
-          "$GPGGA,075247.000,3539.51480,N,13944.72598,E,1,8,0.97,-15.6,M,27.5,M,13,X*44",
-        ]
-      end
-
-
-      it{ expect(subject.keys.sort).to eq [:gga, :gll, :gsa, :gsv, :rmc, :vtg, :zda] }
-      it do 
-        expect(subject).to eq({
-          gll: ["$GPGLL,3539.51480,N,13944.72598,E,075247.000,A,A*5D"],
-          gsa: ["$GPGSA,A,3,24,26,05,13,21,12,15,18,,,,,1.29,0.97,0.86*00"],
-          gsv: [
-            "$GPGSV,3,1,11,24,70,198,52,15,63,016,,50,47,156,38,21,44,270,39*78",
-            "$GPGSV,3,2,11,18,40,314,30,26,27,058,46,05,19,124,42,12,09,159,35*73",
-            "$GPGSV,3,3,11,13,07,067,35,28,07,041,15,22,05,309,28*42",
-          ],
-          rmc: ["$GPRMC,075333.000,A,3539.51480,N,13944.72598,E,32.84,151.55,171214,,,A*68"],
-          vtg: ["$GPVTG,93.98,T,,M,32.84,N,60.85,K,D*05"],
-          zda: ["$GPZDA,075936.000,17,12,2014,,*5A"],
-          gga: ["$GPGGA,075247.000,3539.51480,N,13944.72598,E,1,8,0.97,-15.6,M,27.5,M,13,X*44"],
-        })
-      end
-
-    end
-  end
-
-  describe "" do
-  end
-
-  describe "" do
-  end
-
-end