mm_gps 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d54d7a04b331b5339f0e68b21e903101424a9f9e
-  data.tar.gz: b07d30015c9e27d411154880d00b23f1afd6cb00
+  metadata.gz: bafa75b0c01b3afc71beb0aeec35a2b9b7656a80
+  data.tar.gz: 9fc0afa4c8aac65f97f07f056c361a4f74f1e95f
 SHA512:
-  metadata.gz: c8f837ef92db27cd2a89db5a03c368f301cdcd5003bc7d43d54279407d0a60c433847ad7283826560e66e11ac3535a22d7ec2397ec62914e8b4eb88d563b4d6b
-  data.tar.gz: 86cd9f6dadc96679aaa1712b4620569262954635f29014b3672fdac13b5c115e53db40284854433c2d4b12bc62799b9e5e1273e223fac93f0536fccce2d23546
+  metadata.gz: dae1b925e9a840821017e70660b50656311976f661a7069af3539769ca5cdf6f9213f1ec2c2f013e5e4b6aecd9f23ac85484186770e163765c4adc9844bf9f65
+  data.tar.gz: e1c98dbc0e84f3dedf1fbe1bd965e293df9745e589dd698f8918ce7ead976ccc0a285a8c914716e22e93f9b078fc343ae6d96836e6ce2975bd260b6e5529ab3f

data/README.md

@@ -29,12 +29,16 @@ require 'mm_gps'
 PORT = "/dev/cu.usbmodem1411"
 BAUD = 115200 # SerialPort class does not support non-standard 500 kbps
 
-beacon = MmGPS::Beacon.new(PORT, BAUD)
+beacon = MmGPS::Beacon.new(PORT, baud: BAUD)
 beacon.trap # installs signal handler for CTRL-C
 
  # Standard each loop. Type CTRL-C for interrupting it
-beacon.each do |packet|
-  p packet
+File.open("dump.bin", 'w') do |f|
+  beacon.each do |packet, raw|
+    p packet
+    puts MmGPS::hexify(raw)
+    f.print(raw)
+  end
 end
 
  # Use the enumerator:

data/ext/mm_gps/mm_gps.c

@@ -1,6 +1,8 @@
 #include "mm_gps.h"
 
+#ifndef uchar
 typedef unsigned char uchar;
+#endif
 
 typedef union { 
   ushort w;
@@ -29,10 +31,11 @@ static ushort CRC16(const void *buf, ushort length) {
   return (ushort)crc.w;
 }
 
-/* Calculate CRC16 checksum of a string
- * 
- * @param buf [String] the string to be checksummed
- * @return [Fixnum] the CRC16 value
+/* @overload crc16(buf)
+ *   Calculate CRC16 checksum of a string
+ *   
+ *   @param buf [String] the string to be checksummed
+ *   @return [Fixnum] the CRC16 value
  */
 static VALUE mm_gps_CRC16(VALUE klass, VALUE str)
 {
@@ -40,10 +43,11 @@ static VALUE mm_gps_CRC16(VALUE klass, VALUE str)
   return rb_fix_new(CRC16(RSTRING_PTR(str), RSTRING_LEN(str)));
 }
 
-/* Appends a CRC16 checksum to a string
- * 
- * @param buf [String] the starting string
- * @return [String] the original string plus its CRC16
+/* @overload append_crc16(buf)
+ *   Appends a CRC16 checksum to a string
+ *   
+ *   @param buf [String] the starting string
+ *   @return [String] the original string plus its CRC16
  */
 static VALUE mm_gps_add_CRC16(VALUE klass, VALUE str)
 {

data/lib/mm_gps/mm_gps_beacon.rb

@@ -4,12 +4,13 @@ module MmGPS
   # You may want (and can) to have more than one instance.
   # 
   # @example Typical usage:
-  #   beacon = MmGPS::Beacon.new(PORT, BAUD)
+  #   beacon = MmGPS::Beacon.new(PORT, baud: BAUD)
   #   beacon.trap # installs signal handler for CTRL-C
   #   
   #   # Standard each loop. Type CTRL-C for interrupting it
-  #   beacon.each do |packet|
+  #   beacon.each do |packet, raw|
   #     p packet
+  #     puts MmGPS::hexify(raw)
   #   end
   # @example Using the enumerator:
   #   # Use the enumerator:
@@ -29,7 +30,7 @@ module MmGPS
     # 
     # @param port [String] 'COM1' on Windows, '/dev/ttyNNN' on *nix
     # @param baud [Fixnum] baudrate, value must be supported by the platform
-    def initialize(port, baud = 115200)
+    def initialize(port, baud: 115200)
       @port, @baud = port, baud
       self.open
     end
@@ -98,7 +99,7 @@ module MmGPS
       return enum_for(:each) unless block_given?
       loop do
         begin
-          yield self.get_packet
+          yield self.get_packet, @last_pkt
         rescue MmGPSError => e
           warn "Packet Error: #{e.inspect}, reason: #{e.data[:reason]}"
           warn "Packet: #{MmGPS.hexify(e.data[:packet])}"
@@ -121,8 +122,7 @@ module MmGPS
       if pkt.empty? then
         raise MmGPSError.new("Data unavailable", {reason: :noavail})
       end
-      @last_pkt = pkt
-      return @last_pkt
+      return @last_pkt = pkt
     end
     
     # Reads a raw packet, checks its CRC, and returns its contents as a Hash.

data/lib/mm_gps/version.rb

@@ -1,3 +1,3 @@
 module MmGPS
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/test.rb

@@ -4,15 +4,18 @@ require 'mm_gps'
 PORT = "/dev/cu.usbmodem1411"
 BAUD = 115200 # SerialPort class does not support non-standard 500 kbps
 
-beacon = MmGPS::Beacon.new(PORT, BAUD)
+beacon = MmGPS::Beacon.new(PORT, baud: BAUD)
 beacon.trap # installs signal handler for CTRL-C
 
 # Standard each loop. Type CTRL-C for interrupting it
-beacon.each do |packet|
-  p packet
+File.open("dump.bin", 'w') do |f|
+  beacon.each do |packet, raw|
+    p packet
+    puts MmGPS::hexify(raw)
+    f.print(raw)
+  end
 end
 
-
 # Use the enumerator:
 beacon.reopen      # Needed, since CTRL-C in previous example also closes the Serialport connection
 enum = beacon.each # gets the Enumerator

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mm_gps
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Paolo Bosetti
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-23 00:00:00.000000000 Z
+date: 2016-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: serialport