Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

NFC is a ruby wrapper for the Near Field Communication library.

tree: 4e03d5343d

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 bin
Octocat-spinner-32 ext
Octocat-spinner-32 lib
Octocat-spinner-32 test
Octocat-spinner-32 .autotest
Octocat-spinner-32 CHANGELOG.rdoc
Octocat-spinner-32 Manifest.txt
Octocat-spinner-32 README.rdoc
Octocat-spinner-32 Rakefile
README.rdoc

NFC

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 (MIFARE) tags right now.

SYNOPSIS:

require 'nfc'

# 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.

  • libnfc

INSTALL:

First install libnfc. I installed libnfc via MacPorts like this:

$ sudo port install libnfc

The install the gem:

$ sudo gem install nfc

NOTE!!!! The nfc gem requires libnfc version 1.2.0 or greater!

LICENSE:

(The MIT License)

Copyright © 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.

Something went wrong with that request. Please try again.