phidgets 0.0.5 → 0.1.0

data/lib/phidgets/ph_sensor.rb

@@ -0,0 +1,25 @@
+
+
+module Phidgets
+  class PHSensor < Common
+
+    unless RUBY_VERSION < '1.9.0'
+
+      # call-seq:
+      #   setOnPHChangeHandler(proc=nil, &block)
+      #
+      # Set a PH change handler. This is called when the PH changes by more then the change trigger.
+      #
+      def setOnPHChangeHandler(cb_proc = nil, &cb_block)
+        @on_ph_change_thread.kill if defined? @on_ph_change_thread
+        callback = cb_proc || cb_block
+        @on_ph_change_thread = Thread.new {ext_setOnPHChangeHandler(callback)}
+      end
+
+      alias :on_ph_change :setOnPHChangeHandler
+
+    end
+
+  end
+end
+

data/lib/phidgets/rfid.rb

@@ -1,122 +1,49 @@
 
 
 module Phidgets
-
-  extern "int CPhidgetRFID_create(void *)"
-  extern "int CPhidgetRFID_getOutputCount(void *, int *)"
-  extern "int CPhidgetRFID_getOutputState(void *, int, int *)"
-  extern "int CPhidgetRFID_setOutputState(void *, int, int)"
-  extern "int CPhidgetRFID_getAntennaOn(void *, int *)"
-  extern "int CPhidgetRFID_setAntennaOn(void *, int)"
-  extern "int CPhidgetRFID_getLEDOn(void *, int *)"
-  extern "int CPhidgetRFID_setLEDOn(void *, int)"
-  extern "int CPhidgetRFID_getLastTag(void *, void *)"
-  extern "int CPhidgetRFID_getTagStatus(void *, int *)"
-  
-  
   class RFID < Common
 
-    # Create a new RFID object.
-    # === Parameters
-    # * _serial_number_ = Serial number of the phidget board to open. Specify -1 to open any.
-    # * _timeout_       = Time to wait for attachment. Specify 0 to not call open.
-    def initialize(serial_number=-1, timeout=0)
-      super()
-      create
-      open(serial_number, timeout) if timeout > 0
-    end
-
-    # Gets the number of outputs supported by this board.
-    def getOutputCount
-      cnt = Phidgets.malloc(SIZEOF_INT)
-      r = Phidgets.send(FUNCTION_PREFIX + 'PhidgetRFID_getOutputCount', @handle, cnt.ref)
-      raise Phidgets::Exception.new(r) if r != 0
-      cnt.free = nil
-      cnt.to_i
-    end
-
-    # Gets the state of an output.
-    # === Parameters
-    # * _index_ = The output index.
-    def getOutputState(index)
-      state = Phidgets.malloc(SIZEOF_INT)
-      r = Phidgets.send(FUNCTION_PREFIX + 'PhidgetRFID_getOutputState', @handle, index.to_i, state.ref)
-      raise Phidgets::Exception.new(r) if r != 0
-      state.free = nil
-      state.to_i
-    end
-
-    # Sets the state of an output.
-    # === Parameters
-    # * _index_ = The output index.
-    # * _state_ = The output state. Possible values are PTRUE  and PFALSE.
-    def setOutputState(index, state)
-      r = Phidgets.send(FUNCTION_PREFIX + 'PhidgetRFID_setOutputState', @handle, index.to_i, state.to_i)
-      raise Phidgets::Exception.new(r) if r != 0
-    end
-
-    # Gets the state of the antenna.
-    def getAntennaOn
-      state = Phidgets.malloc(SIZEOF_INT)
-      r = Phidgets.send(FUNCTION_PREFIX + 'PhidgetRFID_getAntennaOn', @handle, state.ref)
-      raise Phidgets::Exception.new(r) if r != 0
-      state.free = nil
-      state.to_i
-    end
-
-    # Sets the state of the antenna. Note that the antenna must be enabled before tags will be read.
-    # === Parameters
-    # * _state_ = The antenna state. Possible values are PTRUE  and PFALSE.
-    def setAntennaOn(state)
-      r = Phidgets.send(FUNCTION_PREFIX + 'PhidgetRFID_setAntennaOn', @handle, state.to_i)
-      raise Phidgets::Exception.new(r) if r != 0
-    end
+    unless RUBY_VERSION < '1.9.0'
+
+      # call-seq:
+      #   setOnTagHandler(proc=nil, &block)
+      #
+      # Set a tag handler. This is called when a tag is first detected by the reader.
+      #
+      def setOnTagHandler(cb_proc = nil, &cb_block)
+        @on_tag_thread.kill if defined? @on_tag_thread
+        callback = cb_proc || cb_block
+        @on_tag_thread = Thread.new {ext_setOnTagHandler(callback)}
+      end
+
+      # call-seq:
+      #   setOnTagLostHandler(proc=nil, &block)
+      #
+      # Set a tag lost handler. This is called when a tag is no longer detected by the reader.
+      #
+      def setOnTagLostHandler(cb_proc = nil, &cb_block)
+        @on_tag_lost_thread.kill if defined? @on_tag_lost_thread
+        callback = cb_proc || cb_block
+        @on_tag_lost_thread = Thread.new {ext_setOnTagLostHandler(callback)}
+      end
+
+      # call-seq:
+      #   setOnOutputChangeHandler(proc=nil, &block)
+      #
+      # Set an output change handler. This is called when an output changes.
+      #
+      def setOnOutputChangeHandler(cb_proc = nil, &cb_block)
+        @on_output_change_thread.kill if defined? @on_output_change_thread
+        callback = cb_proc || cb_block
+        @on_output_change_thread = Thread.new {ext_setOnOutputChangeHandler(callback)}
+      end
+
+      alias :on_tag :setOnTagHandler
+      alias :on_tag_lost :setOnTagLostHandler
+      alias :on_output_change :setOnOutputChangeHandler
 
