Magtek MAGTEK User Manual

MAGTEK COMMUNICATION PROTOCOL (MCP) DRIVER REFERENCE MANUAL Manual Part Number 99875164-Rev 3 OCTOBER 2004 REGISTERED TO ISO 900

MagTek Communications Protocol, Driver Reference Manual 4

5SECTION 3. INSTALLATION INSTALLING THE MCP DRIVER Insert the disk, P/N 30037473. If the program does not automatically start, navigate to the C

MagTek Communications Protocol, Driver Reference Manual 6 After this, the MCP Installation welcome screen will appear. Click the “Next >” b

Section 3. Installation 7Read the End User Licensing Agreement, and then click the “Next >” button if you accept it.

MagTek Communications Protocol, Driver Reference Manual 8 Choose whether you wish to install MCP resources. These are only recommended if you are

Section 3. Installation 9Choose the type of MCP Driver to install. On Win 98 and ME machines, this option will not be given as they only suppor

MagTek Communications Protocol, Driver Reference Manual 10 If you wish to create an Instance at this time, make sure the “Yes, edit a Device...” s

Section 3. Installation 11If you do choose to create an Instance, the windows below will appear. Edit the information as desired and click “Nex

MagTek Communications Protocol, Driver Reference Manual 12 The following is an example window of a new installation with the different fields edit

Section 3. Installation 13In the same manner, if you have chosen the Kernel Mode MCP, you can choose if you want the computer to create a shortc

ii Copyright© 2000-2004 MagTek®, Inc. Printed in the United States of America Information in this document is subject to change without notice. No

