nfc 1.0.0 → 2.0.0

data/CHANGELOG.rdoc

@@ -1,3 +1,10 @@
+=== 2.0.0 / 2009-08-07
+
+* 2 major enhancements
+
+  * Switched from FFI to a C backend
+  * Now depends on libnfc 1.2.x
+
 === 1.0.0 / 2009-06-01
 
 * 1 major enhancement

data/Manifest.txt

@@ -4,6 +4,14 @@ Manifest.txt
 README.rdoc
 Rakefile
 bin/nfc
+ext/nfc/extconf.rb
+ext/nfc/nfc.c
+ext/nfc/nfc.h
+ext/nfc/nfc_device.c
+ext/nfc/nfc_device.h
+ext/nfc/nfc_iso14443a.c
+ext/nfc/nfc_iso14443a.h
 lib/nfc.rb
-lib/nfc/lib_nfc.rb
+lib/nfc/device.rb
+lib/nfc/iso14443a.rb
 test/test_nfc.rb

data/README.rdoc

@@ -10,26 +10,50 @@ lets you read RFID tags.
 
 == FEATURES/PROBLEMS:
 
-* Only supports ISO1443A tags (MIFARE) tags right now.
+* Only supports ISO1443A (MIFARE) tags right now.
 
 == SYNOPSIS:
 
   require 'nfc'
 
-  # Read your tag and print the info
+  # Read your tag and print the info.
   p NFC.instance.find
 
+  # NFC#find will return immidiately, which means you should have a tag
+  # sitting on the reader when running it.  If you'd like it to block until
+  # it detects a tag, give find a block like so:
+
+  NFC.instance.find do |tag|
+    p tag
+  end
+
+  # You can even run in an infinite loop if you'd like to continually find
+  # tags:
+
+  loop do
+    NFC.instance.find do |tag|
+      p tag
+    end
+  end
+
 == REQUIREMENTS:
 
 * A USB RFID reader.  I'm using the touchatag[http://touchatag.com].
-* ffi
 * libnfc
 
 == INSTALL:
 