-    # Gets the state of the onboard LED.
-    def getLedOn
-      state = Phidgets.malloc(SIZEOF_INT)
-      r = Phidgets.send(FUNCTION_PREFIX + 'PhidgetRFID_getLEDOn', @handle, state.ref)
-      raise Phidgets::Exception.new(r) if r != 0
-      state.free = nil
-      state.to_i
-    end
-
-    # Sets the state of the onboard LED.
-    # === Parameters
-    # * _state_ = The LED state. Possible values are PTRUE  and PFALSE.
-    def setLedOn(state)
-      r = Phidgets.send(FUNCTION_PREFIX + 'PhidgetRFID_setLEDOn', @handle, state.to_i)
-      raise Phidgets::Exception.new(r) if r != 0
-    end
-
-    # Gets the last tag read by the reader. This tag may or may not still be on the reader.
-    def getLastTag
-      tag = Phidgets.malloc(SIZEOF_VOIDP)
-      r = Phidgets.send(FUNCTION_PREFIX + 'PhidgetRFID_getLastTag', @handle, tag.ref)
-      raise Phidgets::Exception.new(r) if r != 0
-      tag.free = nil
-      tag.to_s
-    end
-
-    # Gets the tag present status. This is whether or not a tag is being read by the reader.
-    def getTagStatus
-      stat = Phidgets.malloc(SIZEOF_INT)
-      r = Phidgets.send(FUNCTION_PREFIX + 'PhidgetRFID_getTagStatus', @handle, stat.ref)
-      raise Phidgets::Exception.new(r) if r != 0
-      stat.free = nil
-      stat.to_i
-    end
-
-
-    private
-
-    # Creates a Phidget RFID handle.
-    def create
-      r = Phidgets.send(FUNCTION_PREFIX + 'PhidgetRFID_create', @handle.ref)
-      raise Phidgets::Exception.new(r) if r != 0
     end
 
   end
-
 end
 

data/lib/phidgets/servo.rb

@@ -1,106 +1,23 @@
 
 module Phidgets
