msr210u progammers manual

MSR210U

Programmer’s Manual

Magnetic Stripe Card Reader - HID Keyboard Emulation -

Document #: PM044-U

Revision C

Sep. 20, 2005

MSR210U Programmer’s Manual UDN PM044-U Rev. C

NOTICE The issuer of this manual has made every effort to provide accurate information. The issuer

will not be held liable for any technical and editorial omission or errors made herein; nor for

incidental consequential damages resulting from the furnishing, performance or use of this

material. This document contains proprietary information that is protected by copyright. All

rights are reserved. No part of this document may be photocopied, reproduced, or translated

without the prior written consent of the issuer. The information provided in this manual is

subject to change without notice.

AGENCY APPROVED - Specification for FCC Class A

- BSMI (Bureau of Standards, Metrology and Inspection, Taiwan)

NOTE: This equipment has been tested and found to comply with the limits for a Class A

digital device, pursuant to Part 15 of the FCC Rules. These limits are designed to provide

reasonable protection against harmful interference when the equipment is operated in a

commercial 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. Operation of this equipment in a residential

area is likely to cause harmful interference in which case the user will be required to correct

the interference at his own expense.

You are cautioned that any change or modifications to the equipment not expressly approve

by the party responsible for compliance could void your authority to operate such equipment.

BSMI 甲類 Class A 警語

警告使用者：

這是甲類的資訊產品，在居住的環境中使用時，可能會造成射頻干

擾，在這種情況下，使用者會被要求採取某些適當的對策。

I


WARRANTY This product is served under one-year warranty to the original purchaser. Within the warranty

period, merchandise found to be defective would be repaired or replaced. This warranty

applies to the products only under the normal use of the original purchaser, and in no

circumstances covers incidental or consequential damages through consumers’ misuse or

modification of the products.

PREFACE This manual provides detailed information relating to the overall operational, electrical,

mechanical, environmental and functional aspects of the MSR210U. This document should

be read and understood prior to initial operation of the product.

For ease of installation and programming use, we have addressed everything from its

attractive features to its various configurations.

When designing the MSR210U, we selected what we feel are the most useful features and

functions. If in some cases you find that your specific needs differ from our existing products,

we welcome your comments and suggestions. Custom-designed models are also available.

If further questions do arise, please call for technical support, our FAE will assist you in any

way we can.

II


Table of Contents Section 1 General Description................................................1-1

Features............................................................................................................ 1-1 Application ....................................................................................................... 1-1 Function ........................................................................................................... 1-1 Part Number Description ................................................................................ 1-2

Section 2 Configurations ........................................................2-1

Dimensions of MSR210U ................................................................................ 2-1 Installation........................................................................................................ 2-2

Section 3 Technical Specifications ........................................3-1

Magnetic Card Specifications......................................................................... 3-1 Mechanical Specifications.............................................................................. 3-2 Electrical Specifications ................................................................................. 3-2 Environmental Specifications ........................................................................ 3-3 USB Communication Specifications.............................................................. 3-4 Data Output Format ......................................................................................... 3-4

Section 4 Operation of Normal Mode.....................................4-1

LED Indication ................................................................................................. 4-1 Card Reading ................................................................................................... 4-1

Section 5 Operation of Configuration Mode..........................5-1

Operation Procedure....................................................................................... 5-1 Setting Items .................................................................................................... 5-1

Section 6 Operation of Download Mode ................................6-1

Section 7 Configuration Mode Specification.........................7-1

Enter Configuration Mode .............................................................................. 7-1 Configuration Settings.................................................................................... 7-1 PS/2 Scan Code Table ..................................................................................... 7-1

Section 8 Download Mode Specification ...............................8-1

Enter Boot Mode.............................................................................................. 8-1 Command Sets................................................................................................. 8-1

Section 9 Usage of API............................................................9-1

API Command Sets.......................................................................................... 9-1

III


Section 1 General Description

This section presents general information about the basic characters of the MSR210U.

Features The MSR210U provides the following features:

1 Friendly setting.

2 No external power supply required.

3 No third party device driver is required.

4 Single, dual, or triple track versions allow to reading ISO, AAMVA and DMV cards.

5 LED and Buzzer indicators indicate the status of reader.

6 Programmable data output.

7 Firmware upgradeable

Application This Magnetic Stripe Reader, MSR210U is designed to read high or low coercive

magnetic cards. It can simultaneously decode/verify up to 3 tracks of data. This product

communicates with a host computer using USB keyboard interface. The reader can read

magnetic data form, any available track encoded per ISO 7810, 7811, AAMVA, DMV.

The host can request the read data from the reader with setting sequences. For details of

sequences, refer to Section 4.

Function Self Test Whenever the reader experiences a reset cycle, a self-test on the resources is

performed.

Indication

LED Buzzer SW1_1 SW1_2Cause

Green 1 Beep OFF OFF Test Success

Red OFF OFF EEPROM Failed

Amber OFF OFF Internal ROM Failed

Amber OFF ON In Download Mode

Green 2 Beep ON OFF Default Configuration Working

1-1


Default Interface Configuration Working 1.

2.

3.

4.

1.

2.

3.

4.

5.

6.

Detach the device from USB port.

