rfid4r 1.0.0-x86-linux

data/lib/event_handler/rfid_server.rb

@@ -0,0 +1,300 @@
+require 'webrick'
+require 'rubygems'
+require 'sqlite3'
+require 'readers_adapter/phidget_rfid_reader'
+require 'inteface_aplication/rfid_interface_client'
+
+#
+# La clase RfidServer representa el manejador de eventos del Middleware RFID, 
+# para el manejo de los eventos generados por las capturas de etiquetas RFID.
+# RfidServer es una clase concreta de la clase WEBrick::GenericServer que 
+# implementa un servidor para el manejo de un lector RFID. Adicionalmente 
+# recibe comandos que permiten consultar, registrar y liberar el lector RFID, 
+# asi como tambien comandos para consultar la base de datos SQLite de eventos 
+# RFID.
+#
+class RfidServer < WEBrick::GenericServer
+  # Representa una referencia a una interfaz cliente para consultas hacia otros 
+  # servidores RFID
+  attr_reader :interface_client
+  # Referencia al lector RFID conectado al servidor 
+  attr_reader :reader
+  # Referencia logica para la presencia o no del lector RFID
+  attr_reader :is_attach
+  # Referencia logica para la activacion o no del muestreo de eventos RFID
+  attr_reader :active
+  # Referencia logica para la activacion o no del muestreo de eventos RFID remoto
+  attr_reader :active_remote
+  # Referencia al tiempo de espera para conectar el lector RFID
+  attr_reader :timeout
+  # Representa una referencia al monitor de enventos le lectura de tags RFID
+  attr_reader :verbose
+  # Representa una referencia al monitor de enventos le lectura de tags RFID remoto
+  attr_reader :verbose_remote
+  # Referencia a un semaforo de sincronizacion de captura de eventos RFID
+  attr_reader :mutex
+  
+  #
+  # Crea un nuevo servidor RFID utilizando el archivo de configuracion 
+  # "rfid_config.yml", adicionalmente instancia la base de datos SQLite de 
+  # eventos para su uso porterior.
+  #
+  def initialize(config={}, default=WEBrick::Config::General)
+    @interface_client =     RfidInterfaceClient.new
+    p =                     @interface_client.config["local_config"]["port"]
+    ip =                    @interface_client.config["local_config"]["ip_address"]
+    @timeout =              @interface_client.config["local_config"]["timeout"]
+    config[:Port] =         p unless p.nil?
+    config[:BindAddress] =  ip unless ip.nil?
+    @is_attach =            false
+    @active =               false
+    @active_remote =        false
+    @mutex =                Mutex.new
+    super
+    @db =                   SQLite3::Database.new('rfid_events.db')
+  end
+  
+  #
+  # Recibe y procesa los comandos, a continuacion se muestra una lista de los comandos soportados 
+  # y una breve descripcion de su funcion:
+  #
+  #   attach:       		Attach a new RFID reader
+  #   detach:       		Detach the RFID reader
+  #   ls|list|reader:   	Serial of RFID reader
+  #   n|name:       		Name of RFID reader 
+  #   t|type:       		Type of RFID reader
+  #   version:       		Version of RFID reader
+  #   verbose:   		Initialize the observer of RFID events 
+  #   stop:	   		Stop the observer of RFID events
+  #   server:       		List all servers 
+  #   set [id_of_server]:	Change the current server
+  #   current:   		Show the current server selected
+  #   select [SQL]:     	Consulta de tipo SQL a la base de datos SQLite
+  #   quit|close|exit:  	Close the connection with de server
+  #
+  def run(sock)
+    while true
+      cmd = sock.gets
+      case cmd
+        when /\bclose|exit|quit\W/
+        sock.print "Shutting down..."
+        break
+        # ************************* servers ******************************
+        when /\bservers\W/
+        if @interface_client.servers>0
+          @interface_client.config.each do |key, value| 
+            sock.print "Server: #{key} #{value["ip_address"]}:#{value["port"]}, Id of server: #{value["id_server"]}\n"
+          end
+        else
+          sock.print "ERROR: No Server Found!\n"
+        end
+        # ************************* current server ******************************
+        when /\bcurrent\W/
+        server_name = @interface_client.id_server
+        sock.print "Server: #{server_name} #{@interface_client.config[server_name]["ip_address"]}:#{@interface_client.config[server_name]["port"]} , Id of server: #{@interface_client.config[server_name]["id_server"]}\n"
+        # ************************* set server ******************************
+        when /\bset\s+([0-9A-Za-z])+/
+        if @interface_client.servers>0
+          @interface_client.set_server(sock,cmd.split(/\s/)[1])
+        else
+          sock.print "ERROR: No Server Found!\n"
+        end
+        # ************************* attach **********************************
+        when /\battach\W(\s*-r)?/
+        if @interface_client.id_server.eql?("local_config")
+          if !@is_attach
+            begin
+              @reader = PhidgetRfidReader.new(@timeout)
+              @is_attach = true
+              sock.print "Device #{@reader.serial} found!\n"
+            rescue Exception => e
+              sock.print "ERROR: #{e}\n"
+            end
+          else
+            sock.print "ERROR: An RFID reader is attached!\n"
+          end
+        elsif @interface_client.servers>0
+          @interface_client.single_consult(sock,"attach -r\n")
+        end
+        if cmd.split(/\s/)[1].eql?("-r")
+          break
+        end
+        # ************************* ls|list|reader **********************************
+        when /\bls|list|reader\W(\s*-r)?/
+        if @interface_client.id_server.eql?("local_config")
+          if @is_attach
+            sock.print "#{@reader.serial}\n"
+          else
+            sock.print "ERROR: No device found!\n"
+          end
+        elsif @interface_client.servers>0
+          @interface_client.single_consult(sock,"ls -r\n")
+        end
+        if cmd.split(/\s/)[1].eql?("-r")
+          break
+        end
+        # ************************* name **********************************
+        when /\bn|name\W(\s*-r)?/
+        if @interface_client.id_server.eql?("local_config")
+          if @is_attach
+            sock.print "#{@reader.name}\n"
+          else
+            sock.print "ERROR: No device found!\n"
+          end
+        elsif @interface_client.servers>0
+          @interface_client.single_consult(sock,"n -r\n")
+        end
+        if cmd.split(/\s/)[1].eql?("-r")
+          break
+        end
+        # ************************* type **********************************
+        when /\bt|type\W(\s*-r)?/
+        if @interface_client.id_server.eql?("local_config")
+          if @is_attach
+            sock.print "#{@reader.type}\n"
+          else
+            sock.print "ERROR: No device found!\n"
+          end
+        elsif @interface_client.servers>0
+          @interface_client.single_consult(sock,"t -r\n")
+        end
+        if cmd.split(/\s/)[1].eql?("-r")
+          break
+        end
+        # ************************* version **********************************
+        when /\bversion\W(\s*-r)?/
+        if @interface_client.id_server.eql?("local_config")
+          if @is_attach
+            sock.print "#{@reader.version}\n"
+          else
+            sock.print "ERROR: No device found!\n"
+          end
+        elsif @interface_client.servers>0
+          @interface_client.single_consult(sock,"version -r\n")
+        end
+        if cmd.split(/\s/)[1].eql?("-r")
+          break
+        end
+        # ************************* detach **********************************
+        when /\bdetach\W(\s*-r)?/
+        if @interface_client.id_server.eql?("local_config")
+          if @is_attach
+            @reader.delete
+            @is_attach = false
+            if @active
+              @verbose.exit
+              @active = false
+            end
+            sock.print "Device #{@reader.serial} detached!\n"
+          else
+            sock.print "ERROR: No device found!\n"
+          end
+        elsif @interface_client.servers>0
+          @interface_client.single_consult(sock,"detach -r\n")
+        end
+        if cmd.split(/\s/)[1].eql?("-r")
+          break
+        end
+        # ************************* detachall **********************************
+        # when /\bdetachall\W/
+        # @readers.each do |s,r|
+        #   sock.print "Device #{r.serial} detached!\n"
+        #   r.delete
+        # end
+        # @readers.clear
+        # ************************* consult **********************************
+        when /\bconsult/
+        @db.execute(cmd.split("consult")[1]) do |row|
+          row.each do |col|
+            sock.print "#{col.to_s};"
+          end
+          sock.print "\n"
+        end
+        break
+        # ************************* select SQL **********************************
+        when /\bselect/
+        begin
+          if @interface_client.id_server.eql?("local_config")
+            @db.execute(cmd) do |row|
+              row.each do |col|
+                sock.print "#{col.to_s};"
+              end
+              sock.print "\n"
+            end
+          elsif @interface_client.servers>0
+            @interface_client.consult(sock,"consult #{cmd}")
+          end
+        rescue SQLite3::SQLException => e
+          sock.print "ERROR: #{e}\n"
+        rescue Exception => e
+          sock.print "ERROR: #{e}\n"
+        end
+        # ******************** Mostrar eventos a cierta frecuencia ************************
+        when /\bverbose\W(\s*-r)?/
+        if @interface_client.id_server.eql?("local_config")
+          if !@active and @is_attach
+            @active = true
+            tag = 0
+            opt = cmd.split(' ')[1]
+            @verbose = Thread.new(opt) do
+              while true
+                if @reader.count > tag
+                  tag = @reader.count
+                  sock.print "Reader:#{@reader.serial} #{@reader.lastTag()}\n" 
+                elsif !@active
+                  sock.print "MESSAGE: Stop Verbose\n"
+                  break
+                else
+                  sock.print " "
+                end
+                sleep(0.1)
+              end
+            end
+          end
+        elsif @interface_client.servers>0
+          if !@active_remote
+            @active_remote = true
+            @verbose_remote = Thread.new do
+              @interface_client.consult(sock,"verbose -r -r")
+            end
+          end
+        end
+        # ************************* Parar Muestreo **********************************
+        when /\bstop\W(\s*-r)?/
+        if @interface_client.id_server.eql?("local_config")
+          if @active
+            #sock.print "MESSAGE: Stop Verbose\n"
+            @active = false
+            #@verbose.exit
+          end
+        elsif @interface_client.servers>0
+          if @active_remote
+            @interface_client.single_consult(sock,"stop -r\n")
+            #@verbose_remote.exit
+            @active_remote = false
+          end
+        end
+        if cmd.split(/\s/)[1].eql?("-r")
+          break
+        end
+        # ************************* h|help **********************************
+        when /\bh|help\W/
+        sock.print "attach:             Attach a new RFID reader\n"
+        sock.print "detach:             Detach the RFID reader\n"
+        sock.print "ls|list|reader:     Serial of RFID reade\n"
+        sock.print "n|name:             Name of RFID reader\n"
+        sock.print "t|type:             Type of RFID reader\n"
+        sock.print "version:            Version of RFID reader\n"
+        sock.print "verbose:            Initialize the observer of RFID events\n"
+        sock.print "stop:               Stop the observer of RFID events\n"
+        sock.print "server:             List all servers\n"
+        sock.print "set [id_of_server]: Change the current server\n"
+        sock.print "current:            Show the current server selected\n"
+        sock.print "select [SQL]:       Consulta de tipo SQL a la base de datos SQLite\n"
+        sock.print "quit|close|exit:    Close the connection with de server\n"
+      else
+        sock.print "ERROR: Unknown command! Type h or help for Help\n"
+      end
+    end
+  end
+end

