Professional Documents
Culture Documents
Suite
Getting Started Guide
VeriFone, Inc.
2099 Gateway Place, Suite 600
San Jose, CA, 95110 USA
1-800-VeriFone
www.verifone.com
VeriFone Part Number 23901, Revision D
CONTENTS
PREFACE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
VDTK Components. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Target Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Document Organization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Conventions and Acronyms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Minimum PC Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Minimum Requirements for Developing Applications . . . . . . . . . . . . . . . . . . . . . . 9
For Verix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
For Verix V . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Default Installation Directory. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Whats New . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
CHAPTER 1
Development Suite
Components
CHAPTER 2
Developing
Applications
Verix SDK . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Debugging Tools. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Verix V SDK . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Debugging Tools. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ACT2000 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Installed Folders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CardSlot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Installed Folders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
VMAC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Installed Folders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
TMA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Installed Folders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Messenger . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Installed Folders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Tools. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Installed Folders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Tools available in Verix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Tools available in Verix V. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Tools available in both Verix and Verix V . . . . . . . . . . . . . . . . . . . . . . . .
Memory Calculator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Font Generation Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Installed Folders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
VeriShield FST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Installed Folders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
VeriFind . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Installed Folders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
VeriPrint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Installed Folders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
15
15
15
16
16
16
17
17
17
17
18
18
19
19
19
19
19
19
19
20
20
21
21
21
22
22
22
22
C ONTENTS
24
24
24
25
LIST OF TABLES
Table 1
Table 2
Table 3
Table 4
Table 5
Table 6
Table 7
VDTK Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Document Organization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Acronyms and Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Minimum PC Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Minimum Requirements for Verix . . . . . . . . . . . . . . . . . . . . . . . . . 9
Minimum Requirements for Verix V . . . . . . . . . . . . . . . . . . . . . . 10
Related Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
L IST OF TABLES
PREFACE
The Verix/Verix V Development Tool Kit (VDTK) contains the Software
Development Kit (SDK), and various useful tools, utilities and libraries using which
you can develop applications for Verix and Verix V terminals.
The VDTK comprises two CDs - Development Suite and Enhanced
Communication Libraries (ECL). Development Suite has the SDK and a set of
libraries, tools and utilities that aid in application development. ECL has a set of
libraries and applications you can use to perform communication tasks in your
applications.
VDTK
Components
Table 1
VDTK Components
Development Suite
ECL
SDK
ACT2000
TCPIP Library
CardSlot
IP Download Library
Multi-App Conductor
Communication Server
Messenger
Tools
Memory Calculator
Font Generation Tool
VeriShield FST
VeriFind
VeriPrint
Target
Audience
This guide is for developers who develop applications for VeriFones Verix and
Verix V terminals using the Verix/Verix V Development Suite. Developers must
have knowledge on C and C++ programming languages.
P REFACE
Document Organization
Document
Organization
Conventions
and Acronyms
Table 2
Document Organization
Chapter
Description
The courier typeface is used for code entries, filenames, and anything that
might require typing at the DOS prompt or from the terminal keypad.
Text in blue indicates terms that are cross-referenced. When the pointer is
placed over these references the pointer changes to the finger pointer,
indicating a link. Click on the link to view the topic.
NOTE
CAUTION
Table 3
Acronym
Definition
ACT
CVLR
ECL
FST
ICC
IMM
IP
Internet Protocol
ITP
MIID
OS
Operating System
PIP
SDK
SNMP
TCP/IP
TMA
P REFACE
Minimum PC Requirements
Table 3
Minimum PC
Requirements
Acronym
Definition
TXO
VCS
VDTK
VLR
Variable-Length Record
VMAC
VTMA
Table 4 lists the software and hardware requirements for installing and using the
DTK for application development.
Table 4
Minimum PC Requirements
Software
Hardware
Minimum
Requirements
for Developing
Applications
For Verix
Table 5 lists the minimum requirements for installing and using Development Suite
components for developing applications.
Table 5
Tool
Requirements
ACT2000, CardSlot,
VMAC
VFSDK
Wind River Systems (SDS) Cross Compiler, version 7.0/
7.1
Tools
VTMA
VMAC
Messenger
VeriPrint
VMAC
VTMA
An application that can print on the VeriFone printer
P REFACE
Minimum Requirements for Developing Applications
Table 5
Tool
Requirements
VeriFind
For Verix V
Table 6
Tool
Requirements
ACT2000,
CardSlot, VMAC
VRXSDK
Tools
VeriFone RVDS 2.1 which includes RVCT 2.0.1 and RVD 1.7
VMAC
Messenger
VMAC
VTMA
VeriPrint
to the terminal.
RS-232 download cable to connect Verix V terminal to a PC
Font Generation
Tool
NOTE
Refer to the Verix (V) ReadMe for details on OS and firmware versions.
To verify the terminals OS version number, restart the terminal. The OS version
appears on the second line of the copyright screen during the start-up sequence.
Following are the commands for different modules to verify the firmware version:
Refer to the WPA Supplicant OIDs on NIC, DoxBox Part Number DO-415610-DG and
10
P REFACE
Default Installation Directory
Default
Installation
Directory
NOTE
Documentation
Table 7
The components are installed in the default path. If you change the default path,
the settings of the project workspace and associated files of the sample programs
must be modified to reflect the new path.
Table 7 lists the relevant documents and their paths. Refer to these documents for
more information on the individual components of the Development Suite.
Related Documents
Document
Path
<Installation directory>\VerixVAps
SDK (Verix)
Aspen 144 Modem, Omni Modem 144, and Santana
VPN 22940
ConnectOne Interface Module AT Command
<Installation directory>\VerixAps\VFSDK\Doc
VPN E-213039
RIM OEM Radio Modem for GSM/GPRS Wireless
19733
Verix Operating System Programming Reference
SDK (Verix V)
WPA Supplicant OIDs on NIC, DoxBox Part Number
DO-415610-DG
CONEXANT SoftMAC, UMAC Management
11
P REFACE
Documentation
Table 7
Document
Path
VPN 2130394
MC55 / MC56 Siemens Cellular Engine, Doc ID MC55
/ MC56_ATC_V00.11
Verix Applications to ARM Porting Guide, VPN 23736
Verix V Operating System Programmers Manual,
<Installation directory>\VerixVAps\VRXSDK\Doc
VPN 23230
Verix V Operating System Programming Tools
(debughelp.htm)
Understanding the Verix Error Log help (errlog.htm)
Silicon Labs AT Commands and Reponses Guide,
VPN 24494
Conexant CX86500 SCXV Modem AT Command
Tools
MakeFile Maker Tool Users Guide, VPN 22265
VerixVWizard.hlp
VeriFind
VeriFind Online Help, VPN 22622
<Installation directory>\VerixAps\VeriFind
VeriPrint
VeriPrint Online Help, VPN 22623
<Installation directory>\VerixAps\VeriPrint
VeriShield FST
VeriShield Online Help, VPN 22311
<Installation directory>Program
Files\FontGenerationTool
ACT Library
Verix/Verix V ACT2000 Programmers Manual, VPN
<Installation directory>\VerixVAps\ACT2000
23285
CardSlot Library
Verix/Verix V CardSlot Library Programmers Guide,
VPN 23288
Multi-App Conductor
12
<Installation directory>\VerixVAps\CardSlot
P REFACE
Whats New
Table 7
Document
Path
<Installation directory>\VerixVAps\VMAC
<Installation directory>\VerixVAps\VTMA
Messenger
Verix/Verix V Messenger Application Users Guide,
<Installation directory>\VerixVAps\Messenger
VPN 23220
NOTE
Whats New
ReadMe files of the components are also in the respective paths mentioned in the
Table 7.
VMAC has been enhanced to support new USBD device for arbitration.
13
P REFACE
Whats New
14
CHAPTER 1
Development Suite Components
This chapter provides an overview of the software applications, tools and libraries
packaged in the Development Suite. The contents of the installed folders for each
component are also explained in this chapter.
Verix SDK
Verix SDK provides startup code, ANSI C standard libraries and related tools
required for the applications to run on Verix terminals. It also provides a standard
C-interface library for Verix applications. It has sample make files for compiling
and linking applications.
Verix SDK contains the following tools to create applications:
DDL -
utility for converting text files into Variable-Length Record (VLR) and
Compressed Variable-Length Record (CVLR) files.
VLR -
OUTHDR -
NOTE
Debugging Tools
DBMON -
VFI2K -
Refer to the Verix Operating System Programmers Manual for more details.
Verix V SDK
The VeriFone SDK provides startup code, ANSI C standard libraries and related
tools for the applications to run on Verix V terminals. It also provides a standard Cinterface library for Verix V applications.
The Verix V SDK contains the following tools to create applications:
- direct download utility for downloading files to the terminal.
DDL
VRXCC -
15
Debugging Tools
VRXHDR -
VRXLIB -
VLR -
utility for converting text files into Verix Variable-Length Record (VLR)
and Compressed Variable-Length Record (CVLR) files.
VRXDB -
DBMON -
Refer to the Verix V Operating System Programmers Manual for more details.
ACT2000
Installed Folders
AIETEST -
SHARE -
PRINTER -
FORMATER -
XModem -
PIPTEST -
DBFMTEST -
Prn950 -
COM1.
Prn250 -
COM1.
FmtrX50 -
printers.
16
CardSlot
Installed Folders
VMAC
Output - contains the CardSlot Library which can be directly linked to any
application.
Installed Folders
ApLoader -
DevMan -
FrontEnd -
IMM -
Varrec components.
17
VMACEX1 -
device.
VMACEX2 -
printing).
DMLAB1 -
swiping.
SCTEST -
ICC2.
TMA
Installed Folders
18
Messenger
Installed Folders
Tools
Installed Folders
NOTE
Tools comprises of various tools and utilities for developing applications for Verix/
Verix V terminals.
Tools installation folder contains the following tools and utilities:
All tools are available in both Verix and Verix V unless otherwise specified in this
section.
FMTERR -
FMTERRORARM -
MakeFileMaker -
API Converter -
VERIXVWIZARD
19
Memory
Calculator
FORMCVT -
GENDATA -
RCK2
TXOFILE -
Font
Generation
Tool
The Font Generation Tool is a GUI application which allows you to create, edit,
and manage display font files (VFT and FON), printer font files (PFT), and printer
logo files (LGO). The tool supports the following printers:
Vx5xx ITP
Vx6xx ITP
P950
The main advantage of using Font Generation Tool is that you can generate font
files without the knowledge of font file formats. The Font Generation Tool provides
the following functionalities:
20
Generate display font files (VFT and FON file formats): allows to edit and
create display font files in VFT and FON formats. These can be of 6x8, 8x16
and 16x16 resolutions.
Generate printer fonts (PFT file format): allows to create printer font files in the
PFT format in 5x8, 8x8 (supported by P950), 8x14 (32- and 42-column
resolution), 16x16, 24x24, 32x32, 48x48 and 64x64 resolutions. It also
enables editing of existing PFT files.
Generate printer logo image files (LGO file format): allows to view printer logo
files used to print graphics on printable receipts.
Convert bitmap files to VFT and LGO files: supports the conversion of bitmaps
to display font or logo files. To convert a Windows bitmap file to display, font or
logo files, the bitmap file must be monochromatic. You can choose an area of
128x128 for Vx670 terminals and 128x64 for other terminals to convert a
bitmap to VFT file. To convert a bitmap file to printer logo file, select an area
not exceeding 384x240 pixels, which is the maximum resolution of printer.
Merging multiple VFT and FON font files: supports merging multiple VFT and
FON files into a single VFT or FON file. A wizard guides you through the steps
required for merging the files.
You can select characters by specifying the range from the input file to the
output file. Also, you can specify an offset value from where the input file
characters need to be merged into the output file.
Installed Folders
VeriShield FST
Bin - contains executables and batch files for Font Generation Tool.
Samples - contains display font files, printer font files, logo files, and bitmap
files.
The VeriShield FST is used for authenticating the files you download to the
terminal. Each file must be digitally signed using the smart card.
NOTE
Installed Folders
VeriShield FST.
21
VeriFind
Installed Folders
VeriPrint
The VeriFind Test Automation Tool is an integrated testing tool that aids testing
applications written for Verix/Verix V terminals. This Windows-based tool
simulates user actions, such as key presses and magnetic card swipes, which
help automate the execution of test suites. It provides a scripting utility, file
transfer utility, screens on the terminal, RAM status, date and time as in the
terminal, and records user actions to play back later.
VeriFind installation folder contains:
VeriFind tool.
Installed Folders
Sample - contains samples that demonstrate how to use the VeriPrint tool to
simulate Omni 33xx, Omni 36xx, Omni 37xx ITPs, Vx5xx ITP and Vx6xx ITPs.
22
CHAPTER 2
Developing Applications
Application
Development
Environment
Applications for Verix and Verix V terminals are written in C or C++ programming
languages. These are compiled and linked on a PC, and then downloaded to the
terminal for execution in Verix/Verix V Operating System environment.
DEVELOPMENT PC
C SOURCE
FILES
LIBRARIES
RUN
COMPILE AND
LINK
EXECUTABLE
APPLICATION
Figure 1
Creating an
Application for
Verix
OPERATING
SYSTEM
DOWNLOAD
SERVICE
CALLS
EXECUTABLE
APPLICATION
23
D EVELOPING A PPLICATIONS
Creating an Application for Verix V
To allocate sufficient memory required for the application, use Outhdr command
as follows:
$(VFSDK)\bin\outhdr -t -s 15000 -h 5000 $(OutDir)
test1.out
Generating Static
Libraries
Generating Shared
Libraries
Creating an
Application for
Verix V
1 Compile all the source files (.c or .cpp) to object files (.o) using the Verix V
Compiler's (vrxcc) '-c' option.
For example, to generate the test1.o and test2.o object files by compiling
the test1.c and test2.c files respectively, use the command:
$(VRXSDK)\bin\vrxcc -c test1.c
$(VRXSDK)\bin\vrxcc -c test2.c
In addition, you can use the following options with the vrxcc:
'-I' to add a directory which contains the .h files (if any) to the include
search path.
D EVELOPING A PPLICATIONS
Creating an Application for Verix V
Then .out file can be generated by linking the library with the .c file
containing the main() function.
For example, assuming that test.c is the file containing the main()
function, the output file testapp.out can be generated as follows:
$(VRXSDK)\bin\vrxcc test.c test.lib -o testapp.out
3 If the library is not created as mentioned in the step 2, the object files
generated in step 1 can be directly linked with the test.c to generate the
testapp.out output file.
For example, $(VRXSDK)\bin\vrxcc test.c test1.o test2.o -o
testapp.out
4 The vrxhdr tool can be used to set the stack and heap size of the output file:
For example, for the output file testapp.out generated in the previous
steps, the stack size can be set to 15000 and heap size to 5000 using:
$(VRXSDK)\bin\vrxhdr -s 15000 -h 5000 testapp.out
5 VeriShield FST is used for signing the output file. Make sure that the
outputfile.fst file is present.
For example, assuming that the testapp.fst file is present in the same
directory where make file is present. The following command generates the
output file:
$(VSFSTOOL)\filesignature .\testapp.fst -nogui
Here the -nogui option suppresses the user interface of the File Signing
Tool.
Creating Shared
Libraries
A shared library can be created using the object files with vrxcc and vrxlib
tools.
For example, to create a shared library test.lib using the object files test1.o
and test2.o, make sure that a library description file test.lid is present. The
library description file describes the library name and its functions (i.e., the
functions in test1.c and test2.c). It should contain library base name and
library id number fields.The shared library can be created using the command:
$(VRXSDK)\bin\vrxcc test1.o test2.o -o test.a
In addition to the standard compiler option, the following options can also be used:
shlabs
$(VRXSDK)\bin\vrxlib test
VERIX/VERIX V DEVELOPMENT SUITE GETTING STARTED GUIDE
25
D EVELOPING A PPLICATIONS
Creating an Application for Verix V
26
D EVELOPING A PPLICATIONS
Creating an Application for Verix V
27
VeriFone, Inc.
2099 Gateway Place, Suite 600
San Jose, CA, 95110 USA
1-800-VeriFone
www.verifone.com