add link to RFID501

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

diff --git a/lib/RFID/Biblio.pm b/lib/RFID/Biblio.pm
index 1139a0c..78341da 100644 (file)
--- a/lib/RFID/Biblio.pm
+++ b/lib/RFID/Biblio.pm
@@ -10,7 +10,7 @@ use Data::Dump qw(dump);
 
 =head1 NAME
 
-RFID::Biblio - easy to use API for writing RFID enabled appliaction
+RFID::Biblio - perl tools to use different RFID readers for library use 
 
 =cut
 
@@ -19,51 +19,47 @@ our $VERSION = '0.02';
 my $debug = 0;
 
 
-=head1 SYNOPSIS
+=head1 DESCRIPTION
 
-This module tries to support USB serial RFID readers wsing simple API
-which is sutable for direct mapping to REST JSONP service.
+Main idea is to develop simple API to reader, and than provide useful
+abstractions on top of it to quickly write applications to respond on
+tags which come in range of RFID reader using L<RFID::Biblio::Reader>.
 
-For implementing application take a look at L<RFID::Biblio::Reader>
-
-=head1 READER IMPLEMENTATION
-
-Each reader must implement following hooks as sub-classes.
-
-=head2 init
-
-  $self->init;
-
-=head2 inventory
-
-  my @tags = $self->invetory;
-
-=head2 read_blocks
+Writing support for new RFID readers should be easy.
+L<RFID::Biblio::Reader::API> provides documentation on writing support
+for different readers.
 
-  my $hash = $self->read_blocks( $tag );
+Currently, two serial RFID readers based on L<RFID::Biblio::Reader::Serial>
+are implemented:
 
-All blocks are under key which is tag UID with array of blocks returned from reader
+=over 4
 
-  $hash = { 'E000000123456789' => [ 'blk1', 'blk2', ... ] };
+=item *
 
-L<RFID::Biblio::Reader::3M810> sends tag UID with data payload, so we might expect
-to receive response from other tags from protocol specification, 
+L<RFID::Biblio::Reader::3M810>
 
-=head2 write_blocks
+=item *
 
-  $self->write_blocks( $tag => $bytes );
+L<RFID::Biblio::Reader::CPRM02>
 
-  $self->write_blocks( $tag => [ 'blk1', 'blk2', ... ] );
+=back
 
-=head2 read_afi
+There is also simple read-only reader using shell commands in
+L<RFID::Biblio::Reader::librfid>.
 
-  my $afi = $self->read_afi( $tag );
+For implementing application take a look at L<RFID::Biblio::Reader>
 
-=head2 write_afi
+C<scripts/RFID-JSONP-server.pl> is example of such application. It's local
+interface to RFID reader and JSONP REST server.
 
-  $self->write_afi( $tag => $afi );
+C<examples/koha-rfid.js> is jQuery based JavaScript code which can be inserted
+in Koha Library System to provide overlay with tags in range and
+check-in/check-out form-fill functionality.
 
+Applications can use L<RFID::Biblio::RFID501> which is some kind of
+semi-standard 3M layout or blocks on RFID tags.
 
+=for readme stop
 
 =head1 EXPORT
 
@@ -112,10 +108,9 @@ sub as_hex {
 
 sub hex_tag { uc(unpack('H16', shift)) }
 
+=for readme continue
 
-=head1 SUPPORTED READERS
-
-Support for different RFID readers is implemented in subclasses:
+=head1 HARDWARE SUPPORT
 
 =head2 3M 810
 
@@ -129,13 +124,16 @@ L<RFID::Biblio::Reader::CPRM02>
 
 L<RFID::Biblio::Reader::librfid>
 
+
 =head1 AUTHOR
 
 Dobrica Pavlinusic, C<< <dpavlin at rot13.org> >>
 
+L<http://blog.rot13.org/>
+
 =head1 BUGS
 
-Please report any bugs or feature requests to C<bug-rfid-serial at rt.cpan.org>, or through
+Please report any bugs or feature requests to C<bug-rfid-biblio at rt.cpan.org>, or through
 the web interface at L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=RFID-Biblio>.  I will be notified, and then you'll
 automatically be notified of progress on your bug as I make changes.
 
@@ -147,6 +145,8 @@ automatically be notified of progress on your bug as I make changes.
 You can find documentation for this module with the perldoc command.
 
     perldoc RFID::Biblio
+    perldoc RFID::Biblio::Reader
+    perldoc RFID::Biblio::Reader::API
 
 
 You can also look for information at: