phidget_rfid 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4bd085dc7bff0f4795a65b3b782dfb73425f836d
+  data.tar.gz: 13a7a824e52d5cf517b1c9ca79ec9ecf83f87fc3
+SHA512:
+  metadata.gz: bc6543af66cf7bbbca5c4d7904c637f2ce1c03e35c0062d2190789b6d5b4becf38434b7c5fea69ec1fc23f0792541cb3d30bba18d5a7d1671f6d5827278bf0a1
+  data.tar.gz: 0a89a8eeb24ff464ec5dbae77654085f136b4bbbcb31062091d512d86cd0dfef0df1d116dc8fa722a8eb1c177c2b9be921406d936d497c2bf66da7eedff99ee8

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.1
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in phidget_rfid.gemspec
+gemspec
+
+gem 'highline'
+gem 'cli-console'
+gem 'phidgets-ffi'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Luis Fontes
+
+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.md

@@ -0,0 +1,30 @@
+# PhidgetRfid
+
+This is a simple ruby program to work with the Phidget RFID in the console
+
+## Installation:
+
+gem install phitdget_rfid
+
+
+## Usage:
+```
+phitdget_rfid
+```
+
+And then you can use the help command
+
+```
+RFID> help
+   ------------------------------
+      read - Read RFID tag
+      write - Write into the RFID tag
+      protocol - Display RFID Tag
+      device - Display RFID Reader info
+      clear - Clear Console
+      log - RFID Log
+      help - Help
+      exit - Exit from program
+   You can type "help <command>" for more info
+   ------------------------------
+```

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/phidget_rfid

@@ -0,0 +1,40 @@
+#!/usr/bin/env ruby
+
+#require "bundler/setup"
+module PhidgetRfid
+
+  require 'highline'
+  require 'cli-console'
+  require "phidget_rfid"
+  require 'phidget_rfid/commands'
+
+  # You can add fixtures and/or initialization code here to make experimenting
+  # with your gem easier. You can also use a different console, if you like.
+
+  # (If you use this, don't forget to add pry to your Gemfile!)
+  # require "pry"
+  # Pry.start
+
+  #require "irb"
+  #IRB.start
+
+  Dir.chdir(File.dirname(__FILE__))
+
+  rfid = RfidHandler.new
+  io = HighLine.new
+  console = CLI::Console.new(io)
+  commands = Commands.new(rfid)
+
+
+  console.addCommand('read', commands.method(:read), 'Read RFID tag')
+  console.addCommand('write', commands.method(:write), 'Write into the RFID tag')
+  console.addCommand('protocol', commands.method(:protocol), 'Display RFID Tag')
+  console.addCommand('device', commands.method(:device), 'Display RFID Reader info')
+  console.addCommand('clear', commands.method(:clear), 'Clear Console')
+  console.addCommand('log', commands.method(:log), 'RFID Log')
+  console.addHelpCommand('help', 'Help')
+  console.addExitCommand('exit', 'Exit from program')
+  #console.addAlias('quit', 'exit')
+
+  console.start("%s> ",["RFID"])
+end

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/phidget_rfid.rb

@@ -0,0 +1,6 @@
+require 'phidgets-ffi'
+require 'phidget_rfid/rfid_handler'
+
+module PhidgetRfid
+
+end

data/lib/phidget_rfid/commands.rb

@@ -0,0 +1,69 @@
+module PhidgetRfid
+    class Commands
+
+    #Dir.chdir(params[0]) unless params.empty?
+
+
+        private
+        extend CLI::Task
+        
+        @rfid
+
+        public
+
+        def initialize (rfid)
+          @rfid = rfid
+        end
+      
+      
+        usage 'Usage: read'
+        desc 'Reads the value from the connected RFID tag'
+
+        def read(params)
+            puts @rfid.read
+        end
+
+
+
+        usage 'Usage: write "string to write" <protocol> <lock>'
+        desc 'Writes the provided text into the RFID tag. Protocols: EM4100, ISO11785_FDX_B, PhidgetTAG, 1'
+
+        def write(params)
+            puts @rfid.write params[0] unless params.empty?
+        end
+
+
+
+        usage 'Usage: protocol'
+        desc 'Displays the current tag protocol'
+
+        def protocol(params)
+            puts @rfid.protocol
+        end
+
+
+
+        usage 'Usage: clear'
+        desc 'Clears the console'
+        
+        def clear(params)
+          system "clear" or system "cls"
+        end
+
+        usage 'Usage: device'
+        desc 'Displays: reader id, serial number and state, Antenna and Led state. Library API version'
+        
+        def device(params)
+          puts @rfid.device
+        end
+        
+        usage 'Usage: log'
+        desc 'Shows the event log'
+        
+        def log(params)
+          puts @rfid.log
+        end
+
+
+    end
+end

