manualshive.com logo in svg

Magtek MICRSafe, Technical Reference Manual

Share
Download
Magtek MICRSafe Technical Reference Manual Download Page 31

 

Section 5.  USB Communications 

 

 

23 

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 device’s 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 the 
standard HID keyboard usages or vendor-defined magnetic stripe reader usage page 0xFF00.  
The vendor-defined 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. 
 
Magnetic Stripe Reader usage page 0xFF00: 

Usage ID 

(Hex) 

Usage Name 

Usage 

Type 

Report 

Type 

20 

Command message 

Data 

Feature 

 

REPORT DESCRIPTOR 

The HID report descriptor is structured as follows: 

Item 

Value(Hex) 

Usage Page (Generic Desktop) 

05 01 

Usage (Keyboard) 

09 06 

Collection (Application) 

A1 01 

Usage Page (Key Codes) 

05 07 

Usage Minimum (224) 

19 E0 

Usage Maximum (231) 

29 E7 

Logical Minimum (0) 

15 00 

Logical Maximum (1) 

25 01 

Report Size (1) 

75 01 

Report Count (8) 

95 08 

Input (Data, Variable, Absolute) 

81 02 

Report Count (1) 

95 01 

Report Size (8) 

75 08 

Input (Constant) 

81 03 

Report Count (5) 

95 05 

Report Size (1) 

75 01 

Usage Page (LEDs) 

05 08 

Usage Minimum (1) 

19 01 

Usage Maximum (5) 

29 05 

Output (Data, Variable, Absolute) 

91 02 

Report Count (1) 

95 01 

Summary of Contents for MICRSafe

Page 1: ...NICAL REFERENCE MANUAL Manual Part Number 99875466 3 OCTOBER 2010 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 w...

Page 2: ...or mechanical for any purpose without the express written permission of MagTek Inc MagTek is a registered trademark of MagTek Inc REVISIONS Rev Date Notes 1 01 Mar 3 2010 Initial Release 2 01 Aug 27...

Page 3: ...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...

Page 4: ...atus 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...

Page 5: ...3 Send Status After Data 13 SWC SWITCH C COMMAND 14 SWC PARAMETERS 15 CMC 7 Character Set 15 Invalid Command Response 15 Data Header 16 Card Data Message 16 HW HARDWARE COMMAND 16 HW PARAMETERS 17 Dis...

Page 6: ...G 49 E13 B CHARACTER SET 49 CMC 7 CHARACTER SET 49 CHECK LAYOUTS 50 MICR FIELDS 51 1 Transit Field 51 2 On Us Field 51 3 Amount Field 52 4 Auxiliary On Us Field 52 APPENDIX C TROUBLESHOOTING GUIDE 53...

Page 7: ...dicators 8 Table 4 2 SWB Command 11 Table 4 3 Control Characters 12 Table 4 4 Error and Status Codes 13 Table 4 5 SWC Command 14 Table 4 6 HW Command 17 Table B 1 CMC 7 Nonnumeric Characters 50 Figure...

Page 8: ...viii Figure 1 1 MICRSafe with 3 Track MSR...

Page 9: ...keyboard or optionally all international keyboards using ALT ASCII code keypad key combinations or customizable key maps This allows host applications designed to acquire card data from keyboard inpu...

Page 10: ...rface or using standard Windows HID drivers No third party device driver is required ACCESSORIES Accessories available for the MICRSafe are as follows Standard USB cable Part Number 22553301 Optional...

Page 11: ...w usb org ANS X9 24 2004 Retail Financial Services Symmetric Key Management Part 1 Using Symmetric Techniques SPECIFICATIONS Table 1 1 lists the specifications for the MICRSafe device Table 1 1 Specif...

Page 12: ...MICRSafe with 3 Track MSR 4...

Page 13: ...be downloaded from http www magtek com support software programming_tools under MICRSafe VCOM PROCEDURE Perform the following steps 1 Connect the interface cable s USB A connector to the PC 2 Connect...

Page 14: ...Windows operating system Sometimes Windows will find all the files it needs Other times Windows will need to know the location of the files it needs If Windows prompts for the file locations insert t...

