phidgets-ffi 0.1.1 → 0.1.2

data/README.rdoc

@@ -13,12 +13,12 @@ Idiomatic examples are in examples/ and the Raw FFI examples are in examples/raw
 First, we need to set up the proper environment and get the necessary files off the Phidgets website. Visit the drivers section at www.phidgets.com and get the latest Phidget driver for your system. You will also need to install the phidgets-ffi gem from RubyGems. More information will be provided in the "Installing the phidgets-ffi gem" section of this document.
 
 We also recommend that you download the following reference materials:
-* {Programming Manual}[http://www.phidgets.com/programming_resources.php]:
-* The {Product Manual}[http://www.phidgets.com] for your device
+* {General Phidget Programming}[http://www.phidgets.com/docs/General_Phidget_Programming]
+* The {User Guide}[http://www.phidgets.com/docs/Category:UserGuide] for your device
 * {RubyDoc API Documentation}[http://rubydoc.info/gems/phidgets-ffi/frames]
 * {Ruby code samples}[https://github.com/kreynolds/phidgets-ffi/tree/master/examples]
 
-The RubyDoc API manual contains calls and events for every type of Phidget and can be used as a reference. You can find a high level discussion about programming with Phidgets in general in the Programming Manual. The Product manual for your device also contains an API section that describes limitations, defaults, and implementation details specific to your Phidget. You may want to have these manuals open while working through these instructions.
+The RubyDoc API manual contains calls and events for every type of Phidget and can be used as a reference. You can find a high level discussion about programming with Phidgets in general on the General Phidget Programming page. The user guide for your device also contains an API section that describes limitations, defaults, and implementation details specific to your Phidget. You may want to have these pages open while working through these instructions.
 
 ==Installing the phidgets-ffi gem
 To install:

data/examples/HelloWorld.rb

@@ -0,0 +1,36 @@
+=begin 
+  Phidget Hello World Program for all devices
+  (c) Phidgets 2012
+=end
+ 
+require 'rubygems'
+require 'phidgets-ffi'
+
+manager = Phidgets::Manager.new
+
+#Determine if there are devices already attached to the computer
+manager.devices.size.times do |i|
+	puts "Hello Device #{Phidgets::Common.name(manager.devices[i])}, Serial Number: #{Phidgets::Common.serial_number(manager.devices[i])}"
+end
+
+# ========== Event Handling Functions ==========
+#The attach event will detect any devices attached AFTER the program is run.
+manager.on_attach do |device_ptr, obj|
+	puts "Hello Device #{Phidgets::Common.name(device_ptr)}, Serial Number: #{Phidgets::Common.serial_number(device_ptr)}"
+end
+
+manager.on_detach do |device_ptr, obj|
+	puts "Goodbye Device #{Phidgets::Common.name(device_ptr)}, Serial Number: #{Phidgets::Common.serial_number(device_ptr)}"
+end
+
+manager.on_error do |device, obj, code, description|
+  puts "Error - code #{code}, description #{description}"
+end
+
+puts 'Phidget Simple Playground (plug and unplug devices)'
+puts 'Please Enter to end anytime...'
+
+gets.chomp
+	
+puts 'Closing...'
+manager.close

data/examples/led.rb

@@ -17,10 +17,8 @@ led.on_attach  do |device, obj|
 	puts "Version: #{device.version}"
 	puts "# LEDs: #{device.leds.size}"
 	
-	device.leds.each do |i|
-		device.leds[i].brightness = 50
-	end
- 
+	device.current_limit = Phidgets::FFI::LEDCurrentLimit[:current_limit_20mA]
+	device.voltage = Phidgets::FFI::LEDVoltage[:voltage_3_9V]
 end
 	 
 led.on_detach  do |device, obj|
@@ -31,6 +29,21 @@ led.on_error do |device, obj, code, description|
 	puts "Error #{code}: #{description}"
 end
 
-sleep 5
+sleep 1
+
+if(led.attached?)
+	led.leds.each do |i|
+		i.current_limit = 20
+		i.brightness = 50
+	end
+	sleep 1
+	led.leds.each do |i|
+		i.brightness = 100
+	end
+	sleep 1
+	led.leds.each do |i|
+		i.current_limit = 2
+	end
+end
 
 led.close

data/examples/rfid.rb

@@ -22,7 +22,6 @@ rfid.on_attach  do |device, obj|
 	rfid.antenna = true
 	rfid.led = true
 	sleep 1
-	
 end
 	 
 rfid.on_detach  do |device, obj|
@@ -55,6 +54,11 @@ if(rfid.attached?)
 	begin
 		puts "Tag present: #{rfid.tag_present}"
 		puts "Last tag: #{rfid.last_tag}"
+		puts "Last tag proto: #{rfid.last_tag_protocol}"
+		
+		# Example for writing to a tag:
+		#rfid.write("Some tag..", Phidgets::FFI::RFIDTagProtocol[:PhidgetTAG])
+		
 	rescue Phidgets::Error::UnknownVal => e
 		puts "Exception caught: #{e.message}"
 	end

data/lib/phidgets-ffi/ffi/led.rb

@@ -18,8 +18,10 @@ module Phidgets
 	
 	attach_function :CPhidgetLED_create, [:phid], :int
     attach_function :CPhidgetLED_getLEDCount, [:phid, :pointer], :int 
-    attach_function :CPhidgetLED_getDiscreteLED, [:phid, :int, :pointer], :int 
-	attach_function :CPhidgetLED_setDiscreteLED, [:phid, :int, :int], :int 
+    attach_function :CPhidgetLED_getBrightness, [:phid, :int, :pointer], :int
+	attach_function :CPhidgetLED_setBrightness, [:phid, :int, :double], :int
+    attach_function :CPhidgetLED_getCurrentLimitIndexed, [:phid, :int, :pointer], :int
+	attach_function :CPhidgetLED_setCurrentLimitIndexed, [:phid, :int, :double], :int
     attach_function :CPhidgetLED_getCurrentLimit, [:phid, :pointer], :int 
 	attach_function :CPhidgetLED_setCurrentLimit, [:phid, LEDCurrentLimit], :int     
     attach_function :CPhidgetLED_getVoltage, [:phid, :pointer], :int 

data/lib/phidgets-ffi/ffi/rfid.rb

@@ -1,6 +1,12 @@
 module Phidgets
   module FFI
-
+  
+   RFIDTagProtocol = enum(
+      :EM4100, 1,
+      :ISO11785_FDX_B,
+      :PhidgetTAG
+    )
+	
 	attach_function :CPhidgetRFID_create, [:phid], :int
 	attach_function :CPhidgetRFID_getOutputCount, [:phid, :pointer], :int    
 	attach_function :CPhidgetRFID_getOutputState, [:phid, :int, :pointer], :int    
@@ -9,17 +15,18 @@ module Phidgets
     attach_function :CPhidgetRFID_setAntennaOn, [:phid, :int], :int 
 	attach_function :CPhidgetRFID_getLEDOn, [:phid, :pointer], :int    
     attach_function :CPhidgetRFID_setLEDOn, [:phid, :int], :int 
-	attach_function :CPhidgetRFID_getLastTag, [:phid, :pointer], :int    
-    attach_function :CPhidgetRFID_getTagStatus, [:phid, :pointer], :int 	
+	attach_function :CPhidgetRFID_getLastTag2, [:phid, :pointer, :pointer], :int
+    attach_function :CPhidgetRFID_getTagStatus, [:phid, :pointer], :int
+	attach_function :CPhidgetRFID_write, [:phid, :pointer, RFIDTagProtocol, :int], :int
 	
 	callback :CPhidgetRFID_set_OnOutputChange_Callback, [:phid, :user_ptr, :int, :int], :int
     attach_function :CPhidgetRFID_set_OnOutputChange_Handler, [:phid, :CPhidgetRFID_set_OnOutputChange_Callback, :user_ptr], :int 
 	
-	callback :CPhidgetRFID_set_OnTag_Callback, [:phid, :user_ptr, :pointer], :int 
-    attach_function :CPhidgetRFID_set_OnTag_Handler, [:phid, :CPhidgetRFID_set_OnTag_Callback, :user_ptr], :int 
+	callback :CPhidgetRFID_set_OnTag2_Callback, [:phid, :user_ptr, :pointer, RFIDTagProtocol], :int
+    attach_function :CPhidgetRFID_set_OnTag2_Handler, [:phid, :CPhidgetRFID_set_OnTag2_Callback, :user_ptr], :int
 	
-	callback :CPhidgetRFID_set_OnTagLost_Callback, [:phid, :user_ptr, :pointer], :int   
-    attach_function :CPhidgetRFID_set_OnTagLost_Handler, [:phid, :CPhidgetRFID_set_OnTagLost_Callback, :user_ptr], :int 
+	callback :CPhidgetRFID_set_OnTagLost2_Callback, [:phid, :user_ptr, :pointer, RFIDTagProtocol], :int
+    attach_function :CPhidgetRFID_set_OnTagLost2_Handler, [:phid, :CPhidgetRFID_set_OnTagLost2_Callback, :user_ptr], :int
 	
 module CPhidgetRFID
       def self.method_missing(method, *args, &block)

data/lib/phidgets-ffi/led.rb

@@ -66,24 +66,39 @@ module Phidgets
       "#<#{self.class} @index=#{index}, @brightness=#{brightness}>"
 	end
 
-	# @return [Integer] returns the index of the servo motor, or raises an error.
+	# @return [Integer] returns the index of the led, or raises an error.
 	def index 
 		@index
 	end
 	
-	# @return [Integer] returns the brightness level of an LED, or raises an error.
+	# @return [Float] returns the brightness level of an LED, or raises an error.
     def brightness
-      ptr = ::FFI::MemoryPointer.new(:int)
-      Klass.getDiscreteLED(@handle, @index, ptr)
+      ptr = ::FFI::MemoryPointer.new(:double)
+      Klass.getBrightness(@handle, @index, ptr)
       ptr.get_int(0)
     end
 
 	# Sets the brightness level of an LED, or raises an error. Brightness levels range from 0-100
-	# @param [Integer] new_brightness new brightness
-	# @return [Integer] returns the brightness of an LED, or raises an error.
+	# @param [Float] new_brightness new brightness
+	# @return [Float] returns the brightness of an LED, or raises an error.
     def brightness=(new_brightness)
-      Klass.setDiscreteLED(@handle, @index, new_brightness.to_i)
-      new_brightness.to_i
+      Klass.setBrightness(@handle, @index, new_brightness.to_f)
+      new_brightness.to_f
+    end
+	
+	# @return [Float] returns the current limit of an LED, or raises an error.
+    def current_limit
+      ptr = ::FFI::MemoryPointer.new(:double)
+      Klass.getCurrentLimitIndexed(@handle, @index, ptr)
+      ptr.get_int(0)
+    end
+
+	# Sets the current limit of an LED, or raises an error. Current Limit levels range from 0-80 mA
+	# @param [Float] new_current_limit new current limit
+	# @return [Float] returns the current limit of an LED, or raises an error.
+    def current_limit=(new_current_limit)
+      Klass.setCurrentLimitIndexed(@handle, @index, new_current_limit.to_f)
+      new_current_limit.to_f
     end
 	
   end #LEDOutputs

data/lib/phidgets-ffi/rfid.rb

@@ -51,10 +51,10 @@ module Phidgets
     # @return [Boolean] returns true or raises an error
     def on_tag(obj=nil, &block)
 	  @on_tag_obj = obj
-      @on_tag = Proc.new { |device, obj_ptr, tag|
-		yield self, convert_int_to_hex(tag), object_for(obj_ptr)
+      @on_tag = Proc.new { |device, obj_ptr, tag, proto|
+		yield self, tag.read_string, object_for(obj_ptr)
 	}
-      Klass.set_OnTag_Handler(@handle, @on_tag, pointer_for(obj))
+      Klass.set_OnTag2_Handler(@handle, @on_tag, pointer_for(obj))
     end
 	
     # Sets a tag lost handler callback function. This is called when a tag is removed from the reader
@@ -69,10 +69,10 @@ module Phidgets
     # @return [Boolean] returns true or raises an error
     def on_tag_lost(obj=nil, &block)
 	  @on_tag_lost_obj = obj
-      @on_tag_lost = Proc.new { |device, obj_ptr, tag|
-	    yield self, convert_int_to_hex(tag), object_for(obj_ptr)
+      @on_tag_lost = Proc.new { |device, obj_ptr, tag, proto|
+	    yield self, tag.read_string, object_for(obj_ptr)
 	}
-      Klass.set_OnTagLost_Handler(@handle, @on_tag_lost, pointer_for(obj))
+      Klass.set_OnTagLost2_Handler(@handle, @on_tag_lost, pointer_for(obj))
     end
 
     # Returns the antenna state of the Phidget.
@@ -115,11 +115,21 @@ module Phidgets
     #
     # @return [String] returns the last tag or raises an error
     def last_tag
-	  tag_size = 5
-	  tag_ffi = ::FFI::MemoryPointer.new(:uchar, tag_size)
-      Klass.getLastTag(@handle, tag_ffi)
-
-      convert_int_to_hex(tag_ffi)	  
+      tag = ::FFI::MemoryPointer.new(:string)
+	  proto = ::FFI::MemoryPointer.new(:int)
+      Klass.getLastTag2(@handle, tag, proto)
+      strPtr = tag.get_pointer(0)
+      strPtr.null? ? nil : strPtr.read_string
+	end
+	
+	# Returns the protocol of the last tag read by the reader. This may or may not still be on the reader - use {Phidgets::RFID#tag_present} to find out.
+    #
+    # @return [Phidgets::FFI::RFIDTagProtocol] returns the last tag protocol or raises an error
+    def last_tag_protocol
+      tag = ::FFI::MemoryPointer.new(:string)
+	  proto = ::FFI::MemoryPointer.new(:int)
+      Klass.getLastTag2(@handle, tag, proto)
+      Phidgets::FFI::RFIDTagProtocol[proto.get_int(0)]
 	end
 	
 	# Returns the value indicating whether or not a tag is on the reader.
@@ -131,6 +141,18 @@ module Phidgets
       (ptr.get_int(0) == 0) ? false : true
     end
 	
+	# Writes to a tag.
+	#
+	# @param [String] tag Tag data to write. See product manual for formatting.
+	# @param [Phidgets::FFI::RFIDTagProtocol] protocol Tag Protocol to use.
+	# @param [Boolean] lock Lock the tag from further writes
+	# @return [Boolean] returns true or raises an error
+	def write(tag, protocol, lock=false)
+      tmp = lock ? 1 : 0
+	  Klass.write(@handle, tag,  Phidgets::FFI::RFIDTagProtocol[protocol], tmp)
+	  true
+	end
+	
   # This class represents an digital output for a PhidgetRFID All the properties of an digital output are stored and modified in this class.
   class RFIDOutputs
     Klass = Phidgets::FFI::CPhidgetRFID
@@ -197,22 +219,10 @@ module Phidgets
       end
     end
 	
-	def convert_int_to_hex(int_tag)
-		tag_string = []
-		5.times { |i|
-			if int_tag[i].get_uchar(0).to_s(16).size == 1  #ruby removes leading 0, so we will put the 0 back in.
-				tag_string[i] = "0#{int_tag[i].get_uchar(0).to_s(16)}"
-			else
-				tag_string[i] = int_tag[i].get_uchar(0).to_s(16)
-			end
-		}
-		tag_string
-	end
-	
 	def remove_specific_event_handlers
 	   Klass.set_OnOutputChange_Handler(@handle, nil, nil)
-	   Klass.set_OnTag_Handler(@handle, nil, nil)
-	   Klass.set_OnTagLost_Handler(@handle, nil, nil)
+	   Klass.set_OnTag2_Handler(@handle, nil, nil)
+	   Klass.set_OnTagLost2_Handler(@handle, nil, nil)
 	end
 	
   end

data/lib/phidgets-ffi/version.rb

@@ -1,5 +1,5 @@
 module Phidgets
   module FFI
-    VERSION = "0.1.1"
+    VERSION = "0.1.2"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: phidgets-ffi
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-17 00:00:00.000000000Z
+date: 2012-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70096848586100 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,15 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *70096848586100
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: ffi
-  requirement: &70096848592520 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +37,12 @@ dependencies:
         version: 1.0.9
   type: :runtime
   prerelease: false
-  version_requirements: *70096848592520
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.9
 description: FFI Bindings for the Phidget Library
 email:
 - support@phidgets.com
@@ -45,6 +55,7 @@ files:
 - LICENSE
 - README.rdoc
 - Rakefile
+- examples/HelloWorld.rb
 - examples/accelerometer.rb
 - examples/advanced_servo.rb
 - examples/analog.rb
@@ -140,7 +151,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: phidgets-ffi
-rubygems_version: 1.8.10
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: FFI Bindings for the Phidget Library