®
Zebra Kiosk OPOS Driver
User Guide
P1061668-001 Rev. A
Download from Www.Somanuals.com. All Manuals Search And Download.
Contents
Who Should Use This Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Core Companies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Document Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Kiosk OPOS Driver Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Hardware Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Compatible Operating Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Before Installing the OPOS Driver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Installing the OPOS Driver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Testing the Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
OLE for Retail POS Controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
How an Application Uses an OPOS Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Device Power Reporting Model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Summary of Common Properties, Methods, and Events . . . . . . . . . . . . . . . . . . . . . . . . . 17
DirectIO Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
POS Printer Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
General Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Data Characters and Escape Sequences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
11/25/2013
OPOS Driver User Guide
P1061668-001 Rev. A
Download from Www.Somanuals.com. All Manuals Search And Download.
Contents
2
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
CapCharacterSet Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
CapRecMarkFeed Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
CapRecNearEndSensor Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
CapRecPapercut Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
CharacterSet Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
CharacterSetList Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
FontTypefaceList Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
MapMode Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
RecBarCodeRotationList Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
RecLineChars Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
RecLineCharsList Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
RecLineHeight Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
RecLineSpacing Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
RecLinesToPaperCut Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
RecLineWidth Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
RecSidewaysMaxChars Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
RecSidewaysMaxLines Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
RotateSpecial Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
CutPaper Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
PrintBarCode Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
PrintBitmap Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
RotatePrint Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
SetBitmap Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
P1061668-001 Rev. A
OPOS Driver User Guide
11/25/2013
Download from Www.Somanuals.com. All Manuals Search And Download.
About This Document
This section provides you with contact information, additional references, and document
conventions.
Who Should Use This Document
The Kiosk OPOS Driver User Guide is targeted to an application developer who requires
access to POS-specific peripheral devices.
OPOS Information
Refer to the following websites for OPOS information:
• Reference implementation – Common Control Objects:
• NRF-ARTS Standards Body:
Information in this document is subject to change without notice.
• © 1995-2000 Fujitsu-ICL. All rights reserved.
• © 1995-2000 Microsoft Corporation. All rights reserved.
• © 1995-2000 NCR Corporation. All rights reserved.
• © 1995-2000 Seiko Epson Corporation. All rights reserved.
11/25/2013
OPOS Driver User Guide
P1061668-001 Rev. A
Download from Www.Somanuals.com. All Manuals Search And Download.
5
Document Conventions
Document Conventions
The following conventions are used throughout this document to convey certain
information.
Alternate Color (online only) Cross-references contain hot links to other sections in this
guide. If you are viewing this guide online in .pdf format, you can click the cross-
reference (blue text) to jump directly to its location.
Icons Used
Important • Advises you of information that is essential to complete a task.
Note • Indicates neutral or positive information that emphasizes or supplements important
points of the main text.
11/25/2013
OPOS Driver User Guide
P1061668-001 Rev. A
Download from Www.Somanuals.com. All Manuals Search And Download.
6
Document Conventions
P1061668-001 Rev. A
OPOS Driver User Guide
11/25/2013
Download from Www.Somanuals.com. All Manuals Search And Download.
Kiosk OPOS Driver
Installation
Kiosk OPOS Driver Installation
The following sections describe:
Hardware Requirements
• Intel® Pentium® P2 processor or equivalent
• 128 Mb RAM
• 150 Mb Hard Disk space
• Compliant USB port
Compatible Operating Systems
• Windows 8 (32 bit only)
• Windows 7 (32 bit only)
• Windows XP
• Windows 2003 Server
• Windows 2000
11/25/2013
OPOS Driver User Guide
Download from Www.Somanuals.com. All Manuals Search And Download.
P1061668-001 Rev. A
Kiosk OPOS Driver Installation
Kiosk OPOS Driver Installation
8
Before Installing the OPOS Driver
Before you start installing the OPOS Driver, install the appropriate Kiosk Printer Driver and
power on your printer.
Installing the OPOS Driver
After you install the appropriate Kiosk Printer Driver, you can install the Kiosk OPOS Driver.
To install the Kiosk OPOS Driver
2. In the Find Support list, select your printer.
3. Click the Drivers tab.
P1061668-001 Rev. A
OPOS Driver User Guide
11/25/2013
Download from Www.Somanuals.com. All Manuals Search And Download.
Kiosk OPOS Driver Installation
Kiosk OPOS Driver Installation
9
The list of available drivers appear.
4. In the Kiosk OPOS Driver row, click Download.
The End User License Agreement appears.
5. Click Accept and Begin Download Now, and save the zebra-kiosk-opos-driver-
installer 1-11-1-2.exe file.
6. Double-click zebra-kiosk-opos-driver-installer 1-11-1-2.exe to start the installer.
A message appears asking if you want to allow the program to make changes to the
computer.
7. Click Yes.
11/25/2013
OPOS Driver User Guide
P1061668-001 Rev. A
Download from Www.Somanuals.com. All Manuals Search And Download.
Kiosk OPOS Driver Installation
Kiosk OPOS Driver Installation
10
The Welcome screen appears.
8. Click Next.
The License Agreement appears.
9. Click the I Agree check box, and then click Next.
10. Read the Important Information, and then click Next.
P1061668-001 Rev. A
OPOS Driver User Guide
11/25/2013
Download from Www.Somanuals.com. All Manuals Search And Download.
Kiosk OPOS Driver Installation
Kiosk OPOS Driver Installation
11
A message appears indicating that the setup is completing.
11. Click Next to begin the installation.
The Updating Your System dialog appears.
Note • A command prompt appears briefly as the files are being copied.
11/25/2013
OPOS Driver User Guide
P1061668-001 Rev. A
Download from Www.Somanuals.com. All Manuals Search And Download.
Kiosk OPOS Driver Installation
Kiosk OPOS Driver Installation
12
When the update is complete, the following dialog appears.
12. In the Select Printer area, select the Kiosk printer that you want to use with the OPOS
driver, click Install OPOS driver, and then click OK.
The following dialog appears indicating that the installer setup is complete.
13. Click the Run Kiosk OPOS Driver Installer now check box, and then click Finish.
P1061668-001 Rev. A
OPOS Driver User Guide
11/25/2013
Download from Www.Somanuals.com. All Manuals Search And Download.
Kiosk OPOS Driver Installation
Kiosk OPOS Driver Installation
13
Testing the Installation
When the driver is installed a link to the test application can be found in the Start menu
OPOS_Test folder or All Programs\Kiosk OPOS Driver Installer folder.
1. Click Start > All Programs > Kiosk OPOS Driver Installer > OPOS_ Test.
The Zebra OPOS Printer Service Object Test Tool appears.
11/25/2013
OPOS Driver User Guide
P1061668-001 Rev. A
Download from Www.Somanuals.com. All Manuals Search And Download.
Kiosk OPOS Driver Installation
Kiosk OPOS Driver Installation
14
2. In the Open Name box, type the full name of the Kiosk printer (e.g., Zebra TTP 2030,
Zebra KR203).
3. Click Open, Claim, then Enable to connect the OPOS Printer Service Object Test Tool
with the printer.
•
•
When connected, the Result Code, Extended, and State turn green.
If the printer is not in error state the Error Level, Error Station and Error String will
also turn green.
•
Check Health will check the status and return successful or not successful, and will
print a printer test page.
4. Exercise PrintNormal or other command buttons and at the end click CutPaper and a page
will print.
The Error String will change and show the Paper in presenter.
5. Remove the paper and the status changes again.
6. To finish the test click Disable, Release and Close to disconnect the application from the
printer.
P1061668-001 Rev. A
OPOS Driver User Guide
11/25/2013
Download from Www.Somanuals.com. All Manuals Search And Download.
Kiosk Modifications of the
OLE for Retail POS
OLE for Retail POS Controls
The goal of this document is to provide an overview and programming guide for the Zebra
Kiosk OPOS driver implementation.
http://www.nrf-arts.org/UnifiedPOS/UnifiedPOS%20Specification%20v1.11.zip.
Due to the nature of the Zebra Kiosk printers not being true POS devices, we have certain
limitations and differences to the original specification. The Zebra Kiosk OPOS driver is based
on the Version 1.11 OLE for Retail POS specification but is working together with an
underlying Windows driver for the Kiosk printers.
The following sections describe:
11/25/2013
OPOS Driver User Guide
P1061668-001 Rev. A
Download from Www.Somanuals.com. All Manuals Search And Download.
Kiosk Modifications of the OLE for Retail POS
How an Application Uses an OPOS Control
16
How an Application Uses an OPOS Control
The first action the application must take on the Control is to call its Open method. The
parameter of this method selects a device name to associate with the Control. The Open
method performs the following steps:
• Establishes a link to the device name that in our case is the Windows printer driver name.
• Initializes the properties OpenResult, Claimed, DeviceEnabled, DataEventEnabled,
FreezeEvents, AutoDisable, DataCount, and BinaryConversion, as well as descriptions
and version numbers of the OPOS Control layers. Additional class-specific properties may
also be initialized.
Several applications may have an OPOS Control open at the same time. Therefore, after the
device is opened, the application will need to call the ClaimDevice method to gain exclusive
access to the device. The device must be claimed before the Control allows access to its
methods and properties. Claiming the device ensures that other applications do not interfere
with the use of the device. The application may call the ReleaseDevice method when the
device can be shared by other applications – for instance, at the end of a transaction.
Before using the device, the application must set the DeviceEnabled property to TRUE. This
value brings the device to an operational state, while FALSE disables the device.
After the application has finished using the device, the DeviceEnabled property should be set
to FALSE, then the ReleaseDevice method and finally the Close method should be called to
release the device and associated resources. Before exiting, an application should close all
open OPOS Controls.
In summary, the application follows this general sequence:
• Open method: Call to link the Control Object to the Service Object.
• ClaimDevice method: Call to gain exclusive access to the device. Required for exclusive-
use devices; optional for some sharable devices.
• DeviceEnabled property: Set to TRUE to make the device operational.
• Use the device.
• DeviceEnabled property: Set to FALSE to disable the device.
• ReleaseDevice method: Call to release exclusive access to the device.
• Close method: Call to release the Service Object from the Control Object.
Device Power Reporting Model
Kiosk Printer OPOS segments device power into two states:
• ONLINE: The device is powered on and ready for use. This is the “operational” state.
• OFF_OFFLINE: The device is either off or offline and the Service Object cannot
distinguish these states.
Power reporting only occurs while the device is open, claimed (if the device is exclusive-use),
and enabled.
P1061668-001 Rev. A
OPOS Driver User Guide
11/25/2013
Download from Www.Somanuals.com. All Manuals Search And Download.
Kiosk Modifications of the OLE for Retail POS
Summary of Common Properties, Methods, and Events
17
Summary of Common Properties, Methods, and Events
Table 1 • Common Properties
Zebra Kiosk Printer
Name
Ver
Type Access
Supported Properties
AutoDisable
1.2 Boolean R/W
NO
NO
CapCompareFirmwareVersion
BinaryConversion
CapPowerReporting
CapStatisticsReporting
CapUpdateFirmware
CapUpdateStatistics
CheckHealthText
Claimed
1.9 Boolean
1.2 Long
R
R/W
R
NO
1.3 Long
NO
1.8 Boolean
1.9 Boolean
1.8 Boolean
1.0 String
1.0 Boolean
1.2 Long
R
NO
R
NO
R
NO
R
YES
YES
NO
R
DataCount
R
DataEventEnabled
DeviceEnabled
1.0 Boolean R/W
1.0 Boolean R/W
1.0 Boolean R/W
NO
YES
YES
YES
NO
FreezeEvents
OpenResult
1.5 Long
1.0 Long
1.3 Long
1.3 Long
1.0 Long
1.0 Long
1.0 Long
1.0 String
1.0 Long
1.0 String
1.0 Long
1.0 String
1.0 String
R
R
OutputID
PowerNotify
R/W
R
NO
PowerState
NO
ResultCode
R
YES
YES
YES
YES
YES
YES
YES
YES
YES
ResultCodeExtended
State
R
R
ControlObjectDescription
ControlObjectVersion
ServiceObjectDescription
ServiceObjectVersion
DeviceDescription
DeviceName
R
R
R
R
R
R
11/25/2013
OPOS Driver User Guide
Download from Www.Somanuals.com. All Manuals Search And Download.
P1061668-001 Rev. A
Kiosk Modifications of the OLE for Retail POS
Summary of Common Properties, Methods, and Events
18
Table 2 • Common Methods
Zebra Kiosk Printer
Supported Methods
Name
Ver
Open
Close
1.0
1.0
1.0
—
YES
YES
YES
Special addition
YES
NO
ClaimDevice
Claim
ReleaseDevice
CheckHealth
1.0
1.0
1.0
1.1
1.0
1.0
1.9
1.8
1.8
1.9
1.8
ClearInput
NO
clearInputProperties
ClearOutput
NO
NO
DirectIO
YES
NO
compareFirmwareVersion
resetStatistics
retrieveStatistics
updateFirmware
updateStatistics
NO
NO
NO
NO
Table 3 • Common Events
Zebra Kiosk Printer
Supported Events
Name
Ver
DataEvent
1.0
1.0
1.0
1.0
1.0
NO
YES
YES
NO
DirectIOEvent
ErrorEvent
OutputCompleteEvent
StatusUpdateEvent
YES
P1061668-001 Rev. A
OPOS Driver User Guide
11/25/2013
Download from Www.Somanuals.com. All Manuals Search And Download.
Kiosk Modifications of the OLE for Retail POS
DirectIO Method
19
DirectIO Method
Syntax LONG DirectIO (LONG Command, LONG* pData, BSTR* pString);
Parameters This table identifies the parameters for this format:
Parameter
Description
Command
Command number. 0 is the only valid option for the Kiosk
printers and then you can send any valid ESC commands with
the exception of status enquiries or data to the printer in the
pString buffer.
pData is set to the amount of bytes in pString.
pData
Pointer to additional numeric data. Set to the amount of bytes
in pString.
pString
Pointer to additional string of valid ESC commands or data.
The data format has to comply with the data format specified
in the Kiosk printers Technical Manual. It is recommended to
only use printer parameter set commands since the printing is
implemented through the Kiosk Printer Windows Driver.
Remarks Call to communicate directly with the Service Object.
This method provides a means for a Service Object to provide functionality to the application
that is not otherwise supported by the standard Control Object for its device class. Depending
upon the Service Object’s definition of the command, this method may be asynchronous or
synchronous.
Use of DirectIO will make an application non-portable. The application may, however,
maintain portability by performing DirectIO calls within conditional code. This code may be
based upon the value of the ServiceObjectDescription, DeviceDescription, or DeviceName
property.
Return One of the following values is returned by the method and placed in the ResultCode
property:
Value
Meaning
OPOS_SUCCESS
Other Values
Direct I/O successful.
See ResultCode.
The use of DirectIO has one valid command entry.
DirectIO (0, BufferLength, Buffer)
11/25/2013
OPOS Driver User Guide
P1061668-001 Rev. A
Download from Www.Somanuals.com. All Manuals Search And Download.
Kiosk Modifications of the OLE for Retail POS
DirectIO Method
20
The calling application has to prepare the DirectIO function with the following data: {STX}
and the printout with the following data: {ETX}.
After sending of {STX} you can send all valid KPL commands to the printer but they have to
be in binary format.
Example • ESC N 1 should be sent as 27 N 1. Where 27 is the binary decimal value for
ESC.
Example • {STX}
<ESC>N<1>Zebra Technologies<CR><LF>
<ESC>N<1>lincoln, RI, 02865<CR>><LF>
<CR><LF>
<ESC>N<1>10/08/09______________12:04<CR><LF>
<CR><LF>
<ESC>N<1>OOS Driver DirectIO sample<CR><LF>
<CR><LF>
<ESC>N<0>NO. : 000192<CR><LF>
<ESC>N<0>Date: 10/08/2009<CR><LF>
<ESC>N<0>Printouts: 1<CR><LF>
<ESC>N<0>OPOS driver for Kiosk use<CR><LF>
<ESC>N<0>Receipt printing<CR><LF>
<ESC>N<0>Theater tickets<CR><LF>
<ESC>N<0>etc.<CR><LF>
<ESC>N<0>No. : 000192<CR><LF>
<ESC>N<0>Zebra Technologies<CR><LF>
<CR><LF>
<CR><LF>
<ESC>N<1>Signature: ________________________<CR><LF>
<ESC>N<1>JOE DOE<CR><LF>
<CR><LF>
<ESC>BS<0><0><h 48><0><0><0><0><h 40><0><2><2>
<ESC>BW<0>733104000099<0>
<ESC>BS<1><0><h 28><0><0><0><0><h 40><4><2><2>
<ESC>BW<1><193>JOEDOE<0>
<RS>
{ETX}
Entering a command of 0 or 1 will result in printing the buffer with KPL and ending the page
after the command. There is no continuation of the data possible with these Commands.
P1061668-001 Rev. A
OPOS Driver User Guide
11/25/2013
Download from Www.Somanuals.com. All Manuals Search And Download.
Kiosk Modifications of the OLE for Retail POS
Events
21
Events
ErrorEvent Event
Remarks Fired when an error is detected and the Control’s State transitions into the error
state.
Input error events are not delivered until the DataEventEnabled property is TRUE, so that
proper application sequencing occurs.
Note • In the Kiosk environment it is not expected that the receipt will be retried because
when a severe Error occurs, a Technician has to go out and clear the Error at the remote
location. Therefore, Retry is not supported and Cancel will clear the printer buffer. All data
will be sent to the printer regardless of the error state.
POS Printer Summary
Table 4 • Common Properties
Zebra Kiosk Printer
Supported
Property (Common)
AutoDisable
Ver
Type
Access May Use After
Properties
1.2
1.2
1.9
1.3
1.8
1.9
1.8
1.0
1.0
1.2
1.0
1.0
1.0
1.5
1.0
1.3
1.3
1.0
1.0
1.0
Boolean
Long
R/W
R/W
R
Not Supported
Open
NO
NO
BinaryConversion
CapCompareFirmwareVersion
CapPowerReporting
CapStatisticsReporting
CapUpdateFirmware
CapUpdateStatistics
CheckHealthText
Claimed
Boolean
Long
—
NO
R
Open
NO
Boolean
Boolean
Boolean
String
R
Open
NO
R
Open
NO
R
Open
NO
R
Open
NO
BooleanR
Long
R
Open
YES
NO
DataCount
R
Not Supported
Not Supported
Open & Claim
Open
DataEventEnabled
DeviceEnabled
FreezeEvents
Boolean
Boolean
Boolean
Long
R/W
R/W
R/W
R
NO
YES
YES
YES
YES
NO
OpenResult
—
OutputID
Long
R
Open
PowerNotify
Long
R/W
R
Open
PowerState
Long
Open
NO
ResultCode
Long
R
—
YES
YES
YES
ResultCodeExtended
State
Long
R
Open
Long
R
—
11/25/2013
OPOS Driver User Guide
Download from Www.Somanuals.com. All Manuals Search And Download.
P1061668-001 Rev. A
Kiosk Modifications of the OLE for Retail POS
POS Printer Summary
22
Table 4 • Common Properties (Continued)
Zebra Kiosk Printer
Supported
Property (Common)
Ver
Type
Access May Use After
Properties
ControlObjectDescription
ControlObjectVersion
ServiceObjectDescription
ServiceObjectVersion
DeviceDescription
1.0
1.0
1.0
1.0
1.0
1.0
String
Long
R
R
R
R
R
R
—
YES
YES
YES
YES
YES
YES
—
String
Long
Open
Open
Open
Open
String
String
DeviceName
Table 5 • Specific Properties
Zebra Kiosk Printer
Supported Properties
Property (Specific)
Ver
Type
Access
May Use After
CapCharacterSet
CapConcurrentJrnRec
CapConcurrentJrnSlp
CapConcurrentRecSlp
CapCoverSensor
CapTransaction
1.1 Long
R
R
R
R
R
R
R
R
R
R
R
R
R
R
R
R
R
R
R
R
R
R
R
Open
Open
Open
Open
Open
Open
Open
Open
Open
Open
Open
Open
Open
Open
Open
Open
Open
Open
Open
Open
Open
Open
Open
YES
NO
NO
NO
YES
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
YES
NO
YES
1.0 Boolean
1.0 Boolean
1.0 Boolean
1.0 Boolean
1.1 Boolean
1.9 Boolean
1.7 Boolean
1.0 Boolean
1.0 Boolean
1.0 Boolean
1.5 Long
CapConcurrentPageMode
CapMapCharacterSet
CapJrnPresent
CapJrn2Color
CapJrnBold
CapJrnCartridgeSensor
CapJrnColor
1.5 Long
CapJrnDhigh
1.0 Boolean
1.0 Boolean
1.0 Boolean
1.0 Boolean
1.0 Boolean
1.0 Boolean
1.0 Boolean
1.0 Boolean
1.0 Boolean
1.0 Boolean
CapJrnDwide
CapJrnDwideDhigh
CapJrnEmptySensor
CapJrnItalic
CapJrnNearEndSensor
CapJrnUnderline
CapRecPresent
CapRec2Color
CapRecBarCode
P1061668-001 Rev. A
OPOS Driver User Guide
Download from Www.Somanuals.com. All Manuals Search And Download.
11/25/2013
Kiosk Modifications of the OLE for Retail POS
POS Printer Summary
23
Table 5 • Specific Properties (Continued)
Zebra Kiosk Printer
Supported Properties
Property (Specific)
CapRecBitmap
Ver
Type
Access
May Use After
1.0 Boolean
1.0 Boolean
1.5 Long
R
R
R
R
R
R
R
R
R
R
R
R
R
R
R
R
R
R
R
R
R
R
R
R
R
R
R
R
R
R
R
R
R
R
Open
Open
Open
Open
Open
Open
Open
Open
Open
Open
Open
Open
Open
Open
Open
Open
Open
Open
Open
Open
Open
Open
Open
Open
Open
Open
Open
Open
Open
Open
Open
Open
Open
Open
YES
YES
NO
NO
YES
YES
YES
YES
YES
YES
NO
YES
YES
NO
NO
NO
YES
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
CapRecBold
CapRecCartridgeSensor
CapRecColor
1.5 Long
CapRecDhigh
1.0 Boolean
1.0 Boolean
1.0 Boolean
1.0 Boolean
1.0 Boolean
1.0 Boolean
1.5 Long
CapRecDwide
CapRecDwideDhigh
CapRecEmptySensor
CapRecItalic
CapRecLeft90
CapRecMarkFeed
CapRecNearEndSensor
CapRecPapercut
CapRecRight90
CapRecRotate180
CapRecStamp
1.0 Boolean
1.0 Boolean
1.0 Boolean
1.0 Boolean
1.0 Boolean
1.0 Boolean
1.9 Boolean
1.9 Boolean
1.0 Boolean
1.0 Boolean
1.0 Boolean
1.0 Boolean
1.0 Boolean
1.0 Boolean
1.5 Boolean
1.5 Long
CapRecUnderline
CapRecPageMode
CapSlpPageMode
CapSlpPresent
CapSlpFullslip
CapSlp2Color
CapSlpBarCode
CapSlpBitmap
CapSlpBold
CapSlpBothSidesPrint
CapSlpCartridgeSensor
CapSlpColor
1.5 Long
CapSlpDhigh
1.0 Boolean
1.0 Boolean
1.0 Boolean
1.0 Boolean
1.0 Boolean
1.0 Boolean
CapSlpDwide
CapSlpDwideDhigh
CapSlpEmptySensor
CapSlpItalic
CapSlpLeft90
11/25/2013
OPOS Driver User Guide
P1061668-001 Rev. A
Download from Www.Somanuals.com. All Manuals Search And Download.
Kiosk Modifications of the OLE for Retail POS
POS Printer Summary
24
Table 5 • Specific Properties (Continued)
Zebra Kiosk Printer
Supported Properties
Property (Specific)
Ver
Type
Access
May Use After
CapSlpNearEndSensor
CapSlpRight90
CapSlpRotate180
CapSlpUnderline
AsyncMode
1.0 Boolean
1.0 Boolean
1.0 Boolean
1.0 Boolean
1.0 Boolean
1.5 Long
R
R
Open
Open
Open
Open
Open
Open
NO
NO
R
NO
R
NO
R/W
R/W
R/W
YES
NO
CartridgeNotify
CharacterSet
1.0 Long
Open, Claim,
& Enable
YES
CharacterSetList
CoverOpen
1.0 String
R
R
Open
YES
YES
1.0 Boolean
Open, Claim,
& Enable
ErrorLevel
1.1 Long
1.0 Long
1.1 String
1.1 String
1.0 Boolean
1.7 Boolean
1.0 Long
1.9 String
1.9 Int32
1.9 Int32
1.9 String
1.9 Int32
1.9 Int32
1.9 Int32
1.1 Long
1.0 Long
R
Open
Open
Open
Open
Open
Open
Open
Open
Open
Open
Open
Open
Open
Open
Open
YES
YES
YES
YES
NO
ErrorStation
R
ErrorString
R
FontTypefaceList
FlagWhenIdle
R
R/W
R/W
R/W
R/W
R/W
R/W
R/W
R/W
R/W
R/W
R/W
R/W
MapCharacterSet
MapMode
NO
YES
NO
PageModeArea
PageModeDescriptor
PageModeHorizontalPosition
PageModePrintArea
PageModePrintDirection
PageModeStation
PageModeVerticalPosition
RotateSpecial
NO
NO
NO
NO
NO
NO
YES
NO
JrnLineChars
Open, Claim,
& Enable
JrnLineCharsList
JrnLineHeight
1.0 String
1.0 Long
R
Open
NO
NO
R/W
Open, Claim,
& Enable
JrnLineSpacing
JrnLineWidth
1.0 Long
1.0 Long
R/W
R
Open, Claim,
& Enable
NO
NO
Open, Claim,
& Enable
P1061668-001 Rev. A
OPOS Driver User Guide
Download from Www.Somanuals.com. All Manuals Search And Download.
11/25/2013
Kiosk Modifications of the OLE for Retail POS
POS Printer Summary
25
Table 5 • Specific Properties (Continued)
Zebra Kiosk Printer
Supported Properties
Property (Specific)
JrnLetterQuality
Ver
Type
Access
May Use After
1.0 Boolean
1.0 Boolean
1.0 Boolean
1.5 Long
R/W
Open, Claim,
& Enable
NO
NO
NO
NO
NO
YES
JrnEmpty
R
R
Open, Claim,
& Enable
JrnNearEnd
Open, Claim,
& Enable
JrnCartridgeState
JrnCurrentCartridge
RecLineChars
R
Open, Claim,
& Enable
1.5 Long
R/W
R/W
Open, Claim,
& Enable
1.0 Long
Open, Claim,
& Enable
RecLineCharsList
RecLineHeight
1.0 String
1.0 Long
R
Open
YES
NO
R/W
Open, Claim,
& Enable
RecLineSpacing
RecLineWidth
1.0 Long
1.0 Long
1.0 Boolean
1.0 Boolean
1.0 Boolean
1.0 Long
1.0 Long
1.0 Long
R/W
R
Open, Claim,
& Enable
YES
YES
NO
Open, Claim,
& Enable
RecLetterQuality
RecEmpty
R/W
R
Open, Claim,
& Enable
Open, Claim,
& Enable
YES
YES
YES
YES
YES
RecNearEnd
R
Open, Claim,
& Enable
RecSidewaysMaxLines
RecSidewaysMaxChars
RecLinesToPaperCut
R
Open, Claim,
& Enable
R
Open, Claim,
& Enable
R
Open, Claim,
& Enable
RecBarCodeRotationList
RecBitmapRotationList
RecCartridgeState
1.1 String
1.7 String
1.5 Long
R
R
R
Open
Open
YES
NO
Open, Claim,
& Enable
NO
RecCurrentCartridge
SlpLineChars
1.5 Long
1.0 Long
R/W
R/W
Open, Claim,
& Enable
NO
NO
Open, Claim,
& Enable
11/25/2013
OPOS Driver User Guide
P1061668-001 Rev. A
Download from Www.Somanuals.com. All Manuals Search And Download.
Kiosk Modifications of the OLE for Retail POS
POS Printer Summary
26
Table 5 • Specific Properties (Continued)
Zebra Kiosk Printer
Supported Properties
Property (Specific)
Ver
Type
Access
May Use After
SlpLineCharsList
SlpLineHeight
1.0 String
1.0 Long
R
Open
NO
NO
R/W
Open, Claim,
& Enable
SlpLineSpacing
SlpLineWidth
1.0 Long
1.0 Long
1.0 Boolean
1.0 Boolean
1.0 Boolean
1.0 Long
1.0 Long
1.0 Long
1.0 Long
R/W
R
Open, Claim,
& Enable
NO
NO
NO
NO
NO
NO
NO
NO
NO
Open, Claim,
& Enable
SlpLetterQuality
SlpEmpty
R/W
R
Open, Claim,
& Enable
Open, Claim,
& Enable
SlpNearEnd
R
Open, Claim,
& Enable
SlpSidewaysMaxLines
SlpSidewaysMaxChars
SlpMaxLines
R
Open, Claim,
& Enable
R
Open, Claim,
& Enable
R
Open, Claim,
& Enable
SlpLinesNearEndToEnd
R
Open, Claim,
& Enable
SlpBarCodeRotationList
SlpBitmapRotationList
SlpPrintSide
1.1 String
1.7 String
1.5 Long
R
R
R
Open
Open
NO
NO
NO
Open, Claim,
& Enable
SlpCartridgeState
1.5 Long
1.5 Long
R
Open, Claim,
& Enable
NO
NO
SlpCurrentCartridge
R/W
Open, Claim,
& Enable
Table 6 • Common Methods
Zebra Kiosk Printer
Supported Methods
Method (Common)
Ver
May Use After
Open
1.0
1.0
1.0
1.0
—
Open
YES
YES
YES
YES
Close
ClaimDevice
ReleaseDevice
Open
Open & Claim
P1061668-001 Rev. A
OPOS Driver User Guide
Download from Www.Somanuals.com. All Manuals Search And Download.
11/25/2013
Kiosk Modifications of the OLE for Retail POS
POS Printer Summary
27
Table 6 • Common Methods
Zebra Kiosk Printer
Supported Methods
Method (Common)
Ver
May Use After
CheckHealth
1.0
1.0
1.0
1.0
1.9
1.8
1.8
1.9
1.8
Open, Claim, & Enable
YES
NO
ClearInput
Not Supported
ClearOutput
Open & Claim
YES
YES
NO
DirectIO
Open
—
compareFirmwareVersion
resetStatistics
retrieveStatistics
updateFirmware
updateStatistics
—
NO
—
NO
—
NO
—
NO
Table 7 • Specific Methods
Ver May Use After
Zebra Kiosk Printer
Supported Methods
Method (Specific)
PrintNormal
1.0
1.0
Open, Claim, & Enable
Open, Claim, & Enable
Open, Claim, & Enable
—
YES
NO
YES
NO
NO
NO
NO
NO
NO
PrintTwoNormal
PrintImmediate
printMemoryBitmap
BeginInsertion
EndInsertion
1.0
1.10
1.0
1.0
1.0
1.9
1.0
1.0
Open, Claim, & Enable
Open, Claim, & Enable
Open, Claim, & Enable
—
BeginRemoval
clearPrintArea
EndRemoval
Open, Claim, & Enable
Open, Claim, & Enable
CutPaper
Full cut and 50% cut to
implement the page hold in
the driver. The driver cut
value will be used to partial
cut.
RotatePrint
1.0
1.0
1.0
1.1
1.1
1.0
Open, Claim, & Enable
Open, Claim, & Enable
Open, Claim, & Enable
Open, Claim, & Enable
Open, Claim, & Enable
Open, Claim, & Enable
Only Landscape mode
PrintBarCode
PrintBitmap
TransactionPrint
ValidateData
SetBitmap
YES
YES
NO
NO
When deleting bitmaps
all bitmaps will be deleted
SetLogo
1.0
Open, Claim, & Enable
NO
11/25/2013
OPOS Driver User Guide
Download from Www.Somanuals.com. All Manuals Search And Download.
P1061668-001 Rev. A
Kiosk Modifications of the OLE for Retail POS
General Information
28
Table 7 • Specific Methods
Zebra Kiosk Printer
Supported Methods
Method (Specific)
Ver
1.5
May Use After
ChangePrintSide
MarkFeed
Open, Claim, & Enable
Open, Claim, & Enable
—
NO
NO
NO
1.5
1.9
pageModePrint
Table 8 • Events
May Occur After
Zebra Kiosk Printer
Supported Events
Name
Ver
DataEvent
1.0
1.0
1.0
1.0
1.0
Not Supported
Open, Claim
NO
YES
YES
NO
DirectIOEvent
ErrorEvent
Open, Claim, & Enable
Open, Claim, & Enable
Open, Claim, & Enable
OutputCompleteEvent
StatusUpdateEvent
YES
General Information
The POS Printer follows the general output model, with some enhancements:
Printer out-of-paper and cover open conditions are reported by setting the ResultCode to
OPOS_E_EXTENDED and then setting ResultCodeExtended to one of the following error
conditions:
• OPOS_EPTR_REC_EMPTY
• OPOS_EPTR_COVER_OPEN
• OPOS_EPTR_REC_CARTRIDGE_REMOVED
• OPOS_EPTR_REC_CARTRIDGE_EMPTY
• OPOS_EPTR_REC_HEAD_CLEANING
Other printer errors are reported by setting the ResultCode to OPOS_E_FAILURE or another
standard error status. These failures are typically due to a printer fault or jam, or to a more
serious error. The Kiosk printer returns a few different error strings back which state the kind
of failure.
P1061668-001 Rev. A
OPOS Driver User Guide
11/25/2013
Download from Www.Somanuals.com. All Manuals Search And Download.
Kiosk Modifications of the OLE for Retail POS
General Information
29
Data Characters and Escape Sequences
The following escape sequences are recognized. If an escape sequence specifies an operation
that is not supported by the printer station, then it is ignored.
One Shots Perform indicated action.
Table 9 • One Shot Data Characters and Escape Sequences
Zebra Kiosk
Name
Paper cut
Data
Remarks
Printer Supported
ESC |#P
Cuts receipt paper. The character ‘#’
is replaced by an ASCII decimal
string telling the percentage cut
desired. If ‘#’ is omitted, then a full
cut is performed. For example: The C
string “\x1B|75P” requests a 75%
partial cut.
For a full cut use
ESC|100P.
Use ESC|50P if you want
to use Hold Page in the
Windows driver.
Feed and Paper cut
ESC |#fP
Cuts receipt paper, after feeding the
paper by the RecLinesToPaperCut
lines. The character ‘#’ is defined by
the “Paper cut” escape sequence.
Use ESC|100P.
This command is not
working as expected
when used with the
Windows printer driver
and the paper advance at
the end before cut has to
be setup in the Driver’s
Printing Preferences
under Advanced settings.
Feed, Paper cut, and
Stamp
ESC |#sP
Cuts and stamps receipt paper, after
feeding the paper by the
NO
RecLinesToPaperCut lines. The
character ‘#’ is defined by the “Paper
cut” escape sequence.
Fire stamp
ESC |sL
ESC |#B
Fires the stamp solenoid, which
usually contains a graphical store
emblem.
NO
Print bitmap
Prints the pre-stored bitmap. The
character ‘#’ is replaced by the bitmap
number. See setBitmap method.
YES
Note • This command
will be ignored in Left90
rotation.
Print top logo
Print bottom logo
Feed lines
ESC |tL
ESC |bL
ESC |#lF
Prints the pre-stored top logo.
NO
NO
Prints the pre-stored bottom logo.
Feed the paper forward by lines. The
character ‘#’ is replaced by an ASCII
decimal string telling the number of
lines to be fed. If ‘#’ is omitted, then
one line is fed.
YES
11/25/2013
OPOS Driver User Guide
P1061668-001 Rev. A
Download from Www.Somanuals.com. All Manuals Search And Download.
Kiosk Modifications of the OLE for Retail POS
General Information
30
Table 9 • One Shot Data Characters and Escape Sequences (Continued)
Zebra Kiosk
Printer Supported
Name
Feed units
Data
Remarks
ESC |#uF
Feed the paper forward by mapping
mode units. The character ‘#’ is
NO
replaced by an ASCII decimal string
telling the number of units to be fed. If
‘#’ is omitted, then one unit is fed.
Feed reverse
ESC |#rF
Feed the paper backward. The
character ‘#’ is replaced by an ASCII
decimal string telling the number of
lines to be fed. If ‘#’ is omitted, then
one line is fed.
NO
Print Mode Characteristics that are remembered until explicitly changed.
Table 10 • Print Mode Data Characters and Escape Sequences
Zebra Kiosk
Printer Supported
Name
Data
Remarks
Pass through
embedded data
ESC |#E
Send the following # characters of
data through to the hardware without
modifying it. The character '#' is
NO
replaced by an ASCII decimal string
telling the number of bytes following
the escape sequence that should be
passed through as-is to the hardware.
Print in-line barcode
ESC |#R
Prints the defined barcode in-line. The NO
character ‘#’ is the number of
characters following the R to use in
the definition of the characteristics of
the barcode to be printed. See details
below.
Font typeface selection ESC |#fT
Selects a new typeface for the
following data. Values for the
character ‘#’ are:
YES
The Kiosk OPOS driver
has 2 fonts implemented.
0 = Default typeface.
Valid selections are 0 for
(small) Monospace, 1 for
Lucida Console (big)
1 = Select second typeface from the
FontTypefaceList property.
2 = Select third typeface from the
FontTypefaceList property.
And so on.
P1061668-001 Rev. A
OPOS Driver User Guide
11/25/2013
Download from Www.Somanuals.com. All Manuals Search And Download.
Kiosk Modifications of the OLE for Retail POS
General Information
31
Print Line Characteristics that are reset at the end of each print method or by a “Normal”
sequence.
Table 11 • Print Line Data Characters and Escape Sequences
Zebra Kiosk
Name
Data
Remarks
Printer Supported
Bold
Underline
ESC |(!)bC
Prints in bold or double-strike. If ‘!’ YES
is specified then bold is disabled,
ESC |#uC
Prints with underline. The character YES
‘#’ is replaced by an ASCII decimal
string telling the thickness of the
underline in printer dot units. If ‘#’ is
omitted, then a printer-specific
default thickness is used.
Italic
ESC |(!)iC
ESC |#rC
Prints in italics. If ‘!’ is specified
then italic is disabled.
YES
NO
Alternate color
(Custom)
Prints using an alternate custom
color. The character ‘#’ is replaced
by an ASCII decimal string
indicating the desired color. The
value of the decimal string is equal
to the value of the cartridge constant
used in the printer device properties.
If ‘#’ is omitted, then the secondary
color (Custom Color 1) is selected.
Custom Color 1 is usually red.
Reverse video
Shading
ESC |(!)rvC
ESC |#sC
Prints in a reverse video format. If ‘!’ YES
is specified then reverse video is
disabled.
Prints in a shaded manner. The
character ‘#’ is replaced by anASCII
decimal string telling the percentage
shading desired. If ‘#’ is omitted,
then a printer-specific default level
of shading is used.
NO
Single high & wide
Double wide
ESC |1C
ESC |2C
Prints normal size.
YES
Prints double-wide characters.
YES, can co-exist with
normal characters on the
line
Double high
ESC |3C
ESC |4C
Prints double-high characters.
YES, can co-exist with
normal characters on the
line
Double high & wide
Prints double-high/double-wide
characters.
YES, can co-exist with
normal characters on the
line
11/25/2013
OPOS Driver User Guide
P1061668-001 Rev. A
Download from Www.Somanuals.com. All Manuals Search And Download.
Kiosk Modifications of the OLE for Retail POS
General Information
32
Table 11 • Print Line Data Characters and Escape Sequences (Continued)
Zebra Kiosk
Printer Supported
Name
Data
Remarks
Scale horizontally
ESC |#hC
Prints with the width scaled ‘#’ times YES, max value 7
the normal size, where ‘#’ is
replaced by an ASCII decimal string.
Scale vertically
RGB color
ESC |#vC
ESC |#fC
Prints with the height scaled ‘#’
times the normal size, where ‘#’ is
replaced by an ASCII decimal string.
YES, max value 15
Prints in # color. The character ‘#’ is NO
replaced by an ASCII decimal string
indicating the additive amount of
RGB to produce the desired color.
There are 3 digits each of Red, Green
and Blue elements. Valid values
range from “000” to “255”. (For
example, “255255000” represents
yellow.) Color Matching to the
subtractive percentage of CMY
(Cyan, Magenta and Yellow
components) to produce the desired
color matching specified by the RGB
is up to the service object. If ‘#’ is
omitted, then the primary color is
used. Bitmap printing is not affected.
Center
ESC |cA
ESC |rA
ESC |N
Aligns following text in the center.
Aligns following text at the right.
YES
YES
YES
Right justify
Normal
Restores printer characteristics to
normal condition.
SubScript
ESC |(!)tbC
ESC |(!)tpC
Prints SubScript characters. If ‘!’ is
specified then SubScript is disabled.
NO
SuperScript
Prints SuperScript characters. If ‘!’ is NO
specified then SuperScript is
disabled.
P1061668-001 Rev. A
OPOS Driver User Guide
11/25/2013
Download from Www.Somanuals.com. All Manuals Search And Download.
Kiosk Modifications of the OLE for Retail POS
Properties
33
Properties
CapCharacterSet Property
Added in Release 1.1, Updated in Release 1.5
Syntax LONG CapCharacterSet
Remarks Holds the default character set capability. It is PTR_CCS_WINDOWS for Kiosk
printer.
Value
Meaning
PTR_CCS_WINDOWS
The Windows ANSI character set. The value of this constant is
999. This is exactly equivalent to the Windows code page 1252.
This property is initialized by the Open method.
CapRecMarkFeed Property
Added in Release 1.5
Mark feed is only supported through settings in the Windows driver.
CapRecNearEndSensor Property
• This property is initialized by the Open method.
• This sensor will be reported as “Paper near end.”
CapRecPapercut Property
• This property is initialized by the Open method.
information.
CharacterSet Property
Updated in Release 1.5
This property is initialized when the device is first enabled following the Open method.
Values are: PTR_CS_WINDOWS for Kiosk printer.
Value
Meaning
PTR_CS_WINDOWS
The Windows ANSI character set. The value of this constant is
999. This is exactly equivalent to the Windows code page 1252.
11/25/2013
OPOS Driver User Guide
Download from Www.Somanuals.com. All Manuals Search And Download.
P1061668-001 Rev. A
Kiosk Modifications of the OLE for Retail POS
Properties
34
CharacterSetList Property
“999” for Kiosk printer.
FontTypefaceList Property
Added in Release 1.1
There are two fonts supported in the Kiosk printer; a small Monospac821 BT and a larger
Lucida Console.
MapMode Property
The value of MapMode is initialized to PTR_MM_DOTS when the device is first enabled
following the Open method. This is the only valid setting for the Kiosk printer.
RecBarCodeRotationList Property
Added in Release 1.1
The Kiosk printer cannot rotate barcodes. The barcode is always in Portrait position.
RecLineChars Property
The value of RecLineChars is initialized to the printer’s default line character width when the
device is first enabled following the Open method. It depends on the page width setting of the
Paper setting in the Windows driver and can be controlled by modifying the paper template
used in the driver.
RecLineCharsList Property
This property is initialized by the Open method. The string consists of ASCII numeric set
numbers, separated by commas.
It depends on the page width setting of the Paper setting in the Windows driver and can be
controlled by modifying the paper template used in the driver.
RecLineHeight Property
The value of RecLineHeight is initialized to the printer’s default line height when the device is
first enabled following the Open method. It depends on the selected Windows font height and
is 30 for the first font and 44 for the second font. The height is reflected in logical units.
P1061668-001 Rev. A
OPOS Driver User Guide
11/25/2013
Download from Www.Somanuals.com. All Manuals Search And Download.
Kiosk Modifications of the OLE for Retail POS
Properties
35
RecLineSpacing Property
The value of RecLineSpacing is initialized to the printer’s default line spacing when the
device is first enabled following the Open method. The value is approximately 7/10 of the
RecLineHeight.
RecLinesToPaperCut Property
This property is initialized when the device is first enabled following the Open method. The
value is determined by the CutPosition parameter set during installation (found in the INF file
and set in mm) and divided by the RecLineHeight.
RecLineWidth Property
The value of RecLineWidth is initialized to the printer’s default line width when the device is
first enabled following the Open method.
It depends on the selected Windows font height and is 15 for the first font and 22 for the
second font.
RecSidewaysMaxChars Property
This property is initialized when the device is first enabled following the Open method. The
number depends on the paper template used in the Windows driver and the printing mode the
driver is set to.
RecSidewaysMaxLines Property
This property is initialized when the device is first enabled following the Open method.
The number depends on the paper template used in the Windows driver and the printing mode
the driver is set to.
RotateSpecial Property
Added in Release 1.1
This property is initialized to PTR_RP_NORMAL by the Open method.
Values are: Only PTR_RP_NORMAL is valid for the Kiosk printer.
11/25/2013
OPOS Driver User Guide
P1061668-001 Rev. A
Download from Www.Somanuals.com. All Manuals Search And Download.
Kiosk Modifications of the OLE for Retail POS
Methods
36
Methods
CutPaper Method
The Percentage parameter indicates the percentage of paper to cut. The constant identifier
PTR_CP_FULLCUT or the value 100 causes a full paper cut. A full cut and 50% cut are the
only valid values for the Kiosk printer.
PrintBarCode Method
Description
Barcode symbol type to use. See values below.
Symbology
Height
Barcode height. Expressed in the unit of measure given by
MapMode. (Valid values can be 96, 124.)
Barcode width. Expressed in the unit of measure given by
MapMode. (Valid values can be 40 to 70.)
Width
Placement of the barcode. The Kiosk printer can’t align
Barcode other then PTR_BC_LEFT.
Alignment
TextPosition
Placement of the readable character string. See values below.
The Alignment parameter values are:
Value
Meaning
Align with the left-most print column.
PTR_BC_LEFT
PTR_BC_CENTER
PTR_BC_RIGHT
Other Values
Align in the center of the station. (Not valid.)
Align with the right-most print column. (Not valid.)
Distance from the left-most print column to the start of the
barcode. Expressed in the unit of measure given by
MapMode. (Not valid.)
The TextPosition parameter values are:
Value
Meaning
No text is printed. Only print the barcode.
Print the text above the barcode.
Print the text below the barcode.
PTR_BC_TEXT_NONE
PTR_BC_TEXT_ABOVE
PTR_BC_TEXT_BELOW
P1061668-001 Rev. A
OPOS Driver User Guide
11/25/2013
Download from Www.Somanuals.com. All Manuals Search And Download.
Kiosk Modifications of the OLE for Retail POS
Methods
37
The Symbology parameter values for this release are:
Table 12 • One Dimensional Symbologies
Value
Meaning
UPC-A
UPC-A with supplemental barcode (Not valid)
UPC-E (Not valid)
UPC-E with supplemental barcode (Not valid)
PTR_BCS_UPCA
PTR_BCS_UPCA_S
PTR_BCS_UPCE
PTR_BCS_UPCE_S
PTR_BCS_UPCD1
PTR_BCS_UPCD2
PTR_BCS_UPCD3
PTR_BCS_UPCD4
PTR_BCS_UPCD5
PTR_BCS_EAN8
PTR_BCS_JAN8
PTR_BCS_EAN8_S
PTR_BCS_EAN13
PTR_BCS_JAN13
PTR_BCS_EAN13_S
PTR_BCS_EAN128
PTR_BCS_TF
—
UPC-D1
(Not valid)
(Not valid)
(Not valid)
(Not valid)
(Not valid)
(Not valid)
(Not valid)
(Not valid)
(Only EAN 13)
(Not valid)
UPC-D2
UPC-D3
UPC-D4
UPC-D5
EAN 8 (= JAN 8)
JAN 8 (= EAN 8)
EAN 8 with supplemental barcode
EAN 13 (= JAN 13)
JAN 13 (= EAN 13)
EAN 13 with supplemental barcode (Not valid)
EAN-128
(Not valid)
(Not valid)
(Not valid)
(Not valid)
(Not valid)
(Not valid)
(Not valid)
(Not valid)
(Not valid)
Standard (or discrete) 2 of 5
Interleaved 2 of 5
Codabar
PTR_BCS_ITF
PTR_BCS_Codabar
PTR_BCS_Code39
PTR_BCS_Code93
PTR_BCS_Code128
PTR_BCS_OCRA
PTR_BCS_OCRB
Code 39
Code 93
Code 128
OCR “A”
OCR “B”
Table 13 • Two Dimensional Symbologies
Value
Meaning
PTR_BCS_PDF417
PDF 417
(Not valid)
(Not valid)
PTR_BCS_MAXICODE
MAXICODE
11/25/2013
OPOS Driver User Guide
Download from Www.Somanuals.com. All Manuals Search And Download.
P1061668-001 Rev. A
Kiosk Modifications of the OLE for Retail POS
Methods
38
Remarks Call to print a barcode on the specified printer station.
If the property RotateSpecial indicates that the barcode is to be rotated, then perform the
rotation. The Height, Width, and TextPosition parameters are applied to the barcode before the
rotation. For example, if PTR_BC_TEXT_BELOW is specified and the barcode is rotated left,
then the text will appear on the paper to the right of the barcode.
Note • Rotation is not possible.
PrintBitmap Method
Parameter
Description
The printer station to be used. Only PTR_S_RECEIPT can be
used.
Station
Name of Windows bitmap file. The file must be in
uncompressed and 2 color (black and white) format. Color
inversion may be necessary.
FileName
Printed width of the bitmap to be performed. Only
PTR_BM_ASIS can be used.
Width
Placement of the bitmap. (No alignment other then left-most
print column possible (PTR_BM_LEFT).)
Alignment
Note • PTR_BM_ASIS is the only valid Width value for the Kiosk printer.
RotatePrint Method
Rotation Direction of rotation. See values below.
Value
Meaning
Rotate printing 90º to the right (clockwise). (Not valid.)
Rotate printing 90º to the left (counter-clockwise).
PTR_RP_RIGHT90
PTR_RP_LEFT90
The printer prints in Landscape mode and can’t print bitmaps
within OPOS commands. The printer will not print any text
until it is switched back into Normal, the page is full, or
receives a FF to print and eject the page. You need to set the
RecLineChars to define the page width.
Rotate printing 180º, that is, print upside-down. (Not valid.)
End rotated printing.
PTR_RP_ROTATE180
PTR_RP_NORMAL
Note • The driver will send an FFto start the print out and eject the page after printing.
P1061668-001 Rev. A
OPOS Driver User Guide
11/25/2013
Download from Www.Somanuals.com. All Manuals Search And Download.
Kiosk Modifications of the OLE for Retail POS
Methods
39
SetBitmap Method
Parameter
Description
The number to be assigned to this bitmap. Two bitmaps,
numbered 1 and 2, may be set. You have to set Bitmap 1 first
and then Bitmap 2 or you receive an Error.
BitmapNumber
Note • You cannot overwrite a bitmap. In order to
reset the bitmap you have to unset all bitmaps first
and then set the new bitmaps again. To do this you
have to SetBitmap with an empty string.
Name of Windows bitmap file. The file must be in
uncompressed and 2 color (black and white) format. Color
inversion may be necessary.
FileName
If set to an empty string (“”), then the bitmap is unset.
Note • When the bitmaps are unset, all bitmaps are
lost.
Remarks Call to save information about a bitmap for later printing.
The bitmaps may be no bigger then approximately 5000 bytes all together otherwise the
printer cannot load it.
Only 2 bitmaps may be set, and each bitmap number may only be used for one station at a
time.
11/25/2013
OPOS Driver User Guide
P1061668-001 Rev. A
Download from Www.Somanuals.com. All Manuals Search And Download.
Kiosk Modifications of the OLE for Retail POS
Methods
40
P1061668-001 Rev. A
OPOS Driver User Guide
Download from Www.Somanuals.com. All Manuals Search And Download.
11/25/2013
Download from Www.Somanuals.com. All Manuals Search And Download.
Zebra Technologies Corporation
Zebra Technologies Corporation
475 Half Day Road, Suite 500
Lincolnshire, IL 60069 USA
T: +1 847 634 6700
Toll-free +1 866 230 9494
F: +1 847 913 8766
Zebra Technologies Europe Limited
Dukes Meadow
Millboard Road
Bourne End
Buckinghamshire, SL8 5XF, UK
T: +44 (0)1628 556000
F: +44 (0)1628 556001
Zebra Technologies Asia Pacific, LLC
120 Robinson Road
#06-01 Parakou Building
Singapore 068913
T: +65 6858 0722
F: +65 6885 0838
© 2013 ZIH Corp.
P1061668-001 Rev. A
Download from Www.Somanuals.com. All Manuals Search And Download.
|