Page 15: ...tly urge the check forward until the unit grabs the check When this happens release the check The check will then be transported around the check path and will exit through the other side 4 After the...

Page 16: ...operations The LED indicator for check reading is located to the left of the slot where the check is first inserted for reading The LED indicator for card reading is located on the upper left side of...

Page 17: ...a different Insta Change check MICRBASE SETUP PROGRAM FOR WINDOWS The MICRbase program P N 22000021 allows the user to control all the programmable options available in the MICRSafe NOTE MICRbase ver...

Page 18: ...ta is optional as described below for each command CR is always required All characters are ASCII No spaces brackets or angle brackets required If your MICRSafe is using an HID Keyboard Emulation inte...

Page 19: ...If no data is sent the MICRSafe responds with the current settings for SWB Table 4 2 SWB Command BIT PARAMETERS 7 6 5 4 3 2 1 0 0 LF No 1 LF Yes 0 CR No 1 CR Yes 0 ETX No 1 ETX Yes 0 ESC No 1 ESC Yes...

Page 20: ...f the STX and CR options are set to YES a MICR Data message from the MICRSafe will look like this MICR Data STX data CR Control Characters and Card Data If the card reader s head is set to security le...

Page 21: ...error status codes are listed in Table 4 4 For example if a Canadian check code 08 is read and has no errors and the MICR data is 1234567890 then the message from the MICRSafe will look like this MICR...

Page 22: ...he new settings become effective immediately To make this command permanent use the SA Save command described at the end of this section If no data is sent the MICRSafe responds with the current setti...

Page 23: ...ault If the MICRSafe receives an unrecognized command it will return a question mark and carriage return to the Host The MICRSafe will then return to an idle state and wait for further commands or che...

Page 24: ...the output message for the individual tracks when a credit card is read If Multiple is selected the Control Characters see SWB command above and Data Header see Data Header section above are added to...

Page 25: ...idually The tracks are always transmitted in ascending order TK1 TK2 TK3 For example if TK1 and TK3 are enabled and TK2 is disabled the MSR will transmit TK1 TK3 ID Card Decoding The MSR has two modes...

Page 26: ...ormat number VR VERSION COMMAND The Version command gives the current software revision in the MICR Reader To execute send the VR command followed by a carriage return as follows VR CR The MICRSafe re...

Page 27: ...wed by a carriage return as follows KS00 CR to send responses to the host via the USB interrupt pipe or KS01 CR to send responses as keystrokes SLP SLEEP MODE COMMAND This command puts the MICRSafe in...

Page 28: ...liary RS 232 port for transmitting check data only or RD03 CR to enable the use of the auxiliary RS 232 port for transmitting both MSR and check data If no data is sent the MICRSafe responds with the...

Page 29: ...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 keyboard data transfer rate The device also has an adjustable serial number desc...

Page 30: ...S 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 using a prog...

Page 31: ...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 the standard HID keyboard usages or vendor defined magnetic str...

Page 32: ...e HID class specific request Set Report The response to a command is retrieved from the device using the HID class specific request Get Report The requests are sent over the default control pipe When...

Page 33: ...will pass the command through to the MSR firmware which will process the command COMMAND NUMBER This one byte field contains the value of the requested command number The following table lists all th...

Page 34: ...defined in the following table Value Result Code Description 0 SUCCESS The command completed successfully 1 FAILURE The command failed 2 BAD_PARAMETER The command failed due to a bad parameter or comm...

Page 35: ...a multiple byte field that contains the value of the property The number of bytes in this field depends on the type of property and the length of the property The following table lists all of the pro...

Page 36: ...descriptor This property is stored in non volatile memory so it will persist when the unit is power cycled When this property is changed the unit must be reset see Command Number 2 or power cycled for...

Page 37: ...dwidth used by the device and slowing down the card data transfer rate decreases the USB bus bandwidth used by the device The value of this property will be sent to the host when the host requests the...

Page 38: ...keyboard keymap For example to transmit the ASCII character 063 decimal the character is looked up in a keymap For a United States keyboard keymap the forward slash key combined with the left shift k...