Switch S1_1 on and attach the device into a USB port.

The device will beep twice and the green LED will turn on.

The device will work under default setting condition as below: a. transmitting speed

is 80 char/sec, and b. keyboard country is U.S. As soon as turn off the switch S1_1

and re-attach the USB connector, the device will work as user’s previous settings.

Solution for Firmware Corrupting Detach the device from USB port.

Switch S1_2 on and attach the device into a USB port.

The LED will turn amber indicating that the device is into firmware download mode.

Execute MSR210U Download Application Program to download proper file into the

device.

When the download process has accomplished, turn off the switch S1_2 and

re-attach the USB connector.

The LED will turn green if download process is success.

Transmitting Data Block of Tracks Each track could be divided into 1~3 blocks for transmission and each block can be set

as different card types and character numbers. If the set data is different from the data

after swiping, the reader will transmit completed data without limitation. The sequences

for setting blocks are shown in Section 4.

Part Number Description The brief configuration of MSR210U part number are shown as below:

MSR210U-12 Dual track 1&2

MSR210U-23 Dual track 2&3

MSR210U-33 Triple track 1&2&3

Note:

Optional configuration is available.

1-2


Section 2 Configurations

This section shows the dimensions and setup for the MSR210U.

Dimensions of MSR210U

Figure 2-1 Dimensions of MSR210U

2-1


Installation 1.

2.

3.

4.

Attach the device into a USB port on the host.

Insert the CD of operation system that your PC is using for installing the driver of

HID keyboard device.

Follow the instruction in the dialog box to install the driver correctly.

If everything has accomplished, the LED will turn green indicating that the device is

ready for use.

Note:

The process of installing driver will be unnecessary only if the device is attached into

other USB port.

Figure 2-2 Installing MSR210U

2-2


Section 3 Technical Specifications

Magnetic Card Specifications

Card Type ISO standard card (ISO 7810 and 7811)

CA old DMV

AAMVA

Read high or low coercivity magnetic stripes (300-4000oe)

Thickness 0.76mm ± 0.08mm

Card Format Track 1 & 3: 210 bpi

Track 2: 75/210 bpi

Card Operation Speed Test Card Speed (IPS)

ISO standard card 5-55

* Jitter 5-50

** Low Amplitude 5-50

Note:

*Jitter card: Reliable reading of magnetic stripes encoded with bit cell length variations

within ±15% of normal as defined by ISO 7811.

**Low amplitude:

Reliable reading of magnetic stripes encoded at 60% or more of the encoding amplitude

as defined by ISO 7811.

3-1


Mechanical Specifications

Body Material ABS 94V-0

Cover and Cable Color IBM 43-4208 pearl white

Dimension Length: 100mm

Width: 34mm

Height: 28mm

Weight 120g

Interface Cable Length 2 meters

Magnetic Head Life 500K Min., 1M optional

Electrical Specifications

Power Required DC 5V ± 5% (from PC)

Power Consumption 35mA Max. in normal operation

Communication Compatible with USB specification Revision 1.1

Ripple 50mVp-p Max.

3-2


Dielectric Strength 250VDC for 1 minute

Insulation Resistance 10MΩ min. at 250VDC

Environmental Specifications

Temperature Operating: -10-55°C

Storage: -30-70°C

Humidity Operating: 15-90% (non condensing)

Storage: 10-90% (non condensing)

3-3


USB Communication Specifications

Identification Information Vendor ID: 04B4h

Product ID: 210Ah

Class HID Keyboard Device, compatible with HID specification Version 1.1

USB Connector Termination Assignment

Contact

Number Signal Name

Typical Wiring

Assignment

1 VBUS Red

2 D- White

3 D+ Green

4 GND Black

Shell Shield Drain Wire

Data Output Format

Preamble Card Data Postamble

TK1 Prefix TK1 Data TK1 Suffix



3-4


Section 4 Operation of Normal Mode

This section describes the LED indication and card reading in Normal Mode.

LED Indication The LED indicator will be either off, amber, red and green in the normal mode. When the

device is not powered, the LED will be off. The LED will turn green and buzzer beeps

once, only if the device is attached and enumerated.

When a card is being swiped, LED will turn off awhile or till the swipe is accomplished. If

there are no errors recognizing the card data, the LED will turn green and buzzer beeps

once. If the LED turns amber and buzzer beeps twice, there is probability some data

unrecognizable or it is not a triple track card. If no data is recognized, the LED will turn

red and buzzer beeps three times. When LED becomes green form red, the device will

be ready to read the next card.

Card Reading To exhibit the card reading capabilities, any text editor program that accepts keyboard

input can be used such as Microsoft Notepad and Word.

Caution:

Any keyboard is connected to the same host with this device and a key is pressed

while data transmitting, it may cause data corruption.

4-1


Section 5 Operation of Configuration Mode

This section describes the operation procedure and all setting items of the configuration

mode.

Operation Procedure Please use MSR210U Setup Application Program to perform the configuration settings

and refer to the User’s Instruction Guide for operating.

Setting Items The main menu of Configuration Mode is as below:

****configuration mode****

1: set interface

2: set magnetic string

3: set string editing

4: set buzzer

5: reset to default

6: show status

0: exit setup mode

