mm_gps 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6caf7bc745f44789a88d5da54fc90055ec8739ef
-  data.tar.gz: f75f3b80c68f8e9cca6a5000e502398c4040b689
+  metadata.gz: f68f04c6955bd3be0fac1c0e6c9f6744efb2463a
+  data.tar.gz: 44d139c72d2ec7fec9eba8a1b9f12c72659bdc5c
 SHA512:
-  metadata.gz: cc3f0816082666eab31c7246112b3f7364b252e2e888cf95b86529755d8408834873449f0144ea1ce00996c91414548e4c79349a2a4194459a28a11eb24db2b7
-  data.tar.gz: 8e5e7beef52535c074fad13583f8b3c4e546bc2eb1e8a5a1f6ddcf435978f9702a5d109c12444d7d8d075b79f5f59de968042849fd04fad12522ded1ce37ed92
+  metadata.gz: d8c3dc05456bd59a303cae8b5d4cd082e0b51a82c3a8533d0308c4ba0202a7cb67c254fb63cce29f1397e9a1f89961616c20f6f7eb674db5e1b6fdaa1c1311b3
+  data.tar.gz: 51b785d6a816b966cb183f5235346ced4496dc510a020e2472994c7181ed7c6580db6ef6067d4ac1c8fdfa79b6986660dc29dae3fabbf13c5a0db0d0c9ebe07d

data/README.md

@@ -33,16 +33,25 @@ beacon = MmGPS::Beacon.new(PORT, BAUD)
 beacon.trap # installs signal handler for CTRL-C
 
 puts "Syncing..."
-beacon.sync # discards any byte until the starting sequence "\xFFG" arrives
+begin
+  beacon.sync # discards any byte until the starting sequence "\xFFG" arrives
+rescue MmGPSError => e
+  puts "Packet Error: #{e.inspect}"
+  p e.data[:packet]
+rescue IOError => e
+  puts "Port closed #{e.inspect}"
+  exit
+end
 
 puts "Reading..."
 while not beacon.closed? do
   begin
     p beacon.get_packet
-  rescue MmGPSException => e
+  rescue MmGPSError => e
     puts "Packet Error: #{e.inspect}"
+    p e.data
   rescue IOError => e
-    puts "Port closed? #{e.inspect}"
+    puts "Port closed #{e.inspect}"
     exit
   end
 end
