MagTek USB KEYBOARD EMULATION User Manual

USB (UNIVERSAL SERIAL BUS)

KEYBOARD EMULATION

FULL SIZE SWIPE READER

TECHNICAL REFERENCE MANUAL

Manual Part Number 99875207 Rev 7

JANUARY 2004

PRELIMINARY

REGISTERED TO ISO 9001:2000

1710 Apollo Court

Seal Beach, CA 90740

Phone: (562) 546-6400

FAX: (562) 546-6301

Technical Support: (651) 415-6800

www.magtek.com

MagTek®, Inc.

Printed in the United States of America

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.

REVISIONS

Rev Number Date Notes

1 28 Aug 01 Initial Release 2 05 Oct 01 Title Page: Removed HID 3 12 Dec 02 Section 4, Command Number: Corrected

GET and SET PROPERTY descriptions

4 28 Jan 03 Changed copyright symbol so .pdf copies

would print on all printers

5 03 Jun 03 Front Matter: added ISO line to logo,

changed Tech Support phone number, added new warranty statement.

6 09 Oct 03 Sec 5: replaced third paragraph with “Demo

programs, version 1.2.0 and newer…”

7 22 Jan 04 Sec 1: Replaced third paragraph, p. 1, with

current entry.

LIMITED WARRANTY

MagTek warrants that the products sold to Reseller 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 original purchaser unless the buyer is authorized by MagTek to resell the products, in which event, this warranty shall apply only to the first repurchase.

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, customer’s negligence, Reseller’s negligence, or non-MagTek modification of the product. 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 by customers.

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.

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.

EACH PURCHASER UNDERSTANDS THAT THE MAGTEK PRODUCT IS OFFERED AS IS. 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, TO RESELLER OR TO RESELLER’S CUSTOMERS, SHALL IN NO EVENT EXCEED THE TOTAL AMOUNT PAID TO MAGTEK BY RESELLER UNDER THIS AGREEMENT. IN NO EVENT WILL MAGTEK BE LIABLE TO THE RESELLER OR THE RESELLER’S CUSTOMER 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 THE PRODUCTS.

MAGTEK MAKES NO OTHER WARRANTIES WITH RESPECT TO THE PRODUCTS, 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 PRODUCTS, 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.

iii

FCC WARNING STATEMENT

This equipment has been tested and found to comply with the limits for 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 to 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 for 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 las classe B prescrites dans le Réglement sur le brouillage radioélectrique édicté par les ministère des Communications du Canada.

CE STANDARDS

Testing for compliance to CE requirements was performed by an independent laboratory. The unit under test was found compliant to Class B.

UL/CSA

This product is recognized per Underwriter Laboratories and Canadian Underwriter Laboratories 1950.

TABLE OF CONTENTS

SECTION 1. FEATURES AND SPECIFICATIONS.....................................................................................1

FEATURES...............................................................................................................................................1

HARDWARE CONFIGURATIONS...........................................................................................................2

ACCESSORIES........................................................................................................................................2

REFERENCE DOCUMENTS....................................................................................................................2

SPECIFICATIONS....................................................................................................................................2

SECTION 2. INSTALLATION......................................................................................................................5

USB CONNECTION .................................................................................................................................5

WINDOWS PLUG AND PLAY SETUP.....................................................................................................6

MOUNTING...............................................................................................................................................6

SECTION 3. OPERATION...........................................................................................................................7

LED INDICATOR......................................................................................................................................7

CARD READ.............................................................................................................................................7

SECTION 4. USB COMMUNICATIONS.......................................................................................................9

HOST APPLICATIONS.............................................................................................................................9

CARD DATA .............................................................................................................................................9

PROGRAMMABLE CONFIGURATION OPTIONS.................................................................................10

LOW LEVEL COMMUNICATIONS.........................................................................................................11

HID USAGES..........................................................................................................................................11

REPORT DESCRIPTOR ........................................................................................................................12

COMMANDS...........................................................................................................................................13

COMMAND NUMBER ............................................................................................................................13

DATA LENGTH.......................................................................................................................................13

DATA.......................................................................................................................................................13

RESULT CODE.......................................................................................................................................14

GET AND SET PROPERTY COMMANDS.............................................................................................14

