nmea_gps 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 07cb0192771b8e1e90ea379ecb8ae3493ec37788
-  data.tar.gz: 020a505200c28173a4614717dcbac765ff9311a8
+  metadata.gz: 186f2e292efec893a3cfb3790f00b763261cba01
+  data.tar.gz: a37fea6191d105c65f2087b5dac5ec4feaa3b585
 SHA512:
-  metadata.gz: 553f60e8a1047a338ddadae3cb042c0909b144f6ea836451690b4d34f78c7393b6a7040e612e6ec6541fcc9776a05494589874fa26c9817fd182b656414ede4c
-  data.tar.gz: 7d544a2e0931dfd50e5435cdc914b00a025ad5a01fa287d957e0f90172c03b193cf301f9045da87c1350784a024d59874371390118d07539953209faf523c9b5
+  metadata.gz: 380861b8c6f53ae3fa3ab3a10e56d24bc915af6e0b55ce3fb7f0114330b105832c34a2b8c8347d5fc688ee19acfd6f5d44def03f8e166227f032e72a75723a24
+  data.tar.gz: 7b4e698131dc1a5b609dfa1be074e0a83c743f7f79e5a236c00265046a9196de30b025b1a2b755c21406ddd43f504f9b7d4e2c007e3334fa1410b831ed36faf4

data/README.md

@@ -37,6 +37,7 @@ gps = Nmea::Gps.new serialport update_hz: 10
 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.raw_sentence_line
   p rmc.time
   p rmc.latitude
   p rmc.longitude
@@ -52,6 +53,12 @@ gps.error do |exception|
   puts exception.backtrace.join "\n"
 end
 
+# if you want to receive all ...
+gps.all do |sentence, sentence_object|
+  p sentence         # such as :gga, :rmc
+  p sentence_object  # such as Nmea::Gps::Rmc, [Nmea::Gps::Gsv, Nmea::Gps::Gsv, ...]
+end
+
 # start the tracking
 gps.track!
 
@@ -83,6 +90,16 @@ gps.track!
 # ..
 # ..
 
+
+# you can clear callbacks on the run
+gps.clear_rmc # this will stop the call instantly
+
+
+# you can even start a callback on the run 
+gps.gga do |gga|
+  p [gga.latitude, gga.longitude]
+end
+
 # when you want to stop callbacks, you can call this
 # gps.stop!
 # then close the connection
