beetle _msr programming manual

BEETLE MSR Module

programmable Magnetic Swipe Card Reader

for BA7x

User Guide

Edition March 2006

Co py right© Win cor Nix dorf In ter na tio nal GmbH, 2006

The re pro duc ti on, trans mis si on or use of this do cu ment or its con tents is not per mit ted wit hout ex press aut ho ri ty.Of fen ders will be li ab le for da ma ges.All rights, in clu ding rights crea ted by pa tent grant or re gi stra ti on of a uti li ty mo del orde sign, are re ser ved.De li very sub ject to avai la bi li ty; tech ni cal mo di fi ca tions pos si ble.

Li nux™ is a re gis te red tra de mark of Li nus Tor valdsPen ti um™ is a re gis te red tra de mark of the In tel Cor po ra ti onMS-DOS™ and Wind ows XP™ are re gis te red tra de marks of theMi cro soft Cor po ra ti onBEET LE™ is a re gis te red tra de mark of Win cor Nix dorf In ter na tio nal GmbH

Contents

Ma nu fac tu rer´s Cer ti fi ca ti on...............................................1FCC-Class A De cla ra ti on............................................................................1War ran ty .....................................................................................................2Re cy cling the MSR Mo du le.........................................................................2Be fo re Swit ching on the Sys tem .................................................................3

Un pa cking and Che cking the Sys tem....................................................3

Swi pe Card Rea der (MSR Mo du le) .....................................4Ge ne ral .......................................................................................................4

How to Ope ra te .....................................................................................4Clea ning In struc tions.............................................................................4

In stal la ti on............................................................................5

Pro gram ming the MSR and Firm wa re Up gra de................8Flash Struc tu re ...........................................................................................8Com mands for Pro gram ming......................................................................9

Era se MSR Flash Pa ges .......................................................................9Wri te MSR Con trol ler Pa ra me ters .......................................................10Read MSR Con trol ler Pa ra me ters.......................................................10Wri te Se quen ces.................................................................................11Read Se quen ces.................................................................................11Wri te MSR-Coun try Codes -> Codes ..................................................12Wri te MSR-Coun try Codes -> Op ti on By tes ........................................12Read MSR-Coun try Codes -> Codes ..................................................13Read MSR-Coun try Codes -> Op ti on By tes ........................................13Test of Flash Page ..............................................................................13Wri te GAP Va lu es for MSR Data Trans mis si on Speed ......................14Read GAP Va lu es for MSR Data Trans mis si on Speed .......................15Loa der Ac ti vat ion.................................................................................15Read Mo du le Info ................................................................................16Send Data ...........................................................................................18

Mea ning of the Com mand Syn tax.............................................................19

Tech ni cal Data ...................................................................21

Manufacturer´s CertificationThe device complies with the requirements of the EECdirective 89/336/EEC with regard to ‘Electromagneticcompatibilily".

Therefore, you will find the CE mark on the device or packaging.

The device is intended only for operation with Wincor Nixdorf approved flatscreens.

FCC-Class A Declaration

This equipment has been tested and found to comply with the limits for aClass A digital device, pursuant to part 15 of the FCC Rules. These limitsare designed to provide reasonable protection against harmful inter-ferencewhen the equipment is operated in a commercial environment. Thisequipment generates, uses, and can radiate radio frequency energy and, ifnot 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 harmfulinterference in which case the user will be required to correct theinterference at his own expense. Modifications not authorized by themanufacturer may void users authority to operate this device. This class Adigital apparatus complies with Canadian ICES-003.

Cet appareil numerique de la classe A est conforme à la norme NMB-003du Canada.

1

FCC-CLASS A DECLARATION

Warranty

Win cor Nix dorf gua ran tees ge ne ral ly a war ran ty en ga ge ment for 12 monthsbe gin ning with the date of de li very. This war ran ty en ga ge ment co vers all da ma ges which oc cur de spi te a nor mal use of the pro duct.

Da ma ges be cau se ofn im pro per or in suf fi cient main ten an ce,n im pro per use of the pro duct or un aut ho ri zed mo di fi ca tions of the pro duct, n ina de qua te lo ca ti on or sur roun dings

will not be co ver ed by the war ran ty.

For furt her in for ma ti on of the sti pu la ti on look at your con tract.

All parts of the pro duct which are sub ject to wear and tear are not in clu dedin the war ran ty en ga ge ment.

Plea se or der spa re parts at the Win cor Nix dorf cus to mer ser vi ce.

Recycling the MSR Module

En vi ron men tal pro tec ti on does not be gin whenthe time co mes to dis po se of the swipe cardreader; it be gins with the ma nu fac tu rer. Thispro duct was de sig ned ac cor ding to our in ter nalnorm “En vi ron men tal cons ci ous pro duct de signand de ve lop ment”

The swipe card reader is manufactured without the use of CFCs und CCHSand is produced mainly from reusable components and materials.

The used plastic materials can, for the most part, be recycled. Even theprecious metals can be recycled, which saves energy and costly rawmaterials.

Please do not stick labels onto plastic case parts. This would help us tore-use components and material.

You can protect our environment by only switching on your equipment whenit is actually needed. If possible, even avoid the stand-by-mode, as this

WARRANTY

2

wastes energy, too. Also switch your equipment off when you take a longerbreak or finish your work.

At present, there are still some parts that are not reusable. Wincor Nixdorfdisposes of old devices in an environmentally sensitive way using arecycling center that is ISO 9001 and ISO 14001 certified, as is the rest ofthe company.

So don’t simply throw your swipe card reader on the scrap heap when it hasserved its time, but take advantage of the environmentally smart, up-to-daterecycling methods!

Plea se con tact your com pe tent branch or the Re cy cling Cen ter Pa der born,Germany (for Eu ro pe an coun tries), for in for ma ti on on how to re turn andre-use de vi ces and dis po sa ble ma ter ials un der the following mail address:

Email: info@win cor-nix dorf.comor on the internet.

We look for ward to your mail.

Before Switching on the System

Un pac king and Chec king the Sys tem

Unpack the parts and check to see whether the delivery matches theinformation on the delivery note.

If damage has occurred during shipping or if the package contents do notmatch the delivery note, promptly inform your Wincor Nixdorf sales outlet.

Trans port the de vi ce only in its ori gi nal pa cka ging (to pro tect it againstim pact and shock).

3

BEFORE SWITCHING ON THE SYSTEM

Swipe Card Reader (MSR Module)

General

The swipe card reader can read three ISO tracks simultaneously in onesingle swipe.

The MSR module is fitted on the right-hand side of the screen module. Theconnection is made via an MF2 interface.

How to Ope ra te

Run the swipe card through the slit of the swipe card reader from top tobottom in a quick and steady movement. Make sure that the magnetic stripis to the right.

When using swipe cards, the following should be observed:

n swipe cards should never be allowed to come into contact with liquids.n swipe cards should not be bent or folded in any way.n swipe cards should not be allowed to come into close contact with a

magnetic field.

Swi pe cards should only be in ser ted in the top of the spe ci al ly de sig ned slitof the rea ding de vi ce. If the card is in ser ted in anot her pla ce, the readinghead could be damaged.

Clea ning In struc tions

In order to guarantee good reading results over a longer period of time, theswipe card reader should be cleaned once a week. This is carried out byusing a special cleaning card that can be purchased from Wincor Nixdorf.

Clean the surface of the swipe card reader with a suitable commerciallyavailable surface cleaner.

Make sure that the power plug is disconnected, connector cables areunplugged and that no liquid finds its way into the device.

General

4

Installation

