correct retry scope
[Biblio-RFID.git] / README
1 NAME
2     Biblio::RFID - perl tools to use different RFID readers for library use
3
4 DESCRIPTION
5     Main idea is to develop simple API to reader, and than provide useful
6     abstractions on top of it to quickly write applications to respond on
7     tags which come in range of RFID reader using Biblio::RFID::Reader.
8
9     Writing support for new RFID readers should be easy.
10     Biblio::RFID::Reader::API provides documentation on writing support for
11     different readers.
12
13     Currently, two serial RFID readers based on Biblio::RFID::Reader::Serial
14     are implemented:
15
16     *   Biblio::RFID::Reader::3M810
17
18     *   Biblio::RFID::Reader::CPRM02
19
20     There is also simple read-only reader using shell commands in
21     Biblio::RFID::Reader::librfid.
22
23     For implementing application take a look at Biblio::RFID::Reader
24
25     `scripts/RFID-JSONP-server.pl' is example of such application. It's
26     local interface to RFID reader and JSONP REST server.
27
28     `examples/koha-rfid.js' is jQuery based JavaScript code which can be
29     inserted in Koha Library System to provide overlay with tags in range
30     and check-in/check-out form-fill functionality.
31
32     Applications can use Biblio::RFID::RFID501 which is some kind of
33     semi-standard 3M layout or blocks on RFID tags.
34
35 HARDWARE SUPPORT
36   3M 810
37     Biblio::RFID::Reader::3M810
38
39   CPR-M02
40     Biblio::RFID::Reader::CPRM02
41
42   librfid
43     Biblio::RFID::Reader::librfid
44
45 AUTHOR
46     Dobrica Pavlinusic, `<dpavlin at rot13.org>'
47
48     http://blog.rot13.org/
49
50 BUGS
51     Please report any bugs or feature requests to `bug-rfid-biblio at
52     rt.cpan.org', or through the web interface at
53     http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Biblio-RFID. I will be
54     notified, and then you'll automatically be notified of progress on your
55     bug as I make changes.
56
57 SUPPORT
58     You can find documentation for this module with the perldoc command.
59
60         perldoc Biblio::RFID
61         perldoc Biblio::RFID::Reader
62         perldoc Biblio::RFID::Reader::API
63
64     You can also look for information at:
65
66     * RT: CPAN's request tracker
67         http://rt.cpan.org/NoAuth/Bugs.html?Dist=Biblio-RFID
68
69     * AnnoCPAN: Annotated CPAN documentation
70         http://annocpan.org/dist/Biblio-RFID
71
72     * CPAN Ratings
73         http://cpanratings.perl.org/d/Biblio-RFID
74
75     * Search CPAN
76         http://search.cpan.org/dist/Biblio-RFID/
77
78 ACKNOWLEDGEMENTS
79 LICENSE AND COPYRIGHT
80     Copyright 2010 Dobrica Pavlinusic.
81
82     This program is free software; you can redistribute it and/or modify it
83     under the terms of the GNU General Public License as published by the
84     Free Software Foundation; version 2 dated June, 1991 or at your option
85     any later version.
86
87     This program is distributed in the hope that it will be useful, but
88     WITHOUT ANY WARRANTY; without even the implied warranty of
89     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
90     Public License for more details.
91
92     A copy of the GNU General Public License is available in the source
93     tree; if not, write to the Free Software Foundation, Inc., 59 Temple
94     Place - Suite 330, Boston, MA 02111-1307, USA.
95