From: Dobrica Pavlinusic Date: Fri, 6 Aug 2010 20:11:23 +0000 (+0200) Subject: improve documentation X-Git-Tag: RFID-Biblio-0.02~42 X-Git-Url: http://git.rot13.org/?p=Biblio-RFID.git;a=commitdiff_plain;h=c9c7cf200fae07daa8423ca303b619f0ca554343;ds=sidebyside improve documentation --- diff --git a/README b/README index 8ea5cd1..28ee13e 100644 --- a/README +++ b/README @@ -1,73 +1,90 @@ -RFID-Biblio +NAME + RFID::Biblio - perl tools to use different RFID readers for library use -perl tools to use different RFID readers for library use +DESCRIPTION + 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 RFID::Biblio::Reader. -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. + Writing support for new RFID readers should be easy. + RFID::Biblio::Reader::API provides documentation on writing support for + different readers. -scripts/RFID-JSONP-server.pl is example of such application. It's local -interface to RFID reader and JSONP REST server. + Currently, two serial RFID readers based on RFID::Biblio::Reader::Serial + are implemented: -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. + * RFID::Biblio::Reader::3M810 -Currently supported readers: + * RFID::Biblio::Reader::CPRM02 - * 3M 810 - RFID::Biblio::Reader::3M810 - * CPR-M02 - RFID::Biblio::Reader::CPRM02 - * OpenPCD, The Omnikey CardMan 5121 and 5321 - RFID::Biblio::Reader::librfid + There is also simple read-only reader using shell commands in + RFID::Biblio::Reader::librfid. -For status of each implementation see pod documentation inside them. + For implementing application take a look at RFID::Biblio::Reader + `scripts/RFID-JSONP-server.pl' is example of such application. It's + local interface to RFID reader and JSONP REST server. -INSTALLATION + `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. -To install this module, run the following commands: +HARDWARE SUPPORT + 3M 810 + RFID::Biblio::Reader::3M810 - perl Makefile.PL - make - make test - make install + CPR-M02 + RFID::Biblio::Reader::CPRM02 -SUPPORT AND DOCUMENTATION + librfid + RFID::Biblio::Reader::librfid -After installing, you can find documentation for this module with the -perldoc command. +AUTHOR + Dobrica Pavlinusic, `' - perldoc RFID::Biblio +BUGS + Please report any bugs or feature requests to `bug-rfid-biblio at + rt.cpan.org', or through the web interface at + 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. -You can also look for information at: +SUPPORT + You can find documentation for this module with the perldoc command. - RT, CPAN's request tracker + perldoc RFID::Biblio + perldoc RFID::Biblio::Reader + perldoc RFID::Biblio::Reader::API + + You can also look for information at: + + * RT: CPAN's request tracker http://rt.cpan.org/NoAuth/Bugs.html?Dist=RFID-Biblio - AnnoCPAN, Annotated CPAN documentation + * AnnoCPAN: Annotated CPAN documentation http://annocpan.org/dist/RFID-Biblio - CPAN Ratings + * CPAN Ratings http://cpanratings.perl.org/d/RFID-Biblio - Search CPAN + * Search CPAN http://search.cpan.org/dist/RFID-Biblio/ - +ACKNOWLEDGEMENTS LICENSE AND COPYRIGHT + Copyright 2010 Dobrica Pavlinusic. -Copyright (C) 2010 Dobrica Pavlinusic - -This program is free software; you can redistribute it and/or modify -it under the terms of the GNU General Public License as published by -the Free Software Foundation; version 2 dated June, 1991 or at your option -any later version. + This program is free software; you can redistribute it and/or modify it + under the terms of the GNU General Public License as published by the + Free Software Foundation; version 2 dated June, 1991 or at your option + any later version. -This program is distributed in the hope that it will be useful, -but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -GNU General Public License for more details. + This program is distributed in the hope that it will be useful, but + WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General + Public License for more details. -A copy of the GNU General Public License is available in the source tree; -if not, write to the Free Software Foundation, Inc., -59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. + A copy of the GNU General Public License is available in the source + tree; if not, write to the Free Software Foundation, Inc., 59 Temple + Place - Suite 330, Boston, MA 02111-1307, USA. diff --git a/lib/RFID/Biblio.pm b/lib/RFID/Biblio.pm index 2e3b977..daccc32 100644 --- a/lib/RFID/Biblio.pm +++ b/lib/RFID/Biblio.pm @@ -19,7 +19,7 @@ our $VERSION = '0.02'; my $debug = 0; -=head1 SYNOPSIS +=head1 DESCRIPTION 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 @@ -56,6 +56,8 @@ C 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. +=for readme stop + =head1 EXPORT Formatting functions are exported @@ -103,10 +105,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 @@ -120,13 +121,14 @@ L L + =head1 AUTHOR Dobrica Pavlinusic, C<< >> =head1 BUGS -Please report any bugs or feature requests to C, or through +Please report any bugs or feature requests to C, or through the web interface at L. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes. @@ -138,6 +140,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: diff --git a/lib/RFID/Biblio/Reader/librfid.pm b/lib/RFID/Biblio/Reader/librfid.pm index c572b3d..2077ca8 100644 --- a/lib/RFID/Biblio/Reader/librfid.pm +++ b/lib/RFID/Biblio/Reader/librfid.pm @@ -12,7 +12,7 @@ use Data::Dump qw(dump); RFID::Biblio::Reader::librfid - execute librfid-tool -=head2 DESCRIPTION +=head1 DESCRIPTION This is wrapper around C from @@ -24,6 +24,8 @@ C is supported. However, this code might provide template for integration with any command-line utilities for different RFID readers. +Currently tested with only with Omnikey CardMan 5321 + =cut sub serial_settings {} # don't open serial