nfc 2.0.1 → 2.1.0

data/CHANGELOG.rdoc

@@ -1,3 +1,9 @@
+=== 2.1.0 / 2011-05-27
+
+* 1 Enhancement
+
+  * Moved to libnfc version 1.5.x
+
 === 2.0.1 / 2009-09-19
 
 * 1 Bugfix

data/Manifest.txt

@@ -9,9 +9,12 @@ ext/nfc/nfc.c
 ext/nfc/nfc.h
 ext/nfc/nfc_device.c
 ext/nfc/nfc_device.h
+ext/nfc/nfc_felica.c
+ext/nfc/nfc_felica.h
 ext/nfc/nfc_iso14443a.c
 ext/nfc/nfc_iso14443a.h
 lib/nfc.rb
 lib/nfc/device.rb
+lib/nfc/felica.rb
 lib/nfc/iso14443a.rb
 test/test_nfc.rb

data/README.rdoc

@@ -52,13 +52,13 @@ The install the gem:
 
   $ sudo gem install nfc
 
-NOTE!!!!  The nfc gem requires libnfc version 1.2.0 or greater!
+NOTE!!!!  The nfc gem requires libnfc version 1.5.0 or greater!
 
 == LICENSE:
 
 (The MIT License)
 
-Copyright (c) 2009 Aaron Patterson
+Copyright (c) 2009-2011 Aaron Patterson
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Rakefile

@@ -6,14 +6,14 @@ gem 'rake-compiler', '>= 0.4.1'
 require "rake/extensiontask"
 
 Hoe.plugin :debugging
+Hoe.plugin :git
 
 HOE = Hoe.spec('nfc') do
-  developer('Aaron Patterson', 'aaronp@rubyforge.org')
+  developer('Aaron Patterson', 'aaron@tenderlovemaking.com')
   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|

data/ext/nfc/extconf.rb

@@ -6,48 +6,16 @@ require 'mkmf'
 
 LIBDIR      = Config::CONFIG['libdir']
 INCLUDEDIR  = Config::CONFIG['includedir']
+HEADER_DIRS = [ '/usr/local/include', INCLUDEDIR, '/usr/include', ]
+LIB_DIRS    = [ '/usr/local/lib', LIBDIR, '/usr/lib', ]
 
-$CFLAGS << " -O3 -Wall -Wcast-qual -Wwrite-strings -Wconversion -Wmissing-noreturn -Winline"
+nfc_dirs = dir_config('nfc', HEADER_DIRS, LIB_DIRS)
 
-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)
+unless find_header('nfc/nfc.h')
   abort "libnfc is missing.  please install libnfc: http://libnfc.org/"
 end
 
-unless find_library('nfc', 'nfc_connect', *LIB_DIRS)
+unless find_library('nfc', 'nfc_connect')
   abort "libnfc is missing.  please install libnfc: http://libnfc.org/"
 end
 

data/ext/nfc/nfc.c

@@ -8,4 +8,5 @@ void Init_nfc()
 
   init_device();
   init_iso14443a();
+  init_felica();
 }

data/ext/nfc/nfc.h

@@ -2,11 +2,12 @@
 #define NFC_H
 
 #include <ruby.h>
-#include <libnfc/libnfc.h>
+#include <nfc/nfc.h>
 
 extern VALUE cNfc;
 
 #include <nfc_device.h>
 #include <nfc_iso14443a.h>
+#include <nfc_felica.h>
 
 #endif

data/ext/nfc/nfc_device.c

@@ -1,5 +1,7 @@
 #include <nfc_device.h>
 