data/lib/inteface_aplication/rfid_config.yml

@@ -0,0 +1,10 @@
+local_config:
+  id_server: 0
+  ip_address: 127.0.0.1
+  port: 8004
+  timeout: 5000
+
+server1:
+  id_server: 1
+  ip_address: 127.0.0.1
+  port: 8000

data/lib/inteface_aplication/rfid_interface_client.rb

@@ -0,0 +1,84 @@
+require 'net/telnet'
+require 'rubygems'
+require 'yaml'
+
+#
+# La clase RfidInterfaceClient representa una interfaz para un cliente Telnet genérico
+#
+class RfidInterfaceClient 
+  # Referencia a un hash de parámetros de configuración
+  attr_reader :config
+  # Referencia a cantidad de servidores instanciados
+  attr_reader :servers
+  # Representa el identificado del servidor actualmente en uso
+  attr_reader :id_server
+  
+  #
+  # Crea una nueva interfaz para un cliente Telnet genérico, a partir de los parámetros 
+  # de configuración obtenidos desde el archivo "rfid_config.yml"
+  #
+  def initialize(yml='rfid_config.yml')
+    parse =     YAML::parse(File.open(yml))
+    @config =   parse.transform
+    @id_server =  "local_config"
+    @servers =  0
+    @config.each do |key, value| 
+      if key.include?("server")
+        @servers = @servers + 1
+      end
+    end
+  end
+  
+  #
+  # Ejecuta un comando y recibe una o más respuestas, imprimiéndola(s) en el socket
+  #
+  def consult(sock,cmd)
+    begin
+      conection = Net::Telnet::new("Host" => @config[@id_server]["ip_address"].to_s,"Timeout" => 5,"Port" => @config[@id_server]["port"])
+      sock.print "MESSAGE: Server "+@config[@id_server]["ip_address"].to_s+":"+@config[@id_server]["port"].to_s+"\n"
+      conection.cmd("#{cmd.chop}") do |response|
+        sock.print response.to_s
+        if response.to_s.include?("Stop Verbose")
+         conection.puts("exit")
+        end
+      end
+    rescue Exception => e
+      sock.print "ERROR: Couldn't establish the conexion!\n"
+    end
+  end
+  
+  #
+  # Ejecuta un comando y recibe una respuesta, imprimiéndola en el socket
+  #
+  def single_consult(sock,cmd)
+    begin
+      conection = Net::Telnet::new("Host" => @config[@id_server]["ip_address"].to_s,"Timeout" => 5,"Port" => @config[@id_server]["port"])
+      sock.print "MESSAGE: Server "+@config[@id_server]["ip_address"].to_s+":"+@config[@id_server]["port"].to_s+"\n"
+      conection.puts("#{cmd.chop}") 
+      sock.print conection.gets
+      #conection.close
+    rescue
+      sock.print "ERROR: Couldn't establish the conexion!\n"
+    end
+  end
+
+  #
+  # Permite cambiar el servidor al cual seran dirigidos los comandos
+  # y consultas
+  #
+  def set_server(sock, id)
+     change = false
+     @config.each do |key, value| 
+          if value["id_server"].to_s.eql?(id)
+           change = true    
+           @id_server = key
+	   sock.print "MESSAGE: Change to Server #{id} Complete!\n"
+	   break
+          end
+      end
+      if !change
+        sock.print "ERROR: No Server Found!\n"
+      end
+  end
+  
+end