-
-  extern "int CPhidgetServo_create(void *)"
-  extern "int CPhidgetServo_getMotorCount(void *, int *)"
-  extern "int CPhidgetServo_getPosition(void *, int, double *)"
-  extern "int CPhidgetServo_setPosition(void *, int, double)"
-  extern "int CPhidgetServo_getPositionMax(void *, int, double *)"
-  extern "int CPhidgetServo_getPositionMin(void *, int, double *)"
-  extern "int CPhidgetServo_getEngaged(void *, int, int *)"
-  extern "int CPhidgetServo_setEngaged(void *, int, int)"
-
   class Servo < Common
 
-    # Create a new Servo object.
-    # === Parameters
-    # * _serial_number_ = Serial number of the phidget board to open. Specify -1 to open any.
-    # * _timeout_       = Time to wait for attachment. Specify 0 to not call open.
-    def initialize(serial_number=-1, timeout=0)
-      super()
-      create
-      open(serial_number, timeout) if timeout > 0
-    end
+    unless RUBY_VERSION < '1.9.0'
 
-    # Gets the number of motors supported by this controller.
-    def getMotorCount
-      cnt = Phidgets.malloc(SIZEOF_INT)
-      r = Phidgets.send(FUNCTION_PREFIX + 'PhidgetServo_getMotorCount', @handle, cnt.ref)
-      raise Phidgets::Exception.new(r) if r != 0
-      cnt.free = nil
-      cnt.to_i
-    end
+      # call-seq:
+      #   setOnPositionChangeHandler(proc=nil, &block)
+      #
+      # Sets a position change event handler. This is called when the position changes.
+      #
+      def setOnPositionChangeHandler(cb_proc = nil, &cb_block)
+        @on_position_change_thread.kill if defined? @on_position_change_thread
+        callback = cb_proc || cb_block
+        @on_position_change_thread = Thread.new {ext_setOnPositionChangeHandler(callback)}
+      end
 
-    # Gets the current position of a motor.
-    # === Parameters
-    # * _index_ = The motor index.
-    def getPosition(index)
-      pos = Phidgets.malloc(SIZEOF_DOUBLE)
-      r = Phidgets.send(FUNCTION_PREFIX + 'PhidgetServo_getPosition', @handle, index.to_i, pos.ref)
-      raise Phidgets::Exception.new(r) if r != 0
-      pos.free = nil
-      pos.to_f
-    end
-    
-    # Sets the current position of a motor.
-    # === Parameters
-    # * _index_   = The motor index.
-    # * _position = The motor position.
-    def setPosition(index, position)
-      r = Phidgets.send(FUNCTION_PREFIX + 'PhidgetServo_setPosition', @handle, index.to_i, position.to_f)
-      raise Phidgets::Exception.new(r) if r != 0
-    end
-    
-    # Gets the maximum position that a motor can be set to.
-    # === Parameters
-    # * _index_ = The motor index.
-    def getPositionMax(index)
-      pos = Phidgets.malloc(SIZEOF_DOUBLE)
-      r = Phidgets.send(FUNCTION_PREFIX + 'PhidgetServo_getPositionMax', @handle, index.to_i, pos.ref)
-      raise Phidgets::Exception.new(r) if r != 0
-      pos.free = nil
-      pos.to_f
-    end
-    
-    # Gets the minimum position that a motor can be set to.
-    # === Parameters
-    # * _index_ = The motor index.
-    def getPositionMin(index)
-      pos = Phidgets.malloc(SIZEOF_DOUBLE)
-      r = Phidgets.send(FUNCTION_PREFIX + 'PhidgetServo_getPositionMin', @handle, index.to_i, pos.ref)
-      raise Phidgets::Exception.new(r) if r != 0
-      pos.free = nil
-      pos.to_f
-    end
-    
-    # Gets the engaged state of a motor. This is whether the motor is powered or not.
-    # === Parameters
-    # * _index_ = The motor index.
-    def getEngaged(index)
-      eng = Phidgets.malloc(SIZEOF_INT)
-      r = Phidgets.send(FUNCTION_PREFIX + 'PhidgetServo_getEngaged', @handle, index.to_i, eng.ref)
-      raise Phidgets::Exception.new(r) if r != 0
-      eng.free = nil
-      eng.to_i
-    end
-
-    # Sets the engaged state of a motor. This is whether the motor is powered or not.
-    # === Parameters
-    # * _index_ = The motor index.
-    # * _state_ = The engaged state. Possible values are PTRUE  and PFALSE.
-    def setEngaged(index, state)
-      r = Phidgets.send(FUNCTION_PREFIX + 'PhidgetServo_setEngaged', @handle, index.to_i, state.to_i)
-      raise Phidgets::Exception.new(r) if r != 0
-    end
-
-    private
+      alias :on_position_change :setOnPositionChangeHandler
 
