ftdi 0.0.1

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License
+
+Copyright (c) 2009 Jason Heiss
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+

data/README

@@ -0,0 +1,6 @@
+Ruby bindings for libftdi:  http://www.intra2net.com/en/developer/libftdi/
+Also requires swig:  http://www.swig.org/
+
+The gem includes example scripts.  Where they end up depends on your
+system, but can be found with:  gem contents ftdi | grep examples
+

data/examples/onoff.rb

@@ -0,0 +1,54 @@
+#!/usr/bin/ruby -w
+
+# An example using bitbang mode which turns all 8 pins off, waits a second,
+# then all on and waits for a second, then off and exits.
+
+require 'rubygems'
+require 'ftdi'
+
+puts 'ftdi_new'
+ftdi1 = Ftdi.ftdi_new
+
+puts 'ftdi_usb_open_desc ?'
+if (r = Ftdi.ftdi_usb_open_desc(ftdi1, 0x0403, 0x6001, 'USBMOD4', '?')) < 0
+  abort "unable to open ftdi device: #{r} (#{Ftdi.ftdi_get_error_string(ftdi1)})"
+end
+
+puts 'ftdi_enable_bitbang'
+if (r = Ftdi.ftdi_enable_bitbang(ftdi1, 0xFF)) < 0
+  abort "unable to enable bitbang mode: #{r} (#{Ftdi.ftdi_get_error_string(ftdi1)})"
+end
+
+buf = Ftdi::UnsignedCharArray.new(1)
+buf[0] = 0x0
+puts 'turning everything off'
+if (r = Ftdi.ftdi_write_data(ftdi1, buf, 1)) < 0
+  abort "unable to write data: #{r} (#{Ftdi.ftdi_get_error_string(ftdi1)})"
+end
+
+sleep 1
+
+buf[0] = 0xFF
+puts 'turning everything on'
+if (r = Ftdi.ftdi_write_data(ftdi1, buf, 1)) < 0
+  abort "unable to write data: #{r} (#{Ftdi.ftdi_get_error_string(ftdi1)})"
+end
+
+sleep 1
+
+buf[0] = 0x0
+puts 'turning everything off'
+if (r = Ftdi.ftdi_write_data(ftdi1, buf, 1)) < 0
+  abort "unable to write data: #{r} (#{Ftdi.ftdi_get_error_string(ftdi1)})"
+end
+
+puts 'ftdi_disable_bitbang'
+if (r = Ftdi.ftdi_disable_bitbang(ftdi1)) < 0
+  abort "unable to disable bitbang mode: #{r} (#{Ftdi.ftdi_get_error_string(ftdi1)})"
+end
+
+puts 'ftdi_usb_close'
+if (r = Ftdi.ftdi_usb_close(ftdi1)) < 0
+  abort "unable to close ftdi device: #{r} (#{Ftdi.ftdi_get_error_string(ftdi1)})"
+end
+

data/examples/simple.rb

@@ -0,0 +1,33 @@
+#!/usr/bin/ruby -w
+
+# Simple libftdi usage example
+# Translation of the example from
+# http://www.intra2net.com/en/developer/libftdi/documentation/
+
+require 'rubygems'
+require 'ftdi'
+
+# Not quite an exact translation of the C example (which statically allocates
+# the ftdi_context and then calls ftdi_init on it, whereas I'm using ftdi_new
+# to allocate and init in one shot so that I can avoid figuring out how to
+# statically allocate a C struct from Ruby).  If someone wants to figure that
+# out I think it would be nice for this script to be a more direct
+# translation, the other examples can take shortcuts.
+ftdic = Ftdi.ftdi_new
+
+if (ret = Ftdi.ftdi_usb_open(ftdic, 0x0403, 0x6001)) < 0
+  abort "unable to open ftdi device: #{ret} (#{Ftdi.ftdi_get_error_string(ftdic)})"
+end
+
+# Read out FTDIChip-ID of R type chips
+if ftdic.type == Ftdi::TYPE_R
+  chipid = IntPointer.new
+  puts "ftdi_read_chipid: #{Ftdi.ftdi_read_chipid(ftdic, chipid)}"
+  puts "FTDI chipid: #{chipid.value}"
+end
+
+Ftdi.ftdi_usb_close(ftdic)
+Ftdi.ftdi_deinit(ftdic)
+
+exit(true)
+

data/examples/updown.rb