data/lib/readers_adapter/phidget_rfid_reader.rb

@@ -0,0 +1,84 @@
+require 'phid'
+require 'readers_adapter/rfid_reader'
+require 'observer'
+
+# 
+# PhidgetRfidReader es una clase concreta de la clase RfidReader que define en 
+# detalle la estructura de los metodos de un lector RFID.
+#
+class PhidgetRfidReader < RfidReader
+  # El modulo Phid encapsula el wrapper de lector RFID PhidgetRFID-1023.
+  include Phid
+  
+  #
+  # Crea un nuevo lector RFID con sus atributos básicos. 
+  # Adicionalmente maneja un log de registro de eventos de lecturas de 
+  # etiquetas RFID, estos eventos son almacenados en una base de datos SQLite a 
+  # la vez que son leidos por el lector RFID.
+  #
+  def initialize(timeout=10,log='phid.log', dbname='rfid_events.db')
+    begin
+      rfid_create(dbname)
+      result = wait_attachment(timeout)
+      if result != 0
+        raise get_error_description(result)
+      end
+      super(get_device_name, get_device_type, get_serial_number, get_device_version)
+      puts "Device #{name}::#{serial} Found!\n"
+      log_message("#{self}", "Device #{name}::#{serial} Found!\n")
+      enable_loggin("#{serial}-#{log}")
+      turn_antenna_on
+    rescue Exception => e
+        puts "ERROR: #{e}"
+        raise get_error_description(result)
+    end
+  end
+  
+  #
+  # Activa o desactiva la antena del lector RFID.
+  #
+  def antenna(set)
+    if set
+      turn_antenna_on
+    else
+      turn_antenna_off
+    end
+  end
+  
+  #
+  # Muestra por salida estandar las propiedas básicas del lector RFID, como 
+  # nombre, tipo, serial y versión.
+  #
+  def properties
+    puts "Device Name: #{name}\n"
+    puts "Device Type: #{type}\n"
+    puts "Device Serial: #{serial}\n"
+    puts "Device Version: #{version}\n"
+  end
+  
+  #
+  # Elimina el lector RFID mostrando un aviso de notificacion, con lo cual se 
+  # dejara de detectar las etiquetas RFID. Adicionalmente, este evento es 
+  # almacenado en el log de registro y en la base de datos SQLite.
+  #
+  def delete
+    puts "Device #{name}::#{serial} Dettached!\n"
+    log_message("#{self}", "Device #{name}::#{serial} Dettached!\n")
+    rfid_delete
+  end
+  
+  #
+  # Retorna el último ID leído por el lector.
+  #
+  def lastTag
+    get_lastTag
+  end
+  
+  #
+  # Retorna el número de eventos de lectura registrados por el lector.
+  #
+  def count
+    count_tags
+  end
+  
+end