-    # Creates a Phidget Servo handle.
-    def create
-      r = Phidgets.send(FUNCTION_PREFIX + 'PhidgetServo_create', @handle.ref)
-      raise Phidgets::Exception.new(r) if r != 0
     end
 
   end
-
 end

data/lib/phidgets/spatial.rb

@@ -0,0 +1,25 @@
+
+
+module Phidgets
+  class Spatial < Common
+
+    unless RUBY_VERSION < '1.9.0'
+
+      # call-seq:
+      #   setOnSpatialDataHandler(proc=nil, &block)
+      #
+      # Set a Data event handler. This is called at getDataRate, up to 8ms.
+      #
+      def setOnSpatialDataHandler(cb_proc = nil, &cb_block)
+        @on_spatial_data_thread.kill if defined? @on_spatial_data_thread
+        callback = cb_proc || cb_block
+        @on_spatial_data_thread = Thread.new {ext_setOnSpatialDataHandler(callback)}
+      end
+
+      alias :on_spatial_data :setOnSpatialDataHandler
+
+    end
+
+  end
+end
+

data/lib/phidgets/stepper.rb

@@ -0,0 +1,61 @@
+
+
+module Phidgets
+  class Stepper < Common
+
+    unless RUBY_VERSION < '1.9.0'
+
+      # call-seq:
+      #   setOnInputChangeHandler(proc=nil, &block)
+      #
+      # Set a digital input change handler. This is called when a digital input changes.
+      #
+      def setOnInputChangeHandler(cb_proc = nil, &cb_block)
+        @on_input_change_thread.kill if defined? @on_input_change_thread
+        callback = cb_proc || cb_block
+        @on_input_change_thread = Thread.new {ext_setOnInputChangeHandler(callback)}
+      end
+
+      # call-seq:
+      #   setOnVelocityChangeHandler(proc=nil, &block)
+      #
+      # Sets a velocity change event handler. This is called when the velocity changes.
+      #
+      def setOnVelocityChangeHandler(cb_proc = nil, &cb_block)
+        @on_velocity_change_thread.kill if defined? @on_velocity_change_thread
+        callback = cb_proc || cb_block
+        @on_velocity_change_thread = Thread.new {ext_setOnVelocityChangeHandler(callback)}
+      end
+
+      # call-seq:
+      #   setOnPositionChangeHandler(proc=nil, &block)
+      #
+      # Sets a position change event handler. This is called when the position changes.
+      #
+      def setOnPositionChangeHandler(cb_proc = nil, &cb_block)
+        @on_position_change_thread.kill if defined? @on_position_change_thread
+        callback = cb_proc || cb_block
+        @on_position_change_thread = Thread.new {ext_setOnPositionChangeHandler(callback)}
+      end
+
+      # call-seq:
+      #   setOnCurrentChangeHandler(proc=nil, &block)
+      #
+      # Sets a current change event handler. This is called when the current draw changes.
+      #
+      def setOnCurrentChangeHandler(cb_proc = nil, &cb_block)
+        @on_current_change_thread.kill if defined? @on_current_change_thread
+        callback = cb_proc || cb_block
+        @on_current_change_thread = Thread.new {ext_setOnCurrentChangeHandler(callback)}
+      end
+
+      alias :on_input_change :setOnInputChangeHandler
+      alias :on_velocity_change :setOnVelocityChangeHandler
+      alias :on_position_change :setOnPositionChangeHandler
+      alias :on_current_change :setOnCurrentChangeHandler
+
+    end
+
+  end
+end
+