+static byte_t abtFelica[5] = { 0x00, 0xff, 0xff, 0x00, 0x00 };
+
 /*
  * call-seq:
  *  connect
@@ -8,7 +10,7 @@
  */
 static VALUE connect(VALUE klass)
 {
-  dev_info * dev = nfc_connect();
+  nfc_device_t * dev = nfc_connect(NULL);
   if(!dev)
     rb_raise(rb_eRuntimeError, "could not find NFC device");
 
@@ -26,8 +28,8 @@ static VALUE connect(VALUE klass)
  */
 static VALUE disconnect(VALUE self)
 {
-  dev_info * dev;
-  Data_Get_Struct(self, dev_info, dev);
+  nfc_device_t * dev;
+  Data_Get_Struct(self, nfc_device_t, dev);
   nfc_disconnect(dev);
 
   return self;
@@ -41,12 +43,12 @@ static VALUE disconnect(VALUE self)
  */
 static VALUE configure(VALUE self, VALUE option, VALUE flag)
 {
-  dev_info * dev;
-  Data_Get_Struct(self, dev_info, dev);
+  nfc_device_t * dev;
+  Data_Get_Struct(self, nfc_device_t, dev);
 
   nfc_configure(
     dev,
-    (const dev_config_option)NUM2INT(option),
+    (const nfc_device_option_t)NUM2INT(option),
     (const bool)NUM2INT(flag)
   );
 
@@ -61,14 +63,29 @@ static VALUE configure(VALUE self, VALUE option, VALUE flag)
  */
 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);
+  nfc_device_t * dev;
+  nfc_modulation_t * mod;
+  nfc_target_t * ti;
+
+  Data_Get_Struct(self, nfc_device_t, dev);
+  Data_Get_Struct(tag, nfc_modulation_t, mod);
+
+  ti = (nfc_target_t *)calloc(1, sizeof(nfc_target_t));
+
+  if (nfc_initiator_select_passive_target(dev, *mod, NULL, 0, ti) ) {
+    switch(mod->nmt) {
+      case NMT_ISO14443A:
+        return Data_Wrap_Struct(cNfcISO14443A, 0, free, ti);
+        break;
+      case NMT_FELICA:
+        return Data_Wrap_Struct(cNfcFelica, 0, free, ti);
+        break;
+      default:
+        rb_raise(rb_eRuntimeError, "untested type: %d", mod->nmt);
+    }
+  }
+
+  return Qfalse;
 }
 
 /*
@@ -79,8 +96,8 @@ static VALUE dev_select(VALUE self, VALUE tag)
  */
 static VALUE name(VALUE self)
 {
-  dev_info * dev;
-  Data_Get_Struct(self, dev_info, dev);
+  nfc_device_t * dev;
+  Data_Get_Struct(self, nfc_device_t, dev);
 
   return rb_str_new2(dev->acName);
 }
@@ -93,16 +110,55 @@ static VALUE name(VALUE self)
  */
 static VALUE dev_deselect(VALUE self)
 {
-  dev_info * dev;
-  Data_Get_Struct(self, dev_info, dev);
+  nfc_device_t * dev;
+  Data_Get_Struct(self, nfc_device_t, dev);
 
-  nfc_initiator_deselect_tag(dev);
+  nfc_initiator_deselect_target(dev);
 
   return self;
 }
 
+static VALUE mod_initialize(VALUE self, VALUE type, VALUE baud)
+{
+  nfc_modulation_t * mod;
+
+  Data_Get_Struct(self, nfc_modulation_t, mod);
+  mod->nmt = NUM2INT(type);
+  mod->nbr = NUM2INT(baud);
+
+  return self;
+}
+
+static VALUE mod_alloc(VALUE klass)
+{
+  nfc_modulation_t * modulation;
+
+  modulation = xcalloc(1, sizeof(nfc_modulation_t));
+
+  return Data_Wrap_Struct(klass, NULL, xfree, modulation);
+}
+
+static VALUE mod_nmt(VALUE self)
+{
+  nfc_modulation_t * mod;
+
+  Data_Get_Struct(self, nfc_modulation_t, mod);
+
+  return INT2NUM(mod->nmt);
+}
+
+static VALUE mod_nbr(VALUE self)
+{
+  nfc_modulation_t * mod;
+
+  Data_Get_Struct(self, nfc_modulation_t, mod);
+
+  return INT2NUM(mod->nbr);
+}
+
 void init_device()
 {
+  VALUE cNfcModulation;
   VALUE cNfcDevice = rb_define_class_under(cNfc, "Device", rb_cObject);
 
   rb_define_singleton_method(cNfcDevice, "connect", connect, 0);
@@ -111,4 +167,21 @@ void init_device()
   rb_define_method(cNfcDevice, "select", dev_select, 1);
   rb_define_method(cNfcDevice, "deselect", dev_deselect, 0);
   rb_define_method(cNfcDevice, "name", name, 0);
+
+  cNfcModulation = rb_define_class_under(cNfcDevice, "Modulation", rb_cObject);
+
+  /* modulation types. */
+  rb_define_const(cNfcModulation, "NMT_ISO14443A", INT2NUM(NMT_ISO14443A));
+  rb_define_const(cNfcModulation, "NMT_FELICA", INT2NUM(NMT_FELICA));
+
+  /* baud rates */
+  rb_define_const(cNfcModulation, "NBR_UNDEFINED", INT2NUM(NBR_UNDEFINED));
+  rb_define_const(cNfcModulation, "NBR_106", INT2NUM(NBR_106));
+  rb_define_const(cNfcModulation, "NBR_212", INT2NUM(NBR_212));
+
+  rb_define_alloc_func(cNfcModulation, mod_alloc);
+
+  rb_define_method(cNfcModulation, "initialize", mod_initialize, 2);
+  rb_define_method(cNfcModulation, "nmt", mod_nmt, 0);
+  rb_define_method(cNfcModulation, "nbr", mod_nbr, 0);
 }

data/ext/nfc/nfc_felica.c

@@ -0,0 +1,62 @@
+#include <nfc_felica.h>
+
+VALUE cNfcFelica;
+
+/*
+ * size_t szLen;
+ * byte_t btResCode;
+ * byte_t abtId[8];
+ * byte_t abtPad[8];
+ * byte_t abtSysCode[2];
+ */
+
+static VALUE szLen(VALUE self)
+{
+  nfc_felica_info_t * tag;
+  Data_Get_Struct(self, nfc_felica_info_t, tag);
+
+  return INT2NUM(tag->szLen);
+}
+
+static VALUE btResCode(VALUE self)
+{
+  nfc_felica_info_t * tag;
+  Data_Get_Struct(self, nfc_felica_info_t, tag);
+
+  return INT2NUM(tag->btResCode);
+}
+
+static VALUE abtId(VALUE self)
+{
+  nfc_felica_info_t * tag;
+  Data_Get_Struct(self, nfc_felica_info_t, tag);
+
+  return rb_str_new(tag->abtId, 8 );
+}
+
+static VALUE abtPad(VALUE self)
+{
+  nfc_felica_info_t * tag;
+  Data_Get_Struct(self, nfc_felica_info_t, tag);
+
+  return rb_str_new(tag->abtPad, 8 );
+}
+
+static VALUE abtSysCode(VALUE self)
+{
+  nfc_felica_info_t * tag;
+  Data_Get_Struct(self, nfc_felica_info_t, tag);
+
+  return rb_str_new(tag->abtSysCode, 2 );
+}
+
+void init_felica()
+{
+  cNfcFelica = rb_define_class_under(cNfc, "Felica", rb_cObject);
+
+  rb_define_method(cNfcFelica, "szLen", szLen, 0);
+  rb_define_method(cNfcFelica, "btResCode", btResCode, 0);
+  rb_define_method(cNfcFelica, "abtId", abtId, 0);
+  rb_define_private_method(cNfcFelica, "abtPad", abtPad, 0);
+  rb_define_private_method(cNfcFelica, "abtSysCode", abtSysCode, 0);
+}

data/ext/nfc/nfc_felica.h

@@ -0,0 +1,10 @@
+#ifndef NFC_Felica
+#define NFC_Felica
+
+#include <nfc.h>
+
+extern VALUE cNfcFelica;
+
+void init_felica();
+
+#endif

data/ext/nfc/nfc_iso14443a.c

@@ -4,30 +4,30 @@ VALUE cNfcISO14443A;
 
 /*
  * call-seq:
- *  uiUidLen
+ *  szUidLen
  *
- * Get the uiUidLen
+ * Get the szUidLen
  */
-static VALUE uiUidLen(VALUE self)
+static VALUE szUidLen(VALUE self)
 {
-  tag_info_iso14443a * tag;
-  Data_Get_Struct(self, tag_info_iso14443a, tag);
+  nfc_iso14443a_info_t * tag;
+  Data_Get_Struct(self, nfc_iso14443a_info_t, tag);
 
-  return INT2NUM(tag->uiUidLen);
+  return INT2NUM(tag->szUidLen);
 }
 
 /*
  * call-seq:
- *  uiAtsLen
+ *  szAtsLen
  *
- * Get the uiAtsLen
+ * Get the szAtsLen
  */
-static VALUE uiAtsLen(VALUE self)
+static VALUE szAtsLen(VALUE self)
 {
-  tag_info_iso14443a * tag;
-  Data_Get_Struct(self, tag_info_iso14443a, tag);
+  nfc_iso14443a_info_t * tag;
+  Data_Get_Struct(self, nfc_iso14443a_info_t, tag);
 
-  return INT2NUM(tag->uiAtsLen);
+  return INT2NUM(tag->szAtsLen);
 }
 
 /*
@@ -38,10 +38,10 @@ static VALUE uiAtsLen(VALUE self)
  */
 static VALUE abtUid(VALUE self)
 {
-  tag_info_iso14443a * tag;
-  Data_Get_Struct(self, tag_info_iso14443a, tag);
+  nfc_iso14443a_info_t * tag;
+  Data_Get_Struct(self, nfc_iso14443a_info_t, tag);
 
-  return rb_str_new(tag->abtUid, tag->uiUidLen);
+  return rb_str_new(tag->abtUid, tag->szUidLen);
 }
 
 /*
@@ -52,10 +52,10 @@ static VALUE abtUid(VALUE self)
  */
 static VALUE abtAts(VALUE self)
 {
-  tag_info_iso14443a * tag;
-  Data_Get_Struct(self, tag_info_iso14443a, tag);
+  nfc_iso14443a_info_t * tag;
+  Data_Get_Struct(self, nfc_iso14443a_info_t, tag);
 
-  return rb_str_new(tag->abtAts, tag->uiAtsLen);
+  return rb_str_new(tag->abtAts, tag->szAtsLen);
 }
 
 /*
@@ -66,8 +66,8 @@ static VALUE abtAts(VALUE self)
  */
 static VALUE abtAtqa(VALUE self)
 {
-  tag_info_iso14443a * tag;
-  Data_Get_Struct(self, tag_info_iso14443a, tag);
+  nfc_iso14443a_info_t * tag;
+  Data_Get_Struct(self, nfc_iso14443a_info_t, tag);
 
   return rb_str_new(tag->abtAtqa, 2);
 }
@@ -80,8 +80,8 @@ static VALUE abtAtqa(VALUE self)
  */
 static VALUE btSak(VALUE self)
 {
-  tag_info_iso14443a * tag;
-  Data_Get_Struct(self, tag_info_iso14443a, tag);
+  nfc_iso14443a_info_t * tag;
+  Data_Get_Struct(self, nfc_iso14443a_info_t, tag);
 
   return INT2NUM(tag->btSak);
 }
@@ -90,8 +90,8 @@ 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, "szUidLen", szUidLen, 0);
+  rb_define_method(cNfcISO14443A, "szAtsLen", szAtsLen, 0);
   rb_define_method(cNfcISO14443A, "btSak", btSak, 0);
 
   rb_define_private_method(cNfcISO14443A, "abtUid", abtUid, 0);