Note:

Once user choose [0] to exit Configuration Mode, the reader will be reset and execute

the modified settings.

Set Interface In the main menu, users can choose [1] to enter Set Interface sub-menu.

1: set keyboard country

2: set transmit speed

3: firmware version and date

0: back

5-1


1: Set Keyboard Country

This is used to inform the reader about the keyboard type that should be used when

transmitting card data. The default setting is “U.S.”. It will be shown as below:

1: U.S.

2: German

3: French

4: UK English

5: Spanish

6: Italy

7: Dutch

8: Portuguese

9: Swedish

a: Danish

0: back

reader status = U.S.

Note:

reader status displays the country of keyboard interface in use. The user could choose

[1] through [A] to change the keyboard interface. Choose [0] to return to last menu.

2: Set Transmit Speed

This is used to set the speed of card data sent to the host. The default setting is “80

characters/sec”. It will be shown as below:

**** set transmit speed ****

1: 25 character/sec

2: 40 character/sec

3: 60 character/sec

4: 80 character/sec

0: back

reader status = 80 char/sec

5-2


3: Firmware Version And Date

Display the firmware version, release date, and the programmer of the reader. The

message is shown as below as an example:

2100161d 11-mar-2004

Note:

Where 2100161d represents the version of firmware.

Set Magnetic String In the main menu, user could choose [2] to enter Set Magnetic String sub-menu.

1:set enable tracks

2:set require tracks

3:carriage return

4:transmit ss/es

5:caps lock

6:track output order

7:change carriage return code

8:output cr if read nothing

9:raw data output

0:back

5-3


1: Set Enable Tracks

This function is used to enable and disable specific tracks of data sent from the reader.

The default setting is “track 1, 2, 3”. For example, for a triple track reader it may be

necessary in some applications to use only track 2 data. In this case, this setting can

make track 2 enabled and disable track 1&3.

**** enable tracks ****

1: track 1

2: track 2

3: track 1,2

4: track 3

5: track 1,3

6: track 2,3

7: track 1,2,3

0: back

reader status = track 1,2,3

2: Set Require Tracks

This function is used to set require track as criteria of effective reading. The default

setting is “any track”. The criteria means if the require track has been read after swiping

card. For example, if user set track 2 as a criterion and gets track 2 data exactly from the

reading data, then it is a good reading and the reader sends all enabled track data to the

host. If not, the reader doesn’t transmit any data. The default setting is “any track will be

considered a good read”. This feature is useful if your software requires specific tracks of

the card data.

**** require tracks ****

1:track 1

2:track 2

3:track 1,2

4:track 3

5:track 1,3

6:track 2,3

7:track 1,2,3

8:any track

0:back

reader status = any track

5-4


3: Carriage Return

This is used to set the output data with or without carriage return for each track. The

default setting is “after each track”.

**** carriage return ****

1:don't send carriage return

2:after all tracks

3:after each track

4:after all data

0:back

reader status = after each track

Note:

”After all data” means to send CR out following card data plus something like

preamble/postamble, and “after all track” means to do it right after sending out card data.

4: Transmit SS/ES

This function is used to determine whether the SS and ES of each track will be sent with

the card data. The default setting is “enable”. (SS: start sentinel; ES: end sentinel)

**** ss/es send ****

1:send

2:no send

0:back

reader status = enable

5: Caps Lock

This function is used to set the send data as capital letters. The default setting is “enable”.

No matter what the Caps Lock on the keyboard is ON or OFF, the reader is always

sending out the capital letters while the setting is “enable”. Once this setting is “disable”,

the letters of the sent data are consistent with the Caps Lock status.

The default setting is “enable”.

1:enable

2:disable

0:back

reader status = enable

5-5


6: Track Output Order

The track output order is used to control the order and appearance of each track output.

The default setting is “1, 2, 3”. You have to input the track in order; i.e.: FIRST, SECOND,

and then THIRD.

1:track 1

2:track 2

3:track 3

0:back

reader status = 1,2,3

first:

second:

third:

7: Change Carriage Return Code

The change carriage return code is used to change the code of carriage return. The

default setting is [enter].

1:change

2:reset

0:back

reader status = [enter]

After setting, you may re-confirm it by entering change carriage return code section.

You shall see:

1:change

2:reset

0:back

reader status = [shift]4

8: Output CR If Read Nothing

The default setting is “disable”.

no data, output carriage return

1:enable

2:disable

0:back

5-6


9: Raw Data Output (U.S.A. only)

The default setting is “disable”.

**** set raw data output ****

1:enable

2:disable

0:back

Set String Editing In the main menu, select [3] to enter set string editing sub-menu.

1:set prefix

2:set suffix

3:set magnetic stripe preamble

4:set magnetic stripe postamble

5:block output order

6:send control

7:field output order

8:exp date format

9:exp date separator

0:back

5-7


1: Set Prefix

The track 1, 2, 3 prefix are 6-character strings that are transmitted prior to the track data.

It will be shown as below:

1:track 1

2:track 2

3:track 3

0:back

**** set track 1 prefix ****

1:enable

2:disable

0:back

reader status = disable