data/lib/phidgets/temperature_sensor.rb

@@ -0,0 +1,25 @@
+
+
+module Phidgets
+  class TemperatureSensor < Common
+
+    unless RUBY_VERSION < '1.9.0'
+
+      # call-seq:
+      #   setOnTemperatureChangeHandler(proc=nil, &block)
+      #
+      # Set a temperature change handler. This is called when the temperature changes by more then the change trigger.
+      #
+      def setOnTemperatureChangeHandler(cb_proc = nil, &cb_block)
+        @on_temperature_change_thread.kill if defined? @on_temperature_change_thread
+        callback = cb_proc || cb_block
+        @on_temperature_change_thread = Thread.new {ext_setOnTemperatureChangeHandler(callback)}
+      end
+
+      alias :on_temperature_change :setOnTemperatureChangeHandler
+
+    end
+
+  end
+end
+

data/lib/phidgets/text_lcd.rb

@@ -0,0 +1,8 @@
+
+
+module Phidgets
+  class TextLCD < Common
+
+  end
+end
+

data/lib/phidgets/text_led.rb

@@ -0,0 +1,8 @@
+
+
+module Phidgets
+  class TextLED < Common
+
+  end
+end
+

data/lib/phidgets/weight_sensor.rb

@@ -0,0 +1,25 @@
+
+
+module Phidgets
+  class WeightSensor < Common
+
+    unless RUBY_VERSION < '1.9.0'
+
+      # call-seq:
+      #   setOnWeightChangeHandler(proc=nil, &block)
+      #
+      # Set a weight change handler. This is called when the weight changes by more then the change trigger.
+      #
+      def setOnWeightChangeHandler(cb_proc = nil, &cb_block)
+        @on_weight_change_thread.kill if defined? @on_weight_change_thread
+        callback = cb_proc || cb_block
+        @on_weight_change_thread = Thread.new {ext_setOnWeightChangeHandler(callback)}
+      end
+
+      alias :on_weight_change :setOnWeightChangeHandler
+
+    end
+
+  end
+end
+

data/lib/phidgets.rb

@@ -1,13 +1,32 @@
 $:.unshift(File.dirname(__FILE__)) unless
   $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
 
-require File.dirname(__FILE__) + '/phidgets/phidgets.rb'
+require File.dirname(__FILE__) + '/phidgets.so' if FileTest.exists? "#{File.dirname(__FILE__)}/phidgets.so"
+
+require File.dirname(__FILE__) + '/phidgets/dictionary.rb'
+require File.dirname(__FILE__) + '/phidgets/manager.rb'
 require File.dirname(__FILE__) + '/phidgets/common.rb'
+require File.dirname(__FILE__) + '/phidgets/accelerometer.rb'
+require File.dirname(__FILE__) + '/phidgets/advanced_servo.rb'
+require File.dirname(__FILE__) + '/phidgets/analog.rb'
+require File.dirname(__FILE__) + '/phidgets/bridge.rb'
+require File.dirname(__FILE__) + '/phidgets/encoder.rb'
+require File.dirname(__FILE__) + '/phidgets/frequency_counter.rb'
+require File.dirname(__FILE__) + '/phidgets/gps.rb'
 require File.dirname(__FILE__) + '/phidgets/interfacekit.rb'
+require File.dirname(__FILE__) + '/phidgets/ir.rb'
+require File.dirname(__FILE__) + '/phidgets/led.rb'
+require File.dirname(__FILE__) + '/phidgets/motor_control.rb'
+require File.dirname(__FILE__) + '/phidgets/ph_sensor.rb'
 require File.dirname(__FILE__) + '/phidgets/rfid.rb'
 require File.dirname(__FILE__) + '/phidgets/servo.rb'