Page 39: ...to take effect Example Set ASCII To Keypress Conversion Type property Request Hex Cmd Num Data Len Prp ID Prp Value 01 02 0F 00 Example Set ASCII To Keypress Conversion Type property Response Hex Resu...

Page 40: ...this manual for a complete description of these commands To set up a device to use a custom key map select the appropriate key map to be modified using the active key map property reset the device to...

Page 41: ...erty to 0x03 end of text If you would like a carriage return to be sent as two carriage returns you could set the Convert From Char A property to 0x0D carriage return and set the Convert To String A p...

Page 42: ...ing A property Request Hex Cmd Num Data Len Prp ID Prp Value 01 03 1B 0D 0D Example Set Convert To String A property Response Hex Result Code Data Len Data 00 00 Example Get Convert To String A proper...

Page 43: ...Convert From Char B property Request Hex Cmd Num Data Len Prp ID Prp Value 01 02 1C FF Example Set Convert From Char B property Response Hex Result Code Data Len Data 00 00 Example Get Convert From C...

Page 44: ...ed to reset the device s USB CPU This command can be used to make previously changed properties take effect without having to unplug and then plug in the device When the device resets it automatically...

Page 45: ...ey modifier byte modifies the meaning of the key usage ID The modifier byte indicates if any combination of the right or left Ctrl Shift Alt or GUI keys are pressed at the same time as the key usage I...

Page 46: ...are sent to the host to represent the ASCII character The key map maps a single ASCII character to a single USB key usage ID and USB key modifier byte The key usage ID and the key modifier byte are tr...

Page 47: ...F For example to set the key map item for ASCII character card data end sentinel use the ASCII value of which is 63 0x3F 1 Key Usage ID The value of the USB key usage ID that is to be mapped to the gi...

Page 48: ...legacy commands to the device over the USB The device will send up to two responses to this command The first response is the standard response to a USB command This response indicates to the host th...

Page 49: ...1 Response Data None Result codes 0 success Example Request Hex Cmd Num Data Len Data SWB CR 07 04 53 57 42 0D Example Response Hex Result Code Data Len Data 00 00 Example Legacy Command Response send...

Page 50: ...MICRSafe with 3 Track MSR 42...

Page 51: ...nd MagnePrint information may depending on how the MICRSafe is configured be TDEA Triple Data Encryption Algorithm aka Triple DES encrypted using DUKPT Derived Unique Key Per Transaction key managemen...

Page 52: ...MICRSafe with 3 Track MSR 44...

Page 53: ...a check is read The formats may be selected using the FC command Section 4 Legacy Commands or Insta Change checks provided by MagTek Each format is assigned a 4 digit number which indicates the forma...

Page 54: ...spaces and dashes check always 6 characters zero filled Fmt 2400 transit T acct A check C amount transit all characters in the field keep dashes acct all characters are sent remove spaces and dashes...

Page 55: ...he field remove dashes and spaces Fmt 7600 T transit A acct C check M raw data transit all characters in the field remove dashes and spaces acct all characters are sent remove dashes and spaces check...

Page 56: ......

Page 57: ...ed in the US Canada Australia United Kingdom Japan India Mexico Venezuela Colombia and the Far East The CMC 7 set is used in France Spain other Mediterranean countries and most South American countrie...

Page 58: ...CMC 7 Nonnumeric Characters CMC 7 Character MICRSafe Output SI A SII B SIII C SIV D SV E CHECK LAYOUTS Personal checks with MICR fields are shown in Figure B 1 Business checks are shown in Figure B 2...

Page 59: ...ided as follows Digits 1 4 Federal Reserve Routing Number Digits 5 8 Bank ID Number American Banking Association Digit 9 Check Digit 2 On Us Field The On Us field is variable up to 19 characters inclu...

Page 60: ...acketed by Amount symbols The field is always zero filled to the left 4 Auxiliary On Us Field The Auxiliary On Us field is variable 4 10 digits bracketed by two On Us symbols This field is not present...

Page 61: ...f compressed air A cleaning card P N 96700006 SET UP Plug the USB Cable P N 22553301 into the MICRSafe and the host computer Power on the MICR Reader Run the MICRbase program on the PC Start trouble s...