enter prefix (6 chars max) then press ` when finished

important! [caps] key is not allowed

After selecting tracks, user set the prefix for the specific track. If the track needs prefix,

choose [1], users can input 1~6 characters to be as the prefix; if not, choose [2]. The

default setting is “disable”.

5-8


2: Set Suffix

The track 1, 2, 3 suffix are 6-character strings that are transmitted after to the track data.

It will be shown as below:

1:track 1

2:track 2

3:track 3

0:back

**** set track 1 suffix ****

1:enable

2:disable

0:back


enter suffix (6 chars max) then press ` when finished


After selecting tracks, user set the suffix of the specific track. If the track needs suffix,

choose [1], users can input 1~6 characters to be as the suffix; if not, choose [2]. The


3: Set Magnetic Stripe Preamble

The preamble is a 6-character string that is transmitted before all card data. This string

allows you to ensure that the cursor is positioned at the desired location at the time of a

card swipe.

**** set preamble ****

1:enable

2:disable

0:back


enter preamble (6 chars max) then press ` when finished


If choose [1], then users can input 1~6 characters to be as the preamble; if not, choose

[2]. The default setting is “disable”.

5-9


4: Set Magnetic Stripe Postamble

The postamble is a 6-character string that is transmitted after all card data. This string

allows you to ensure that the cursor is positioned at the desired location at the time of a

card swipe.

**** set postamble ****

1:enable

2:disable

0:back


enter postamble (6 chars max) then press ` when finished


If choose [1], then users can input 1~6 characters to be as the postamble; if not, choose

[2]. The default setting is “disable”.

Note:

For 1~4 item in the Set String Editing mode, if users input up to 6 characters, this mode

will be finished automatically, if less than 6 characters, users can click the key ` escaping

this mode.

The key ` is the character for U.S. keyboard configuration. For the same function, please

click the exact position on the keyboard as below.

5-10


5: Block Output Order

The Block Output Order is used to control the order and appearance of each block output.

Each track has three blocks (A, B, C) which could be set conforming to ISO, DMV,

AAMVA or Trade Show, and the characters of each block could be set during 1~109.

Example:

Controlling the output data format of block A on track 1 is ISO standard card, 15th

character to 30th character. The procedure is as follows:

Step 1: Choosing [1] to set data format of track 1.

**** set block output order ****

1:track 1

2:track 2

3:track 3

0:back

Step 2: Choosing [1] to set block a.

1:block a

2:block b

3:block c

0:back

Step 3: Choosing [3] to set the card type is ISO standard.

** set track1 block a **


1:dmv

2:aamva

3:iso

4:trade show

9:disable

0:back

Step 4: To set the range of the transmitting data format. Please click [Enter] key on the

Configuration Setup AP to confirm the input data.

START = 15

END = 30

5-11


Example:

For track 1, if you set block A is ISO type 1-4, block B is DMV type 6-9 and block C is ISO

type 11-25, then

1.while you swipe an ISO card, it’ll output char 1-4 plus 11-25 of track 1 data.

2.while you swipe a DMV card. It’ll output char 6-9 of track 1 data.

3.while you swipe an AAMVA card/ it’ll output all char of track1 data.

6: Send Control

This function is used to control the reader send out data until users input a specific key or

any key by the MSR210U setup application program after swiping cards. After choosing

[1] and a beep sound, a user starts to set the key, which will become to control the send

data. That means the reader will not send data until users click the exact key. If choose

[2], the reader will send data once clicking any key excluding extension key(s). The


1:set key

2:any key

3:disable

0:back


7: Field Output Order

The Field Output Order is used to control the order and appearance of each field output.

Each card has three fields could be set (i.e.: name, account, and expire date). You may

set one, two, or three fields that depend on actual application. The default setting is

“disable”.

1:enable

2:disable

0:back


5-12


Step: Choosing [1] to enable field output order.

1:name

2:account

3:expire date

0:back

first:

second:

third:

Example:

Setting the Field Output Order as expire date, name, and account in order. The

procedure is as follows:

Step 1: Choosing [1] to enable field output order.

1:name

2:account

3:expire date

0:back

first:

Step 2: Click [3] to choose expire date as the first output field.

1:name

2:account

3:expire date

0:back

first:

second:

5-13


Step 3: Click [1] to choose name as the second output field.

1:name

2:account

3:expire date

0:back

first:

second:

third:

Step 4: Click [2] to choose account as the third output field.

After setting done, you may re-confirm it by entering “Field Output Setting” section. You

shall see:

1:enable

2:disable

0:back

reader status = expire date,name,account

8: Exp Date Format

The Expire Date Format is used to set the format of expiration date of the Field Output

Order. This function only is effective while Field Output Order is enable, and won’t impact

on general card data output. The default setting is “YYMM”.

1:yymm

2:mmyy

0:back

reader status = yymm

5-14


9: Exp Date Separator

The Expire Date Separator is used to set a specific character to separate the MM and YY

that is defined in Expire Date Format. This function only is effective while Field Output

Order is enable, and won’t impact on general card data output. The default setting is

“disable”.

1:change

2:reset

0:back


Set Buzzer In the main menu, choose [4] to enter set buzzer mode. Clicking [1] to makes the buzzer

of the device active, or click [2] makes buzzer of the device inactive. But when the device

