gpsd 0.0.1

data/lib/gpsd.rb

@@ -0,0 +1,135 @@
+require 'timeout'
+require 'socket'
+require 'io/wait'
+
+require_relative 'gpsd/response'
+require_relative 'gpsd/errors'
+
+class Socket
+  def ready?
+    not IO.select([self], nil, nil, 0) == nil
+  end
+end
+
+module GPS
+  class Receiver
+    DEFAULT_HOSTNAME     = 'localhost'
+    DEFAULT_PORT         = 2947
+    DEFAULT_TIMEOUT      = 5
+    DEFAULT_MAX_ATTEMPT  = 3
+    DEFAULT_RETRY_DELAY  = 10
+    DEFAULT_READ_TIMEOUT = 2
+
+    attr_reader :version, :filename, :hostname, :port
+
+    def initialize(options={})
+      @_options = options
+
+    # set default options
+      @_options[:timeout]      ||= DEFAULT_TIMEOUT
+      @_options[:read_timeout] ||= DEFAULT_READ_TIMEOUT
+      @_options[:hostname]     ||= DEFAULT_HOSTNAME
+      @_options[:port]         ||= DEFAULT_PORT
+      @_options[:retry_delay]  ||= DEFAULT_RETRY_DELAY
+      @_options[:attempts]     ||= DEFAULT_MAX_ATTEMPT
+
+      connect() unless options[:autoconnect] == false
+    end
+
+    def connect(options=nil)
+      attempts = 0
+      options = @_options.merge(options || {})
+
+      Timeout.timeout(options[:timeout]) do
+      # connect to a UNIX socket
+        if options[:socket]
+          raise GPS::Error.new("File #{options[:socket]} is not a socket") unless File.socket?(options[:socket])
+          @filename = options[:socket]
+          @socket = UNIXSocket.new(options[:socket])
+        else
+          begin
+            attempts += 1
+            @hostname = options[:hostname]
+            @port     = options[:port]
+            @socket = TCPSocket.new(options[:hostname], options[:port].to_i)
+          rescue Errno::ECONNREFUSED
+            raise GPS::ConnectionError.new("Could not connect to #{options[:hostname]}:#{options[:port]} after #{attempts} attempts, connection is closed") if attempts >= options[:attempts]
+            sleep options[:retry_delay]
+            retry
+          end
+        end
+
+        if (gps_ident = GPS::Response.new(socket().gets()))
+          raise GPS::ProtocolError.new("Problem connecting to GPSd: invalid banner") if gps_ident.nil? or gps_ident.classname != :VERSION
+          @version = gps_ident.release
+        end
+      end
+    end
+
+    def socket()
+      if @socket.closed?
+        connect()
+      end
+
+      return @socket
+    end
+
+    def close()
+      socket().close() if not socket().closed?
+    end
+
+    def send_command(cmd, options={})
+      cmdline = "?#{cmd.to_s.upcase}#{options.empty? ? '' : '='+MultiJson.dump(options)};"
+
+      begin
+        socket().puts(cmdline)
+      rescue Errno::EPIPE
+        connect()
+        retry
+      end
+    end
+
+    def read_response(blocking=true)
+      rv = []
+
+      if blocking == true
+        return GPS::Response.new(socket().gets())
+      else
+        while socket().ready?
+          v = socket().gets()
+          rv << GPS::Response.new(v)
+        end
+      end
+
+      return rv
+    end
+
+    def command(command, options={})
+      block = options.delete(:block)
+      send_command(command, options)
+
+    # wait for reply
+      socket().wait(@_options[:read_timeout])
+
+      return read_response(block)
+    end
+
+
+    def watch(options={})
+      options = ({
+        :enable => true,
+        :json   => true
+      }) if options.empty?
+
+      return command(:watch, options)
+    end
+
+    def poll()
+      return command(:poll).select{|i|
+        i.classname == :POLL
+      }.sort{|a,b|
+        a.time <=> b.time
+      }
+    end
+  end
+end

data/lib/gpsd/errors.rb

@@ -0,0 +1,5 @@
+module GPS
+  class Error < Exception; end
+  class ConnectionError < Error; end
+  class ProtocolError < Error; end
+end

data/lib/gpsd/response.rb

@@ -0,0 +1,63 @@
+require 'multi_json'
+require_relative 'errors'
+
+module GPS
+  class Response
+    attr_reader :payload
+
+    def initialize(response)
+      if response.is_a?(String)
+        @payload = MultiJson.load(response)
+      elsif response.is_a?(Hash)
+        @payload = response
+      else
+        raise GPS::ProtocolError.new("Invalid response data")
+      end
+
+      @payload['time'] = Time.parse(@payload['time']) if @payload.has_key?('time')
+
+      case @payload['class']
+      when 'POLL'
+        @payload['tpv'] = @payload['tpv'].collect{|i|
+          GPS::Response.new(i)
+        }
+
+        @payload['sky'] = @payload['sky'].collect{|i|
+          GPS::Response.new(i)
+        }
+      end
+    end
+
+    def method_missing(method, *args)
+      if @payload.has_key?(method.to_s)
+        return @payload[method.to_s]
+      else
+        super
+      end
+    end
+
+    def [](key)
+      return @payload[key.to_s]
+    rescue
+      return nil
+    end
+
+    def classname()
+      return @payload['class'].to_sym
+    rescue
+      return nil
+    end
+
+    def to_hash()
+      Hash[payload().collect{|k,v|
+        if v.is_a?(GPS::Response)
+          [k, v.to_hash()]
+        elsif v.is_a?(Array) and v.first.is_a?(GPS::Response)
+          [k, v.collect{|i| i.to_hash() }]
+        else
+          [k, v]
+        end
+      }]
+    end
+  end
+end

data/lib/gpsd/util.rb

@@ -0,0 +1,8 @@
+require 'socket'
+require 'multi_json'
+
+module GPS
+  module Util
+
+  end
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: gpsd
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Gary Hetzel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: &13112800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 1.7.9
+  type: :runtime
+  prerelease: false
+  version_requirements: *13112800
+description: This is a client interface to the GPSd service daemon.
+email: garyhetzel@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/gpsd.rb
+- lib/gpsd/errors.rb
+- lib/gpsd/response.rb
+- lib/gpsd/util.rb
+homepage: https://github.com/ghetzel/gpsd
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: A Ruby client interface for GPSd
+test_files: []