data/lib/nfc.rb

@@ -3,13 +3,14 @@ require 'thread'
 require 'nfc/nfc'
 require 'nfc/device'
 require 'nfc/iso14443a'
+require 'nfc/felica'
 
 ###
 # 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 = '2.0.1'
+  VERSION = '2.1.0'
 
   include Singleton
 

data/lib/nfc/device.rb

@@ -5,6 +5,7 @@ class NFC
     DCO_ACTIVATE_FIELD        = 0x10
     DCO_INFINITE_LIST_PASSIVE = 0x20
 
-    IM_ISO14443A_106    = 0x00
+    IM_ISO14443A_106 = Modulation.new Modulation::NMT_ISO14443A,
+                                      Modulation::NBR_106
   end
 end

data/lib/nfc/felica.rb

@@ -0,0 +1,34 @@
+class NFC
+  class Felica
+
+    def uid
+      abtId.unpack 'C*'
+    end
+
+    def pad
+      abtPad.unpack 'C*'
+    end
+
+    def sys_code
+      abtSysCode.unpack 'C*'
+    end
+
+    def to_s join_string = ''
+      sprintf((['%02x'] * 8 ).join(join_string), * uid).upcase
+    end
+
+    def inspect
+# 78     printf("The following (NFC) Felica tag was found:\n\n");
+# 79     printf("%18s","ID (NFCID2): "); print_hex(ti.tif.abtId,8);
+# 80     printf("%18s","Parameter (PAD): "); print_hex(ti.tif.abtPad,8);
+      pad = sprintf( (['%02x'] * 8 ).join('  '), *self.pad) 
+      string_ary = [
+        "(NFC) Felica Tag",
+        "ID    (NFCID2): #{to_s '  '}",
+        "Parameter(PAD): #{pad}"
+      ]
+      string_ary.join "\n"
+    end
+
+  end
+end

