mm_gps 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1f421d76d52b1d166ba48c7297133442e1d1d14f
-  data.tar.gz: 07eae466b465b8fcf74a39b4fde01f27c08cc120
+  metadata.gz: 4d298aac2aca73d83fc9191f83fac4742cf672d5
+  data.tar.gz: 29f94747a2e57cafd333845eeb7ea26f03a69eb8
 SHA512:
-  metadata.gz: 014223691ed7495d9e02994a500f76d9e16da35b17d04bc52cb1b24de0001c9e6dbd3c3307b755da9d1278bf1b55e9170cd081818b96d98f66d39e14b70e3f61
-  data.tar.gz: a203d83b7b478948b2f1ae91381cd93580b24ef41417a6d71a15581beb1e21c6295ac19625243bfa3e691c322b2b55cb2fc597801fb165f3d0a946bdd6b60e45
+  metadata.gz: b12093d8d971346ea2ee6955a8b432e09433ce4a187814cc7bc53fd2a54a3da25d19014a301fe89868e3a21a0d5dc0b721050b850c44dda5d51436a5028e0a78
+  data.tar.gz: 3cca41dcc61d525fd2e47fd70a8fd2398c45ff2b4c6471c5cf7f3f84ddfb47b759b65d5b27dfbe9a9d853dcdc2741ecc7bdddbd38c47952ef0bc2681e367409a

data/README.md

