USB HID SURESWIPE
&
USB HID SWIPE READER
TECHNICAL REFERENCE MANUAL
Manual Part Number 99875191 Rev 13
JANUARY 2012
REGISTERED TO ISO 9001:2008
1710 Apollo Court
Seal Beach, CA 90740
Phone: (562) 546-6400
FAX: (562) 546-6301
Technical Support: (651) 415-6800
www.magtek.com
ii
Rev Number
Date
Notes
1
15 Jun 01
Initial Release
2
22 Jun 01
Section 4. On Tracks 1, 2, and 3 Decode Status delete “more than
3
25 Jul 01
Front Matter: Agency Approvals: Corrected Class B for CE.
5
12 Dec 02
Section 4, Command Number: Corrected GET and SET
PROPERTY descriptions.
6
28 Jan 03
Changed copyright symbol so pdf copies would print on all printers
7
03 Jun 03
Front Matter: added ISO line to logo, changed Tech Support phone
number, added new warranty statement.
8
17 May 05
Included references to new commands added after June 2005. Sec
4: Replaced all of Section 4.
9
22 Nov 05
Sec 1: To Hardware Configuration Table, added P/N 21040139.
Corrected cable descriptions for Models 21040119 and 21040139.
10
30 Aug 06
Added dual head models 21040140 and 21040146
11
19 Mar 07
Add SureSwipe title and content
12
23 Mar 09
Added MTBF Specification; updated warrant y and agency approval
information
13
4 Jan 12
Added Host Poll Timeout Property (0x52); removed references to
readable
Copyright© 2001-2012
MagTek©, Inc.
Printed in the United States of Americ a
Information in this document is subject to change without notice. No part of this document may be
reproduced or transmitted in any form or by any means, electronic or mechanical, for any purpose,
without the express written permission of MagTek, Inc.
MagTek is a registered trademark of MagTek, Inc.
USB (Universal Serial Bus) Specification is Copyright© 1998 by Compaq Computer Corporation, Intel
Corporation, Microsoft Corporation, NEC Corporation.
REVISIONS
eight bits of data” and add “data on it that is not noise.” From Card
Encode Type, Value 3, delete “This device does not d etect blank
cards so this value will never occur.”
4 17 Aug 01 Section 4, Report Descriptor: Changed Logical Maximum from 25 ff
to 26 ff 00.
part numbers 21040113,-14, -43; updated figures to be more
iii
LIMITED WARRANTY
MagTek warrants that the products sold pursuant to this Agreement will perform in accordance with MagTek’s
published specifications. This warranty shall be provided only for a period of one year from the date of the
shipment of the product from MagTek (the “Warranty Period”). This warranty shall apply only to the “Buyer”
(the original purchaser, unless that entity resells the product as authorized by MagTek, in which event this
warranty shall apply only to the first repurchaser).
During the Warranty Period, should this product fail to conform to MagTek’s specifications, MagTek will, at its
option, repair or replace this product at no additional charge except as set forth below. Repair parts and
replacement products will be furnished on an exchange basis and will be either reconditioned or new. All replaced
parts and products become the property of MagTek. This limited warranty does not include service to repair
damage to the product resulting from accident, disaster, unreasonable use, misuse, abuse, negligence, or
modification of the product not authorized by MagTek. MagTek reserves the right to examine the alleged
defective goods to determine whether the warranty is applicable.
Without limiting the generality of the foregoing, MagTek specifically disclaims any liability or warranty for
goods resold in other than MagTek’s original packages, and for goods modified, altered, or treated without
authorization by MagTek.
Service may be obtained by delivering the product during the warranty period to MagTek (1710 Apollo Court,
Seal Beach, CA 90740). If this product is delivered by mail or by an equivalent shipping carrier, the customer
agrees to insure the product or assume the risk of loss or damage in transit, to prepay shipping charges to the
warranty service location, and to use the original shipping container or equivalent. MagTek will return the
product, prepaid, via a three (3) day shipping service. A Return Material Authorization (“RMA”) number must
accompany all returns. Buyers may obtain an RMA number by contacting Technical Support at (888) 624-8350.
EACH BUYER UNDERSTANDS THAT THIS MAGTEK PRODUCT IS
OFFERED AS IS.
MAGTEK MAKES NO OTHER WARRANTY , EXPRESS OR
IMPLIED, AND MAGTEK DISCLAIMS ANY WARRANTY OF ANY OTHER
KIND, INCLUDING ANY WARRANTY OF MERCHANTABILITY OR FITNESS
FOR A PARTICULAR PURPOSE.
IF THIS PRODUCT DOES NOT CONFORM TO MAGTEK’S SPECIFICATIONS, THE SOLE REMEDY
SHALL BE REPAIR OR REPLACEMENT AS PROVIDED ABOVE. MAGTEK’S LIABILITY, IF ANY,
SHALL IN NO EVENT EXCEED THE TOTAL AMOUNT PAID TO MAGTEK UNDER THIS
AGREEMENT. IN NO EVENT WILL MAGTEK BE LIABLE TO THE BUYER FOR ANY DAMAGES,
INCLUDING ANY LOST PROFITS, LOST SAVINGS, OR OTHER INCIDENTAL OR CONSEQUENTIAL
DAMAGES ARISING OUT OF THE USE OF, OR INABILITY TO USE, SUCH PRODUCT, EVEN IF
MAGTEK HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES, OR FOR ANY CLAIM BY
ANY OTHER PARTY.
LIMITATION ON LIABILITY
EXCEPT AS PROVIDED IN THE SECTIONS RELATING TO MAGTEK’S LIMITED WARRANTY,
MAGTEK’S LIABILITY UNDER THIS AGREEMENT IS LIMITED TO THE CONTRACT PRICE OF THIS
PRODUCT.
MAGTEK MAKES NO OTHER WARRANTIES WITH RESPECT TO THE PRODUCT, EXPRESSED OR
IMPLIED, EXCEPT AS MAY BE STATED IN THIS AGREEMENT, AND MAGTEK DISCLAIMS ANY
IMPLIED WARRANTY, INCLUDING WITHOUT LIMITATION ANY IMPLIED WARRANTY OF
MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
MAGTEK SHALL NOT BE LIABLE FOR CONTINGENT, INCIDENTAL, OR CONSEQUENTIAL
DAMAGES TO PERSONS OR PROPERTY. MAGTEK FURTHER LIMITS ITS LIABILITY OF ANY KIND
WITH RESPECT TO THE PRODUCT, INCLUDING ANY NEGLIGENCE ON ITS PART, TO THE
CONTRACT PRICE FOR THE GOODS.
MAGTEK’S SOLE LIABILITY AND BUYER’S EXCLUSIVE REMEDIES ARE STATED IN THIS SECTION
AND IN THE SECTION RELATING TO MAGTEK’S LIMITED WARRANTY.
iv
FCC WARNING STATEMENT
This equipment has been tested and was found to comply with the limits for a Class B digital device pursuant to
Part 15 of FCC Rules. These limits are designed to provide reasonable protection against harmful interference
when the equipment is operated in a residential environment. This equipment generates, uses, and can radiate
radio frequency energy and, if not installed and used in accordance with the instruction manual, may cause
harmful interference with radio communications. However, there is no guarantee that interference will not occur
in a particular installation.
FCC COMPLIANCE STATEMENT
This device complies with Part 15 of the FCC Rules. Operation of this device is subject to the following two
conditions: (1) this device may not cause harmful interference, and (2) this device must accept any interference
received, including interference that may cause undesired operation.
CANADIAN DOC STATEMENT
This digital apparatus does not exceed the Class B limits for radio noise from digital apparatus set out in the
Radio Interference Regulations of the Canadian Department of Communications.
Le présent appareil numérique n’émet pas de bruits radioélectriques dépassant les limites applicables aux
appareils numériques de la classe B prescrites dans le Réglement sur le brouillage radioélectrique édicté par le
ministère des Communications du Canada.
This Class B digital apparatus complies with Canadian ICES-003.
Cet appareil numériqué de la classe B est conformé à la norme NMB-003 du Canada.
CE STANDARDS
Testing for compliance with CE requirements was performed by an independent laboratory. The unit under test
was found compliant with s tandards established for Class B devices.
UL/CSA
This product is recognized per Underwriter Laboratories and Canadian Underwriter Laboratories 1950.
RoHS STATEMENT
When ordered as RoHS compliant, this product meets the Electrical and Electronic Equipment (EEE) Reduction
of Hazardous Substances (RoHS) European Directive 2002/95/EC. The marking is clearly recognizable, either as
written words like “Pb-free”, “lead-free”, or as another clear symbol ( ).
v
TABLE OF CONTENTS
SECTION 1. FEATURES AND SPECIFICATIONS ..................................................................................... 1
USB HID SWIPE READER ....................................................................................................................... 1
USB HID SURESWIPE ............................................................................................................................. 1
FEATURES ............................................................................................................................................... 2
HARDWARE CONFIGURATIONS ........................................................................................................... 2
ACCESSORIES ........................................................................................................................................ 3
REFERENCE DOCUMENTS .................................................................................................................... 3
SPECIFICATIONS .................................................................................................................................... 4
SECTION 2. INSTALLATION ...................................................................................................................... 7
USB CONNECTION ................................................................................................................................. 7
WINDOWS PLUG AND PLAY S E TUP ..................................................................................................... 8
MOUNTING ............................................................................................................................................... 8
SECTION 3. OPERATION ......................................................................................................................... 11
LED INDICATOR .................................................................................................................................... 11
CARD READ ........................................................................................................................................... 11
SECTION 4. USB COMMUNICATIONS .................................................................................................... 13
HID USAGES .......................................................................................................................................... 13
REPORT DESCRIPTOR ........................................................................................................................ 14
CARD DATA ........................................................................................................................................... 15
TRACK 1 DECODE STATUS ................................................................................................................. 15
TRACK 2 DECODE STATUS ................................................................................................................. 15
TRACK 3 DECODE STATUS ................................................................................................................. 16
TRACK 1 DATA LENGTH ....................................................................................................................... 16
TRACK 2 DATA LENGTH ....................................................................................................................... 16
TRACK 3 DATA LENGTH ....................................................................................................................... 16
CARD ENCODE TYPE ........................................................................................................................... 16
TRACK DATA ......................................................................................................................................... 17
TRACK 1 DATA ...................................................................................................................................... 17
TRACK 2 DATA ...................................................................................................................................... 17
T
RACK 3 DATA ...................................................................................................................................... 17
COMMANDS ........................................................................................................................................... 17
COMMAND NUMBER ............................................................................................................................ 18
DATA LENGTH ....................................................................................................................................... 18
DATA ....................................................................................................................................................... 18
RESULT CODE....................................................................................................................................... 18
GET AND SET PROPERTY COMMANDS ............................................................................................. 18
SOFTWARE ID PROPERTY .................................................................................................................. 19
SERIAL NUM PROPERTY ..................................................................................................................... 20
POLLING INTERV AL PR OPERTY ......................................................................................................... 20
MAX PACKET SIZE PROPERTY ........................................................................................................... 21
TRACK ID ENABLE PRO P ERTY ........................................................................................................... 22
INTERFACE TYPE PROPERTY ............................................................................................................ 23
HOST POLL TIMEOUT PROPERTY ...................................................................................................... 24
RESET DEVICE COMMAND .................................................................................................................. 25
SECTION 5. DEMO PROGRAM ................................................................................................................. 27
INSTALLATION....................................................................................................................................... 27
OPERATION ........................................................................................................................................... 27
SOURCE CODE ..................................................................................................................................... 28
FIGURES AND TABLES
FIGURE 1-1. USB SWIPE READER ...................................................................................................................... VI
TABLE 1-1. SPECIFICATIONS ................................................................................................................................. 4
FIGURE 1-2. DIMENSIONS ...................................................................................................................................... 5
FIGURE 2-1. READER CABLE AND CONNECTOR ................................................................................................ 7
TABLE 2-1. 4-PIN CONNECTOR ............................................................................................................................. 7
FIGURE 2-2. MOUNTING HOLE DIMENSIONS FOR SURFACE ........................................................................... 9
vi
Figure 1-1. USB Swipe Reader
1
SECTION 1. FEATURES AND SPECIFICATIONS
USB HID SWIPE READER
The USB (Universal Serial Bus) HID (Human Interface Device) Swipe Reader is a compact
magnetic stripe card reader with a single read head that conforms to ISO standards. The Reader
is compatible with any device with a host USB interface. A card is read by sliding it, stripe
down and facing the LED side, through the slot either forward or backward.
A LED (Light Emitting Diode) indicator on the Reader panel provides the operator with
continuous status of the Reader operations.
The reader conforms to the USB HID Class specification Version 1.1. This allows host
applications designed for most versions of Windows to easily communicate to the device using
standard Windows API calls that communicate to the device through the HID driver that comes
with Windows.
Unlike HID keyboard emulation readers, this device does NOT use keyboard emulation. It
behaves like a vendor-defined HID device so that a direct communication path can be established
between the Host application and the device without interference such as keystrokes from other
HID devices. (For information on the USB KB Emulation Reader, refer to Technical Manual
99875206.)
USB HID SURESWIPE
The USB HID SureSwipe is a card reader with two magnetic heads. The SureSwipe reader was
designed specifically to read any magnetic stripe card regardless of which way the magnetic
stripe is facing when swiped. The SureSwipe’s dual heads provide convenience for the user by
eliminating the confusion when swiping a card.
In all other regards, the SureSwipe reader is technically equivalent to the single-head USB HID
Swipe reader described above. All technical specifications described in this manual are
applicable to both types of readers.
The SureSwipe readers have specific part numbers and they are described in a table in the
“Hardware Configurations” section below.
USB HID Swipe Reader
2
Part Number
Tracks
Color
Cable
Heads
21040101
TK 1,2,3
Pearl White
6’ USB-A
Single
21040102
TK 1,2,3
Black
6’ USB-A
Single
21040103
TK 1,2
Pearl White
6’ USB-A
Single
21040104
TK 1,2
Black
6’ USB-A
Single
21040119
TK 1,2,3
No enclosure
11” 5 Pin Molex
Single
21040139
TK 1,2,3
No enclosure
21” 5 Pin Molex
Single
FEATURES
Major features of the Swipe Reader are as follows:
• Powered through the USB – no external power supply required
• Hardware Compatible with PC or any computer or terminal with a USB interface
• Bi-directional card reading
• Reads encoded data that meets ANSI/ISO/AAMVA standards and others such as ISO track 1
format on track 2 or 3.
• Reads up to three tracks of card data
• LED for status
• Compatible with USB specification Revision 1.1
• Compatible with HID specification Version 1.1
• Can use standard Windows HID driver for communications. No third part device driver is
required.
• Programmable USB serial number descriptor
• Programmable USB Interrupt In Endpoint polling interval
• Non-volatile memory for configuration storage
• Built-in 6 foot USB cable
• Ability to convert to Keyboard Emulation mode of operation (new in June 2005)
Note
New features have been added to the USB HID Swipe Reader. The following commands were
added to most readers that are shipped after June 1, 2005:
MAX PACKET SIZE Property
TRACK ID ENABLE Property
INTERFACE TYPE Property
RESET DEVICE Command
In order to determine if these features are available, request the SOFTWARE ID property. If the
software ID string shows “21042804xxx”, the new features are NOT available. If the software
string shows “21042812xxx” or “21042818xxx”, then these new features are supported.
HARDWARE CONFIGURATIONS
The hardware configurations for the USB HID Swipe Reader are as follows:
Section 1. Features and Specifications
3
Part Number
Tracks
Color
Cable
Heads
21040140
TK 1,2,3
Black
6’ USB-A
Dual
21040146
TK 1,2,3
Pearl White
6’ USB-A
Dual
Part Number
Description
21042806
USB MSR Demo Program with Source Code (Diskette)
99510026
USB MSR Demo Program with Source Code (WEB)
The hardware configurations for the USB HID SureSwipe are as follows:
ACCESSORIES
The accessories are as follows:
REFERENCE DOCUMENTS
MagTek USB KB Swipe Reader, Technical Reference Manual (99875206)
Axelson, Jan. USB Complete, Everything You Need to Develop Custom USB Peripherals, 1999.
Lakeview Research, 2209 Winnebago St., Madison WI 53704, 396pp., http://www.lvr.com.
USB Human Interface Device (HID) Class Specification Version 1.1.
USB (Universal Serial Bus) Specification, Version 1.1, Copyright 1998 by Compaq Computer
Corporation, Intel Corporation, Microsoft Corporation, NEC Corporation.
USB Implementers Forum, Inc., www.usb.org.
USB HID Swipe Reader
4
Reference Standards
ISO 7810 and ISO 7811/AAMVA*
Power Input
5V From USB bus
Recording Method
Two-frequency coherent phase (F2F)
Message Format
ASCII
Card Speed
3 to 60 ips (7.62 – 152.4 cm/s)
ELECTRICAL
Current
Suspend Mode
200 uA
MTBF
1.0 E06 Hrs based on Mil-217
MECHANICAL
Size
Height
1.23” (31.3mm)
Weight
4.5 oz. (127.57 g)
Cable length
6 ft. (1.8m)
Connector
USB Type A plug
ENVIRONMENTAL
Temperature
Operating
-40 oC to 70 oC (-40 oF to 158 oF)
Storage
-40 oC to 70 oC (-40 oF to 158 oF)
Humidity
Operating
10% to 90% noncondensing
Storage
10% to 90% noncondensing
Altitude
Operating
0-10,000 ft. (0-3048 m.)
Storage
0-50,000 ft. (0-15240 m.)
SPECIFICATIONS
Table 1-1 lists the specifications for the USB Swipe Reader. Figure 1-2 shows the dimensions
for the standard product.
Table 1-1. Specifications
Normal Mode
Length
Width
* ISO (International Standards Organization) and AAMVA (American
Association of Motor Vehicle Administrators).
15 mA
3.94” (100.0mm)
1.28” (32.5mm)
Section 1. Features and Specifications
5
Figure 1-2. Dimensions
USB HID Swipe Reader
6
7
Pin Number
Signal
Cable Color
1
VBUS
Red
2
-Data
White
3
+Data
Green
4
Ground
Black
SECTION 2. INSTALLATION
This section describes the cable connection, the Windows Plug and Play Setup, and the physical
mounting of the unit.
USB CONNECTION
Connect the USB cable to a USB port on the host. The Reader, LED Indicator, and pin numbers
for the 4-pin connector are shown in Figure 2-1.
Figure 2-1. Reader Cable and Connector
Pin numbers and signal descriptions for the cable shown in the illustration are listed in Table 2-1.
Table 2-1. 4-Pin Connector
USB HID Swipe Reader
8
WINDOWS PLUG AND PLAY SETUP
On hosts with the Windows operating system, the first time the device is plugged into a specific
USB port, Windows will pop up a dialog box, which will guide you through the process of
installing a device driver for the device. After this process is completed once, Windows will no
longer request this process as long as the device is plugged into the same USB port. The device
driver that Windows will install for this device is the driver used for HID devices and it is part of
the Windows operating system. When the dialog box pops up, follow the instructions given in
the dialog box. Sometimes Windows will find all the files it needs on its own without giving any
prompts. Other times Windows will need to know the location of the files it needs. If Windows
prompts for the file locations, insert the CD that was used to install Windows on your PC and
point Windows to the root directory of the CD. Windows should find all the files it needs there.
MOUNTING
The Reader may be mounted with screws or fastening tape as described below.
Caution
The Reader should be mounted such that the bottom (mounting
side) is not exposed to the user. This is because the mounting side
of the reader may be susceptible to electrostatic discharge.
1. The Reader can be mounted on a surface in various ways:
• By two screws through the surface attached to the bottom of the unit and running the
cable on the top of the surface
• By two screws through the surface attached to the bottom of the unit and by drilling a
hole in the surface for the cable and running the cable through the hole
• By attaching the unit to the surface with fastening tape and running the cable on the
top of the surface
Note
The two mounting inserts are 3mm diameter, 0.5mm pitch, 6.4mm
deep. The length of the screws used depends on the mounting
surface thickness and the thickness of washers (if used).
The mounting dimensions are shown in Figure 2-2. Determine the method of mounting
required.
Section 2. Installation
9
Figure 2-2. Mounting Hole Dimensions for Surface
2. Ensure the Reader is positioned on a flat, accessible surface with at least 4 inches
clearance on either end for room to swipe a card. Orient the Reader so the side with the
LED is facing the direction of intended use.
If fastening tape is to be used, clean the area that the Reader will be mounted on with
isopropyl alcohol. Remove the adhesive protective cover on the fastening tape, and
position the Reader and push down firmly.
3. Mount the Reader.
USB HID Swipe Reader
10
11
SECTION 3. OPERATION
This section describes the LED Indicator and Card Read.
LED INDICATOR
The LED indicator will be either off, red, or green. When the device is not powered, the LED
will be off. When the device is first plugged in, the LED will be red. As soon as the device is
plugged in, the host will try to enumerate the device. Once the device is enumerated the LED
will turn green indicating that the device is ready for use. When a card is being swiped, the LED
will turn off temporarily until the swipe is completed. If there are no errors after decoding the
card data then the LED will turn green. If there are any errors after decoding the card data, the
LED will turn red for approximately two seconds to indicate that an error occurred and then turn
green. Anytime the host puts the device into suspend mode, the LED will turn off. Once the
host takes the device out of suspend mode, the LED will return to the state it was in prior to
entering suspend mode.
CARD READ
A card may be swiped through the Reader slot when the LED is green.
When using a USB HID Swipe Reader (with a single head), the magnetic stripe must face toward
the front (the side with the LED) and may be swiped in either direction.
When using a USB HID SureSwipe reader (with dual heads), the magnetic stripe can face toward
the front or the back, and may be swiped in either direction.
If there is data encoded on the card, the reader will attempt to decode the data and then send the
results to the host via a USB HID input report. After the results are sent to the host, the device
will be ready to read the next card.
USB HID Swipe Reader
12
13
SECTION 4. USB COMMUNICATIONS
This device conforms to the USB specification revision 1.1. This device also conforms with the
Human Interface Device (HID) class specification version 1.1. The device communicates to the
host as a vendor-defined HID device. The details about how the card data and commands are
structured into HID reports follow later in this section. The latest versions of the Windows
operating systems come with a standard Windows USB HID driver. Windows applications that
communicate to this device can be easily developed. These applications can communicate to the
device using standard windows API calls that communicate to the device using the standard
Windows USB HID driver. These applications can be easily developed using compilers such as
Microsoft’s Visual Basic or Visual C++. A demonstration program and its source code, written
in Visual Basic, that communicates with this device is available. This demo program can be
used to test the device and it can be used as a guide for developing other applications. More
details about the demo program follow later in this document.
It is recommended that application software developers become familiar with the HID
specification the USB specification before attempting to communicate with this device. This
document assumes that the reader is familiar with these specifications. These specifications can
be downloaded free from www.usb.org.
This is a full speed USB device. This device has a number of programmable configuration
properties. These properties are stored in non-volatile memory. These properties can be
configured at the factory or by the end user. The device has an adjustable endpoint descriptor
polling interval value that can be set to any value in the range of 1ms to 255ms. This property
can be used to speed up or slow down the card data transfer rate. The device also has an
adjustable serial number descriptor. More details about these properties can be found later in this
document in the command section.
The device will go into suspend mode when directed to do so by the host. The device will
wakeup from suspend mode when directed to do so by the host. The device does not support
remote wakeup.
This device is powered from the USB bus. Its vendor ID is 0x0801 and its product ID is 0x0002.
HID USAGES
HID devices send data in reports. Elements of data in a report are identified by unique identifiers
called usages. The structure of the device’s reports and the device’s capabilities are reported to
the host in a report descriptor. The host usually gets the report descriptor only once, right after
the device is plugged in. The report descriptor usages identify the devices capabilities and report
structures. For example, a device could be identified as a keyboard by analyzing the device’s
report descriptor. Usages are four byte integers. The most significant two bytes are called the
usage page and the least significant two bytes are called usage IDs. Usages that are related can
share a common usage page. Usages can be standardized or they can be vendor defined.
Standardized usages such as usages for mice and keyboards can be found in the HID Usage
Tables document and can be downloaded free at www.usb.org. Vendor-defined usages must
have a usage page in the range 0xff00 – 0xffff. All usages for this device use vendor-defined
magnetic stripe reader usage page 0xff00. The usage IDs for this device are defined in the
Loading...