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  *  \section SSec_Info USB Information:
  10  *
  11  *  The following table gives a rundown of the USB utilization of this demo.
  12  *
  13  * <table>
  14  *  <tr>
  15  *   <td><b>USB Mode:</b></td>
  16  *   <td>Device</td>
  17  *  </tr>
  18  *  <tr>
  19  *   <td><b>USB Class:</b></td>
  20  *   <td>Human Interface Device (HID)</td>
  21  *  </tr>
  22  *  <tr>
  23  *   <td><b>USB Subclass:</b></td>
  24  *   <td>Keyboard</td>
  25  *  </tr>
  26  *  <tr>
  27  *   <td><b>Relevant Standards:</b></td>
  28  *   <td>USBIF HID Standard, USBIF HID Usage Tables</td>
  29  *  </tr>
  30  *  <tr>
  31  *   <td><b>Usable Speeds:</b></td>
  32  *   <td>Low Speed Mode, Full Speed Mode</td>
  33  *  </tr>
  34  * </table>
  35  *
  36  *  \section SSec_Description Project Description:
  37  *
  38  *  Firmware for a USB AVR powered USB TTL magnetic stripe reader (using a card
  39  *  reader such as the Omron V3B-4K) by Denver Gingerich. This project is designed
  40  *  to be used with the open source Stripe Snoop project at http://stripesnoop.sourceforge.net/.
  41  *
  42  *  See http://ossguy.com/ss_usb/ for the USB reader hardware project website,
  43  *  including construction and support details.
  44  *
  45  *  To use, connect your magnetic card reader device to the USB AVR as follows (pin and port mapping may be adjusted
  46  *  from the project makefile):
  47  *
  48  *  <table>
  49  *   <tr>
  50  *    <td><b>Signal:</b></td>
  51  *    <td><b>AVR Port:</b></td>
  52  *   </tr>
  53  *   <tr>
  54  *    <td>Track 1 Data</td>
  55  *    <td>PORTC, Pin 1</td>
  56  *   </tr>
  57  *   <tr>
  58  *    <td>Track 1 Clock</td>
  59  *    <td>PORTC, Pin 2</td>
  60  *   </tr>
  61  *   <tr>
  62  *    <td>Track 2 Data</td>
  63  *    <td>PORTC, Pin 3</td>
  64  *   </tr>
  65  *   <tr>
  66  *    <td>Track 2 Clock</td>
  67  *    <td>PORTC, Pin 0</td>
  68  *   </tr>
  69  *   <tr>
  70  *    <td>Track 3 Data</td>
  71  *    <td>PORTC, Pin 5</td>
  72  *   </tr>
  73  *   <tr>
  74  *    <td>Track 3 Clock</td>
  75  *    <td>PORTC, Pin 6</td>
  76  *   </tr>
  77  *   <tr>
  78  *    <td>Card Detect</td>
  79  *    <td>PORTC, Pin 4</td>
  80  *   </tr>
  81  *  </table>
  82  *
  83  *  This project is based on the LUFA Keyboard demonstration application,
  84  *  written by Denver Gingerich.
  85  *
  86  *  This application uses a keyboard HID driver to communicate the data collected
  87  *  a TTL magnetic stripe reader to the connected computer. The raw bitstream
  88  *  obtained from the magnetic stripe reader is "typed" through the keyboard
  89  *  driver as 0's and 1's. After every card swipe, the demo will send a return key.
  90  *
  91  *  \section SSec_Options Project Options
  92  *
  93  *  The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
  94  *
  95  *  <table>
  96  *   <tr>
  97  *    <td><b>Define Name:</b></td>
  98  *    <td><b>Location:</b></td>
  99  *    <td><b>Description:</b></td>
 100  *   </tr>
 101  *   <tr>
 102  *    <td>MAX_BITS</td>
 103  *    <td>CircularBitBuffer.h</td>
 104  *    <td>Gives the maximum number of bits per track which can be buffered by the device for later transmission to a host.</td>
 105  *   </tr>
 106  *  </table>
 107  */