@@ -0,0 +1,56 @@
+#!/usr/bin/ruby -w
+
+# An example using bitbang mode which turns all 8 pins off, waits a second,
+# then turns each pin on in turn for 1/2 sec each, then turns everything back
+# off and exits.
+
+require 'rubygems'
+require 'ftdi'
+
+puts 'ftdi_new'
+ftdi1 = Ftdi.ftdi_new
+
+puts 'ftdi_usb_open_desc ?'
+if (r = Ftdi.ftdi_usb_open_desc(ftdi1, 0x0403, 0x6001, 'USBMOD4', '?')) < 0
+  abort "unable to open ftdi device: #{r} (#{Ftdi.ftdi_get_error_string(ftdi1)})"
+end
+
+puts 'ftdi_enable_bitbang'
+if (r = Ftdi.ftdi_enable_bitbang(ftdi1, 0xFF)) < 0
+  abort "unable to enable bitbang mode: #{r} (#{Ftdi.ftdi_get_error_string(ftdi1)})"
+end
+
+buf = Ftdi::UnsignedCharArray.new(1)
+buf[0] = 0x0
+puts 'turning everything off'
+if (r = Ftdi.ftdi_write_data(ftdi1, buf, 1)) < 0
+  abort "unable to write data: #{r} (#{Ftdi.ftdi_get_error_string(ftdi1)})"
+end
+
+sleep 1
+
+0.upto(7) do |i|
+  buf[0] =  0 | (0x0 ^ 1 << (i % 8))
+  printf "%08b\n", buf[0]
+  if (r = Ftdi.ftdi_write_data(ftdi1, buf, 1)) < 0
+    abort "unable to write data: #{r} (#{Ftdi.ftdi_get_error_string(ftdi1)})"
+  end
+  sleep 0.5
+end
+
+buf[0] = 0x0
+puts 'turning everything off'
+if (r = Ftdi.ftdi_write_data(ftdi1, buf, 1)) < 0
+  abort "unable to write data: #{r} (#{Ftdi.ftdi_get_error_string(ftdi1)})"
+end
+
+puts 'ftdi_disable_bitbang'
+if (r = Ftdi.ftdi_disable_bitbang(ftdi1)) < 0
+  abort "unable to disable bitbang mode: #{r} (#{Ftdi.ftdi_get_error_string(ftdi1)})"
+end
+
+puts 'ftdi_usb_close'
+if (r = Ftdi.ftdi_usb_close(ftdi1)) < 0
+  abort "unable to close ftdi device: #{r} (#{Ftdi.ftdi_get_error_string(ftdi1)})"
+end
+

data/ext/extconf.rb

@@ -0,0 +1,43 @@
+require 'mkmf'
+idir, ldir = dir_config('ftdi')
+have_library('ftdi', 'ftdi_init')
+
+# Swig seemingly has no notion of searching any standard system directories
+# for included header files.  And figuring out where the user has ftdi
+# installed is potentially tricky.  Seems like there are three
+# possibilities for where mkmf will end finding ftdi:
+# - Installed in a standard system location searched by cpp by default
+# - Installed in the same location as Ruby, as mkmf adds
+#   Config::CONFIG['CPPFLAGS'] to the compiler args, and thus adds the include
+#   directory associated with the Ruby install location even if cpp wouldn't
+#   normally check there by default.
+# - A location specified by the user at install time via the dir_config
+#   feature
+# This all seems horribly cheesy, so if a someone who knows anything about
+# swig happens to read this I'd appreciate pointers on how other folks handle
+# this.
+ftdi_includes = []
+# Standard system locations
+IO.popen('cpp -M -include ftdi.h < /dev/null') do |pipe|
+  pipe.each do |line|
+    line.split(' ').each do |inc|
+      if inc.include?('/ftdi.h')
+        ftdi_includes << '-I' + inc
+      end
+    end
+  end
+end
+# Any -I directories in Config::CONFIG['CPPFLAGS']
+Config::CONFIG['CPPFLAGS'].split(' ').each do |rbcppflag|
+  if rbcppflag =~ /^-I/
+    ftdi_includes << rbcppflag
+  end
+end
+# User specified directory via dir_config
+if idir
+  ftdi_includes << '-I' + idir
+end
+system("swig -ruby #{ftdi_includes.uniq.join(' ')} ftdi.i") || abort("swig failed")
+
+create_makefile("ftdi")
+

data/ext/ftdi.i

@@ -0,0 +1,20 @@
+%module ftdi
+
+%include "cpointer.i"
+%include "carrays.i"
+%include "cdata.i"
+
+/* Wrap a class interface around an "int *" */
+/* http://www.swig.org/Doc1.3/SWIGDocumentation.html#Library_nn4 */
+%pointer_class(int, IntPointer);
+
+/* Wrap a class interface around an "unsigned char *" */
+/* http://www.swig.org/Doc1.3/SWIGDocumentation.html#Library_nn7 */
+%array_class(unsigned char, UnsignedCharArray);
+
+%{
+#include <ftdi.h>
+%}
+
+%include "ftdi.h"
+

data/test/test_ftdi.rb

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'ftdi'
+require 'test/unit'
+
+class TestTest < Test::Unit::TestCase
+  def test_ftdi
+    t = Ftdi.new
+    assert_equal(Object, Ftdi.superclass)
+    assert_equal(Ftdi, t.class)
+    t.add(1)
+    t.add(2)
+    assert_equal([1,2], t.instance_eval("@arr"))
+  end
+end
+

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification 
+name: ftdi
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Jason Heiss
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-16 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: |+
+  Ruby bindings for libftdi:  http://www.intra2net.com/en/developer/libftdi/
+  Also requires swig:  http://www.swig.org/
+  
+  The gem includes example scripts.  Where they end up depends on your
+  system, but can be found with:  gem contents ftdi | grep examples
+  
+email: jheiss@aput.net
+executables: []
+
+extensions: 
+- ext/extconf.rb
+extra_rdoc_files: []
+
+files: 
+- README
+- LICENSE
+- examples/onoff.rb
+- examples/simple.rb
+- examples/updown.rb
+- ext/extconf.rb
+- ext/ftdi.i
+- test/test_ftdi.rb
+has_rdoc: true
+homepage: http://github.com/jheiss/ftdi
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.8"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: 
+- libftdi
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Ruby bindings for libftdi
+test_files: 
+- test/test_ftdi.rb