data/lib/phidget_rfid/rfid_handler.rb

@@ -0,0 +1,83 @@
+module PhidgetRfid
+  class RfidHandler
+    @rfid
+    @prompt
+    @time
+    attr_accessor :log
+    
+    def initialize()
+      @rfid = Phidgets::RFID.new
+      @time = Time.new
+      @prompt = "at #{@time.strftime("%Y-%m-%d %H:%M:%S")} \033[0m"
+      @log = ""
+      
+      @rfid.on_detach  do |device, obj|
+        @log.append "\n#{device.attributes.inspect} removed"
+      end
+      
+      @rfid.on_attach  do |device, obj|
+        @rfid.antenna = true
+        @rfid.led = false
+      end
+      
+      @rfid.on_error do |device, obj, code, description|
+        @log << "\033[31m\nError #{code}: #{description} #{@prompt}" 
+      end
+      
+      @rfid.on_tag  do |device, tag, obj|
+        @rfid.led = true
+        @log << "\n\033[32m[+] #{protocol} tag detected #{@prompt}" 
+      end
+      
+      @rfid.on_tag_lost do |device, tag, obj|
+        @rfid.led = false
+        @log << "\n\033[33m[-] #{protocol} tag removed #{@prompt}"
+      end
+      
+      
+    end
+    
+    def protocol
+      if(@rfid.attached?)
+        @rfid.last_tag_protocol
+      end
+    end
+    
+    def read
+      if(@rfid.attached?)
+        @rfid.last_tag
+      end
+    end
+    
+    def write(value, protocol = @rfid.last_tag_protocol, lock = false)
+      if(@rfid.attached?)
+        p = protocol.to_sym
+
+        if lock
+          puts "Data: #{value}"
+          puts "Protocol: #{p}"
+          puts "Are you sure you want to lock the RFID Tag? This will make it read-only (y/N)"
+          r = gets.chomp
+          @rfid.write value, p, true if r == "y"
+
+        end
+
+      end
+    end
+    
+    def device
+      puts "Library Version: #{Phidgets::FFI.library_version}"
+      puts "Class: #{device.device_class}"
+      puts "Id: #{device.id}"
+      puts "Serial number: #{device.serial_number}"
+      puts "# Digital Outputs: #{device.outputs.size}"
+    end
+    
+    
+      
+  end
+
+end
+
+
+

data/lib/phidget_rfid/version.rb

@@ -0,0 +1,3 @@
+module PhidgetRfid
+  VERSION = "0.1.0"
+end

data/phidget_rfid.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'phidget_rfid/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "phidget_rfid"
+  spec.version       = PhidgetRfid::VERSION
+  spec.authors       = ["Luis Fontes"]
+  spec.email         = ["mail.fontes@gmail.com"]
+
+  spec.summary       = %q{PHIDGET RFID wrapper}
+  spec.description   = %q{A simple console app to work with PHIDGET RFID.}
+  spec.homepage      = "https://github.com/luisfontes19/phidget_rfid"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org/"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "bin"
+  spec.executables   = 'phidget_rfid'
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_runtime_dependency "highline"
+  spec.add_runtime_dependency "cli-console"
+  spec.add_runtime_dependency "phidgets-ffi"
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: phidget_rfid
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Luis Fontes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: cli-console
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: phidgets-ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A simple console app to work with PHIDGET RFID.
+email:
+- mail.fontes@gmail.com
+executables:
+- phidget_rfid
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/phidget_rfid
+- bin/setup
+- lib/phidget_rfid.rb
+- lib/phidget_rfid/commands.rb
+- lib/phidget_rfid/rfid_handler.rb
+- lib/phidget_rfid/version.rb
+- phidget_rfid.gemspec
+homepage: https://github.com/luisfontes19/phidget_rfid
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.7
+signing_key: 
+specification_version: 4
+summary: PHIDGET RFID wrapper
+test_files: []