Insert the deliveredscrews (Phillips Head)into the positions markedby the arrows (12.1"screen). Fasten thescrews a little but do notscrew them too tightly.

Two positions areavailable at the 15"screen. In this illustrationit is the upper positionswhich are marked withtwo arrows. There is asecond, lower position.

Fasten the screwsslightly, leaving enoughplace for the sheet metal.

5

INSTALLATION

Then place the MSR withthe openings (see arrows)on to the screws and push it to the right.

Tighten the screws.

Do not touch the electronic board.

Connect the cable to theupper socket (1) and put the cable into the guide of thecable (2).

If a keyboard is to beconnected, use the secondconnection below (3).

INSTALLATION

6

�

��

First hook theco ver with thecatch (see fi gu reabo ve) into the top of the rear side(see cen ter fi gu re).

Make sure that the ca ble lies in theguide and is fit ting through the ope -ning of the co ver.Press the two en -ga ge ments at thebot tom un til youhear a click.

7

INSTALLATION

Pro gram ming the MSR and Firmware UpgradeThe MSR controller provides programmable start- and end-sequences forthe MSR. A loadable country table can be used for the data.

This firmware concept is necessary for the software to produce the utility forprogramming the MSR controller.

The necessary commands are described on the following pages.

A Loader upgrade will not be supported.

Flash Structure

Implemented in the hardware of the MSR controller is a 64K-Byte FLASH. Itmaintains the Loader, MSR controller parameter, MSR data(start-/ende-sequences, country table), firmware header and the firmware.The pagesize is min. 128 Byte.

For the Atmel microcontroller AT89C51RD2 the Flash-API routines havebeen moved from the 64kByte Flash area to an extra 2kByte Boot ROMarea.

Memoryaddress

Memory occupation

0x0000Security jump to loader address if Software Boot Vector isnot programmed (0x00)

0x00C0 Loader-header (64 byte)

0x0100Loader -> start-address depending on Boot Vector (10240Byte)

0x2000 MSR controller parameter (max. length 128 bytes)

0x2080start-, end sequences for MSR track no. 1 (max. length 128 bytes)


FLASH STRUCTURE

8


0x2200 MSR country codes (codes) (max. length 128 bytes)

0x2280 MSR country codes (option bytes) (max. length 128 bytes)

0x2300GAP values for varying MSR data transmission speed(max. length 128 bytes)

0x2900Firmware-header (64 byte) + following 64 byte filled with„00“

0x2980Firmware (variable length (max. 54912 Byte); see details in FW-Header)

0xFFFF End of flash

Commands for Programming

For the handling of start-/end-sequences for MSR and the country tables,new commands were generated. For explanation of the followingabbreviations please refer to the table "meaning of command syntax" in thischapter. The introduction command ‘D7’h is sent from the system and willbe acknowledged with ‘FA’h from MSR controller. The introductioncommand ‘D7’h is followed by the byte ComSel (Command-Select), whichdifferentiates following orders:

Era se MSR Flash Pa ges

With this command the MSR area of Flash will be erased. This means it willbe set to default.

System Request

Command ComSel Fieldlen LRC

D7h 00h 00h D7h

9

COMMANDS FOR PROGRAMMING

Wri te MSR Con trol ler Pa ra me ters

This command stores all global MSR controller parameters in the Flash.

System Request

Command ComSel Fieldlen KbMode LevSel SdMode (nFl-3) xData(0 – 16)

LRC

D7h 01h nFl nKb nLS nSd xxh xxh

sto red in Flash

nFl = 03h – 13h (3 - 19)nKb = 00h – 02hnLS = 00h – 07hnSd = 00h – 01h

Read MSR Con trol ler Pa ra me ters

The stored parameters can be read again with this command.

System Request

Command ComSel

D7h 02h

MSR Reply

Fieldlen KbMode LevSel SdMode (nFl-3) xData

LRC

nFl nKb nLS nSd xxh xxh

nFl = 03h – 13h (3 - 19)nKb = 00h – 02hnLS = 00h – 07hnSd = 00h – 01h


10

Wri te Se quen ces

With this command the start-/end-sequences (header/trailer) for each of thethree possible tracks of the MSR can be written into the Flash. Aftersuccessful programming these start-/end sequences will be sent to thesystem for each programmed track no. while reading a magnet stripe cardsuccessfully.

System Request

Command ComSel DevSel Opt FieldlenStart

nFIS xSeqStart

FieldlenEnd

nFIE xSeqEnd

LRC

D7h 05h nDS nO nFlS xxh nFIE xxh xxh

sto red in Flash

nDS = 00h – 05hnO = 00h – FFhnFlS = 00h – 20h (0 – 32)nFlE = 00h – 10h (0 – 16)

NOTE for possible data lengthsThe maximum number of codes for Header strings is 32 and for Trailerstrings is 16. At the interface between MSR controller and the system makecodes consist of 1 byte and break codes of 2 bytes. So a Header string may consist of up to 10 simple keystrokes and a trailer string of 5 simple key-strokes. Note, however, that there exist so-called extended keys, with 2bytes make code and 3 bytes break code. Also, if large letters or specialcharacters occur in the string, additional shift keystrokes will be insertedautomatically by the KB-Utility (KbUti.exe).

Read Se quen ces

To realize a copy function from one MSR controller to another, it must bepossible to read programmed start-/end-sequences.

System Request

Command ComSel DevSel

D7h 06h nDS

11


nDS = 00h – 05h

MSR Re ply

Opt FieldlenStart

nFIS xSeqStart

FieldlenEnd

nFIE xSeqEnd

LRC

NO nFlS xxh nFIE xxh xxh

NO = 00h – FFhnFlS = 00h – 20h (0 – 32)nFlE = 00h – 10h (0 – 16)

Wri te MSR-Coun try Codes -> Codes

With this command it is possible to write the first part of the country codesinto the Flash. This part consists of a 64 Byte country code.

System Request

Command ComSel FieldLen 64kLänder-Code

LRC

D7h 07h 40h xxh xxh

sto red in Flash

Wri te MSR-Coun try Codes -> Op ti on By tes

With this command it is possible to write the second part of the countrycodes into the Flash. This part consists of a 64 Byte option code, whichrealises whether the country code is sent with Shift- or Alt- keycode.

Sys tem Re quest

Command ComSel FieldLen 64k xOptByte

LRC

D7h 08h 40h xxh xxh

sto red in Flash


12

Read MSR-Coun try Codes -> Codes

To reali ze a copy functi on from one MSR con trol ler to anot her, it must bepos si ble to read the pro gram med coun try code.

System Request

Command ComSel

D7h 09h

MSR Reply

FieldLen 64 x Country Code LRC

40h xxh xxh

Read MSR-Coun try Codes -> Op ti on By tes

To reali ze a copy functi on from one MSR con trol ler to anot her, it must bepos si ble to read the pro gram med op ti on bytes.

Sys tem Request

Command ComSel

D7h 0Ah

MSR Re ply

FieldLen 64 x OptByte LRC

40h xxh xxh

Test of Flash Page

This command is exclusively provided for testing the Flash during theproduction process. The test is non-destructive, i.e. after the test the MSRcontroller has to be programmed again.

13


64 Byte data are written into the selected Flash page. Thereafter every byteof this page is read and compared.

Sys tem re quest

Command ComSel PageNoLow-Byte

PageNoLow-Byte

Fieldlen 64 x Daten LRC

D7h 0Bh nPNL nPNH 40h xxh xxh

sto red in Flash

nPNL = 00h – FFh (0-255)nPNH = 00h – 01h

Wri te GAP Va lu es for MSR Data Trans mis si on Speed

This command stores valid values for programmable GAP-Handling into theflash. These values will be used for accelerating or slowing down theMSR-data transmissions speed depending on the used system.

Sys tem Re quest

Command ComSel ComSel2(write)

Fieldlen nFL x Data(1-16)

LRC

D7h 0Eh 01h nFl xxh xxh

im Flash ge spei chert

Com Sel2 = 01h-02h ( 01 = write; 02 = read)nFl = 01h – 10h (1 - 16) nFl x Data = GAP values (va lid data: 1…6)

1 – GAP du ra ti on 0,55ms2 – GAP du ra ti on 0,85ms3 – GAP du ra ti on 1,5ms 4 – GAP du ra ti on 2,0ms5 – GAP du ra ti on 2,5ms6 – GAP du ra ti on 3,4ms


14

The values above are calculated in the case the MSR tracks ofMSR-controller are not programmed with header/trailer by the customer.Otherwise, if header/trailer are programmed the GAP duration may be alittle bit higher.When pro gram ming the ex ter nal flash with key co des and/ or hea der/trai ler(for MSR) by using the uti li ty KbU ti.exe the flash con tents in clu dingpro gram med GAP va lu es will be era sed. So, if nee ded you have to pro gramkey co des and/or hea der trai ler (for MSR) first, be fo re pro gram ming GAPva lu es into the flash. Plea se fol low the same procedures when set ting akey bo ard from pro gram med sta te into de fault sta te by using the utility.

Read GAP Va lu es for MSR Data Trans mis si on Speed

This command is used to read out the programmed value for GAP-Handlingfrom flash.

Sys tem Re quest

Command ComSel ComSel2 (read)

D7h 0Eh 02h

Com Sel2 = 02h (read)

MSR Reply

FieldLen nFl x GAP- Value LRC

nFl xxh xxh

nFl = 01h- 10h (1-16)

Loa der Acti vation

This com mand be longs to the firm wa re up gra de com mand set and cau ses a chan ge of firm wa re for the loa der. All By tes of the com mand will be ac knowled ged by the firm wa re. With the Loa der ac ti vat ed the ac knowled gecomes from the loa der.

15


Sys tem Request

Command ComSel1 ComSel2 PckNo LRC

D7h 0Ch 01h xxh xxh

MSR Reply

Fieldlen PckNo Status Resp. Time Out LRC

nFl xxh xxh xxh xxh

nFl = 00h- 03h (0-3)

ResponseTimeOutThis is the maximum time in which the loader must send an acknowledge ofa command. Time starts after the acknowledge of the last command byte.The waiting time is necessary, because the keyboard has no chance to lockthe interface. The loader utility must ensure that no data will be sent duringthe waiting time. The value is 0-255 Seconds.The wai ting time for the com mand “Loa der Ac ti vat ion” is 2 Se conds.

Read Mo du le Info

This command belongs to the firmware upgrade command set and providesall information about all existing modules. These modules are marked by aspecial identification. Nonexisting modules have no data.

Sys tem re quest

Command ComSel1 ComSel2 PckNo LRC

D7h 0Ch 02h xxh xxh


16

MSR Reply

Offset Lenght Datatyp Value Meaning

0 1 bin b FieldLen

1 1 bin b PckNo

2 1 bin b Status

3 5 ASCII $MOD$ Identification

8 1 ASCII 0x20 Blank

9 6 ASCII yymmddDate of release(YYMMDD)


16 4 ASCII rrvv Release/Version


21 8 ASCII a..a Modulname

29 1 ASCII 0x2E Dot "."

30 3 ASCII aaa Extension

33 1 bin 0x00 String-End-Terminator

34 3 bin bbb Data length (big endian)

37 2 bin bb16 Bit Checksum(big endian)

39 1 ASCII 0x3A Colon ":" ® next Module

... ... ... ... ...

n-1 1 ASCII 0x3B Semicolon ";"

n 1 bin b LRC

17


Send Data

This command belongs to the firmware upgrade command set, by which the programmable Header and Data are sent to the KB controller. The packagelength PckLen is limited up to max. 128 Byte. This is for the knowledge ofKB controller, to calculate how much RAM is available. Each package isconsecutively numbered by a package number PckNo.

After all data are sent, an empty Data package (PckLen = Zero) must besent from the FW upgrade utility. The Loader verifies the Checksum andsends remaining data to the Flash.

Sys tem re quest

Command ComSel1 ComSel2 PckNo PckLen npkLx Data(1- 128)

LRC

D7h 0Ch 03h xxh npckL xxh xxh

nPkL = 00h- 7Fh (0- 255)

MSR reply

Fieldlen PckNo Status LRC

nFl xxh xxh xxh

nFl = 00h- 03h (0- 4)


18

Meaning of the Command Syntax

Following syntax is used for the commands described above (summary):

Com mand: In tro duc to ry Com mand D7h

Com Sel: Com mand Selec ti on

Field len: Field length con tains the num ber of fol lo wing data by tes.

LRC: Lon gi tu di nal Redun dan cy Check. Com pa ri son bet ween Sys tem LRC and the ge ner ated LRC from MSR con trol ler will be done af ter com mand output.

KbMo de: In the MSR con trol ler pa ra me ter com mands the Con trol ler Mode deposits the con di tions for the mode of ope ra ti on how to se lec t the le vels. This applies analogously for handling the Level Select.

LevSel: Selec ti on of Level for MSR con trol ler ope ra ti on or pro gram ming.

SdMo de In the Subdevi ce Mode is fi xed the ope ra ti on mode of the de vi ce MSR. It is pos si ble to choo se bet ween DOS/WIN- Mode and pro gram ma ble Mode.

Track No The Track Numero (num ber) de fi nes the track of the read MSR data .This num ber as signs a track to a page in the Flash.

Opt De pend of com mand: Not used

MSR data MSR data as hea der and trai ler are sto red in the Flash.

DevSel Device Selec ti on for pro gram ming the start- and end- Se quen ce.

Field lenS tart Field length of Start Se quen ce.

SeqStart Da ta by tes of Start Sequen ce

19

MEANING OF THE COMMAND SYNTAX

Field len End Field length of End Se quen ce.

Se qEnd Da ta by tes of End Sequen ce

Coun try co de 64 Da ta by tes of Coun try co de

OptByte 64 Optionbytes belonging to the Country code table, which contains the condition of Shift and Alt.

MEANING OF THE COMMAND SYNTAX

20

Technical Data

Number of tracks 3

Swipe direction vertical

Read speed 15 to 80 cm/sec.

Coding of swipe cards according to ISO/IEC 7811-2

Connector keyboard: 6 Pin Mini DIN

Operating Condition IEC721 3-3 Class 3K3

+5°C to 40°C (41°F to 104°F)

Storage ConditionIEC721 3-1 Class 1K2

+5°C to 40°C (41°F to 104°F)

Transport Condition IEC721 3-2 Class 2K2

-25°C to 60°C (-13°F to 140°F)

Width 78 mm (3.07")

Height 215 mm (8.46")

Depth 36 mm (1.42")

Weight 345 g

21

TECHNICAL DATA

beetle _msr programming manual

Documents