phidgets 0.0.2 → 0.0.3

data/History.txt

@@ -1,6 +1,12 @@
+== 0.0.3 2010-08-09
+  * Moved the Phidgets::Exception class before the initialization code so that the init code can throw an exception
+  * Fixed bugs in Common::openRemote and Common::openRemoteIP that prevented them from being called
+  * Add ability to turn on/off logging in the C library (for debugging)
+
 == 0.0.2 2010-05-12
   * Rewrote using DL/Importable
   * Added some documentation
+  * Added support for Servo class.
   
 == 0.0.1 2009-03-27
   * Initial release

data/Manifest.txt

@@ -2,12 +2,14 @@ GNU_GPL.txt
 History.txt
 Manifest.txt
 PostInstall.txt
+README.txt
 README.rdoc
 Rakefile
 lib/phidgets.rb
 lib/phidgets/common.rb
 lib/phidgets/interfacekit.rb
 lib/phidgets/rfid.rb
+lib/phidgets/servo.rb
 script/console
 script/destroy
 script/generate

data/README.rdoc

@@ -12,28 +12,52 @@ This gem provides a ruby interface to the phidgets library.
 * This gem uses DL to call the c functions in the Phidgets shared library, so the library must be installed and working.
 * The gem has been tested to work on both Linux and Windows.
 * Not all the devices have been implemented, and not all of the devices that have been implemented have been fully tested.
