Zebra ZQ110 User Guide

ZQ110
OPOS Driver Application Develop Guide
P1069379-001 Rev. A
ZQ110
OPOS Driver Application Develop Guide
Table of Contents
1. Manual Information ........................................................................................................ 6
2. Development Environment ........................................................................................... 6
2-1 Communication Configuration .................................................................................... 6
3. Property/Method ............................................................................................................ 7
3-1 Printer Type ................................................................................................................ 7
3-2 Property Range/Default Value .................................................................................... 7
3-2-1 Capability Property Setting Value ................................................................... 7
3-2-2 Property Default Value/Range ........................................................................ 8
3-2-3 POSPrinter Method ........................................................................................ 8
3-2-4 POSPrinter Escape Sequences ...................................................................... 9
3-2-5 Color Bitmap Printing Support ........................................................................ 9
4. Extended Functions ..................................................................................................... 10
4-1 DirectIO Method ........................................................................................................ 10
4-2 DirectIOEvent Event ................................................................................................. 12
5. Error Information ......................................................................................................... 13
5-1 ResultCode List ........................................................................................................ 13
Rev. 1.00
ZQ110
OPOS Driver Application Develop Guide
Proprietary Statements
This manual contains proprietary information for Zebra Technologies Corporation. It is intended solely for the information and use of parties operating and maintaining the equip­ment described herein. Such proprietary information may not be used, reproduced, or dis­closed to any other parties for any other purpose without the expressed written permission of Zebra Technologies Corporation.
Product Improvements Since continuous product improvement is a policy of Zebra Technologies Corporation, all specifications and signs are subject to change without notice.
FCC Compliance Statement NOTE: This equipment has been tested and found to comply with the limits of a Class B digital device, pursuant to Part 15 of the FCC Rules. These limits are designed to provide reasonable protection against harmful interference in a residential installation. This equip­ment generates, uses and can radiate radio frequency energy and, if not installed and used in accordance with the instructions, may cause harmful interference with radio communications. However, there is no guarantee that interference will not occur in a particular installation. If this equipment does cause harmful interference to radio or television reception, which can be determined by turning the equipment off and on, the user is encouraged to try to correct the interference by one or more of the following measures:
• Reorient or relocate the receiving antenna.
• Increase the separation between the equipment and the receiver.
• Connect the equipment to an outlet or circuit different from that to which the receiver is
connected.
• Consult the dealer or an experienced radio/TV technician for help.
WARNING: Exposure to Radio Frequency radiation. To conform to FCC RF exposure re­quirements this device shall be used in accordance with the operating conditions and in­structions listed in this manual. NOTE: This unit was tested with shielded cables on the peripheral devices. Shielded cables must be used with the unit to ensure compliance. Changes or modifications to this unit not expressly approved by Zebra Technologies Corporation could void the user’s authority to operate this equipment.
Rev. 1.00
ZQ110
OPOS Driver Application Develop Guide
Canadian Compliance Statement
This Class B digital apparatus complies with Canadian ICES-003. Cet appareil numérique de la classe B est conforme á la norme NMB-003 du Canada. “IC:” before the equipment certification number signifies that the Industry Canada technical specifications were met. It does not guarantee that the certified product will operate to the user’s satisfaction.
Liability Disclaimer Inasmuch as every effort has been made to supply accurate information in this manual, Zebra Technologies Corporation is not liable for any erroneous information or omissions. Zebra Technologies Corporation reserves the right to correct any such errors and disclaims liability resulting therefrom.
No Liability for Consequential Damage In no event shall Zebra Technologies Corporation or anyone else involved in the creation, production, or delivery of the accompanying product (including hardware and software) be liable for any damages whatsoever (including, without limitation, damages for loss of business profits, business interruption, loss of business information, or other pecuniary loss) arising out of the use of or the results of use of or inability to use such product, even if Zebra Technologies Corporation has been advised of the possibility of such damages. Because some states do not allow the exclusion of liability for consequential or incidental damages, the above limitation may not apply to you.
Rev. 1.00
ZQ110
OPOS Driver Application Develop Guide
Copyrights
The copyrights in this manual and the label print engine described therein are owned by Zebra Technologies Corporation. Unauthorized reproduction of this manual or the software in the label print engine may result in imprisonment of up to one year and fines of up to $10,000 (17 U.S.C.506). Copyright violators may be subject to civil liability. This product may contain ZPL® , ZPL II® , and ZebraLink programs; Element Energy Equalizer® Circuit; E3® ; and AGFA fonts. Software © ZIH Corp. All rights reserved worldwide. ZebraLink and all product names and numbers are trademarks, and Zebra, the Zebra logo, ZPL, ZPL II, Element Energy Equalizer Circuit, and E3 Circuit are registered trademarks of ZIH Corp. All rights reserved worldwide. Monotype® , Intellifont® and UFST® are trademarks of Monotype Imaging, Inc. registered in the United States Patent and Trademark Office and may be registered in certain jurisdictions. Andy, CG Palacio, CG Century Schoolbook, CG Triumvirate, CG Times, Monotype Kai, Monotype Mincho and Monotype Sung are trademarks of Monotype Imaging, Inc. and may be registered in some jurisdictions. HY Gothic Hangul is a trademark of Hanyang Systems, Inc. Angsana is a trademark of Unity Progress Company (UPC) Limited. Andale® , Arial® , Book Antiqua® , Corsiva® , Gill Sans® , Sorts® and Times New Roman® are trademarks of The Monotype Corporation registered in the United States Patent and Trademark Office and may be registered in certain jurisdictions. Century Gothic™, Bookman Old Style™ and Century Schoolbook are trademarks of The Monotype Corporation and may be registered in certain jurisdictions. HGPGothicB is a trademark of the Ricoh company, Ltd. and may be registered in some jurisdictions. Univers is a trademark of Heidelberger Druckmaschinen AG, which may be registered in certain jurisdictions, exclusively licensed through Linotype Library GmbH, a wholly owned subsidiary of Heidelberger Druckmaschinen AG. Futura® is a trademark of Bauer Types SA registered in the United States Patent and Trademark Office and may be registered in some jurisdictions. TrueType® is a trademark of Apple Computer, Inc. registered in the United States Patent and Trademark Office and may be registered in certain jurisdictions. All other product names are the property of their respective owners. All other brand names, product names, or trademarks belong to their respective holders. © 2014 ZIH Corp.
Rev. 1.00
ZQ110
OPOS Driver Application Develop Guide
Printer Model
Baud Rate
Printer Type
Dots Per Inch (dpi)
ZQ110
Not supported
Mono Thermal
203 dpi
1. Manual Information
The OPOS Driver Application DevelopGuide explains how to set and configure a device and to develop applications to use the Zebra ZQ110 printer with the OPOS driver.
Before using the printer, set and configure the printer using the OPOS Setup Utility.
Throughout this manual, “OLE for Retail POS” is called “OPOS” and “Unified for Retail POS” is called “UPOS”.
2. Development Environment
2-1 Communication Configuration
Communication Configuration for the serial interface is set in the OPOS Setup Utility.
* Check the default communication setting. For more details, refer to the user manual
included in the printer package.
Rev. 1.00
OPOS Driver Application Develop Guide
3. Property/Method
Capability Name
1 Color Thermal : ZQ110
CapCompareFirmwareVersion
FALSE
CapPowerReporting
TRUE
CapStatisticsReporting
FALSE
CapUpdateFirmware
FALSE
CapUpdateStatistics
FALSE
CapTransaction
TRUE
CapCoverSensor
TRUE
CapConcurrentRecSlp
FALSE
CapConcurrentJrnSlp
FALSE
CapConcurrentJrnRec
FALSE
CapCharacterSet
TRUE
CapRecUnderline
TRUE
CapRecPageMode
FALSE
CapCuncurrentPageMode
FALSE
CapRecStamp
FALSE
CapRecRotate180
TRUE
CapRecRight90
FALSE
CapRecPapercut
FALSE
CapRecNearEndSensor
FALSE
CapRecMarkFeed
FALSE
CapRecLeft90
FALSE
CapRecItalic
FALSE
CapRecEmptySensor
TRUE
CapRecDwideDhigh
TRUE
CapRecDwide
TRUE
CapRecDhigh
TRUE
CapRecColor
FALSE
CapRecCartridgeSensor
FALSE
CapRecBold
TRUE
CapRecBitmap
TRUE
CapRecBarCode
TRUE
CapRec2Color
FALSE
CapRecPresent
TRUE
3-1 Printer Type
Property value will be determined by the printer type, as shown in the table below.
3-2 Property Range/Default Value
3-2-1 Capability Property Setting Value
ZQ110
Rev. 1.00
OPOS Driver Application Develop Guide
3-2-2 Property Default Value/Range
Property
Range or Value
RecLineCharsList
“32,42”
RecBitmapList
0,L90,R90,180
CharacterSetList
437,1(Katakana),850,860,863,865,1252,866,852,858,862,
864,23(Thai42),1253,1254,1257,27(Farsi),1251,737,775, 31(Thai14),32(Hebrew_old),1255,34(Thai11),35(Thai18),
36(Cyrillic),857,928,39(Thai16),1256
RecLineHeight
24
RecLineWidth
384
RecLinePaperCut
5
RecLineSpacing
0~127(Default :16)
Method
Value
beginInsertion
Not Supported
beginRemoval
Not Supported
changePrintSide
Not Supported
clearPrintArea
Supported
cutPaper
Supported
drawRuledLine
Not Supported
endInsertion
Not Supported
endRemoval
Not Supported
markFeed
Not Supported
pageModePrint
Supported
(Dot, Ink type printer unsupported)
printBarCode
Supported
printBitmap
Supported
printImmediate
Supported
printMemoryBitmap
Supported
printNormal
Supported
printTwoNormal
Not Supported
rotatePrint
Supported
setBitmap
Supported
setLogo
Supported
transactionPrint
Supported
validateData
Supported
3-2-3 POSPrinter Method
ZQ110
Rev. 1.00
OPOS Driver Application Develop Guide
3-2-4 POSPrinter Escape Sequences
Escape Sequence
Value
[#]P
0-100
[#]fP
0-100
[#]sP
Not Supported
sL
Not Supported
[#]B
1-20
tL
Supported
bL
Supported
[#]lF
0-9999
[#]uF Base Pitch [inch]
Supported
[#]rF Maximum[inch]
Not Supported
#E
Supported
#R
Not Supported
#dL
Not Supported
#fT
Supported
[!]bC
Supported
[!][#]uC
Supported
[!]iC
Not Supported
[#]rC
Supported
[!]rvC
Supported
[#]sC
Not Supported
1C
Supported
2C
Supported
3C
Supported
4C
Supported
#hC
Supported
#vC
Supported
[#]fC
Not Supported
[!]tbC
Not Supported
[!]tpC
Not Supported
cA
Supported
rA
Supported
lA
Supported
[!][#]stC
Not Supported
N
Supported
ZQ110
3-2-5 Color Bitmap Printing Support
ZQ110 OPOS Driver supports following image formats:
GIF JPG BMP
The image will be converted into monochrome.
Rev. 1.00
ZQ110
OPOS Driver Application Develop Guide
Parameter
Explanation
Type
Command
Output format
Long
PData
Number of output data / Value defined by command
Long
PString
Output Data
String
Command
Description
DISP_DI_OUTPUT
Output defined pString data
DISP_DI_INTERNATIONAL_CHAR
International characterset define
PTR_DI_MOBILE_MSR_READ
Read the MSR data
PTR_DI_MOBILE_MSR_READ_TRACK1
Get the Track 1 information from MSR data
PTR_DI_MOBILE_MSR_READ_TRACK2
Get the Track 2 information from MSR data
PTR_DI_ MOBILE _MSR_READ_TRACK3
Get the Track 3 information from MSR data
PTR_DI MOBILE _MSR_READ_CLEAR
Clear the MSR data
PTR_DI_
MOBILE
_MSR_READ_ENCRYPTION
Read the MSR encryption data
Argument
Command
PTR_DI_OUTPUT
PData
Null
PString
Output data
Description
Sends data without any process after checking printer status.
“PString” is not affected by “BinaryConversion”
Return
Result Code
ResultCodeExtended
OPOS_SUCCESS
0
OPOS_E_CLOSED
0
OPOS_E_CLAIMED
0
OPOS_E_NOTCLAIMED
0
OPOS_E_DISABLED
0
OPOS_E_BUSY
0
OPOS_E_ILLEGAL
0
OPOS_E_OFFLINE
0
OPOS_E_FAILURE
0
4. Extended Functions
This section explains the DirectIO method. This method will operate properly only with a POS printer.
4-1 DirectIO Method
The table(s) below provides the DirectIO command and corresponding description.
OPOS DirectIO Command
PTR _DI_OUTPUT
Rev. 1.00
OPOS Driver Application Develop Guide
PTR_DI_INTERNATIONAL_CHAR
Argument
Command
PTR_DI_INTERNATIONAL_CHAR
PData
One of the commands:
PRN_DI_CHAR_USA
PRN_DI_CHAR_FRANCE
PRN_DI_CHAR_GERMANY
PRN_DI_CHAR_UK
PRN_DI_CHAR_DENMARK1
PRN_DI_CHAR_SWEDEN
PRN_DI_CHAR_ITALY
PRN_DI_CHAR_SPAIN1
PRN_DI_CHAR_NORWAY
PRN_DI_CHAR_DENMARK2
PString
Printing position
Description
Sets International character set. If CharacterSet property value is
changed, International character set will be reset.
Return
Result Code
ResultCodeExtended
OPOS_SUCCESS
0
OPOS_E_CLOSED
0
OPOS_E_CLAIMED
0
OPOS_E_NOTCLAIMED
0
OPOS_E_DISABLED
0
OPOS_E_BUSY
0
OPOS_E_ILLEGAL
0
OPOS_E_OFFLINE
0
OPOS_E_FAILURE
0
Argument
Command
PTR_DI_MOBILE_MSR_READ
PData
Null
PString
Null
Description
Read the MSR data.
Return
Result Code
ResultCodeExtended
OPOS_SUCCESS
0
OPOS_E_ILLEGAL
0
Argument
Command
PTR_DI_MOBILE_MSR_READ_TRACK1 PTR_DI_MOBILE_MSR_READ_TRACK2 PTR_DI_MOBILE_MSR_READ_TRACK3
PData
Null
PString
Appropriate Track information
Description
Get the Track information from MSR data.
Return
Result Code
ResultCodeExtended
OPOS_SUCCESS
0
OPOS_E_ILLEGAL
0
ZQ110
PTR_DI_MOBILE_MSR_READ
PTR_DI_MOBILE_MSR_READ_TRACK
Rev. 1.00
OPOS Driver Application Develop Guide
PTR_DI_MOBILE_MSR_READ_CLEAR
Argument
Command
PTR_DI_MOBILE_MSR_READ_CLEAR
PData
Null
PString
Null
Description
Clear the MSR data.
Return
Result Code
ResultCodeExtended
OPOS_SUCCESS
0
OPOS_E_ILLEGAL
0
Argument
Command
PTR_DI_MOBILE_MSR_READ_ENCRYPTION
PData
Null
PString
Null
Description
Read the MSR encryption data.
Return
Result Code
ResultCodeExtended
OPOS_SUCCESS
0
OPOS_E_ILLEGAL
0
PTR_DI_MOBILE_MSR_READ_ENCRYPTION
4-2 DirectIOEvent Event
Not used.
ZQ110
Rev. 1.00
ZQ110
OPOS Driver Application Develop Guide
Method
Result Code
ResultCodeExtended
ClaimDevice
OPOS_E_ILLEGAL
OPOS_EPTR_UNRECOVERABLE
OPOS_EPTR_MECHANICAL
OPOS_EPTR_CUTTER
OPOS_EPTR_OVERHEAT
OPOS_EPTR_REC_EMPTY
OPOS_EPTR_JRN_EMPTY
Method
Result Code
ResultCodeExtended
CheckHealth
OPOS_SUCCESS
0
OPOS_E_CLOSED
0
OPOS_E_CLAIMED
0
OPOS_E_DISABLED
0
OPOS_E_ILLEGAL
0
OPOS_E_OFFLINE
0
OPOS_E_OFFLINE
0
OPOS_E_FAILURE OPOS_EPTR_UNRECOVERA BLE
OPOS_EPTR_CUTTER
OPOS_EPTR_MECHANICAL
OPOS_EPTR_OVERHEAT
Method
Result Code
ResultCodeExtended
ClearOutput
OPOS_SUCCESS
0
OPOS_E_CLOSED
0
OPOS_E_CLAIMED
0
OPOS_E_NOTCLAIMED
0
5. Error Information
This section explains returned error information when using POS Printer methods. For more details, please refer to the UPOS specifications.
5-1 ResultCode List
ClaimDevice
CheckHealth
ClearOutput
Rev. 1.00
OPOS Driver Application Develop Guide
DirectIO
Method
Result Code
ResultCodeExtended
DirectIO
OPOS_SUCCESS
0
OPOS_E_CLOSED
0
OPOS_E_CLAIMED
0
OPOS_E_NOTCLAIMED
0
OPOS_E_DISABLED
0
OPOS_E_ILLEGAL
0
OPOS_E_OFFLINE
0
OPOS_EPTR_COVER_OPEN
OPOS_E_FAILURE
OPOS_EPTR_UNRECOVERA BLE
OPOS_EPTR_CUTTER
OPOS_EPTR_MECHANICAL
OPOS_EPTR_OVERHEAT
OPOS_E_EXTENDED
OPOS_EPTR_COVER_OPEN
OPOS_EPTR_JRN_EMPTY
OPOS_EPTR_REC_EMPTY
Method
Result Code
ResultCodeExtended
PrintNormal
OPOS_SUCCESS
0
OPOS_E_CLOSED
0
OPOS_E_CLAIMED
0
OPOS_E_NOTCLAIMED
0
OPOS_E_DISABLED
0
OPOS_E_ILLEGAL
0
OPOS_E_OFFLINE
0
OPOS_E_FAILURE
OPOS_EPTR_UNRECOVERA BLE
OPOS_EPTR_CUTTER
OPOS_EPTR_MECHANICAL
OPOS_EPTR_OVERHEAT
OPOS_E_EXTENDED
OPOS_EPTR_COVER_OPEN
OPOS_EPTR_JRN_EMPTY
OPOS_EPTR_REC_EMPTY
Method
Result Code
ResultCodeExtended
PrintImmediate
OPOS_SUCCESS
0
OPOS_E_CLOSED
0
OPOS_E_CLAIMED
0
OPOS_E_NOTCLAIMED
0
OPOS_E_DISABLED
0
OPOS_E_ILLEGAL
0
OPOS_E_OFFLINE
0
OPOS_E_FAILURE
OPOS_EPTR_UNRECOVERA BLE
OPOS_EPTR_CUTTER
OPOS_EPTR_MECHANICAL
OPOS_EPTR_OVERHEAT
OPOS_E_EXTENDED
OPOS_EPTR_COVER_OPEN
OPOS_EPTR_JRN_EMPTY
OPOS_EPTR_REC_EMPTY
PrintNormal
ZQ110
PrintImmediate
Rev. 1.00
OPOS Driver Application Develop Guide
CutPaper
Method
Result Code
ResultCodeExtended
CutPaper
OPOS_SUCCESS
0
OPOS_E_CLOSED
0
OPOS_E_CLAIMED
0
OPOS_E_NOTCLAIMED
0
OPOS_E_DISABLED
0
OPOS_E_ILLEGAL
0
OPOS_E_OFFLINE
0
OPOS_E_FAILURE
OPOS_EPTR_UNRECOVERA BLE
OPOS_EPTR_CUTTER
OPOS_EPTR_MECHANICAL
OPOS_EPTR_OVERHEAT
OPOS_E_EXTENDED
OPOS_EPTR_COVER_OPEN
OPOS_EPTR_JRN_EMPTY
OPOS_EPTR_REC_EMPTY
Method
Result Code
ResultCodeExtended
RotatePrint
OPOS_SUCCESS
0
OPOS_E_CLOSED
0
OPOS_E_CLAIMED
0
OPOS_E_NOTCLAIMED
0
OPOS_E_DISABLED
0
OPOS_E_ILLEGAL
0
OPOS_E_OFFLINE
0
OPOS_E_FAILURE
OPOS_EPTR_UNRECOVERA BLE
OPOS_EPTR_CUTTER
OPOS_EPTR_MECHANICAL
OPOS_EPTR_OVERHEAT
OPOS_E_EXTENDED
OPOS_EPTR_COVER_OPEN
OPOS_EPTR_JRN_EMPTY
OPOS_EPTR_REC_EMPTY
Method Name
Result Code
ResultCodeExtended
PrintBitmap
OPOS_SUCCESS
0
OPOS_E_CLOSED
0
OPOS_E_CLAIMED
0
OPOS_E_NOTCLAIMED
0
OPOS_E_DISABLED
0
OPOS_E_ILLEGAL
0
OPOS_E_OFFLINE
0
OPOS_E_FAILURE
OPOS_EPTR_UNRECOVERA BLE
OPOS_EPTR_CUTTER
OPOS_EPTR_MECHANICAL
OPOS_EPTR_OVERHEAT
OPOS_E_NOEXIST
0
OPOS_E_EXTENDED
OPOS_EPTR_COVER_OPEN
OPOS_EPTR_JRN_EMPTY
OPOS_EPTR_REC_EMPTY
OPOS_EPTR_SLP_EMPTY
OPOS_EPTR_TOOBIG
OPOS_EPTR_BADFORMAT
RotatePrint
ZQ110
PrintBitmap
Rev. 1.00
OPOS Driver Application Develop Guide
SetBitmap
Method
Result Code
ResultCodeExtended
SetBitmap
OPOS_SUCCESS
0
OPOS_E_CLOSED
0
OPOS_E_CLAIMED
0
OPOS_E_NOTCLAIMED
0
OPOS_E_DISABLED
0
OPOS_E_ILLEGAL
0
OPOS_E_OFFLINE
0
OPOS_E_FAILURE
OPOS_EPTR_UNRECOVERA BLE
OPOS_EPTR_CUTTER
OPOS_EPTR_MECHANICAL
OPOS_EPTR_OVERHEAT
OPOS_E_NOEXIST
0
OPOS_E_EXTENDED
OPOS_EPTR_COVER_OPEN
OPOS_EPTR_JRN_EMPTY
OPOS_EPTR_REC_EMPTY
OPOS_EPTR_SLP_EMPTY
OPOS_EPTR_TOOBIG
OPOS_EPTR_BADFORMAT
Method
Result Code
ResultCodeExtended
SetLogo
OPOS_SUCCESS
0
OPOS_E_CLOSED
0
OPOS_E_CLAIMED
0
OPOS_E_NOTCLAIMED
0
OPOS_E_DISABLED
0
OPOS_E_ILLEGAL
0
Method
Result Code
ResultCodeExtended
TransactionPrint
OPOS_SUCCESS
0
OPOS_E_CLOSED
0
OPOS_E_CLAIMED
0
OPOS_E_NOTCLAIMED
0
OPOS_E_DISABLED
0
OPOS_E_ILLEGAL
0
OPOS_E_OFFLINE
0
OPOS_E_FAILURE
OPOS_EPTR_UNRECOVERA BLE
OPOS_EPTR_CUTTER
OPOS_EPTR_MECHANICAL
OPOS_EPTR_OVERHEAT
OPOS_E_NOEXIST
0
OPOS_E_EXTENDED
OPOS_EPTR_COVER_OPEN
OPOS_EPTR_JRN_EMPTY
OPOS_EPTR_REC_EMPTY
OPOS_EPTR_SLP_EMPTY
ZQ110
SetLogo
TransactionPrint
Rev. 1.00
www.zebra.com
Zebra Technologies International, LLC Zebra Technologies Europe Limited
475 Half Day Road Dukes Meadow
Suite 500, Lincolnshire
Illinois 60069 USA
Phone: +1.847.634.6700
Toll-Free: +1.800.230.9494
Fax: +1.847.913.8766
Millboard Road
Bourne End
Buckinghamshire, SL8 5XF, UK
Phone: +44 (0)1628 556000
Fax: +44 (0)1628 556001
Loading...