data/lib/nfc/iso14443a.rb

@@ -21,7 +21,7 @@ class NFC
     ###
     # Get the UID as a hex string
     def to_s join_string = ''
-      sprintf((['%02x'] * uiUidLen).join(join_string), * uid).upcase
+      sprintf((['%02x'] * szUidLen).join(join_string), * uid).upcase
     end
 
     ###
@@ -33,8 +33,8 @@ class NFC
           "    UID (NFCID1): #{to_s '  '}",
           "   SAK (SEL_RES): #{sprintf("%02x", btSak)}"
         ]
-      if uiAtsLen > 0
-        ats = sprintf((['%02x'] * uiAtsLen).join('  '), *self.ats)
+      if szAtsLen > 0
+        ats = sprintf((['%02x'] * szAtsLen).join('  '), *self.ats)
         string_ary << "       ATS (ATR): #{ats}"
       end
       string_ary.join "\n"

metadata

@@ -1,42 +1,44 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: nfc
-version: !ruby/object:Gem::Version 
-  version: 2.0.1
+version: !ruby/object:Gem::Version
+  version: 2.1.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Aaron Patterson
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2009-09-19 00:00:00 -07:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-05-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: hoe
+  requirement: &2153398480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.9.4
   type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 2.3.3
-    version: 
-description: |-
-  NFC is a ruby wrapper for the Near Field Communication library.  The Near
+  prerelease: false
+  version_requirements: *2153398480
+description: ! 'NFC is a ruby wrapper for the Near Field Communication library.  The
+  Near
+
   Field Communication library works with many USB RFID readers, so this gem