SOFTWARE_ID PROPERTY.................................................................................................................15

SERIAL_NUM PROPERTY....................................................................................................................16

POLLING_INTERVAL PROPERTY........................................................................................................16

TRACK_ID_ENABLE PROPERTY.........................................................................................................17

TRACK_DATA_SEND_FLAGS PROPERTY .........................................................................................18

TERMINATION_CHAR PROPERTY......................................................................................................18

SS_TK2_7BITS PROPERTY..................................................................................................................19

SS_TK3_CADL PROPERTY..................................................................................................................19

SS_TK3_ISO_ABA PROPERTY ............................................................................................................20

SS_TK3_AAMVA PROPERTY...............................................................................................................20

SS_TK3_7BITS PROPERTY..................................................................................................................20

PRE_CARD_CHAR PROPERTY...........................................................................................................21

POST_CARD_CHAR PROPERTY.........................................................................................................21

PRE_TK_CHAR PROPERTY.................................................................................................................22

POST_TK_CHAR PROPERTY...............................................................................................................22

SECTION 5. DEMO PROGRAM.................................................................................................................23

INSTALLATION.......................................................................................................................................23

OPERATION...........................................................................................................................................23

SOURCE CODE .....................................................................................................................................24

FIGURES

Figure 1-1. USB Full Size Keyboard Emulation Swipe Reader---------------------------------------------------- viii Figure 1-2. Dimensions-------------------------------------------------------------------------------------------------------- -4 Figure 2-1. Reader Cable and Connector---------------------------------------------------------------------------------- 5

TABLES

Table 1-2. Specifications------------------------------------------------------------------------------------------------------- 3 Table 2-1. 4-Pin Connector---------------------------------------------------------------------------------------------------- 5

vii

viii

Figure 1-1. USB Full Size Keyboard Emulation Swipe Reader

SECTION 1. FEATURES AND SPECIFICATIONS

The USB (Universal Serial Bus), HID Keyboard Emulation, Full Size Swipe Reader is a compact magnetic stripe card reader, which conforms to ISO standards. The Reader is compatible with the PC series of personal computers or any device with a 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 emulates a USB Human Interface Device (HID) United States keyboard. This allows host applications designed to acquire card data from keyboard input to seamlessly acquire the card data from the USB swipe reader. Note that since this reader only emulates United States keyboards, it may not work with systems configured to use keyboards that are not United States keyboards.

Caution

If another keyboard is connected to the same host as this device and a key is pressed on the other keyboard while this device is transmitting, then the data transmitted by this device may get corrupted.

Because of potential "data interleave" issues associated with the USB Keyboard interface, MagTek recommends that the USB Keyboard Emulation MSR product should only be used by customers who have previously used MagTek's Keyboard Wedge MSR, or who are interfacing with an existing PC software application which gathers card data from the keyboard port. If previous applications were based upon RS-232 serial interface MSR's, or if this is a brand new development effort, it is strongly recommended that you use the MagTek's "standard version" of the USB MSR (Non-Keyboard Emulation Version). Please refer to Technical Manual 99875204 for further information regarding the "standard version" USB MSR.

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

• Bidirectional card reading

• Reads encoded data that meets ANSI/ISO/CDL/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

USB HID Keyboard Emulation Swipe Reader

• Can use standard Windows drivers for communications. No third part device driver is

required.

• Many programmable configuration options

• Non-volatile flash EEPROM memory for configuration storage

• Built-in 6 foot USB cable

HARDWARE CONFIGURATIONS

The hardware configuration is as follows:

Part Number Tracks Color

21088066

ACCESSORIES

The accessories are as follows:

Part Number Description

21042806 USB MSR Demo Program with Source Code (Diskette) 99510026 USB MSR Demo Program with Source Code (WEB)

REFERENCE DOCUMENTS

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.

Corporation, Intel Corporation, Microsoft Corporation, NEC Corporation. USB Implementers Forum, Inc., www.usb.org.

SPECIFICATIONS

Table 1-2 lists the specifications for the USB Swipe Reader. Figure 1-2 shows the dimensions for the standard product. Other sizes are available by special order.

TK 1,2,3 Pearl White

+ 22 hidden pages