@@ -50,7 +59,7 @@ end
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/mm_gps.
+Bug reports and pull requests are welcome [on GitHub ](https://github.com/pbosetti/ruby_mm_gps).
 
 
 ## License

data/lib/mm_gps/mm_gps_beacon.rb

@@ -5,17 +5,19 @@ module MmGPS
   class Beacon
     START_TOKEN = "\xFFG".force_encoding(Encoding::BINARY)
     EMPTY = ''.force_encoding(Encoding::BINARY)
+    attr_reader :last_pkt
     
     # Open a new connection on the given serial port. It also encapsulates
     # the underlying SerialPort object instance, setting a read timeout of 1 s
     # and enabling the binary mode.
     # 
     # @param port [String] 'COM1' on Windows, '/dev/ttyNNN' on *nix
-    # @param baus [Fixnum] baudrate, value must be supported by the platform
+    # @param baud [Fixnum] baudrate, value must be supported by the platform
     def initialize(port, baud = 115200)
       @sp = SerialPort.new(port, "baud" => baud)
       @sp.read_timeout = 1000 #1 sec
       @sp.binmode
+      @last_pkt = ''.force_encoding(Encoding::BINARY)
     end
     
     # Istalls a signal handler for the given signal, default to SIGINT, 
@@ -59,10 +61,17 @@ module MmGPS
     def get_raw_packet
       buf = START_TOKEN.dup
       while true do
-        buf << (@sp.read(1) || EMPTY)
+        char = @sp.read(1)
+        unless char
+          raise MmGPSError.new("Data unavailable", 
+            {reason: :noavail, packet:nil}) 
+        else
+          buf << char
+        end
         break if buf[-2..-1] == START_TOKEN
       end
-      return buf[0...-2]
+      @last_pkt = buf[0...-2]
+      return @last_pkt
     end
     
     # Reads a raw packet, checks its CRC, and returns its contents as a Hash.
@@ -70,6 +79,12 @@ module MmGPS
     # @return [Hash] typically in the form `%I(ts x y z f).zip(payload).to_h`
     def get_packet
       return MmGPS::parse_packet(self.get_raw_packet)
+    rescue MmGPSError => e
+      if e.data[:reason] == :noavail then
+        return nil
+      else 
+        raise e
+      end
     end
     
   end

data/lib/mm_gps/mm_gps_module.rb

@@ -1,5 +1,26 @@
 # Local Exception class.
-class MmGPSException < Exception; end
+#
+# The +@data+ attribute holds a Hash with informative content. In particular, 
+# +@data [:reason]+ holds a Symbol providing the internal error code, currently
+# one of the following:
+# 
+# - +:notype+   when the packet type code is neither 1 nor 2
+# - +:nocrc+    when the CRC16 check fails
+# - +:noavail+  when the serialport was not available for reading (timeout)
+# 
+# Typically, the last raw buffer is available in human readable format as:
+# 
+#     rescue MmGPSError => e
+#       puts MmGPS::hexify(e.data[:packet])
+#     end
+# 
+class MmGPSError < RuntimeError
+  attr_reader :data
+  def initialize(msg="Error in MmGPS class", data={})
+    @data = data
+    super(msg)
+  end
+end
 
 # Manage connection and data decoding with a MarvelMind beacon or hedgehog.
 module MmGPS
@@ -11,6 +32,17 @@ module MmGPS
     crc16(str) == 0
   end
   
+  # Returns a HEX description of a binary buffer
+  #
+  # @param buf [String] the input buffer
+  # @return [String] the HEX description
+  def self.hexify(buf)
+    len = buf.length
+    return (("%02X " * len) % buf.unpack("C#{len}")).chop
+  rescue NoMethodError
+    return '--'
+  end
+  
   # Parse the given buffer according to the MarvelMind protocol.
   # See http://www.marvelmind.com/pics/marvelmind_beacon_interfaces_v2016_03_07a.pdf
   #
@@ -18,7 +50,9 @@ module MmGPS
   # @return [Hash|Array] if the system is running, return a Hash with
   #   timestamp, coordinates, and error code (data code 0x0001). Otherwise returns an Array of Hashes for beacons status (data code 0x0002).
   def self.parse_packet(buf)
-    raise MmGPSException, "Invalid CRC" unless valid_crc16?(buf)
+    unless valid_crc16?(buf) then
+      raise MmGPSError.new("Invalid CRC", {reason: :nocrc, packet:buf, crc:crc16(buf)}) 
+    end
     # warn "Invalid CRC" unless valid_crc16?(buf)
     header = buf[0..5].unpack('CCS<C')
     if header[2] == 1 then # Regular GPS Data
@@ -37,7 +71,10 @@ module MmGPS
         %I(x y z).each {|k| result.last[k] /= 100.0}
       end
     else
-      raise MmGPSException, "Unexpected packet type #{header[2]}"
+      unless valid_crc16?(buf) then
+        raise MmGPSError.new("Unexpected packet type #{header[2]}",
+          {reason: :notype, packet:buf, crc:crc16(buf), type:header[2]}) 
+      end
     end
     return result
   end

data/lib/mm_gps/version.rb

@@ -1,3 +1,3 @@
 module MmGPS
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

data/test.rb

@@ -10,8 +10,9 @@ beacon.trap # installs signal handler for CTRL-C
 puts "Syncing..."
 begin
   beacon.sync # discards any byte until the starting sequence "\xFFG" arrives
-rescue MmGPSException => e
-  puts "Packet Error: #{e.inspect}"
+rescue MmGPSError => e
+  puts "Packet Error: #{e.inspect}, reason: #{e.data[:reason]}"
+  puts "Packet: #{MmGPS.hexify(e.data[:packet])}"
 rescue IOError => e
   puts "Port closed #{e.inspect}"
   exit
@@ -21,8 +22,9 @@ puts "Reading..."
 while not beacon.closed? do
   begin
     p beacon.get_packet
-  rescue MmGPSException => e
-    puts "Packet Error: #{e.inspect}"
+  rescue MmGPSError => e
+    puts "Packet Error: #{e.inspect}, reason: #{e.data[:reason]}"
+    puts "Packet: #{MmGPS.hexify(e.data[:packet])}"
   rescue IOError => e
     puts "Port closed #{e.inspect}"
     exit

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mm_gps
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Paolo Bosetti