-  lets you read RFID tags.
-email: 
-- aaronp@rubyforge.org
-executables: 
+
+  lets you read RFID tags.'
+email:
+- aaron@tenderlovemaking.com
+executables:
 - nfc
-extensions: 
+extensions:
 - ext/nfc/extconf.rb
-extra_rdoc_files: 
+extra_rdoc_files:
 - Manifest.txt
 - CHANGELOG.rdoc
 - README.rdoc
-files: 
+files:
 - .autotest
 - CHANGELOG.rdoc
 - Manifest.txt
@@ -48,41 +50,41 @@ files:
 - ext/nfc/nfc.h
 - ext/nfc/nfc_device.c
 - ext/nfc/nfc_device.h
+- ext/nfc/nfc_felica.c
+- ext/nfc/nfc_felica.h
 - ext/nfc/nfc_iso14443a.c
 - ext/nfc/nfc_iso14443a.h
 - lib/nfc.rb
 - lib/nfc/device.rb
+- lib/nfc/felica.rb
 - lib/nfc/iso14443a.rb
 - test/test_nfc.rb
-has_rdoc: true
+- .gemtest
 homepage: http://seattlerb.rubyforge.org
 licenses: []
-
 post_install_message: 
-rdoc_options: 
+rdoc_options:
 - --main
 - README.rdoc
-require_paths: 
+require_paths:
 - lib
-- ext
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: seattlerb
-rubygems_version: 1.3.5
+rubyforge_project: nfc
+rubygems_version: 1.8.2
 signing_key: 
 specification_version: 3
 summary: NFC is a ruby wrapper for the Near Field Communication library
-test_files: 
+test_files:
 - test/test_nfc.rb