MagTek Communications Protocol, Driver Reference Manual 14 During the installation, you will see the following windows (not all the windows you wi

Section 3. Installation 15The following screen (on XP only) will appear because the program is not Windows Logo compliant. Click the “Continue

MagTek Communications Protocol, Driver Reference Manual 16 Make sure “Yes, I want to restart...” is selected and then click “Finish” to reboot and

Section 3. Installation 17CHANGING THE MCP DRIVER: Go to the Control Panel and select Add/Remove programs (Start/Settings/Control Panel is Win9

MagTek Communications Protocol, Driver Reference Manual 18 In this case, we have the Kernel Mode MCP Driver installed and it is version 1.5.0.9.

Section 3. Installation 19Change the selection to “Modify” and then click “Next >”.

MagTek Communications Protocol, Driver Reference Manual 20 If this is a Win NT/2K or XP machine, you will be given the choice to keep the current

Section 3. Installation 21You can also create a new Instance or modify a current installed one. To create or modify and Instance, make sure the

MagTek Communications Protocol, Driver Reference Manual 22 If there are any previous Instances, they will appear in the pulldown menu “MCP Devices

Section 3. Installation 23The following shows the Instance was modified so a new Instance will be created.

iiiSOFTWARE LICENSE AGREEMENT IMPORTANT: YOU SHOULD CAREFULLY READ ALL THE TERMS, CONDITIONS AND RESTRICTIONS OF THIS LICENSE AGREEMENT BEFORE INSTA

MagTek Communications Protocol, Driver Reference Manual 24 Select the remaining options as desired and then allow the computer to reboot. You wil

Section 3. Installation 25The next choice is to keep or remove the short-cut

MagTek Communications Protocol, Driver Reference Manual 26 If you choose to install the MCP resources, the following will appear:

Section 3. Installation 27You will then be asked where you would like to save them. When complete click Next.

MagTek Communications Protocol, Driver Reference Manual 28 Review the settings and either click Back or Next as described below. The followin

Section 3. Installation 29When backup is complete, the following will appear: To complete, click Yes and Finish.

MagTek Communications Protocol, Driver Reference Manual 30 REMOVING THE MCP DRIVERS Note You cannot remove individual Instances with this option

Section 3. Installation 31You will see a series of windows.

MagTek Communications Protocol, Driver Reference Manual 32 You must let the computer reboot to complete the removal of the MCP Driver.

Section 3. Installation 33DEVICE INSTANCE MANAGEMENT Device Instance Overview Before the MCP driver can communicate to a device, a device inst

iv TABLE OF CONTENTS SECTION 1. OVERVIEW...

MagTek Communications Protocol, Driver Reference Manual 34 MCPCFG Command Summary The following shows a summary of all commands supported by MCPC

Section 3. Installation 35Adding a Device Instance from Command Line – RS-232 Use the following command to add a new device instance: mcpcfg

MagTek Communications Protocol, Driver Reference Manual 36 Adding a Device Instance from Windows Based Application (WINDOWS 2000, XP) – RS-232 1

Section 3. Installation 37Removing a Device Instance from a Command Line – RS-232 Use the following command syntax to remove an existing device

MagTek Communications Protocol, Driver Reference Manual 38 The list displayed contains all properties that can be set for a device instance, wheth

Section 3. Installation 39mcpcfg s IntelliStripe Port.BaudRate=9600 Port.TraceEnabled=1 The informational and diagnostic messages displayed by

MagTek Communications Protocol, Driver Reference Manual 40 mcpcfg stop Administrator privilege is required to execute this command. Windows Con

Section 3. Installation 41DEVICE INSTANCE PROPERTIES Generic Properties These properties are used regardless of what communication transport t

MagTek Communications Protocol, Driver Reference Manual 42 Propery Name Description Core.RspTimeout Message Response Timeout (specified in millis

Section 3. Installation 43Serial Port Properties These properties are serial port specific. Value Notes Port.Name Serial Port Name to which t

vCONSTANT DEFINITIONS...70 Operation

MagTek Communications Protocol, Driver Reference Manual 44 Value Notes Port.BlockWaitTimeout Block Wait Timeout (specified in milliseconds). Maxi

45 SECTION 4. TRACE LOG The trace log is a file that logs the communications between the driver and a device. The trace log is used for helping a

MagTek Communications Protocol, Driver Reference Manual 46 08\10\2004 11:44:48:267 MSG Out 00 00 00 00 02 00 08\10\2004 11:44:48:267 FRM Out 01 00

47SECTION 5. APPLICATION PROGRAMMABLE INTERFACE The application programmable interface (API) is presented through a 32 bit, Win32 DLL MCPAPI.DLL.

MagTek Communications Protocol, Driver Reference Manual 48 DEVICE CHANNEL LIFE CYCLE Devices are identified at the API level by names. The host

Section 5. Application Programmable Interface 49COMMANDS Host applications access device functions by communicating with a specific device appl

MagTek Communications Protocol, Driver Reference Manual 50 NOTIFICATIONS MCP devices can send unsolicited messages – notifications, in case an ex

Section 5. Application Programmable Interface 51FUNCTIONS Summary The following section describes each function of the API. A short descripti

MagTek Communications Protocol, Driver Reference Manual 52 MCPBUS Structure The MCPBUS structure represents a common structure (bus) used to pass

Section 5. Application Programmable Interface 53dwApplicationID Application ID. This number identifies which application within the device the

vi

MagTek Communications Protocol, Driver Reference Manual 54 dwPropertyType Property Type. When obtaining (McpGet) or modifying (McpSet) property

Section 5. Application Programmable Interface 55dwOutBufferSize Size of Output Buffer. The MCP driver needs to know the length (in bytes) of th

MagTek Communications Protocol, Driver Reference Manual 56 McpEnum This function is used to enumerate (get the names of) all of the MCP compliant

Section 5. Application Programmable Interface 57McpOpen This function is used to open the communication channel and establish communications wi

MagTek Communications Protocol, Driver Reference Manual 58 try to synchronize to new communication parameters until it is reset or power cycled.

Section 5. Application Programmable Interface 59McpClose This function is used to close a communication channel to an MCP device which was open

MagTek Communications Protocol, Driver Reference Manual 60 McpReset This function is used to reset the channel and reestablish communications wit

Section 5. Application Programmable Interface 61McpGet This function is used to get the value of a property from the MCP driver MCP device appl

MagTek Communications Protocol, Driver Reference Manual 62 Return Value The returned value indicates the outcome of the get property function. V

Section 5. Application Programmable Interface 63McpSet This function is used to set the value of a property in the MCP driver, MCP device or MC

1SECTION 1. OVERVIEW The MCP driver is a kernel-mode driver that provides reliable communications between a user-mode application and an MCP device

MagTek Communications Protocol, Driver Reference Manual 64 Return Value The returned value indicates the outcome of the enumeration function. Va

Section 5. Application Programmable Interface 65McpCall This function is used to execute an MCP command request. Commands can be issued to the

MagTek Communications Protocol, Driver Reference Manual 66 Return Value The returned value indicates the outcome of the call function. Value Me

Section 5. Application Programmable Interface 67McpWait This function is used to get the next notification which the device has sent. When noti

MagTek Communications Protocol, Driver Reference Manual 68 The following structure members are used as output parameters. Member Meaning dwAppli

Section 5. Application Programmable Interface 69If this function returns successfully, the dwApplicationID indicates the device application whic

MagTek Communications Protocol, Driver Reference Manual 70 CONSTANT DEFINITIONS Operation Attributes #define MCP_ATTR_NONE 0 // No

Section 5. Application Programmable Interface 71#define MCP_ST_PANIC 41 // unexpected condition of self or internal

MagTek Communications Protocol, Driver Reference Manual 72 #define MCP_ST_CLEANUP 85 // object is about to be destroyed, now in

73 INDEX A Adding a Device Instance from Command Line – RS-232...34 Adding a Device Instance

MagTek Communications Protocol, Driver Reference Manual 2

MagTek Communications Protocol, Driver Reference Manual 74 S Serial Port Properties....42 Stopping the MCP Driv

3SECTION 2. SYSTEM REQUIREMENTS COMPUTER SYSTEM The driver requires a 133 MHz Intel Pentium based PC or better. OPERATING SYSTEM The driver is