/SBMSR Demo Program Information 07/19/2005
(best viewed in non-proportional font, such as Courier New)
Version 1.05.02
This file contains the following information:
1) Overview
2) System requirements
3) Installation instructions
4) Operating instructions
5) Source Code
6) Release information
Overview:
=========
The demo program, which is written in Visual Basic 6.0, can be used to
do the following:
o Read cards from the device and view the card data
o Send command requests to the device and view the command responses
o Guide application developers in their application development by
providing examples, in source code, of how to properly communicate
with the device using the standard Windows APIs
System requirements:
====================
This software will run on Windows 98, Me, 2000 and XP.
Installation instructions:
==========================
To install the demo program, run the setup.exe file and follow the
instructions given on the screen.
Operating instructions:
=======================
To operate the demo program perform the following steps:
o Plug the device into a USB port on the host.
o On hosts with the Windows operating system, the first time the device
is plugged into a specific USB port, Windows will pop up a dialog box
which will guide you through the process of installing a device
driver for the device. After this process is completed once, Windows
will no longer request this process as long as the device is plugged
into the same USB port. The device driver that Windows will install
for this device is the driver used for HID devices and it is part of
the Windows operating system. When the dialog box pops up, follow
the instructions given to you in the dialog box. Sometimes Windows
will find all the files it needs on its own without giving you any
prompts. Other times Windows will need to know the location of the
files it needs. If Windows prompts you for the file locations,
insert the CD that was used to install Windows on your PC and point
Windows to the root directory of the CD. Windows should find all the
files it needs there.
o Run the demo program (USBMSR.exe).
o To read cards and view the card data, click on the "Read Cards..."
tab and swipe (or insert) a card when prompted to do so.
o To send command to the device, click on the "Send Commands..." tab.
o Enter a command in the Message edit box. All data entered should be
in hexadecimal bytes (spaces may be entered for readability but will
not affect the command). i.e. 00 00 is the same to the program as
0000 or 0 000). Enter the command number followed by the command
data if there is any.
# If the "Auto Add Length" box is checked, the application will
automatically calculate and send the command data length for you.
For example, to send the GET_PROPERTY command for property
SOFTWARE_ID enter 00 00 (the second parameter, Data Len, "01",
has been omitted).
# If the "Auto Add Length" box is NOT checked, you must enter the
length in the command (i.e. you can enter the commands as shown in
the Technical Reference Manual [MagTek Part Number 99875206]). For
example, to send the GET_PROPERTY command for property SOFTWARE_ID
enter 00 01 00.
o Press Enter or click on Send Msg to send the command and receive the
result.
o The command request and the command result will be displayed in the
Communications Dialog text box.
o The Clear Dialog button clears the Communication Dialog text box.
o To load and send a series of commands, create a text file containing
a list of USBMSR coommands, one per line.
# Comments and blank lines are ignored. A comment begins with a
semicolon (;) and can be placed any where in a line. Anything text
after a semicolon will be ignored.
Example command file:
-----------------------------------------------------------------------
; This is an example of a comment, below is a blank line
00 00 ; this is an example of a comment following a command line
00 00 ; this is an example of a comment following a command line
; note: the leading spaces are ignored
-----------------------------------------------------------------------
# Any non-comment and non-blank line will be interpreted as a command.
Commands can preceed a comment. If a non-hex value is found, the
entire line will be ignored.
# The commands in a command file must match the Auto Add Length box.
i.e. If the commands in a file include the Data Len parameter, then
make sure the Auto Add Length box is unchecked. If the commands in
a file do not include the Data Len parameter, then make sure the
Auto Add Length box is checked.
o A special, non-USB command, "Delay n", can be included in the command
file. This command causes the program to delay n seconds. This is
mostly used after a reset command (02) to allow time for the device
to finish reseting. The reset command requires a little less than five
seconds to complete so a "Delay 5" should be inserted into the command
file after a reset command (see the example below). The parameter, n,
is the number of seconds to delay. The value "n" will bet set to 0
(zero) if missing or if not a number. The word "delay" is case
insensitive.
Example: Switch to keyboard mode, reset, then delay five seconds to
allow the reset to complete.
-----------------------------------------------------------------------
; change device to Keyboad Emulation Mode
01 10 01 ; keyboard mode
02 ; reset
delay 5 ; wait for four seconds
-----------------------------------------------------------------------
o To load the command file, click the Load File button, use the File/
Open menu option and browse to the command file or type it into the
edit box (then press Enter). The application will attempt to load
the file and extract the commands. Underneath the command file edit
box, the application will show you the number of commands it found in
the file and the text box at the bottom will show you the file's
contents.
o When ready to download these commands, click on the Download button.
The application will send these commands to the device and display
the results in the Communication Dialog text box. Every time the
Download button is clicked, the application will send the commands.
o To automate this process (i.e. Batch mode), pass the desired filename
in this program's command line (e.g. USBMSR MyCommands.txt). The
application will load the file, extract and run the commands then
exit back to Windows.
o If the "Reload at start?" check box is checked, the program will
reload the the last used command file when the application is rerun.
If this check box is not selected, the command file edit box will be
empty when the program is first run.
o The name of the last four command files will be saved in the Files
menu under 1, 2, 3 and 4. Clicking on any of these (if a filename is
present) will reload that file.
o Example command files can be found at:
C:\Program Files\MagTek\MagTek USBMSR 107
Example Command File.txt - Retrieves the device's firmware number
Change To Keyboard.txt - Changes the device to Keyboard Mode
Change To HID.txt - Changes the device to HID Mode
Source Code:
============
The source code for this demo program is located in the USBMSR folder on
the CDROM. This is in "Disk1" of the Web release. It can be used as a
guide for application development. It is commented well to assist
developers. The book USB Complete by Jan Axelson is also a good guide
for application developers, especially the chapter on Human Interface
Device Host Applications.
Release information:
====================
Version Programmer Date Description
------- ----------- -------- ----------------------------------------
1.5.2 Steven Ross 07/13/05 * Added "Batch" mode
* Changed structure of program to be
"Tabbed" instead of individual forms.
* Upgraded the installation to
InstallShield DevStudio 9.0
1.4.0 Ted Logan 04/04/05 * Fixed bug introduced in version 1.3.0
that would cause the installation to
fail on all versions of Windows
earlier than XP Service Pack 2.
1.3.0 Ted Logan 02/10/05 * Added support for MagnePrint Swipe
reader.
* Added support for reset and hot re-
plugging when sending commands to the
device.
1.2.0 Ted Logan 09/17/03 * Implemented Paul Deignan's fix that
allows commands to be sent to
keyboard emulation readers on Windows
2000 and XP.
1.1.0 Ted Logan 07/09/01 * Added support for insertion style
readers.
1.0.0 Ted Logan 04/20/01 * First Release.
Download Driver Pack
After your driver has been downloaded, follow these simple steps to install it.
Expand the archive file (if the download file is in zip or rar format).
If the expanded file has an .exe extension, double click it and follow the installation instructions.
Otherwise, open Device Manager by right-clicking the Start menu and selecting Device Manager.
Find the device and model you want to update in the device list.
Double-click on it to open the Properties dialog box.
From the Properties dialog box, select the Driver tab.
Click the Update Driver button, then follow the instructions.
Very important: You must reboot your system to ensure that any driver updates have taken effect.
For more help, visit our Driver Support section for step-by-step videos on how to install drivers for every file type.