Page 62: ...ove are true If yes rectify and continue to step 00 If no continue to step 18 02 READ A CHECK Read a check through the MICRSafe If the check is transported all the way around the check path continue t...

Page 63: ...not hold on to the check as it goes around the path Release the check immediately after the MICRSafe grabs it Also make sure that the front end is not tilted up while the check is being read Foreign d...

Page 64: ...conditions described above are true If yes rectify and continue to step 02 If no continue to step 18 09 PATH IS OBSTRUCTED Foreign debris is obstructing the check path Loose debris power off the MICR...

Page 65: ...MF are monitors DC adapters or magnetic devices Set EMF to NO or move the MICRSafe at least 6 inches away from the source of noise interference Determine if the condition described above is true If ye...

Page 66: ...no continue to step 15 14 CABLE PROBLEM Possible causes for this problem are Loose connection the cable connector on the PC or the MICRSafe may be loose Make sure that both connectors are tightly conn...

Page 67: ...ther analysis testing and possibly repair Please contact your supplier or MagTek Support Services at 651 415 6800 for additional troubleshooting and if necessary repair Please have the device availabl...

Page 68: ...MICRSafe with 3 Track MSR 60...

Page 69: ...9 29 41 I 49 73 i 69 105 LF 0A 10 2A 42 J 4A 74 j 6A 106 VT 0B 11 2B 43 K 4B 75 k 6B 107 FF 0C 12 2C 44 L 4C 76 l 6C 108 CR 0D 13 2D 45 M 4D 77 m 6D 109 SO 0E 14 2E 46 N 4E 78 n 6E 110 SI 0F 15 2F 47...

Page 70: ...MICRSafe with 3 Track MSR 62...

Page 71: ...a keyboard may be modified for a different language by simply printing different keycaps One example is the Y key on a North American keyboard In Germany this is typically Z Rather than changing the k...

Page 72: ...Y 4 22 4 101 104 29 1D Keyboard z and Z 4 46 4 101 104 30 1E Keyboard 1 and 4 2 4 101 104 31 1F Keyboard 2 and 4 3 4 101 104 32 20 Keyboard 3 and 4 4 4 101 104 33 21 Keyboard 4 and 4 5 4 101 104 34 22...

Page 73: ...9 45 Keyboard F12 123 101 104 70 46 Keyboard PrintScreen 1 124 101 104 71 47 Keyboard Scroll Lock 11 125 4 101 104 72 48 Keyboard Pause 1 126 101 104 73 49 Keyboard Insert 1 75 101 104 74 4A Keyboard...

Page 74: ...ower 9 103 67 Keypad 104 68 Keyboard F13 62 105 69 Keyboard F14 63 106 6A Keyboard F15 64 107 6B Keyboard F16 65 107 6C Keyboard F17 109 6D Keyboard F18 110 6E Keyboard F19 111 6F Keyboard F20 112 70...

Page 75: ...oard Lang1 25 145 91 Keyboard Lang2 26 146 92 Keyboard Lang3 30 147 93 Keyboard Lang4 31 148 94 Keyboard Lang5 32 149 95 Keyboard Lang6 8 150 96 Keyboard Lang7 8 151 97 Keyboard Lang8 8 152 98 Keyboar...

Page 76: ...Keypad 197 C5 Keypad 198 C6 Keypad 199 C7 Keypad 200 C8 Keypad 201 C9 Keypad 202 CA Keypad 203 CB Keypad 204 CC Keypad 205 CD Keypad Space 206 CE Keypad 207 CF Keypad 208 D0 Keypad Memory Store 209 D1...

Page 77: ...0 See additional foot notes in Universal Serial Bus HID Usage Tables Copyright 1996 2005 USB Implementers Forum 21 Toggle Double Byte Single Byte mode 22 Undefined available for other Front End Langua...

Page 78: ...MICRSafe with 3 Track MSR 70...

Page 79: ...ce Class Definition for Human Interface Devices HID Version 1 11 and specifically for this manual Section 8 3 Report Format for Array Items The modifier byte is defined as follows Table F 1 Modifier B...

Reviews:

No comments

Brands by name

Popular brands

Load more brands