-* The callback functionality of the Phidgets library is not working very well. Making multiple calls to the phidgets library from
-  within a callback will cause an exception.
-* The gem will attempt to guess the name of the phidgets library based on the platform it is run on (Linux or Windows).
+* The callback functionality of the Phidgets library is working but should be used with caution. I have found that the callback
+  will cause a stack overflow exception if it is too big (not sure exactly what the limit is, but it isn't much).
+* The gem will attempt to guess the name of the phidgets library based on the platform it is run on (Linux, Windows or OS X).
+  If it guessesincorrectly please leave a message to let me know what your platform sets for Config::CONFIG['target_os'] and
+  what is the name of the phidgets library.
 
 == SYNOPSIS:
 
-require 'phidgets'
+  require 'phidgets'
 
-begin
-  ik = Phidgets::InterfaceKit.new(-1,2000)
+  begin
+    ik = Phidgets::InterfaceKit.new(-1,2000)
 
-  puts "Device Name     = #{ik.getDeviceName}"
-  puts "Serial Number   = #{ik.getSerialNumber}"
-  puts "Device Version  = #{ik.getDeviceVersion}"
+    puts "Device Name     = #{ik.getDeviceName}"
+    puts "Serial Number   = #{ik.getSerialNumber}"
+    puts "Device Version  = #{ik.getDeviceVersion}"
 
-  ik.close
+    ik.close
 
-rescue Phidgets::Exception => e
-  puts "Phidgets Error (#{e.code}). #{e}"
+  rescue Phidgets::Exception => e
+    puts "Phidgets Error (#{e.code}). #{e}"
+  end
 
-end
+=== <b>or to use a callback:</b>
 
+  require 'phidgets'
+
+  def onConnect(handle, data)
+    # the ruby object passed in to the callback is converted to an object id.
+    # Now convert it back to an object reference
+    ik = ObjectSpace._id2ref(data.to_i)
+    puts ik.getDeviceName
+    return 0
+  end
+
+  begin
+    ik = Phidgets::InterfaceKit.new
+    ik.setOnAttachHandler("onConnect", ik)
+    ik.open
+
+    # do something else
+    sleep 4
+
+  rescue Phidgets::Exception => e
+    puts "Phidgets Error (#{e.code}). #{e}"
+  end
 
 
 == REQUIREMENTS:
@@ -46,7 +70,7 @@ end
 
 == LICENSE:
 
-Copyright (C) 2009-2010  Craig DeHaan
+Copyright (C) 2009  Craig DeHaan
 
 This program is free software; you can redistribute it and/or
 modify it under the terms of the GNU General Public License

data/README.txt

@@ -0,0 +1,87 @@
+= phidgets
+
+* http://phidgets.rubyforge.org
+
+== DESCRIPTION:
+
+Phidgets are a set of "plug and play" building blocks for low cost USB sensing and control from your PC.
+This gem provides a ruby interface to the phidgets library.
+
+== FEATURES/PROBLEMS:
+
+* This gem uses DL to call the c functions in the Phidgets shared library, so the library must be installed and working.
+* The gem has been tested to work on both Linux and Windows.
+* Not all the devices have been implemented, and not all of the devices that have been implemented have been fully tested.
+* The callback functionality of the Phidgets library is working but should be used with caution. I have found that the callback
+  will cause a stack overflow exception if it is too big (not sure exactly what the limit is, but it isn't much).
+* The gem will attempt to guess the name of the phidgets library based on the platform it is run on (Linux, Windows or OS X).
+  If it guessesincorrectly please leave a message to let me know what your platform sets for Config::CONFIG['target_os'] and
+  what is the name of the phidgets library.
+
+== SYNOPSIS:
+
+  require 'phidgets'
+
+  begin
+    ik = Phidgets::InterfaceKit.new(-1,2000)
+
+    puts "Device Name     = #{ik.getDeviceName}"
+    puts "Serial Number   = #{ik.getSerialNumber}"
+    puts "Device Version  = #{ik.getDeviceVersion}"
+
+    ik.close
+
+  rescue Phidgets::Exception => e
+    puts "Phidgets Error (#{e.code}). #{e}"
+  end
+
+=== <b>or to use a callback:</b>
+
+  require 'phidgets'
+
+  def onConnect(handle, data)
+    # the ruby object passed in to the callback is converted to an object id.
+    # Now convert it back to an object reference
+    ik = ObjectSpace._id2ref(data.to_i)
+    puts ik.getDeviceName
+    return 0
+  end
+
+  begin
+    ik = Phidgets::InterfaceKit.new
+    ik.setOnAttachHandler("onConnect", ik)
+    ik.open
+
+    # do something else
+    sleep 4
+
+  rescue Phidgets::Exception => e
+    puts "Phidgets Error (#{e.code}). #{e}"
+  end
+
+
+== REQUIREMENTS:
+
+* The Phidgets library (http://www.phidgets.com/)
+
+== INSTALL:
+
+* sudo gem install phidgets
+
+== LICENSE:
+
+Copyright (C) 2009  Craig DeHaan
+
+This program is free software; you can redistribute it and/or
+modify it under the terms of the GNU General Public License
+as published by the Free Software Foundation; either version 2
+of the License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software
+Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.

data/lib/phidgets.rb

@@ -4,7 +4,8 @@ $:.unshift(File.dirname(__FILE__)) unless
 require File.dirname(__FILE__) + '/phidgets/common.rb'
 require File.dirname(__FILE__) + '/phidgets/interfacekit.rb'
 require File.dirname(__FILE__) + '/phidgets/rfid.rb'
+require File.dirname(__FILE__) + '/phidgets/servo.rb'
 
 module Phidgets
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/lib/phidgets/common.rb

@@ -7,6 +7,9 @@ require 'rbconfig'
 module Phidgets
   extend DL::Importable
 
+  PFALSE                           = 0
+  PTRUE                            = 1
+
   NOTATTACHED                      = 0
   ATTACHED                         = 1
 
@@ -62,63 +65,12 @@ module Phidgets
   ID_TEXTLED_4x8                   = 0x048
   ID_WEIGHTSENSOR                  = 0x072
 
-  begin
-    case Config::CONFIG['target_os']
-      when 'linux'
-        dlload 'libphidget21.so'
-      when 'mswin32'
-        dlload 'phidget21.dll'
-      else
-        raise Phidgets::Exception.new(Exception::EPHIDGET_LIBNAME)
-    end
-  rescue
-    raise Phidgets::Exception.new(Exception::EPHIDGET_LOAD_LIB_FAIL)
-  end
-
-  extern "int CPhidget_openRemote(void *, int, void *, void *)"
-  extern "int CPhidget_openRemoteIP(void *, int, void *, int, void *)"
-  extern "int CPhidget_open(void *, int)"
-  extern "int CPhidget_close(void *)"
-  extern "int CPhidget_delete(void *)"
-  extern "int CPhidget_set_OnDetach_Handler(void *, void *, void *)"
-  extern "int CPhidget_set_OnAttach_Handler(void *, void *, void *)"
-  extern "int CPhidget_set_OnServerConnect_Handler(void *, void *, void *)"
-  extern "int CPhidget_set_OnServerDisconnect_Handler(void *, void *, void *)"
-  extern "int CPhidget_set_OnError_Handler(void *, void *, void *)"
-  extern "int CPhidget_getDeviceName(void *, void *)"
-  extern "int CPhidget_getSerialNumber(void *, int *)"
-  extern "int CPhidget_getDeviceVersion(void *, int *)"
-  extern "int CPhidget_getDeviceStatus(void *, int *)"
-  extern "int CPhidget_getLibraryVersion(void *)"
-  extern "int CPhidget_getDeviceType(void *, void *)"
-  extern "int CPhidget_getDeviceLabel(void *, void *)"
-  extern "int CPhidget_setDeviceLabel(void *, void *)"
-  extern "int CPhidget_getErrorDescription(int, void *)"
-  extern "int CPhidget_waitForAttachment(void *, int)"
-  extern "int CPhidget_getServerID(void *, void *)"
-  extern "int CPhidget_getServerAddress(void *, void *, int *)"
-  extern "int CPhidget_getServerStatus(void *, int *)"
-  extern "int CPhidget_getDeviceID(void *, int *)"
-  extern "int CPhidget_getDeviceClass(void *, int *)"
-
-  # Gets the library version. This contains a version number and a build date.
-  def Phidgets.getLibraryVersion
-    ptr = DL.malloc(DL.sizeof('P'))
-    r = cPhidget_getLibraryVersion(ptr.ref)
-    raise Phidgets::Exception.new(r) if r != 0
-    ptr.free = nil
-    ptr.to_s
-  end
-
-  # Gets the description for an error code.
-  def Phidgets.getErrorDescription(error_code)
-    ptr = DL.malloc(DL.sizeof('P'))
-    r = cPhidget_getErrorDescription(error_code, ptr.ref)
-    raise Phidgets::Exception.new(r) if r != 0
-    ptr.free = nil
-    ptr.to_s
-  end
-
+  PHIDGET_LOG_CRITICAL             = 1
+  PHIDGET_LOG_ERROR                = 2
+  PHIDGET_LOG_WARNING              = 3
+  PHIDGET_LOG_DEBUG                = 4
+  PHIDGET_LOG_INFO                 = 5
+  PHIDGET_LOG_VERBOSE              = 6
 
   class Exception < RuntimeError
     attr_reader :code
@@ -195,27 +147,116 @@ module Phidgets
 
   end
 
+  begin
+    case Config::CONFIG['target_os']
+      when /linux/
+        dlload 'libphidget21.so'
+      when /mswin/
+        dlload 'phidget21.dll'
+      when /darwin/
+        dlload '/Library/Frameworks/Phidget21.framework/Versions/Current/Phidget21'
+      else
+        raise Phidgets::Exception.new(Exception::EPHIDGET_LIBNAME)
+    end
+  rescue
+    raise Phidgets::Exception.new(Exception::EPHIDGET_LOAD_LIB_FAIL)
+  end
+
+  extern "int CPhidget_openRemote(void *, int, void *, void *)"
+  extern "int CPhidget_openRemoteIP(void *, int, void *, int, void *)"
+  extern "int CPhidget_open(void *, int)"
+  extern "int CPhidget_close(void *)"
+  extern "int CPhidget_delete(void *)"
+  extern "int CPhidget_set_OnDetach_Handler(void *, void *, void *)"
+  extern "int CPhidget_set_OnAttach_Handler(void *, void *, void *)"
+  extern "int CPhidget_set_OnServerConnect_Handler(void *, void *, void *)"
+  extern "int CPhidget_set_OnServerDisconnect_Handler(void *, void *, void *)"
+  extern "int CPhidget_set_OnError_Handler(void *, void *, void *)"
+  extern "int CPhidget_getDeviceName(void *, void *)"
+  extern "int CPhidget_getSerialNumber(void *, int *)"
+  extern "int CPhidget_getDeviceVersion(void *, int *)"
+  extern "int CPhidget_getDeviceStatus(void *, int *)"
+  extern "int CPhidget_getLibraryVersion(void *)"
+  extern "int CPhidget_getDeviceType(void *, void *)"
+  extern "int CPhidget_getDeviceLabel(void *, void *)"
+  extern "int CPhidget_setDeviceLabel(void *, void *)"
+  extern "int CPhidget_getErrorDescription(int, void *)"
+  extern "int CPhidget_waitForAttachment(void *, int)"
+  extern "int CPhidget_getServerID(void *, void *)"
+  extern "int CPhidget_getServerAddress(void *, void *, int *)"
+  extern "int CPhidget_getServerStatus(void *, int *)"
+  extern "int CPhidget_getDeviceID(void *, int *)"
+  extern "int CPhidget_getDeviceClass(void *, int *)"
+  extern "int CPhidget_enableLogging(int, char *)"
+  extern "int CPhidget_disableLogging()"
+
+  # Gets the library version. This contains a version number and a build date.
+  def Phidgets.getLibraryVersion
+    ptr = DL.malloc(DL.sizeof('P'))
+    r = cPhidget_getLibraryVersion(ptr.ref)
+    raise Phidgets::Exception.new(r) if r != 0
+    ptr.free = nil
+    ptr.to_s
+  end
+
+  # Gets the description for an error code.
+  def Phidgets.getErrorDescription(error_code)
+    ptr = DL.malloc(DL.sizeof('P'))
+    r = cPhidget_getErrorDescription(error_code, ptr.ref)
+    raise Phidgets::Exception.new(r) if r != 0
+    ptr.free = nil
+    ptr.to_s
+  end
+
+  # Enables logging. Logging is provided mainly for debugging purposes. Enabling logging will output internal library
+  # information that can be used to find bugs with the help of Phidgetd Inc. Alternatively, the user can enable
+  # and write to the log for their own uses.
+  # === Parameters
+  # * _level_ = The highest level of logging to output. All lower levels will also be output.
+  # * _file_  = File to output log to. This should be a full pathname, not a relative pathname.
+  def Phidgets.enableLogging(level, file)
+    r = cPhidget_enableLogging(level, file)
+    raise Phidgets::Exception.new(r) if r != 0
+  end
+
+  # Disables logging.
+  def Phidgets.disableLogging
+    r = cPhidget_disableLogging
+    raise Phidgets::Exception.new(r) if r != 0
+  end
+
 
   class Common
-    def initialize
-      @handle = DL.malloc(DL.sizeof('P'))
-    end
 
     # Opens a Phidget remotely by ServerID. Note that this requires Bonjour (mDNS) to be running on both the host and the server.
+    # === Parameters
+    # * _serial_number_ = Serial number. Specify -1 to open any.
+    # * _server_        = Server ID. Specify nil to open any.
+    # * _password_      = Password. Can be nil if the server is running unsecured.
+    # * _timeout_       = Time to wait for attachment. Specify 0 to not wait.
     def openRemote(serial_number=-1, server=nil, password=nil, timeout=0)
-      r = cPhidget_openRemote(@handle, serial_number, server, password)
+      r = Phidgets.cPhidget_openRemote(@handle, serial_number, server, password)
       raise Phidgets::Exception.new(r) if r != 0
       waitForAttachment(timeout) if timeout > 0
     end
 
     # Opens a Phidget remotely by address and port.
+    # === Parameters
+    # * _serial_number_ = Serial number. Specify -1 to open any.
+    # * _address_       = Address. This can be a hostname or IP address.
+    # * _port_          = Port number. Default is 5001.
+    # * _password_      = Password. Can be nil if the server is running unsecured.
+    # * _timeout_       = Time to wait for attachment. Specify 0 to not wait.
     def openRemoteIP(serial_number, address, port=5001, password=nil, timeout=0)
-      r = cPhidget_openRemoteIP(@handle, serial_number, address, port, password)
+      r = Phidgets.cPhidget_openRemoteIP(@handle, serial_number, address, port, password)
       raise Phidgets::Exception.new(r) if r != 0
       waitForAttachment(timeout) if timeout > 0
     end
 
     # Opens a Phidget.
+    # === Parameters
+    # * _serial_number_ = Serial number. Specify -1 to open any.
+    # * _timeout_       = Time to wait for attachment. Specify 0 to not wait.
     def open(serial_number=-1, timeout=0)
       r = Phidgets.cPhidget_open(@handle, serial_number)
       raise Phidgets::Exception.new(r) if r != 0
@@ -236,32 +277,47 @@ module Phidgets
     end
 
     # Sets a detach handler callback function. This is called when this Phidget is unplugged from the system.
-    def setOnDetachHandler(callback, data)
-      r = Phidgets.cPhidget_set_OnDetach_Handler(@handle, createCallback(callback), DL::PtrData.new(data.object_id))
+    # === Parameters
+    # * _callback_func_ = Callback function.
+    # * _data_          = Data for use by the user - this object is passed back into the callback function.
+    def setOnDetachHandler(callback_func, data)
+      r = Phidgets.cPhidget_set_OnDetach_Handler(@handle, Phidgets.callback("int #{callback_func}(void *, void *)"), DL::PtrData.new(data.object_id))
       raise Phidgets::Exception.new(r) if r != 0
     end
 
     # Sets an attach handler callback function. This is called when this Phidget is plugged into the system, and is ready for use.
-    def setOnAttachHandler(callback, data)
-      r = Phidgets.cPhidget_set_OnAttach_Handler(@handle, createCallback(callback), DL::PtrData.new(data.object_id))
+    # === Parameters
+    # * _callback_func_ = Callback function.
+    # * _data_          = Data for use by the user - this object is passed back into the callback function.
+    def setOnAttachHandler(callback_func, data)
+      r = Phidgets.cPhidget_set_OnAttach_Handler(@handle, Phidgets.callback("int #{callback_func}(void *, void *)"), DL::PtrData.new(data.object_id))
       raise Phidgets::Exception.new(r) if r != 0
     end
 
     # Sets a server connect handler callback function. This is used for opening Phidgets remotely, and is called when a connection to the sever has been made.
-    def setOnConnectHandler(callback, data)
-      r = Phidgets.cPhidget_set_OnServerConnect_Handler(@handle, createCallback(callback), DL::PtrData.new(data.object_id))
+    # === Parameters
+    # * _callback_func_ = Callback function.
+    # * _data_          = Data for use by the user - this object is passed back into the callback function.
+    def setOnConnectHandler(callback_func, data)
+      r = Phidgets.cPhidget_set_OnServerConnect_Handler(@handle, Phidgets.callback("int #{callback_func}(void *, void *)"), DL::PtrData.new(data.object_id))
       raise Phidgets::Exception.new(r) if r != 0
     end
 
     # Sets a server disconnect handler callback function. This is used for opening Phidgets remotely, and is called when a connection to the server has been lost.
-    def setOnDisconnectHandler(callback, data)
-      r = Phidgets.cPhidget_set_OnServerDisconnect_Handler(@handle, createCallback(callback), DL::PtrData.new(data.object_id))
+    # === Parameters
+    # * _callback_func_ = Callback function.
+    # * _data_          = Data for use by the user - this object is passed back into the callback function.
+    def setOnDisconnectHandler(callback_func, data)
+      r = Phidgets.cPhidget_set_OnServerDisconnect_Handler(@handle, Phidgets.callback("int #{callback_func}(void *, void *)"), DL::PtrData.new(data.object_id))
       raise Phidgets::Exception.new(r) if r != 0
     end
 
     # Sets the error handler callback function. This is called when an asynchronous error occurs.
-    def setOnErrorHandler(callback, data)
-      r = Phidgets.cPhidget_set_OnError_Handler(@handle, createErrorCallback(callback), DL::PtrData.new(data.object_id))
+    # === Parameters
+    # * _callback_func_ = Callback function.
+    # * _data_          = Data for use by the user - this object is passed back into the callback function.
+    def setOnErrorHandler(callback_func, data)
+      r = Phidgets.cPhidget_set_OnError_Handler(@handle, Phidgets.callback("int #{callback_func}(void *, void *, int, const char *)"), DL::PtrData.new(data.object_id))
       raise Phidgets::Exception.new(r) if r != 0
     end
 
@@ -319,13 +375,17 @@ module Phidgets
       ptr.to_s
     end
 
-    # Sets the label of a Phidget. Note that this is nut supported on very old Phidgets, and not yet supported in Windows.
+    # Sets the label of a Phidget. Note that this is not supported on very old Phidgets, and not yet supported in Windows.
+    # === Parameters
+    # * _label_ = A string containing the label to be set.
     def setDeviceLabel(label)
       r = Phidgets.cPhidget_setDeviceLabel(@handle, label)
       raise Phidgets::Exception.new(r) if r != 0
     end
 
-    # Waits for attachment to happen. This can be called wirght after calling CPhidget_open, as an alternative to using the attach handler.
+    # Waits for attachment to happen. This can be called right after calling open, as an alternative to using the attach handler.
+    # === Parameters
+    # * _timeout_ = Time to wait for the attachment. Specify 0 to wait forever.
     def waitForAttachment(timeout)
       r = Phidgets.cPhidget_waitForAttachment(@handle, timeout)
       raise Phidgets::Exception.new(r) if r != 0
@@ -381,18 +441,8 @@ module Phidgets
 
     private
 
-    def createCallback(callback)
-      DL.callback('IPP') {|handle,data|
-        data = ObjectSpace._id2ref(data.to_i)
-        eval("#{callback}(data)")
-      }
-    end
-
-    def createErrorCallback(callback)
-      DL.callback('IPPIS') {|handle,data,error_code,error_string|
-        data = ObjectSpace._id2ref(data.to_i)
-        eval("#{callback}(data,error_code,error_string)")
-      }
+    def initialize
+      @handle = DL.malloc(DL.sizeof('P'))
     end
 
   end

data/lib/phidgets/interfacekit.rb

@@ -17,6 +17,10 @@ module Phidgets
   
   class InterfaceKit < Common
 
+    # Create a new interface kit 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
@@ -33,6 +37,8 @@ module Phidgets
     end
 
     # Gets the state of a digital input.
+    # === Parameters
+    # * _index_ = The input index.
     def getInputState(index)
       state = DL.malloc(DL.sizeof('I'))
       r = Phidgets.cPhidgetInterfaceKit_getInputState(@handle, index, state.ref)
@@ -51,6 +57,8 @@ module Phidgets
     end
 
     # Gets the state of a digital output.
+    # === Parameters
+    # * _index_ = The output index.
     def getOutputState(index)
       state = DL.malloc(DL.sizeof('I'))
       r = Phidgets.cPhidgetInterfaceKit_getOutputState(@handle, index, state.ref)
@@ -60,6 +68,9 @@ module Phidgets
     end
 
     # Sets the state of a digital output.
+    # === Parameters
+    # * _index_ = The output index.
+    # * _state_ = The output state. Possible values are PTRUE  and PFALSE.
     def setOutputState(index, state)
       r = Phidgets.cPhidgetInterfaceKit_setOutputState(@handle, index, state)
       raise Phidgets::Exception.new(r) if r != 0
@@ -75,6 +86,8 @@ module Phidgets
     end
 
     # Gets a sensor value (0-1000).
+    # === Parameters
+    # * _index_ = The sensor index.
     def getSensorValue(index)
       state = DL.malloc(DL.sizeof('I'))
       r = Phidgets.cPhidgetInterfaceKit_getSensorValue(@handle, index, state.ref)
@@ -84,6 +97,8 @@ module Phidgets
     end
 
     # Gets a sensor raw value (12-bit).
+    # === Parameters
+    # * _index_ = The sensor index.
     def getSensorRawValue(index)
       state = DL.malloc(DL.sizeof('I'))
       r = Phidgets.cPhidgetInterfaceKit_getSensorRawValue(@handle, index, state.ref)
@@ -102,6 +117,8 @@ module Phidgets
     end
 
     # Sets the ratiometric state for this board.
+    # === Parameters
+    # * _ratiometric_ = The ratiometric state. Possible values are PTRUE  and PFALSE.
     def setRatiometric(ratiometric)
       r = Phidgets.cPhidgetInterfaceKit_setRatiometric(@handle, ratiometric)
       raise Phidgets::Exception.new(r) if r != 0

data/lib/phidgets/rfid.rb

@@ -18,6 +18,10 @@ module Phidgets
   
   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
@@ -34,6 +38,8 @@ module Phidgets
     end
 
     # Gets the state of an output.
+    # === Parameters
+    # * _index_ = The output index.
     def getOutputState(index)
       state = DL.malloc(DL.sizeof('I'))
       r = Phidgets.cPhidgetRFID_getOutputState(@handle, index, state.ref)
@@ -43,6 +49,9 @@ module Phidgets
     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.cPhidgetRFID_setOutputState(@handle, index, state)
       raise Phidgets::Exception.new(r) if r != 0
@@ -58,6 +67,8 @@ module Phidgets
     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.cPhidgetRFID_setAntennaOn(@handle, state)
       raise Phidgets::Exception.new(r) if r != 0
@@ -73,6 +84,8 @@ module Phidgets
     end
 
     # Sets the state of the onboard LED.
+    # === Parameters
+    # * _state_ = The LED state. Possible values are PTRUE  and PFALSE.
     def setLedOn(state)
       r = Phidgets.cPhidgetRFID_setLEDOn(@handle, state)
       raise Phidgets::Exception.new(r) if r != 0

data/lib/phidgets/servo.rb

@@ -0,0 +1,106 @@
+
+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
+
+    # Gets the number of motors supported by this controller.
+    def getMotorCount
+      cnt = DL.malloc(DL.sizeof('I'))
+      r = Phidgets.cPhidgetServo_getMotorCount(@handle, cnt.ref)
+      raise Phidgets::Exception.new(r) if r != 0
+      cnt.free = nil
+      cnt.to_i
+    end
+
+    # Gets the current position of a motor.
+    # === Parameters
+    # * _index_ = The motor index.
+    def getPosition(index)
+      pos = DL.malloc(DL.sizeof('D'))
+      r = Phidgets.cPhidgetServo_getPosition(@handle, index, 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.cPhidgetServo_setPosition(@handle, index, position)
+      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 = DL.malloc(DL.sizeof('D'))
+      r = Phidgets.cPhidgetServo_getPositionMax(@handle, index, 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 = DL.malloc(DL.sizeof('D'))
+      r = Phidgets.cPhidgetServo_getPositionMin(@handle, index, 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 = DL.malloc(DL.sizeof('I'))
+      r = Phidgets.cPhidgetServo_getEngaged(@handle, index, 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.cPhidgetServo_setEngaged(@handle, index, state)
+      raise Phidgets::Exception.new(r) if r != 0
+    end
+
+    private
+
+    # Creates a Phidget Servo handle.
+    def create
+      r = Phidgets.cPhidgetServo_create(@handle.ref)
+      raise Phidgets::Exception.new(r) if r != 0
+    end
+
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: phidgets
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
 - Craig DeHaan
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-02 00:00:00 -04:00
+date: 2010-08-09 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -46,17 +46,20 @@ extra_rdoc_files:
 - History.txt
 - Manifest.txt
 - PostInstall.txt
+- README.txt
 files: 
 - GNU_GPL.txt
 - History.txt
 - Manifest.txt
 - PostInstall.txt
+- README.txt
 - README.rdoc
 - Rakefile
 - lib/phidgets.rb
 - lib/phidgets/common.rb
 - lib/phidgets/interfacekit.rb
 - lib/phidgets/rfid.rb
+- lib/phidgets/servo.rb
 - script/console
 - script/destroy
 - script/generate