USB HID INTELLIHEAD FOR SWIPE READERS TECHNICAL REFERENCE MANUAL Manual Part Number 99875320-5 OCTOBER 2008 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.
ii
Copyright© 2008 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. IntelliHead™ is a trademark of MagTek, Inc.
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.
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.
TABLE OF CONTENTS SECTION 1. FEATURES AND SPECIFICATIONS..................................................................................... 1 FEATURES............................................................................................................................................... 1 HARDWARE CONFIGURATIONS ........................................................................................................... 2 ACCESSORIES.....................................................................
TABLES AND FIGURES Figure 1-1. USB IntelliHead 3-Track .......................................................................................................... viii Table 1-1. Specifications.............................................................................................................................. 3 Table 2-1. 5-Pin Connector .......................................................................................................................... 5 Figure A-1.
Figure 1-1.
SECTION 1. FEATURES AND SPECIFICATIONS The USB (Universal Serial Bus) HID (Human Interface Device) IntelliHead Swipe Reader is a compact magnetic stripe card reader that conforms to ISO standards. The Reader is compatible with any device with a USB host interface. A card is read by sliding it past the head either forward or backward. The Reader conforms to the USB HID Class specification Version 1.1.
USB HID IntelliHead Swipe Reader HARDWARE CONFIGURATIONS The hardware configurations are as shown in the table below. Drawings of each model are included in Appendix A.
Section 1. Features and Specifications SPECIFICATIONS Table 1-1 lists the specifications for the USB IntelliHead. Table 1-1. Specifications Reference Standards Power Input Recording Method Message Format Card Speed ISO 7810, ISO 7811, AAMVA and JIS X 6302* 5V from USB bus Two-frequency coherent phase (F2F) ASCII 3 to 60 ips (7.62 – 152.4 cm/s) ELECTRICAL Current Normal Mode Suspend Mode Weight Cable length Connector 15mA 200 µA MECHANICAL 1.1 oz. (31 gr.
USB HID IntelliHead Swipe Reader 4
SECTION 2. INSTALLATION This section describes the cable connection, the Windows Plug and Play Setup, and the physical mounting of the unit. USB CONNECTION Since the USB IntelliHead is supplied as an OEM product, the installation and system integration will be unique for each application. The reader module must be attached to an appropriate connector which, in turn, connects to the USB port or hub. The pin numbers for the 5-pin connector are shown in Figure 2-1.
USB HID IntelliHead Swipe Reader 6
SECTION 3. OPERATION CARD READ A card may be swiped past the read head at any time. The magnetic stripe must face toward the head and may be swiped in either direction. If there is data encoded on the card, the device 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 IntelliHead Swipe Reader 8
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.
USB HID IntelliHead Swipe Reader 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 following table. The usage types are also listed. These usage types are defined in the HID Usage Tables document.
Section 4. USB Communications Item Input (Data, Variable, Absolute, Buffered Bytes) Usage (Track 3 data) Report Count (110) Input (Data, Variable, Absolute, Buffered Bytes) Usage (Command message) Report Count (24) Feature (Data, Variable, Absolute, Buffered Bytes) End Collection Value (Hex) 82 02 01 09 32 95 6E 82 02 01 09 20 95 18 B2 02 01 C0 CARD DATA Card data is only sent to the host on the Interrupt In pipe using an Input Report. The device will send only one Input Report per card swipe.
USB HID IntelliHead Swipe Reader TRACK 2 DECODE STATUS Bits Value 7-1 Reserved 0 Error This is a one-byte value, which indicates the status of decoding track 2. Bit position zero indicates if there was an error decoding track 2 if this bit is set to one. If it is zero, then no error occurred. If a track has data on it that is not noise, and it is not decodable, then a decode error is indicated.
Section 4. USB Communications CARD ENCODE TYPE This one-byte value indicates the type of encoding that was found on the card. The following table defines the possible values. Value 0 1 2 Encode Type ISO/ABA AAMVA CADL 3 4 Blank Other 5 Undetermined 6 None 7 JIS Type 2 Description ISO/ABA encode format AAMVA encode format CADL encode format. Note that this reader can only read track 2 for this format. It cannot read tracks 1 and 3. However, this format is obsolete. The card is blank.
USB HID IntelliHead Swipe Reader COMMANDS Most host applications do not need to send commands to the device. Most host applications only need to obtain card data from the device as described previously in this section. This section of the manual can be ignored by anyone who does not need to send commands to the device. Command requests and responses are sent to and received from the device using feature reports. Command requests are sent to the device using the HID class specific request Set_Report.
Section 4. USB Communications data. The HID specification requires that Reports be fixed in length. Command data may vary in length. Therefore, the Report should be filled with zeros after the valid data. RESULT CODE This one-byte field contains the value of the result code. There are two types of result codes: generic result codes and command-specific result codes. Generic result codes always have the most significant bit set to zero.
USB HID IntelliHead Swipe Reader The result codes for the Get and Set Property commands can be any of the codes list in the generic result code table. Property ID is a one-byte field that contains a value that identifies the property.
Section 4. USB Communications SERIAL_NUM PROPERTY Property ID: Property Type: Length: Get Property: Set Property: Default Value: Description: 0x01 String 0 – 15 bytes Yes Yes The default value is no string with a length of zero. The value is an ASCII string that represents the device’s serial number. This string can be 0 – 15 bytes long. The value of this property, if any, will be sent to the host when the host requests the USB string descriptor.
USB HID IntelliHead Swipe Reader POLLING_INTERVAL PROPERTY Property ID: Property Type: Length: Get Property: Set Property: Default Value: Description: 0x02 Byte 1 byte Yes Yes 10 The value is a byte that represents the devices polling interval for the Interrupt In Endpoint. The value can be set in the range of 1 – 255 and has units of milliseconds. The polling interval tells the host how often to poll the device for card data packets.
Section 4. USB Communications MAX_PACKET_SIZE PROPERTY Property ID: Property Type: Length: Get Property: Set Property: Default Value: Description: 0x03 Byte 1 byte Yes Yes 8 The value is a byte that represents the devices maximum packet size for the Interrupt In Endpoint. The value can be set in the range of 1 – 64 and has units of bytes. The maximum packet size tells the host the maximum size of the Interrupt In Endpoint packets.
USB HID IntelliHead Swipe Reader TRACK_ID_ENABLE PROPERTY Property ID: Property Type: Length: Get Property: Set Property: Default Value: Description: id 0x04 Byte 1 byte Yes Yes 0x95 This property is defined as follows: 0 T3 T3 T2 T2 T1 T1 Id 0 – Decodes standard ISO/ABA cards only 1 – Decodes AAMVA and 7-bit cards also T# 00 – Track Disabled 01 – Track Enabled 10 – Track Enabled/Required (Error if blank) This property is stored in non-volatile memory, so it will persist when the unit is power c
Section 4. USB Communications INTERFACE_TYPE PROPERTY Property ID: Property Type: Length: Get Property: Set Property: Default Value: Description: 0x10 Byte 1 byte Yes Yes 0 (HID) The value is a byte that represents the devices interface type. The value can be set to 0 for the HID interface or to 1 for the keyboard emulation interface. When the value is set to 0 (HID) the device will behave as described in the HID manual.
USB HID IntelliHead Swipe Reader DECODE_ENABLE PROPERTY Property ID: Property Type: Length: Get Property: Set Property: Default Value: Description: Bit Position Decode Type 0x1A Byte 1 byte Yes Yes 0x00 This property is defined as follows: 7 6 5 4 3 2 1 0 Reserved Reserved Reserved Reserved Reserved Reserved Reserved JIS Type 2 When a decode type bit is set to 1 (true), the decode type represented by that bit is enabled.
Section 4. USB Communications RESET_DEVICE COMMAND Command number: 0x02 Description: This command is used to reset the device. This command can be used to make previously changed properties take affect without having to unplug and then plug in the device. When the device resets, it automatically does a USB detach followed by an attach.
USB HID IntelliHead Swipe Reader 24
SECTION 5.
USB HID IntelliHead Swipe Reader SOURCE CODE Source code is included with the demo program. It can be used as a guide for application development. It is described in detail, with comments, to assist developers. The book USB Complete by Jan Axelson is also a good guide for application developers, especially the chapter on Human Interface Device Host Applications (see “Reference Documents” in Section 1).
APPENDIX A. DRAWINGS The following drawings are provided in this section: Part Number Title 21030006 21030010 21030042 21040124 21040128 21044000 21045087 21046003 21047011 USB HID IntelliHead, 3-Track, 125mm wire, 5-Pin Molex Connector USB HID IntelliHead, 3 Track, 440mm wire, 5-Pin Molex (Reverse pin out) USB HID IntelliHead, 3 Track, 4.
USB HID IntelliHead Swipe Reader Figure A-1.
Appendix A. Drawings Figure A-2.
USB HID IntelliHead Swipe Reader Figure A-3. USB HID IntelliHead, 3-Track, 125mm Wire, 4.
Appendix A. Drawings Figure A-4.
USB HID IntelliHead Swipe Reader Figure A-5.
Appendix A. Drawings Figure A-6.
USB HID IntelliHead Swipe Reader Figure A-7.
Appendix A. Drawings Figure A-8.
USB HID IntelliHead Swipe Reader Figure A-9.