-* First install libnfc[http://libnfc.org/]
-* Make sure libnfc.dylib or libnfc.so is in your library path
-* gem install nfc
+First install libnfc[http://libnfc.org/]
+I installed libnfc like this:
+
+  $ ./configure --prefix=/usr/local
+  $ make && make install
+
+The install the gem:
+
+  $ sudo gem install nfc
+
+NOTE!!!!  The nfc gem requires libnfc version 1.2.0 or greater!
 
 == LICENSE:
 

data/Rakefile

@@ -2,15 +2,20 @@
 
 require 'rubygems'
 require 'hoe'
-$: << "lib"
-require 'nfc'
+gem 'rake-compiler', '>= 0.4.1'
+require "rake/extensiontask"
 
-Hoe.new('nfc', NFC::VERSION) do |p|
-  p.developer('Aaron Patterson', 'aaronp@rubyforge.org')
-  p.readme_file   = 'README.rdoc'
-  p.history_file  = 'CHANGELOG.rdoc'
-  p.extra_rdoc_files  = FileList['*.rdoc']
-  p.extra_deps      = ['ffi']
+HOE = Hoe.spec('nfc') do
+  developer('Aaron Patterson', 'aaronp@rubyforge.org')
+  self.readme_file   = 'README.rdoc'
+  self.history_file  = 'CHANGELOG.rdoc'
+  self.extra_rdoc_files  = FileList['*.rdoc']
+  self.spec_extras = { :extensions => ["ext/nfc/extconf.rb"] }
+  self.rubyforge_name = 'seattlerb'
+end
+
+RET = Rake::ExtensionTask.new("nfc", HOE.spec) do |ext|
+  ext.lib_dir = File.join('lib', 'nfc')
 end
 
 # vim: syntax=Ruby

data/bin/nfc

@@ -6,4 +6,6 @@ nfc = NFC.instance
 
 puts "Connected to NFC reader: #{nfc.device.name}"
 puts
-p nfc.find
+nfc.find do |tag|
+  p tag
+end

data/ext/nfc/extconf.rb

@@ -0,0 +1,56 @@
+ENV['RC_ARCHS'] = '' if RUBY_PLATFORM =~ /darwin/
+
+# :stopdoc:
+
+require 'mkmf'
+
+LIBDIR      = Config::CONFIG['libdir']
+INCLUDEDIR  = Config::CONFIG['includedir']
+
+$CFLAGS << " -O3 -Wall -Wcast-qual -Wwrite-strings -Wconversion -Wmissing-noreturn -Winline"
+
+HEADER_DIRS = [
+  # First search /opt/local for macports
+  '/opt/local/include',
+
+  # Then search /usr/local for people that installed from source
+  '/usr/local/include',
+
+  # Check the ruby install locations
+  INCLUDEDIR,
+
+  # Finally fall back to /usr
+  '/usr/include',
+]
+
+LIB_DIRS = [
+  # First search /opt/local for macports
+  '/opt/local/lib',
+
+  # Then search /usr/local for people that installed from source
+  '/usr/local/lib',
+
+  # Check the ruby install locations
+  LIBDIR,
+
+  # Finally fall back to /usr
+  '/usr/lib',
+]
+
+nfc_dirs = dir_config('nfc', '/opt/local/include', '/opt/local/lib')
+unless ["", ""] == nfc_dirs
+  HEADER_DIRS.unshift nfc_dirs.first
+  LIB_DIRS.unshift nfc_dirs[1]
+end
+
+unless find_header('libnfc/libnfc.h', *HEADER_DIRS)
+  abort "libnfc is missing.  please install libnfc: http://libnfc.org/"
+end
+
+unless find_library('nfc', 'nfc_connect', *LIB_DIRS)
+  abort "libnfc is missing.  please install libnfc: http://libnfc.org/"
+end
+
+create_makefile('nfc/nfc')
+
+# :startdoc:

data/ext/nfc/nfc.c

@@ -0,0 +1,11 @@
+#include <nfc.h>
+
+VALUE cNfc;
+
+void Init_nfc()
+{
+  cNfc = rb_define_class("NFC", rb_cObject);
+
+  init_device();
+  init_iso14443a();
+}

data/ext/nfc/nfc.h

@@ -0,0 +1,12 @@
+#ifndef NFC_H
+#define NFC_H
+
+#include <ruby.h>
+#include <libnfc/libnfc.h>
+
+extern VALUE cNfc;
+
+#include <nfc_device.h>
+#include <nfc_iso14443a.h>
+
+#endif

data/ext/nfc/nfc_device.c

@@ -0,0 +1,111 @@
+#include <nfc_device.h>
+
+/*
+ * call-seq:
+ *  connect
+ *
+ * Connect to the NFC device
+ */
+static VALUE connect(VALUE klass)
+{
+  dev_info * dev = nfc_connect();
+  if(!nfc_initiator_init(dev))
+    rb_raise(rb_eRuntimeError, "oh snap, could not init");
+
+  return Data_Wrap_Struct(klass, 0, 0, dev);
+}
+
+/*
+ * call-seq:
+ *  disconnect
+ *
+ * Disconnect from the NFC device
+ */
+static VALUE disconnect(VALUE self)
+{
+  dev_info * dev;
+  Data_Get_Struct(self, dev_info, dev);
+  nfc_disconnect(dev);
+
+  return self;
+}
+
+/*
+ * call-seq:
+ *  configure(option, value)
+ *
+ * Configure the Device with +option+ and +value+
+ */
+static VALUE configure(VALUE self, VALUE option, VALUE flag)
+{
+  dev_info * dev;
+  Data_Get_Struct(self, dev_info, dev);
+
+  nfc_configure(
+    dev,
+    (const dev_config_option)NUM2INT(option),
+    (const bool)NUM2INT(flag)
+  );
+
+  return self;
+}
+
+/*
+ * call-seq:
+ *  select(tag)
+ *
+ * Select the +tag+ type from the device
+ */
+static VALUE dev_select(VALUE self, VALUE tag)
+{
+  dev_info * dev;
+  Data_Get_Struct(self, dev_info, dev);
+
+  tag_info * ti = calloc(1, sizeof(tag_info));
+
+  nfc_initiator_select_tag(dev, IM_ISO14443A_106, NULL, 0, ti);
+
+  return Data_Wrap_Struct(cNfcISO14443A, 0, free, ti);
+}
+
+/*
+ * call-seq:
+ *  name
+ *
+ * Get the name of the tag reader
+ */
+static VALUE name(VALUE self)
+{
+  dev_info * dev;
+  Data_Get_Struct(self, dev_info, dev);
+
+  return rb_str_new2(dev->acName);
+}
+
+/*
+ * call-seq:
+ *  deselect
+ *
+ * Deselect the current tag
+ */
+static VALUE dev_deselect(VALUE self)
+{
+  dev_info * dev;
+  Data_Get_Struct(self, dev_info, dev);
+
+  nfc_initiator_deselect_tag(dev);
+
+  return self;
+}
+
+void init_device()
+{
+  VALUE cNfcDevice = rb_define_class_under(cNfc, "Device", rb_cObject);
+
+  rb_define_singleton_method(cNfcDevice, "connect", connect, 0);
+  rb_define_method(cNfcDevice, "disconnect", disconnect, 0);
+  rb_define_method(cNfcDevice, "configure", configure, 2);
+  rb_define_method(cNfcDevice, "select", dev_select, 1);
+  rb_define_method(cNfcDevice, "deselect", dev_deselect, 0);
+  rb_define_method(cNfcDevice, "name", name, 0);
+}

data/ext/nfc/nfc_device.h

@@ -0,0 +1,8 @@
+#ifndef NFC_DEVICE_H
+#define NFC_DEVICE_H
+
+#include <nfc.h>
+
+void init_device();
+
+#endif

data/ext/nfc/nfc_iso14443a.c

@@ -0,0 +1,100 @@
+#include <nfc_iso14443a.h>
+
+VALUE cNfcISO14443A;
+
+/*
+ * call-seq:
+ *  uiUidLen
+ *
+ * Get the uiUidLen
+ */
+static VALUE uiUidLen(VALUE self)
+{
+  tag_info_iso14443a * tag;
+  Data_Get_Struct(self, tag_info_iso14443a, tag);
+
+  return INT2NUM(tag->uiUidLen);
+}
+
+/*
+ * call-seq:
+ *  uiAtsLen
+ *
+ * Get the uiAtsLen
+ */
+static VALUE uiAtsLen(VALUE self)
+{
+  tag_info_iso14443a * tag;
+  Data_Get_Struct(self, tag_info_iso14443a, tag);
+
+  return INT2NUM(tag->uiAtsLen);
+}
+
+/*
+ * call-seq:
+ *  abtUid
+ *
+ * Get the abtUid
+ */
+static VALUE abtUid(VALUE self)
+{
+  tag_info_iso14443a * tag;
+  Data_Get_Struct(self, tag_info_iso14443a, tag);
+
+  return rb_str_new(tag->abtUid, tag->uiUidLen);
+}
+
+/*
+ * call-seq:
+ *  abtAts
+ *
+ * Get the abtAts
+ */
+static VALUE abtAts(VALUE self)
+{
+  tag_info_iso14443a * tag;
+  Data_Get_Struct(self, tag_info_iso14443a, tag);
+
+  return rb_str_new(tag->abtAts, tag->uiAtsLen);
+}
+
+/*
+ * call-seq:
+ *  abtAtqa
+ *
+ * Get the abtAtqa
+ */
+static VALUE abtAtqa(VALUE self)
+{
+  tag_info_iso14443a * tag;
+  Data_Get_Struct(self, tag_info_iso14443a, tag);
+
+  return rb_str_new(tag->abtAtqa, 2);
+}
+
+/*
+ * call-seq:
+ *  btSak
+ *
+ * Get the btSak
+ */
+static VALUE btSak(VALUE self)
+{
+  tag_info_iso14443a * tag;
+  Data_Get_Struct(self, tag_info_iso14443a, tag);
+
+  return INT2NUM(tag->btSak);
+}
+
+void init_iso14443a()
+{
+  cNfcISO14443A = rb_define_class_under(cNfc, "ISO14443A", rb_cObject);
+
+  rb_define_method(cNfcISO14443A, "uiUidLen", uiUidLen, 0);
+  rb_define_method(cNfcISO14443A, "uiAtsLen", uiAtsLen, 0);
+  rb_define_method(cNfcISO14443A, "btSak", btSak, 0);
+
+  rb_define_private_method(cNfcISO14443A, "abtUid", abtUid, 0);
+  rb_define_private_method(cNfcISO14443A, "abtAts", abtAts, 0);
+  rb_define_private_method(cNfcISO14443A, "abtAtqa", abtAtqa, 0);
+}

data/ext/nfc/nfc_iso14443a.h

@@ -0,0 +1,10 @@
+#ifndef NFC_ISO14443A
+#define NFC_ISO14443A
+
+#include <nfc.h>
+
+extern VALUE cNfcISO14443A;
+
+void init_iso14443a();
+
+#endif

data/lib/nfc.rb

@@ -1,60 +1,106 @@
 require 'singleton'
-require 'nfc/lib_nfc'
+require 'thread'
+require 'nfc/nfc'
+require 'nfc/device'
+require 'nfc/iso14443a'
 
+###
+# NFC is a class for dealing with Near Field Communication systems.  This
+# library will read RFID tags from an RFID reader.  You should start by reading
+# NFC#find
 class NFC
-  VERSION = '1.0.0'
-
-  attr_reader :device
+  VERSION = '2.0.0'
 
   include Singleton
 
+  ###
+  # Create a new NFC class.  This is private, do this instead:
+  #   NFC.instance
   def initialize
-    @device = NFC::LibNFC::Device.new(NFC::LibNFC.nfc_connect)
-    LibNFC.nfc_reader_init(@device.pointer)
+    @device = nil
+    @mutex = Mutex.new
   end
 
+  ###
+  # Deactivate the detection field
   def deactivate_field
-    LibNFC.nfc_configure @device.pointer, LibNFC::DCO_ACTIVATE_FIELD, 0
+    device.configure Device::DCO_ACTIVATE_FIELD, 0
   end
 
+  ###
+  # Activate the detection field
   def activate_field
-    LibNFC.nfc_configure @device.pointer, LibNFC::DCO_ACTIVATE_FIELD, 1
+    device.configure Device::DCO_ACTIVATE_FIELD, 1
   end
 
+  ###
+  # Do CRC checks
   def crc= value
-    LibNFC.nfc_configure @device.pointer, LibNFC::DCO_HANDLE_CRC, value ? 1 : 0
+    device.configure Device::DCO_HANDLE_CRC, value ? 1 : 0
   end
 
+  ###
+  # Parity checks
   def parity= v
-    LibNFC.nfc_configure @device.pointer, LibNFC::DCO_HANDLE_PARITY, v ? 1 : 0
+    device.configure Device::DCO_HANDLE_PARITY, v ? 1 : 0
+  end
+
+  ###
+  # Get the device
+  def device
+    @device ||= NFC::Device.connect
   end
 
+  ###
+  # Block until a passive tag is detected
   def infinite_list_passive= v
-    LibNFC.nfc_configure(
-      @device.pointer,
-      LibNFC::DCO_INFINITE_LIST_PASSIVE,
-      v ? 1 : 0
-    )
+    device.configure Device::DCO_INFINITE_LIST_PASSIVE, v ? 1 : 0
+  end
+
+  ###
+  # Select a tag
+  def select
+    device.select Device::IM_ISO14443A_106
   end
+  alias :detect :select
 
-  def poll_mifare
-    thing = LibNFC::ISO1443A.new
-    LibNFC.nfc_reader_list_passive(
-      @device.pointer,
-      LibNFC::IM_ISO14443A_106,
-      nil,
-      0,
-      thing
-    )
-    thing
+  ###
+  # Deselect a tag
+  def deselect
+    device.deselect
   end
 
+  # Read your tag and print the info.
+  #
+  #   p NFC.instance.find
+  #
+  # NFC#find will return immidiately, which means you should have a tag
+  # sitting on the reader when running it.  If you'd like it to block until
+  # it detects a tag, give find a block like so:
+  #
+  #   NFC.instance.find do |tag|
+  #     p tag
+  #   end
+  #
+  # You can even run in an infinite loop if you'd like to continually find
+  # tags:
+  #
+  #   loop do
+  #     NFC.instance.find do |tag|
+  #       p tag
+  #     end
+  #   end
   def find
+    @mutex.lock
     deactivate_field
-    self.infinite_list_passive = false
+    self.infinite_list_passive = block_given?
     self.crc = true
     self.parity = true
     activate_field
-    poll_mifare
+    tag = detect
+    deselect
+    @mutex.unlock
+    yield tag if block_given?
+    tag
   end
 end

data/lib/nfc/device.rb

@@ -0,0 +1,10 @@
+class NFC
+  class Device
+    DCO_HANDLE_CRC            = 0x00
+    DCO_HANDLE_PARITY         = 0x01
+    DCO_ACTIVATE_FIELD        = 0x10
+    DCO_INFINITE_LIST_PASSIVE = 0x20
+
+    IM_ISO14443A_106    = 0x00
+  end
+end

data/lib/nfc/iso14443a.rb

@@ -0,0 +1,39 @@
+class NFC
+  class ISO14443A
+    ###
+    # Get the unique ID for this tag
+    def uid
+      abtUid.unpack 'C*'
+    end
+
+    ###
+    # Get the ATS for this tag
+    def ats
+      abtAts.unpack 'C*'
+    end
+
+    ###
+    # Get the atqa
+    def atqa
+      abtAtqa.unpack 'C*'
+    end
+
+    ###
+    # Inspect this tag
+    def inspect
+      uid = sprintf((['%02x'] * uiUidLen).join('  '), *self.uid)
+
+      string_ary =
+        [ "(NFC) ISO14443A Tag",
+          " ATQA (SENS_RES): #{sprintf("%02x  %02x", *atqa)}",
+          "    UID (NFCID1): #{uid}",
+          "   SAK (SEL_RES): #{sprintf("%02x", btSak)}"
+        ]
+      if uiAtsLen > 0
+        ats = sprintf((['%02x'] * uiAtsLen).join('  '), *self.ats)
+        string_ary << "       ATS (ATR): #{ats}"
+      end
+      string_ary.join "\n"
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: nfc
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors: 
 - Aaron Patterson
@@ -9,19 +9,9 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-06-01 00:00:00 -07:00
+date: 2009-08-07 00:00:00 -07:00
 default_executable: 
 dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: ffi
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
-    version: 
 - !ruby/object:Gem::Dependency 
   name: hoe
   type: :development
@@ -30,7 +20,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.12.1
+        version: 2.3.2
     version: 
 description: |-
   NFC is a ruby wrapper for the Near Field Communication library.  The Near
@@ -40,8 +30,8 @@ email:
 - aaronp@rubyforge.org
 executables: 
 - nfc
-extensions: []
-
+extensions: 
+- ext/nfc/extconf.rb
 extra_rdoc_files: 
 - Manifest.txt
 - CHANGELOG.rdoc
@@ -53,8 +43,16 @@ files:
 - README.rdoc
 - Rakefile
 - bin/nfc
+- ext/nfc/extconf.rb
+- ext/nfc/nfc.c
+- ext/nfc/nfc.h
+- ext/nfc/nfc_device.c
+- ext/nfc/nfc_device.h
+- ext/nfc/nfc_iso14443a.c
+- ext/nfc/nfc_iso14443a.h
 - lib/nfc.rb
-- lib/nfc/lib_nfc.rb
+- lib/nfc/device.rb
+- lib/nfc/iso14443a.rb
 - test/test_nfc.rb
 has_rdoc: true
 homepage: http://seattlerb.rubyforge.org
@@ -66,6 +64,7 @@ rdoc_options:
 - README.rdoc
 require_paths: 
 - lib
+- ext
 required_ruby_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
@@ -80,8 +79,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   version: 
 requirements: []
 
-rubyforge_project: nfc
-rubygems_version: 1.3.3
+rubyforge_project: seattlerb
+rubygems_version: 1.3.4
 signing_key: 
 specification_version: 3
 summary: NFC is a ruby wrapper for the Near Field Communication library

data/lib/nfc/lib_nfc.rb

@@ -1,66 +0,0 @@
-require 'ffi'
-
-class NFC
-  class LibNFC
-    extend FFI::Library
-    ffi_lib 'nfc'
-
-    attach_function :nfc_connect, [], :pointer
-    attach_function :nfc_disconnect, [:pointer], :void
-    attach_function :nfc_reader_init, [:pointer], :int
-    attach_function :nfc_configure, [:pointer, :int, :int], :int
-    attach_function :nfc_reader_list_passive, [:pointer, :int, :pointer, :int, :pointer], :int
-
-    DCO_HANDLE_CRC            = 0x00
-    DCO_HANDLE_PARITY         = 0x01
-    DCO_ACTIVATE_FIELD        = 0x10
-    DCO_INFINITE_LIST_PASSIVE = 0x20
-
-    IM_ISO14443A_106    = 0x00
-
-    class Device < FFI::Struct
-      layout(:name, [:char, 256])
-
-      def name
-        pointer.read_string
-      end
-
-      def self.release ptr
-        LibNFC.nfc_disconnect ptr
-      end
-    end
-
-    class ISO1443A < FFI::Struct
-      layout(
-        :abtAtqa, [:uchar, 2],
-        :btSak, :uchar,
-        :uiUidLen, :int,
-        :abtUid, [:uchar, 10],
-        :uiAtsLen, :int,
-        :abtAts, [:uchar, 36]
-      )
-
-      def uid
-        self[:abtUid].to_a.slice(0, self[:uiUidLen])
-      end
-
-      def inspect
-        uid = sprintf((['%02x'] * self[:uiUidLen]).join('  '), *self.uid)
-
-        string_ary =
-          [ "(NFC) ISO14443A Tag",
-            " ATQA (SENS_RES): #{sprintf("%02x  %02x", *(self[:abtAtqa]))}",
-            "    UID (NFCID1): #{uid}",
-            "   SAK (SEL_RES): #{sprintf("%02x", self[:btSak])}"
-          ]
-        if self[:uiAtsLen] > 0
-          ats =
-            sprintf((['%02x'] * self[:uiAtsLen]).join('  '), *(self[:abtAts]))
-          string_ary <<
-            "       ATS (ATR): #{ats}"
-        end
-        string_ary.join "\n"
-      end
-    end
-  end
-end