-require File.dirname(__FILE__) + '/phidgets/manager.rb'
+require File.dirname(__FILE__) + '/phidgets/spatial.rb'
+require File.dirname(__FILE__) + '/phidgets/stepper.rb'
+require File.dirname(__FILE__) + '/phidgets/temperature_sensor.rb'
+require File.dirname(__FILE__) + '/phidgets/text_lcd.rb'
+require File.dirname(__FILE__) + '/phidgets/text_led.rb'
+require File.dirname(__FILE__) + '/phidgets/weight_sensor.rb'
 
 module Phidgets
-  VERSION = '0.0.5'
+  VERSION = '0.1.0'
 end

data/phidgets.gemspec

@@ -0,0 +1,42 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "phidgets"
+  s.version = "0.1.0"
+  s.authors = ["Craig DeHaan"]
+  s.email = ["cdehaan2@cfl.rr.com"]
+  s.homepage = "https://github.com/csdehaan/phidgets"
+  s.summary = "Phidgets are a set of \"plug and play\" building blocks for low cost USB sensing and control from your PC.\nThis gem provides a ruby interface to the phidgets library."
+  s.description = s.summary
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.executables = ["phidget"]
+  s.extensions = ["ext/phidgets/extconf.rb"]
+  s.extra_rdoc_files = ["GNU_GPL.txt", "History.txt", "README.rdoc"]
+  s.files = Dir.glob("bin/*") +
+            Dir.glob("ext/**/*.{c,h}") +
+            Dir.glob("lib/**/*.rb")+
+            Dir.glob("test/*.rb")+
+            %w(Rakefile GNU_GPL.txt History.txt README.rdoc phidgets.gemspec)
+  s.test_files = Dir.glob("test/*.rb")
+  s.post_install_message = "For more information on phidgets, see http://www.phidgets.com/"
+  s.rdoc_options = ["--main", "README.rdoc"]
+  s.require_paths = ["lib", "ext/phidgets"]
+  s.rubygems_version = "1.8.25"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rdoc>, ["~> 3.10"])
+      s.add_development_dependency("rake-compiler")
+    else
+      s.add_dependency(%q<rdoc>, ["~> 3.10"])
+      s.add_dependency("rake-compiler")
+    end
+  else
+    s.add_dependency(%q<rdoc>, ["~> 3.10"])
+    s.add_dependency("rake-compiler")
+  end
+
+end

data/test/test_accelerometer.rb

@@ -0,0 +1,47 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestPhidgetsAccelerometer < Test::Unit::TestCase
+
+  def test_create
+    assert_nothing_raised {Phidgets::Accelerometer.new}
+  end
+
+  def test_get_axis_count
+    accel = Phidgets::Accelerometer.new
+    assert_raise(Phidgets::Error::NotAttached) {accel.axis_count}
+  end
+
+  def test_get_acceleration
+    accel = Phidgets::Accelerometer.new
+    assert_raise(Phidgets::Error::NotAttached) {accel.acceleration 1}
+  end
+
+  def test_get_acceleration_min
+    accel = Phidgets::Accelerometer.new
+    assert_raise(Phidgets::Error::NotAttached) {accel.acceleration_min 1}
+  end
+
+  def test_get_acceleration_max
+    accel = Phidgets::Accelerometer.new
+    assert_raise(Phidgets::Error::NotAttached) {accel.acceleration_max 1}
+  end
+
+  def test_get_acceleration_change_trigger
+    accel = Phidgets::Accelerometer.new
+    assert_raise(Phidgets::Error::NotAttached) {accel.acceleration_change_trigger 1}
+  end
+
+  unless RUBY_VERSION < '1.9.0'
+    def test_set_acceleration_change_trigger
+      accel = Phidgets::Accelerometer.new
+      assert_raise(Phidgets::Error::NotAttached) {accel.set_acceleration_change_trigger 1, 2.5}
+    end
+
+    def test_set_on_acceleration_change
+      accel = Phidgets::Accelerometer.new
+      assert_nothing_raised {accel.on_acceleration_change {puts 'hello'}}
+    end
+  end
+
+end
+