MagTek USB MagnePrint Swipe Reader with Encryption - Manual (Page 32)

USB MagnePrint Swipe Reader with Encryption
24
PROGRAMMABLE CONFIGURATION OPTIONS
This device has a number of programmable configuration properties. Most of the programmable
properties deal with the Keyboard Emulation mode but some of the properties deal with the
reader regardless of the mode. These properties are stored in non-volatile memory. These
properties can be configured at the factory or by the end user using a program supplied by
MagTek. Programming these parameters requires low level communications with the device.
Details on how to communicate with the device to change programmable configuration
properties follows in the next few sections. These details are included as a reference only. Most
users will not need to know these details because the device will be configured at the factory or
by a program supplied by MagTek. Most users may want to skip over the next few sections on
low level communications and continue with the details of the configuration properties.
Low Level Communications
It is strongly recommended that application software developers become familiar with the HID
specification the USB specification before attempting to communicate directly with this device.
This document assumes that the reader is familiar with these specifications. These specifications
can be downloaded free from
www.usb.org .
COMMANDS
Most host applications do not need to send commands to the device. Most host applications only
need to obtain card data from the device as described previously in this section. This section of
the manual can be ignored by anyone who does not need to send commands to the device.
Command requests and responses are sent to and received from the device using feature reports.
Command requests are sent to the device using the HID class specific request Set_Report. The
response to a command is retrieved from the device using the HID class specific request
Get_Report. These requests are sent over the default control pipe. When a command request is
sent, the device will NAK the Status stage of the Set_Report request until the command is
completed. This insures that, as soon as the Set_Report request is completed, the Get_Report
request can be sent to get the command response. The usage ID for the command message was
shown previously in the Usage Table.
The following table shows how the feature report is structured for command requests:
Offset Field Name
0 Command Number
1 Data Length
2 – 23 Data
The following table shows how the feature report is structured for command responses.
Offset Field Name
0 Result Code
1 Data Length
2 – 23 Data
COMMAND NUMBER
This one-byte field contains the value of the requested command number. The following table
lists all the existing commands.