is in the mode of Default Interface Configuration Working (S1_1 ON), the buzzer will beep

once after attaching the device. The default setting is “enable”.

Reset To Default In the main menu, cho

defaults returns the unit

**** set buzzer enable/disable ****

1:enable

2:disable

0:back

ose [5] to enter reset to default mode. Clicking [1] to reset all

to initial factory settings.

1:reset to default

0:back

5-15


Show Status

In the main menu, click [6] to display all of the existing settings of the reader.

For example:

keyboard country=u.s.

transmit speed=120 char/sec

enable tracks=track 1,2,3

require tracks=any track

carriage return=after each track

ss/es send=enable

caps lock=enable

raw data output=disable

buzzer=enable

data output=1,2,3

keyboard=standard configuration

press 0 to back

To click any key checks other settings of the reader, and click [0] escaping show status

mode backing to the main menu.

track 1 prefix=disable



track 1 suffix=disable



preamble=disable

postamble=disable

press 0 to back

To click any key checks other settings of the reader, and click [0] escaping show status

mode backing to the main menu.

5-16


track1 block a=disable

track1 block b=disable

track1 block c=disable







After showing all of the settings, press any key to back to the main menu.

5-17


Section 6 Operation of Download Mode Please refer to the User’s Instruction of MSR210U Download Application Program.

6-1


Section 7 Configuration Mode Specification

This section provides the information about operating in configuration mode via HID Class

API to send the scan code of PS/2 interface from host to the device.

Enter Configuration Mode The device can accept PS/2 scan codes in Normal Mode and Configuration Mode.

Procedure 1. Attach the device into a USB port.

2. Send the scan codes 14h (Left Ctrl make code), 11h (Left Alt make code), 09h (F10

make code) and then F0h 09h (F10 break code), F0h 11h (Left Alt break code), F0h

14h (Left Ctrl break code) to the device. As soon as the device acknowledges these

scan codes, it will go into configuration mode and the LED goes blinking.

3. The device will send out entire data of the configuration mode menu to where cursor

is.

Configuration Settings In the configuration mode, host only needs to send the make codes and break codes to

device sequentially to emulate a keystroke for configuration settings.

Caution:

The break code must be sent to the device if a relative make code has been accept,

otherwise host will assume that the specific key is not released.

PS/2 Scan Code Table key

location

101/102 Enhanced

Keyboard

scan 1

make

scan 1

break

scan 2

make

scan 2

brake

1 ~ ` 29 A9 0E F0 0E

2 ! 1 02 82 16 F0 16

3 @ 2 03 83 1E F0 1E

4 # 3 04 84 26 F0 26

5 $ 4 05 85 25 F0 25

6 % 5 06 86 2E F0 2E

7-1


key

location

101/102 Enhanced

Keyboard

scan 1

make

scan 1

break

scan 2

make

scan 2

brake

7 ^ 6 07 87 36 F0 36

8 & 7 08 88 3D F0 3D

9 * 8 09 89 3E F0 3E

10 ( 9 0A 8A 46 F0 46

11 ) 0 0B 8B 45 F0 45

12 _ - 0C 8C 4E F0 4E

13 + = 0D 8D 55 F0 55

15 Backspace 0E 8E 66 F0 66

16 Tab 0F 8F 0D F0 0D

17 Q 10 90 15 F0 15

18 W 11 91 1D F0 1D

19 E 12 92 24 F0 24

20 R 13 93 2D F0 2D

21 T 14 94 2C F0 2C

22 Y 15 95 35 F0 35

23 U 16 96 3C F0 3C

24 I 17 97 43 F0 43

25 O 18 98 44 F0 44

26 P 19 99 4D F0 4D

27 [ 1A 9A 54 F0 54

28 ] 1B 9B 5B F0 5B

29* | \ 2B AB 5D F0 5D

30 Caps Lock 3A BA 58 F0 58

31 A 1E 9E 1C F0 1C

32 S 1F 9F 1B F0 1B

33 D 20 A0 23 F0 23

34 F 21 A1 2B F0 2B

35 G 22 A2 34 F0 34

36 H 23 A3 33 F0 33

37 J 24 A4 3B F0 3B

38 K 25 A5 42 F0 42

39 L 26 A6 4B F0 4B

40 : ; 27 A7 4C F0 4C

41 “ ‘ 28 A8 52 F0 52

42** 2B AB 5D F0 5D

7-2


key

location

101/102 Enhanced

Keyboard

scan 1

make

scan 1

break

scan 2

make

scan 2

brake

43 Enter 1C 9C 5A F0 5A

44 L SHIFT 2A AA 12 F0 12

45** 56 D6 61 F0 61

46 Z 2C AC 1A F0 1A

47 X 2D AD 22 F0 22

48 C 2E AE 21 F0 21

49 V 2F AF 2A F0 2A

50 B 30 B0 32 F0 32

51 N 31 B1 31 F0 31

52 M 32 B2 3A F0 3A

53 < , 33 B3 41 F0 41

54 > . 34 B4 49 F0 49

55 ? / 35 B5 4A F0 4A

56*** 73 F3 51 F0 51

57 R SHIFT 36 B6 59 F0 59

58 L CTRL 1D 9D 14 F0 14

60 L ALT 38 B8 11 F0 11

61 Space Bar 39 B9 29 F0 29

62 R ALT E0 38 E0 B8 E0 11 E0 F0 11

64 R CTRL E0 1D E0 9D E0 14 E0 F0 14

75 Insert E0 52 E0 D2 E0 70 E0 F0 70

76 Delete E0 53 E0 D3 E0 71 E0 F0 71

79 L Arrow E0 4B E0 CB E0 6B E0 F0 6B

80 Home E0 47 E0 C7 E0 6C E0 F0 6C

81 End E0 4F E0 CF E0 69 E0 F0 69

83 Up Arrow E0 48 E0 C8 E0 75 E0 F0 75

84 Dn Arrow E0 50 E0 D0 E0 72 E0 F0 72

85 Page Up E0 49 E0 C9 E0 7D E0 F0 7D

86 Page Down E0 51 E0 D1 E0 7A E0 F0 7A

89 R Arrow E0 4D E0 CD E0 74 E0 F0 74

90 Num Lock 45 C5 77 F0 77

91 Numeric 7 47 C7 6C F0 6C

92 Numeric 4 4B CB 6B F0 6B

93 Numeric 1 4F CF 69 F0 69

95 Numeric / E0 35 E0 B5 E0 4A E0 F0 4A

7-3


key

location

101/102 Enhanced

Keyboard

scan 1

make

scan 1

break

scan 2

make

scan 2

brake

96 Numeric 8 48 C8 75 F0 75

97 Numeric 5 4C CC 73 F0 73

98 Numeric 2 50 D0 72 F0 72

99 Numeric 0 52 D2 70 F0 70

100 Numeric * 37 B7 7C F0 7C

101 Numeric 9 49 C9 7D F0 7D

102 Numeric 6 4D CD 74 F0 74

103 Numeric 3 51 D1 7A F0 7A

104 Numeric . 53 D3 71 F0 71

105 Numeric - 4A CA 7B F0 7B

106 Numeric + 4E CE 79 F0 79

107*** 7E FE 6D F0 6D

108 Numeric Enter E0 1C E0 9C E0 5A E0 F0 5A

110 Esc 01 81 76 F0 76

112 F1 3B BB 05 F0 05

113 F2 3C BC 06 F0 06

114 F3 3D BD 04 F0 05

115 F4 3E BE 0C F0 0C

116 F5 3F BF 03 F0 03

117 F6 40 C0 0B F0 0B

118 F7 41 C1 83 F0 83

119 F8 42 C2 0A F0 0A

120 F9 43 C3 01 F0 01

121 F10 44 C4 09 F0 09

122 F11 57 D7 78 F0 78

123 F12 58 D8 07 F0 07

124 Print Screen E0 2A E0 37 E0 B7 E0 AA E0 12 E0 7C E0 F0 7C E0 F0

12

125 Scroll Lock 46 C6 7E F0 7E

126 Pause E1 1D 45 E1 9D

C5 None

E1 14 77 E1 F0

14 F0 77 None

Left Win E0_5B E0_DB E0_1F E0_F0 1F

Right Win E0_5C E0_DC E0_27 E0_F0 27

Application E0_5D E0_DD E0_2F E0_F0 2F

Note *

Key 29 is available on the US and not on the International Keyboard.

7-4


Note **

Keys 42 and 45 are available on the International Keyboard and not on the US Keyboard.

Note ***

Keys 56 and 107 are used on Brazilian and some Far East keyboards. They are not available

on US Keyboards.

7-5


Section 8 Download Mode Specification

This section provides the information about firmware download via HID Class API to send

packet commands from host to the device.

Enter Boot Mode The device can accept packet commands only in Boot Mode.

Procedure 1.

2.

Attach the device into a USB port.

Send the single command C5 to the device. As soon as the device acknowledges

this command, it will go into boot mode and the LED goes amber from green.

When the device is in boot mode, it can accept packet commands from host to do

download firmware.

For download firmware, the host shall send packet command(s) to device sequentially.

When finishes download, the host shall send the packet command to reset the device. If

any errors that except LRC error are occurred during download, the host will receive a

packet command that indicates error code from the device. After the host received the

packet command, it shall abort the process.

Command Sets This section describes the packet commands and responses available for the device.

Each system packet command format includes its data element, size and comments. The

comments provide an explanation of each data element. The letter 'h' written in size

column is an abbreviation of 'hexadecimal'.

Except single commands, all system packet commands are preceded by a header, hex

code C2h, and terminated with one byte LRC. LRC is an XOR of the 8 data bits,

excluding header, of each character in the entire packet command.

8-1


System Packet Command Format:

<Header><Command Type><Data Length>[Data]LRC

Data Element Size Comments

<Header> 01h Packet Command Header, Value: C2h

<Command Type> 01h Command code

<Data Length> 01h Indicate the length of [Data]

[Data] 1~256 Optional

LRC 01h Error Check

Maximum: 260 characters Minimum: 5 characters

The device’s packet commands can be divided into two categories as below:

Single Commands

System Packet Commands

Single Commands The single commands are used to enter boot mode and active/inactive the interface

between host and keyboard. The device will react to these commands without

responding any message to host.

Command

(Hexadecimal) Description

C5h Request the reader to enter boot mode

C7h Active the path between host and keyboard

C8h Inactive the path between host and keyboard

C5 — Request the reader to enter boot mode

After power on the device, the host sends this command to device for entering boot mode

and the LED goes amber from green.

C7 — Active the path between host and keyboard

While the device is in boot mode, the host sends this command to active the interface

between host and keyboard after finishing firmware download.

C8 — Inactive the path between host and keyboard

While the device is in boot mode, the host sends this command to inactive the interface

between host and keyboard before starting firmware download.

8-2


System Packet Commands When the device is in boot mode, the system packet commands are used to do firmware

related functions between host and device.

Command

(Hexadecimal) Description

01h Programming

02h Programming restart

03h Fill in unused location with zero

04h Request checksum of system program

05h Response checksum of system program

10h Reset reader

21h Request firmware version of boot loader

22h Response firmware version of boot loader

23h Request firmware version of system program

24h Response firmware version of system program

Command 01 — Programming

The host sends this command to download system program into device. If the device

receives this command at first time after entering into boot mode, it will erase all data

stored in system program area and start download firmware from the very first location. If

the device receives this command at second times or above, it depends on if the

command 02 is preceded by or not. If yes, the device will start download firmware from

the very first location; if not, the device will download firmware from behind the location

that firmware is downloaded before. During download process, the LED goes red blinking.

After download done, the LED returns to amber.

Command: 01

Command Format: <Header><Command Type><Data Length>[Data]LRC


<Header> 01H Packet Command Header, Value: C2h

<Command Type> 01H Command code

<Data Length> 01H Indicate the length of [Data]

[Data] 1~256 Optional

LRC 01H Error Check


8-3


Host to Device Flow of System Packet Command 01

Host Device

Send command to device ==

==

ACK if LRC okay

NAK if LRC incorrect, and prompt host to re-send

EOT if any errors are occurred, and will follow a

packet command with error code

Note:

Host will send packet command 01 continuously till the firmware download is completed.

Command 02 — Programming restart

As long as any errors are occurred during download firmware process, this command

shall be preceded prior to download firmware again. When the device receives this

command, it will initial download parameters stored in boot loader area.

Command: 02, 03, 04, 21, 23

Command Format: <Header><Command Type><Data Length>LRC




<Data Length> 01H Indicate the length of [Data], Value: 00h

LRC 01H Error Check


Host to Device Flow of System Packet Command 02, 03, 10

Host Device


==

ACK if LRC okay




Command 03 — Fill in unused location with zero

When the device receives this command, the LED goes red and the device starts to fill

zero into unused system program area. After finished, the LED returns to orange.

Note:

The command format and flow sequence can be found in the section of command 02.

8-4


Command 04 — Request checksum of system program

The host sends this command to request the checksum (2-byte) of system program.

Note:

The command format can be found in the section of command 02.

Host to Device Flow of System Packet Command 04, 05

Host Device


==

ACK if LRC okay




== Response command 05 with 2-byte checksum

Command 05 — Response checksum of system program

The device responses this command to host to indicate the checksum (2-byte) of system

program.

Command: 05






[Data] 02h Checksum of system program

LRC 01H Error Check


Note:

The command flow sequence can be found in the section of command 04.

8-5


Command 10 — Reset reader

When the device receives this command, it will return to normal mode from boot mode.

The LED goes green.

Command: 10






[Data] 02h Reset password, Value: AAh 55h

LRC 01H Error Check


Note:


Command 21 — Request firmware version of boot loader

The host sends this command to request the firmware version (8-byte) of boot loader.

Note:

The command format can be found in the section of command 02.

Host to Device Flow of System Packet Command 21, 22, 23, 24

Host Device


==

ACK if LRC okay




==

Response command 22/24 with 8-byte firmware

version of boot loader/system program

8-6


Command 22 — Response firmware version of boot loader

The device responses this command to host to indicate the firmware version (8-byte) of

boot loader.

Command: 22, 24






[Data] 08h Firmware version of boot loader/system program

LRC 01H Error Check


Note:


Command 23 — Request firmware version of system program

The host sends this command to request the firmware version (8-byte) of system

program.

Note:

The command format can be found in the section of command 02, and flow sequence

can be found in the section of command 21.

Command 24 — Response firmware version of system program

The device responses command 23 by responding this command to host to indicate the

firmware version (8-byte) of system program.

Note:

The command format can be found in the section of command 22, and flow sequence

can be found in the section of command 21.

8-7


Section 9 Usage of API

This section describes all used API roughly. Please refer to Microsoft MSDN for detailed

information.

API Command Sets HidD_GetHidGuid The HidD_GetHidGuid routine returns the device interface GUID for HIDClass devices.

For example:

Public Declare Function HidD_GetHidGuid Lib "hid.dll" _

(ByRef HidGuid As GUID) As Long

Public Type GUID

Data1 As Long

Data2 As Integer

Data3 As Integer

Data4(7) As Byte

End Type

SetupDiGetClassDevs The SetupDiGetClassDevs function returns a device information set that contains all

devices of a specified class.

For example:

Public Declare Function SetupDiGetClassDevs Lib "setupapi.dll" _

Alias "SetupDiGetClassDevsA" (ByRef ClassGuid As GUID, _

ByVal Enumerator As String, ByVal hwndParent As Long, _

ByVal Flags As Long) _

As Long

SetupDiEnumDeviceInterfaces The SetupDiEnumDeviceInterfaces function returns a context structure for a device

interface element of a device information set. Each call returns information about one

device interface; the function can be called repeatedly to get information about several

interfaces exposed by one or more devices.

9-1


For example:

Public Declare Function SetupDiEnumDeviceInterfaces Lib "setupapi.dll" _

(ByVal DeviceInfoSet As Long, ByVal DeviceInfoData As Long, _

ByRef InterfaceClassGuid As GUID, ByVal MemberIndex As Long, _

ByRef DeviceInterfaceData As SP_DEVICE_INTERFACE_DATA) _

As Long

Public Type SP_DEVICE_INTERFACE_DATA

cbSize As Long

InterfaceClassGuid As GUID

Flags As Long

Reserved As Long

End Type

SetupDiGetDeviceInterfaceDetail The SetupDiGetDeviceInterfaceDetail function returns details about a particular device

interface.

For example:

Public Declare Function SetupDiGetDeviceInterfaceDetail Lib "setupapi.dll" _

Alias "SetupDiGetDeviceInterfaceDetailA" (ByVal DeviceInfoSet As Long, _

ByRef DeviceInterfaceData As SP_DEVICE_INTERFACE_DATA, _

ByVal DeviceInterfaceDetailData As Long, _

ByVal DeviceInterfaceDetailDataSize As Long, _

ByRef RequiredSize As Long, ByVal DeviceInfoData As Long) _

As Long

CreateFile The CreateFile function creates or opens a file, directory, physical disk, volume, console

buffer, tape drive, communications resource, mailslot, or named pipe. The function

returns a handle that can be used to access the object.

For example:

Public Declare Function CreateFile Lib "kernel32" Alias "CreateFileA" _

(ByVal lpFileName As String, ByVal dwDesiredAccess As Long, _

ByVal dwShareMode As Long, ByVal lpSecurityAttributes As Long, _

ByVal dwCreationDisposition As Long, ByVal dwFlagsAndAttributes As Long, _

ByVal hTemplateFile As Long) _

As Long

9-2


HidD_GetAttributes The HidD_GetAttributes routine returns the attributes of a specified top-level collection.

For example:

Public Declare Function HidD_GetAttributes Lib "hid.dll" _

(ByVal HidDeviceObject As Long, ByRef Attributes As HIDD_ATTRIBUTES) _

As Long

Public Type HIDD_ATTRIBUTES

size As Long

VendorID As Integer

ProductID As Integer

VersionNumber As Integer

End Type

HidD_GetPreparsedData The HidD_GetPreparsedData routine returns a top-level collection's preparsed data.

For example:

Public Declare Function HidD_GetPreparsedData Lib "hid.dll" _

(ByVal HidDeviceObject As Long, ByRef PreparsedData As Long) _

As Long

HidP_GetCaps The HidP_GetCaps routine returns a top-level collection's HIDP_CAPS structure.

For example:

Public Declare Function HidP_GetCaps Lib "hid.dll" _

(ByVal PreparsedData As Long, ByRef Capabilities As HIDP_CAPS) _

As Long

Public Type HIDP_CAPS

Usage As Integer

UsagePage As Integer

InputReportByteLength As Integer

OutputReportByteLength As Integer

FeatureReportByteLength As Integer

Reserved(16) As Integer

NumberLinkCollectionNodes As Integer

9-3


NumberInputButtonCaps As Integer

NumberInputValueCaps As Integer

NumberInputDataIndices As Integer

NumberOutputButtonCaps As Integer

NumberOutputValueCaps As Integer

NumberOutputDataIndices As Integer

NumberFeatureButtonCaps As Integer

NumberFeatureValueCaps As Integer

NumberFeatureDataIndices As Integer

End Type

HidD_GetManufacturerString The HidD_GetManufacturerString routine returns a top-level collection's embedded string

that identifies the manufacturer.

For example:

Public Declare Function HidD_GetManufacturerString Lib "hid.dll" _

(ByVal Handle As Long, ByRef BufferPtr As Byte, _

ByVal Length As Long) _

As Long

HidD_SetFeature The HidD_SetFeature routine sends a feature report to a top-level collection.

For example:

Public Declare Function HidD_SetFeature Lib "hid.dll" _

(ByVal HidDeviceObject As Long, ByRef ReportBuffer As Byte, _

ByVal ReportBufferLength As Long) _

As Byte

HidD_GetFeature The HidD_GetFeature routine returns a feature report from a specified top-level

collection.

For example:

Public Declare Function HidD_GetFeature Lib "hid.dll" _

(ByVal HidDeviceObject As Long, ByRef ReportBuffer As Byte, _

ByVal ReportBufferLength As Long) _

As Byte

9-4


9-5

CloseHandle The CloseHandle function closes an open object handle.

For example:

Public Declare Function CloseHandle Lib "kernel32" _

(ByVal hObject As Long) _

As Long

msr210u progammers manual

Documents