@@ -1,4 +1,4 @@
-# MmGps
+# MmGPS
 [![Gem Version](https://badge.fury.io/rb/mm_gps.svg)](https://badge.fury.io/rb/mm_gps)
 
 Ruby interface to [MarvelMind Indoor GPS System](http://www.marvelmind.com).
@@ -21,7 +21,32 @@ Or install it yourself as:
 
 ## Usage
 
-Definitely a TODO section :(
+Simple usage example:
+
+```ruby
+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.trap # installs signal handler for CTRL-C
+
+puts "Syncing..."
+beacon.sync # discards any byte until the starting sequence "\xFFG" arrives
+
+puts "Reading..."
+while not beacon.closed? do
+  begin
+    p beacon.get_packet
+  rescue GPSException => e
+    puts "Packet Error: #{e.inspect}"
+  rescue IOError => e
+    puts "Port closed? #{e.inspect}"
+    exit
+  end
+end
+```
 
 ## Contributing
 

data/ext/mm_gps/mm_gps.c

@@ -48,12 +48,12 @@ static VALUE mm_gps_add_CRC16(VALUE klass, VALUE str)
 }
 
 
-VALUE rb_mMmGps;
+VALUE rb_mMmGPS;
 
 void
 Init_mm_gps(void)
 {
-  rb_mMmGps = rb_define_module("MmGps");
-  rb_define_singleton_method(rb_mMmGps, "crc16", mm_gps_CRC16, 1);
-  rb_define_singleton_method(rb_mMmGps, "append_crc16", mm_gps_add_CRC16, 1);
+  rb_mMmGPS = rb_define_module("MmGPS");
+  rb_define_singleton_method(rb_mMmGPS, "crc16", mm_gps_CRC16, 1);
+  rb_define_singleton_method(rb_mMmGPS, "append_crc16", mm_gps_add_CRC16, 1);
 }

data/lib/mm_gps/mm_gps_beacon.rb

@@ -0,0 +1,49 @@
+module MmGPS  
+  class Beacon
+    START_TOKEN = "\xFFG".force_encoding(Encoding::BINARY)
+    EMPTY = ''.force_encoding(Encoding::BINARY)
+    
+    def initialize(port, baud = 115200)
+      @sp = SerialPort.new(port, "baud" => baud)
+      @sp.read_timeout = 1000 #1 sec
+      @sp.binmode
+    end
+    
+    def trap
+      Signal.trap("INT") do
+        @sp.close
+        puts "Beacon port: #{@sp.inspect}"
+      end
+    end
+
+    def close
+      @sp.close
+    end
+    
+    def closed?
+      return @sp.closed?
+    end
+    
+    def sync
+      buf = EMPTY
+      begin
+        buf << (@sp.read(1) || EMPTY)
+        buf = buf[-2..-1] if buf.size > 2
+      end while buf != START_TOKEN
+    end
+    
+    def get_raw_packet
+      buf = START_TOKEN.dup
+      while true do
+        buf << (@sp.read(1) || EMPTY)
+        break if buf[-2..-1] == START_TOKEN
+      end
+      return buf[0...-2]
+    end
+    
+    def get_packet
+      return MmGPS::parse_packet(self.get_raw_packet)
+    end
+    
+  end
+end

data/lib/mm_gps/mm_gps_module.rb

@@ -1,25 +1,28 @@
 class GPSException < Exception; end
 
-module MmGps
+module MmGPS
   def self.valid_crc16?(str)
     crc16(str) == 0
   end
   
   def self.parse_packet(buf)
     raise GPSException, "Invalid CRC" unless valid_crc16?(buf)
-    header = buf[0...5].unpack('CCS>C')
-    
+    # warn "Invalid CRC" unless valid_crc16?(buf)
+    header = buf[0..5].unpack('CCS<C')
     if header[2] == 1 then # Regular GPS Data
       result = {}
-      payload = buf[5...16].unpack('L>S>3C')
+      payload = buf[5...16].unpack('L<s<3C')
       result = %I(ts x y z f).zip(payload).to_h
+      result[:ts] /= 64.0
+      %I(x y z).each {|k| result[k] /= 100.0}
     elsif header[2] == 2 then # Frozen
       len = buf[5].unpack('C')[0]
       result = []
       len.times do |i|
         offset = 6 + i * 8
-        payload = buf[offset...(offset + 8)].unpack('CS>3C')
+        payload = buf[offset...(offset + 8)].unpack('Cs<3C')
         result << %I(address x y z reserved).zip(payload).to_h
+        %I(x y z).each {|k| result.last[k] /= 100.0}
       end
     else
       raise GPSException, "Unexpected packet type #{header[2]}"

data/lib/mm_gps/version.rb

@@ -1,3 +1,3 @@
-module MmGps
-  VERSION = "0.1.1"
+module MmGPS
+  VERSION = "0.1.2"
 end

data/lib/mm_gps.rb

@@ -1,7 +1,9 @@
-require "mm_gps/version"
-require "mm_gps/mm_gps_module"
-require "mm_gps/mm_gps"
+require 'serialport'
+require 'mm_gps/version'
+require 'mm_gps/mm_gps_module'
+require 'mm_gps/mm_gps_beacon'
+require 'mm_gps/mm_gps'
 
-module MmGps
+module MmGPS
   # Your code goes here...
 end

data/mm_gps.gemspec

@@ -5,7 +5,7 @@ require 'mm_gps/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "mm_gps"
-  spec.version       = MmGps::VERSION
+  spec.version       = MmGPS::VERSION
   spec.authors       = ["Paolo Bosetti"]
   spec.email         = ["paolo.bosetti@unitn.it"]
 
@@ -27,6 +27,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
   spec.extensions    = ["ext/mm_gps/extconf.rb"]
+  spec.add_dependency "serialport", "~> 1.3.1"
 
   spec.add_development_dependency "bundler", "~> 1.12"
   spec.add_development_dependency "rake", "~> 10.0"

data/test.rb

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+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.trap # installs signal handler for CTRL-C
+
+puts "Syncing..."
+beacon.sync # discards any byte until the starting sequence "\xFFG" arrives
+
+puts "Reading..."
+while not beacon.closed? do
+  begin
+    p beacon.get_packet
+  rescue GPSException => e
+    puts "Packet Error: #{e.inspect}"
+  rescue IOError => e
+    puts "Port closed? #{e.inspect}"
+    exit
+  end
+end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: mm_gps
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Paolo Bosetti
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-07-21 00:00:00.000000000 Z
+date: 2016-08-17 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: serialport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -71,9 +85,11 @@ files:
 - ext/mm_gps/mm_gps.c
 - ext/mm_gps/mm_gps.h
 - lib/mm_gps.rb
+- lib/mm_gps/mm_gps_beacon.rb
 - lib/mm_gps/mm_gps_module.rb
 - lib/mm_gps/version.rb
 - mm_gps.gemspec
+- test.rb
 homepage: https://github.com/pbosetti/ruby_mm_gps
 licenses:
 - MIT