Corrected CDC class bootloader to fix a few bugs, changed address counter to store...
[pub/USBasp.git] / Projects / Magstripe / Magstripe.txt
1 /** \file
2 *
3 * This file contains special DoxyGen information for the generation of the main page and other special
4 * documentation pages. It is not a project source file.
5 */
6
7 /** \mainpage Denver Gingerich's USBSnoop Magnetic Card Reader Project
8 *
9 * Firmware for a USB AVR powered USB TTL magnetic stripe reader (using a card
10 * reader such as the Omron V3B-4K) by Denver Gingerich. This project is designed
11 * to be used with the open source Stripe Snoop project at http://stripesnoop.sourceforge.net/.
12 *
13 * See http://ossguy.com/ss_usb/ for the USB reader hardware project website,
14 * including construction and support details.
15 *
16 * To use, connect your magentic card reader device to the USB AVR as follows (pin and port mapping may be adjusted
17 * from the project makefile):
18 *
19 * <table>
20 * <tr>
21 * <td><b>Signal:</b></td>
22 * <td><b>AVR Port:</b></td>
23 * </tr>
24 * <tr>
25 * <td>Track 1 Data</td>
26 * <td>PORTC, Pin 1</td>
27 * </tr>
28 * <tr>
29 * <td>Track 1 Clock</td>
30 * <td>PORTC, Pin 2</td>
31 * </tr>
32 * <tr>
33 * <td>Track 2 Data</td>
34 * <td>PORTC, Pin 3</td>
35 * </tr>
36 * <tr>
37 * <td>Track 2 Clock</td>
38 * <td>PORTC, Pin 0</td>
39 * </tr>
40 * <tr>
41 * <td>Track 3 Data</td>
42 * <td>PORTC, Pin 5</td>
43 * </tr>
44 * <tr>
45 * <td>Track 3 Clock</td>
46 * <td>PORTC, Pin 6</td>
47 * </tr>
48 * <tr>
49 * <td>Card Detect</td>
50 * <td>PORTC, Pin 4</td>
51 * </tr>
52 * </table>
53 *
54 *
55 * This project is based on the LUFA Keyboard demonstration application,
56 * written by Denver Gingerich.
57 *
58 * This application uses a keyboard HID driver to communicate the data collected
59 * a TTL magnetic stripe reader to the connected computer. The raw bitstream
60 * obtained from the magnetic stripe reader is "typed" through the keyboard
61 * driver as 0's and 1's. After every card swipe, the demo will send a return key.
62 *
63 * <table>
64 * <tr>
65 * <td><b>USB Mode:</b></td>
66 * <td>Device</td>
67 * </tr>
68 * <tr>
69 * <td><b>USB Class:</b></td>
70 * <td>Human Interface Device (HID)</td>
71 * </tr>
72 * <tr>
73 * <td><b>USB Subclass:</b></td>
74 * <td>Keyboard</td>
75 * </tr>
76 * <tr>
77 * <td><b>Relevant Standards:</b></td>
78 * <td>USBIF HID Standard, USBIF HID Usage Tables</td>
79 * </tr>
80 * <tr>
81 * <td><b>Usable Speeds:</b></td>
82 * <td>Low Speed Mode, Full Speed Mode</td>
83 * </tr>
84 * </table>
85 */