Tokenworks IDWedgeBT User Manual

IDWedgeBT™ Users Guide
Serial Port Profile Mode
Version 2.3 Software
Confidential Page 1 5/31/2013
Copyright
Copyright 2002 - 2013 TokenWorks, Inc. Printed in the USA
www.TokenWorks.com (Company Web Site) www.CardVisor.com, www.IDVisor.com, www.IDScanner.com (Product Web site)
TokenWorks®, CardVisor®, CardTool®, IDVisor® and IDWedge® are registered trademarks of TokenWorks, Inc. IDWedgeBT is a TokenWorks Inc trademark.
Version Description of Change
Auth
or
Date
1.0 Initial PC 07272012
1.1 Change wording for SD card access PC 08062012
1.2 Update Config.xml, firmware rev 1.5 PC 11292012
1.3
1.4 Update Magnetic parsing, rev 1.8 PC 02262013
1.5 Rev 1.9 software, updated parsing bugs PC 03052013
1.6 Add Document Issue Date, rev 2.0 PC 03062013
1.7 BT Conn. LED stays on during SD access
1.8
1.9 Change power up initialization, add appendix 2,3 PC 05312013
Change version to match firmware release 1.6. Update Config.xml, improve Magnetic formula description, add Self Test appendix
Function button displays 1st LED = HID Function button outputs configurable string
Move SD Access to beginning of code, add raw data mode (Lng=99) to magnetic cards
PC 01092013
PC 04112013
PC 05012013
Confidential Page 2 5/31/2013
Copyright........................................................................................................................... 2
1 Introduction................................................................................................................. 4
1.1 Document overview................................................................................................... 4
1.2 Operational overview................................................................................................ 4
1.2.1 Power ................................................................................................................. 5
1.2.2 Battery................................................................................................................ 5
1.2.3 Function Button ................................................................................................. 5
1.2.4 Connection Status .............................................................................................. 5
2 Configuration file...................................................................................................... 6
2.1 Config.xml................................................................................................................. 6
2.1.1 Version............................................................................................................... 7
2.1.2 Name.................................................................................................................. 7
2.1.3 Pin......................................................................................................................7
2.1.4 Auth.................................................................................................................... 7
2.1.5 FuncKey............................................................................................................. 7
2.1.6 CreditCard.......................................................................................................... 7
2.1.7 1DBarcode ......................................................................................................... 7
2.1.8 MagTrackCard................................................................................................... 7
2.1.9 MidInitial ........................................................................................................... 7
2.1.10 5DigitZip.......................................................................................................... 7
2.1.11 ScanMsg........................................................................................................... 8
2.2 Reading/Writing Config.xml..................................................................................... 8
3 Formulas and CSV output strings................................................................................ 8
3.1 DL/ID Card CSV string ............................................................................................ 8
3.2 Credit Card CSV string............................................................................................. 9
3.3 Magnetic.txt .............................................................................................................. 9
4 Serial Protocol.............................................................................................................. 12
4.1 Outgoing Card Scan message ............................................................................. 12
4.2 Incoming Bluetooth Commands and Outgoing Responses ................................ 13
4.2.1 Ping.................................................................................................................. 13
4.2.2 Get Serial Number ........................................................................................... 13
4.2.3 Speaker Volume............................................................................................... 14
4.2.4 Read Battery Level .......................................................................................... 14
4.2.5 Write Registration............................................................................................ 15
4.2.6 Read Registration............................................................................................. 15
Appendix 1 – Power on BIT (Built in Test) Description ............................................. 16
Confidential Page 3 5/31/2013
1 Introduction
The IDWedgeBT is a barcode/magnetic card scanner that supports a Bluetooth connection to a host computer/tablet and functions as a Serial Port Profile device. Cards are scanned and parsed into fields, and these fields are sent as a Comma Separated Value (CSV) string to the host.
1.1 Document overview
This document will describe the basic functionality of the IDWedgeBT and how to configure the application parameters and formulas used to control the output of data from the scanner.
1.2 Operational overview
The diagram below shows the top view of the IDWedgeBT scanner and the location of the LED indicators and button switches used during the operation of the device.
Confidential Page 4 5/31/2013
1.2.1 Power
The Power Button switches the battery power on/off to the unit. Power can be applied by connecting the 12VDC power supply, which charges the internal battery. The USB cable can also supply power, but does not charge the battery. If either of these two cables is connected the device powers on and ignores the state of the Power Button. When the device is powered on, the device will perform a self-test. After approximately 5 seconds the scanner is operational. See appendix 1 for detail on the Self Test
1.2.2 Battery
The Battery button displays the state of the internal battery, press it once and view the state of the battery on the 5 segment LED. The Battery button serves a dual purpose of providing access to the SD card. To access the SD card, with the power off, press and hold the Battery button, and then power on the device. Continue to hold the Battery button for 3-4 seconds, and then release it. When the USB cable is connected to a PC, the IDWedgeBT will now appear as an external USB memory device, and the Connection Status LED will stay lit.
NOTE: The USB cable supplied with the Scanner supplies operational power. The preferred method of accessing the SD card is to hold the battery button down, and plug in the USB cable to the PC; this will avoid having to press the power button.
1.2.3 Function Button
The Function button is used to re-program the device. If you press and hold this button during power up, you will put the device into programming mode and the device will no be operational, this mode is used to re-flash the firmware of the IDWedgeBT. A custom cable is required to re-program the device. When you press the Function button, the 1
st
and 2nd segments of the 5 segment LED will light to identify the SPP application. The Function button also outputs the string stored in the Config.xml file under the FuncKey variable. This string can be 10 digits or less. If a string longer than 10 digits is used, then the default string of “TokenWorks” will be output.
1.2.4 Connection Status
This LED will flash when the IDWedgeBT has successfully paired with a compliant Bluetooth host. The default mode for the Bluetooth connection is Slave; the host device controls all aspects of pairing and connecting to the device. When the unit is set up to access the SD card via USB cable connection to PC, the LED will stay on solid until the next power cycle.
Confidential Page 5 5/31/2013
2 Configuration file
The IDWedgeBT maintains configuration file called Config.xml. This file stores the application parameters. If the file gets erased, it will be created automatically using default settings. If the file contains editing errors or is corrupted and cannot be opened, then a file called ConfigError.txt will be written to the SD card. Once the errors have been corrected and the file can be read, the ConfigError.txt file will be automatically erased.
2.1 Config.xml
Below is an example of the default Config.xml file. Each tagged item in the file represents an application variable and these variables control the operation of the IDWedgeBT.
<?xml version="1.0" encoding="utf-8" ?>
-
<configuration>
-
<appSettings>
<add key="Version" value="2.3S" /> <add key="Name" value="IDWEDGEBT" /> <add key="PIN" value="1234" /> <add key="Auth" value="0" /> <add key="FuncKey" value="TokenWorks"/> <add key="CreditCard" value="True" /> <add key="1Dbarcode" value="True" /> <add key="MagTrackCard" value="True" /> <add key="MidInitial" value="True" /> <add key="5DigitZip" value="True" /> <add key="ScanMsg" value="True" />
</appSettings>
</configuration>
Confidential Page 6 5/31/2013
Loading...
+ 11 hidden pages