split RFID::Bibio::Reader::Serial as base class

[Biblio-RFID.git] / lib / RFID / Biblio.pm

diff --git a/lib/RFID/Biblio.pm b/lib/RFID/Biblio.pm
index c7adf9e..1139a0c 100644 (file)
--- a/lib/RFID/Biblio.pm
+++ b/lib/RFID/Biblio.pm
@@ -6,16 +6,15 @@ use strict;
 use base 'Exporter';
 our @EXPORT = qw( hex2bytes as_hex hex_tag );
 
 use base 'Exporter';
 our @EXPORT = qw( hex2bytes as_hex hex_tag );
 

-use Device::SerialPort qw(:STAT);

 use Data::Dump qw(dump);
 
 =head1 NAME
 
 use Data::Dump qw(dump);
 
 =head1 NAME
 

-RFID::Biblio - support serial RFID devices
+RFID::Biblio - easy to use API for writing RFID enabled appliaction

 
 =cut
 
 
 =cut
 

-our $VERSION = '0.01';
+our $VERSION = '0.02';

 
 my $debug = 0;
 
 
 my $debug = 0;
 


@@ -25,92 +24,9 @@ my $debug = 0;
 This module tries to support USB serial RFID readers wsing simple API
 which is sutable for direct mapping to REST JSONP service.
 
 This module tries to support USB serial RFID readers wsing simple API
 which is sutable for direct mapping to REST JSONP service.
 

-Perhaps a little code snippet.
+For implementing application take a look at L<RFID::Biblio::Reader>

 
 

-    use RFID::Biblio;
-
-    my $rfid = RFID::Biblio->new(
-               device => '/dev/ttyUSB0', # with fallback to RFID_DEVICE
-       );
-       my $visible = $rfid->scan;
-
-=head1 SUBROUTINES/METHODS
-
-=head2 new
-
-=cut
-
-sub new {
-       my $class = shift;
-       my $self = {@_};
-       bless $self, $class;
-
-       $self->port;
-
-       $self->init;
-
-       return $self;
-}
-
-=head2 port
-
-  my $serial_obj = $self->port;
-
-=cut
-
-sub port {
-       my $self = shift;
-
-       return $self->{port} if defined $self->{port};
-
-       my $settings = $self->serial_settings;
-       my $device   = $settings->{device} ||= $ENV{RFID_DEVICE};
-       warn "# settings ",dump $settings;
-
-       if ( ! $device ) {
-               warn "# no device, serial port not opened\n";
-               return;
-       }
-
-       $self->{port} = Device::SerialPort->new( $settings->{device} )
-       || die "can't open serial port: $!\n";
-
-       $self->{port}->$_( $settings->{$_} )
-       foreach ( qw/handshake baudrate databits parity stopbits/ );
-
-}
-
-=head2 scan
-
-  my $visible = $rfid->scan;
-
-Returns hash with keys which match tag UID and values with blocks
-
-=cut
-
-sub scan {
-       my $self = shift;
-
-       warn "# scan tags in reader range\n";
-       my @tags = $self->inventory;
-
-       my $visible;
-       # FIXME this is naive implementation which just discards other tags
-       foreach my $tag ( @tags ) {
-               my $blocks = $self->read_blocks( $tag );
-               if ( ! $blocks ) {
-                       warn "ERROR: can't read tag $tag\n";
-                       delete $visible->{$tag};
-               } else {
-                       $visible->{$tag} = $blocks->{$tag};
-               }
-       }
-
-       return $visible;
-}
-
-
-=head1 MANDATORY IMPLEMENTATIONS
+=head1 READER IMPLEMENTATION

 
 Each reader must implement following hooks as sub-classes.
 
 
 Each reader must implement following hooks as sub-classes.
 


@@ -130,7 +46,7 @@ All blocks are under key which is tag UID with array of blocks returned from rea
 
   $hash = { 'E000000123456789' => [ 'blk1', 'blk2', ... ] };
 
 
   $hash = { 'E000000123456789' => [ 'blk1', 'blk2', ... ] };
 

-L<RFID::Biblio::3M810> sends tag UID with data payload, so we might expect
+L<RFID::Biblio::Reader::3M810> sends tag UID with data payload, so we might expect

 to receive response from other tags from protocol specification, 
 
 =head2 write_blocks
 to receive response from other tags from protocol specification, 
 
 =head2 write_blocks


@@ -203,15 +119,15 @@ Support for different RFID readers is implemented in subclasses:
 
 =head2 3M 810
 
 
 =head2 3M 810
 

-L<RFID::Biblio::3M810>
+L<RFID::Biblio::Reader::3M810>

 
 =head2 CPR-M02
 
 
 =head2 CPR-M02
 

-L<RFID::Biblio::CPRM02>
+L<RFID::Biblio::Reader::CPRM02>

 
 =head2 librfid
 
 
 =head2 librfid
 

-L<RFID::Biblio::librfid>
+L<RFID::Biblio::Reader::librfid>

 
 =head1 AUTHOR
 
 
 =head1 AUTHOR