data/lib/readers_adapter/rfid_reader.rb

@@ -0,0 +1,40 @@
+# 
+# La clase RfidReader encapsula la estructura básica de los metodos de un 
+# lector RFID. Las subclases deberan redefinir los metodos sin cambiar su 
+# estructura.
+#
+class RfidReader
+  # Referencia al nombre del lector RFID
+  attr_accessor :name
+  # Referencia al tipo de lector RFID
+  attr_accessor :type
+  # Referencia al serial unico del lector RFID
+  attr_accessor :serial
+  # Referencia a la versión del lector RFID
+  attr_accessor :version
+  
+  #
+  # Crea un nuevo lector RFID con sus atributos básicos. 
+  #
+  def initialize(name, type, serial, version)
+    @name=name
+    @type=type
+    @serial=serial
+    @version=version
+  end
+
+  #
+  # Muestra las propiedas básicas del lector RFID, como nombre, tipo, serial 
+  # y/o versión.
+  #
+  def properties
+  end
+  
+  #
+  # Elimina el lector RFID, con lo cual se dejara de detectar las etiquetas 
+  # RFID.
+  #
+  def delete
+  end
+
+end

data/lib/rfid4r.rb

@@ -0,0 +1,32 @@
+require 'event_handler/rfid_server'
+
+# 
+# La clase Rfid4r implementa directamente el servidor RFID de la clase 
+# RfidServer.
+#
+class Rfid4r
+  # Referencia al servidor RFID
+  attr_reader :server
+
+  # Instancia e inicia automaticamente los servicios del servidor RFID.
+  # Un ejemplo sencillo de uso de esta clase se muestra a continuacion:
+  #   
+  #   require 'rubygems'
+  #   require 'rfid4r'
+  #   r = Rfid4r.new
+  #   r.init
+  #  se obtiene:
+  #   [2008-10-03 12:34:48] INFO  WEBrick 1.3.1
+  #   [2008-10-03 12:34:48] INFO  ruby 1.8.6 (2008-08-08) [i686-linux]
+  #   [2008-10-03 12:34:48] INFO  RfidServer#start: pid=6394 port=8004
+  def init	
+   @server = RfidServer.new()
+   trap("INT"){ @server.shutdown }
+   @server.start
+  end
+
+  def stop
+    @server.shutdown
+  end
+end
+

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: rfid4r
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: x86-linux
+authors: 
+- "Daniel Gonz\xC3\xA1lez & Joel Ojeda"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-10-27 00:00:00 -04:30
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: sqlite3-ruby
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.4
+    version: 
+description: 
+email: dangt85@gmail.com & ojeda.joel@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- ext/phid.so
+- ext/phid.h
+- ext/phid_wrap.c
+- ext/extconf.rb
+- ext/Makefile
+- ext/phid.i
+- lib/readers_adapter
+- lib/readers_adapter/rfid_reader.rb
+- lib/readers_adapter/phidget_rfid_reader.rb
+- lib/inteface_aplication
+- lib/inteface_aplication/rfid_interface_client.rb
+- lib/inteface_aplication/rfid_config.yml
+- lib/rfid4r.rb
+- lib/phid.so
+- lib/event_handler
+- lib/event_handler/rfid_server.rb
+- README.rdoc
+has_rdoc: true
+homepage: http://rfid4r.rubyforge.org
+post_install_message: 
+rdoc_options: []
+
+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: rfid4r
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: An RFID middleware using a Ruby wrapper for the PhidgetRFID-1023 reader.
+test_files: []
+