@@ -92,6 +109,16 @@ gps.track!
 ## sentences
 [click here](https://github.com/github0013/nmea_gps/tree/master/lib/nmea_gps/sentences) for details
 
+| sentence | callback | parameter to be passed |
+|:----|:----|:---------------|
+| GGA | gga | Nmea::Gps::Gga |
+| GLL | gll | Nmea::Gps::Gll |
+| GSA | gsa | Nmea::Gps::Gsa |
+| GSV | gsv | [Nmea::Gps::Gsv, Nmea::Gps::Gsv, ...] |
+| RMC | rmc | Nmea::Gps::Rmc |
+| VTG | vtg | Nmea::Gps::Vtg |
+| ZDA | zda | Nmea::Gps::Zda |
+
 ## Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/nmea_gps/fork )

data/lib/nmea_gps/gps.rb

@@ -11,10 +11,14 @@ module Nmea
 
     Dir[Pathname(__FILE__).join("../sentences/*.rb")].collect do |path|
       Pathname(path).basename(".rb").to_s
-    end.tap{|array| array << "error" }.each do |sentence|
+    end.tap{|array| array << "error" << "all" }.each do |sentence|
       define_method(sentence) do |&block|
         self.callbacks[__callee__] = block
       end
+
+      define_method("clear_#{sentence}") do 
+        self.callbacks.delete(sentence.to_sym)
+      end
     end
 
     def track!
@@ -43,8 +47,8 @@ module Nmea
         Hash.new{|hash, key| hash[key] = [] }.tap do |set|
           catch(:done_one_cycle) do
             loop do 
-              ensure_sentence do |sentence, line|
-                set[sentence] << line
+              ensure_sentence do |sentence, raw_sentence_line|
+                set[sentence] << raw_sentence_line
               end
             end
           end
@@ -54,46 +58,43 @@ module Nmea
       def ensure_sentence
         yield *@buffer if @buffer
 
-        line = self.gps_serial_port.gets("\r\n").strip
+        raw_sentence_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})/)
+        return unless match = raw_sentence_line.match(/\A\$#{TALKER_ID}([ACDGLMRSTVZ]{3})/)
         
         sentence = match[1].downcase.to_sym
         if sentence == self.initial_sentence
-          @buffer = [sentence, line]
+          @buffer = [sentence, raw_sentence_line]
           throw :done_one_cycle 
         end
 
-        yield sentence, line
+        yield sentence, raw_sentence_line
 
         self.initial_sentence ||= sentence unless sentence == :gsv 
       end
 
       def callback!
-        this_set = sentences_in_a_cycle
-        this_set.keys.each do |sentence|
+        sentences_in_a_cycle.each do |sentence, raw_sentence_lines_in_array|
           begin
-            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
+                    raw_sentence_lines_in_array.sort.collect do |raw_sentence|
+                      target_class.new raw_sentence
                     end
                   else
-                    target_class.new(this_set[sentence].first)
+                    target_class.new(raw_sentence_lines_in_array.first)
                   end
 
-            this_callback.call object
+            self.callbacks[sentence].call object         if self.callbacks[sentence]
+            self.callbacks[:all].call [sentence, object] if self.callbacks[:all]
           rescue => ex
-            self.callbacks[:error].call ex
+            self.callbacks[:error].call ex if self.callbacks[:error]
           end
         end
 
       rescue => ex
-        self.callbacks[:error].call ex
+        self.callbacks[:error].call ex if self.callbacks[:error]
       end
 
 

data/lib/nmea_gps/sentence_base.rb

@@ -15,9 +15,10 @@ module Nmea
         "E" => :dr,
       }
 
+      attr_reader :raw_sentence_line
 
-      def initialize(line)
-        @line = line
+      def initialize(raw_sentence_line)
+        @raw_sentence_line = raw_sentence_line
       end
 
       def name
@@ -25,13 +26,10 @@ module Nmea
       end
 
       def raw_data
-        _, *data = self.line.split("*").first.split(",")
+        _, *data = self.raw_sentence_line.split("*").first.split(",")
         data
       end
 
-      protected
-        attr_reader :line
-
     end
   end
 end

data/lib/nmea_gps/version.rb

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

data/spec/lib/nmea_gps/sentence_base_spec.rb

@@ -2,12 +2,12 @@ require 'spec_helper'
 require 'nmea_gps/sentence_base'
 
 describe Nmea::Gps::SentenceBase do
-  let(:line){ "" }
-  subject{ Nmea::Gps::SentenceBase.new line }
+  let(:raw_sentence_line){ "" }
+  subject{ Nmea::Gps::SentenceBase.new raw_sentence_line }
 
   describe "initialize" do
-    let(:line){ "line" }
-    it{ expect(subject.instance_eval{@line}).to eq line }
+    let(:raw_sentence_line){ "raw_sentence_line" }
+    it{ expect(subject.raw_sentence_line).to eq raw_sentence_line }
   end
 
   describe "name" do
@@ -15,7 +15,7 @@ describe Nmea::Gps::SentenceBase do
   end
 
   describe "raw_data" do
-    let(:line){ "$GPNAME,#{(0..9).to_a.join(",")}*sum" }
+    let(:raw_sentence_line){ "$GPNAME,#{(0..9).to_a.join(",")}*sum" }
 
     it{ expect(subject.raw_data.first).to eq "0" }
     it{ expect(subject.raw_data.last).to eq "9" }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nmea_gps
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - ore
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-18 00:00:00.000000000 Z
+date: 2014-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler