nfc 1.0.0

data/.autotest

@@ -0,0 +1,23 @@
+# -*- ruby -*-
+
+require 'autotest/restart'
+
+# Autotest.add_hook :initialize do |at|
+#   at.extra_files << "../some/external/dependency.rb"
+#
+#   at.libs << ":../some/external"
+#
+#   at.add_exception 'vendor'
+#
+#   at.add_mapping(/dependency.rb/) do |f, _|
+#     at.files_matching(/test_.*rb$/)
+#   end
+#
+#   %w(TestA TestB).each do |klass|
+#     at.extra_class_map[klass] = "test/test_misc.rb"
+#   end
+# end
+
+# Autotest.add_hook :run_command do |at|
+#   system "rake build"
+# end

data/CHANGELOG.rdoc

@@ -0,0 +1,6 @@
+=== 1.0.0 / 2009-06-01
+
+* 1 major enhancement
+
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,9 @@
+.autotest
+CHANGELOG.rdoc
+Manifest.txt
+README.rdoc
+Rakefile
+bin/nfc
+lib/nfc.rb
+lib/nfc/lib_nfc.rb
+test/test_nfc.rb

data/README.rdoc

@@ -0,0 +1,57 @@
+= NFC
+
+* http://seattlerb.rubyforge.org
+
+== 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.
+
+== FEATURES/PROBLEMS:
+
+* Only supports ISO1443A tags (MIFARE) tags right now.
+
+== SYNOPSIS:
+
+  require 'nfc'
+
+  # Read your tag and print the info
+  p NFC.instance.find
+
+== 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
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Aaron Patterson
+
+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/Rakefile

@@ -0,0 +1,16 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+$: << "lib"
+require 'nfc'
+
+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']
+end
+
+# vim: syntax=Ruby

data/bin/nfc

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'nfc'
+nfc = NFC.instance
+
+puts "Connected to NFC reader: #{nfc.device.name}"
+puts
+p nfc.find

data/lib/nfc.rb

@@ -0,0 +1,60 @@
+require 'singleton'
+require 'nfc/lib_nfc'
+
+class NFC
+  VERSION = '1.0.0'
+
+  attr_reader :device
+
+  include Singleton
+
+  def initialize
+    @device = NFC::LibNFC::Device.new(NFC::LibNFC.nfc_connect)
+    LibNFC.nfc_reader_init(@device.pointer)
+  end
+
+  def deactivate_field
+    LibNFC.nfc_configure @device.pointer, LibNFC::DCO_ACTIVATE_FIELD, 0
+  end
+
+  def activate_field
+    LibNFC.nfc_configure @device.pointer, LibNFC::DCO_ACTIVATE_FIELD, 1
+  end
+
+  def crc= value
+    LibNFC.nfc_configure @device.pointer, LibNFC::DCO_HANDLE_CRC, value ? 1 : 0
+  end
+
+  def parity= v
+    LibNFC.nfc_configure @device.pointer, LibNFC::DCO_HANDLE_PARITY, v ? 1 : 0
+  end
+
+  def infinite_list_passive= v
+    LibNFC.nfc_configure(
+      @device.pointer,
+      LibNFC::DCO_INFINITE_LIST_PASSIVE,
+      v ? 1 : 0
+    )
+  end
+
+  def poll_mifare
+    thing = LibNFC::ISO1443A.new
+    LibNFC.nfc_reader_list_passive(
+      @device.pointer,
+      LibNFC::IM_ISO14443A_106,
+      nil,
+      0,
+      thing
+    )
+    thing
+  end
+
+  def find
+    deactivate_field
+    self.infinite_list_passive = false
+    self.crc = true
+    self.parity = true
+    activate_field
+    poll_mifare
+  end
+end

data/lib/nfc/lib_nfc.rb

@@ -0,0 +1,66 @@
+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

data/test/test_nfc.rb

@@ -0,0 +1,39 @@
+require "test/unit"
+require "nfc"
+
+class TestNFC < Test::Unit::TestCase
+  def setup
+    @nfc = NFC.instance
+  end
+
+  def test_connect
+    assert_not_nil @nfc.device
+  end
+
+  def test_deactivate_field
+    @nfc.deactivate_field
+  end
+
+  def test_activate_field
+    @nfc.activate_field
+  end
+
+  def test_crc=
+    @nfc.crc = true
+    @nfc.crc = false
+  end
+
+  def test_parity=
+    @nfc.parity = true
+    @nfc.parity = false
+  end
+
+  def test_infinite_list_passive=
+    @nfc.infinite_list_passive = true
+    @nfc.infinite_list_passive = false
+  end
+
+  def test_poll_mifare
+    thing = @nfc.poll_mifare
+  end
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification 
+name: nfc
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Aaron Patterson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-01 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
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.12.1
+    version: 
+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: 
+- nfc
+extensions: []
+
+extra_rdoc_files: 
+- Manifest.txt
+- CHANGELOG.rdoc
+- README.rdoc
+files: 
+- .autotest
+- CHANGELOG.rdoc
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- bin/nfc
+- lib/nfc.rb
+- lib/nfc/lib_nfc.rb
+- test/test_nfc.rb
+has_rdoc: true
+homepage: http://seattlerb.rubyforge.org
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+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: 
+requirements: []
+
+rubyforge_project: nfc
+rubygems_version: 1.3.3
+signing_key: 
+specification_version: 3
+summary: NFC is a ruby wrapper for the Near Field Communication library
+test_files: 
+- test/test_nfc.rb