Programming Guide

for
ZPL II
ZBI 2
Set-Get-Do
Mirror
WML
P1012728-004
2

© 2010 ZIH Corp. The copyrights in this manual and the software and/or firmware in the printer described
therein are owned by ZIH Corp. and Zebra’s licensors. Unauthorized reproduction of this manual or the software
and/or firmware in the printer 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 Monotype Imaging fonts. Software © ZIH Corp. All rights reserved worldwide.

ZebraLink, Element Energy Equalizer, E3 and all product names and numbers are trademarks, and Zebra, the Zebra
head graphic, ZPL and ZPL II are registered trademarks of ZIH Corp. All rights reserved worldwide.

All other brand names, product names, or trademarks belong to their respective holders. For additional trademark
information, please see “Trademarks” on the product CD.

Proprietary Statement This manual contains proprietary information of Zebra Technologies Corporation and its
subsidiaries (“Zebra Technologies”). It is intended solely for the information and use of parties operating and
maintaining the equipment described herein. Such proprietary information may not be used, reproduced, or disclosed
to any other parties for any other purpose without the express, written permission of Zebra Technologies Corporation.

Product Improvements Continuous improvement of products is a policy of Zebra Technologies Corporation.

All specifications and designs are subject to change without notice.

Liability Disclaimer Zebra Technologies Corporation takes steps to ensure that its published Engineering
specifications and manuals are correct; however, errors do occur. Zebra Technologies Corporation reserves the right
to correct any such errors and disclaims liability resulting therefrom.

Limitation of Liability 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, consequential damages including loss of business profits, business
interruption, or loss of business information) arising out of the use of, 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. Some
jurisdictions do not allow the exclusion or limitation of incidental or consequential damages, so the above limitation
or exclusion may not apply to you.

P1012728-004 Rev. A Zebra Programming Guide 6/8/10

 Contents

Functional List of ZPL Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Alphabetical List of ZBI Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Alphabetical List of Set/Get/Do Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
About This Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Who Should Use This Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
How This Document Is Organized . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Contacts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Document Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

ZPL Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Basic ZPL Exercises and Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Before you begin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
^A Scalable/Bitmapped Font . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
^A@ Use Font Name to Call Font . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
^B0 Aztec Bar Code Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
^B1 Code 11 Bar Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
^B2 Interleaved 2 of 5 Bar Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
^B3 Code 39 Bar Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
^B4 Code 49 Bar Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
^B5 Planet Code bar code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
^B7 PDF417 Bar Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
^B8 EAN-8 Bar Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
^B9 UPC-E Bar Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
^BA Code 93 Bar Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
^BB CODABLOCK Bar Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80

6/8/10 Zebra Programming Guide P1012728-004 Rev. A

4 Contents

^BC Code 128 Bar Code (Subsets A, B, and C) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84

^BD UPS MaxiCode Bar Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
^BE EAN-13 Bar Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
^BF MicroPDF417 Bar Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
^BI Industrial 2 of 5 Bar Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
^BJ Standard 2 of 5 Bar Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
^BK ANSI Codabar Bar Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
^BL LOGMARS Bar Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
^BM MSI Bar Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
^BO Aztec Bar Code Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .113
^BP Plessey Bar Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .115
^BQ QR Code Bar Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .117
^BR GS1 Databar (formerly Reduced Space Symbology) . . . . . . . . . . . . . . . . . . . . . . 125
^BS UPC/EAN Extensions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
^BT TLC39 Bar Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
^BU UPC-A Bar Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
^BX Data Matrix Bar Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
^BY Bar Code Field Default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
^CC ~CC Change Caret . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
^BZ POSTAL Bar Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
^CD ~CD Change Delimiter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
^CF Change Alphanumeric Default Font . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
^CI Change International Font/Encoding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
^CM Change Memory Letter Designation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
^CN Cut Now . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
^CO Cache On . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
^CP Remove Label . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
^CT ~CT Change Tilde . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
^CV Code Validation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
^CW Font Identifier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
~DB Download Bitmap Font . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
~DE Download Encoding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
^DF Download Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
~DG Download Graphics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
~DN Abort Download Graphic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
~DS Download Intellifont (Scalable Font) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
~DT Download Bounded TrueType Font . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
~DU Download Unbounded TrueType Font . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
~DY Download Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
~EG Erase Download Graphics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176

P1012728-004 Rev. A Zebra Programming Guide 6/8/10

 Contents 5

^FB Field Block . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177

^FC Field Clock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
^FD Field Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
^FH Field Hexadecimal Indicator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
^FL Font Linking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184
^FM Multiple Field Origin Locations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
^FN Field Number . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
^FO Field Origin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
^FP Field Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
^FR Field Reverse Print . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
^FS Field Separator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
^FT Field Typeset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
^FV Field Variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
^FW Field Orientation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
^FX Comment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
^GB Graphic Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
^GC Graphic Circle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
^GD Graphic Diagonal Line . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
^GE Graphic Ellipse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
^GF Graphic Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206
^GS Graphic Symbol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208
~HB Battery Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209
~HD Head Diagnostic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
^HF Host Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .211
^HG Host Graphic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
^HH Configuration Label Return . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213
~HI Host Identification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
~HM Host RAM Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
~HQ Host Query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
~HQ Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219
~HS Host Status Return . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224
^HT Host Linked Fonts List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228
~HU Return ZebraNet Alert Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229
^HV Host Verification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
^HW Host Directory List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
^HY Upload Graphics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
^HZ Display Description Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234
^ID Object Delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236
^IL Image Load . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238
^IM Image Move . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239

6/8/10 Zebra Programming Guide P1012728-004 Rev. A

6 Contents

^IS Image Save . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240

~JA Cancel All . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242
^JB Initialize Flash Memory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
~JB Reset Optional Memory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244
~JC Set Media Sensor Calibration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245
~JD Enable Communications Diagnostics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246
~JE Disable Diagnostics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
~JF Set Battery Condition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248
~JG Graphing Sensor Calibration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249
^JH Early Warning Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250
^JI Start ZBI (Zebra BASIC Interpreter) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253
~JI Start ZBI (Zebra BASIC Interpreter) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255
^JJ Set Auxiliary Port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256
~JL Set Label Length . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258
^JM Set Dots per Millimeter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259
~JN Head Test Fatal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260
~JO Head Test Non-Fatal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261
~JP Pause and Cancel Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262
~JQ Terminate Zebra BASIC Interpreter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263
~JR Power On Reset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264
^JS Sensor Select . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265
~JS Change Backfeed Sequence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266
^JT Head Test Interval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268
^JU Configuration Update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269
^JW Set Ribbon Tension . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270
~JX Cancel Current Partially Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271
^JZ Reprint After Error . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272
~KB Kill Battery (Battery Discharge Mode) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273
^KD Select Date and Time Format (for Real Time Clock) . . . . . . . . . . . . . . . . . . . . . 274
^KL Define Language . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275
^KN Define Printer Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276
^KP Define Password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277
^KV Kiosk Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278
^LF List Font Links . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282
^LH Label Home . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283
^LL Label Length . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284
^LR Label Reverse Print . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285
^LS Label Shift . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286
^LT Label Top . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287
^MA Set Maintenance Alerts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288

P1012728-004 Rev. A Zebra Programming Guide 6/8/10

 Contents 7

^MC Map Clear . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290

^MD Media Darkness . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291
^MF Media Feed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292
^MI Set Maintenance Information Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293
^ML Maximum Label Length . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294
^MM Print Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295
^MN Media Tracking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297
^MP Mode Protection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298
^MT Media Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300
^MU Set Units of Measurement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301
^MW Modify Head Cold Warning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303
^NC Select the Primary Network Device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304
~NC Network Connect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305
^ND Change Network Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306
^NI Network ID Number . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308
~NR Set All Network Printers Transparent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309
^NS Change Wired Networking Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310
~NT Set Currently Connected Printer Transparent . . . . . . . . . . . . . . . . . . . . . . . . . . 312
^PA Advanced Text Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313
^PF Slew Given Number of Dot Rows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314
^PH ~PH Slew to Home Position . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315
~PL Present Length Addition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316
^PM Printing Mirror Image of Label . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317
^PN Present Now . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318
^PO Print Orientation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 319
^PP ~PP Programmable Pause . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 320
^PQ Print Quantity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 321
^PR Print Rate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322
~PR Applicator Reprint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 324
~PS Print Start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325
^PW Print Width . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326
~RO Reset Advanced Counters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 327
^SC Set Serial Communications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329
~SD Set Darkness . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 330
^SE Select Encoding Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331
^SF Serialization Field (with a Standard ^FD String) . . . . . . . . . . . . . . . . . . . . . . . . . 332
^SI Set Sensor Intensity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 335
^SL Set Mode and Language (for Real-Time Clock) . . . . . . . . . . . . . . . . . . . . . . . . . 336
^SN Serialization Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 338
^SO Set Offset (for Real-Time Clock) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 341

6/8/10 Zebra Programming Guide P1012728-004 Rev. A

8 Contents

^SP Start Print . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 342

^SQ Halt ZebraNet Alert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 344
^SR Set Printhead Resistance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 346
^SS Set Media Sensors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 347
^ST Set Date and Time (for Real-Time Clock) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349
^SX Set ZebraNet Alert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 350
^SZ Set ZPL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 352
~TA Tear-off Adjust Position . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353
^TB Text Blocks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 354
^TO Transfer Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 355
~WC Print Configuration Label . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 357
^WD Print Directory Label . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 358
~WQ Write Query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 360
~WQ Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 362
^XA Start Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 367
^XB Suppress Backfeed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 368
^XF Recall Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 369
^XG Recall Graphic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 370
^XS Set Dynamic Media Calibration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371
^XZ End Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 372
^ZZ Printer Sleep . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 373

ZPL RFID Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 375

RFID Command Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 376
Printer and Firmware Compatibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 376
^HL or ~HL Return RFID Data Log to Host . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 380
^HR Calibrate RFID Transponder Position . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 381
^RA Read AFI or DSFID Byte . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 387
^RB Define EPC Data Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 389
^RE Enable/Disable E.A.S. Bit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 391
^RF Read or Write RFID Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 392
^RI Get RFID Tag ID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 395
^RM Enable RFID Motion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 396
^RN Detect Multiple RFID Tags in Encoding Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . 397
^RQ Quick Write EPC Data and Passwords . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 398
^RR Specify RFID Retries for a Block . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 400
^RS Set Up RFID Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 402
^RT Read RFID Tag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 410
~RV Report RFID Encoding Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 412
^RW Set RF Power Levels for Read and Write . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 413

P1012728-004 Rev. A Zebra Programming Guide 6/8/10

 Contents 9

^RZ Set RFID Tag Password and Lock Tag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 416

^WF Encode AFI or DSFID Byte . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 418
^WT Write (Encode) Tag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 420
^WV Verify RFID Encoding Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 422

ZPL Wireless Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 423

^KC Set Client Identifier (Option 61) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 424
^NB Search for Wired Print Server during Network Boot . . . . . . . . . . . . . . . . . . . . . . . 425
^NN Set SNMP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 426
^NP Set Primary/Secondary Device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 427
^NT Set SMTP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 428
^NW Set Web Authentication Timeout Value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 429
^WA Set Antenna Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 430
^WE Set WEP Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 431
^WI Change Wireless Network Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 433
^WL Set LEAP Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 435
~WL Print Network Configuration Label . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 436
^WP Set Wireless Password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 437
^WR Set Transmit Rate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 438
~WR Reset Wireless Radio Card and Print Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . 439
^WS Set Wireless Radio Card Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 440
^WX Configure Wireless Securities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 442
Supporting Parameters for Different Security Types . . . . . . . . . . . . . . . . . . . . . . . . 446

ZBI Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 451

Command and Function Reference Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 452
Function Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 453
Introduction to Zebra Basic Interpreter (ZBI) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 453
What is ZBI and why is it for me? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 453
Printers, ZBI Keys, & ZBI Versions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 454
Section Organization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 456
Writing ZBI Programs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 456
Editing Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 457
Running and Debugging Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 465

6/8/10 Zebra Programming Guide P1012728-004 Rev. A

10 Contents

Base Types and Expressions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 479

Variable Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 480
Variable Declarations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 481
Constants . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 481
Arrays . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 481
Assignment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 483
Numeric Expressions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 485
String Concatenation (&) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 487
Sub-strings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 487
Boolean Expressions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 489
Combined Boolean Expressions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 491
Control and Flow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 492
Input and Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 500
Available Ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 500
Creating Connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 501
Reading and Writing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 509
Port Usage Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 519
File System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 526
Runtime Access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 527
Comma Separated Values (CSV) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 533
Accessing Comma Separated Value (CSV) and Text File Functions . . . . . . . . . . . . 533
Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 539
Available Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 540
ZBI Key Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 542
Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 550
Applicator Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 557
String Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 563
Math Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 579
Array Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 588
Time and Date Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 597
Set/Get/Do Interactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 602
Example Programs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 605
Array Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 605
CSV Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 607
DPI Conversion Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .611
Email Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 615
Extraction 1 Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 617
Extraction 2 Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 619
Front Panel Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 621
Recall Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 623
Scale Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 625

P1012728-004 Rev. A Zebra Programming Guide 6/8/10

 Contents 11

SGD Printer Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 627

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 628
setvar Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 628
getvar Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 628
do Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 629
Command Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 630
How to Send Multiple SGD Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 630
appl.option_board_version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 631
appl.bootblock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 632
appl.name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 633
CISDFCRC16 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 634
Download Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 634
cutter.clean_cutter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 636
device.download_connection_timeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 637
device.epl_legacy_mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 638
device.friendly_name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 640
device.frontpanel.key_press . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 641
device.frontpanel.line1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 642
device.frontpanel.line2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 643
device.frontpanel.xml . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 644
device.jobs_print . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 645
device.languages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 646
device.orientation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 647
device.pnp_option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 648
device.reset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 649
device.restore_defaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 650
device.unique_id . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 651
device.uptime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 652
device.user_p1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 653
device.user_p2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 654
device.xml.enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 655
display.text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 656
file.delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 657
file.dir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 658
file.type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 659
file.run . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 660
head.latch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 661
interface.network.active.gateway . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 662
interface.network.active.ip_addr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 663
interface.network.active.mac_addr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 664
interface.network.active.mac_raw . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 665
interface.network.active.netmask . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 666
interface.network.active.protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 667
media.cartridge.part_number . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 668

6/8/10 Zebra Programming Guide P1012728-004 Rev. A

12 Contents

media.cut_now . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 669
media.darkness_mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 670
media.media_low.external . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 671
media.media_low.warning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 672
media.present.cut_amount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 673
media.present.eject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 674
media.present.length_addition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 675
media.present.loop_length . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 676
media.present.loop_length_max . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 677
media.present.cut_margin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 678
media.present.present_timeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 679
media.present.present_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 680
media.printmode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 681
media.speed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 683
odometer.headclean . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 684
odometer.headnew . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 685
odometer.label_dot_length . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 686
odometer.media_marker_count1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 687
odometer.media_marker_count2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 688
odometer.retracts_count . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 689
odometer.rfid.valid_resettable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 690
odometer.rfid.void_resettable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 691
odometer.total_print_length . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 692
print.tone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 693
rfid.error.response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 694
rfid.position.program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 695
rfid.reader_1.antenna_port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 697
rfid.reader_1.power.read . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 699
rfid.reader_1.power.single_power . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 700
rfid.reader_1.power.write . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 701
rfid.tag.calibrate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 703
rfid.tag.data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 704
rfid.tag.test . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 705
rfid.tag.type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 706
zbi.control.add_breakpoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 709
zbi.control.break . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 710
zbi.control.clear_breakpoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .711
zbi.control.delete_breakpoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 712
zbi.control.line_number . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 713
zbi.control.restart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 714
zbi.control.run . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 715
zbi.control.step . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 716
zbi.control.terminate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 717
zbi.control.variable_name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 718
zbi.control.variable_value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 719

P1012728-004 Rev. A Zebra Programming Guide 6/8/10

 Contents 13

zbi.key . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 720
zbi.last_error . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 721
zbi.reseller_key . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 722
zbi.revision . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 723
zbi.running_program_name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 724
zbi.start_info.execute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 725
zbi.start_info.file_name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 726
zbi.start_info.memory_alloc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 727
zbi.state . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 728

SGD Wired Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 729

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 730
setvar Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 730
getvar Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 730
do Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 731
Command Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 732
How to Send Multiple SGD Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 732
external_wired.check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 733
external_wired.ip.addr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 734
external_wired.ip.arp_interval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 735
external_wired.ip.default_addr_enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 736
external_wired.ip.dhcp.cid_all . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 737
external_wired.ip.dhcp.cid_enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 738
external_wired.ip.dhcp.cid_prefix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 739
external_wired.ip.dhcp.cid_suffix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 740
external_wired.ip.dhcp.cid_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 741
external_wired.ip.gateway . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 742
external_wired.ip.netmask . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 743
external_wired.ip.port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 744
external_wired.ip.protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 745
external_wired.ip.timeout.enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 746
external_wired.ip.timeout.value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 747
external_wired.ip.v6.addr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 748
external_wired.ip.v6.gateway . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 749
external_wired.ip.v6.prefix_length . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 750
external_wired.mac_addr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 751
external_wired.mac_raw . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 752
internal_wired.auto_switchover . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 753
internal_wired.ip.addr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 754
internal_wired.ip.arp_interval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 755
internal_wired.ip.default_addr_enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 756
internal_wired.ip.dhcp.cache_ip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 757
internal_wired.ip.dhcp.cid_all . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 758
internal_wired.ip.dhcp.cid_enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 759
internal_wired.ip.dhcp.cid_prefix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 760

6/8/10 Zebra Programming Guide P1012728-004 Rev. A

14 Contents

internal_wired.ip.dhcp.cid_suffix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 761
internal_wired.ip.dhcp.cid_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 762
internal_wired.ip.dhcp.option12 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 767
internal_wired.ip.dhcp.option12_format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 768
internal_wired.ip.gateway . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 773
internal_wired.ip.netmask . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 774
internal_wired.ip.port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 775
internal_wired.ip.protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 776
internal_wired.ip.timeout.enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 777
internal_wired.ip.timeout.value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 778
internal_wired.mac_addr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 779
internal_wired.mac_raw . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 780

SGD Wireless Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 781

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 783
setvar Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 783
getvar Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 783
do Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 784
Command Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 785
How to Send Multiple SGD Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 785
bluetooth.address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 786
bluetooth.afh_map . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 787
bluetooth.afh_map_curr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 788
bluetooth.afh_mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 789
bluetooth.authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 790
bluetooth.bluetooth_pin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 791
bluetooth.date . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 792
bluetooth.discoverable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 793
bluetooth.enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 794
bluetooth.friendly_name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 795
bluetooth.local_name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 796
bluetooth.radio_auto_baud . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 797
bluetooth.radio_version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 798
bluetooth.short_address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 799
bluetooth.version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 800
card.mac_addr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 801
card.inserted . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 802
comm.type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 803
ip.active_network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 804
ip.addr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 805
ip.arp_interval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 806
ip.bootp.enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 807
ip.dhcp.cache_ip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 808
ip.dhcp.cid_all . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 809
ip.dhcp.cid_enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 810

P1012728-004 Rev. A Zebra Programming Guide 6/8/10

 Contents 15

ip.dhcp.cid_prefix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .811
ip.dhcp.cid_suffix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 812
ip.dhcp.lease.length . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 813
ip.dhcp.cid_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 814
ip.dhcp.enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 815
ip.dhcp.lease.last_attempt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 816
ip.dhcp.lease.server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 817
ip.dhcp.lease.time_left . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 818
ip.dhcp.option12 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 819
ip.dhcp.option12_format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 820
ip.dhcp.option12_value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 821
ip.dhcp.request_timeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 822
ip.dhcp.requests_per_session . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 823
ip.dhcp.session_interval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 824
ip.dns.domain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 825
ip.dns.servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 826
ip.ftp.enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 827
ip.ftp.execute_file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 828
ip.gateway . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 829
ip.http.enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 830
ip.lpd.enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 831
ip.mac_raw . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 832
ip.mirror.auto . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 833
ip.mirror.error_retry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 834
ip.mirror.feedback.auto . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 835
ip.mirror.feedback.freq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 836
ip.mirror.feedback.odometer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 837
ip.mirror.feedback.path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 838
ip.mirror.fetch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 839
ip.mirror.freq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 840
ip.mirror.freq_hours . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 841
ip.mirror.last_error . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 842
ip.mirror.last_time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 843
ip.mirror.password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 844
ip.mirror.path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 845
ip.mirror.reset_delay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 846
ip.mirror.server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 847
ip.mirror.success . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 848
ip.mirror.success_time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 849
ip.mirror.username . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 850
ip.mirror.version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 851
ip.netmask . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 852
ip.pop3.enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 853
ip.pop3.password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 854
ip.pop3.poll . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 855

6/8/10 Zebra Programming Guide P1012728-004 Rev. A

16 Contents

ip.pop3.server_addr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 856
ip.pop3.username . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 857
ip.port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 858
ip.primary_network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 859
ip.smtp.domain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 860
ip.smtp.enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 861
ip.smtp.server_addr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 862
ip.snmp.get_community_name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 863
ip.snmp.set_community_name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 864
ip.snmp.enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 865
ip.telnet.enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 866
ip.tcp.enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 867
ip.udp.enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 868
wlan.adhocautomode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 869
wlan.adhocchannel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 870
wlan.associated . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 871
wlan.bssid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 872
wlan.channel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 873
wlan.channel_mask . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 874
wlan.current_tx_rate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 875
wlan.essid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 876
wlan.firmware_version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 877
wlan.ip.addr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 878
wlan.ip.arp_interval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 879
wlan.ip.default_addr_enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 880
wlan.ip.dhcp.cache_ip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 881
wlan.ip.dhcp.cid_all . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 882
wlan.ip.dhcp.cid_enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 883
wlan.ip.dhcp.cid_prefix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 884
wlan.ip.dhcp.cid_suffix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 885
wlan.ip.dhcp.cid_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 886
wlan.ip.dhcp.lease.last_attempt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 887
wlan.ip.dhcp.lease.length . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 888
wlan.ip.dhcp.lease.server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 889
wlan.ip.dhcp.lease.time_left . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 890
wlan.ip.dhcp.option12 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 891
wlan.ip.dhcp.option12_format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 892
wlan.ip.dhcp.option12_value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 893
wlan.ip.dhcp.request_timeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 894
wlan.ip.dhcp.requests_per_session . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 895
wlan.ip.dhcp.session_interval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 896
wlan.ip.gateway . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 897
wlan.ip.netmask . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 898
wlan.ip.port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 899
wlan.ip.protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 900

P1012728-004 Rev. A Zebra Programming Guide 6/8/10

 Contents 17

wlan.ip.timeout.enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 901
wlan.ip.timeout.value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 902
wlan.keep_alive.enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 903
wlan.keep_alive.timeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 904
wlan.kerberos.kdc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 905
wlan.kerberos.password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 906
wlan.kerberos.realm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 907
wlan.kerberos.username . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 908
wlan.mac_addr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 909
wlan.mac_raw . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 910
wlan.operating_mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .911
wlan.password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 912
wlan.preamble . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 913
wlan.private_key_password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 914
wlan.roam.interchannel_delay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 915
wlan.roam.interval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 916
wlan.roam.max_chan_scan_time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 917
wlan.roam.signal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 918
wlan.security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 919
Supporting SGD Commands for Different Security Types . . . . . . . . . . . . . . . . . . . . 920
wlan.signal_noise . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 927
wlan.signal_quality . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 928
wlan.signal_strength . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 929
wlan.station_name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 930
wlan.tx_power . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 931
wlan.tx_rate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 932
wlan.username . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 933
wlan.wep.auth_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 934
wlan.wep.index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 935
wlan.wep.key1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 936
wlan.wep.key2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 937
wlan.wep.key3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 938
wlan.wep.key4 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 939
wlan.wpa.psk . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 940
wlan.wep.key_format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 941

Zebra Code Pages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 943

Zebra Code Page 850 — Latin Character Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 944
Zebra Code Page 1250 (Scalable/Downloaded TTF) —Central and Eastern European Latin
Character Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 946
Zebra Code Page 1252— Latin Character Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 948
Zebra Code Page 1253 — Modern Greek Character Set . . . . . . . . . . . . . . . . . . . . . . . 950
Zebra Code Page 1254 — Turkish Character Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 952
Zebra Code Page 1255 — Hebrew Character Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . 954

6/8/10 Zebra Programming Guide P1012728-004 Rev. A

18 Contents

ASCII . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 957
ASCII Code Chart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 958

Fonts and Bar Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 959

Standard Printer Fonts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 960
Proportional and Fixed Spacing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 962
Scalable Versus Bitmapped Fonts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 964
Scalable Fonts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 964
Bitmapped Fonts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 964
Font Matrices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 966
Bar Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 968
Basic Format for Bar Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 968
Bar Code Field Instructions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 969
Bar Code Command Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 971

Mod 10 and Mod 43 Check Digits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 973

Mod 10 Check Digit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 974
Mod 43 Check Digit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 975

Error Detection Protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 977

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 978
What is a Protocol? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 978
How Protocols Work . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 978
Request Packet Formats from the Host Computer . . . . . . . . . . . . . . . . . . . . . . . . . . . . 979
Header Block Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 979
Data Block Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 980
Response From the Zebra Printer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 981
Zebra Packet Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 981
Header Block Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 981
Data Block Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 982
Disguising Control Code Characters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 983
Error Detection Protocol Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 984
Error Conditions and System Faults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 984
How the Zebra Printer Processes a Request Packet . . . . . . . . . . . . . . . . . . . . . . . 985
How the Zebra Printer Responds to Host Status . . . . . . . . . . . . . . . . . . . . . . . . . . . 986

ZB64 Encoding and Compression . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 987

Introduction to B64 and Z64 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 988
B64 and Z64 Encoding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 990

Field Interactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 993

Normal Orientation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 994
Rotated Orientation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 995
Bottom Up Orientation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 996

P1012728-004 Rev. A Zebra Programming Guide 6/8/10

 Contents 19

Inverted Orientation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 997

Real Time Clock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 999

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1000
Control Panel Programming . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1001
Real Time Clock Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1001
RTC Date . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1002
RTC Time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1003
RTC General Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1004
First Day of the Week Affects Calendar Week . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1006
Time and Date Precision . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1009
ZPL II Samples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1011

ZBI Character Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1015

Character Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1016

SGD Command Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1019

Printer and Firmware Compatibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1020
Printer Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1020

Firmware Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1039

Firmware x.17 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1040
Firmware x.16 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1041
Firmware x.15 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1043
Wireless Securities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1043
ZPL and SGD Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1044
SNMP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1044
Set / Get / Do Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1044
XML-Enabled Printing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1044
Firmware x.14 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1045
Global Printing Solution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1046

Mirror . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1049
Mirror Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1050
Benefits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1050
Professional Services for Mirror Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1051
Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1052
How Mirror Works . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1054
Mirror Process Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1055
Mirror Process Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1055

6/8/10 Zebra Programming Guide P1012728-004 Rev. A

20 Contents

Creating ZPL Files for Use in the

"<update-root>/files" Directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1057
One Format per File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1057
Character Substitution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1058
Removing the ^XA and ^XZ commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1058
Removing the ^DF command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1059
Example Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1060
File Naming Recommendations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1060
Command Use Recommendations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1060
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1061
Mirror FTP Server Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1061
Mirror Printer Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1061
The Feedback.get File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1062
Example Feedback.get file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1063
How to Set Up and Use Mirror . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1065
Scenario One . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1065
Scenario Two . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1066
Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1067

Wireless Markup Language (WML) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1071

WML Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1072
WML Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1072
Supported Printers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1073
Professional Services for WML Content Creation . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1073
WML Tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1074
Using WML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1074
Send WML Content to the Printer via FTP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1075
Resetting the "ip.ftp.execute_file setting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1076
Sending WML Content to the Printer via the CISDFCRC16 Command: . . . . . . . . 1077
Retrieving WML Content from the Printer using the file.type Command: . . . . . . . 1078
Using .nrd Files from WML Menus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1078
Removing WML or .nrd Files from the Printer using the file.delete Command: . . . 1078
WML Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1078
Example 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1079
Example 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1080
Example 3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1081
Example 4 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1083
Example 5 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1084
Troubleshooting Scenarios . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1087

Glossary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1089
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1093

P1012728-004 Rev. A Zebra Programming Guide 6/8/10

 Functional List
of ZPL Commands

Abort Download Graphic . . . . . . . . . . . . . . . 168 Define Language . . . . . . . . . . . . . . . . . . . . . . 275

Advanced Text Properties . . . . . . . . . . . . . . . 313 Define Password . . . . . . . . . . . . . . . . . . . . . . 277
ANSI Codabar Bar Code . . . . . . . . . . . . . . . . 107 Define Printer Name . . . . . . . . . . . . . . . . . . . 276
Applicator Reprint . . . . . . . . . . . . . . . . . . . . . 324 Detect Multiple RFID Tags in Encoding Field . 397
Aztec Bar Code Parameters . . . . . . . . . . . . . . 113 Disable Diagnostics . . . . . . . . . . . . . . . . . . . . 247
Aztec Bar Code Parameters . . . . . . . . . . . . . . . 53 Display Description Information . . . . . . . . . . 234
Bar Code Field Default . . . . . . . . . . . . . . . . . 138 Download Bitmap Font . . . . . . . . . . . . . . . . . 160
Battery Status . . . . . . . . . . . . . . . . . . . . . . . . 209 Download Bounded TrueType Font . . . . . . . 170
Cache On . . . . . . . . . . . . . . . . . . . . . . . . . . . 152 Download Encoding . . . . . . . . . . . . . . . . . . . 162
Calibrate RFID Transponder Position . . . . . . . 381 Download Files . . . . . . . . . . . . . . . . . . . . . . . . 634
Cancel All . . . . . . . . . . . . . . . . . . . . . . . . . . . 242 Download Format . . . . . . . . . . . . . . . . . . . . . 164
Cancel Current Partially Input Format . . . . . . 271 Download Graphics . . . . . . . . . . . . . . . . . . . . 165
Change Alphanumeric Default Font . . . . . . 144 Download Intellifont (Scalable Font) . . . . . . . 169
Change Backfeed Sequence . . . . . . . . . . . . 266 Download Objects . . . . . . . . . . . . . . . . . . . . . . 172
Change Caret . . . . . . . . . . . . . . . . . . . . . . . . 140 Download Unbounded TrueType Font . . . . . 171
Change Delimiter . . . . . . . . . . . . . . . . . . . . . 143 EAN-13 Bar Code . . . . . . . . . . . . . . . . . . . . . . 99
Change International Font/Encoding . . . . . . . 145 EAN-8 Bar Code . . . . . . . . . . . . . . . . . . . . . . . . 72
Change Memory Letter Designation . . . . . . 149 Early Warning Settings . . . . . . . . . . . . . . . . . . 250
Change Network Settings . . . . . . . . . . . . . . . . 306 Enable Communications Diagnostics . . . . . . 246
Change Tilde . . . . . . . . . . . . . . . . . . . . . . . . 155 Enable RFID Motion . . . . . . . . . . . . . . . . . . . . 396
Change Wired Networking Settings . . . . . . . . 310 Enable/Disable E.A.S. Bit . . . . . . . . . . . . . . . . 391
Change Wireless Network Settings . . . . . . . . 433 Encode AFI or DSFID Byte . . . . . . . . . . . . . . . 418
CODABLOCK Bar Code . . . . . . . . . . . . . . . . . . 80 End Format . . . . . . . . . . . . . . . . . . . . . . . . . . 372
Code 11 Bar Code . . . . . . . . . . . . . . . . . . . . . 55 Erase Download Graphics . . . . . . . . . . . . . . 176
Code 128 Bar Code (Subsets A, B, and C) . . . 84 Field Block . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
Code 39 Bar Code . . . . . . . . . . . . . . . . . . . . . . 59 Field Clock . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
Code 49 Bar Code . . . . . . . . . . . . . . . . . . . . . . 63 Field Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
Code 93 Bar Code . . . . . . . . . . . . . . . . . . . . . . 76 Field Hexadecimal Indicator . . . . . . . . . . . . . . 182
Code Validation . . . . . . . . . . . . . . . . . . . . . . . 156 Field Number . . . . . . . . . . . . . . . . . . . . . . . . . 190
Comment . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200 Field Orientation . . . . . . . . . . . . . . . . . . . . . . 198
Configuration Label Return . . . . . . . . . . . . . . . 213 Field Origin . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
Configuration Update . . . . . . . . . . . . . . . . . . 269 Field Parameter . . . . . . . . . . . . . . . . . . . . . . . 192
Configure Wireless Securities . . . . . . . . . . . . 442 Field Reverse Print . . . . . . . . . . . . . . . . . . . . 193
Cut Now . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151 Field Separator . . . . . . . . . . . . . . . . . . . . . . . 194
Data Matrix Bar Code . . . . . . . . . . . . . . . . . . 134 Field Typeset . . . . . . . . . . . . . . . . . . . . . . . . . 195
Define EPC Data Structure . . . . . . . . . . . . . . . 389 Field Variable . . . . . . . . . . . . . . . . . . . . . . . . 197

6/8/10 Zebra Programming Guide P1012728-004 Rev. A

22 Functional List of ZPL Commands

Font Identifier . . . . . . . . . . . . . . . . . . . . . . . . . 158 Object Delete . . . . . . . . . . . . . . . . . . . . . . . . 236

Font Linking . . . . . . . . . . . . . . . . . . . . . . . . . . 184 Pause and Cancel Format . . . . . . . . . . . . . 262
Get RFID Tag ID . . . . . . . . . . . . . . . . . . . . . . . 395 PDF417 Bar Code . . . . . . . . . . . . . . . . . . . . . . 68
Graphic Box . . . . . . . . . . . . . . . . . . . . . . . . . 201 Planet Code bar code . . . . . . . . . . . . . . . . . . . . 67
Graphic Circle . . . . . . . . . . . . . . . . . . . . . . . . 203 Plessey Bar Code . . . . . . . . . . . . . . . . . . . . . . 115
Graphic Diagonal Line . . . . . . . . . . . . . . . . . 204 POSTAL Bar Code . . . . . . . . . . . . . . . . . . . . . 141
Graphic Ellipse . . . . . . . . . . . . . . . . . . . . . . 205 Power On Reset . . . . . . . . . . . . . . . . . . . . . . 264
Graphic Field . . . . . . . . . . . . . . . . . . . . . . . . 206 Present Length Addition . . . . . . . . . . . . . . . . . 316
Graphic Symbol . . . . . . . . . . . . . . . . . . . . . . 208 Present Now . . . . . . . . . . . . . . . . . . . . . . . . . . 318
Graphing Sensor Calibration . . . . . . . . . . . . . 249 Print Configuration Label . . . . . . . . . . . . . . . . . 357
GS1 Databar (formerly Reduced Space Symbolo- Print Directory Label . . . . . . . . . . . . . . . . . . . 358
gy) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125 Print Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295
Halt ZebraNet Alert . . . . . . . . . . . . . . . . . . . . . 344 Print Network Configuration Label . . . . . . . . . 436
Head Diagnostic . . . . . . . . . . . . . . . . . . . . . . . 210 Print Orientation . . . . . . . . . . . . . . . . . . . . . . . 319
Head Test Fatal . . . . . . . . . . . . . . . . . . . . . . 260 Print Quantity . . . . . . . . . . . . . . . . . . . . . . . . 321
Head Test Interval . . . . . . . . . . . . . . . . . . . . 268 Print Rate . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322
Head Test Non-Fatal . . . . . . . . . . . . . . . . . . 261 Print Start . . . . . . . . . . . . . . . . . . . . . . . . . . . 325
Host Directory List . . . . . . . . . . . . . . . . . . . . 231 Print Width . . . . . . . . . . . . . . . . . . . . . . . . . . 326
Host Format . . . . . . . . . . . . . . . . . . . . . . . . . . 211 Printer Sleep . . . . . . . . . . . . . . . . . . . . . . . . . 373
Host Graphic . . . . . . . . . . . . . . . . . . . . . . . . 212 Printing Mirror Image of Label . . . . . . . . . . . 317
Host Identification . . . . . . . . . . . . . . . . . . . . 214 Programmable Pause . . . . . . . . . . . . . . . . . . 320
Host Linked Fonts List . . . . . . . . . . . . . . . . . . 228 QR Code Bar Code . . . . . . . . . . . . . . . . . . . . . 117
Host Query . . . . . . . . . . . . . . . . . . . . . . . . . . . 216 Quick Write EPC Data and Passwords . . . . . . 398
Host RAM Status . . . . . . . . . . . . . . . . . . . . . 215 Read AFI or DSFID Byte . . . . . . . . . . . . . . . . . 387
Host Status Return . . . . . . . . . . . . . . . . . . . . 224 Read or Write RFID Format . . . . . . . . . . . . . . 392
Host Verification . . . . . . . . . . . . . . . . . . . . . . . 230 Read RFID Tag . . . . . . . . . . . . . . . . . . . . . . . . 410
Image Load . . . . . . . . . . . . . . . . . . . . . . . . . . 238 Recall Format . . . . . . . . . . . . . . . . . . . . . . . . 369
Image Move . . . . . . . . . . . . . . . . . . . . . . . . . 239 Recall Graphic . . . . . . . . . . . . . . . . . . . . . . . . 370
Image Save . . . . . . . . . . . . . . . . . . . . . . . . . 240 Remove Label . . . . . . . . . . . . . . . . . . . . . . . . . 154
Industrial 2 of 5 Bar Codes . . . . . . . . . . . . . . 103 Report RFID Encoding Results . . . . . . . . . . . . 412
Initialize Flash Memory . . . . . . . . . . . . . . . . . 243 Reprint After Error . . . . . . . . . . . . . . . . . . . . . 272
Interleaved 2 of 5 Bar Code . . . . . . . . . . . . . . 57 Reset Advanced Counters . . . . . . . . . . . . . . . 327
Kill Battery (Battery Discharge Mode) . . . . . 273 Reset Optional Memory . . . . . . . . . . . . . . . . 244
Kiosk Values . . . . . . . . . . . . . . . . . . . . . . . . . . 278 Reset Wireless Radio Card and Print Server . 439
Label Home . . . . . . . . . . . . . . . . . . . . . . . . . . 283 Return RFID Data Log to Host . . . . . . . . . . . . 380
Label Length . . . . . . . . . . . . . . . . . . . . . . . . . 284 Return ZebraNet Alert Configuration . . . . . . . . 229
Label Reverse Print . . . . . . . . . . . . . . . . . . . . 285 Scalable/Bitmapped Font . . . . . . . . . . . . . . . . . 49
Label Shift . . . . . . . . . . . . . . . . . . . . . . . . . . . 286 Search for Wired Print Server during Network Boot
Label Top . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287 425
List Font Links . . . . . . . . . . . . . . . . . . . . . . . . 282 Select Date and Time Format (for Real Time Clock)
LOGMARS Bar Code . . . . . . . . . . . . . . . . . . . 109 274
Map Clear . . . . . . . . . . . . . . . . . . . . . . . . . . . 290 Select Encoding Table . . . . . . . . . . . . . . . . . . 331
Maximum Label Length . . . . . . . . . . . . . . . . 294 Select the Primary Network Device . . . . . . . . . 304
Media Darkness . . . . . . . . . . . . . . . . . . . . . . 291 Sensor Select . . . . . . . . . . . . . . . . . . . . . . . . . 265
Media Feed . . . . . . . . . . . . . . . . . . . . . . . . . . 292 Serialization Data . . . . . . . . . . . . . . . . . . . . . . 338
Media Tracking . . . . . . . . . . . . . . . . . . . . . . . 297 Serialization Field (with a Standard ^FD String) .
Media Type . . . . . . . . . . . . . . . . . . . . . . . . . . 300 332
MicroPDF417 Bar Code . . . . . . . . . . . . . . . . . 101 Set All Network Printers Transparent . . . . . . 309
Mode Protection . . . . . . . . . . . . . . . . . . . . . . 298 Set Antenna Parameters . . . . . . . . . . . . . . . . . 430
Modify Head Cold Warning . . . . . . . . . . . . . . . 303 Set Auxiliary Port . . . . . . . . . . . . . . . . . . . . . . 256
MSI Bar Code . . . . . . . . . . . . . . . . . . . . . . . . 111 Set Battery Condition . . . . . . . . . . . . . . . . . . 248
Multiple Field Origin Locations . . . . . . . . . . . 187 Set Client Identifier (Option 61) . . . . . . . . . . . . 424
Network Connect . . . . . . . . . . . . . . . . . . . . . 305 Set Currently Connected Printer Transparent 312
Network ID Number . . . . . . . . . . . . . . . . . . . 308 Set Darkness . . . . . . . . . . . . . . . . . . . . . . . . . 330

P1012728-004 Rev. A Zebra Programming Guide 6/8/10

 Functional List of ZPL Commands 23

Set Date and Time (for Real-Time Clock) . . 349

Set Dots per Millimeter . . . . . . . . . . . . . . . . 259
Set Dynamic Media Calibration . . . . . . . . . . . 371
Set Label Length . . . . . . . . . . . . . . . . . . . . . 258
Set LEAP Parameters . . . . . . . . . . . . . . . . . . 435
Set Maintenance Alerts . . . . . . . . . . . . . . . . . 288
Set Maintenance Information Message . . . . . 293
Set Media Sensor Calibration . . . . . . . . . . . 245
Set Media Sensors . . . . . . . . . . . . . . . . . . . . 347
Set Mode and Language
(for Real-Time Clock) . . . . . . . . . . . . . . . 336
Set Offset (for Real-Time Clock) . . . . . . . . . . 341
Set Primary/Secondary Device . . . . . . . . . . . . 427
Set Printhead Resistance . . . . . . . . . . . . . . . 346
Set RF Power Levels for Read and Write . . . . 413
Set RFID Tag Password and Lock Tag . . . . . 416
Set Ribbon Tension . . . . . . . . . . . . . . . . . . . . 270
Set Sensor Intensity . . . . . . . . . . . . . . . . . . . . 335
Set Serial Communications . . . . . . . . . . . . . 329
Set SMTP . . . . . . . . . . . . . . . . . . . . . . . . . . . . 428
Set SNMP . . . . . . . . . . . . . . . . . . . . . . . . . . . . 426
Set Transmit Rate . . . . . . . . . . . . . . . . . . . . . . 438
Set Units of Measurement . . . . . . . . . . . . . . 301
Set Up RFID Parameters . . . . . . . . . . . . . . . . 402
Set Web Authentication Timeout Value . . . . . 429
Set WEP Mode . . . . . . . . . . . . . . . . . . . . . . . . 431
Set Wireless Password . . . . . . . . . . . . . . . . . . 437
Set Wireless Radio Card Values . . . . . . . . . . 440
Set ZebraNet Alert . . . . . . . . . . . . . . . . . . . . . 350
Set ZPL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 352
Slew Given Number of Dot Rows . . . . . . . . . 314
Slew to Home Position . . . . . . . . . . . . . . . . . 315
Specify RFID Retries for a Block . . . . . . . . . . 400
Standard 2 of 5 Bar Code . . . . . . . . . . . . . . . . 105
Start Format . . . . . . . . . . . . . . . . . . . . . . . . . . 367
Start Print . . . . . . . . . . . . . . . . . . . . . . . . . . . . 342
Start ZBI (Zebra BASIC Interpreter) . . . . . . . 253
Start ZBI (Zebra BASIC Interpreter) . . . . . . . . 255
Suppress Backfeed . . . . . . . . . . . . . . . . . . . . 368
Tear-off Adjust Position . . . . . . . . . . . . . . . . . 353
Terminate Zebra BASIC Interpreter . . . . . . . 263
Text Blocks . . . . . . . . . . . . . . . . . . . . . . . . . . . 354
TLC39 Bar Code . . . . . . . . . . . . . . . . . . . . . . . 130
Transfer Object . . . . . . . . . . . . . . . . . . . . . . . 355
UPC/EAN Extensions . . . . . . . . . . . . . . . . . . 127
UPC-A Bar Code . . . . . . . . . . . . . . . . . . . . . . 132
UPC-E Bar Code . . . . . . . . . . . . . . . . . . . . . . . 74
Upload Graphics . . . . . . . . . . . . . . . . . . . . . . 233
UPS MaxiCode Bar Code . . . . . . . . . . . . . . . . 96
Use Font Name to Call Font . . . . . . . . . . . . . . 51
Verify RFID Encoding Operation . . . . . . . . . . 422
Write (Encode) Tag . . . . . . . . . . . . . . . . . . . . 420
Write Query . . . . . . . . . . . . . . . . . . . . . . . . . . 360

6/8/10 Zebra Programming Guide P1012728-004 Rev. A

24 Functional List of ZPL Commands

Notes • ___________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

P1012728-004 Rev. A Zebra Programming Guide 6/8/10

 Alphabetical List
of ZBI Commands

! (EXCLAMATION MARK) . . . . . . . . . . . . . . . 460 IF Statements . . . . . . . . . . . . . . . . . . . . . . . . . 493

ACCEPT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 508 INBYTE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 514
ADDBREAK . . . . . . . . . . . . . . . . . . . . . . . . . . 475 INPUT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 510
AUTONUM . . . . . . . . . . . . . . . . . . . . . . . . . . . 462 INSERTROW . . . . . . . . . . . . . . . . . . . . . . . . . 591
AUXPORT_GETPIN . . . . . . . . . . . . . . . . . . . . 561 INTTOHEX$ . . . . . . . . . . . . . . . . . . . . . . . . . . 586
AUXPORT_RELEASEPIN . . . . . . . . . . . . . . . 562 ISERROR . . . . . . . . . . . . . . . . . . . . . . . . . . . . 551
AUXPORT_SETPIN . . . . . . . . . . . . . . . . . . . . 560 ISWARNING . . . . . . . . . . . . . . . . . . . . . . . . . . 552
AUXPORT_STEALPIN . . . . . . . . . . . . . . . . . . 558 LCASE$ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 564
BREAK . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 474 LEN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 578
CHR$ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 565 LET . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 484
CLIENTSOCKET . . . . . . . . . . . . . . . . . . . . . . 507 LIST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 461
CLOSE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 503 LOAD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 530
CLRERR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 555 LTRIM$ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 566
COLUMNSIZE . . . . . . . . . . . . . . . . . . . . . . . . 594 MAX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 581
CSVLOAD . . . . . . . . . . . . . . . . . . . . . . . . . . . 534 MAXNUM . . . . . . . . . . . . . . . . . . . . . . . . . . . . 583
CSVSTORE . . . . . . . . . . . . . . . . . . . . . . . . . . 536 MIN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 582
CTRL-C . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 468 MOD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 584
DATAREADY . . . . . . . . . . . . . . . . . . . . . . . . . 504 NEW . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 458
DATE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 600 ON ERROR . . . . . . . . . . . . . . . . . . . . . . . . . . . 556
DATE$ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 598 OPEN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 502
DEBUG . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 472 ORD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 576
DELBREAK . . . . . . . . . . . . . . . . . . . . . . . . . . 476 OUTBYTE . . . . . . . . . . . . . . . . . . . . . . . . . . . . 513
DELETE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 532 POS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 577
DELROW . . . . . . . . . . . . . . . . . . . . . . . . . . . . 592 PRINT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 512
DIR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 531 READ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 515
DO Loops . . . . . . . . . . . . . . . . . . . . . . . . . . . . 494 REDIM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 589
ECHO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 464 REGISTEREVENT . . . . . . . . . . . . . . . . . . . . . 544
END . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 499 REM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 459
EXIT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 498 RENUM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 463
EXTRACT$ . . . . . . . . . . . . . . . . . . . . . . . . . . . 574 REPEAT$ . . . . . . . . . . . . . . . . . . . . . . . . . . . . 567
FIND . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 595 RESTART . . . . . . . . . . . . . . . . . . . . . . . . . . . . 469
FOR Loops . . . . . . . . . . . . . . . . . . . . . . . . . . . 495 ROWSIZE . . . . . . . . . . . . . . . . . . . . . . . . . . . . 593
GETVAR$ . . . . . . . . . . . . . . . . . . . . . . . . . . . . 604 RTRIM$ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 568
GOTO/GOSUB . . . . . . . . . . . . . . . . . . . . . . . . 496 RUN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 467
HANDLEEVENT . . . . . . . . . . . . . . . . . . . . . . . 547 SEARCHTO$ . . . . . . . . . . . . . . . . . . . . . . . . . 517
HEXTOINT . . . . . . . . . . . . . . . . . . . . . . . . . . . 587 SERVERCLOSE . . . . . . . . . . . . . . . . . . . . . . . 506

6/8/10 Zebra Programming Guide P1012728-004 Rev. A

26 Alphabetical List of ZBI Commands

SERVERSOCKET . . . . . . . . . . . . . . . . . . . . . 505
SETERR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 554
SETVAR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 603
SLEEP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 553
SPLIT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 569
SPLITCOUNT . . . . . . . . . . . . . . . . . . . . . . . . . 572
STEP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 471
STORE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 529
STR$ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 580
SUB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 497
TIME . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 601
TIME$ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 599
TRACE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 473
TRIGGEREVENT . . . . . . . . . . . . . . . . . . . . . . 549
TXTLOAD . . . . . . . . . . . . . . . . . . . . . . . . . . . . 537
TXTSTORE . . . . . . . . . . . . . . . . . . . . . . . . . . 538
UCASE$ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 573
UNREGISTEREVENT . . . . . . . . . . . . . . . . . . 546
VAL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 585
WRITE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 516
ZPL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 478

P1012728-004 Rev. A Zebra Programming Guide 6/8/10

 Alphabetical List
of Set/Get/Do Commands

appl.bootblock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 632 display.text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 656

appl.name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 633 external_wired.check . . . . . . . . . . . . . . . . . . . . . . . . . . 733
appl.option_board_version . . . . . . . . . . . . . . . . . . . . . . 631 external_wired.ip.addr . . . . . . . . . . . . . . . . . . . . . . . . . . 734
bluetooth.address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 786 external_wired.ip.arp_interval . . . . . . . . . . . . . . . . . . . . 735
bluetooth.afh_map . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 787 external_wired.ip.default_addr_enable . . . . . . . . . . . . . 736
bluetooth.afh_map_curr . . . . . . . . . . . . . . . . . . . . . . . . . 788 external_wired.ip.dhcp.cid_all . . . . . . . . . . . . . . . . . . . . 737
bluetooth.afh_mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . 789 external_wired.ip.dhcp.cid_enable . . . . . . . . . . . . . . . . 738
bluetooth.authentication . . . . . . . . . . . . . . . . . . . . . . . . . 790 external_wired.ip.dhcp.cid_prefix . . . . . . . . . . . . . . . . . 739
bluetooth.bluetooth_pin . . . . . . . . . . . . . . . . . . . . . . . . . 791 external_wired.ip.dhcp.cid_suffix . . . . . . . . . . . . . . . . . 740
bluetooth.date . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 792 external_wired.ip.dhcp.cid_type . . . . . . . . . . . . . . . . . . 741
bluetooth.discoverable . . . . . . . . . . . . . . . . . . . . . . . . . . 793 external_wired.ip.gateway . . . . . . . . . . . . . . . . . . . . . . . 742
bluetooth.enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 794 external_wired.ip.netmask . . . . . . . . . . . . . . . . . . . . . . 743
bluetooth.friendly_name . . . . . . . . . . . . . . . . . . . . . . . . . 795 external_wired.ip.port . . . . . . . . . . . . . . . . . . . . . . . . . . 744
bluetooth.local_name . . . . . . . . . . . . . . . . . . . . . . . . . . . 796 external_wired.ip.protocol . . . . . . . . . . . . . . . . . . . . . . 745
bluetooth.radio_auto_baud . . . . . . . . . . . . . . . . . . . . . . 797 external_wired.ip.timeout.enable . . . . . . . . . . . . . . . . . 746
bluetooth.radio_version . . . . . . . . . . . . . . . . . . . . . . . . . 798 external_wired.ip.timeout.value . . . . . . . . . . . . . . . . . . . 747
bluetooth.short_address . . . . . . . . . . . . . . . . . . . . . . . . 799 external_wired.ip.v6.addr . . . . . . . . . . . . . . . . . . . . . . . 748
bluetooth.version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 800 external_wired.ip.v6.gateway . . . . . . . . . . . . . . . . . . . . 749
card.inserted . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 802 external_wired.ip.v6.prefix_length . . . . . . . . . . . . . . . . . 750
card.mac_addr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 801 external_wired.mac_addr . . . . . . . . . . . . . . . . . . . . . . . 751
CISDFCRC16 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 634 external_wired.mac_raw . . . . . . . . . . . . . . . . . . . . . . . . 752
comm.type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 803 file.delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 657
cutter.clean_cutter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 636 file.dir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 658
device.download_connection_timeout . . . . . . . . . . . . . . 637 file.run . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 660
device.epl_legacy_mode . . . . . . . . . . . . . . . . . . . . . . . . 638 file.type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 659
device.friendly_name . . . . . . . . . . . . . . . . . . . . . . . . . . . 640 head.latch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 661
device.frontpanel.key_press . . . . . . . . . . . . . . . . . . . . . 641 interface.network.active.gateway . . . . . . . . . . . . . . . . . 662
device.frontpanel.line1 . . . . . . . . . . . . . . . . . . . . . . . . . . 642 interface.network.active.ip_addr . . . . . . . . . . . . . . . . . . 663
device.frontpanel.line2 . . . . . . . . . . . . . . . . . . . . . . . . . . 643 interface.network.active.mac_addr . . . . . . . . . . . . . . . . 664
device.frontpanel.xml . . . . . . . . . . . . . . . . . . . . . . . . . . . 644 interface.network.active.mac_raw . . . . . . . . . . . . . . . . . 665
device.jobs_print . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 645 interface.network.active.netmask . . . . . . . . . . . . . . . . . 666
device.languages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 646 interface.network.active.protocol . . . . . . . . . . . . . . . . . . 667
device.orientation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 647 internal_wired.auto_switchover . . . . . . . . . . . . . . . . . . 753
device.pnp_option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 648 internal_wired.ip.addr . . . . . . . . . . . . . . . . . . . . . . . . . . 754
device.reset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 649 internal_wired.ip.arp_interval . . . . . . . . . . . . . . . . . . . . 755
device.restore_defaults . . . . . . . . . . . . . . . . . . . . . . . . . 650 internal_wired.ip.default_addr_enable . . . . . . . . . . . . . 756
device.unique_id . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 651 internal_wired.ip.dhcp.cache_ip . . . . . . . . . . . . . . . . . . 757
device.uptime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 652 internal_wired.ip.dhcp.cid_all . . . . . . . . . . . . . . . . . . . . 758
device.user_p1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 653 internal_wired.ip.dhcp.cid_enable . . . . . . . . . . . . . . . . . 759
device.user_p2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 654 internal_wired.ip.dhcp.cid_prefix . . . . . . . . . . . . . . . . . . 760
device.xml.enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 655 internal_wired.ip.dhcp.cid_suffix . . . . . . . . . . . . . . . . . . 761

6/8/10 Zebra Programming Guide P1012728-004 Rev. A

28 Alphabetical List of Set/Get/Do Commands

internal_wired.ip.dhcp.cid_type . . . . . . . . . . . . . . . . . . . 762 ip.mirror.server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 847

internal_wired.ip.dhcp.lease.last_attempt . . . . . . . . . . . 763 ip.mirror.success . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 848
internal_wired.ip.dhcp.lease.length . . . . . . . . . . . . . . . . 764 ip.mirror.success_time . . . . . . . . . . . . . . . . . . . . . . . . . 849
internal_wired.ip.dhcp.lease.server . . . . . . . . . . . . . . . . 765 ip.mirror.username . . . . . . . . . . . . . . . . . . . . . . . . . . . . 850
internal_wired.ip.dhcp.lease.time_left . . . . . . . . . . . . . . 766 ip.mirror.version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 851
internal_wired.ip.dhcp.option12 . . . . . . . . . . . . . . . . . . 767 ip.netmask . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 852
internal_wired.ip.dhcp.option12_format . . . . . . . . . . . . 768 ip.pop3.enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 853
internal_wired.ip.dhcp.option12_value . . . . . . . . . . . . . 769 ip.pop3.password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 854
internal_wired.ip.dhcp.request_timeout . . . . . . . . . . . . 770 ip.pop3.poll . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 855
internal_wired.ip.dhcp.requests_per_session . . . . . . . . 771 ip.pop3.server_addr . . . . . . . . . . . . . . . . . . . . . . . . . . . 856
internal_wired.ip.dhcp.session_interval . . . . . . . . . . . . 772 ip.pop3.username . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 857
internal_wired.ip.gateway . . . . . . . . . . . . . . . . . . . . . . . 773 ip.port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 858
internal_wired.ip.netmask . . . . . . . . . . . . . . . . . . . . . . . 774 ip.primary_network . . . . . . . . . . . . . . . . . . . . . . . . . . . . 859
internal_wired.ip.port . . . . . . . . . . . . . . . . . . . . . . . . . . . 775 ip.smtp.domain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 860
internal_wired.ip.protocol . . . . . . . . . . . . . . . . . . . . . . . 776 ip.smtp.enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 861
internal_wired.ip.timeout.enable . . . . . . . . . . . . . . . . . . 777 ip.smtp.server_addr . . . . . . . . . . . . . . . . . . . . . . . . . . . 862
internal_wired.ip.timeout.value . . . . . . . . . . . . . . . . . . . 778 ip.snmp.enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 865
internal_wired.mac_addr . . . . . . . . . . . . . . . . . . . . . . . . 779 ip.snmp.get_community_name . . . . . . . . . . . . . . . . . . . 863
internal_wired.mac_raw . . . . . . . . . . . . . . . . . . . . . . . . . 780 ip.snmp.set_community_name . . . . . . . . . . . . . . . . . . . 864
ip.active_network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 804 ip.tcp.enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 867
ip.addr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 805 ip.telnet.enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 866
ip.arp_interval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 806 ip.udp.enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 868
ip.bootp.enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 807 media.cartridge.part_number . . . . . . . . . . . . . . . . . . . . 668
ip.dhcp.cache_ip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 808 media.cut_now . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 669
ip.dhcp.cid_all . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 809 media.darkness_mode . . . . . . . . . . . . . . . . . . . . . . . . . 670
ip.dhcp.cid_enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 810 media.media_low.external . . . . . . . . . . . . . . . . . . . . . . 671
ip.dhcp.cid_prefix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 811 media.media_low.warning . . . . . . . . . . . . . . . . . . . . . . . 672
ip.dhcp.cid_suffix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 812 media.present.cut_amount . . . . . . . . . . . . . . . . . . . . . . 673
ip.dhcp.cid_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 814 media.present.cut_margin . . . . . . . . . . . . . . . . . . . . . . . 678
ip.dhcp.enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 815 media.present.eject . . . . . . . . . . . . . . . . . . . . . . . . . . . . 674
ip.dhcp.lease.last_attempt . . . . . . . . . . . . . . . . . . . . . . . 816 media.present.length_addition . . . . . . . . . . . . . . . . . . . 675
ip.dhcp.lease.length . . . . . . . . . . . . . . . . . . . . . . . . . . . . 813 media.present.loop_length . . . . . . . . . . . . . . . . . . . . . . 676
ip.dhcp.lease.server . . . . . . . . . . . . . . . . . . . . . . . . . . . . 817 media.present.loop_length_max . . . . . . . . . . . . . . . . . . 677
ip.dhcp.lease.time_left . . . . . . . . . . . . . . . . . . . . . . . . . . 818 media.present.present_timeout . . . . . . . . . . . . . . . . . . . 679
ip.dhcp.option12 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 819 media.present.present_type . . . . . . . . . . . . . . . . . . . . . 680
ip.dhcp.option12_format . . . . . . . . . . . . . . . . . . . . . . . . 820 media.printmode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 681
ip.dhcp.option12_value . . . . . . . . . . . . . . . . . . . . . . . . . 821 media.speed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 683
ip.dhcp.request_timeout . . . . . . . . . . . . . . . . . . . . . . . . . 822 odometer.headclean . . . . . . . . . . . . . . . . . . . . . . . . . . 684
ip.dhcp.requests_per_session . . . . . . . . . . . . . . . . . . . . 823 odometer.headnew . . . . . . . . . . . . . . . . . . . . . . . . . . . 685
ip.dhcp.session_interval . . . . . . . . . . . . . . . . . . . . . . . . . 824 odometer.label_dot_length . . . . . . . . . . . . . . . . . . . . . . 686
ip.dns.domain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 825 odometer.media_marker_count1 . . . . . . . . . . . . . . . . . 687
ip.dns.servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 826 odometer.media_marker_count2 . . . . . . . . . . . . . . . . . 688
ip.ftp.enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 827 odometer.retracts_count . . . . . . . . . . . . . . . . . . . . . . . . 689
ip.ftp.execute_file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 828 odometer.rfid.valid_resettable . . . . . . . . . . . . . . . . . . . . 690
ip.gateway . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 829 odometer.rfid.void_resettable . . . . . . . . . . . . . . . . . . . . 691
ip.http.enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 830 odometer.total_print_length . . . . . . . . . . . . . . . . . . . . . 692
ip.lpd.enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 831 print.tone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 693
ip.mac_raw . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 832 rfid.error.response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 694
ip.mirror.auto . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 833 rfid.position.program . . . . . . . . . . . . . . . . . . . . . . . . . . . 695
ip.mirror.error_retry . . . . . . . . . . . . . . . . . . . . . . . . . . . . 834 rfid.reader_1.antenna_port . . . . . . . . . . . . . . . . . . . . . . 697
ip.mirror.feedback.auto . . . . . . . . . . . . . . . . . . . . . . . . . 835 rfid.reader_1.power.read . . . . . . . . . . . . . . . . . . . . . . . . 699
ip.mirror.feedback.freq . . . . . . . . . . . . . . . . . . . . . . . . . 836 rfid.reader_1.power.single_power . . . . . . . . . . . . . . . . . 700
ip.mirror.feedback.odometer . . . . . . . . . . . . . . . . . . . . . 837 rfid.reader_1.power.write . . . . . . . . . . . . . . . . . . . . . . . 701
ip.mirror.feedback.path . . . . . . . . . . . . . . . . . . . . . . . . . 838 rfid.tag.calibrate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 703
ip.mirror.fetch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 839 rfid.tag.data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 704
ip.mirror.freq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 840 rfid.tag.test . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 705
ip.mirror.freq_hours . . . . . . . . . . . . . . . . . . . . . . . . . . . . 841 rfid.tag.type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 706
ip.mirror.last_error . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 842 wlan.adhocautomode . . . . . . . . . . . . . . . . . . . . . . . . . . 869
ip.mirror.last_time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 843 wlan.adhocchannel . . . . . . . . . . . . . . . . . . . . . . . . . . . . 870
ip.mirror.password . . . . . . . . . . . . . . . . . . . . . . . . . . . . 844 wlan.associated . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 871
ip.mirror.path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 845 wlan.bssid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 872
ip.mirror.reset_delay . . . . . . . . . . . . . . . . . . . . . . . . . . . 846 wlan.channel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 873

P1012728-004 Rev. A Zebra Programming Guide 6/8/10

 Alphabetical List of Set/Get/Do Commands 29

wlan.channel_mask . . . . . . . . . . . . . . . . . . . . . . . . . . . . 874 zbi.control.break . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 710

wlan.current_tx_rate . . . . . . . . . . . . . . . . . . . . . . . . . . . 875 zbi.control.clear_breakpoints . . . . . . . . . . . . . . . . . . . . 711
wlan.essid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 876 zbi.control.delete_breakpoint . . . . . . . . . . . . . . . . . . . . 712
wlan.firmware_version . . . . . . . . . . . . . . . . . . . . . . . . . . 877 zbi.control.line_number . . . . . . . . . . . . . . . . . . . . . . . . . 713
wlan.ip.addr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 878 zbi.control.restart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 714
wlan.ip.arp_interval . . . . . . . . . . . . . . . . . . . . . . . . . . . . 879 zbi.control.run . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 715
wlan.ip.default_addr_enable . . . . . . . . . . . . . . . . . . . . . 880 zbi.control.step . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 716
wlan.ip.dhcp.cache_ip . . . . . . . . . . . . . . . . . . . . . . . . . . 881 zbi.control.terminate . . . . . . . . . . . . . . . . . . . . . . . . . . . 717
wlan.ip.dhcp.cid_all . . . . . . . . . . . . . . . . . . . . . . . . . . . . 882 zbi.control.variable_name . . . . . . . . . . . . . . . . . . . . . . . 718
wlan.ip.dhcp.cid_enable . . . . . . . . . . . . . . . . . . . . . . . . . 883 zbi.control.variable_value . . . . . . . . . . . . . . . . . . . . . . . 719
wlan.ip.dhcp.cid_prefix . . . . . . . . . . . . . . . . . . . . . . . . . . 884 zbi.key . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 720
wlan.ip.dhcp.cid_suffix . . . . . . . . . . . . . . . . . . . . . . . . . . 885 zbi.last_error . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 721
wlan.ip.dhcp.cid_type . . . . . . . . . . . . . . . . . . . . . . . . . . . 886 zbi.reseller_key . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 722
wlan.ip.dhcp.lease.last_attempt . . . . . . . . . . . . . . . . . . . 887 zbi.revision . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 723
wlan.ip.dhcp.lease.length . . . . . . . . . . . . . . . . . . . . . . . . 888 zbi.running_program_name . . . . . . . . . . . . . . . . . . . . . 724
wlan.ip.dhcp.lease.server . . . . . . . . . . . . . . . . . . . . . . . 889 zbi.start_info.execute . . . . . . . . . . . . . . . . . . . . . . . . . . 725
wlan.ip.dhcp.lease.time_left . . . . . . . . . . . . . . . . . . . . . . 890 zbi.start_info.file_name . . . . . . . . . . . . . . . . . . . . . . . . . 726
wlan.ip.dhcp.option12 . . . . . . . . . . . . . . . . . . . . . . . . . . 891 zbi.start_info.memory_alloc . . . . . . . . . . . . . . . . . . . . . 727
wlan.ip.dhcp.option12_format . . . . . . . . . . . . . . . . . . . . 892 zbi.state . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 728
wlan.ip.dhcp.option12_value . . . . . . . . . . . . . . . . . . . . . 893
wlan.ip.dhcp.request_timeout . . . . . . . . . . . . . . . . . . . . 894
wlan.ip.dhcp.requests_per_session . . . . . . . . . . . . . . . . 895
wlan.ip.dhcp.session_interval . . . . . . . . . . . . . . . . . . . . 896
wlan.ip.gateway . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 897
wlan.ip.netmask . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 898
wlan.ip.port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 899
wlan.ip.protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 900
wlan.ip.timeout.enable . . . . . . . . . . . . . . . . . . . . . . . . . . 901
wlan.ip.timeout.value . . . . . . . . . . . . . . . . . . . . . . . . . . . 902
wlan.keep_alive.enable . . . . . . . . . . . . . . . . . . . . . . . . . 903
wlan.keep_alive.timeout . . . . . . . . . . . . . . . . . . . . . . . . . 904
wlan.kerberos.kdc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 905
wlan.kerberos.password . . . . . . . . . . . . . . . . . . . . . . . . 906
wlan.kerberos.realm . . . . . . . . . . . . . . . . . . . . . . . . . . . . 907
wlan.kerberos.username . . . . . . . . . . . . . . . . . . . . . . . . 908
wlan.mac_addr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 909
wlan.mac_raw . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 910
wlan.operating_mode . . . . . . . . . . . . . . . . . . . . . . . . . . . 911
wlan.password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 912
wlan.preamble . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 913
wlan.private_key_password . . . . . . . . . . . . . . . . . . . . . . 914
wlan.roam.interchannel_delay . . . . . . . . . . . . . . . . . . . . 915
wlan.roam.interval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 916
wlan.roam.max_chan_scan_time . . . . . . . . . . . . . . . . . 917
wlan.roam.signal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 918
wlan.security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 919
wlan.signal_noise . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 927
wlan.signal_quality . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 928
wlan.signal_strength . . . . . . . . . . . . . . . . . . . . . . . . . . . 929
wlan.station_name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 930
wlan.tx_power . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 931
wlan.tx_rate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 932
wlan.username . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 933
wlan.wep.auth_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . 934
wlan.wep.index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 935
wlan.wep.key_format . . . . . . . . . . . . . . . . . . . . . . . . . . . 941
wlan.wep.key1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 936
wlan.wep.key2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 937
wlan.wep.key3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 938
wlan.wep.key4 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 939
wlan.wpa.psk . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 940
zbi.control.add_breakpoint . . . . . . . . . . . . . . . . . . . . . . . 709

6/8/10 Zebra Programming Guide P1012728-004 Rev. A

30 Alphabetical List of Set/Get/Do Commands

Notes • ____________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

P1012728-004 Rev. A Zebra Programming Guide 6/8/10

 1
About This Document

This section provides an overview of the entire document, contact information, and details on
document structure and organization.

Contents
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Who Should Use This Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
How This Document Is Organized . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Contacts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Document Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

6/8/10 Zebra Programming Guide P1012728-004

32 About This Document
Introduction

Introduction
This guide is the unabridged, alphabetical reference of programming commands supported in
the firmware. This includes all ZPL commands and SGD commands.

Important • These are important points to note when using ZPL and SGD commands:
• ZPL and SGD commands should be sent to the printer as separate files.
• Certain settings can be controlled by both ZPL and SGD. Configuration changes made in
ZPL can affect configuration changes made in SGD.

Firmware You can get the printer’s firmware version by printing out a configuration label.
For instructions to do so, see your printer’s user guide.

Note • For firmware upgrades go to: www.zebra.com.

Important • These are important points to note when using a Zebra G-Series printer:
• You can send instructions to the printer using multiple programming languages: EPL,
ZPL, or SGD. EPL and ZPL commands configure the printer, print labels, and get device
status information. SGD commands set and get configuration details. These three
languages can be used without the need to send the printer instructions to switch from one
language to another.
• EPL, ZPL, and SGD commands must be sent to the printer as separate files. They cannot
be used together in one format, or set of commands. For example, if you send a series of
SGD commands to the printer and they are followed by a printable format, this needs to
be done using separate files.

Many text editors and word processors can recreate most examples in this guide in ASCII
format. However, for other encodings such as Unicode, a text editor such as Microsoft
Notepad is needed.

If there are any terms used in this guide that you need clarification on, please see the Glossary
on page 1089.

P1012728-004 Zebra Programming Guide 6/8/10

 About This Document 33
Who Should Use This Document

Who Should Use This Document

This Programming Guide is for programmers who are familiar working with programming
languages.

How This Document Is Organized

The Programming Guide is set up as follows:

Section Description
About This Document Provides a high-level overview about this guide
and Zebra Programming Language (ZPL).
ZPL Commands Provides an alphabetical, detailed description of
each ZPL command.
ZPL RFID Commands Provides an alphabetical, detailed description of
each ZPL RFID command, and some examples of
how to use them.
ZPL Wireless Commands Provides new and modified ZPL commands for the
wireless print server.
ZBI Commands Provides details about the Zebra Basic Interpreter,
its commands, descriptions, formats, and
parameters.
SGD Printer Commands Provides a high-level overview of printer setting
Set / Get / Do (SGD) commands.
SGD Wired Commands Provides a high-level overview of the wired
Set / Get / Do (SGD) commands.
SGD Wireless Commands Provides a high-level overview of the wireless
Set / Get / Do (SGD) commands.
Appendixes The appendixes include:
Zebra Code Pages
ASCII
Fonts and Bar Codes
Mod 10 and Mod 43 Check Digits
Error Detection Protocol
ZB64 Encoding and Compression
Field Interactions
Real Time Clock
ZBI Character Set
SGD Command Support
Mirror
Wireless Markup Language (WML)
Firmware Features
Glossary Glossary of terms.

6/8/10 Zebra Programming Guide P1012728-004

34 About This Document
Contacts

Contacts
Technical Support via the Internet is available 24 hours per day, 365 days per year.

Web Site: www.zebra.com

E-mail Back Technical Library:
E-mail address: [email protected]
Subject line: Emaillist
Self Service Knowledge Base: www.zebra.com/knowledgebase
Online Case Registration: www.zebra.com/techrequest

Which Department Europe, Middle East, Asia Pacific

The Americas
Do You Need? and Africa and India

Regional Headquarters Zebra Technologies Corporation Zebra Technologies Europe Limited Zebra Technologies Asia Pacific
475 Half Day Road, Suite 500 Dukes Meadow Pte. Ltd.
Lincolnshire, IL 60069 USA Millboard Road 120 Robinson Road
T: +1 847 634 6700 Bourne End #06-01 Parakou Building
Toll-free +1 866 230 9494 Buckinghamshire, SL8 5XF Singapore 068913
F: +1 847 913 8766 United Kingdom T: + 65 6858 0722
T: +44 (0) 1628 556000 F: +65 6885 0838
F: +44 (0) 1628 556001
Technical Support T: +1 877 ASK ZEBRA (275 9327) T: +44 (0) 1628 556039 T: +65 6858 0722
For questions on the F: +1 847 913 2578 F: +44 (0) 1628 556003 F: +65 6885 0838
operation of Zebra Hardware: [email protected] E: [email protected] E: China: [email protected]
equipment and software, Software: [email protected] All other areas:
please call your distributor. Kiosk printers: [email protected]
For additional assistance, T: +1 866 322 5202
contact us. E: [email protected]
Please have your model and
serial numbers available.

Repair Service T: +1 877 ASK ZEBRA (275 9327) T: +44 (0) 1772 693069 T: +65 6858 0722
Department F: +1 847 821 1797 F: +44 (0) 1772 693046 F: +65 6885 0838
For back-to-base service and E: [email protected] New requests: [email protected] E: China: [email protected]
repair. To request a repair in the U.S., Status updates: All other areas:
go to www.zebra.com/repair. [email protected] [email protected]

Technical Training T: +1 847 793 6868 T: +44 (0) 1628 556000 T: + 65 6858 0722
Department T: +1 847 793 6864 F: +44 (0) 1628 556001 F: +65 6885 0838
For Zebra product training F: +1 847 913 2578 E: [email protected] E: China: [email protected]
courses. E: [email protected] All other areas:
[email protected]
Inquiry Department T: +1 877 ASK ZEBRA (275 9327) T: +44 (0) 1628 556037 E: China: [email protected]
For product literature and E: [email protected] F: +44 (0) 1628 556005 All other areas:
distributor and dealer E: [email protected] [email protected]
information.

Customer Service T: +1 877 ASK ZEBRA (275 9327) T: +44 (0) 1628 556032 T: +65 6858 0722
Department (US) E: [email protected] F: +44 (0) 1628 556001 F: +65 6885 0836
Internal Sales E: [email protected] E: China: [email protected]
Department (UK) All other areas:
For printers, parts, media, [email protected]
and ribbon, please call your
distributor or contact us.
Key: T: Telephone
F: Facsimile
E: E-mail

P1012728-004 Rev. A Zebra Programming Guide 6/8/10

 About This Document 35
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.

Command Line Examples Command line examples appear in Courier New font. For
example, type ZTools to get to the Post-Install scripts in the bin directory.

Files and Directories File names and directories appear in Courier New font. For
example, the Zebra<version number>.tar file and the /root directory.

Icons Used

Identifies features that are available in printers with firmware version Vx.17.x or later.

Identifies features that are available in printers with firmware version V60.16, V53.16, or
later.

Identifies features that are available in printers with firmware version V60.15.x, V50.15.x, or
later.

Identifies features that are available in printers with firmware version V60.14, V50.14, or
later.

Identifies features that are available in printers with firmware version V60.13.x, V50.13.x, or
earlier.

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.

6/8/10 Zebra Programming Guide P1012728-004

36 About This Document
Document Conventions

Illustration Callouts Callouts are used when an illustration contains information that needs
to be labeled and described. A table that contains the labels and descriptions follows the
graphic. Figure 1 provides an example.

Figure 1 • Sample Figure with Callouts

1 2

ZPL II CODE CODE 49 BAR CODE

^XA
^FO150,100^BY3
^B4N,20,A,A
^FD12345ABCDE^FS
^XZ

1 ZPL Code
2 Generated Label

P1012728-004 Zebra Programming Guide 6/8/10

 2
ZPL Commands

This section contains the complete alphabetical listing of ZPL II commands.

Description This heading provides an explanation of how the command is used, what it is
capable of, and any defining characteristics it has.

Format Format explains how the command is syntactically arranged and what parameters it
contains. For example, the ^B8 command prints a EAN-8 bar code. The format of the ^B8
command is: ^B8o,h,f,g. It is arranged with the caret symbol (^), the command code
(B8), and the parameters and are replaced with supported values.

Parameters If a command has values that can be defined to make its function more specific,
these are outlined as parameters. Parameters typically have Accepted Values and Default
Values.

Still using the ^B8 example, the h parameter is defined as:

h = bar code height (in dots)

Accepted Values: 1 to 32000
Default Value: value set by ^BY

If the command has no parameters – for example ~JA (Cancel All) – the parameter heading is
removed, indicating that the format of the command (~JA) is acceptable ZPL II code.

6/8/10 Zebra Programming Guide P1012728-004

38 ZPL Commands

Example • When the command is best clarified in context, an example of the

ZPL II code is provided. Text indicating exact code entered is printed in an easily
recognizable Courier font. An example of code using the ^B8 command looks like this:
^XA
^FO50,50
^B8N,100,Y,N
^FD1234567^FS
^XZ
Notice that the ^B8 parameter letters have been replaced with real values that apply to the
command. In this example N,100,Y,N have been entered.

Comment This section is reserved for notes that are of value to a programmer, warnings of
potential command interactions, or command-specific information that should be taken into
consideration.

Example • An example comment is: This command works only when the printer is idle,
or This command is ignored if a value exceeds the parameter limits.
Comments are also included next to parameters if they apply directly to a particular setting.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 39
Basic ZPL Exercises and Examples

Basic ZPL Exercises and Examples

The purpose of these exercises is to introduce basic ZPL commands to novice ZPL users.

Make sure this checklist is complete:

 Load the printer with labels that are big enough to give you ample space to work with.
 Print a configuration label (CANCEL test).
 Look at the configuration label and make sure that the LEFT POSITION is set to
000 and LABEL TOP is set to 000.
 Determine the printer’s resolution. It is listed on the configuration label. 8/MM =
200 dpi, 12/MM = 300 dpi and 24/MM = 600 dpi.

Tips

These are some tips when using ZPL:

• Use the DOS text editor to write ZPL files.
• Save the file as a .txt file and copy it to the printer from DOS command line.

Before you begin

Some things that are important to understand before you begin are:
• 200 dpi means the resolution of the printhead is 200 dots per inch. If you program the
printer to draw a line 100 dots long that equals a half inch. 100 dots on a
300 dpi printer prints a line 1/3 inch long.
• The home position that all your coordinates are referencing is at the left-hand trailing edge
of the label as the label comes out of the printer. (There are some exceptions to this.)

6/8/10 Zebra Programming Guide P1012728-004

40 ZPL Commands
Basic ZPL Exercises and Examples

Exercises
The exercises start simple and gradually progress to give you an opportunity to try a variety of
commonly used ZPL commands. Not all commands are covered, but this should be a good
core of commands to learn. Some commands may not be supported due to the firmware
version in your printer.

Exercise 1 • This exercise shows you how to specify a location for an entered name.

1. Print your name on the label.

2. Start by printing just your name on the label. Use this format as a model:

Important • Your name goes where you see xxxxxxxxxxx in the second line of code.

3. Send this format to the printer:

1 ^XA
2 ^FO50,50^ADN,36,20^FDxxxxxxxxxxx
3 ^FS
4 ^XZ

1 Every format starts with the ^XA command

2 ^FO (field origin) command
3 ^FS (field separator) command
4 Every format ends with the ^XZ command
5 ^FD (field data) command

4. When the label prints correctly, alter the first number after the ^FOx. See how that
change affects the print position. Alter the second number after the ^FO50,x and see
how that the print position.

Font instruction

^ADN

1. Alter the numbers after the ^ADN,x,x command.

• 18,10 is the smallest size you can make the D font.
• The first number is the height of the font in dots. The second number is the width in
dots.
• You can use direct multiples up to ten times that size as a maximum.

Example • 180,100 is the largest you can make the D font.

• 25,18 would not be a valid size. The printer rounds to the next recognizable size.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 41
Basic ZPL Exercises and Examples

2. Check the font matrices tables for other fonts to try. See Fonts and Bar Codes
on page 959.

3. Try the zero scalable font ^A0N,x,x.

This font is scalable, and you can choose any height and width.

Rotation commands

1. Change ^ADN to ^ADR, and then ^ADI, and then ^ADB.

See how the print position changes.

2. Add more fields.

3. Add two more fields to print directly under your name using the ^ADN,36,20 font and
size:
Your street address
Your city, state, zip

4. You must add two more lines of code that start off with:
^XA
^FO50,50^ADN,36,20^FDxxxxxxxxxxx^FS
^FO (fill in the rest)
^FO (fill in the rest)
^XZ

Make sure all these fields print in the same font and size and left side of fields has same
vertical alignment.
Your name
1200 W Main Street
Anytown, Il 60061

6/8/10 Zebra Programming Guide P1012728-004

42 ZPL Commands
Basic ZPL Exercises and Examples

Special Effects commands

The Graphic Box or ^GB command or is used in some of the speical effects commands.

Reverse Printing a Field

1. Write the following format and send to the printer:

^XA
^PR1
^FO100,100
^GB70,70,70,,3^FS
^FO200,100
^GB70,70,70,,3^FS
^FO300,100
^GB70,70,70,,3^FS
^FO400,100
^GB70,70,70,,3^FS
^FO107,110^CF0,70,93
^FR^FDREVERSE^FS
^XZ

2. To see the effects, remove:

^FR^FDREVERSE^FS

3. To see the effects, try removing one of the ^GB lines of code.

Label Reverse Print

1. Write the following format and send to the printer:

^XA^LRY
^FO100,50
^GB195,203,195^FS
^FO180,110^CFG
^FDLABEL^FS
^FO130,170
^FDREVERSE^FS
^XZ

2. To see the effects, remove:

^GB195,203,195^FS

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 43
Basic ZPL Exercises and Examples

Mirror Image of Label

1. Write the following format and send to the printer:

^XA^PMY
^FO100,100
^CFG
^FDMIRROR^FS
^FO100,160
^FDIMAGE^FS
^XZ

2. To see the effects, in the first line of code change ^PMY to ^PMN.

Print Orientation

1. Write the following format and send to the printer:

^XA^CFD
^POI
^LH330,10
^FO50,50
^FDZEBRA TECHNOLOGIES^FS
^FO50,75
^FDVernon Hills, IL^FS
^XZ

2. To see the effects, in the second line of code change ^POI to ^PON.

Exercise 2 • Boxes and lines

1. Use the address format from Exercise 1.

2. Add this new line to your existing format:

^FO50,200^GB200,200,2^FS
This prints a box one wide by one inch long and the thickness of the line is 2 dots.

3. Reposition and resize the square so that it goes around the name and address uniformly.

4. Print a line by adding:

^FO50,300^GB400,0,4,^FS
This prints a horizontal line two inches wide by 4 dots thick.

5. Print a vertical line using this code:

^F0100,50^GBO,400,4^FS

6/8/10 Zebra Programming Guide P1012728-004

44 ZPL Commands
Basic ZPL Exercises and Examples

Exercise 3 • Bar codes — ^B3 code 39 bar code

1. Write the following format and send to the printer:

^XA
^FO50,50^B3N,N,100,Y,N^FD123456^FS
^XZ

2. Try changing each of the parameters in the ^B3 string so you can see the effects.
^B3o,e,h,f,g
^BY

Important • For valid parameter choices, see ^B3 on page 59.

3. Insert the ^BY command just before the ^B3 to see how the narrow bar width can be
altered.
^FO50,50^BY2^B3..etc ^BYx, acceptable values for x are 1
through 10

4. Alter the ratio of the narrow to wide bar.

^FO50,50^BY2,3^B3..etc ^BY2,x acceptable values for x are
2.1 through 3 in .1 increments

5. Print out a ^B3 bar code with the interpretation line on top of the bar code and the bar
code rotated 90 degrees.

6. Add a ^PQ just before the ^XZ to print several labels.

^PQ4
^XZ
^PR Print rate (in inches per second)

7. Add a ^PR command after the ^XA at the beginning of the format to change the print rate
(print speed).
^XA
^PR4 then try ^PR6 ^PRx acceptable values for x are 2 through
12 (check printer specs)
See how the print speed affects the print quality of the bar code. You may need to increase
the printer darkness setting at higher print speeds.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 45
Basic ZPL Exercises and Examples

Exercise 4 • ^SN — Serial Number command

1. Send this format to the printer:

^XA
^FO100,100^ADN,36,20^SN001,1,Y^FS
^PQ3
^XZ
To vary the ^SNv,n,z to exercise increment/decrement and leading zeros functions,
consult this guide.
If your serial number contains alpha and numeric characters, you can increment or
decrement a specific segment of the data even if it is in the middle, as this sample
sequence shows:
ABCD1000EFGH, ABCD1001EFGH, ABCD1002EFGH

2. Send this file to the printer and to see how it increments the serial number. The ^SF
command can also work with alpha characters.
^XA
^FO100,100^ADN,36,20^FDABCD1000EFGH^SF%%%%dddd%%%%,10000^FS
^PQ15
^XZ
Notice how the field data character position aligns with the ^SF data string:

^ F D A B C D 1 0 0 0 E F G H
^ S F % % % % d d d d % % % %
1 0 0 0 0
2 0 0 0 0
3 0 0 0 0

And on through…

1 0 1 4 0 0 0 0

The last label prints ABCD1014EFGH.

The % is placed in positions that you do not want to increment or decrement,

d = decimal, 10000 = increment value.

For more details on ^SF, see ^SF on page 332.

6/8/10 Zebra Programming Guide P1012728-004

46 ZPL Commands
Basic ZPL Exercises and Examples

Exercise 5 • Saving a template to memory. ^IS and image save and image load.

Note • This exercise helps you troubleshoot your code against the errors you see on your
labels.

1. Send this format to the printer:

^XA
^FO20,30^GB750,1100,4^FS
^FO20,30^GB750,200,4^FS
^FO20,30^GB750,400,4^FS
^FO20,30^GB750,700,4^FS
^FO20,226^GB325,204,4^FS
^FO30,40^ADN,36,20^FDShip to:^FS
^FO30,260^ADN,18,10^FDPart number #^FS
^FO360,260^ADN,18,10^FDDescription:^FS
^FO30,750^ADN,36,20^FDFrom:^FS
^ISR:SAMPLE.GRF^FS
^XZ

2. Send this format:

^XA
^ILR:SAMPLE.GRF^FS
^FO150,125^ADN,36,20^FDAcme Printing^FS
^FO60,330^ADN,36,20^FD14042^FS
^FO400,330^ADN,36,20^FDScrew^FS
^FO70,480^BY4^B3N,,200^FD12345678^FS
^FO150,800^ADN,36,20^FDMacks Fabricating^FS
^XZ

In this way the template only needs to be sent one time to the printer’s memory. Subsequent
formats can be sent recalling the template and merging variable data into the template. In this
exercise, the file was saved in the printers R: memory, which is volatile.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 47
Basic ZPL Exercises and Examples

Exercise 6 • ^DF and ^XF — Download format and recall format

Similar concept to ^IS and ^IL command. ^IS and ^IL processes faster in the printer than
^DF and ^XF.

This is how the ^DF and ^XF format structure produces a label similar to the ^IS/^IL
sample you just tried.

Figure 2 • Download and Recall Format

ZPL II CODE GENERATED LABEL

^XA
^DFR:SAMPLE.GRF^FS
^FO20,30^GB750,1100,4^FS
^FO20,30^GB750,200,4^FS
^FO20,30^GB750,400,4^FS
^FO20,30^GB750,700,4^FS
^FO20,226^GB325,204,4^FS
^FO30,40^ADN,36,20^FDShip to:^FS
^FO30,260^ADN,18,10^FDPart number #^FS
^FO360,260^ADN,18,10^FDDescription:^FS
^FO30,750^ADN,36,20^FDFrom:^FS
^FO150,125^ADN,36,20^FN1^FS (ship to)
^FO60,330^ADN,36,20^FN2^FS(part num)
^FO400,330^ADN,36,20^FN3^FS(description)
^FO70,480^BY4^B3N,,200^FN4^FS(barcode)
^FO150,800^ADN,36,20^FN5^FS (from)
^XZ

^XA
^XFR:SAMPLE.GRF
^FN1^FDAcme Printing^FS
^FN2^FD14042^FS
^FN3^FDScrew^FS
^FN4^FD12345678^FS
^FN5^FDMacks Fabricating^FS
^XZ

1 Download format code

2 Recall format call that generates the generated label in Figure 2.

6/8/10 Zebra Programming Guide P1012728-004

48 ZPL Commands
Basic ZPL Exercises and Examples

Exercise 7 • Asian and Unicode Encodings

This exercise works in printers with firmware version V60.14, V50.14, or later.

In each of the following examples, the format is saved in the corresponding encoding before
being sent down to the printer and the ZPL script was made in Microsoft Notepad, a basic text
editor. The characters were inserted from the character map in Windows or typed from the
keyboard.

Example • This is an example of using an Asian encoding, such as UHANGUL, with ASCII
text. Using the CI26 command tells the printer to recognize any byte less than 7F as ASCII
text and every byte above as the first byte of UHANGUAL encoding:

ZPL II CODE GENERATED LABEL

Example • This is an example of using the Unicode encoding, UTF-8:

ZPL II CODE

GENERATED LABEL

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 49
^A

^A
Scalable/Bitmapped Font
Description The ^A command specifies the font to use in a text field. ^A designates the
font for the current ^FD statement or field. The font specified by ^A is used only once for that
^FD entry. If a value for ^A is not specified again, the default ^CF font is used for the next
^FD entry.

Format ^Afo,h,w

Important • Parameter f is required. If f is omitted it defaults to the last value of the ^CF
command.

This table identifies the parameters for this format:

Command Details
f = font name Accepted Values: A through Z, and 0 to 9
Any font in the printer (downloaded, EPROM, stored fonts, fonts A
through Z and 0 to 9).
o = field orientation Accepted Values:
N = normal
R = rotated 90 degrees (clockwise)
I = inverted 180 degrees
B = read from bottom up, 270 degrees
Default Value: the last accepted ^FW value or the ^FW default
h = Character Height Scalable
(in dots) Accepted Values: 10 to 32000
Default Value: last accepted ^CF
Bitmapped
Accepted Values: multiples of height from 1 to 10 times the standard
height, in increments of 1
Default Value: last accepted ^CF
w = width (in dots) Scalable
Accepted Values: 10 to 32000
Default Value: last accepted ^CF
Bitmapped
Accepted Values: multiples of width from 1 to 10 times the standard
width, in increments of 1
Default Value: last accepted ^CF

6/8/10 Zebra Programming Guide P1012728-004

50 ZPL Commands
^A

Scalable Font Command

Example • This is an example of a scalable font command:

ZPL II Code Generated Label

^XA
^FO50,50
^A0,32,25
^FDZEBRA^FS
^FO50,150
^A0,32,25
^FDPROGRAMMING^FS
^FO50,250
^A0,32,25^FDLANGUAGE^FS
^XZ

Bitmap Font Command

Example • This is an example of a bitmap font command:

ZPL II Code Generated Label

^XA
^FO50,50
^ADN,36,20
^FDZEBRA^FS
^FO50,150
^ADN,36,20
^FDPROGRAMMING^FS
^FO50,250
^ADN,36,20^FDLANGUAGE^FS
^XZ

For reference, see Standard Printer Fonts on page 960, Zebra Code Page 850 — Latin
Character Set on page 944, Fonts and Bar Codes on page 959, and ASCII on page 957.

Comments Fonts are built using a matrix that defines standard height-to-width ratios. If you
specify only the height or width value, the standard matrix for that font automatically
determines the other value. If the value is not given or a 0 (zero) is entered, the height or width
is determined by the standard font matrix.

This command interacts with the justification parameters of ^FO and ^FT and with the field
direction parameter of ^FP. For output and examples, see Field Interactions on page 993.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 51
^A@

^A@
Use Font Name to Call Font
Description The ^A@ command uses the complete name of a font, rather than the character
designation used in ^A. Once a value for ^A@ is defined, it represents that font until a new
font name is specified by ^A@.

Format ^A@o,h,w,d:o.x

This table identifies the parameters for this format:

Parameters Details
o = field orientation Accepted Values:
N = normal
R = rotates 90 degrees (clockwise)
I = inverted 180 degrees
B = read from bottom up, 270 degrees
Default Value: N or the last ^FW value
h = character height (in Default Value: specifies magnification by w (character width) or the last
dots) accepted ^CF value. Uses the base height if none is specified.
Scalable The value is the height in dots of the entire character block.
Magnification factors are unnecessary, because characters are scaled.
Bitmapped The value is rounded to the nearest integer multiple of the
font’s base height, then divided by the font’s base height to give a
magnification nearest limit.
w = width (in dots) Default Value: specifies magnification by h (height) or the last accepted ^CF
value. Specifies the base width is used if none is specified.
Scalable The value is the width in dots of the entire character block.
Magnification factors are unnecessary, because characters are scaled.
Bitmapped The value rounds to the nearest integer multiple of the font’s
base width, then divided by the font’s base width to give a magnification
nearest limit.
d = drive location of font Accepted Values: R:, E:, B:, and A:
Default Value: R:
o = font name Accepted Values: any valid font
Default Value: if an invalid or no name is entered, the default set by ^CF is
used. If no font has been specified in ^CF, font A is used.
The font named carries over on all subsequent ^A@ commands without a font
name.
x = extension Accepted Values:
.FNT = font
.TTF = TrueType Font
.TTE is only supported in
.TTE = TrueType Extension
firmware version V60.14.x,
V50.14.x, or later.

6/8/10 Zebra Programming Guide P1012728-004

52 ZPL Commands
^A@

Example • This example is followed by a table that identifies the called out lines of code:

1 Starts the label format.

2 Searches non-volatile printer memory (B:) for CYRI_UB.FNT. When
the font is found, the ^A@ command sets the print orientation to
normal and the character size to 50 dots by 50 dots.
3 Sets the field origin at 100,100.
4 Prints the field data, Zebra Printer Fonts on the label.
5 Calls the font again and character size is decreased to 40 dots by 40
dots.
6 Sets the new field origin at 100,150.
7 Prints the field data, This uses the B:CYRI_UB.FNT on the label.
8 Ends the label format.

For reference, see Zebra Code Page 850 — Latin Character Set on page 944, Fonts and Bar
Codes on page 959, and ASCII on page 957.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 53
^B0

^B0
Aztec Bar Code Parameters
Description The ^B0 command creates a two-dimensional matrix symbology made up of
square modules arranged around a bulls-eye pattern at the center.

Note • The Aztec bar code works with firmware version V60.13.0.11A and V50.13.2 or later.

Format ^B0a,b,c,d,e,f,g

Parameters Details
a = orientation Accepted Values:
N = normal
R = rotated
I = inverted 180 degrees
B = read from bottom up, 270 degrees
Default Value: current ^FW value
b = magnification factor Accepted Values: 1 to 10
Default Value:
1 on 150 dpi printers
2 on 200 dpi printers
3 on 300 dpi printers
6 on 600 dpi printers
c = extended channel Accepted Values:
interpretation code Y = if data contains ECICs
indicator N = if data does not contain ECICs
Default Value: N
d = error control and Accepted Values:
symbol size/type 0 = default error correction level
indicator 01 to 99 = error correction percentage (minimum)
101 to 104 = 1 to 4-layer compact symbol
201 to 232 = 1 to 32-layer full-range symbol
300 = a simple Aztec “Rune”
Default Value: 0
e = menu symbol Accepted Values:
indicator Y = if this symbol is to be a menu (bar code reader initialization) symbol
N = if it is not a menu symbol
Default Value: N
f = number of symbols Accepted Values: 1 through 26
for structured append Default Value: 1

6/8/10 Zebra Programming Guide P1012728-004

54 ZPL Commands
^B0

Parameters Details
g = optional ID field for The ID field is a text string with 24-character maximum
structured append Default Value: no ID

Example • This is an example of the ^B0 command:

ZPL II CODE GENERATED LABEL

^XA
^B0R,7,N,0,N,1,0
^FD 7. This is testing label 7^FS
^XZ

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 55
^B1

^B1
Code 11 Bar Code
Description The ^B1 command produces the Code 11 bar code, also known as USD-8
code. In a Code 11 bar code, each character is composed of three bars and two spaces, and the
character set includes 10 digits and the hyphen (-).
• ^B1 supports print ratios of 2.0:1 to 3.0:1.
• Field data (^FD) is limited to the width (or length, if rotated) of the label.

Format ^B1o,e,h,f,g

Important • If additional information about the Code 11 bar code is required, go to

www.aimglobal.org.

Parameters Details
o = orientation Accepted Values:
N = normal
R = rotated 90 degrees (clockwise)
I = inverted 180 degrees
B = read from bottom up, 270 degrees
Default Value: current ^FW value
e = check digit Accepted Values:
Y = 1 digit
N = 2 digits
Default Value: N
h = bar code height (in Accepted Values: 1 to 32000
dots) Default Value: value set by ^BY
f = print interpretation Accepted Values:
line Y = yes
N = no
Default Value: Y
g = print interpretation Accepted Values:
line above code Y = yes
N = no
Default Value: N

6/8/10 Zebra Programming Guide P1012728-004

56 ZPL Commands
^B1

Example • This is an example of the Code 11 bar code:

ZPL II CODE CODE 11 BAR CODE

^XA
^FO100,100^BY3
^B1N,N,150,Y,N
^FD123456^FS
^XZ

CODE 11 BAR CODE CHARACTERS

0 1 2 3 4 5 6 7 8 9 -
Internal Start/Stop Character:

When used as a stop character:

is used with 1 check digit
is used with 2 check digits

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 57
^B2

^B2
Interleaved 2 of 5 Bar Code
Description The ^B2 command produces the Interleaved 2 of 5 bar code, a high-density,
self-checking, continuous, numeric symbology.

Each data character for the Interleaved 2 of 5 bar code is composed of five elements: five bars
or five spaces. Of the five elements, two are wide and three are narrow. The bar code is formed
by interleaving characters formed with all spaces into characters formed with all bars.
• ^B2 supports print ratios of 2.0:1 to 3.0:1.
• Field data (^FD) is limited to the width (or length, if rotated) of the label.

Format ^B2o,h,f,g,e,j

Important • If additional information about the Interleaved 2 of 5 bar code is required, go to

www.aimglobal.org.

Parameters Details
o = orientation Accepted Values:
N = normal
R = rotated 90 degrees (clockwise)
I = inverted 180 degrees
B = read from bottom up, 270 degrees
Default Value: current ^FW value
h = bar code height (in Accepted Values: 1 to 32000
dots) Default Value: value set by ^BY
f = print interpretation Accepted Values:
line Y = yes
N = no
Default Value: Y
g = print interpretation Accepted Values:
line above code Y = yes
N = no
Default Value: N
e = calculate and print Accepted Values:
Mod 10 check digit Y = yes
N = no
Default Value: N

6/8/10 Zebra Programming Guide P1012728-004

58 ZPL Commands
^B2

Example • This is an example of an Interleaved 2 of 5 bar code:

ZPL II CODE INTERLEAVED 2 OF 5 BAR CODE

^XA
^FO100,100^BY3
^B2N,150,Y,N,N
^FD123456^FS
^XZ

INTERLEAVED 2 OF 5 BAR CODE CHARACTERS

0 1 2 3 4 5 6 7 8 9
Start/Stop (internal)

Comments The total number of digits in an Interleaved 2 of 5 bar code must be even. The
printer automatically adds a leading 0 (zero) if an odd number of digits is received.

The Interleaved 2 of 5 bar code uses the Mod 10 check-digit scheme for error checking. For
more information on Mod 10 check digits, see Mod 10 Check Digit on page 974.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 59
^B3

^B3
Code 39 Bar Code
Description The Code 39 bar code is the standard for many industries, including the U.S.
Department of Defense. It is one of three symbologies identified in the American National
Standards Institute (ANSI) standard MH10.8M-1983. Code 39 is also known as USD-3 Code
and 3 of 9 Code.

Each character in a Code 39 bar code is composed of nine elements: five bars, four spaces, and
an inter-character gap. Three of the nine elements are wide; the six remaining elements are
narrow.
• ^B3 supports print ratios of 2.0:1 to 3.0:1.
• Field data (^FD) is limited to the width (or length, if rotated) of the label.
• Code 39 automatically generates the start and stop character (*).
• Asterisk (*) for start and stop character prints in the interpretation line, if the interpretation
line is turned on.
• Code 39 is capable of encoding the full 128-character ASCII set.

Format ^B3o,e,h,f,g

Important • If additional information about the Code 39 bar code is required, go to

www.aimglobal.org.

Parameters Details
o = orientation Accepted Values:
N = normal
R = rotated 90 degrees (clockwise)
I = inverted 180 degrees
B = read from bottom up, 270 degrees
Default Value: current ^FW value
e = Mod-43 check digit Accepted Values:
Y = yes
N = no
Default Value: N
h = bar code height (in Accepted Values: 1 to 32000
dots) Default Value: value set by ^BY
f = print interpretation Accepted Values:
line Y = yes
N = no
Default Value: Y

6/8/10 Zebra Programming Guide P1012728-004

60 ZPL Commands
^B3

Parameters Details
g = print interpretation Accepted Values:
line above code Y = yes
N = no
Default Value: N

Example 1 • This is an example of a Code 39 bar code:

ZPL II CODE CODE 39 BAR CODE

^XA
^FO100,100^BY3
^B3N,N,100,Y,N
^FD123ABC^FS
^XZ

CODE 39 BAR CODE CHARACTERS

0 1 2 3 4 5 6 7 8 9
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
- . $ / + % Space

Comments Extended ASCII is a function of the scanner, not of the bar code. Your scanner
must have extended ASCII enabled for this feature to work. To enable extended ASCII in the
Code 39, you must first encode +$ in your ^FD statement. To disable extended ASCII, you
must encode -$ in your ^FD statement.

Example 2 • This example encodes a carriage return with line feed into a Code 39 bar code:

ZPL II CODE GENERATED LABELS

^XA
^FO20,20
^B3N,N,100,Y
^FDTEST+$$M$J-$^FS
^XZ

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 61
^B3

Full ASCII Mode for Code 39

Code 39 can generate the full 128-character ASCII set using paired characters as shown in
these tables:

Table 1 • Code 39 Full ASCII Mode

ASCII Code 39 ASCII Code 39

SOH $A SP Space
STX $B ! /A
ETX $C “ /B
EOT $D # /C
ENQ $E $ /D
ACK $F % /E
BEL $G & /F
BS $H ‘ /G
HT $I ( /H
LF $J ) /I
VT $K * /J
FF $L ++ /K
CR $M , /L
SO $N - -
SI $O . .
DLE $P / /O
DC1 $Q 0 O
DC2 $R 1 1
DC3 $S 2 2
DC4 $T 3 3
NAK $U 4 4
SYN $V 5 5
ETB $W 6 6
CAN $X 7 7
EM $Y 8 8
SUB $Z 9 9
ESC %A : /Z
FS %B ; %F
FS %C < %G
RS %D = %H
US %E > %I
? %J

6/8/10 Zebra Programming Guide P1012728-004

62 ZPL Commands
^B3

Table 2 • Code 39 Full ASCII Mode

ASCII Code 39 ASCII Code 39

@ %V ‘ %W
A A a +A
B B b +B
C C c +C
D D d +D
E E e +E
F F f +F
G G g +G
H H h +H
I I I +I
J J j +J
K K k +K
L L l +L
M M m +M
N N n +N
O O o +O
P P p +P
Q Q q +Q
R R r +R
S S s +S
T T t +T
U U u +U
V V v +V
W W w +W
X X x +X
Y Y y +Y
Z Z z +Z
[ %K { %P
\ %L | %Q
] %M } %R
^ %N ~ %S
_ %O DEL %T, %X

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 63
^B4

^B4
Code 49 Bar Code
Description The ^B4 command creates a multi-row, continuous, variable-length
symbology capable of encoding the full 128-character ASCII set. It is ideally suited for
applications requiring large amounts of data in a small space.

The code consists of two to eight rows. A row consists of a leading quiet zone, four symbol
characters encoding eight code characters, a stop pattern, and a trailing quiet zone. A separator
bar with a height of one module separates each row. Each symbol character encodes two
characters from a set of Code 49 characters.
• ^B4 has a fixed print ratio.
• Rows can be scanned in any order.

Format ^B4o,h,f,m

Important • For additional information about the Code 49 bar code is required, go to
www.aimglobal.org.

Parameters Details
o = orientation Accepted Values:
N = normal
R = rotated 90 degrees (clockwise)
I = inverted 180 degrees
B = read from bottom up, 270 degrees
Default Value: current ^FW value
h = height multiplier of Accepted Values: 1 to height of label
individual rows Default Value: value set by ^BY
This number multiplied by the module equals the height of the individual
rows in dots. 1 is not a recommended value.
f = print interpretation Accepted Values:
line N = no line printed
A = print interpretation line above code
B = print interpretation line below code
Default Value: N
When the field data exceeds two rows, expect the interpretation line to
extend beyond the right edge of the bar code symbol.

6/8/10 Zebra Programming Guide P1012728-004

64 ZPL Commands
^B4

Parameters Details
m = starting mode Accepted Values:
0 = Regular Alphanumeric Mode
1 = Multiple Read Alphanumeric
2 = Regular Numeric Mode
3 = Group Alphanumeric Mode
4 = Regular Alphanumeric Shift 1
5 = Regular Alphanumeric Shift 2
A = Automatic Mode. The printer determines the starting mode by
analyzing the field data.
Default Value: A

Example 1 • This is an example of a Code 49 bar code:

ZPL II CODE CODE 49 BAR CODE

^XA
^FO150,100^BY3
^B4N,20,A,A
^FD12345ABCDE^FS
^XZ

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 65
^B4

Table 3 • Code 49 CharacterSet

Field Data Unshifted Shift 1 Shift 2

Set Character Set Character Set Character Set
0 0 ’
1 1 ESC ;
2 2 FS <
3 3 GS =
4 4 RS >
5 5 US ?
6 6 ! @
7 7 “ [
8 8 # \
9 9 & ]
A A SOH a
B B STX b
C C ETX c
D D EOT d
E E ENQ e
F F ACK f
G G BEL g
H H BS h
I I HT I
J J LF j
K K VT k
L L FF l
M M CR m
N N SO n
O O SI o
P P DLE p
Q Q DC1 q
R R DC2 r
S S DC3 s
T T DC4 t
U U NAK u
V V SYN v
W W ETB w
X X CAN x
Y Y EM y
Z Z SUB z
- - ( _
. . ) ‘
SPACE SPACE Null DEL
$ $ * {
/ / , |
++ ++ : }
% % reserved ~
< (Shift 1)
> (Shift 2)
: (N.A.)
; (N.A.)
? (N.A.)
= (Numeric Shift)
Code 49 Shift 1 and 2 Character Substitutions

6/8/10 Zebra Programming Guide P1012728-004

66 ZPL Commands
^B4

Code 49 Field Data Character Set

The ^FD data sent to the printer when using starting modes 0 to 5 is based on the
Code 49 Internal Character Set. This is shown in the first column of the Code 49 table on the
previous page. These characters are Code 49 control characters:
: ; < = > ?

Valid field data must be supplied when using modes 0 to 5. Shifted characters are sent as a
two-character sequence of a shift character followed by a character in the unshifted character
set.

Example 2 • To encode a lowercase a, send a > (Shift 2) followed by an uppercase A. If

interpretation line printing is selected, a lowercase a prints in the interpretation line. This
reflects what the output from the scanner reads. Code 49 uses uppercase alphanumeric
characters only.

If an invalid sequence is detected, the Code 49 formatter stops interpreting field data and prints
a symbol with the data up to the invalid sequence. These are examples of invalid sequences:
• Terminating numeric mode with any characters other than 0 to 9 or a Numeric Space.
• Starting in Mode 4 (Regular Alphanumeric Shift 1) and the first field data character is
not in the Shift 1 set.
• Starting in Mode 5 (Regular Alphanumeric Shift 2) and the first field data character is
not in the Shift 2 set.
• Sending Shift 1 followed by a character not in the Shift 1 set.
• Sending Shift 2 followed by a character not in the Shift 2 set.
• Sending two Shift 1 or Shift 2 control characters.

Advantages of Using the Code 49 Automatic Mode

Using the default (Automatic Mode) completely eliminates the need for selecting the starting
mode or manually performing character shifts. The Automatic Mode analyzes the incoming
ASCII string, determines the proper mode, performs all character shifts, and compacts the data
for maximum efficiency.

Numeric Mode is selected or shifted only when five or more continuous digits are found.
Numeric packaging provides no space advantage for numeric strings consisting of fewer than
eight characters.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 67
^B5

^B5
Planet Code bar code
Description The ^B5 command is supported in all printers as a resident bar code.

Note • Accepted bar code characters are 0 - 9.

Format ^B5o,h,f,g

Parameters Details
o = orientation code Accepted Values:
N = normal
R = rotated
I = inverted 180 degrees
B = read from bottom up, 270 degrees
Default Value: current ^FW value
h = bar code height (in Accepted Values: 1 to 9999
dots) Default Value: value set by ^BY
f = interpretation line Accepted Values:
N = no
Y = yes
Default Value: N
g = determines if the Accepted Values:
interpretation line is N = no
printed above the bar Y = yes
code
Default Value: N

Example • This is an example of a Planet Code bar code:

ZPL II CODE GENERATED LABEL

^XA
^FO150,100^BY3
^B5N,100,Y,N
^FD12345678901^FS
^XZ

6/8/10 Zebra Programming Guide P1012728-004

68 ZPL Commands
^B7

^B7
PDF417 Bar Code
Description The ^B7 command produces the PDF417 bar code, a two-dimensional,
multirow, continuous, stacked symbology. PDF417 is capable of encoding over 1,000
characters per bar code. It is ideally suited for applications requiring large amounts of
information at the time the bar code is read.

The bar code consists of three to 90 stacked rows. Each row consists of start and stop patterns
and symbol characters called code-words. A code-word consists of four bars and four spaces.
A three code-word minimum is required per row.

The PDF417 bar code is also capable of using the structured append option (^FM), which
allows you to extend the field data limitations by printing multiple bar codes. For more
information on using structured append, see ^FM on page 187.
• PDF417 has a fixed print ratio.
• Field data (^FD) is limited to 3K of character data.

Format ^B7o,h,s,c,r,t

Parameters Details
o = orientation Accepted Values:
N = normal
R = rotated 90 degrees (clockwise)
I = inverted 180 degrees
B = read from bottom up, 270 degrees
Default Value: current ^FW value
h = bar code height for Accepted Values: 1 to height of label
individual rows (in Default Value: value set by ^BY
dots) This number multiplied by the module equals the height of the individual
rows in dots. If this number is not specified, the overall bar code height,
divided by the number of rows, equals the height of the individual rows in
dots, where the overall bar code height is defined by the ^BY command. 1 is
not a recommended value.
s = security level Accepted Values: 1 to 8 (error detection and correction)
Default Value: 0 (error detection only)
This determines the number of error detection and correction code-words to
be generated for the symbol. The default level provides only error detection
without correction. Increasing the security level adds increasing levels of
error correction and increases the symbol size.
c = number of data Accepted Values: 1 to 30
columns to encode Default Value: 1:2 (row-to-column aspect ratio)
You can specify the number of code-word columns giving control over the
width of the symbol.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 69
^B7

Parameters Details
r = number of rows to Accepted Values: 3 to 90
encode Default Value: 1:2 (row-to-column aspect ratio)
You can specify the number of symbol rows giving control over the height
of the symbol. For example, with no row or column values entered, 72
code-words would be encoded into a symbol of six columns and 12 rows.
Depending on code-words, the aspect ratio is not always exact.
t = truncate right row Accepted Values:
indicators and stop N = no truncation
pattern Y = perform truncation
Default Value: N

Example 1 • This is an example of a PDF417 bar code:

ZPL II CODE PDF417 BAR CODE

^XA
^BY2,3
^FO10,10^B7N,5,5,,83,N
^FDZebra Technologies
Corporation strives to be
the expert supplier of
innovative solutions to
speciality demand labeling
and ticketing problems of
business and government.
We will attract and retain
the best people who will
understand our customer's
needs and provide them with
systems, hardware, software,
consumables and service
offering the best value,
high quality, and reliable
performance, all delivered
in a timely manner.
^FS^XZ

6/8/10 Zebra Programming Guide P1012728-004

70 ZPL Commands
^B7

Example 2 • This is an example of a PDF417 without and with truncation selected:

Example 3 • This example shows the ^B7 command used with field hex (^FH) characters:

ZPL II CODE GENERATED LABEL

^XA
^FO50,50^BY3,3.0^B7N,8,5,7,21,N
^FH_^FD[)>_1E06_1DP12345678_1DQ160
_1D1JUN123456789A2B4C6D8E_1D20LA6-987
_1D21L54321 ZES_1D15KG1155
_1DBSC151208_1D7Q10GT_1E_04^FS
^XZ

Comments Noted in this bulleted list:

• If both columns and rows are specified, their product must be less than 928.
• No symbol is printed if the product of columns and rows is greater than 928.
• No symbol is printed if total code-words are greater than the product of columns and rows.
• Serialization is not allowed with this bar code.
• The truncation feature can be used in situations where label damage is not likely. The right
row indicators and stop pattern is reduced to a single module bar width. The difference
between a non truncated and a truncated bar code is shown in the previous examples.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 71
^B7

Special Considerations for ^BY When Using PDF417

When used with ^B7, the parameters for the ^BY command are:
w = module width (in dots)
Accepted Values: 2 to 10
Default Value: 2
r = ratio
Fixed Value: 3 (ratio has no effect on PDF417)
h = height of bars (in dots)
Accepted Values: 1 to 32000
Default Value: 10
PDF417 uses this only when row height is not specified in the ^B7 h parameter.

Special Considerations for ^FD When Using PDF417

The character set sent to the printer with the ^FD command includes the full ASCII set, except
for those characters with special meaning to the printer.

See Zebra Code Page 850 — Latin Character Set on page 944, ^CC ~CC on page 140, and
^CT ~CT on page 155.
• CR and LF are also valid characters for all ^FD statements. This scheme is used:
\& = carriage return/line feed
\\ = backslash (\)
• ^CI13 must be selected to print a backslash (\).

6/8/10 Zebra Programming Guide P1012728-004

72 ZPL Commands
^B8

^B8
EAN-8 Bar Code
Description The ^B8 command is the shortened version of the EAN-13 bar code. EAN is
an acronym for European Article Numbering. Each character in the EAN-8 bar code is
composed of four elements: two bars and two spaces.
• ^B8 supports a fixed ratio.
• Field data (^FD) is limited to exactly seven characters. ZPL II automatically pads or
truncates on the left with zeros to achieve the required number of characters.
• When using JAN-8 (Japanese Article Numbering), a specialized application of EAN-8,
the first two non-zero digits sent to the printer are always 49.

Format ^B8o,h,f,g

Important • If additional information about the EAN-8 bar code is required, go to

www.aimglobal.org.

Parameters Details
o = orientation Accepted Values:
N = normal
R = rotated 90 degrees (clockwise)
I = inverted 180 degrees
B = read from bottom up, 270 degrees
Default Value: current ^FW value
h = bar code height (in Accepted Values: 1 to 32000
dots) Default Value: value set by ^BY
f = print interpretation Accepted Values:
line N = no
Y = yes
Default Value: Y
g = print interpretation Accepted Values:
line above code N = no
Y = yes
Default Value: N

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 73
^B8

Example • This is an example of an EAN-8 bar code:

ZPL II CODE EAN-8 BAR CODE

^XA
^FO100,100^BY3
^B8N,100,Y,N
^FD1234567^FS
^XZ

EAN-8 BAR CODE CHARACTERS

0 1 2 3 4 5 6 7 8 9

6/8/10 Zebra Programming Guide P1012728-004

74 ZPL Commands
^B9

^B9
UPC-E Bar Code
Description The ^B9 command produces a variation of the UPC symbology used for
number system 0. It is a shortened version of the UPC-A bar code, where zeros are suppressed,
resulting in codes that require less printing space. The 6 dot/mm, 12 dot/mm, and 24 dot/mm
printheads produce the UPC and EAN symbologies at 100 percent of their size. However, an
8 dot/mm printhead produces the UPC and EAN symbologies at a magnification factor of 77
percent.

Each character in a UPC-E bar code is composed of four elements: two bars and two spaces.
The ^BY command must be used to specify the width of the narrow bar.
• ^B9 supports a fixed ratio.
• Field data (^FD) is limited to exactly 10 characters, requiring a five-digit manufacturer’s
code and five-digit product code.
• When using the zero-suppressed versions of UPC, you must enter the full
10-character sequence. ZPL II calculates and prints the shortened version.

Format ^B9,h,f,g,e

Important • If additional information about the UPC-E bar code is required, go to

www.aimglobal.org.

Parameters Details
o = orientation Accepted Values:
N = normal
R = rotated 90 degrees (clockwise)
I = inverted 180 degrees
B = read from bottom up, 270 degrees
Default Value: current ^FW value
h = bar code height (in Accepted Values: 1 to 32000
dots) Default Value: value set by ^BY
f = print interpretation Accepted Values:
line N = no
Y = yes
Default Value: Y
g = print interpretation Accepted Values:
line above code N = no
Y = yes
Default Value: N

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 75
^B9

Parameters Details
e = print check digit Accepted Values:
N = no
Y = yes
Default Value: Y

Example • This is an example of a UPC-E bar code:

ZPL II CODE UPC-E BAR CODE

^XA
^FO150,100^BY3
^B9N,100,Y,N,Y
^FD1230000045^FS
^XZ

UPC-E BAR CODE CHARACTERS

0 1 2 3 4 5 6 7 8 9

Rules for Proper Product Code Numbers

• If the last three digits in the manufacturer’s number are 000, 100, or 200, valid product
code numbers are 00000 to 00999.
• If the last three digits in the manufacturer’s number are 300, 400, 500, 600, 700, 800, or
900, valid product code numbers are 00000 to 00099.
• If the last two digits in the manufacturer’s number are 10, 20, 30, 40, 50, 60, 70, 80, or 90,
valid product code numbers are 00000 to 00009.
• If the manufacturer’s number does not end in zero (0), valid product code numbers are
00005 to 00009.

6/8/10 Zebra Programming Guide P1012728-004

76 ZPL Commands
^BA

^BA
Code 93 Bar Code
Description The ^BA command creates a variable length, continuous symbology. The
Code 93 bar code is used in many of the same applications as Code 39. It uses the full 128-
character ASCII set. ZPL II, however, does not support ASCII control codes or escape
sequences. It uses the substitute characters shown below.

Control Code ZPL II Substitute

Ctrl $ &
Ctrl % ‘
Ctrl / (
Ctrl + )

Each character in the Code 93 bar code is composed of six elements: three bars and three
spaces. Although invoked differently, the human-readable interpretation line prints as though
the control code has been used.
• ^BA supports a fixed print ratio.
• Field data (^FD) is limited to the width (or length, if rotated) of the label.

Format ^BAo,h,f,g,e

Important • If additional information about the Code 93 bar code is required, go to

www.aimglobal.org.

Parameters Details
o = orientation Accepted Values:
N = normal
R = rotated 90 degrees (clockwise)
I = inverted 180 degrees
B = read from bottom up, 270 degrees
Default Value: current ^FW value
h = bar code height (in Accepted Values: 1 to 32000
dots) Default Value: value set by ^BY
f = print interpretation Accepted Values:
line N = no
Y = yes
Default Value: Y
g = print interpretation Accepted Values:
line above code N = no
Y = yes
Default Value: N

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 77
^BA

Parameters Details
e = print check digit Accepted Values:
N = no
Y = yes
Default Value: N

Example • This is an example of a Code 93 bar code:

ZPL II CODE CODE 93 BAR CODE

^XA
^FO100,75^BY3
^BAN,100,Y,N,N
^FD12345ABCDE^FS
^XZ

CODE 93 BAR CODE CHARACTERS

0 1 2 3 4 5 6 7 8 9
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
- . $ / + % & ’ ( )
SPACE
Denotes an internal start/stop character that must precede and follow
every bar code message.

Comments All control codes are used in pairs.

Code 93 is also capable of encoding the full 128-character ASCII set. For more details, see
Table 4 on page 78.

Full ASCII Mode for Code 93

Code 93 can generate the full 128-character ASCII set using paired characters as shown in
Table 4 on page 78.

6/8/10 Zebra Programming Guide P1012728-004

78 ZPL Commands
^BA

Table 4 • Code 93 Full ASCII Mode

ASCII Code 93 ASCII Code 93

NUL ‘U SP Space
SOH &A ! (A
STX &B “ (B
ETX &C # (C
EOT &D $ (D
ENQ &E % (E
ACK &F & (F
BEL &G ‘ (G
BS &H ( (H
HT &I ) (I
LF &J * (J
VT &K ++ ++
FF &L , (L
CR &M - -
SO &N . .
SI &O / /
DLE &P 0 O
DC1 &Q 1 1
DC2 &R 2 2
DC3 &S 3 3
DC4 &T 4 4
NAK &U 5 5
SYN &V 6 6
ETB &W 7 7
CAN &X 8 8
EM &Y 9 9
SUB &Z : (Z
ESC ‘A ; ‘F
FS ‘B < ‘G
FS ‘C = ‘H
RS ‘D > ‘I
US ‘E ? ‘J

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 79
^BA

Table 5 • Code 93 Full ASCII Mode

ASCII Code 93 ASCII Code 93

@ ‘V ‘ ‘W
A A a )A
B B b )B
C C c )C
D D d )D
E E e )E
F F f )F
G G g )G
H H h )H
I I I )I
J J j )J
K K k )K
L L l )L
M M m )M
N N n )N
O O o )O
P P p )P
Q Q q )Q
R R r )R
S S s )S
T T t )T
U U u )U
V V v )V
W W w )W
X X x )X
Y Y y )Y
Z Z z )Z
[ ‘K { ‘P
\ ‘L | ‘Q
] ‘M } ‘R
^ ‘N ~ ‘S
_ ‘O DEL ‘T

6/8/10 Zebra Programming Guide P1012728-004

80 ZPL Commands
^BB

^BB
CODABLOCK Bar Code
Description The ^BB command produces a two-dimensional, multirow, stacked
symbology. It is ideally suited for applications that require large amounts of information.

Depending on the mode selected, the code consists of one to 44 stacked rows. Each row begins
and ends with a start and stop pattern.
• CODABLOCK A supports variable print ratios.
• CODABLOCK E and F support only fixed print ratios.

Format ^BBo,h,s,c,r,m

Important • If additional information about the CODABLOCK bar code is required, go to

www.aimglobal.org.

Parameters Details
o = orientation Accepted Values:
N = normal
R = rotated 90 degrees (clockwise)
I = inverted 180 degrees
B = read from bottom up, 270 degrees
Default Value: N
h = bar code height for Accepted Values: 2 to 32000
individual rows (in Default Value: 8
dots) This number, multiplied by the module, equals the height of the individual
row in dots.
s = security level Accepted Values:
N = no
Y = yes
Default Value: Y
Security level determines whether symbol check-sums are generated and
added to the symbol. Check sums are never generated for single-row
symbols. This can be turned off only if parameter m is set to A.
c = number of characters Accepted Values: 2 to 62 characters
per row (data This is used to encode a CODABLOCK symbol. It gives the you control
columns) over the width of the symbol.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 81
^BB

Parameters Details
r = number of rows to Accepted Values:
encode for CODABLOCK A: 1 to 22
for CODABLOCK E and F: 2 to 4
• If values for c and r are not specified, a single row is produced.
• If a value for r is not specified, and c exceeds the maximum range, a
single row equal to the field data length is produced.
• If a value for c is not specified, the number of characters per row is
derived by dividing the field data by the value of r.
• If both parameters are specified, the amount of field data must be less
than the product of the specified parameters. If the field data exceeds
the value of the product, either no symbol or an error code is printed (if
^CV is active).
• If the data field contains primarily numeric data, fewer than the
specified rows might be printed. If the field data contains several shift
and code-switch characters, more than the specified number of rows
might be printed.
m = mode Accepted Values: A, E, F
CODABLOCK A uses the Code 39 character set.
CODABLOCK F uses the Code 128 character set.
CODABLOCK E uses the Code 128 character set and automatically adds
FNC1.
Default Value: F

6/8/10 Zebra Programming Guide P1012728-004

82 ZPL Commands
^BB

Example • This is an example of a CODABLOCK bar code:

ZPL II CODE CODABLOCK BAR CODE

^XA
^BY2,3
^FO10,10^BBN,30,,30,44,E
^FDZebra Technologies
Corporation strives to be
the expert supplier of
innovative solutions to
speciality demand labeling
and ticketing problems of
business and government.
We will attract and retain
the best people who will
understand our customer's
needs and provide them with
systems, hardware, software,
consumables and service
offering the best value,
high quality, and reliable
performance, all delivered
in a timely manner.^FS
^XZ

Special Considerations for the ^BY Command When Using ^BB

The parameters for the ^BYw,r,h command, when used with a ^BB code, are as follows:
w = module width (in dots)
Accepted Values: 2 to 10 (CODABLOCK A only)
Default Value: 2
r = ratio
Fixed Value: 3 (ratio has no effect on CODABLOCK E or F)
h = height of bars (in dots)
Accepted Values: 1 to 32,32000
Default Value: 10
CODABLOCK uses this as the overall symbol height only when the row height is not
specified in the ^BB h parameter.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 83
^BB

Special Considerations for ^FD Character Set When Using ^BB

The character set sent to the printer depends on the mode selected in parameter m.
CODABLOCK A: CODABLOCK A uses the same character set as Code 39. If any other
character is used in the ^FD statement, either no bar code is printed or an error message is
printed (if ^CV is active).
CODABLOCK E: The Automatic Mode includes the full ASCII set except for those
characters with special meaning to the printer. Function codes or the
Code 128 Subset A <nul> character can be inserted using of the ^FH command.

<fnc1> = 80 hex <fnc3> = 82 hex

<fnc2> = 81 hex <fnc4> = 83 hex
<nul> = 84 hex

For any other character above 84 hex, either no bar code is printed or an error message is
printed (if ^CV is active).
CODABLOCK F: CODABLOCK F uses the full ASCII set, except for those characters
with special meaning to the printer. Function codes or the Code 128 Subset A <nul>
character can be inserted using of the ^FH command.

<fnc1> = 80 hex <fnc3> = 82 hex

<fnc2> = 81 hex <fnc4> = 83 hex
<nul> = 84 hex

6/8/10 Zebra Programming Guide P1012728-004

84 ZPL Commands
^BC

^BC
Code 128 Bar Code (Subsets A, B, and C)
Description The ^BC command creates the Code 128 bar code, a high-density, variable
length, continuous, alphanumeric symbology. It was designed for complexly encoded product
identification.

Code 128 has three subsets of characters. There are 106 encoded printing characters in each
set, and each character can have up to three different meanings, depending on the character
subset being used. Each Code 128 character consists of six elements: three bars and three
spaces.
• ^BC supports a fixed print ratio.
• Field data (^FD) is limited to the width (or length, if rotated) of the label.

Format ^BCo,h,f,g,e,m

Important • If additional information about the Code 128 bar code is required, go to
www.aimglobal.org.

Parameters Details
o = orientation Accepted Values:
N = normal
R = rotated 90 degrees (clockwise)
I = inverted 180 degrees
B = read from bottom up, 270 degrees
Default Value: current ^FW value
h = bar code height (in Accepted Values: 1 to 32000
dots) Default Value: value set by ^BY
f = print interpretation Accepted Values: Y (yes) or N (no)
line Default Value: Y
The interpretation line can be printed in any font by placing the font
command before the bar code command.
g = print interpretation Accepted Values: Y (yes) or N (no)
line above code Default Value: N
e = UCC check digit Accepted Values: Y (turns on) or N (turns off)
Mod 103 check digit is always there. It cannot be turned on or off. Mod 10
and 103 appear together with e turned on.
Default Value: N

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 85
^BC

Parameters Details
m = mode Accepted Values:
N = no selected mode
U = UCC Case Mode
• More than 19 digits in ^FD or ^SN are eliminated.
• Fewer than 19 digits in ^FD or ^SN add zeros to the right to bring the
count to 19. This produces an invalid interpretation line.
A = Automatic Mode
This analyzes the data sent and automatically determines the best
packing method. The full ASCII character set can be used in the ^FD
statement — the printer determines when to shift subsets. A string of
four or more numeric digits causes an automatic shift to Subset C.
D = UCC/EAN Mode (x.11.x and newer firmware)
This allows dealing with UCC/EAN with and without chained
application identifiers. The code starts in the appropriate subset
followed by FNC1 to indicate a UCC/EAN 128 bar code. The printer
automatically strips out parentheses and spaces for encoding, but
prints them in the human-readable section. The printer automatically
determines if a check digit is required, calculate it, and print it.
Automatically sizes the human readable.
Default Value: N

Example 1 • This is an example of a Code 128 bar code:

ZPL II CODE CODE 128 BAR CODE

^XA
^FO100,100^BY3
^BCN,100,Y,N,N
^FD123456^FS
^XZ

6/8/10 Zebra Programming Guide P1012728-004

86 ZPL Commands
^BC

Code 128 Subsets

The Code 128 character subsets are referred to as Subset A, Subset B, and Subset C. A subset
can be selected in these ways:
• A special Invocation Code can be included in the field data (^FD) string associated with
that bar code.
• The desired Start Code can be placed at the beginning of the field data. If no Start Code is
entered, Subset B are used.

To change subsets within a bar code, place the Invocation Code at the appropriate points
within the field data (^FD) string. The new subset stays in effect until changed with the
Invocation Code. For example, in Subset C, >7 in the field data changes the Subset to A.

Table 6 shows the Code 128 Invocation Codes and Start Characters for the three subsets.

Table 6 • Code 128 Invocation Characters

Invocation Decimal Subset A Subset B Subset C

Code Value Character Character Character
>< 62
>0 30 > >
>= 94 ~
>1 95 USQ DEL
>2 96 FNC 3 FNC 3
>3 97 FNC 2 FNC 2
>4 98 SHIFT SHIFT
>5 99 CODE C CODE C
>6 100 CODE B FNC 4 CODE B
>7 101 FNC 4 CODE A CODE A
>8 102 FNC 1 FNC 1 FNC 1

Start Characters
>9 103 Start Code A (Numeric Pairs give Alpha/Numerics)
>: 104 Start Code B (Normal Alpha/Numeric)
>; 105 Start Code C (All numeric (00 - 99)

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 87
^BC

Table 7 shows the character sets for Code 128:

Table 7 • Code 128 Character Sets

Value Code A Code B Code C Value Code A Code B Code C

0 SP SP 00 53 U U 53
1 ! ! 01 54 V V 54
2 '' '' 02 55 W W 55
3 # # 03 56 X X 56
4 $ $ 04 57 Y Y 57
5 % % 05 58 Z Z 58
6 & & 06 59 [ [ 59
7 ' ' 07 60 \ \ 60
8 ( ( 08 61 ] ] 61
9 ) ) 09 62 ^ ^ 62
10 * * 10 63 _ _ 63
11 + + 11 64 NUL . 64
12 , , 12 65 SOH a 65
13 - - 13 66 STX b 66
14 . . 14 67 ETX c 67
15 / / 15 68 EOT d 68
16 0 0 16 69 ENQ e 69
17 1 1 17 70 ACK f 70
18 2 2 18 71 BEL g 71
19 3 3 19 72 BS h 72
20 4 4 20 73 HT i 73
21 5 5 21 74 LF j 74
22 6 6 22 75 VT k 75
23 7 7 23 76 FF l 76
24 8 8 24 77 CR m 77
25 9 9 25 78 SO n 78
26 : : 26 79 SI o 79
27 ; ; 27 80 DLE p 80
28 < < 28 81 DC1 q 81
29 = = 29 82 DC2 r 82
30 > > 30 83 DC3 s 83
31 ? ? 31 84 DC4 t 84
32 @ @ 32 85 NAK u 85
33 A A 33 86 SYN v 86
34 B B 34 87 ETB w 87
35 C C 35 88 CAN x 88
36 D D 36 89 EM y 89
37 E E 37 90 SUB z 90
38 F F 38 91 ESC { 91
39 G G 39 92 FS | 92
40 H H 40 93 GS } 93
41 I I 41 94 RS ~ 94
42 J J 42 95 US DEL 95
43 K K 43 96 FNC3 FNC3 96
44 L L 44 97 FNC2 FNC2 97
45 M M 45 98 SHIFT SHIFT 98
46 N N 46 99 Code C Code C 99
47 O O 47 100 Code B FNC4 Code B
48 P P 48 101 FNC4 Code A Code A
49 Q Q 49 102 FNC1 FNC1 FNC1
50 R R 50 103 START (Code A)
51 S S 51 104 START (Code B)
52 T T 52 105 START (Code C)

6/8/10 Zebra Programming Guide P1012728-004

88 ZPL Commands
^BC

Example 2 • Figures A and B are examples of identical bar codes, and Figure C is an
example of switching from Subset C to B to A, as follows:

^XA
^FO100,75
^BCN,100,Y,N,N
^FDCODE128^FS
^XZ

Figure A: Subset B with no start character

^XA
^FO100,75
^BCN,100,Y,N,N
^FD>:CODE128^FS
^XZ

Figure B: Subset B with start character

Because Code 128 Subset B is the most commonly used subset, ZPL II defaults to Subset B if
no start character is specified in the data string.

^XA
^FO50,50
^BY3^BCN,100,Y,N,N
^FD>;382436>6CODE128>752375152^FS
^XZ

Figure C: Switching from Subset C to B to A

How ^BC Works Within a ZPL II Script

^XA – the first command starts the label format.

^FO100,75 – the second command sets the field origin at 100 dots across the x-axis and 75
dots down the y-axis from the upper-left corner.

^BCN,100,Y,N,N – the third command calls for a Code 128 bar code to be printed with
no rotation (N) and a height of 100 dots. An interpretation line is printed (Y) below the bar
code (N). No UCC check digit is used (N).

^FDCODE128^FS (Figure A) ^FD>:CODE128^FS (Figure B) – the field data command

specifies the content of the bar code.

^XZ – the last command ends the field data and indicates the end of the label.

The interpretation line prints below the code with the UCC check digit turned off.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 89
^BC

The ^FD command for Figure A does not specify any subset, so Subset B is used. In Figure B,
the ^FD command specifically calls Subset B with the >: Start Code. Although ZPL II defaults
to Code B, it is good practice to include the Invocation Codes in the command.

Code 128 – Subset B is programmed directly as ASCII text, except for values greater than 94
decimal and a few special characters that must be programmed using the invocation codes.
Those characters are:
^ > ~

Example 3 • Code 128 – Subsets A and C

Code 128, Subsets A and C are programmed in pairs of digits, 00 to 99, in the field data
string. For details, see Table 6 on page 86.

In Subset A, each pair of digits results in a single character being encoded in the bar code; in
Subset C, characters are printed as entered. Figure E below is an example of Subset A (>9 is
the Start Code for Subset A).

Nonintegers programmed as the first character of a digit pair (D2) are ignored. However,
nonintegers programmed as the second character of a digit pair (2D) invalidate the entire
digit pair, and the pair is ignored. An extra unpaired digit in the field data string just before a
code shift is also ignored.

Figure C and Figure D below are examples of Subset C. Notice that the bar codes are
identical. In the program code for Figure D, the D is ignored and the 2 is paired with the 4.

^XA
^FO100,75^BY3
^BCN,100,Y,N,N
^FD>;382436^FS
^XZ

Figure C: Subset C with normal data

^XA
^FO100,75^BY3
^BCN,100,Y,N,N
^FD>;38D2436^FS
^XZ

Figure D: Subset C with ignored alpha character

^XA
^FO100,75^BY3
^BCN,100,Y,N,N
^FD>935473637171824^FS
^XZ

Figure E: Subset A

6/8/10 Zebra Programming Guide P1012728-004

90 ZPL Commands
^BC

The UCC/EAN-128 Symbology

The symbology specified for the representation of Application Identifier data is UCC/EAN-
128, a variant of Code 128, exclusively reserved to EAN International and the Uniform Code
Council (UCC).

Note • It is not intended to be used for data to be scanned at the point of sales in retail outlets.

UCC/EAN-128 offers several advantages. It is one of the most complete, alphanumeric, one-
dimensional symbologies available today. The use of three different character sets (A, B and
C), facilitates the encoding of the full 128 ASCII character set. Code 128 is one of the most
compact linear bar code symbologies. Character set C enables numeric data to be represented
in a double density mode. In this mode, two digits are represented by only one symbol
character saving valuable space. The code is concatenated. That means that multiple AIs and
their fields may be combined into a single bar code. The code is also very reliable. Code 128
symbols use two independent self-checking features which improves printing and scanning
reliability.

UCC/EAN-128 bar codes always contain a special non-data character known as function 1
(FNC 1), which follows the start character of the bar code. It enables scanners and processing
software to auto-discriminate between UCC/EAN-128 and other bar code symbologies, and
subsequently only process relevant data.

The UCC/EAN-128 bar code is made up of a leading quiet zone, a Code 128 start character A,
B, or C, a FNC 1 character, Data (Application Identifier plus data field), a symbol check
character, a stop character, and a trailing quiet zone.

UCC/EAN, UCC/128 are a couple of ways you'll hear someone refer to the code. This just
indicates that the code is structured as dictated by the application identifiers that are used.

SSCC (Serial Shipping Container Code) formatted following the data structure layout for
Application Identifier 00. See Table 8, UCC Application Identifier Table on page 93. It could
be 00 which is the SSCC code. The customer needs to let us know what application identifiers
are used for their bar code so we can help them.

There are several ways of writing the code to print the code to Application Identifier '00'
structure.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 91
^BC

Using N for the mode (m) parameter

Example 4 • This example shows with application identifier 00 structure:

ZPL II CODE N FOR THE M PARAMETER

^XA
^FO90,200^BY4
^BCN,256,Y,N,Y,N
^FD>;>80012345123451234512^FS
^XZ

• >;>8' sets it to subset C, function 1

• '00' is the application identifier followed by '17 characters', the check digit is selected
using the 'Y' for the (e) parameter to automatically print the 20th character.
• you are not limited to 19 characters with mode set to N

Using U for the mode (m) parameter

Example 5 • The example shows the application identifier 00 format:

ZPL II CODE U FOR THE M PARAMETER

^XA
^FO90,200
^BY4^BC,256,Y,N,,U
^FD0012345123451234512^FS
^XZ

UCC Case Mode

• Choosing U selects UCC Case mode. You will have exactly 19 characters available in
^FD.
• Subset C using FNC1 values are automatically selected.
• Check digit is automatically inserted.

6/8/10 Zebra Programming Guide P1012728-004

92 ZPL Commands
^BC

Using D for the mode (m) parameter

Example 6 • This example shows application identifier 00 format ((x.11.x or later):

ZPL II CODE D FOR THE M PARAMETER

^XA
^FO50,200^BCN,150,Y,N,,D
^FD(00)10084423 7449200940^FS
^XZ

(0 at end of field data is a bogus character that is inserted as a place holder for the check digit
the printer will automatically insert.
• Subset C using FNC1 values are automatically selected.
• Parentheses and spaces can be in the field data. '00' application identifier, followed by
17 characters, followed by bogus check digit place holder.
• Check digit is automatically inserted. The printer will automatically calculate the
check digit and put it into the bar code and interpretation line.
• The interpretation line will also show the parentheses and spaces but will strip them
out from the actual bar code.

Printing the Interpretation Line

Example 7 • This example shows printing the interpretation in a different font with firmware
x.11.x or later:

ZPL II CODE INTERPRETATION LINE

^XA
^FO50,200
^A0N,40,30^BCN,150,Y,N,Y
^FD>;>80012345123451234512^FS
^XZ

The font command (^A0N,40,30) can be added and changed to alter the font and size of the
interpretation line.

With firmware version later than x.10.x

• A separate text field needs to be written.
• The interpretation line needs to be turned off.
• ^A0N,50,40 is the font and size selection for the separate text field.
• You have to make sure you enter the correct check digit in the text field.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 93
^BC

• Creating a separate text field allows you to format the interpretation line with
parentheses and spaces.

ZPL II CODE FIRMWARE OLDER THAN X.10.X

^XA
^FO25,25
^BCN,150,N,N,Y
^FD>;>80012345123451234512^FS
^FO100,190
^A0N,50,40
^FD(00) 1 2345123 451234512 0^FS
^XZ

Application Identifiers — UCC/EAN APPLICATION IDENTIFIER

An Application Identifier is a prefix code used to identify the meaning and the format of the
data that follows it (data field).

There are AIs for identification, traceability, dates, quantity, measurements, locations, and
many other types of information.

For example, the AI for batch number is 10, and the batch number AI is always followed by an
alphanumeric batch code not to exceed 20-characters.

The UCC/EAN Application Identifiers provide an open standard that can be used and
understood by all companies in the trading chain, regardless of the company that originally
issued the codes.

Table 8 • UCC Application Identifier Table

Plus The Following Data

Data Content AI
Structure
Serial Shipping Container Code (SSCC) 00 exactly 18 digits
Shipping Container Code 01 exactly 14 digits
Batch Numbers 10 up to 20 alpha numerics
Production Date (YYMMDD) 11 exactly 6 digits
Packaging Date (YYMMDD) 13 exactly 6 digits
Sell By Date (YYMMDD) 15 exactly 6 digits
Expiration Date (YYMMDD) 17 exactly 6 digits
Product Variant 20 exactly 2 digits
Serial Number 21 up to 20 alpha numerics
HIBCC Quantity, Date, Batch and Link 22 up to 29 alpha numerics
a
Lot Number 23 up to 19 alpha numerics
Quantity Each 30
a. Plus one digit for length indication.
b. Plus one digit for decimal point indication.

6/8/10 Zebra Programming Guide P1012728-004

94 ZPL Commands
^BC

Table 8 • UCC Application Identifier Table (Continued)

Plus The Following Data

Data Content AI
Structure
Net Weight (Kilograms) 310 b exactly 6 digits
Length, Meters 311 b exactly 6 digits
b
Width or Diameter (Meters) 312 exactly 6 digits
b
Depths (Meters) 313 exactly 6 digits
b
Area (Sq. Meters) 314 exactly 6 digits
b
Volume (Liters) 315 exactly 6 digits
Volume (Cubic Meters) 316 b exactly 6 digits
b
Net Weight (Pounds) 320 exactly 6 digits
Customer PO Number 400 up to 29 alpha numerics
Ship To (Deliver To) Location Code using EAN 13 or DUNS 410 exactly 13 digits
Number with leading zeros
Bill To (Invoice To) Location Code using EAN 13 or DUNS 411 exactly 13 digits
Number with leading zeros
Purchase from 412 exactly 13 digits
Ship To (Deliver To) Postal Code within single postal 420 up to 9 alpha numerics
authority
Ship To (Deliver To) Postal Code with 3-digit ISO Country 421 3 digits plus up to 9 alpha numerics
Code Prefix
Roll Products - width, length, core diameter, direction and 8001 exactly 14 digits
splices
Electronic Serial number for cellular mobile phone 8002 up to 20 alpha numerics
a. Plus one digit for length indication.
b. Plus one digit for decimal point indication.

Note • Table 8 is a partial table showing the application identifiers. For more current and
complete information, search the Internet for UCC Application Identifier.

For date fields that only need to indicate a year and month, the day field is set to 00.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 95
^BC

Chaining several application identifiers (firmware x.11.x or later)

The FNC1, which is invoked by >8, is inserted just before the AI's so that the scanners reading
the code sees the FNC1 and knows that an AI follows.

Example 8 • This is an example with the mode parameter set to A (automatic):

^XA
^BY2,2.5,193
^FO33,400
^BCN,,N,N,N,A
^FD>;>80204017773003486100008535>8910001>837252^FS
^FT33,625^AEN,0,0^FD(02)04017773003486(10)0008535(91)
0001(37)252^FS
^XZ

Example 9 • This is an example with the mode parameter set to U:

^XA
^BY3,2.5,193
^FO33,200
^BCN,,N,N,N,U
^FD>;>80204017773003486>8100008535>8910001>837252^FS
^FT33,455^A0N,30,30^FD(02)04017773003486(10)0008535(9
1)0001(37)252^FS
^XZ

Example 10 • This is an example with the mode parameter set to D*:

^XA
^PON
^LH0,0
^BY2,2.5,145
^FO218,343
^BCB,,Y,N,N,D
^FD(91)0005886>8(10)0000410549>8(99)05^FS
^XZ
D* — When trying to print the last Application Identifier with an odd number of characters,
a problem existed when printing EAN128 bar codes using Mode D. The problem was fixed
in firmware version V60.13.0.6.

6/8/10 Zebra Programming Guide P1012728-004

96 ZPL Commands
^BD

^BD
UPS MaxiCode Bar Code
Description The ^BD command creates a two-dimensional, optically read (not scanned)
code. This symbology was developed by UPS (United Parcel Service).

Notice that there are no additional parameters for this code and it does not generate an
interpretation line. The ^BY command has no effect on the UPS MaxiCode bar code.
However, the ^CV command can be activated.

Format ^BDm,n,t

Parameters Details
m = mode Accepted Values:
2 = structured carrier message: numeric postal code (U.S.)
3 = structured carrier message: alphanumeric postal code (non-U.S.)
4 = standard symbol, secretary
5 = full EEC
6 = reader program, secretary
Default Value: 2
n = symbol number Accepted Values: 1 to 8 can be added in a structured document
Default Value: 1
t = total number of Accepted Values: 1 to 8, representing the total number of symbols in this
symbols sequence
Default Value: 1

Example • This is an example of UPS MAXICODE - MODE 2 bar code:

ZPL II CODE UPS MAXICODE - MODE 2

^XA
^FO50,50
^CVY
^BD^FH^FD001840152382802
[)>_1E01_1D961Z00004951_1DUPSN_
1D_06X610_1D159_1D1234567_1D1/1_
1D_1DY_1D634 ALPHA DR_
1DPITTSBURGH_1DPA_1E_04^FS
^FO30,300^A0,30,30^FDMode2^FS
^XZ

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 97
^BD

Special Considerations for ^FD when Using ^BD

The ^FD statement is divided into two parts: a high priority message (hpm) and a low priority
message (lpm). There are two types of high priority messages. One is for a U.S. Style Postal
Code; the other is for a non-U.S. Style Postal Code. The syntax for either of these high priority
messages must be exactly as shown or an error message is generated.

Format ^FD <hpm><lpm>

This table identifies the parameters for this format:

Parameters Details
<hpm> = high priority Accepted Values: 0 to 9, except where noted
message (applicable U.S. Style Postal Code (Mode 2)
only in Modes 2 and <hpm> = aaabbbcccccdddd
3)
aaa = three-digit class of service
bbb = three-digit country zip code
ccccc = five-digit zip code
dddd = four-digit zip code extension (if none exists, four zeros (0000)
must be entered)
non-U.S. Style Postal Code (Mode 3)
<hpm> = aaabbbcccccc
aaa = three-digit class of service
bbb = three-digit country zip code
ccccc = six-digit zip code (A through Z or 0 to 9)
<lpm> = low priority GS is used to separate fields in a message (0x1D). RS is used to separate format
message (only types (0x1E). EOT is the end of transmission characters.
applicable in Modes Message Header [)>RS
2 and 3)
Transportation Data
Format Header 01GS96
Tracking Number* <tracking number>
SCAC* GS<SCAC>
UPS Shipper Number GS<shipper number>
Julian Day of Pickup GS<day of pickup>
Shipment ID Number GS<shipment ID number>
Package n/x GS<n/x>
Package Weight GS<weight>
Address Validation GS<validation>
Ship to Street Address GS<street address>
Ship to City GS<city>
Ship to State GS<state>
RS RS
End of Message EOT
(* Mandatory Data for UPS)

6/8/10 Zebra Programming Guide P1012728-004

98 ZPL Commands
^BD

Comments
• The formatting of <hpm> and <lpm> apply only when using Modes 2 and 3.
Mode 4, for example, takes whatever data is defined in the ^FD command and places it in
the symbol.
• UPS requires that certain data be present in a defined manner. When formatting MaxiCode
data for UPS, always use uppercase characters. When filling in the fields in the <lpm> for
UPS, follow the data size and types specified in Guide to Bar Coding with UPS.
• If you do not choose a mode, the default is Mode 2. If you use non-U.S. Postal Codes, you
probably get an error message (invalid character or message too short). When using non-
U.S. codes, use Mode 3.
• ZPL II doesn’t automatically change your mode based on the zip code format.
• When using special characters, such as GS, RS, or EOT, use the ^FH command to tell
ZPL II to use the hexadecimal value following the underscore character ( _ ).

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 99
^BE

^BE
EAN-13 Bar Code
Description The ^BE command is similar to the UPC-A bar code. It is widely used
throughout Europe and Japan in the retail marketplace.

The EAN-13 bar code has 12 data characters, one more data character than the UPC-A code.
An EAN-13 symbol contains the same number of bars as the UPC-A, but encodes a 13th digit
into a parity pattern of the left-hand six digits. This 13th digit, in combination with the 12th
digit, represents a country code.
• ^BE supports fixed print ratios.
• Field data (^FD) is limited to exactly 12 characters. ZPL II automatically truncates or
pads on the left with zeros to achieve the required number of characters.
• When using JAN-13 (Japanese Article Numbering), a specialized application of EAN-13,
the first two non-zero digits sent to the printer must be 49.

Format ^BEo,h,f,g

Note • Use Interleaved 2 of 5 for UCC and EAN 14.

Important • If additional information about the EAN-13 bar code is required, go to

www.aimglobal.org.

Parameters Details
o = orientation Accepted Values:
N = normal
R = rotated 90 degrees (clockwise)
I = inverted 180 degrees
B = read from bottom up, 270 degrees
Default Value: current ^FW value
h = bar code height (in Accepted Values: 1 to 32000
dots) Default Value: value set by ^BY
f = print interpretation Accepted Values:
line N = no
Y = yes
Default Value: Y
g = print interpretation Accepted Values:
line above code N = no
Y = yes
Default Value: N

6/8/10 Zebra Programming Guide P1012728-004

100 ZPL Commands
^BE

Example • This is an example of an EAN-13 bar code:

ZPL II CODE EAN-13 BAR CODE

^XA
^FO100,100^BY3
^BEN,100,Y,N
^FD12345678^FS
^XZ

EAN-13 BAR CODE CHARACTERS

0 1 2 3 4 5 6 7 8 9

Comments The EAN-13 bar code uses the Mod 10 check-digit scheme for error checking.
For more information on Mod 10, see Mod 10 Check Digit on page 974.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 101
^BF

^BF
MicroPDF417 Bar Code
Description The ^BF command creates a two-dimensional, multi-row, continuous, stacked
symbology identical to PDF417, except it replaces the 17-module-wide start and stop patterns
and left/right row indicators with a unique set of 10-module-wide row address patterns. These
reduce overall symbol width and allow linear scanning at row heights as low as 2X.

MicroPDF417 is designed for applications with a need for improved area efficiency but
without the requirement for PDF417’s maximum data capacity. It can be printed only in
specific combinations of rows and columns up to a maximum of four data columns by 44
rows.

Field data (^FD) and field hexadecimal (^FH) are limited to:
• 250 7-bit characters
• 150 8-bit characters
• 366 4-bit numeric characters

Format ^BFo,h,m

Parameters Details
o = orientation Accepted Values:
N = normal
R = rotated 90 degrees (clockwise)
I = inverted 180 degrees
B = read from bottom up, 270 degrees
Default Value: current ^FW value
h = bar code height (in Accepted Values: 1 to 9999
dots) Default Value: value set by ^BY or 10 (if no ^BY value exists).
m = mode Accepted Values: 0 to 33 (see Table 9, MicroPDF417 Mode on page 102)
Default Value: 0 (see Table 9)

Example • This is an example of a MicroPDF417 bar code:

ZPL II CODE MICRO-PDF417 BAR CODE

^XA
^FO100,100^BY6
^BFN,8,3
^FDABCDEFGHIJKLMNOPQRSTUV^FS
^XZ

6/8/10 Zebra Programming Guide P1012728-004

102 ZPL Commands
^BF

To encode data into a MicroPDF417 bar code, complete these steps:

1. Determine the type of data to be encoded (for example, ASCII characters, numbers, 8-bit
data, or a combination).

2. Determine the maximum amount of data to be encoded within the bar code (for example,
number of ASCII characters, quantity of numbers, or quantity of 8-bit data characters).

3. Determine the percentage of check digits that are used within the bar code. The higher the
percentage of check digits that are used, the more resistant the bar code is to damage —
however, the size of the bar code increases.

4. Use Table 9, MicroPDF417 Mode on page 102 with the information gathered from the
questions above to select the mode of the bar code.

Table 9 • MicroPDF417 Mode

Mode Number Number % of Max Max

(M) of Data of Data Cws for Alpha Digits
Columns Rows EC Characters
0 1 11 64 6 8
1 1 14 50 12 17
2 1 17 41 18 26
3 1 20 40 22 32
4 1 24 33 30 44
5 1 28 29 38 55
6 2 8 50 14 20
7 2 11 41 24 35
8 2 14 32 36 52
9 2 17 29 46 67
10 2 20 28 56 82
11 2 23 28 64 93
12 2 26 29 72 105
13 3 6 67 10 14
14 3 8 58 18 26
15 3 10 53 26 38
16 3 12 50 34 49
17 3 15 47 46 67
18 3 20 43 66 96
19 3 26 41 90 132
20 3 32 40 114 167
21 3 38 39 138 202
22 3 44 38 162 237
23 4 6 50 22 32
24 4 8 44 34 49
25 4 10 40 46 67
26 4 12 38 58 85
27 4 15 35 76 111
28 4 20 33 106 155
29 4 26 31 142 208
30 4 32 30 178 261
31 4 38 29 214 313
32 4 44 28 250 366
33 4 4 50 14 20

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 103
^BI

^BI
Industrial 2 of 5 Bar Codes
Description The ^BI command is a discrete, self-checking, continuous numeric
symbology. The Industrial 2 of 5 bar code has been in use the longest of the 2 of 5 family of
bar codes. Of that family, the Standard 2 of 5 (^BJ) and Interleaved 2 of 5 (^B2) bar codes are
also available in ZPL II.

With Industrial 2 of 5, all of the information is contained in the bars. Two bar widths are
employed in this code, the wide bar measuring three times the width of the narrow bar.
• ^BI supports a print ratio of 2.0:1 to 3.0:1.
• Field data (^FD) is limited to the width (or length, if rotated) of the label.

Format ^BIo,h,f,g

Important • If additional information about the Industrial 2 of 5 bar code, go to

www.aimglobal.org.

Parameters Details
o = orientation Accepted Values:
N = normal
R = rotated 90 degrees (clockwise)
I = inverted 180 degrees
B = read from bottom up, 270 degrees
Default Value: current ^FW value
h = bar code height (in Accepted Values: 1 to 32000
dots) Default Value: value set by ^BY
f = print interpretation Accepted Values:
line N = no
Y = yes
Default Value: Y
g = print interpretation Accepted Values:
line above code N = no
Y = yes
Default Value: N

6/8/10 Zebra Programming Guide P1012728-004

104 ZPL Commands
^BI

Example • This is an example of an Industrial 2 of 5 bar code:

ZPL II CODE INDUSTRIAL 2 OF 5 BAR CODE

^XA
^FO100,100^BY3
^BIN,150,Y,N
^FD123456^FS
^XZ

INDUSTRIAL 2 OF 5 BAR CODE CHARACTERS

0 1 2 3 4 5 6 7 8 9
Start/Stop (internal)

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 105
^BJ

^BJ
Standard 2 of 5 Bar Code
Description The ^BJ command is a discrete, self-checking, continuous numeric
symbology.

With Standard 2 of 5, all of the information is contained in the bars. Two bar widths are
employed in this code, the wide bar measuring three times the width of the narrow bar.
• ^BJ supports a print ratio of 2.0:1 to 3.0:1.
• Field data (^FD) is limited to the width (or length, if rotated) of the label.

Format ^BJo,h,f,g

Important • If additional information about the Standard 2 of 5 bar code is required, go to

www.aimglobal.org.

Parameters Details
o = orientation Accepted Values:
N = normal
R = rotated 90 degrees (clockwise)
I = inverted 180 degrees
B = read from bottom up, 270 degrees
Default Value: current ^FW value
h = bar code height (in Accepted Values: 1 to 32000
dots) Default Value: value set by ^BY
f = print interpretation Accepted Values:
line N = no
Y = yes
Default Value: Y
g = print interpretation Accepted Values:
line above code N = no
Y = yes
Default Value: N

6/8/10 Zebra Programming Guide P1012728-004

106 ZPL Commands
^BJ

Example • This is an example of a Standard 2 of 5 bar code:

ZPL II CODE STANDARD 2 OF 5 BAR CODE

^XA
^FO100,100^BY3
^BJN,150,Y,N
^FD123456^FS
^XZ

STANDARD 2 OF 5 BAR CODE CHARACTERS

0 1 2 3 4 5 6 7 8 9
Start/Stop (automatic)

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 107
^BK

^BK
ANSI Codabar Bar Code
Description The ANSI Codabar bar code is used in a variety of information processing
applications such as libraries, the medical industry, and overnight package delivery companies.
This bar code is also known as USD-4 code, NW-7, and 2 of 7 code. It was originally
developed for retail price labeling.

Each character in this code is composed of seven elements: four bars and three spaces.
Codabar bar codes use two character sets, numeric and control (start and stop) characters.
• ^BK supports a print ratio of 2.0:1 to 3.0:1.
• Field data (^FD) is limited to the width (or length, if rotated) of the label.

Format ^BKo,e,h,f,g,k,l

Important • If additional information about the ANSI Codabar bar code is required, go to
www.aimglobal.org.

Parameters Details
o = orientation Accepted Values:
N = normal
R = rotated 90 degrees (clockwise)
I = inverted 180 degrees
B = read from bottom up, 270 degrees
Default Value: current ^FW value
e = check digit Fixed Value: N
h = bar code height (in Accepted Values: 1 to 32000
dots) Default Value: value set by ^BY
f = print interpretation Accepted Values:
line N = no
Y = yes
Default Value: Y
g = print interpretation Accepted Values:
line above code N = no
Y = yes
Default Value: N
k = designates a start Accepted Values: A,B, C, D
character Default Value: A
l = designates stop Accepted Values: A,B, C, D
character Default Value: A

6/8/10 Zebra Programming Guide P1012728-004

108 ZPL Commands
^BK

Example • This is an example of an ANSI Codabar bar code:

ZPL II CODE ANSI CODABAR BAR CODE

^XA
^FO100,100^BY3
^BKN,N,150,Y,N,A,A
^FD123456^FS
^XZ

ANSI CODABAR BAR CODE CHARACTERS

0 1 2 3 4 5 6 7 8 9
Control Characters
- : . $ / +
Start/Stop Characters
A B C D

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 109
^BL

^BL
LOGMARS Bar Code
Description The ^BL command is a special application of Code 39 used by the Department
of Defense. LOGMARS is an acronym for Logistics Applications of Automated Marking and
Reading Symbols.
• ^BL supports a print ratio of 2.0:1 to 3.0:1.
• Field data (^FD) is limited to the width (or length, if rotated) of the label. Lowercase
letters in the ^FD string are converted to the supported uppercase LOGMARS
characters.

Format ^BLo,h,g

Important • If additional information about the LOGMARS bar code is required, go to

www.aimglobal.org.

Parameters Details
o = orientation Accepted Values:
N = normal
R = rotated 90 degrees (clockwise)
I = inverted 180 degrees
B = read from bottom up, 270 degrees
Default Value: current ^FW value
h = bar code height (in Accepted Values: 1 to 32000
dots) Default Value: value set by ^BY
g = print interpretation Accepted Values:
line above code N = no
Y = yes
Default Value: N

6/8/10 Zebra Programming Guide P1012728-004

110 ZPL Commands
^BL

Example • This is an example of a LOGMARS bar code:

ZPL II CODE LOGMARS BAR CODE

^XA
^FO100,75^BY3
^BLN,100,N
^FD12AB^FS
^XZ

LOGMARS BAR CODE CHARACTERS

0 1 2 3 4 5 6 7 8 9
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
- . $ / + %
SPACE

Comments The LOGMARS bar code produces a mandatory check digit using
Mod 43 calculations. For further information on the Mod 43 check digit, see
Mod 43 Check Digit on page 975.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 111
^BM

^BM
MSI Bar Code
Description The ^BM command is a pulse-width modulated, continuous, non-self-
checking symbology. It is a variant of the Plessey bar code (^BP).

Each character in the MSI bar code is composed of eight elements: four bars and four adjacent
spaces.
• ^BM supports a print ratio of 2.0:1 to 3.0:1.
• For the bar code to be valid, field data (^FD) is limited to 1 to 14 digits when
parameter e is B, C, or D. ^FD is limited to 1 to 13 digits when parameter e is A, plus
a quiet zone.

Format ^BMo,e,h,f,g,e2

Important • If additional information about the MSI bar code is required, go to

www.aimglobal.org.

Parameters Details
o = orientation Accepted Values:
N = normal
R = rotated 90 degrees (clockwise)
I = inverted 180 degrees
B = read from bottom up, 270 degrees
Default Value: current ^FW value
e = check digit selection Accepted Values:
A = no check digits
B = 1 Mod 10
C = 2 Mod 10
D = 1 Mod 11 and 1 Mod 10
Default Value: B
h = bar code height (in Accepted Values: 1 to 32000
dots) Default Value: value set by ^BY
f = print interpretation Accepted Values:
line N = no
Y = yes
Default Value: Y
g = print interpretation Accepted Values:
line above code N = no
Y = yes
Default Value: N

6/8/10 Zebra Programming Guide P1012728-004

112 ZPL Commands
^BM

Parameters Details
e2 = inserts check digit Accepted Values:
into the interpretation N = no
line Y = yes
Default Value: N

Example • This is an example of a MSI bar code:

ZPL II CODE MSI BAR CODE

^XA
^FO100,100^BY3
^BMN,B,100,Y,N,N
^FD123456^FS
^XZ

MSI BAR CODE CHARACTERS

1 2 3 4 5 6 7 8 9

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 113
^BO

^BO
Aztec Bar Code Parameters
Description The ^BO command creates a two-dimensional matrix symbology made up of
square modules arranged around a bulls-eye pattern at the center.

Note • The Aztec bar code works with firmware version V60.13.0.11A and V50.13.2 or later.

Format ^BOa,b,c,d,e,f,g

Parameters Details
a = orientation Accepted Values:
N = normal
R = rotated
I = inverted 180 degrees
B = read from bottom up, 270 degrees
Default Value: current ^FW value
b = magnification factor Accepted Values: 1 to 10
Default Value:
1 on 150 dpi printers
2 on 200 dpi printers
3 on 300 dpi printers
6 on 600 dpi printers
c = extended channel Accepted Values:
interpretation code Y = if data contains ECICs
indicator N = if data does not contain ECICs.
Default Value: N
d = error control and Accepted Values:
symbol size/type 0 = default error correction level
indicator 01 to 99 = error correction percentage (minimum)
101 to 104 = 1 to 4-layer compact symbol
201 to 232 = 1 to 32-layer full-range symbol
300 = a simple Aztec “Rune”
Default Value: 0
e = menu symbol Accepted Values:
indicator Y = if this symbol is to be a menu (bar code reader initialization) symbol
N = if it is not a menu symbol
Default Value: N
f = number of symbols Accepted Values: 1 through 26
for structured append Default Value: 1

6/8/10 Zebra Programming Guide P1012728-004

114 ZPL Commands
^BO

Parameters Details
g = optional ID field for The ID field is a text string with 24-character maximum
structured append Default Value: no ID

Example • This is an example of the ^B0 command:

ZPL II CODE GENERATED LABEL

^XA
^B0R,7,N,0,N,1,0
^FD 7. This is testing label 7^FS
^XZ

P1012728-004 Zebra Programming Guide 6/8/10

 115
^BP

^BP
Plessey Bar Code
Description The ^BP command is a pulse-width modulated, continuous, non-self-
checking symbology.

Each character in the Plessey bar code is composed of eight elements: four bars and four
adjacent spaces.
• ^BP supports a print ratio of 2.0:1 to 3.0:1.
• Field data (^FD) is limited to the width (or length, if rotated) of the label.

Format ^BPo,e,h,f,g

Important • If additional information about the Plessey bar code is required, go to

www.aimglobal.org.

Parameters Details
o = orientation Accepted Values:
N = normal
R = rotated 90 degrees (clockwise)
I = inverted 180 degrees
B = read from bottom up, 270 degrees
Default Value: current ^FW value
e = print check digit Accepted Values:
N = no
Y = yes
Default Value: N
h = bar code height (in Accepted Values:
dots) N = no
Y = yes
Default Value: N
f = print interpretation Accepted Values:
line N = no
Y = yes
Default Value: Y
g = print interpretation Accepted Values:
line above code N = no
Y = yes
Default Value: N

6/8/10 Zebra Programming Guide P1012728-004

116 ZPL Commands
^BP

Example • This is an example of a Plessey bar code:

ZPL II CODE PLESSEY BAR CODE

^XA
^FO100,100^BY3
^BPN,N,100,Y,N
^FD12345^FS
^XZ

PLESSEY BAR CODE CHARACTERS

0 1 2 3 4 5 6 7 8 9
A B C D E F

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 117
^BQ

^BQ
QR Code Bar Code
Description The ^BQ command produces a matrix symbology consisting of an array of
nominally square modules arranged in an overall square pattern. A unique pattern at three of
the symbol’s four corners assists in determining bar code size, position, and inclination.

A wide range of symbol sizes is possible, along with four levels of error correction. User-
specified module dimensions provide a wide variety of symbol production techniques.

QR Code Model 1 is the original specification, while QR Code Model 2 is an enhanced form
of the symbology. Model 2 provides additional features and can be automatically differentiated
from Model 1.

Model 2 is the recommended model and should normally be used.

This bar code is printed using field data specified in a subsequent ^FD string.

Encodable character sets include numeric data, alphanumeric data, 8-bit byte data, and Kanji
characters.

Format ^BQa,b,c,d,e

Important • If additional information about the QR Code bar code is required, go to

www.aimglobal.org.

Parameters Details
a = field orientation Fixed Value: normal (^FW has no effect on rotation)
b = model Accepted Values: 1 (original) and 2 (enhanced – recommended)
Default Value: 2
c = magnification factor Accepted Values: 1 to 10
Default Value:
1 on 150 dpi printers
2 on 200 dpi printers
3 on 300 dpi printers
6 on 600 dpi printers
d = H,Q,M,L Accepted Values:
H = ultra-high reliability level
Q = high reliability level
M = standard level
L = high density level
Default Value:
Q = if empty
M = invalid values

6/8/10 Zebra Programming Guide P1012728-004

118 ZPL Commands
^BQ

Parameters Details
e = N,A,B.K Accepted Values: 1 - 7
Default Value: 7

Example 1 •This is an example of a QR Code bar code:

ZPL II CODE QR CODE BAR CODE

^XA
^FO100,100
^BQN,2,10
^FDMM,AAC-42^FS
^XZ

On the pages that follow are specific commands for formatting the ^BQ command with the
^FD statements that contain the information to be coded.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 119
^BQ

Considerations for ^FD When Using the QR Code:

QR Switches (formatted into the ^FD field data)

mixed mode <D>

D = allows mixing of different types of character modes in one code.
code No. <01 16>
Value = subtracted from the Nth number of the divided code (must be two digits).

No. of divisions <02 16>

Number of divisions (must be two digits).

parity data <1 byte>

Parity data value is obtained by calculating at the input data (the original input data before
divided byte-by-byte through the EX-OR operation).

error correction level <H, Q, M, L>

H = ultra-high reliability level
Q = high reliability level
M = standard level (default)
L = high density level

character Mode <N, A, B, K>

N = numeric
A = alphanumeric
Bxxxx = 8-bit byte mode. This handles the 8-bit Latin/Kana character set in accordance
with JIS X 0201 (character values 0x00 to 0xFF).
xxxx = number of data characters is represented by two bytes of BCD code.
K = Kanji — handles only Kanji characters in accordance with the Shift JIS system
based on JIS X 0208. This means that all parameters after the character mode K should be
16-bit characters. If there are any 8-bit characters (such as ASCII code), an error occurs.

data character string <Data>

Follows character mode or it is the last switch in the ^FD statement.

data input <A, M>

A = Automatic Input (default). Data character string JIS8 unit, Shift JIS. When the input
mode is Automatic Input, the binary codes of 0x80 to 0x9F and 0xE0 to 0xFF cannot be
set.
M = Manual Input

Two types of data input mode exist: Automatic (A) and Manual (M). If A is specified, the
character mode does not need to be specified. If M is specified, the character mode must be
specified.

6/8/10 Zebra Programming Guide P1012728-004

120 ZPL Commands
^BQ

^FD Field Data (Normal Mode)

Automatic Data Input (A) with Switches
^FD
<error correction level>A,
<data character string>
^FS

Example 1 •QR Code, normal mode with automatic data input.

^XA
^FO20,20^BQ,2,10^FDQA,0123456789ABCD 2D code^FS
^XZ

1 2 3

1 Q = error correction level

2 A, = automatic setting
3 data string character

Manual Data Input (M) with Switches

^FD
<error correction level>M,
<character mode><data character string>
^FS

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 121
^BQ

Example 2 •QR Code, normal mode with manual data input:

ZPL II CODE GENERATED LABEL

^XA
^FO20,20^BQ,2,10
^FDHM,N123456789012345^FS
^XZ

1 4
3
2

1 H = error correction level (ultra-high reliability level

2 M, = input mode (manual input)
3 N = character mode (numeric data)
4 data character string

Example 3 •QR Code, normal mode with standard reliability and manual data input:

ZPL II CODE GENERATED LABEL

^XA
^FO20,20^BQ,2,10^FDMM,AAC-42^FS
^XZ

1 2 3 4

1 M = error correction level (standard-high reliability level

2 M, = manual input
3 A = alphanumeric data
4 AC-42 = data character string

6/8/10 Zebra Programming Guide P1012728-004

122 ZPL Commands
^BQ

^FD Field Data (Mixed Mode – requires more switches)

Automatic Data Input (A) with Switches

^FD
<D><code No.> <No. of divisions> <parity data>,
<error correction level> A,
<data character string>,
<data character string>,
< : >,
<data character string n**>
^FS

Manual Data Input (M) with Switches

^FD
<code No.> <No. of divisions> <parity data>,
<error correction level> M,
<character mode 1> <data character string 1>,
<character mode 2> <data character string 2>,
< : > < : >,
<character mode n> <data character string n**>
^FS

n** up to 200 in mixed mode

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 123
^BQ

Example • QR Code, mixed mode with manual data input:

ZPL II CODE GENERATED LABEL

^XA
^FO,20,20^BQ,2,10
^FDD03048F,LM,N0123456789,A12AABB,B0006qrcode^FS
^XZ

<mixed mode identifier> D (mixed)

<code No.> M (code number)

<No. of divisions> D (divisions)

<parity data> M (0x0C)

<error correction level> L (high-density level)

<input mode> M (manual input)

<character mode> N (numeric data)

<data character string> 0123456789

<character mode> A (alphanumeric data)

<data character string> 12AABB

<character mode> B (8-bit byte data)

0006 (number of bytes)

<data character string> qrcode

6/8/10 Zebra Programming Guide P1012728-004

124 ZPL Commands
^BQ

Example • This is an example of QR Code, mixed mode with automatic data input:
^XA
^FO20,20^BQ,2,10
^FDD03040C,LA,012345678912AABBqrcode^FS
^XZ

<mixed mode identifier> D (mixed)

<code No.> M (code number)

<No. of divisions> D (divisions)

<parity data> M (0x0C)

<error correction level> L (high-density level)

<input mode> A (automatic input)

<data character string> 012345678912AABBqrcode

For proper functionality, when encoding Kanji characters in ^CI28-30 (Unicode) be sure
the JIS.DAT table is loaded on the printer and specified.

Example • This is a Unicode example:

ZPL II CODE GENERATED LABEL

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 125
^BR

^BR
GS1 Databar (formerly Reduced Space Symbology)
Description The ^BR command is bar code types for space-constrained identification from
EAN International and the Uniform Code Council, Inc.

Format ^BRa,b,c,d,e,f

Parameters Details
a = orientation Accepted Values:
N = Normal
R = Rotated
I = Inverted
B = Bottom-up
Default Value: R
b = symbology type in Accepted Values:
the GS1 DataBar 1 = GS1 DataBar Omnidirectional
family 2 = GS1 DataBar Truncated
3 = GS1 DataBar Stacked
4 = GS1 DataBar Stacked Omnidirectional
5 = GS1 DataBar Limited
6 = GS1 DataBar Expanded
7 = UPC-A
8 = UPC-E
9 = EAN-13
10 = EAN-8
11 = UCC/EAN-128 and CC-A/B
12 = UCC/EAN-128 and CC-C
Default Value: 1
c = magnification factor Accepted Values: 1 to 10
Default Value:
24 dot = 6, 12 dot is 3, 8 dot and lower is 2
12 dot = 6, > 8 dot is 3, 8 dot and less is 2
d = separator height Accepted Values: 1 or 2
Default Value: 1
e = bar code height The bar code height only affects the linear portion of the bar code. Only
UCC/EAN and CC-A/B/C.
Accepted Values: 1 to 32000 dots
Default Value: 25
f = the segment width Accepted Values: 2 to 22, even numbers only, in segments per line
(GS1 DataBar Default Value: 22
Expanded only)

6/8/10 Zebra Programming Guide P1012728-004

126 ZPL Commands
^BR

Example 1 •This is an example of Symbology Type 7 - UPC-A:

ZPL II CODE GENERATED LABEL

^XA
^FO10,10^BRN,7,5,2,100
^FD12345678901|this is composite info^FS
^XZ

Example 2 •This is an example of Symbology Type 1 - GS1 DataBar Omnidirectional:

ZPL II CODE GENERATED LABEL

^XA
^FO10,10^BRN,1,5,2,100
^FD12345678901|this is composite info^FS
^XZ

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 127
^BS

^BS
UPC/EAN Extensions
Description The ^BS command is the two-digit and five-digit add-on used primarily by
publishers to create bar codes for ISBNs (International Standard Book Numbers). These
extensions are handled as separate bar codes.

The ^BS command is designed to be used with the UPC-A bar code (^BU) and the UPC-E bar
code (^B9).
• ^BS supports a fixed print ratio.
• Field data (^FD) is limited to exactly two or five characters. ZPL II automatically
truncates or pads on the left with zeros to achieve the required number of characters.

Format ^BSo,h,f,g

Important • If additional information about the UPC/EAN bar code is required, go to

www.aimglobal.org.

Parameters Details
o = orientation Accepted Values:
N = normal
R = rotated 90 degrees (clockwise)
I = inverted 180 degrees
B = read from bottom up, 270 degrees
Default Value: current ^FW value
h = bar code height (in Accepted Values: 1 to 32000
dots) Default Value: value set by ^BY
f = print interpretation Accepted Values:
line N = no
Y = yes
Default Value: Y
g = print interpretation Accepted Values:
line above code N = no
Y = yes
Default Value: Y

6/8/10 Zebra Programming Guide P1012728-004

128 ZPL Commands
^BS

Example 1 •This is an example of a UPC/EAN Two-digit bar code:

ZPL II CODE UPC/EAN 2-DIGIT BAR CODE

^XA
^FO100,100^BY3
^BSN,100,Y,N
^FD12^FS
^XZ

UPC/EAN 2-DIGIT BAR CODE CHARACTERS

0 1 2 3 4 5 6 7 8 9

Example 2 •This is an example of a UPC/EAN Five-digit bar code:

ZPL II CODE UPC/EAN 5-DIGIT BAR CODE

^XA
^FO100,100^BY3
^BSN,100,Y,N
^FD12345^FS
^XZ

UPC/EAN 5-DIGIT BAR CODE CHARACTERS

0 1 2 3 4 5 6 7 8 9

Care should be taken in positioning the UPC/EAN extension with respect to the
UPC-A or UPC-E code to ensure the resulting composite code is within the UPC specification.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 129
^BS

For UPC codes, with a module width of 2 (default), the field origin offsets for the extension
are:

Example 3 •This is an example of a UPC-A:

Supplement Origin Adjustment

X - Offset Y - Offset
Normal 209 Dots 21 Dots
Rotated 0 209 Dots

This is an example of a UPC-E:

Supplement Origin Adjustment

X - Offset Y - Offset
Normal 122 Dots 21 Dots
Rotated 0 122 Dots

Additionally, the bar code height for the extension should be 27 dots (0.135 inches) shorter
than that of the primary code. A primary UPC code height of 183 dots (0.900 inches) requires
an extension height of 155 dots (0.765 inches).

Example 4 •This example illustrates how to create a normal UPC-A bar code for the value
7000002198 with an extension equal to 04414:

ZPL II CODE UPC-A BAR CODE WITH EXTENSION

^XA
^FO100,100^BY3
^BUN,137
^FD07000002198^FS
^FO400,121
^BSN,117
^FD04414^FS
^XZ

6/8/10 Zebra Programming Guide P1012728-004

130 ZPL Commands
^BT

^BT
TLC39 Bar Code
Description The ^BT bar code is the standard for the TCIF can tag telecommunications
equipment.

The TCIF CLEI code, which is the MicroPDF417 bar code, is always four columns. The
firmware must determine what mode to use based on the number of characters to be encoded.

Format ^BTo,w1,r1,h1,w2,h2

Parameters Details
o = orientation Accepted Values:
N = normal
R = rotated
I = inverted
B = bottom up
w1 = width of the Code Accepted Value (in dots): 1 to 10
39 bar code Default Value (600 dpi printers): 4
Default Value (200- and 300 dpi printer): 2
r1 = wide to narrow bar Accepted Values: 2.0 to 3.0(increments of 0.1)
width ratio the Code Default Value: 2.0
39 bar code
h1 = height of the Code Accepted Values (in dots): 1 to 9999
39 bar code Default Value (600 dpi printer): 120
Default Value (300 dpi printer): 60
Default Value (200 dpi printer): 40
h2 = row height of the Accepted Values (in dots): 1 to 255
MicroPDF417 bar Default Value (600 dpi printer): 8
code
Default Value (200- and 300 dpi printers): 4
w2 = narrow bar width of Accepted Values (in dots): 1 to 10
the Default Value (600 dpi printer): 4
MicroPDF417 bar
Default Value (200- and 300 dpi printers): 2
code

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 131
^BT

Example • TLC39 Bar Code

This is an example on how to print TLC39 bar code. The callouts identify the key
components and are followed by a detailed description below:

Use the command defaults to get results that are in compliance with TCIF industry standards;
regardless of printhead density.

1 2

1 ECI Number. If the seventh character is not a comma, only Code 39 prints. This
means if more than 6 digits are present, Code 39 prints for the first six digits (and no
Micro-PDF symbol is printed).
• Must be 6 digits.
• Firmware generates invalid character error if the firmware sees anything but
6 digits.
• This number is not padded.
2 Serial number. The serial number can contain up to 25 characters and is variable
length. The serial number is stored in the Micro-PDF symbol. If a comma follows
the serial number, then additional data is used below.
• If present, must be alphanumeric (letters and numbers, no punctuation).
This value is used if a comma follows the ECI number.
3 Additional data. If present, it is used for things such as a country code.
Data cannot exceed 150 bytes. This includes serial number commas.
• Additional data is stored in the Micro-PDF symbol and appended after the
serial number. A comma must exist between each maximum of 25 characters
in the additional fields.
• Additional data fields can contain up to 25 alphanumeric characters per field.
The result is:

ZPL II CODE GENERATED LABEL

^XA^FO100,
100^BT^FD123456,
ABCd12345678901234,
5551212,
88899
^FS^XZ

6/8/10 Zebra Programming Guide P1012728-004

132 ZPL Commands
^BU

^BU
UPC-A Bar Code
Description The ^BU command produces a fixed length, numeric symbology. It is
primarily used in the retail industry for labeling packages. The UPC-A bar code has 11 data
characters. The 6 dot/mm, 12 dot/mm, and 24 dot/mm printheads produce the UPC-A bar code
(UPC/EAN symbologies) at 100 percent size. However, an 8 dot/mm printhead produces the
UPC/EAN symbologies at a magnification factor of 77 percent.
• ^BU supports a fixed print ratio.
• Field data (^FD) is limited to exactly 11 characters. ZPL II automatically truncates or
pads on the left with zeros to achieve required number of characters.

Format ^BUo,h,f,g,e
Important • If additional information about the UPC-A bar code is required, go to
www.aimglobal.org.

Parameters Details
o = orientation Accepted Values:
N = normal
R = rotated 90 degrees (clockwise)
I = inverted 180 degrees
B = read from bottom up, 270 degrees
Default Value: current ^FW value
h = bar code height (in Accepted Values: 1 to 9999
dots) Default Value: value set by ^BY
f = print interpretation Accepted Values:
line N = no
Y = yes
Default Value: Y
g = print interpretation Accepted Values:
line above code N = no
Y = yes
Default Value: N
e = print check digit Accepted Values:
N = no
Y = yes
Default Value: Y

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 133
^BU

The font style of the interpretation line depends on the modulus (width of narrow bar) selected
in ^BY:

Note • Zero is not allowed.

• 6 dot/mm printer: a modulus of 2 dots or greater prints with an OCR-B interpretation

line; a modulus of 1 dot prints font A.
• 8 dot/mm printer: a modulus of 3 dots or greater prints with an OCR-B interpretation
line; a modulus of 1 or 2 dots prints font A.
• 12 dot/mm printer: a modulus of 5 dots or greater prints with an OCR-B interpretation
line; a modulus of 1, 2, 3, or 4 dots prints font A.
• 24 dot/mm printer: a modulus of 9 dots or greater prints with an OCR-B interpretation
line; a modulus of 1 to 8 dots prints font A.

Example • This is an example of a UPC-A bar code with extension:

ZPL II CODE UPC-A BAR CODE WITH EXTENSION

^XA
^FO100,100^BY3
^BUN,137
^FD07000002198^FS
^FO400,121
^BSN,117
^FD04414^FS
^XZ

Comments The UPC-A bar code uses the Mod 10 check digit scheme for error checking.
For further information on Mod 10, see Mod 10 Check Digit on page 974.

6/8/10 Zebra Programming Guide P1012728-004

134 ZPL Commands
^BX

^BX
Data Matrix Bar Code
Description The ^BX command creates a two-dimensional matrix symbology made up of
square modules arranged within a perimeter finder pattern.

Format ^BXo,h,s,c,r,f,g,a

Parameters Details
o = orientation Accepted Values:
N = normal
R = rotated 90 degrees (clockwise)
I = inverted 180 degrees
B = read from bottom up, 270 degrees
Default Value: current ^FW value
h = dimensional height of Accepted Values: 1 to the width of the label
individual symbol The individual elements are square — this parameter specifies both
elements module and row height. If this parameter is zero (or not given), the h
parameter (bar height) in ^BY is used as the approximate symbol height.
s = quality level Accepted Values: 0, 50, 80, 100, 140, 200
Default Value: 0
Quality refers to the amount of data that is added to the symbol for error
correction. The AIM specification refers to it as the ECC value. ECC 50,
ECC 80, ECC 100, and ECC 140 use convolution encoding; ECC 200 uses
Reed-Solomon encoding. For new applications, ECC 200 is recommended.
ECC 000-140 should be used only in closed applications where a single
party controls both the production and reading of the symbols and is
responsible for overall system performance.
c = columns to encode Accepted Values: 9 to 49
Odd values only for quality 0 to 140 (10 to 144); even values only for
quality 200.
Odd values only for quality 0 to 140 (10 to 144); even values only for
quality 200. The number of rows and columns in the symbol is
automatically determined. You might want to force the number of rows and
columns to a larger value to achieve uniform symbol size. In the current
implementation, quality 0 to 140 symbols are square, so the larger of the
rows or columns supplied are used to force a symbol to that size. If you
attempt to force the data into too small of a symbol, no symbol is printed.
If a value greater than 49 is entered, the rows or columns value is set to
zero and the size is determined normally. If an even value is entered, it
generates INVALID-P (invalid parameter). If a value less than 9 but not 0,
or if the data is too large for the forced size, no symbol prints; if ^CV is
active, INVALID-L prints.
r = rows to encode Accepted Values: 9 to 49

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 135
^BX

Parameters Details
f = format ID (0 to 6) — Accepted Values:
not used with quality 1 = field data is numeric + space (0..9,”) – No \&’’
set at 200 2 = field data is uppercase alphanumeric + space (A..Z,’’) – No \&’’
3 = field data is uppercase alphanumeric + space, period, comma, dash,
and slash (0..9,A..Z,“.-/”)
4 = field data is upper-case alphanumeric + space (0..9,A..Z,’’) – no \&’’
5 = field data is full 128 ASCII 7-bit set
6 = field data is full 256 ISO 8-bit set
Default Value: 6
g = escape sequence Accepted Values: any character
control character Default Value: ~ (tilde)
This parameter is used only if quality 200 is specified. It is the escape
character for embedding special control sequences within the field data.
Important • A value must always be specified when using the escape sequence
control character. If no value is entered, the command is ignored.
The g parmeter will continue to be underscore (_) for anyone with
firmware version: V60.13.0.12, V60.13.0.12Z, V60.13.0.12B,
V60.13.0.12ZB, or later.
a = aspect ratio Accepted Values:
1 = square
2 = rectangular
Default Value: 1
The a parameter is only
supported in V60.16.5Z
and V53.16.5Z or later.

Table 10 • Maximum Field Sizes

ECC
LEVEL ID = 1 ID = 2 ID = 3 ID = 4 ID = 5 ID = 6

0 596 452 394 413 310 271

50 457 333 291 305 228 200

80 402 293 256 268 201 176

100 300 218 190 200 150 131

140 144 105 91 96 72 63

Maximum Field Sizes

6/8/10 Zebra Programming Guide P1012728-004

136 ZPL Commands
^BX

Example 1 •This is an example of a square Data Matrix bar code:

ZPL II CODE DATA MATRIX BAR CODE

^XA
^FO100,100
^BXN,10,200
^FDZEBRA TECHNOLOGIES CORPORATION
333 CORPORATE WOODS PARKWAY
VERNON HILLS, IL
60061-3109^FS
^XZ

Example 2 •This is an example of a rectangle Data Matrix bar code:

ZPL II CODE DATA MATRIX BAR CODE

^XA
^FO100,100
^BXN,10,200,,,,,2
^FDZEBRA TECHNOLOGIES CORPORATION
333 CORPORATE WOODS PARKWAY
^FS
^XZ

a1

Effects of ^BY on ^BX

w = module width (no effect)

r = ratio (no effect)

h = height of symbol
If the dimensions of individual symbol elements are not specified in the ^BY command,
the height of symbol value is divided by the required rows/columns, rounded, limited to a
minimum value of one, and used as the dimensions of individual symbol elements.

Field Data (^FD) for ^BX

Quality 000 to 140

• The \& and || can be used to insert carriage returns, line feeds, and the backslash, similar to
the PDF417. Other characters in the control character range can be inserted only by using
^FH. Field data is limited to 596 characters for quality 0 to 140. Excess field data causes
no symbol to print; if ^CV is active, INVALID-L prints. The field data must correspond to
a user-specified format ID or no symbol prints; if ^CV is active, INVALID-C prints.
• The maximum field sizes for quality 0 to 140 symbols are shown in the table in the g
parameter.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 137
^BX

Quality 200
• If more than 3072 bytes are supplied as field data, it is truncated to 3072 bytes. This limits
the maximum size of a numeric Data Matrix symbol to less than the 3116 numeric
characters that the specification would allow. The maximum alphanumeric capacity is
2335 and the maximum 8-bit byte capacity is 1556.
• If ^FH is used, field hexadecimal processing takes place before the escape sequence
processing described below.
• The underscore is the default escape sequence control character for quality 200 field data.
A different escape sequence control character can be selected by using parameter g in the
^BX command.

The information that follows applies to firmware version: V60.13.0.12, V60.13.0.12Z,

V60.13.0.12B, V60.13.0.12ZB, or later. The input string escape sequences can be embedded
in quality 200 field data using the ASCII 95 underscore character ( _ ) or the character entered
in parameter g:
• _X is the shift character for control characters (e.g., _@=NUL,_G=BEL,_0 is PAD)
• _1 to _3 for FNC characters 1 to 3 (explicit FNC4, upper shift, is not allowed)
• FNC2 (Structured Append) must be followed by nine digits, composed of three-digit
numbers with values between 1 and 254, that represent the symbol sequence and file
identifier (for example, symbol 3 of 7 with file ID 1001 is represented by
_2214001001)
• 5NNN is code page NNN where NNN is a three-digit code page value (for example, Code
Page 9 is represented by _5009)
• _dNNN creates ASCII decimal value NNN for a code word (must be three digits)
• _ in data is encoded by __ (two underscores)

The information that follows applies to all other versions of firmware. The input string escape
sequences can be embedded in quality 200 field data using the ASCII 7E tilde character (~) or
the character entered in parameter g:
• ~X is the shift character for control characters (e.g., ~@=NUL,~G=BEL,~0 is PAD)
• ~1 to ~3 for FNC characters 1 to 3 (explicit FNC4, upper shift, is not allowed)
• FNC2 (Structured Append) must be followed by nine digits, composed of three-digit
numbers with values between 1 and 254, that represent the symbol sequence and file
identifier (for example, symbol 3 of 7 with file ID 1001 is represented by
~2214001001)
• 5NNN is code page NNN where NNN is a three-digit code page value (for example, Code
Page 9 is represented by ~5009)
• ~dNNN creates ASCII decimal value NNN for a code word (must be three digits)
• ~ in data is encoded by a ~ (tilde)

6/8/10 Zebra Programming Guide P1012728-004

138 ZPL Commands
^BY

^BY
Bar Code Field Default
Description The ^BY command is used to change the default values for the module width
(in dots), the wide bar to narrow bar width ratio and the bar code height (in dots). It can be
used as often as necessary within a label format.

Format ^BYw,r,h

Parameters Details
w = module width (in Accepted Values: 1 to 10
dots) Initial Value at power-up: 2
r = wide bar to narrow Accepted Values: 2.0 to 3.0, in 0.1 increments
bar width ratio This parameter has no effect on fixed-ratio bar codes.
Default Value: 3.0
h = bar code height (in Initial Value at power-up: 10
dots)

For parameter r, the actual ratio generated is a function of the number of dots in parameter w,
module width. See Table 11 on page 139.

Example • Set module width (w) to 9 and the ratio (r) to 2.4. The width of the narrow bar is
9 dots wide and the wide bar is 9 by 2.4, or 21.6 dots. However, since the printer rounds out
to the nearest dot, the wide bar is actually printed at 22 dots.
This produces a bar code with a ratio of 2.44 (22 divided by 9). This ratio is as close to 2.4 as
possible, since only full dots are printed.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 139
^BY

Module width and height (w and h) can be changed at anytime with the ^BY command,
regardless of the symbology selected.

Table 11 • Shows Module Width Ratios in Dots

Ratio
Selected Module Width in Dots (w)
(r)

1 2 3 4 5 6 7 8 9 10

2.0 2:1 2:1 2:1 2:1 2:1 2:1 2:1 2:1 2:1 2:1
2.1 2:1 2:1 2:1 2:1 2:1 2:1 2:1 2:1 2:1 2.1:1
2.2 2:1 2:1 2:1 2:1 2.2:1 2.16:1 2.1:1 2.12:1 2.1:1 2.2:1
2.3 2:1 2:1 2.3:1 2.25:1 2.2:1 2.16:1 2.28:1 2.25:1 2.2:1 2.3:1
2.4 2:1 2:1 2.3:1 2.25:1 2.4:1 2.3:1 2.28:1 2.37:1 2.3:1 2.4:1
2.5 2:1 2.5:1 2.3:1 2.5:1 2.4:1 2.5:1 2.4:1 2.5:1 2.4:1 2.5:1
2.6 2:1 2.5:1 2.3:1 2.5:1 2.6:1 2.5:1 2.57:1 2.5:1 2.5:1 2.6:1
2.7 2:1 2.5:1 2.6:1 2.5:1 2.6:1 2.6:1 2.57:1 2.65:1 2.6:1 2.7:1
2.8 2:1 2.5:1 2.6:1 2.75:1 2.8:1 2.6:1 2.7:1 2.75:1 2.7:1 2.8:1
2.9 2:1 2.5:1 2.6:1 2.75:1 2.8:1 2.8:1 2.85:1 2.87:1 2.8:1 2.9:1
3.0 3:1 3:1 3:1 3:1 3:1 3:1 3:1 3:1 3:1 3:1

Comments Once a ^BY command is entered into a label format, it stays in effect until
another ^BY command is encountered.

6/8/10 Zebra Programming Guide P1012728-004

140 ZPL Commands
^CC ~CC

^CC ~CC
Change Caret
Description The ^CC command is used to change the format command prefix. The default
prefix is the caret (^).

Format ^CCx or ~CCx

Parameters Details
x = caret character Accepted Values: any ASCII character
change Default Value: a parameter is required. If a parameter is not entered, the next
character received is the new prefix character.

Example • This is an example of how to change the format prefix to / from a ::

^XA
^CC/
/XZ
The forward slash (/) is set at the new prefix. Note the /XZ ending tag uses the new
designated prefix character (/).

Example • This is an example of how to change the format prefix from ~ to a /:

~CC/
/XA/JUS/XZ

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 141
^BZ

^BZ
POSTAL Bar Code
Description The POSTAL bar code is used to automate the handling of mail. POSTAL
codes use a series of tall and short bars to represent the digits.
• ^BZ supports a print ratio of 2.0:1 to 3.0:1.
• Field data (^FD) is limited to the width (or length, if rotated) of the label and by the
bar code specification.

Format ^BZo,h,f,g,t

Important • If additional information about the POSTAL and PLANET bar code is required,
go to www.aimglobal.org, or contact the United States Postal Service http://pe.usps.gov. If
additional information about the INTELLIGENT MAIL bar code is required, see:
http://ribbs.usps.gov/OneCodeSolution.

Parameters Details
o = orientation Accepted Values:
N = normal
R = rotated 90 degrees (clockwise)
I = inverted 180 degrees
B = read from bottom up, 270 degrees
Default Value: current ^FW value
h = bar code height (in Accepted Values: 1 to 32000
dots) Default Value: value set by ^BY
f = print interpretation Accepted Values:
line N = no
Y = yes
Default Value: N
g = print interpretation Accepted Values:
line above code N = no
Y = yes
Default Value: N
t = Postal code type Accepted Values:
0 = Postnet bar code
1 = Plant Bar Code
2 = Reserved
3 = USPS Intelligent Mail bar code
Default Value: 0

6/8/10 Zebra Programming Guide P1012728-004

142 ZPL Commands
^BZ

Example 1 •This is an example of a POSTNET bar code:

ZPL II CODE POSTNET BAR CODE

^XA
^FO100,100^BY3
^BZN,40,Y,N
^FD12345^FS
^XZ

POSTNET BAR CODE CHARACTERS

0 1 2 3 4 5 6 7 8 9

Example 2 •This is an example of a USPS Intelligent Mail bar code:

ZPL II CODE USPS INTELLIGENT MAIL BAR CODE

^XA
^FO100,040^BZ,40,,,3
^FD00123123456123456789^FS
^XZ

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 143
^CD ~CD

^CD ~CD
Change Delimiter
Description The ^CD and ~CD commands are used to change the delimiter character. This
character is used to separate parameter values associated with several ZPL II commands. The
default delimiter is a comma (,).

Format ^CDa or ~CDa

Parameters Details
a = delimiter character Accepted Values: any ASCII character
change Default Value: a parameter is required. If a parameter is not entered, the next
character received is the new prefix character.

Example • This shows how to change the character delimiter to a semi-colon (;):
^XA
^FO10,10
^GB10,10,3
^XZ
^XA
^CD;
^FO10;10
^GB10;10;3
^XZ
• To save, the JUS command is required. Here is an example using JUS:
~CD;
^XA^JUS^XZ

6/8/10 Zebra Programming Guide P1012728-004

144 ZPL Commands
^CF

^CF
Change Alphanumeric Default Font
Description The ^CF command sets the default font used in your printer. You can use the
^CF command to simplify your programs.

Format ^CFf,h,w

Parameters Details
f = specified default font Accepted Values: A through Z and 0 to 9
Initial Value at power-up: A
h = individual character Accepted Values: 0 to 32000
height (in dots) Initial Value at power-up: 9
w = individual character Accepted Values: 0 to 32000
width (in dots) Initial Value at power-up: 5 or last permanent saved value

Parameter f specifies the default font for every alphanumeric field. Parameter h is the default
height for every alphanumeric field, and parameter w is the default width value for every
alphanumeric field.

The default alphanumeric font is A. If you do not change the alphanumeric default font and do
not use any alphanumeric field command (^AF) or enter an invalid font value, any data you
specify prints in font A.

Defining only the height or width forces the magnification to be proportional to the parameter
defined. If neither value is defined, the last ^CF values given or the default ^CF values for
height and width are used.

Example • This is an example of ^CF code and the result of the code:

ZPL II CODE GENERATED LABEL

^XA
^CF0,89
^FO20,50
^FDA GUIDE TO^FS
^FO20,150
^FDTHE ZPL II^FS
^FO20,250
^FDPROGRAMMING^FS
^FO20,350
^FDLANGUAGE^FS
^XZ

Comments Any font in the printer, including downloaded fonts, EPROM stored fonts, and
fonts A through Z and 0 to 9, can also be selected with ^CW.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 145
^CI

^CI
Change International Font/Encoding
Description Zebra printers can print fonts using international character sets: U.S.A.1,
U.S.A.2, UK, Holland, Denmark/Norway, Sweden/Finland, Germany, France 1, France 2,
Italy, Spain, and several other sets, including the Unicode character set.

The ^CI command enables you to call up the international character set you want to use for
printing. You can mix character sets on a label.

A character within a font can be remapped to a different numerical position.

In x.14 version of firmware and later, this command allows character remapping when
parameter a = 0-13.

Format ^CIa,s1,d1,s2,d2,...

Parameters Details
a = desired character set Accepted values 0 - 12 are Zebra Code Page 850 with specific character
replacements. For details, see International Character Sets on page 148 and/or
Zebra Code Page 850 — Latin Character Set on page 944.
Accepted Values:
0 = Single Byte Encoding - U.S.A. 1 Character Set
1 = Single Byte Encoding - U.S.A. 2 Character Set
2 = Single Byte Encoding - U.K. Character Set
3 = Single Byte Encoding - Holland Character Set
4 = Single Byte Encoding - Denmark/Norway Character Set
5 = Single Byte Encoding - Sweden/Finland Character Set
6 = Single Byte Encoding - Germany Character Set
7 = Single Byte Encoding - France 1 Character Set
8 = Single Byte Encoding - France 2 Character Set
Note • These 9 = Single Byte Encoding - Italy Character Set
parameters are only 10 = Single Byte Encoding - Spain Character Set
valid when (parameter details continued on next page)
parameter
a = 1 - 13
a. The encoding is controlled by the conversion table (*.DAT). The correct table must be present for the conversion to func-
tion. The table generated by ZTools™ is the TrueType fonts internal encoding (Unicode).
b. Shift-JIS encoding converts Shift-JIS to JIS and then looks up the JIS conversion in JIS.DAT. This table must be present
for Shift-JIS to function.
c. Supports ASCII transparency for Asian encodings. 7F and less are treated as single byte characters. 80 to FE is treated as the
first byte of a 2 byte character 8000 to FEFF in the encoding table for Unicode.
d. The ^CI17 command has been deprecated, along with the ^F8 and ^F16 commands that are required for the ^CI17 com-
mand to function. The recommended replacement is the ^CI28-30 commands.

6/8/10 Zebra Programming Guide P1012728-004

146 ZPL Commands
^CI

Parameters Details
a = desired character set 11 = Single Byte Encoding - Miscellaneous Character Set
(continued) 12 = Single Byte Encoding - Japan (ASCII with Yen symbol) Character
Set
13 = Zebra Code Page 850 (see page 944)
14 = Double Byte Asian Encodings a
15 = Shift-JIS b
16 = EUC-JP and EUC-CN a
17 = Deprecated - UCS-2 Big Endian d
18 to 23 = Reserved
24 = Single Byte Asian Encodings a
25 = Reserved
26 = Multibyte Asian Encodings with ASCII Transparency a and c
27 = Zebra Code Page 1252 (see page 948)
28 = Unicode (UTF-8 encoding) - Unicode Character Set
29 = Unicode (UTF-16 Big-Endian encoding) - Unicode Character Set
Values 28 to 30 are only 30 = Unicode (UTF-16 Little-Endian encoding) - Unicode Character Set
supported in firmware 31 = Zebra Code Page 1250 (see page 946) is supported for scalable
version V60.14.x, fonts, such as Font 0, or a downloaded TrueType font. Bitmapped
V50.14.x, or later. fonts (including fonts A-H) do not fully support Zebra Code Page
1250. This value is supported only on Zebra G-Series™ printers.
33 = Code Page 1251
34 = Code page 1253
Values 31 to 36 are only 35 = Code Page 1254
supported in firmware 36 = Code Page 1255
version x.16.x or later. Initial Value at power-up: 0
s1 = source 1 (character Accepted Values: decimals 0 to 255
output image)
d1 = destination 1 Accepted Values: decimals 0 to 255
(character input)
s2 = source 2 (character Accepted Values: decimals 0 to 255
output image)
d2 = destination 2 Accepted Values: decimals 0 to 255
(character input)
… = continuation of Up to 256 source and destination pairs can be entered in this command.
pattern
a. The encoding is controlled by the conversion table (*.DAT). The correct table must be present for the conversion to func-
tion. The table generated by ZTools™ is the TrueType fonts internal encoding (Unicode).
b. Shift-JIS encoding converts Shift-JIS to JIS and then looks up the JIS conversion in JIS.DAT. This table must be present
for Shift-JIS to function.
c. Supports ASCII transparency for Asian encodings. 7F and less are treated as single byte characters. 80 to FE is treated as the
first byte of a 2 byte character 8000 to FEFF in the encoding table for Unicode.
d. The ^CI17 command has been deprecated, along with the ^F8 and ^F16 commands that are required for the ^CI17 com-
mand to function. The recommended replacement is the ^CI28-30 commands.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 147
^CI

80 to FF could mean quad byte in GB18030. The ^CI26 command can also be used to
support the GB 18030 and Big5 HKSCS encodings. The GB 18030 uses the GB18030.DAT
encoding table and BIG5 HKSCS uses the BIG5HK.DAT encoding table.

The ^CI17 command has been deprecated, along with the ^F8 and ^F16 commands that
are required for the ^CI17 command to function. The recommended replacement is the
^CI28-30 commands.

We recommend that a ^CI command (or Unicode BOM) is included at the beginning of each
ZPL script. This is important when ZPL scripts with different encodings are being sent to a
single printer. To assist in the interleaving of encoding schemes, the printer maintains two
encoding states (^CI0 - 28 and ^CI29 - 30). It automatically acknowledges when it should
switch encoding states, allowing it to distinguish between encodings, and maintains a ^CI
for each, but endianess is shared.

Example • This example remaps the Euro symbol (21) decimal to the dollar sign value (36)
decimal. When the dollar sign character is sent to the printer, the Euro symbol prints:

ZPL II CODE GENERATED LABEL

^XA
^CI0,21,36
^FO100,200^A0N50,50^FD$0123^FS
^XZ

The font selected determines the shape and resolution of the printed symbol.

6/8/10 Zebra Programming Guide P1012728-004

148 ZPL Commands
^CI

International Character Sets

Note • ^CI 13 = US keyboard

Comments The space character cannot be remapped for any font.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 149
^CM

^CM
Change Memory Letter Designation
Description The ^CM command allows you to reassign a letter designation to the printer’s
memory devices. If a format already exists, you can reassign the memory device to the
corresponding letter without forcing, altering, or recreating the format itself.

Using this command affects every subsequent command that refers to specific memory
locations.

Format ^CMa,b,c,d

Parameters Details
a = memory alias for B: Accepted Values: B:, E:,R:, A:, and NONE
Default Value: B:
b = memory alias for E: Accepted Values: B:, E:,R:, A:, and NONE
Default Value: E:
c = memory alias for R: Accepted Values: B:, E:,R:, A:, and NONE
Default Value: R:
d = memory alias for A: Accepted Values: B:, E:,R:, A:, and NONE
Default Value: A:
e = multiple alias Accepted Values: M, or no value
Default Value: no value
• This parameter is supported on Xi4 and ZM400/ZM600 printers using
firmware V53.17.7Z or later.
• This parameter is supported on G-Series printers using firmware versions
v56.17.7Z and v61.17.7Z or later.
• This parameter is supported on printers using firmware V60.17.7Z or later.

Comments Unless the e (multiple alias) parameter is used, when two or more parameters
specify the same letter designator, all letter designators are set to their default values.

It is recommended that after entering the ^CM command, ^JUS is entered to save changes to
EEPROM. Any duplicate parameters entered will reset the letter designations back to the
default.

If any of the parameters are out of specification, the command is ignored.

Example 1 • This example designates letter E: to point to the B: memory device, and the
letter B: to point to the E:memory device.
^XA
^CME,B,R,A
^JUS
^XZ

6/8/10 Zebra Programming Guide P1012728-004

150 ZPL Commands
^CM

Example 2 • This example designates that content sent to, or read from the B: or E: memory
locations will be sent to or read from the E: memory location.
^XA
^CME,E,R,A,M
^JUS
^XZ

Example 3 • This example designates that content sent to, or read from the A: or E: memory
locations will be sent to or read from the E: memory location.
^XA
^CMB,E,R,E,M
^JUS
^XZ

Example 4 • This example designates that content sent to, or read from the A:, B: or E:
memory locations will be sent to or read from the E: memory location.
^XA
^CME,E,R,E,M
^JUS
^XZ

Note • Examples 2, 3 and 4 are the only valid uses of the multiple alias parameter.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 151
^CN

^CN
Cut Now
Description The ^CN causes the printer to cycle the media cutter.
Important • This command works only when the printer is in Print Mode Kiosk (^MMk).
If the printer is not in Print Mode Kiosk, then using this command has no effect. See ^MM
on page 295.

Supported Devices
• KR403

Format ^CNa

Parameters Details
a = Cut Mode Override Accepted Values:
0 = Use the “kiosk cut amount” setting from ^KV
1 = Ignore “kiosk cut amount” from ^KV and do a full cut

Default Value: none

The command is ignored if parameters are missing or invalid.

6/8/10 Zebra Programming Guide P1012728-004

152 ZPL Commands
^CO

^CO
Cache On

Note • If you have firmware x.12 or greater this command is not required because the printer
firmware automatically expands the size of the character cache as needed.

Description The ^CO command is used to change the size of the character cache. By
definition, a character cache (referred to as cache) is a portion of the DRAM reserved for
storing scalable characters. All printers have a default 40K cache that is always turned on. The
maximum single character size that can be stored, without changing the size of the cache, is
450 dots by 450 dots.

There are two types of fonts used in Zebra printers: bitmapped and scalable. Letters, numbers,
and symbols in a bitmapped font have a fixed size (for example: 10 points, 12 points, 14
points). By comparison, scalable fonts are not fixed in size.

Because their size is fixed, bitmapped fonts can be moved quickly to the label. In contrast,
scalable fonts are much slower because each character is built on an as-needed basis before it
is moved to the label. By storing scaled characters in a cache, they can be recalled at a much
faster speed.

The number of characters that can be stored in the cache depends on two factors: the size of the
cache (memory) and the size of the character (in points) being saved. The larger the point size,
the more space in the cache it uses. The default cache stores every scalable character that is
requested for use on a label. If the same character, with the same rotation and size is used
again, it is quickly retrieved from cache.

It is possible that after a while the print cache could become full. Once the cache is full, space
for new characters is obtained by eliminating an existing character from the print cache.
Existing characters are eliminated by determining how often they have been used. This is done
automatically. For example, a 28-point Q that was used only once would be a good candidate
for elimination from the cache.

Maximum size of a single print cache character is 1500 dots by 1500 dots. This would require
a cache of 274K.

When the cache is too small for the desired style, smaller characters might appear but larger
characters do not. If possible, increase the size of the cache.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 153
^CO

Format ^COa,b,c

Parameters Details
a = cache on Accepted Values:
N = no
Y = yes
Default Value: Y
b = amount of additional Accepted Values: 1 to 9999
memory to be added Default Value: 40
to cache (in K)
c = cache type Accepted Values:
0 = cache buffer (normal fonts)
1 = internal buffer (recommended for Asian fonts)
Default Value: 0

Example • To resize the print cache to 62K, assuming a 22K existing cache:
^COY,40

To resize the print cache to 100K, assuming a 22K existing cache:

^COY,78

Print Cache Performance

For printing large characters, memory added to the cache by the ^CO command is not
physically added to the 22K cache already in the printer. In the second example above, the
resulting 100K cache is actually two separate blocks of memory, 22K and 78K.

Because large characters need contiguous blocks of memory, a character requiring a cache of
90K would not be completely stored because neither portion of the 100K cache is big enough.
Therefore, if large characters are needed, the ^CO command should reflect the actual size of
the cache you need.

Increasing the size of the cache improves the performance in printing scalable fonts. However,
the performance decreases if the size of the cache becomes large and contains too many
characters. The performance gained is lost because of the time involved searching the cache
for each character.

Comments The cache can be resized as often as needed. Any characters in the cache when
it is resized are lost. Memory used for the cache reduces the space available for label bitmaps,
graphic, and fonts.

Some Asian fonts require an internal working buffer that is much larger than the normal cache.
Since most fonts do not require this larger buffer, it is now a selectable configuration option.
Printing with the Asian fonts greatly reduces the printer memory available for labels, graphics,
fonts, formats, and label bitmaps.

6/8/10 Zebra Programming Guide P1012728-004

154 ZPL Commands
^CP

^CP
Remove Label
Description The ^CP command causes the printer to move a printed label out of the
presenter area in one of several ways.

Supported Devices
• KR403

Format ^CPa

Parameters Details

a = kiosk present mode Accepted Values:

0 = Eject presented page
1 = Retracts presented page
2 = Takes the action defined by c parameter of ^KV command.

Default Value: none

The command is ignored if parameters are missing or invalid.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 155
^CT ~CT

^CT ~CT
Change Tilde
Description The ^CT and ~CT commands are used to change the control command prefix.
The default prefix is the tilde (~).

Format ^CTa or ~CTa

Parameters Details
a = change control Accepted Values: any ASCII character
command character Default Value: a parameter is required. If a parameter is not entered, the next
character received is the new control command character.

Example • This is an example of how to change the control command prefix from a ^ to a +:
^XA
^CT+
^XZ
+HS

6/8/10 Zebra Programming Guide P1012728-004

156 ZPL Commands
^CV

^CV
Code Validation
Description The ^CV command acts as a switch to turn the code validation function on and
off. When this command is turned on, all bar code data is checked for these error conditions:
• character not in character set
• check-digit incorrect
• data field too long (too many characters)
• data field too short (too few characters)
• parameter string contains incorrect data or missing parameter

When invalid data is detected, an error message and code is printed in reverse image in place
of the bar code. The message reads INVALID - X where X is one of these error codes:
C = character not in character set
E = check-digit incorrect
L = data field too long
S = data field too short
P = parameter string contains incorrect data
(occurs only on select bar codes)

Once turned on, the ^CV command remains active from format to format until turned off by
another ^CV command or the printer is turned off. The command is not permanently saved.

Format ^CVa

Parameters Details
a = code validation Accepted Values:
N = no
Y = yes
Default Value: N

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 157
^CV

Example • The examples below show the error labels ^CVY generates when incorrect field
data is entered. Compare the letter following INVALID – to the listing on the previous page.
ZPL II CODE GENERATED LABEL
^XA
^CVY
^FO50,50
^BEN,100,Y,N
^FD97823456 890^FS
^XZ

^XA
^CVY
^FO50,50
^BEN,100,Y,N
^FD9782345678907^FS
^XZ

^XA
^CVY
^FO50,50
^BEN,100,Y,N
^FD97823456789081^FS
^XZ

^XA
^CVY
^FO50,50
^BEN,100,Y,N
^FD97823456789^FS
^XZ

^XA
^CVY
^FO50,50
^BQN2,3
^FDHM,BQRCODE-22^FS
^XZ

Comments If more than one error exists, the first error detected is the one displayed.

The ^CV command tests the integrity of the data encoded into the bar code. It is not used for
(or to be confused with) testing the scan-integrity of an image or bar code.

6/8/10 Zebra Programming Guide P1012728-004

158 ZPL Commands
^CW

^CW
Font Identifier
Description All built-in fonts are referenced using a one-character identifier. The ^CW
command assigns a single alphanumeric character to a font stored in DRAM, memory card,
EPROM, or Flash.

If the assigned character is the same as that of a built-in font, the downloaded font is used in
place of the built-in font. The new font is printed on the label wherever the format calls for the
built-in font. If used in place of a built-in font, the change is in effect only until power is turned
off.

If the assigned character is different, the downloaded font is used as an additional font. The
assignment remains in effect until a new command is issued or the printer is turned off.

Format ^CWa,d:o.x

Parameters Details
a = letter of existing font Accepted Values: A through Z and 0 to 9
to be substituted, or Default Value: a one-character entry is required
new font to be added
d = device to store font in Accepted Values: R:, E:, B:, and A:
(optional) Default Value: R:
o = name of the Accepted Values: any name up to 8 characters
downloaded font to Default Value: if a name is not specified, UNKNOWN is used
be substituted for the
built-in, or as an
additional font
x = extension Accepted Values:
.FNT = Font
.TTF = TrueType Font
.TTE is only supported in .TTE = TrueType Extension
firmware version V60.14.x,
V50.14.x, or later.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 159
^CW

Example • These examples show how to use:

• MYFONT.FNT stored in DRAM whenever a format calls for Font A:
^XA
^CWA,R:MYFONT.FNT
^XZ
• MYFONT.FNT stored in DRAM additionally as Font Q:
^XA
^CWQ,R:MYFONT.FNT
^XZ
• NEWFONT.FNT stored in DRAM whenever a format calls for font F:
^XA
^CWF,R:NEWFONT.FNT
^XZ

Label Listing Before Assignment Label Listing After Assignment

6/8/10 Zebra Programming Guide P1012728-004

160 ZPL Commands
~DB

~DB
Download Bitmap Font
Description The ~DB command sets the printer to receive a downloaded bitmap font and
defines native cell size, baseline, space size, and copyright.

This command consists of two portions, a ZPL II command defining the font and a structured
data segment that defines each character of the font.

Format ~DBd:o.x,a,h,w,base,space,#char,©,data

Parameters Details
d = drive to store font Accepted Values: R:, E:, B:, and A:
Default Value: R:
o = name of font Accepted Values: 1 to 8 alphanumeric characters
Default Value: if a name is not specified, UNKNOWN is used
x = extension Format: .FNT
a = orientation of native Fixed Value: normal
font
h = maximum height of Accepted Values: 1 to 32000
cell (in dots) Default Value: a value must be specified
w = maximum width of Accepted Values: 1 to 32000
cell (in dots) Default Value: a value must be specified
base = dots from top of Accepted Values: 1 to 32000
cell to character Default Value: a value must be specified
baseline
space = width of space Accepted Values: 1 to 32000
or Default Value: a value must be specified
non-existent
characters
#char = number of Accepted Values: 1 to 256 (must match the characters being downloaded)
characters in font Default Value: a value must be specified
© = copyright holder Accepted Values: 1 to 63 alphanumeric characters
Default Value: a value must be specified

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 161
~DB

Parameters Details
data = structured The # symbol signifies character code parameters, which are separated with
ASCII data that periods. The character code is from 1 to 4 characters to allow for large
defines each international character sets to be downloaded to the printer.
character in the font The data structure is:
#xxxx.h.w.x.y.i.data
#xxxx = character code
h = bitmap height (in dot rows)
w = bitmap width (in dot rows)
x = x-offset (in dots)
y = y-offset (in dots)
i = typesetting motion displacement (width, including
inter character gap of a particular character in the font)
data = hexadecimal bitmap description

Example • This is an example of how to use the ~DB command. It shows the first two
characters of a font being downloaded to DRAM.
~DBR:TIMES.FNT,N,5,24,3,10,2,ZEBRA 1992,
#0025.5.16.2.5.18.
OOFF
OOFF
FFOO
FFOO
FFFF
#0037.4.24.3.6.26.
OOFFOO
OFOOFO
OFOOFO
OOFFOO

6/8/10 Zebra Programming Guide P1012728-004

162 ZPL Commands
~DE

~DE
Download Encoding
Description The standard encoding for TrueType Windows® fonts is always Unicode. The
ZPL II field data must be converted from some other encoding to Unicode that the Zebra
printer understands. The required translation tables are provided with font packs. Some tables
can be downloaded from www.zebra.com.

Format ~DEd:o.x,s,data

Parameters Details
d = location of table Accepted Values: R:, E:, B:, and A:
Default Value: R:
o = name of table Accepted Values: any valid name, up to 8 characters
Default Value: if a name is not specified, UNKNOWN is used
x = extension Format: .DAT
s = table size Accepted Values: the number of memory bytes required to hold the Zebra
downloadable format of the font
Default Value: if an incorrect value or no value is entered, the command is
ignored
data = data string Accepted Values: a string of ASCII hexadecimal values
Default Value: if no data is entered, the command is ignored

Example • This is an example of how to download the required translation table:

~DER:JIS.DAT,27848,300021213001...

(27848 two-digit hexadecimal values)

Comments For more information on ZTools or ZebraNet Bridge, see the program
documentation included with the software.

For assistance with editing or adding mappings to .DAT tables, ZebraNet Bridge includes a
.DAT table editor in the font wizard.

Encoding scheme for the data sent to the printer is the second four character and the encoding
scheme for the font is the first four characters throughout the .DAT file. The data must be
ordered by the second four characters (the encoding table).

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 163
~DE

Example • This is an example of a .DAT table. The table below the example identifies the
elements:

~DEE:EXAMPLE.DAT,16,

00310041 1

00320042 2

00330043 3

00340044 4

1 Input stream with 0041 will be mapped to

0031. The printer prints "1".
2 Input stream with 0042 will be mapped to
0032. The printer prints "2".
3 Input stream with 0043 will be mapped to
0033. The printer prints "3".
4 Input stream with 0044 will be mapped to
0034. The printer prints "4".

Data must have 0041, 0042, 0043, and 0044 in order. Multiple pairs can be on the same line.

6/8/10 Zebra Programming Guide P1012728-004

164 ZPL Commands
^DF

^DF
Download Format
Description The ^DF command saves ZPL II format commands as text strings to be later
merged using ^XF with variable data. The format to be stored might contain field number
(^FN) commands to be referenced when recalled.

While use of stored formats reduces transmission time, no formatting time is saved—this
command saves ZPL II as text strings formatted at print time.

Enter the ^DF stored format command immediately after the ^XA command, then enter the
format commands to be saved.

Format ^DFd:o.x

Parameters Details
d = device to store image Accepted Values: R:, E:, B:, and A:
Default Value: R:
o = image name Accepted Values: 1 to 8 alphanumeric characters
Default Value: if a name is not specified, UNKNOWN is used
x = extension Format: .ZPL

For a complete example of the ^DF and ^XF command, see ^DF and ^XF — Download
format and recall format on page 47.

Example • This example is generated using the ^XF command to recall this format:

ZPL II CODE GENERATED LABEL

^XA
^DFR:STOREFMT.ZPL^FS
^FO25,25
^AD,36,20^FN1^FS
^FO165,25
^AD,36,20^FN2^FS
^FO25,75
^AB,22,14^FDBUILT BY^FS
^FO25,125
^AE,28,15^FN1
^XZ
^XA
^XFR:STOREFMT.ZPL^FS
^FN1^FDZEBRA^FS
^XZ

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 165
~DG

~DG
Download Graphics
Description The ~DG command downloads an ASCII Hex representation of a graphic
image. If .GRF is not the specified file extension, .GRF is automatically appended.

For more saving and loading options when downloading files, see ~DY on page 172.

Format ~DGd:o.x,t,w,data

Parameters Details
d = device to store image Accepted Values: R:, E:, B:, and A:
Default Value: R:
o = image name Accepted Values: 1 to 8 alphanumeric characters
Default Value: if a name is not specified, UNKNOWN is used
x = extension Format: .GRF
t = total number of bytes See the formula in the examples below.
in graphic
w = number of bytes per See the formula in the examples below.
row
data = ASCII The data string defines the image and is an ASCII hexadecimal representation
hexadecimal string of the image. Each character represents a horizontal nibble of four dots.
defining image

This is the key for the examples that follow:

x = width of the graphic in millimeters
y = height of the graphic in millimeters
z = dots/mm = print density of the printer being programmed
8 = bits/byte

6/8/10 Zebra Programming Guide P1012728-004

166 ZPL Commands
~DG

Examples • These are some example related to the ~DG command:

To determine the t parameter use this formula:

xz
------  yz = totalbytes
8

To determine the correct t parameter for a graphic 8 mm wide, 16 mm high, and a print
density of 8 dots/mm, use this formula:

8  128 = 1024
t = 1024
Raise any portion of a byte to the next whole byte.

To determine the w parameter (the width in terms of bytes per row) use this formula:
xz
------ =  totalbytes    row 
8
w = 8

To determine the correct w parameter for a graphic 8 mm wide and a print density of 8
dots/mm, use this formula:
 8-
8-----------
= 8bytes
8
w = 8
Raise any portion of a byte to the next whole byte.

Parameter w is the first value in the t calculation.

The data parameter is a string of hexadecimal numbers sent as a representation of the graphic
image. Each hexadecimal character represents a horizontal nibble of four dots. For example,
if the first four dots of the graphic image are white and the next four black, the dot-by-dot
binary code is 00001111. The hexadecimal representation of this binary value is 0F. The
entire graphic image is coded in this way, and the complete graphic image is sent as one
continuous string of hexadecimal values.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 167
~DG

This is an example of using the ~DG command to load a checkerboard pattern into DRAM. The
name used to store the graphic is SAMPLE.GRF:
ZPL II CODE GENERATED LABEL
~DGR:SAMPLE.GRF,00080,010,
FFFFFFFFFFFFFFFFFFFF
8000FFFF0000FFFF0001
8000FFFF0000FFFF0001
8000FFFF0000FFFF0001
FFFF0000FFFF0000FFFF
FFFF0000FFFF0000FFFF
FFFF0000FFFF0000FFFF
FFFFFFFFFFFFFFFFFFFF
^XA
^F020,20^XGR:SAMPLE.GRF,1,1^FS
^XZ

Comments Do not use spaces or periods when naming your graphics. Always use different
names for different graphics.

If two graphics with the same name are sent to the printer, the first graphic is erased and
replaced by the second graphic.

6/8/10 Zebra Programming Guide P1012728-004

168 ZPL Commands
~DN

~DN
Abort Download Graphic
Description After decoding and printing the number of bytes in parameter t of the ~DG
command, the printer returns to normal Print Mode. Graphics Mode can be aborted and normal
printer operation resumed by using the ~DN command.

Format ~DN

Comments If you need to stop a graphic from downloading, you should abort the
transmission from the host device. To clear the ~DG command, however, you must send a ~DN
command.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 169
~DS

~DS
Download Intellifont (Scalable Font)
Description The ~DS command is used to set the printer to receive a downloadable
scalable font and defines the size of the font in bytes.

The ~DS command, and its associated parameters, is the result of converting a vendor-
supplied font for use on a Zebra printer. To convert this font use the ZTools utility.

Format ~DSd:o.x,s,data

Parameters Details
d = device to store image Accepted Values: R:, E:, B:, and A:
Default Value: R:
o = image name Accepted Values: 1 to 8 alphanumeric characters
Default Value: if a name is not specified, UNKNOWN is used
x = extension Fixed Value: .FNT
s = size of font in bytes Fixed Value: this number is generated by ZTools and should not be changed
data = ASCII Fixed Value: this number is generated by ZTools and should not be changed
hexadecimal string
that defines font

Example • This example shows the first three lines of a scalable font that was converted
using the ZTools program and is ready to be downloaded to the printer. If necessary, the
destination and object name can be changed.
~DSB:CGTIMES.FNT,37080,
OOFFOOFFOOFFOOFF
FFOAECB28FFFOOFF

Comments Downloaded scalable fonts are not checked for integrity. If they are corrupt,
they cause unpredictable results at the printer.

If you are using a TrueType font use these commands: ~DT, ~DU, and ~DY. To determine
when to use the noted commands, see ~DT on page 170, ~DU on page 171, and ~DY
on page 172.

6/8/10 Zebra Programming Guide P1012728-004

170 ZPL Commands
~DT

~DT
Download Bounded TrueType Font
Description Use ZTools to convert a TrueType font to a Zebra-downloadable format. that
has less than 256 characters in it. To convert a font that has more than 256 characters, see ~DU
on page 171. ZTools creates a downloadable file that includes a ~DT command. For
information on converting and downloading Intellifont information, see ~DS on page 169.

Format ~DTd:o.x,s,data

Parameters Details
d = font location Accepted Values: R:, E:, B:, and A:
Default Value: R:
o = font name Accepted Values: any valid TrueType name, up to 8 characters
Default Value: if a name is not specified, UNKNOWN is used
x = extension Fixed Value: .DAT
s = font size Accepted Values: the number of memory bytes required to hold the Zebra-
downloadable format of the font
Default Value: if an incorrect value or no value is entered, the command is
ignored
data = data string Accepted Values: a string of ASCII hexadecimal values (two hexadecimal
digits/byte). The total number of two-digit values must match parameter s.
Default Value: if no data is entered, the command is ignored

Example • This is an example of how to download a true type font:

~DTR:FONT,52010,00AF01B0C65E...

(52010 two-digit hexadecimal values)

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 171
~DU

~DU
Download Unbounded TrueType Font
Description Some international fonts, such as Asian fonts, have more than
256 printable characters. These fonts are supported as large TrueType fonts and are
downloaded to the printer with the ~DU command. Use ZTools to convert the large TrueType
fonts to a Zebra-downloadable format.

The Field Block (^FB) command cannot support the large TrueType fonts.

Format ~DUd:o.x,s,data

Parameters Details
d = font location Accepted Values: R:, E:, B:, and A:
Default: R:
o = font name Accepted Values: 1 to 8 alphanumeric characters
Default Value: if a name is not specified, UNKNOWN is used
x = extension Format: .FNT
s = font size Accepted Values: the number of memory bytes required to hold the Zebra-
downloadable format of the font
Default Value: if no data is entered, the command is ignored
data = data string Accepted Values: a string of ASCII hexadecimal values (two hexadecimal
digits/byte). The total number of two-digit values must match parameter s.
Default Value: if no data is entered, the command is ignored

Example • This is an example of how to download an unbounded true type font:

~DUR:KANJI,86753,60CA017B0CE7...

(86753 two-digit hexadecimal values)

For similar commands, see ~DS on page 169, ~DT on page 170, and ~DY on page 172.

6/8/10 Zebra Programming Guide P1012728-004

172 ZPL Commands
~DY

~DY
Download Objects
Description The ~DY command downloads to the printer graphic objects or fonts in any
supported format. This command can be used in place of ~DG for more saving and loading
options. ~DY is the preferred command to download TrueType fonts on printers with firmware
later than X.13. It is faster than ~DU. The ~DY command also supports downloading wireless
certificate files.

Note • When using certificate files, your printer supports:

• Using Privacy Enhanced Mail (PEM) formatted certificate files.
• Using the client certificate and private key as two files, each downloaded separately.
• Using exportable PAC files for EAP-FAST.
• Zebra recommends using Linear style memory devices for storing larger
objects.

Format ~DYd:f,b,x,t,w,data

Parameters Details
d = file location Accepted Values: R:, E:, B:, and A:
Default Value: R:

.NRD and .PAC files

reside on E: in firmware
versions V60.15.x,
V50.15.x, or later.
f = file name Accepted Values: 1 to 8 alphanumeric characters
Default Value: if a name is not specified, UNKNOWN is used
b = format downloaded Accepted Values:
in data field A = uncompressed (ZB64, ASCII)
B = uncompressed (.TTE, .TTF, binary)
C = AR-compressed (used only by Zebra’s BAR-ONE® v5)
.TTE and .TTF are only P = portable network graphic (.PNG) - ZB64 encoded
supported in firmware Default Value: a value must be specified
versions V60.14.x,
V50.14.x, or later.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 173
~DY

Parameters Details
x = extension of stored Accepted Values:
file B = bitmap
E = TrueType Extension (.TTE)
G = raw bitmap (.GRF)
.TTE and .OTF are only P = store as compressed (.PNG)
supported in firmware T = TrueType (.TTF) or OpenType (.OTF)
versions V60.14.x, X = Paintbrush (.PCX)
V50.14.x, or later. NRD = Non Readable File (.NRD)
PAC = Protected Access Credential (.PAC)
C = User defined menu file (WML)
.NRD and .PAC are only F = User defined webpage file (HTM)
supported in firmware H = Printer feedback file (GET)
versions V60.15.x, Default Value: a value other than the accepted values defaults to .GRF
V50.15.x, or later.
t = total number of bytes Accepted Values:
in file .BMP
This parameter refers to the actual size of the file, not the amount of
disk space.
.GRF images: the size after decompression into memory
This parameter refers to the actual size of the file, not the amount of
disk space.
.PCX
This parameter refers to the actual size of the file, not the amount of
disk space.
.PNG images:
This parameter refers to the actual size of the file, not the amount of
disk space.
.TTF
This parameter refers to the actual size of the file, not the amount of
disk space.
.TTE is only supported in
.TTE
firmware versions
V60.14.x, V50.14.x, or This parameter refers to the actual size of the file, not the amount of
later. disk space.

6/8/10 Zebra Programming Guide P1012728-004

174 ZPL Commands
~DY

Parameters Details
w = total number of bytes Accepted Values:
per row .GRF images: number of bytes per row
.PNG images: value ignored
.TTF images: value ignored
.TTE is only supported in .TTE images: value ignored
firmware version V60.14.x,
V50.14.x, or later. .NRD images: value ignored
.PAC images: value ignored

.NRD and .PAC files are

supported in firmware
version V60.15.x,
V50.15.x, or later.
data = data ASCII hexadecimal encoding, ZB64, or binary data, depending on b.
A, P = ASCII hexadecimal or ZB64
B, C = binary
When binary data is sent, all control prefixes and flow control characters are
ignored until the total number of bytes needed for the graphic format is
received.

Note • When transmitting fonts or graphics, the ~DY command and the binary content can be
sent as two separate data streams. In cases where the ~DY command and data content are sent
separately, the connection to the printer must be maintained until both the command and data
content have been sent. If the command and data content are sent separately, the data light on
the printer will remain lit until it receives all the data called for in the ~DY command. The
download will be considered complete when the number of bytes called out in the ~DY
command have been received.

For best results, graphic files must be monochrome (black and white) or dithered.

Example • This is an example of how to download a binary TrueType Font file of Size bytes
using the name fontfile.ttf and storing it to permanent flash memory on the printer:
~DYE:FONTFILE.TTF,B,T,SIZE,,

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 175
~DY

Examples • These examples show:

• that when the ^IM command is used with the ^FO command, the ^IM command (see
^IM on page 239) moves the logo.png file from a storage area to the 0,0 position on
the label. This is the ZPL code:
^XA
^FO0,0^IMR:LOGO.PNG^FS
^XZ
• that when the ^IL command (see ^IL on page 238) is used at the beginning of a label
format, it loads a stored image (logo.png) of a format and merges it with additional
data. It is automatically positioned at the 0,0 position of the label and does not require the
^FO command. This is the ZPL code:
^XA
^ILR:LOGO.PNG
^XZ

Comments For more information on ZB64 encoding and compression, see

ZB64 Encoding and Compression on page 987.

These are some important things to know about this command in firmware version V60.14.x,
V50.14.x, or later:
• ZebraNet Bridge can be used to download fonts and graphics with this command.
• OpenType tables are only supported when downloading the font with this command
• OpenType fonts (.OTF) are supported if they are downloaded as a TrueType font. In
the printer .OTF fonts have the .TTF extension.

6/8/10 Zebra Programming Guide P1012728-004

176 ZPL Commands
~EG

~EG
Erase Download Graphics
See ^ID on page 236.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 177
^FB

^FB
Field Block
Description The ^FB command allows you to print text into a defined block type format.
This command formats an ^FD or ^SN string into a block of text using the origin, font, and
rotation specified for the text string. The ^FB command also contains an automatic word-wrap
function.

Format ^FBa,b,c,d,e

Parameters Details
a = width of text block Accepted Values: 0 to the width of the label
line (in dots) Default Value: 0
If the value is less than font width or not specified, text does not print.
b = maximum number of Accepted Values: 1 to 9999
lines in text block Default Value: 1
Text exceeding the maximum number of lines overwrites the last line.
Changing the font size automatically increases or decreases the size of the
block.
c = add or delete space Accepted Values: -9999 to 9999
between lines (in Default Value: 0
dots) Numbers are considered to be positive unless preceded by a minus sign.
Positive values add space; negative values delete space.
d = text justification Accepted Values:
L = left
C = center
R = right
J = justified
Default Value: L
If J is used the last line is left-justified.
e = hanging indent (in Accepted Values: 0 to 9999
dots) of the second Default Value: 0
and remaining lines

6/8/10 Zebra Programming Guide P1012728-004

178 ZPL Commands
^FB

Example • These are examples of how the ^FB command affects field data.

ZPL II CODE GENERATED LABEL

^XA
^CF0,30,30^FO25,50
^FB250,4,,
^FDFD command that IS\&
preceded by an FB \&command.
^FS
^XZ

^XA
^CF0,30,30^FO25,50
^FDFD command that IS NOT
preceded by an FB command.^FS
^XZ

Comments

This scheme can be used to facilitate special functions:

\& = carriage return/line feed
\(*) = soft hyphen (word break with a dash)
\\ = backslash (\)

Item 1: ^CI13 must be selected to print a backslash (\).

Item 2: If a soft hyphen escape sequence is placed near the end of a line, the hyphen is printed.
If it is not placed near the end of the line, it is ignored.
(*) = any alphanumeric character
• If a word is too long to print on one line by itself (and no soft hyphen is specified), a
hyphen is automatically placed in the word at the right edge of the block. The remainder
of the word is on the next line. The position of the hyphen depends on word length, not a
syllable boundary. Use a soft hyphen within a word to control where the hyphenation
occurs.
• Maximum data-string length is 3K, including control characters, carriage returns, and line
feeds.
• Normal carriage returns, line feeds, and word spaces at line breaks are discarded.
• When using ^FT (Field Typeset), ^FT uses the baseline origin of the last possible line of
text. Increasing the font size causes the text block to increase in size from bottom to top.
This could cause a label to print past its top margin.
• When using ^FO (Field Origin), increasing the font size causes the text block to increase
in size from top to bottom.
• ^FS terminates an ^FB command. Each block requires its own ^FB command.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 179
^FB

While the ^FB command has a text justification parameter that defines the justification of the
text within the block, it also interacts with the justification of ^FO and ^FT that define the
justification of the origin.

The ^FB command does not support soft hyphens as a potential line break point. However,
soft hyphen characters are always printed as if they were a hyphen.

The ^FB command does not support complex text. For complex text support, use ^TB.

6/8/10 Zebra Programming Guide P1012728-004

180 ZPL Commands
^FC

^FC
Field Clock
Description The ^FC command is used to set the clock-indicators (delimiters) and the
clock mode for use with the Real-Time Clock hardware. This command must be included
within each label field command string each time the Real-Time Clock values are required
within the field.

Format ^FCa,b,c

Parameters Details
a = primary clock Accepted Values: any ASCII character
indicator character Default Value: %
b = secondary clock Accepted Values: any ASCII character
indicator character Default Value: none—this value cannot be the same as a or c
c = third clock indicator Accepted Values: any ASCII character
character Default Value: none—this value cannot be the same as a or b

Example • Entering these ZPL commands sets the primary clock indicator to %, the
secondary clock indicator to {, and the third clock indicator to #. The results are printed on a
label with Primary, Secondary, and Third as field data.

ZPL II CODE GENERATED LABEL

^XA
^FO10,100^A0N,50,50
^FC%,{,#
^FDPrimary: %m/%d/%y^FS
^FO10,200^A0N,50,50
^FC%,{,#
^FDSecondary: {m/{d/{y^FS
^FO10,300^A0N,50,50
^FC%,{,#
^FDThird: #m/#d/#y^FS
^XZ

Comments The ^FC command is ignored if the Real Time Clock hardware is not present.
As of V60.13.0.10, (^SN) functions with (^FC) capabilities.

For more details on the Real Time Clock, see Real Time Clock on page 999.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 181
^FD

^FD
Field Data
Description The ^FD command defines the data string for the field. The field data can be
any printable character except those used as command prefixes (^ and ~).

Format ^FDa

Parameters Details
a = data to be printed Accepted Values: any data string up to 3072 bytes
Default Value: none—a string of characters must be entered

Comments The ^ and ~ characters can be printed by changing the prefix characters—see
^CD ~CD on page 143 and ^CT ~CT on page 155. The new prefix characters cannot be
printed.

Characters with codes above 127, or the ^ and ~ characters, can be printed using the ^FH and
^FD commands.
• ^CI13 must be selected to print a backslash (\).

For information on using soft hyphens, see Comments on the ^FB command on page 178.

6/8/10 Zebra Programming Guide P1012728-004

182 ZPL Commands
^FH

^FH
Field Hexadecimal Indicator
Description The ^FH command allows you to enter the hexadecimal value for any
character directly into the ^FD statement. The ^FH command must precede each ^FD
command that uses hexadecimals in its field.

Within the ^FD statement, the hexadecimal indicator must precede each hexadecimal value.
The default hexadecimal indicator is _ (underscore). There must be a minimum of two
characters designated to follow the underscore. The a parameter can be added when a
different hexadecimal indicator is needed.

This command can be used with any of the commands that have field data (that is ^FD, ^FV
(Field Variable), and ^SN (Serialized Data)).

Valid hexadecimal characters are:

0 1 2 3 4 5 6 7 8 9 A B C D E F a b c d e f

Format ^FHa

Parameters Details
a = hexadecimal Accepted Values: any character except current format and control prefix (^ and
indicator ~ by default)
Default Value: _ (underscore)

Example • This is an example of how to enter a hexadecimal value directly into a ^FD
statement: This is an example for ascii data using ^CI0.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 183
^FH

Examples • These are examples of how ^FH works with UTF-8 and UTF-16BE:

UTF-8
ZPL II CODE GENERATED LABEL

^XA
^CI28
^LL500
^FO100,100
^AA,20,20
^FH^FDU+00A1 in UTF8 = _C2_A1^FS
^XZ

UTF-16BE
ZPL II CODE GENERATED LABEL

^XA
^CI29
^LL500
^FO100,100
^AA,20,20
^FH^FDU+00A1 in UTF16BE = _00_A1^FS
^XZ

6/8/10 Zebra Programming Guide P1012728-004

184 ZPL Commands
^FL

^FL
Font Linking
This command is available only for printers with firmware versions V60.14.x, V50.14.x, or
later.

Description The ^FL command provides the ability to link any TrueType font, including
private character fonts, to associated fonts.

If the base font does not have a glyph for the required character, the printer looks to the linked
fonts for the glyph. The font links are user-definable. The font linking remains until the link is
broken or the printer is turned off. To permanently save the font linking, use the ^JUS
command.

Note • For assistance in setting up the font links, please use the font wizard in
ZebraNet Bridge.

Format ^FL<ext>,<base>,<link>

Parameters Details
<ext> This is the fully-qualified filename of the extension. This file name does not
accept wildcards.
The supported extensions for this parameter are: .TTF and .TTE. The format
for this parameter is the memory device followed by the font name with the
extension, as follows:
E:SWISS721.TTF
<base> This is the filename of the base font(s) to which <ext> is associated. This can
be partially or fully wild carded; all files that match the wildcard specification
will have this extension associated with it.
The filename does not have to match a file that is currently defined on the
printer. A specification of *.TTF results in all *.TTF font files loaded on the
printer currently or in the future to be associated with the specified <ext> font
extension.
<link> This is an indicator that determines if the extension is to be linked with the
base, or unlinked from the base, as follows:
Accepted Values:
0 = <ext> is to be unlinked (disassociated) from the file(s) specified in
<base>
1 = <ext> is to be linked (associated) with the file(s) specified by
<base>
Default Value: must be an accepted value or it is ignored

Comments A font can have up to five fonts linked to it. The printer resident font, 0.FNT is
always the last font in the list of font links, but is not included in the five link maximum. It can
also be placed anywhere in the font links list.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 185
^FL

The default glyph prints when a glyph cannot be found in any of the fonts in the link list. The
advanced layout command ^PA determines if the default glyph is a space character or the
default glyph of the base font, which is typically a hollow box.

The list of font links can be printed by using the ^LF command or retrieved with the ^HT
command.

Examples • These examples show the code and output for no font linking and for font
linking:
No Font Linking
In the no font linking example, the Swiss721 font does not have the Asian glyphs, which
is why Asian glyphs do not print.

ZPL II CODE GENERATED LABEL

6/8/10 Zebra Programming Guide P1012728-004

186 ZPL Commands
^FL

Font Linking
In the font linking example, this code is sent down to link the ANMDJ.TTF font to
SWISS721.TTF font:
^XA
^FLE:ANMDJ.TTF,E:SWISS721.TTF,1^FS
^XZ
When the label reprints, the Asian characters are printed using the ANMDJ.TTF font,
rather than the SWISS721.TTF font.

ZPL II CODE GENERATED LABEL

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 187
^FM

^FM
Multiple Field Origin Locations
Description The ^FM command allows you to control the placement of bar code symbols.

It designates field locations for the PDF417 (^B7) and MicroPDF417 (^BF) bar codes when
the structured append capabilities are used. This allows printing multiple bar codes from the
same set of text information.

The structured append capability is a way of extending the text printing capacity of both bar
codes. If a string extends beyond what the data limitations of the bar code are, it can be printed
as a series: 1 of 3, 2 of 3, 3 of 3. Scanners read the information and reconcile it into the
original, unsegmented text.

The ^FM command triggers multiple bar code printing on the same label with ^B7 and ^BF
only. When used with any other commands, it is ignored.

Format ^FMx1,y1,x2,y2,...

Parameters Details
x1 = x-axis location of Accepted Values:
first symbol (in dots) 0 to 32000
e = exclude this bar code from printing
Default Value: a value must be specified
y1 = y-axis location of Accepted Values:
first symbol (in dots) 0 to 32000
e = exclude this bar code from printing
Default Value: a value must be specified
x2 = x-axis location of Accepted Values:
second symbol (in 0 to 32000
dots) e = exclude this bar code from printing
Default Value: a value must be specified
y2 = y-axis location of Accepted Values:
second symbol (in 0 to 32000
dots) e = exclude this bar code from printing
Default Value: a value must be specified
… = continuation of X,Y Maximum number of pairs: 60
pairs

6/8/10 Zebra Programming Guide P1012728-004

188 ZPL Commands
^FM

Example • This example shows you how to generate three bar codes with the text “Zebra
Technologies Corporation strives to be…” would need to be repeated seven times, which
includes 2870 characters of data (including spaces) between ^FD and ^FS:

ZPL II CODE GENERATED LABEL

^XA
^FM100,100,100,600,100,1200
^BY2,3
^B7N,5,5,9,83,N
^FDZebra Technologies
Corporation strives to be
the expert supplier of
innovative solutions to
specialty demand labeling
and ticketing problems of
business and government.
We will attract and retain
the best people who will
understand our customer's
needs and provide them with
systems, hardware, software,
consumables and service
offering the best value,
high quality, and reliable
performance, all delivered
in a timely manner
…
^FS^XZ

1 The ellipse is not part of the code. It indicates that the text needs to be
repeated seven times, as mentioned in the example description.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 189
^FM

Example • This example assumes a maximum of three bar codes, with bar code 2 of 3
omitted:

ZPL II CODE GENERATED LABEL

^XA
^FM100,100,e,e,100,1200
^BY2,3
^B7N,5,5,9,83,N
^FDZebra Technologies
Corporation strives to be
the expert supplier of
innovative solutions to
specialty demand labeling
and ticketing problems of
business and government.
We will attract and retain
the best people who will
understand our customer's
needs and provide them with
systems, hardware, software,
consumables and service
offering the best value,
high quality, and reliable
performance, all delivered
in a timely manner
…
^FS^XZ

1 The ellipse is not part of the code. It indicates that the text needs to be
repeated seven times, as mentioned in the example description.

Comments Subsequent bar codes print once the data limitations of the previous bar code
have been exceeded. For example, bar code 2 of 3 prints once 1 of 3 has reached the maximum
amount of data it can hold. Specifying three fields does not ensure that three bar codes print;
enough field data to fill three bar code fields has to be provided.

The number of the x,y pairs can exceed the number of bar codes generated. However, if too
few are designated, no symbols print.

6/8/10 Zebra Programming Guide P1012728-004

190 ZPL Commands
^FN

^FN
Field Number
Description The ^FN command numbers the data fields. This command is used in both
^DF (Store Format) and ^XF (Recall Format) commands.

In a stored format, use the ^FN command where you would normally use the ^FD (Field
Data) command. In recalling the stored format, use ^FN in conjunction with the ^FD
command.

The optional "a" parameter can be used with the KDU Plus to cause prompts to be displayed
on the KDU unit. Also, when the Print on Label link is selected on the Directory page of
ZebraLink enabled printers the field prompt displays.

The number of fields and data that can be stored is dependent in the available printer memory.

Note • The maximum number of ^FN commands that can be used depends on the amount of
data that is placed in the fields on the label. It is recommended to use 400 or fewer fields.

Format ^FN#"a"

Parameters Details
# = number to be Accepted Values: 0 to 9999
assigned to the field Default Value: 0
"a" = optional Accepted Values: 255 alphanumeric characters maximum
parameter* (a-z,A-Z,1-9 and space)
Default Value: optional parameter

* This parameter is only available on printers with firmware V50.13.2, V53.15.5Z,

V60.13.0.1, or later. For a complete example of the ^DF and ^XF command, see ^DF and ^XF
— Download format and recall format on page 47.

Comments
• The same ^FN value can be stored with several different fields.
• If a label format contains a field with ^FN and ^FD, the data in that field prints for any
other field containing the same ^FN value.
• For the "a" parameter to function as a prompt the characters used in the "a" parameter
must be surrounded by double quotes (see example).

Example • The ^FN1”Name” would result in “Name” being used as the prompt
on the KDU unit.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 191
^FO

^FO
Field Origin
Description The ^FO command sets a field origin, relative to the label home (^LH)
position. ^FO sets the upper-left corner of the field area by defining points along the x-axis
and y-axis independent of the rotation.

Format ^FOx,y,z

Parameters Details
x = x-axis location (in Accepted Values: 0 to 32000
dots) Default Value: 0
y = y-axis location (in Accepted Values: 0 to 32000
dots) Default Value: 0
z = justification Accepted Values:
0 = left justification
1 = right justification
The z parameter is only 2 = auto justification (script dependent)
supported in firmware Default Value: last accepted ^FW value or ^FW default
versions V60.14.x,
V50.14.x, or later.

Comments If the value entered for the x or y parameter is too high, it could position the
field origin completely off the label.

This command interacts with the field direction parameter of ^FP and with the rotation
parameter of ^A. For output and examples, see Field Interactions on page 993.

The auto justification option might cause unexpected results if variable fields or bidirectional
text are used with ^FO. For the best results with bidirectional text and/or variable fields, use
either the left of right justification option.

6/8/10 Zebra Programming Guide P1012728-004

192 ZPL Commands
^FP

^FP
Field Parameter
Description The ^FP command allows vertical and reverse formatting of the font field,
commonly used for printing Asian fonts.

Format ^FPd,g
.

Parameters Details
d = direction Accepted Values:
H = horizontal printing (left to right)
V = vertical printing (top to bottom)
R = reverse printing (right to left)
Default Value: H
g = additional Accepted Values: 0 to 9999
inter-character gap Default Value: 0 if no value is entered
(in dots)

Example • This is an example of how to implement reverse and vertical print:

For vertical and reverse printing directions, combining semantic clusters are used to place
characters.

This command interacts with the justification parameters of ^FO and ^FT and with the
rotation parameter of ^A. For output and examples, see Field Interactions on page 993.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 193
^FR

^FR
Field Reverse Print
Description The ^FR command allows a field to appear as white over black or black over
white. When printing a field and the ^FR command has been used, the color of the output is
the reverse of its background.

Format ^FR

Example • In this example, the ^GB command creates areas of black allowing the printing to
appear white:

ZPL II CODE GENERATED LABEL

^XA
^PR1
^FO100,100
^GB70,70,70,,3^FS
^FO200,100
^GB70,70,70,,3^FS
^FO300,100
^GB70,70,70,,3^FS
^FO400,100
^GB70,70,70,,3^FS
^FO107,110^CF0,70,93
^FR^FDREVERSE^FS
^XZ

Comments The ^FR command applies to only one field and has to be specified each time.
When multiple ^FR commands are going to be used, it might be more convenient to use the
^LR command.

6/8/10 Zebra Programming Guide P1012728-004

194 ZPL Commands
^FS

^FS
Field Separator
Description The ^FS command denotes the end of the field definition. Alternatively, ^FS
command can also be issued as a single ASCII control code SI (Control-O, hexadecimal 0F).

Format ^FS

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 195
^FT

^FT
Field Typeset
Description The ^FT command sets the field position, relative to the home position of the
label designated by the ^LH command. The typesetting origin of the field is fixed with respect
to the contents of the field and does not change with rotation.

Note • The ^FT command is capable of concantination of fields.

Format ^FTx,y,z

Parameters Details
x = x-axis location (in Accepted Values: 0 to 32000
dots) Default Value: position after last formatted text field
y = y-axis location (in Accepted Values: 0 to 32000
dots) Default Value: position after last formatted text field
z = justification Accepted Values:
0 = left justification
1 = right justification
2 = auto justification (script dependent)
Default Value: last accepted ^FW value or ^FW default
The z parameter is only
supported in firmware The auto justification option may cause unexpected results if variable fields or
version V60.14.x, bidirectional text are used with ^FT. For best results with bidirectional text
V50.14.x, or later. and/or variable fields, use either the left of right justification options.

Table 12 • Typeset Justification

Text For examples, see Field Interactions on page 993.

Justified

Bar Codes Origin is base of bar code, at left edge

Left

Graphic Boxes Origin is bottom-left corner of the box

Images Origin is bottom-left corner of the image area
Text For examples, see Field Interactions on page 993.
Justified

Bar Codes Origin is base of bar code, at right edge

Right

Graphic Boxes Origin is bottom-right corner of the box

Images Origin is bottom-right corner of the image area

6/8/10 Zebra Programming Guide P1012728-004

196 ZPL Commands
^FT

Example • This is an example of the ^FT command and concatenation:

When a coordinate is missing, the position following the last formatted field is assumed. This
remembering simplifies field positioning with respect to other fields. Once the first field is
positioned, other fields follow automatically.

There are several instances where using the ^FT command without specifying x and y
parameters is not recommended:
• when positioning the first field in a label format
• at any time with the ^FN (Field Number) command
• following an ^SN (Serialization Data) command
• variable data
• bidirectional text

The right typeset justified is available only for printers with firmware version V60.14.x,
V50.14.x, or later.

This command interacts with the field direction parameters of ^FP and with the rotation
parameter of ^A. For output and code examples, see Field Interactions on page 993

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 197
^FV

^FV
Field Variable
Description ^FV replaces the ^FD (field data) command in a label format when the field is
variable.

Format ^FVa

Parameters Details
a = variable field data to Accepted Values: 0 to 3072 byte string
be printed Default Value: if no data is entered, the command is ignored

Example • This is an example of how to use the ^MC and ^FV command:

ZPL II CODE GENERATED LABEL

^XA
^FO40,40
^GB300,203,8^FS
^FO55,60^CF0,25
^FVVARIABLE DATA #1^FS
^FO80,150
^FDFIXED DATA^FS
^MCN
^XZ

^XA
^FO55,60^CF0,25
^FVVARIABLE DATA #2^FS
^MCY
^XZ

Comments ^FV fields are always cleared after the label is printed. ^FD fields are not
cleared.

6/8/10 Zebra Programming Guide P1012728-004

198 ZPL Commands
^FW

^FW
Field Orientation
Description The ^FW command sets the default orientation for all command fields that
have an orientation (rotation) parameter (and in x.14 sets the default justification for all
commands with a justification parameter). Fields can be rotated 0, 90, 180, or 270 degrees
clockwise by using this command. In x.14, justification can be left, right, or auto.

The ^FW command affects only fields that follow it. Once you have issued a ^FW command,
the setting is retained until you turn off the printer or send a new ^FW command to the printer.

Format ^FWr,z

Parameters Details
r = rotate field Accepted Values:
N = normal
R = rotated 90 degrees
I = inverted 180 degrees
B = bottom-up 270 degrees, read from bottom up
Initial Value at Power-up: N
z = justification Accepted Values:
0 = left justification
1 = right justification
The z parameter is 2 = auto justification (script dependent)
available only with printers Default Value: auto for ^TB and left for all other commands
with firmware version
V60.14.x, V50.14.x, or
later.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 199
^FW

Example • This example shows how ^FW rotation works in conjunction with ^FO. In this
example, note that:
• the fields using A0N print the field in normal rotation
• the fields with no rotation indicated (A0) follow the rotation used in the ^FW
command (^FWR).

ZPL II CODE GENERATED LABEL

^XA
^FWR
^FO150,90^A0N,25,20^FDZebra Technologies^FS
^FO115,75^A0,25,20^FD0123456789^FS
^FO150,115^A0N,25,20^FD333 Corporate Woods
Parkway^FS
^FO400,75^A0,25,20^FDXXXXXXXXX^FS
^XZ

Comments ^FW affects only the orientation in commands where the rotation parameter has
not been specifically set. If a command has a specific rotation parameter, that value is used.

^FW affects only the justification in commands where the parameter has not been set. If a
command has a specific justification parameter that value is used .

6/8/10 Zebra Programming Guide P1012728-004

200 ZPL Commands
^FX

^FX
Comment
Description The ^FX command is useful when you want to add non-printing informational
comments or statements within a label format. Any data after the ^FX command up to the next
caret (^) or tilde (~) command does not have any effect on the label format. Therefore, you
should avoid using the caret (^) or tilde (~) commands within the ^FX statement.

Format ^FXc

Parameters Details
c = non printing Creates a non-printable comment.
comment

Example • This is an example of how to use the ^FX command effectively:

ZPL II CODE GENERATED LABEL

^XA
^LH100,100^FS
^FXSHIPPING LABEL^FS
^FO10,10^GB470,280,4^FS
^FO10,190^GB470,4,4^FS
^FO10,80^GB240,2,2^FS
^FO250,10^GB2,100,2^FS
^FO250,110^GB226,2,2^FS
^FO250,60^GB226,2,2^FS
^FO156,190^GB2,95,2^FS
^FO312,190^GB2,95,2^FS
^XZ

Comments Correct usage of the ^FX command includes following it with the ^FS
command.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 201
^GB

^GB
Graphic Box
Description The ^GB command is used to draw boxes and lines as part of a label format.
Boxes and lines are used to highlight important information, divide labels into distinct areas,
or to improve the appearance of a label. The same format command is used for drawing either
boxes or lines.

Format ^GBw,h,t,c,r

Parameters Details
w = box width (in dots) Accepted Values: value of t to 32000
Default Value: value used for thickness (t) or 1
h = box height (in dots) Accepted Values: value of t to 32000
Default Value: value used for thickness (t) or 1
t = border thickness (in Accepted Values: 1 to 32000
dots) Default Value: 1
c = line color Accepted Values:
B = black
W = white
Default Value: B
r = degree of corner- Accepted Values: 0 (no rounding) to 8 (heaviest rounding)
rounding Default Value: 0

For the w and h parameters, keep in mind that printers have a default of 6, 8, 12, or
24 dots/millimeter. This comes out to 153, 203, 300, or 600 dots per inch. To determine the
values for w and h, calculate the dimensions in millimeters and multiply by 6, 8, 12, or 24.

If the width and height are not specified, you get a solid box with its width and height as
specified by value t.

The roundness-index is used to determine a rounding-radius for each box. Formula:

rounding-radius = (rounding-index / 8) * (shorter side / 2)

where the shorter side is the lesser of the width and height (after adjusting for minimum and
default values).

6/8/10 Zebra Programming Guide P1012728-004

202 ZPL Commands
^GB

Examples • Here are a few examples of graphic boxes:

Width: 1.5 inch; Height: 1 inch; Thickness: 10; Color: default; Rounding: default
ZPL II CODE GENERATED LABEL

^XA
^FO50,50
^GB300,200,10^FS
^XZ

Width: 0 inch; Height: 1 inch; Thickness: 20; Color: default; Rounding: default:
ZPL II CODE GENERATED LABEL

^XA
^FO50,50
^GB0,203,20^FS
^XZ

Width: 1 inch; Height: 0 inch; Thickness: 30; Color: default; Rounding: default
ZPL II CODE GENERATED LABEL

^XA
^FO50,50
^GB203,0,20^FS
^XZ

Width: 1.5 inch; Height: 1 inch; Thickness: 10; Color: default; Rounding: 5
ZPL II CODE GENERATED LABEL

^XA
^FO50,50
^GB300,200,10,,5^FS
^XZ

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 203
^GC

^GC
Graphic Circle
Description The ^GC command produces a circle on the printed label. The command
parameters specify the diameter (width) of the circle, outline thickness, and color. Thickness
extends inward from the outline.

Format ^GCd,t,c

Parameters Details
d = circle diameter (in Accepted Values: 3 to 4095 (larger values are replaced with 4095)
dots) Default Value: 3
t = border thickness (in Accepted Values: 2 to 4095
dots) Default Value: 1
c = line color Accepted Values:
B = black
W = white
Default Value: B

Example • This is an example of how to create a circle on the printed label:

ZPL II CODE GENERATED LABEL

^XA
^FO50,50
^GC250,10,B^FS
^XZ

6/8/10 Zebra Programming Guide P1012728-004

204 ZPL Commands
^GD

^GD
Graphic Diagonal Line
Description The ^GD command produces a straight diagonal line on a label. This can be
used in conjunction with other graphic commands to create a more complex figure.

Format ^GDw,h,t,c,o

Parameters Details
w = box width (in dots) Accepted Values: 3 to 32000
Default Value: value of t (thickness) or 3
h = box height (in dots) Accepted Values: 3 to 32000
Default Value: value of t (thickness) or 3
t = border thickness (in Accepted Values: 1 to 32000
dots) Default Value: 1
c = line color Accepted Values:
B = black
W = white
Default Value: B
o = orientation (direction Accepted Values:
of the diagonal) R (or /) = right-leaning diagonal
L (or \) = left-leaning diagonal
Default Value: R

Example • This is an example of how to create a diagonal line connecting one corner with the
opposite corner of a box on a printed label:

ZPL II CODE GENERATED LABEL

^XA
^FO150,100
^GB350,203,10^FS
^FO155,110
^GD330,183,10,,R^FS
^XZ

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 205
^GE

^GE
Graphic Ellipse
Description The ^GE command produces an ellipse in the label format.

Format ^GEw,h,t,c

Parameters Details
w = ellipse width (in dots) Accepted Values: 3 to 4095 (larger values are replaced with 4095)
Default Value: value used for thickness (t) or 1
h = ellipse height (in Accepted Values: 3 to 4095
dots) Default Value: value used for thickness (t) or 1
t = border thickness (in Accepted Values: 2 to 4095
dots) Default Value: 1
c = line color Accepted Values:
B = black
W = white
Default Value: B

Example • This is an example of how to create a ellipse on a printed label:

ZPL II CODE GENERATED LABEL

^XA
^FO100,100
^GE300,100,10,B^FS
^XZ

6/8/10 Zebra Programming Guide P1012728-004

206 ZPL Commands
^GF

^GF
Graphic Field
Description The ^GF command allows you to download graphic field data directly into the
printer’s bitmap storage area. This command follows the conventions for any other field,
meaning a field orientation is included. The graphic field data can be placed at any location
within the bitmap space.

Format ^GFa,b,c,d,data

Parameters Details
a = compression type Accepted Values:
A = ASCII hexadecimal (follows the format for other download
commands)
B = binary (data sent after the c parameter is strictly binary)
C = compressed binary (data sent after the c parameter is in compressed
binary format. The data is compressed on the host side using Zebra’s
compression algorithm. The data is then decompressed and placed
directly into the bitmap.)
Default Value: A
b = binary byte count Accepted Values: 1 to 99999
This is the total number of bytes to be transmitted for the total image or the
total number of bytes that follow parameter d. For ASCII download, the
parameter should match parameter c. Out-of-range values are set to the
nearest limit.
Default Value: command is ignored if a value is not specified
c = graphic field count Accepted Values: 1 to 99999
This is the total number of bytes comprising the graphic format (width x
height), which is sent as parameter d. Count divided by bytes per row gives
the number of lines in the image. This number represents the size of the
image, not necessarily the size of the data stream (see d).
Default Value: command is ignored if a value is not specified
d = bytes per row Accepted Values: 1 to 99999
This is the number of bytes in the downloaded data that comprise one row
of the image.
Default Value: command is ignored if a value is not specified

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 207
^GF

Parameters Details
data = data Accepted Values:
ASCII hexadecimal data: 00 to FF
A string of ASCII hexadecimal numbers, two digits per image byte. CR and
LF can be inserted as needed for readability. The number of two-digit
number pairs must match the above count. Any numbers sent after count is
satisfied are ignored. A comma in the data pads the current line with 00
(white space), minimizing the data sent. ~DN or any caret or tilde character
prematurely aborts the download.
Binary data: Strictly binary data is sent from the host. All control prefixes
are ignored until the total number of bytes needed for the graphic format is
sent.

Example • This example downloads 8,000 total bytes of data and places the graphic data at
location 100,100 of the bitmap. The data sent to the printer is in ASCII form.

^FO100,100^GFA,8000,8000,80,ASCII data

Example • This example downloads 8,000 total bytes of data and places the graphic data at
location 100,100 of the bitmap. The data sent to the printer is in binary form.

^FO100,100^GFB,8000,8000,80,Binary data

6/8/10 Zebra Programming Guide P1012728-004

208 ZPL Commands
^GS

^GS
Graphic Symbol
Description The ^GS command enables you to generate the registered trademark,
copyright symbol, and other symbols.

Format ^GSo,h,w

Parameters Details
o = field orientation Accepted Values:
N = normal
R = rotate 90 degrees clockwise
I = inverted 180 degrees
B = bottom-up, 270 degrees
Default Value: N or last ^FW value
h = character height Accepted Values: 0 to 32000
proportional to width Default Value: last ^CF value
(in dots)
w = character width Accepted Values: 0 to 32000
proportional to Default Value: last ^CF value
height (in dots)

Example • Use the ^GS command followed by ^FD and the appropriate character (A
through E) within the field data to generate the desired character:

ZPL II CODE GENERATED LABEL

^XA^CFD
^FO50,50
^FDZEBRA PROGRAMMING^FS
^FO50,75
^FDLANGUAGE II (ZPL II )^FS
^FO280,75
^GS^FDC^FS
^XZ

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 209
~HB

~HB
Battery Status
Description When the ~HB command is sent to the printer, a data string is sent back to the
host. The string starts with an <STX> control code sequence and terminates by an
<ETX><CR><LF> control code sequence.

Important • This command only responds to mobile printers.

Format ~HB

Parameters: when the printer receives the command, it returns:

<STX>bb.bb,hh.hh,bt<ETX><CR><LF>

<STX> = ASCII start-of-text character

bb.bb = current battery voltage reading to the nearest 1/4 volt
hh.hh = current head voltage reading to the nearest 1/4 volt
bt = battery temperature in Celsius
<ETX> = ASCII end-of-text character
<CR> = ASCII carriage return
<LF> = ASCII line feed character

Comments This command is used for the power-supply battery of the printer and should
not be confused with the battery backed-up RAM.

6/8/10 Zebra Programming Guide P1012728-004

210 ZPL Commands
~HD

~HD
Head Diagnostic
Description The ~HD command echoes printer status information that includes the power
supply and head temperature using the terminal emulator.

Format ~HD

Example • This is an example of the ~HD command:

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 211
^HF

^HF
Host Format
Description The ^HF command sends stored formats to the host.

Format ^HFd,o,x

Parameters Details
d = device to recall Accepted Values: R:, E:, B:, and A:
image Default Value: R:
o = image name Accepted Values: 1 to 8 alphanumeric characters
Default Value: if a name is not specified, UNKNOWN is used
x = extension Fixed Value: .ZPL

Example • This example shows the sequence and results.

Using a terminal emulator, you download this code to the printer:

^XA
^DFB:FILE1.ZPL
^FO100,100^A0,100
^FDTEST^FS
^XZ

Then you send this code to the printer:

^XA
^HFB:FILE1.ZPL
^XZ
The terminal emulator returns this code:
^XA^DFFILE1,
^FO100,100^A0,100^FDTEST^FS
^XZ

6/8/10 Zebra Programming Guide P1012728-004

212 ZPL Commands
^HG

^HG
Host Graphic
Description The ^HG command is used to upload graphics to the host. The graphic image
can be stored for future use, or it can be downloaded to any Zebra printer.

Format ^HGd:o.x

Parameters Details
d = device location Accepted Values: R:, E:, B:, and A:
of object Default Value: search priority
o = object name Accepted Values: 1 to 8 alphanumeric characters
Default Value: if a name is not specified, UNKNOWN is used
x = extension Fixed Value: .GRF

Comments For more information on uploading graphics, see ^HY on page 233.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 213
^HH

^HH
Configuration Label Return
Description The ^HH command echoes printer configuration back to the host, using a
terminal emulator.

Format ^HH

Example • This is an example of what is returned to the host when ^XA^HH^XZ is sent to
the printer:

6/8/10 Zebra Programming Guide P1012728-004

214 ZPL Commands
~HI

~HI
Host Identification
Description The ~HI command is designed to be sent from the host to the Zebra printer to
retrieve information. Upon receipt, the printer responds with information on the model,
software version, dots-per-millimeter setting, memory size, and any detected objects.

Format ~HI

When the printer receives this command, it returns:

XXXXXX,V1.0.0,dpm,000KB,X
XXXXXX = model of Zebra printer
V1.0.0 = version of software
dpm = dots/mm
6, 8, 12, or 24 dots/mm printheads
000KB = memory
512KB = 1/2 MB
1024KB = 1 MB
2048KB = 2 MB
4096KB = 4 MB
8192KB = 8 MB
x = recognizable objects
only options specific to printer are shown (cutter, options, et cetera.)

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 215
~HM

~HM
Host RAM Status
Description Sending ~HM to the printer immediately returns a memory status message to
the host. Use this command whenever you need to know the printer’s RAM status.

When ~HM is sent to the Zebra printer, a line of data containing information on the total
amount, maximum amount, and available amount of memory is sent back to the host.

Format ~HM

Example • This example shows when the ~HM is sent to the printer, a line of data containing
three numbers are sent back to the host. Each set of numbers is identified and explained in the
table that follows:

1 1024,0780,0780 3

1 The total amount of RAM (in kilobytes) installed in the printer. In

this example, the printer has 1024K RAM installed.
2 The maximum amount of RAM (in kilobytes) available to the
user. In this example, the printer has a maximum of 780K RAM
available.
3 The amount of RAM (in kilobytes) currently available to the user.
In this example, there is 780K of RAM in the printer currently
available to the user.

Comments Memory taken up by bitmaps is included in the currently available memory

value (due to ^MCN).

Downloading a graphic image, fonts, or saving a bitmap affects only the amount of RAM. The
total amount of RAM and maximum amount of RAM does not change after the printer is
turned on.

6/8/10 Zebra Programming Guide P1012728-004

216 ZPL Commands
~HQ

~HQ
Host Query
Description The ~HQ command group causes the printer to send information back to the
host.

Supported Devices
• Xi4, RXi4
• ZM400/ZM600 with v53.17.1Z or later, RZ400/RZ600
• S4M with v53.17.1Z or later
• G-Series with v56.16.5 or later
or
G-Series with v61.16.5 or later

Format ~HQquery-type

Parameter Details
query-type For detailed examples of these parameters, see ~HQ Examples on page 219.
Accepted Values:
ES = requests the printer’s status - see Table 13 on page 217 and Table 14
on page 218
HA = hardware address of the internal wired print server
JT = requests a summary of the printer’s printhead test results
MA = maintenance alert settings
MI = maintenance information
OD = odometer
PH = printhead life history
PP = printer’s Plug and Play string
SN = printer’s serial number
UI = USB product ID and BDC release version

Default Value: must be an accepted value or the command is ignored

Comments The response to the ~HQ command starts with STX, a CR LF is inserted
between each line, and the response ends with ETX.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 217
~HQ

Table 13 • Error Flags (~HQES)

Group 2 Group 1 (X = Value can be any hexadecimal number [0-9, A-F])
Error Flags Flag
Nibbles16-9 Nibble8 Nibble7 Nibble6 Nibble5 Nibble4 Nibble3 Nibble2 Nibble1

No Error 0 00000000 0 0 0 0 0 0 0 0
Error Present 1 00000000 X X X X X X X X
Printhead Thermistor Open 1 00000000 X X X X X 2 X X
Invalid Firmware Config. 1 00000000 X X X X X 1 X X
Printhead Detection Error 1 00000000 X X X X X X 8 X
Bad Printhead Element 1 00000000 X X X X X X 4 X
Motor Over Temperature 1 00000000 X X X X X X 2 X
Printhead Over Temperature 1 00000000 X X X X X X 1 X
Cutter Fault 1 00000000 X X X X X X X 8
Head Open 1 00000000 X X X X X X X 4
Ribbon Out 1 00000000 X X X X X X X 2
Media Out 1 00000000 X X X X X X X 1
a a a
Clear Paper Path Failed 1 00000000 X X X X 8 X X X
a a a
Paper Feed Error 1 00000000 X X X X 4 X X X
a a a
Presenter Not Running 1 00000000 X X X X 2 X X X
a a a
Paper Jam during Retract 1 00000000 X X X X 1 X X X
a a a
Black Mark not Found 1 00000000 X X X 8 X X X X
a a a
Black Mark Calabrate Error 1 00000000 X X X 4 X X X X
a a a
Retract Function timed out 1 00000000 X X X 2 X X X X
a a a
Paused 1 00000000 X X X 1 X X X X
a. This error flag is supported only on KR403 printers.

6/8/10 Zebra Programming Guide P1012728-004

218 ZPL Commands
~HQ

Table 14 • Warning Flags (~HQES)

Group 2 Group 1 (X = Value can be any hexadecimal number [0-9, A-F])
Error Flags Flag
Nibbles16-9 Nibble8 Nibble7 Nibble6 Nibble5 Nibble4 Nibble3 Nibble2 Nibble1

No Warning 0 00000000 0 0 0 0 0 0 0 0
Warning Present 1 00000000 X X X X X X X X
b b b
Paper-near-end Sensor 1 00000000 X X X X X X X 8
Replace Printhead 1 00000000 X X X X X X X 4
Clean Printhead 1 00000000 X X X X X X X 2
Need to Calibrate Media 1 00000000 X X X X X X X 1
b b b
Sensor 1 (Paper before head) 1 00000000 X X X X X X 1 X
b b b
Sensor 2 (Black mark) 1 00000000 X X X X X X 2 X
b b b
Sensor 3 (Paper after head) 1 00000000 X X X X X X 4 X
b b b
Sensor 4 (loop ready) 1 00000000 X X X X X X 8 X
b b b
Sensor 5 (presenter) 1 00000000 X X X X X 1 X X
b b b
Sensor 6 (retract ready) 1 00000000 X X X X X 2 X X
b b b
Sensor 7 (in retract) 1 00000000 X X X X X 4 X X
b b b
Sensor 8 (at bin) 1 00000000 X X X X X 8 X X
b. This error flag is supported only on KR403 printers.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 219
~HQ

~HQ Examples
This section provides detail examples of all the available parameters.

Example 1 • This example shows how to request the printer’s status.

a. To request the printer’s status, type ~HQES
The printer responds with data similar to this:
PRINTER STATUS
ERRORS: 1 00000000 00000005
WARNINGS: 1 00000000 00000002

In this example, the Printer Status resolves to these conditions:

• The cover/printhead is open (value = 4).
• Media is out or not loaded into the printer (value = 1).
• The printhead needs to be cleaned (value = 2).
• Error nibble 1 is equal to 5 when the error status values are added together (4 + 1).

This illustration identifies the printer status definitions:

1 3 5

PRINTER STATUS
ERRORS: 1 00000000 00000005
WARNINGS: 1 00000000 00000002

2 4 6

1 Flag
2 Nibble 16-9
3 Nibble 8-4
4 Nibble 3
5 Nibble 2
6 Nibble 1

6/8/10 Zebra Programming Guide P1012728-004

220 ZPL Commands
~HQ

Example 2 • This example shows how the printer responds when the printer receives the
~HQES command:
a. To see how the printer responds, type ~HQES
The printer responds with data similar to this:
PRINTER STATUS
ERRORS: 1 00000000 0000000B
WARNINGS: 0 00000000 00000000

In this example, the printer status resolves to the following conditions:

• The cutter has a fault (value = 8).
• Ribbon is out or not loaded into the printer (value = 2).
• Media is out or not loaded into the printer (value = 1).
• Error byte 1 is equal to B when the error status values are added together
(8 + 2 + 1 = hexadecimal B).

Example 3 • This is an example of how to retrieve the hardware address of the internal wired
print server.
a. To get the hardware address of the internal wired print server, type ~HQHA
The printer responds with data similar to this:
MAC ADDRESS
00:07:4d:2c:e0:7a

Example 4 • This is an example of how to request a summary of the printer’s printhead test
results.
The ^JT command is used to initiate printhead testing, set the testing interval, and set the
element range to be tested. For more details see, ^JT on page 268.
a. To request a summary of the printer’s printhead test, type ~HQJT
The printer responds with data similar to this:
PRINT HEAD TEST RESULTS
0,A,0000,0000,0000
When the printer has printed enough labels to trigger a printhead test, the initial data
changes.
b. To request a summary of the printer’s printhead test, type ~HQJT
The printer responds with data similar to this:
PRINT HEAD TEST RESULTS:
0,A,0015,0367,0000

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 221
~HQ

This illustration identifies the printhead test field definitions:

0,A,0000,0000,0000

1 2 3 4 5

1 Element failure
2 Manual (M) or automatic (A) range
3 First test element
4 Last test element
5 Failure count

Example 5 • This is an example of how to use the maintenance alert query for the ~HQ
command.
a. To get the current settings, type ~HQMA
The printer responds with data similar to this:
~HQMA
MAINTENANCE ALERT SETTINGS
HEAD REPLACEMENT INTERVAL: 1 km
HEAD REPLACEMENT FREQUENCY: 0 M
HEAD CLEANING INTERVAL: 0 M
HEAD CLEANING FREQUENCY: 0 M
PRINT REPLACEMENT ALERT: NO
PRINT CLEANING ALERT: NO
UNITS: C

Example 6 • This is an example of how to use the maintenance information query for the
~HQ command. Note that the message is controlled by the ^MI command.
a. To get the current settings, type ~HQMI 1
The printer responds with data similar to this:
MAINTENANCE ALERT MESSAGES 2
CLEAN: PLEASE CLEAN PRINT HEAD
REPLACE: PLEASE REPLACE PRINT HEAD

6/8/10 Zebra Programming Guide P1012728-004

222 ZPL Commands
~HQ

Example 7 • This is an example of how to use the odometer query for the ~HQ command.
Note that the units of measure are controlled by the ^MA command. Also, if the "Early
Warning Maintenance State" is turned "ON" the printer response would also list LAST
CLEANED and CURRENT PRINTHEAD LIFE counters.
a. To get the current settings, type ~HQOD
The printer responds with data similar to this:
PRINT METERS
TOTAL NONRESETTABLE: 8560 "
USER RESETTABLE CNTR1: 9 "
USER RESETTABLE CNTR2: 8560 "
The units of measure are set to inches.
b. To change the units of measure to centimeters, type:
^XA^MA,,,,C
^XZ
The units of measure are set to centimeters.
c. To check the settings, type ~HQOD
The printer responds with data similar to this:
PRINT METERS
TOTAL NONRESETTABLE: 21744 cm
USER RESETTABLE CNTR1: 24 cm
USER RESETTABLE CNTR2: 21744 cm

Example 8 • This is an example of how to use the printhead life query for the ~HQ
command. Note that the units of measure are controlled by the ^MA command.
a. To get the current settings, type ~HQPH
The printer responds with data similar to this:

LAST CLEANED: 257 "

HEAD LIFE HISTORY
# DISTANCE
1: 257 "
2: 1489 "
3: 7070 "

1 The current life of the print head.

2 Line items 2 through 10 (the example only shows 2 through
3) tracks the measurement for each time the print head is
changed.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 223
~HQ

Example 9 • This is an example of how to request the printer’s Plug and Play string.
a. To request the printer’s Plug and Play string, type ~HQPP
The printer responds with data similar to this:
PLUG AND PLAY MESSAGES
MFG: Zebra Technologies
CMD: ZPL
MDL: GX420t

Example 10 • This is an example of how to retrieve the printer’s serial number.

a. To get the printer’s serial number, type ~HQSN
The printer responds with data similar to this:
SERIAL NUMBER
41A06440023

Example 11 • This is an example of how to retrieve the printer’s USB product ID and BCD
release version.
a. To get the printer’s USB product ID and BCD release version, type ~HQUI
The printer responds with data similar to this:
USB INFORMATION
PID: 0085
RELEASE VERSION: 15.01

6/8/10 Zebra Programming Guide P1012728-004

224 ZPL Commands
~HS

~HS
Host Status Return
Description When the host sends ~HS to the printer, the printer sends three data strings
back. Each string starts with an <STX> control code and is terminated by an
<ETX><CR><LF> control code sequence. To avoid confusion, the host prints each string on a
separate line.

Note • When a ~HS command is sent, the printer will not send a response to the host if the
printer is in one of these conditions:
• MEDIA OUT
• RIBBON OUT
• HEAD OPEN
• REWINDER FULL
• HEAD OVER-TEMPERATURE

String 1 <STX>aaa,b,c,dddd,eee,f,g,h,iii,j,k,l<ETX><CR><LF>

aaa = communication (interface) settings

b = paper out flag (1 = paper out)
c = pause flag (1 = pause active)
dddd = label length (value in number of dots)
eee = number of formats in receive buffer
f = buffer full flag (1 = receive buffer full)
g = communications diagnostic mode flag (1 = diagnostic mode active)
h = partial format flag (1 = partial format in progress)
iii = unused (always 000)
j = corrupt RAM flag (1 = configuration data lost)
k = temperature range (1 = under temperature)
l = temperature range (1 = over temperature)

c. This string specifies the printer’s baud rate, number of data bits, number of stop bits, parity setting,
and type of handshaking. This value is a three-digit decimal representation of an eight-bit binary
number. To evaluate this parameter, first convert the decimal number to a binary number.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 225
~HS

The nine-digit binary number is read according to this table:

aaa = a8 a7 a6 a5 a 4 a3 a2 a1 a0
a 7 = Handshake a 8 a 2 a 1 a 0 = Baud
0 = Xon/Xoff
1 = DTR 0 000 = 110
6 0 001 = 300
a = Parity Odd/Even
0 010 = 600
0 = Odd
0 011 = 1200
1 = Even
0 100 = 2400
a 5 = Disable/Enable 0 101 = 4800
0 = Disable 0 110 = 9600
1 = Enable 0 111 = 19200
1 000 = 28800 (available only on certain printer models)
a 4 = Stop Bits 1 001 = 38400 (available only on certain printer models)
0 = 2 Bits 1 010 = 57600 (available only on certain printer models)
1 = 1 Bit 1 011 = 14400
a 3 = Data Bits
0 = 7 Bits
1 = 8 Bits

6/8/10 Zebra Programming Guide P1012728-004

226 ZPL Commands
~HS

String 2 <STX>mmm,n,o,p,q,r,s,t,uuuuuuuu,v,www<ETX><CR><LF>

mmm = function settings d

n = unused
o = head up flag (1 = head in up position)
p = ribbon out flag (1 = ribbon out)
q = thermal transfer mode flag (1 = Thermal Transfer Mode
selected)
r = Print Mode
0 = Rewind
1 = Peel-Off
2 = Tear-Off
Values 4 to 5 are only 3 = Cutter
supported in firmware 4 = Applicator
version V60.14.x, 5 = Delayed cut
V50.14.x, V53. 15.x, 6 = Reserved e
or later. 7 = Reserved e
8 = Reserved e
9 = RFID

s = print width mode

t = label waiting flag (1 = label waiting in Peel-off Mode)
uuuuuuuu = labels remaining in batch
v = format while printing flag (always 1)
www = number of graphic images stored in memory

d. This string specifies the printer’s media type, sensor profile status, and communication diagnostics sta-
tus. As in String 1, this is a three-digit decimal representation of an eight-bit binary number. First, con-
vert the decimal number to a binary number.
e. These values are only supported on the Xi4, RXi4, ZM400/ZM600, and RZ400/RZ600 printers.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 227
~HS

The eight-digit binary number is read according to this table:

mmm = m7 m6 m5 m4 m3 m2 m1 m0
m7 = Media Type m4 m3 m2 m1 = Unused
0 = Die-Cut 0 = Off
1 = Continuous 1 = On
m6 = Sensor Profile m0 = Print Mode
0 = Off 0 = Direct Thermal
1 = Thermal Transfer
m5 = Communications Diagnostics
0 = Off
1 = On

String 3 <STX>xxxx,y<ETX><CR><LF>

xxxx = password

y = 0 (static RAM not installed)

1 (static RAM installed)

6/8/10 Zebra Programming Guide P1012728-004

228 ZPL Commands
^HT

^HT
Host Linked Fonts List
This command is available only for printers with firmware version V60.14.x, V50.14.x, or
later.

Description The ^HT command receives the complete list of font links over a
communication port.

Example • The SWISS.721.TTF is the base font, ANMDJ.TTF is the first linked font, and
MSGOTHIC.TTF is the second linked font:

ZPL II CODE DATA RETURNED

^XA LIST OF FONT LINKS

^HT E:SWISS721.TTF
^XZ E:ANMDJ.TTF
E:MSGOTHIC.TTF

This is the code that was used to establish the font links:
^XA
^FLE:ANMDJ.TTF,E:SWISS721.TTF,1^FS
^FLE:MSGOTHIC.TTF,E:SWISS721.TTF,1^FS
^XZ

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 229
~HU

~HU
Return ZebraNet Alert Configuration
Description This command returns the table of configured ZebraNet Alert settings to the
host.

Format ~HU

Example • If the ~HU command is sent to the printer with existing Alert messages set to go
to e-mail and SNMP traps, the data returned would look something like the information
below. See ^SX on page 350 for complete information on the individual parameter settings.
B,C,Y,Y,[email protected],0
J,F,Y,Y,,0
C,F,Y,Y,,0
D,F,Y,Y,,0
E,F,Y,N,,0
F,F,Y,N,,0
H,C,Y,N,[email protected],0
N,C,Y,Y,[email protected],0
O,C,Y,Y,[email protected],0
P,C,Y,Y,[email protected],0

Important • If there are no ^SX (alerts) set, the printer will not respond to the ~HU
command.

The first line indicates that condition B (ribbon out) is routed to destination C (e-mail address).

The next two characters, Y and Y, indicate that the condition set and condition clear options
have been set to yes.

The following entry is the destination that the Alert e-mail should be sent to; in this example it
is [email protected].

The last figure seen in the first line is 0, which is the port number.

Each line shows the settings for a different Alert condition as defined in the ^SX command.

6/8/10 Zebra Programming Guide P1012728-004

230 ZPL Commands
^HV

^HV
Host Verification
Description Use this command to return data from specified fields, along with an optional
ASCII header, to the host computer. You can use this command with any field that has been
assigned a number with the ^RT command or with the ^FN and ^RF commands.

Format ^HV#,n,h,t,a

This table identifies the parameters for this format:

Parameters Details
# = field number The value assigned to this parameter should be the same as
specified with the one used in another command.
another command Accepted Values: 0 to 9999
Default Value: 0
n = number of bytes to be Accepted Values: 1 to 256
returned Default Value: 64
h = header to be returned Delimiter characters terminate the string. This field is Field
with the data Hex (^FH) capable.
Accepted Values: 0 to 3072 bytes
Default Value: no header
t = termination This field is Field Hex (^FH) capable.
Accepted Values: 0 to 3072 characters
a = command applies to When ^PQ is greater than 1, send one response for a label
format or one for every label printed.
Accepted Values:
F = Format
L = Label
Default Value: F

Example • The following code:

^XA
.
.
.
^FH_^HV0,8,EPC[,]_0D_0A,L^FS
^PQ2
^XZ
Would return data such as this:
EPC[12345678]
EPC[55554444]

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 231
^HW

^HW
Host Directory List
Description ^HW is used to transmit a directory listing of objects in a specific memory area
(storage device) back to the host device. This command returns a formatted ASCII string of
object names to the host.

Each object is listed on a line and has a fixed length. The total length of a line is also fixed.
Each line listing an object begins with the asterisk (*) followed by a blank space. There are
eight spaces for the object name, followed by a period and three spaces for the extension. The
extension is followed by two blank spaces, six spaces for the object size, two blank spaces, and
three spaces for option flags (reserved for future use). The format looks like this:
<STX><CR><LF>
DIR R: <CR><LF>
*Name.ext(2sp.)(6 obj. sz.)(2sp.)(3 option flags)
*Name.ext(2sp.)(6 obj. sz.)(2sp.)(3 option flags)
<CR><LF>
-xxxxxxx bytes free
<CR><LF>
<ETX>
<STX> = start of text
<CR><LR> = carriage return/line feed
<ETX> = end on text

The command might be used in a stand-alone file to be issued to the printer at any time. The
printer returns the directory listing as soon as possible, based on other tasks it might be
performing when the command is received.

This command, like all ^ (caret) commands, is processed in the order that it is received by the
printer.

Format ^HWd:o.x

Parameters Details
d = location to retrieve Accepted Values: R:, E:, B:, A:and Z:
object listing Default Value: R:
o = object name Accepted Values: 1 to 8 alphanumeric characters
Default Value: asterisk (*). A question mark (?) can also be used.
x = extension Accepted Values: any extension conforming to Zebra conventions
Default Value: asterisk (*). A question mark (?) can also be used.

6/8/10 Zebra Programming Guide P1012728-004

232 ZPL Commands
^HW

Parameters Details
f = format Accepted Values:
c = column format
d = default format
Default Value: d

The f parameter is only

supported in firmware
version V60.16.0Z and
V53.16.0Z or later.

Example • Listed is an example of the ^HW command to retrieve from information R:

^XA
^HWR:*.*
^XZ

Example • The printer returned this information as the Host Directory Listing:-DIR
R:*.*
*R:ARIALN1.FNT 49140
*R:ARIALN2.FNT 49140
*R:ARIALN3.FNT 49140
*R:ARIALN4.FNT 49140
*R:ARIALN.FNT 49140
*R:ZEBRA.GRF 8420
-794292 bytes free R:RAM

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 233
^HY

^HY
Upload Graphics
Description The ^HY command is an extension of the ^HG command. ^HY is used to
upload graphic objects from the printer in any supported format.

Format ^HYd:o.x

Parameters Details
d = location of object Accepted Values: R:, E:, B:, and A:
Default Value: search priority
o = object name Accepted Values: 1 to 8 alphanumeric characters
Default Value: an object name must be specified
x = extension Accepted Values:
G = .GRF (raw bitmap format)
P = .PNG (compressed bitmap format)
Default Value: format of stored image

Comments The image is uploaded in the form of a ~DY command. The data field of the
returned ~DY command is always encoded in the ZB64 format.

6/8/10 Zebra Programming Guide P1012728-004

234 ZPL Commands
^HZ

^HZ
Display Description Information
Description The ^HZ command is used for returning printer description information in
XML format. The printer returns information on format parameters, object directories,
individual object data, and print status information.

Format ^HZb

Parameters Details
b = display description to Accepted Values:
return a = display all information
f = display printer format setting information
l = display object directory listing information
o = display individual object data information
r = display printer status information
Default Value: if the value is missing or invalid, the command is ignored

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 235
^HZ

Format ^HZO,d:o.x,l

Parameters Details
d = location of stored Accepted Values: R:, E:, B:, and A:
object Default Value: R:
o = object name Accepted Values: 1 to 8, or 1 to 16 alphanumeric characters based on
parameter l.
Default Value: if a name is not specified, UNKNOWN is used.
x = extension Supported extensions for objects (parameter o) include:
.FNT — font
.GRF — graphic
.PNG — compressed graphic
.ZPL — stored format
.DAT — encoding table
.ZOB — downloadable object
.STO — Alert data file
l = long filename support Accepted Values:
Y = Yes
If Y, the object data stores the filename as 16 characters. The data is
only compatible with firmware version V60.13.0.5, or later.
N = No
If N, the object data stores the filename as 8 characters. The data is
forward and backward compatible with all versions of firmware.
Default Value: N

Example • This example shows the object data information for the object SAMPLE.GRF
located on R:.
^XA
^HZO,R:SAMPLE.GRF
^XZ

6/8/10 Zebra Programming Guide P1012728-004

236 ZPL Commands
^ID

^ID
Object Delete
Description The ^ID command deletes objects, graphics, fonts, and stored formats from
storage areas. Objects can be deleted selectively or in groups. This command can be used
within a printing format to delete objects before saving new ones, or in a stand-alone format to
delete objects.

The image name and extension support the use of the asterisk (*) as a wild card. This allows
you to easily delete a selected groups of objects.

Format ^IDd:o.x

Parameters Details
d = location of stored Accepted Values: R:, E:, B:, and A:
object Default Value: R:
o = object name Accepted Values: any 1 to 8 character name
Default Value: if a name is not specified, UNKNOWN is used
x = extension Accepted Values: any extension conforming to Zebra conventions
Default Value: .GRF

Example 1 • To delete stored formats from DRAM:

^XA
^IDR:*.ZPL^FS
^XZ

Example 2 • To delete formats and images named SAMPLE from DRAM, regardless of the
extension:
^XA
^IDR:SAMPLE.*^FS
^XZ

Example 3 • To delete the image SAMPLE1.GRF prior to storing SAMPLE2.GRF:

^XA
^FO25,25^AD,18,10
^FDDelete^FS
^FO25,45^AD,18,10
^FDthen Save^FS
^IDR:SAMPLE1.GRF^FS
^ISR:SAMPLE2.GRF^FS^XZ

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 237
^ID

Example 4 • In this the * is a wild card, indicating that all objects with the .GRF extension
are deleted:
^XA
^IDR:*.GRF^FS
^XZ

Comments When an object is deleted from R:, the object can no longer be used and
memory is available for storage. This applies only to R:memory. With the other memory types
(A:, B:, E:) the deleted object is no longer available. The memory space recovers when an
automatic defragmentation or initialization occurs.

The ^ID command also frees up the uncompressed version of the object in DRAM.

If the name is specified as *.ZOB, all downloaded bar code fonts (or other objects) are
deleted.

If the named downloadable object cannot be found in the R:, E:, B:, and A: device, the
^ID command is ignored.

6/8/10 Zebra Programming Guide P1012728-004

238 ZPL Commands
^IL

^IL
Image Load
Description The ^IL command is used at the beginning of a label format to load a stored
image of a format and merge it with additional data. The image is always positioned at
^FO0,0.

Important • See ^IS on page 240.

Using this technique to overlay the image of constant information with variable data greatly
increases the throughput of the label format.

Format ^ILd:o.x

Parameters Details
d = location of stored Accepted Values: R:, E:, B:, and A:
object Default Value: R:
o = object name Accepted Values: 1 to 8 alphanumeric characters
Default Value: if a name is not specified, UNKNOWN is used
x = extension Fixed Value: .GRF, .PNG

Example • This example recalls the stored image SAMPLE2.GRF from DRAM and
overlays it with the additional data. The graphic was stored using the ^IS command. For the
stored label format, see the ^IS on page 240 command.

ZPL II CODE GENERATED LABEL

^XA
^ILR:SAMPLE2.GRF^FS
^CFD,36,20
^FO15,210
^FD900123^FS
^FO218,210
^FDLINE 12^FS
^FO15,360^AD
^FDZEBRA THERMAL^FS
^FO15,400^AD
^FDTRANSFER PRINTER^FS
^FO15,540
^FD54321^FS
^FO220,530
^FDZ58643^FS
^FO15,670^A0,27,18
^FDTesting Stored Graphic^FS
^FO15,700^A0,27,18
^FDLabel Formats!!^FS
^XZ

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 239
^IM

^IM
Image Move
Description The ^IM command performs a direct move of an image from storage area into
the bitmap. The command is identical to the ^XG command (Recall Graphic), except there are
no sizing parameters.

Format ^IMd:o.x

Parameters Details
d = location of stored Accepted Values: R:, E:, B:, and A:
object Default Value: search priority
o = object name Accepted Values: 1 to 8 alphanumeric characters
Default Value: if a name is not specified, UNKNOWN is used
x = extension Fixed Value: .GRF, .PNG

Example • This example moves the image SAMPLE.GRF from DRAM and prints it in
several locations in its original size.
^XA
^FO100,100^IMR:SAMPLE.GRF^FS
^FO100,200^IMR:SAMPLE.GRF^FS
^FO100,300^IMR:SAMPLE.GRF^FS
^FO100,400^IMR:SAMPLE.GRF^FS
^FO100,500^IMR:SAMPLE.GRF^FS
^XZ

Comments By using the ^FO command, the graphic image can be positioned anywhere on
the label.

The difference between ^IM and ^XG: ^IM does not have magnification, and therefore might
require less formatting time. However, to take advantage of this, the image must be at a 8-, 16-,
or 32-bit boundary.

6/8/10 Zebra Programming Guide P1012728-004

240 ZPL Commands
^IS

^IS
Image Save
Description The ^IS command is used within a label format to save that format as a
graphic image, rather than as a ZPL II script. It is typically used toward the end of a script. The
saved image can later be recalled with virtually no formatting time and overlaid with variable
data to form a complete label.

Using this technique to overlay the image of constant information with the variable data
greatly increases the throughput of the label format.
\

Important • See ^IL on page 238.

Format ^ISd:o.x,p

Parameters Details
d = location of stored Accepted Values: R:, E:, B:, and A:
object Default Value: R:
o = object name Accepted Values: 1 to 8 alphanumeric characters
Default Value: if a name is not specified, UNKNOWN is used
x = extension Accepted Values: .GRF or .PNG
Default Value: .GRF
p = print image after Accepted Values:
storing N = no
Y = yes
Default Value: Y

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 241
^IS

Example • This is an example of using the ^IS command to save a label format to DRAM.
The name used to store the graphic is SAMPLE2.GRF.

ZPL II CODE GENERATED LABEL

^XA
^LH10,15^FWN^BY3,3,85^CFD,36
^GB430,750,4^FS
^FO10,170^GB200,144,2^FS
^FO10,318^GB410,174,2^FS
^FO212,170^GB206,144,2^FS
^FO10,498^GB200,120,2^FSR
^FO212,498^GB209,120,2^FS
^FO4,150^GB422,10,10^FS
^FO135,20^A0,70,60
^FDZEBRA^FS
^FO80,100^A0,40,30
^FDTECHNOLOGIES CORP^FS
^FO15,180^CFD,18,10^FS
^FDARTICLE#^FS
^FO218,180
^FDLOCATION^FS
^FO15,328
^FDDESCRIPTION^FS
^FO15,508
^FDREQ.NO.^FS
^FO220,508
^FDWORK NUMBER^FS
^FO15,630^AD,36,20
^FDCOMMENTS:^FS
^ISR:SAMPLE2.GRF,Y
^XZ

6/8/10 Zebra Programming Guide P1012728-004

242 ZPL Commands
~JA

~JA
Cancel All
Description The ~JA command cancels all format commands in the buffer. It also cancels
any batches that are printing.

The printer stops after the current label is finished printing. All internal buffers are cleared of
data and the DATA LED turn off.

Submitting this command to the printer scans the buffer and deletes only the data before the
~JA in the input buffer — it does not scan the remainder of the buffer for additional ~JA
commands.

Format ~JA

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 243
^JB

^JB
Initialize Flash Memory
Description The ^JB command is used to initialize various types of Flash memory
available in the Zebra printers.

Format ^JBa

Parameters Details
a = device to initialize Acceptable Values:
A = Option Flash memory
B = Flash card (PCMCIA)
E = internal Flash memory
Default Value: a device must be specified

Example • This is an example of initializing the different types of flash memory:

^JBA – initializes initial Compact Flash memory when installed in the printer.
^JBB – initializes the optional Flash card when installed in the printer.
^JBE – initializes the optional Flash memory when installed in the printer.

Note • Initializing memory can take several minutes. Be sure to allow sufficient time for the
initialization to complete before power cycling the printer.

6/8/10 Zebra Programming Guide P1012728-004

244 ZPL Commands
~JB

~JB
Reset Optional Memory
Description The ~JB command is used for these conditions:
• The ~JB command must be sent to the printer if the battery supplying power to the battery
powered memory card fails and is replaced. A bad battery shows a battery dead condition
on the Printer Configuration Label.
• The ~JB command can also be used to intentionally clear (reinitialize) the B: memory
card. The card must not be write protected.

Format ~JB

Comments If the battery is replaced and this command is not sent to the printer, the
memory card cannot function.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 245
~JC

~JC
Set Media Sensor Calibration
Description The ~JC command is used to force a label length measurement and adjust the
media and ribbon sensor values.

Format ~JC

Comments In Continuous Mode, only the media and ribbon sensors are calibrated.

This command is ignored on the HC100™ printer.

6/8/10 Zebra Programming Guide P1012728-004

246 ZPL Commands
~JD

~JD
Enable Communications Diagnostics
Description The ~JD command initiates Diagnostic Mode, which produces an ASCII
printout (using current label length and full width of printer) of all characters received by the
printer. This printout includes the ASCII characters, the hexadecimal value, and any
communication errors.

Format ~JD

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 247
~JE

~JE
Disable Diagnostics
Description The ~JE command cancels Diagnostic Mode and returns the printer to normal
label printing.

Format ~JE

6/8/10 Zebra Programming Guide P1012728-004

248 ZPL Commands
~JF

~JF
Set Battery Condition
Description There are two low battery voltage levels sensed by the PA/PT400™ printers.
When battery voltage goes below the first level, the green LED begins flashing as a warning
but printing continues. When this warning occurs, it is recommended to recharge the battery.

As printing continues, a second low voltage level is reached. At this point, both green and
orange LEDs flash as a warning, and printing automatically pauses.

When pause on low voltage is active (~JFY) and the battery voltage level falls below the
second low voltage level, printing pauses and an error condition is displayed as an indication
that the printer should be plugged into the battery charger. By pressing FEED, printing
continues on a label-by-label basis, but there is a high risk of losing label format information
due to the continued decrease of battery voltage.

When pause on low voltage is not active (~JFN), and the battery voltage level falls below the
second low voltage level, printing continues and the orange LED remains off. If the battery
voltage continues to decrease, label information could be lost and cause the printer to stop
operating. This option should be selected only when the printer is connected to the Car Battery
Adapter. From time to time the printer might sense that battery voltage is below the first low
voltage level, but due to the continuous recharging of the car battery, further loss of battery
voltage is not a concern and printing continues.

If this option is not selected when using the Car Battery Adapter, you might need to press
FEED to take the printer out of Pause Mode and print each label.

Format ~JFp

Parameters Details
p = pause on low voltage Accepted Values: Y (pause on low voltage) or N (do not pause)
N is suggested when the printer is powered by the Car Battery Adapter.
Default Value: Y

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 249
~JG

~JG
Graphing Sensor Calibration
Description The ~JG command prints a graph (media sensor profile) of the sensor values.

Format ~JG

Example • Sending the ~JG command to a printer configured for thermal transfer produces
a series of labels resembling this image:

GENERATED LABELS

Comments The HC100™ printer does not perform a calibration, but does print a sensor
profile label.

6/8/10 Zebra Programming Guide P1012728-004

250 ZPL Commands
^JH

^JH
Early Warning Settings
Description The ^JH command configures the early warning messages that appear on the
LCD.

Supported Devices
• XiIII, XiIIIPlus, Xi4, RXi4
• PAX3, PAX4
• ZM400, ZM600, RZ400, RZ600
• S4M
• G-Series (“f” parameter only)

Format ^JHa,b,c,d,e,f,g,h,i,j

Parameter Details
a = early warning This parameter is for XiIIIPlus, Xi4, RXi4, PAX3, and PAX4 printers only.
media Accepted Values:
a = supplies warning E = enable
(Xi4 and RXi4 D = disable
printers only)
Default Value: D
b = labels per roll This parameter is for XiIIIPlus, PAX3, and PAX4 printers only.
Accepted Values: 100 to 9999
Default Value: 900
c = media replaced This parameter is for XiIIIPlus, PAX3, and PAX4 printers only.
Accepted Values:
Y = yes
N = no
Default Value: N

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 251
^JH

Parameter Details
d = ribbon length This parameter is for XiIIIPlus, PAX3, and PAX4 printers only.
The accepted values for the XiIII series printers are 100M through 450M. PAX
series printers allow for values up to 900M.
Accepted Values:
0 = 100M 10 = 600M
1 = 150M 11 = 650M
2 = 200M 12 = 700M
3 = 250M 13 = 750M
4 = 300M 14 = 800M
5 = 350M 15 = 850M
6 = 400M 16 = 900M
7 = 450M
8 = 500M
9 = 550M
Default Value: 7
e = ribbon replaced This parameter is for XiIIIPlus, PAX3, and PAX4 printers only.
Accepted Values:
Y = yes
N = no
Default Value: N
f = early warning This parameter is for Xi4, RXi4, PAX4, ZM400, ZM600, RZ400, RZ600, and
maintenance S4M printers only.
Accepted Values:
E = enabled
D = disabled
Default Value: D
Important • On G-Series printers, this parameter must be enabled for
the ^MA driven system to work.

6/8/10 Zebra Programming Guide P1012728-004

252 ZPL Commands
^JH

Parameter Details
g = head cleaning Accepted value exceptions: accepted values for XiIII printer are 100M
interval through 450M; accepted values for 600 dpi XiIII printers are 100M through
150M; accepted values for PAX4 series printers can accept values up to 900M
by increments of 50M; accepted values for ZM400/ZM600, RZ400/RZ600,
and S4M printers are 0M through 450M.
Accepted Values:
0 = 100M 11 = 650M
1 = 150M (default for 96XiIII) 12 = 700M
2 = 200M 13 = 750M
3 = 250M 14 = 800M
4 = 300M 15 = 850M
5 = 350M 16 = 900M
6 = 400M
7 = 450M (default for all except 96XiIII)
8 = 500M
9 = 550M
10= 600M
Default Value: see above
h = head clean Accepted Values:
N = No
Y = Yes
Default Value: N
i = head life Accepted Values:
threshold 0 – 0 in or off
100-3500000 in
Default Value: 1000000
j = head replaced Accepted Values:
N = no
Y = yes
Default Value: N

Comments To permanently save the changes to the ^JH command, send ^XA^JUS^XZ.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 253
^JI

^JI
Start ZBI (Zebra BASIC Interpreter)
Identifies features that are available in printers with firmware version V60.16.2Z, V53.16.2Z,
or later.

Description ^JI works much like the ~JI command. Both commands are sent to the
printer to initialize the Zebra BASIC Interpreter.
In interactive mode, ^JI can be sent through one of the communication ports (serial, parallel,
or Ethernet) to initialize the printer to receive ZBI commands. This command can be sent from
one of the Zebra software utilities, such as ZTools, or from a terminal emulation program.
When the command is received, the printer responds by sending a ZBI header back to the
console, along with the program version number. This indicates that the interpreter is active.

Format ^JId:o.x,b,c,d

Parameters Details
d = location of Acceptable Values: R:, E:, B:, and A:
program to run Default Value: location must be specified
after initialization
o = name of program Accepted Values: any valid program name
to run after Default Value: name must be specified
initialization
x = extension of Fixed Value: .BAS, .BAE
program to run .BAE is only supported in firmware version
after initialization V60.16.0Z or later
b = console control Accepted Values:
Y = console on
N = console off
Default Value: Y
c = echoing control Accepted Values:
Y = echo on
N = echo off
Default Value: Y
d = memory allocation Accepted Values: 20K to 1024K
for ZBI * Default Value: 50K

* This parameter is only available on printers with firmware V60.12.0.x or earlier.

Comments When the printer is turned on, it can receive ZPL II commands and label
formats. However, for the printer to recognize ZBI commands and programs, it must be
initialized using ^JI or ~JI.
Only one ZBI interpreter can be active in the printer at a time. If a second ^JI or ~JI
command is received while the interpreter is running, the command is ignored.

6/8/10 Zebra Programming Guide P1012728-004

254 ZPL Commands
^JI

The interpreter is deactivated by entering one of two commands:

ZPL at the ZBI prompt
~JQ at an active ZPL port

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 255
~JI

~JI
Start ZBI (Zebra BASIC Interpreter)
Identifies features that are available in printers with firmware version V60.16.2Z, V53.16.2Z,
or later.

Description ~JI works much like the ^JI command. Both commands are sent to the
printer to initialize the Zebra BASIC Interpreter.
In interactive mode, ~JI can be sent through one of the communication ports (serial, parallel,
or Ethernet) to initialize the printer to receive ZBI commands. This command can be sent from
one of the Zebra software utilities, such as ZTools, or from a standard PC program, such as
Hyper terminal.
When the command is received, the printer responds by sending a ZBI header back to the
console, along with the program version number. This indicates that the interpreter is active.

Format ~JI

Comments While receiving commands, the printer echoes the received characters back to
the source. This can be toggled on and off with the ZBI ECHO command.
When the printer is turned on, it can receive ZPL II commands and label formats. However, for
the printer to recognize ZBI commands and formats, it must be initialized using ^JI or ~JI.
Only one ZBI interpreter can be active in the printer at a time. If a second ~JI or ^JI
command is received while the interpreter is running, the command is ignored.
The interpreter is deactivated by entering one of these commands:
ZPL at the ZBI prompt
~JQ at an active ZPL port

6/8/10 Zebra Programming Guide P1012728-004

256 ZPL Commands
^JJ

^JJ
Set Auxiliary Port
Description The ^JJ command allows you to control an online verifier or applicator
device.

Format ^JJa,b,c,d,e,f

Parameters Details
a = operational mode for Accepted Values:
auxiliary port 0 = off
1 = reprint on error—the printer stops on a label with a verification error.
When PAUSE is pressed, the label reprints (if ^JZ is set to reprint).
If a bar code is near the upper edge of a label, the label feeds out far
enough for the bar code to be verified and then backfeeds to allow
the next label to be printed and verified.
2 = maximum throughput—the printer stops when a verification error is
detected. The printer starts printing the next label while the verifier is
still checking the previous label. This mode provides maximum
throughput, but does not allow the printer to stop immediately on a
label with a verification error.
Default Value: 0
b = application mode Accepted Values:
0 = off
1 = End Print signal normally high, and low only when the printer is
moving the label forward.
2 = End Print signal normally low, and high only when the printer is
moving the label forward.
3 = End Print signal normally high, and low for 20 ms when a label has
been printed and positioned.
4 = End Print signal normally low, and high for 20 ms when a label has
been printed and positioned.
Default Value: 0
c = application mode Accepted Values:
start signal print p = Pulse Mode – Start Print signal must be de-asserted before it can be
asserted for the next label.
l = Level Mode – Start Print signal does not need to be de-asserted to
print the next label. As long as the Start Print signal is low and a label
is formatted, a label prints.
Default Value: 0

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 257
^JJ

Parameters Details
d = application label Accepted Values:
error mode e = error mode—the printer asserts the Service Required signal
(svce_req - pin 10) on the application port, enters into Pause Mode,
and displays an error message on the LCD.
f = Feed Mode—a blank label prints when the web is not found where
expected to sync the printer to the media.
Default Value: f
e = reprint mode Accepted Values:
e = enabled—the last label reprints after the signal is asserted. If a label
is canceled, the label to be reprinted is also canceled. This mode
consumes more memory because the last printed label is not released
until it reprints.
d = disabled—printer ignores the Reprint signal.
Default Value: d
f = ribbon low mode Accepted Values:
e = enabled – printer warning issued when ribbon low.
d = disabled – printer warning not issued when ribbon low.
Default Value: e

6/8/10 Zebra Programming Guide P1012728-004

258 ZPL Commands
~JL

~JL
Set Label Length
Description The ~JL command is used to set the label length. Depending on the size of the
label, the printer feeds one or more blank labels.

Format ~JL

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 259
^JM

^JM
Set Dots per Millimeter
Description The ^JM command lowers the density of the print—24 dots/mm becomes 12,
12 dots/mm becomes 6, 8 dots/mm becomes 4, and 6 dots/mm becomes 3. ^JM also affects the
field origin (^FO) placement on the label (see example below).

When sent to the printer, the ^JM command doubles the format size of the label. Depending on
the printhead, normal dot-per-millimeter capabilities for a Zebra printer are 12 dots/mm (304
dots/inch), 8 dots/mm (203 dots/inch) or 6 dots/mm (153 dots/inch).

This command must be entered before the first ^FS command in a format. The effects of ^JM
are persistent.

Format ^JMn

Parameters Details
n = set dots per Accepted Values:
millimeter A = 24 dots/mm, 12 dots/mm, 8 dots/mm or 6 dots/mm
B = 12 dots/mm, 6 dots/mm, 4 dots/mm or 3 dots/mm
Default Value: A

Example • This example of the affects of alternating the dots per millimeter:

ZPL II CODE GENERATED LABEL

^XA
^JMA^FS
^FO100,100
^B2N,50,Y,N,N
^FD1234567890^FS
^XZ

^XA
^JMB^FS
^FO100,100
^B2N,50,Y,N,N
^FD1234567890^FS
^XZ

Comments If ^JMB is used, the UPS MaxiCode bar code becomes out of specification.

6/8/10 Zebra Programming Guide P1012728-004

260 ZPL Commands
~JN

~JN
Head Test Fatal
Description The ~JN command turns on the head test option. When activated, ~JN causes
the printer to halt when a head test failure is encountered.

Once an error is encountered the printer remains in error mode until the head test is turned off
(~JO) or power is cycled.

Format ~JN

Comments If the communications buffer is full, the printer is not able to receive data. In
this condition, the ~JO command is not received by the printer.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 261
~JO

~JO
Head Test Non-Fatal
Description The ~JO command configures the printer to run the head test with error
reporting enabled. When ~JO is used an error will be displayed and printing will stop if the
head test fails. The user can push the PAUSE button on the printer to bypass the error. This
command differs from the ~JN (Head Test Fatal) command in that a power cycle is not
required in the event of a head test failure.

~JO is the default print head test condition. This setting is changed when the printer receives a
~JN (Head Test Fatal) command.

Format ~JO

6/8/10 Zebra Programming Guide P1012728-004

262 ZPL Commands
~JP

~JP
Pause and Cancel Format
Description The ~JP command clears the format currently being processed and places the
printer into Pause Mode.

The command clears the next format that would print, or the oldest format from the buffer.
Each subsequent ~JP command clears the next buffered format until the buffer is empty. The
DATA indicator turns off when the buffer is empty and no data is being transmitted.

Issuing the ~JP command is identical to using CANCEL on the printer, but the printer does
not have to be in Pause Mode first.

Format ~JP

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 263
~JQ

~JQ
Terminate Zebra BASIC Interpreter
Identifies features that are available in printers with firmware version V60.16.2Z, V53.16.2Z,
or later.

Description The ~JQ command is used when Zebra BASIC Interpreter is active. Sending
~JQ to the printer terminates the ZBI session.

Format ~JQ

Comments Entering ZPL at the command prompt also terminates a ZBI session.

6/8/10 Zebra Programming Guide P1012728-004

264 ZPL Commands
~JR

~JR
Power On Reset
Description The ~JR command resets all of the printer’s internal software, performs a
power-on self-test (POST), clears the buffer and DRAM, and resets communication
parameters and default values. Issuing a ~JR command performs the same function as a
manual power-on reset.

Format ~JR

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 265
^JS

^JS
Sensor Select
Format ^JSa

Note • This command is ignored on Zebra ZM400/ZM600 and RZ400/RZ600 printers. This
command is only for use with the S4M and Z Series printers (with the exception of the
ZM400/ZM600/RZ400/RZ600).

Parameters Details
a = sensor selection Accepted Values:
A = auto select
R = reflective sensor
T = transmissive sensor
Default Value:
Z series = A
S4M = R

6/8/10 Zebra Programming Guide P1012728-004

266 ZPL Commands
~JS

~JS
Change Backfeed Sequence
Description The ~JS command is used to control the backfeed sequence. This command
can be used on printers with or without built-in cutters.

These are the primary applications:

• to allow programming of the rest point of the cut edge of continuous media.
• provide immediate backfeed after peel-off when the printer is used in a print/apply
application configuration.

This command stays in effect only until the printer is turned off, a new ~JS command is sent,
or the setting is changed on the control panel. When a ~JS command is encountered, it
overrides the current control panel setting for the Backfeed Sequence.

The most common way of eliminating backfeed is to operate in Rewind Mode. Rewind Mode
does not backfeed at all. After a label prints, the leading edge of the next label is placed at the
print line. This eliminates the need to backfeed and does not introduce a non printable area at
the leading edge or bottom of the label. It also does not allow the label to be taken from the
printer because it is not fed out from under the printhead.

Running in another mode with backfeed turned off allows the label to be removed and
eliminates the time-reduction of the backfeed sequence.

Format ~JSb

Parameters Details
b = backfeed order in Accepted Values:
relation to printing A = 100 percent backfeed after printing and cutting
B = 0 percent backfeed after printing and cutting, and
100 percent before printing the next label
N = normal — 90 percent backfeed after label is printed
O = off — turn backfeed off completely
10 to 90 = percentage value
The value entered must be a multiple of 10. Values not divisible by 10 are
rounded to the nearest acceptable value. For example, ~JS55 is accepted
as 50 percent backfeed.
Default Value: N

Comments When using a specific value, the difference between the value entered and 100
percent is calculated before the next label is printed. For example, a value of 40 means 40
percent of the backfeed takes place after the label is cut or removed. The remaining 60 percent
takes place before the next label is printed.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 267
~JS

The value for this command is also reflected in the Backfeed parameter on the printer
configuration label.
For ~JSN — the Backfeed parameter is listed as DEFAULT
For ~JSA — or 100% the Backfeed parameter is listed as AFTER
For ~JSB — or 0% the Backfeed parameter is listed as BEFORE
For ~JS10 — 10% of the backfeed takes place after the label is cut or removed. The
remaining 90% takes place before the next label is printed.

This command is ignored on the HC100™ printer.

6/8/10 Zebra Programming Guide P1012728-004

268 ZPL Commands
^JT

^JT
Head Test Interval
Description The ^JT command allows you to change the printhead test interval from every
100 labels to any desired interval. With the ^JT command, the printer is allowed to run the
test after printing a label. When a parameter is defined, the printer runs the test after printing a
set amount of labels.

The printer’s default head test state is off. Parameters for running the printhead test are defined
by the user.

Format ^JT####,a,b,c

Parameters Details
#### = four-digit Accepted Values: 0000 to 9999
number of labels If a value greater than 9999 is entered, it is ignored.
printed between head Default Value: 0000 (off)
tests
a = manually select range Accepted Values:
of elements to test N = no
Y = yes
Initial Value at Power-up: N
b = first element to check Accepted Values: 0 to 9999
when parameter a is Initial Value at Power-up: 0
Y
c = last element to check Accepted Values: 0 to 9999
when parameter a is Initial Value at Power-up: 9999
Y

Comments The ^JT command supports testing a range of print elements. The printer
automatically selects the test range by tracking which elements have been used since the
previous test.

^JT also turns on Automatic Mode to specify the first and last elements for the head test. This
makes it possible to select any specific area of the label or the entire print width.

If the last element selected is greater than the print width selected, the test stops at the selected
print width.

Whenever the head test command is received, a head test is performed on the next label unless
the count is set to 0 (zero).

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 269
^JU

^JU
Configuration Update
Description The ^JU command sets the active configuration for the printer.

Format ^JUa

Parameters Details
a = active configuration Accepted Values:
F = reload factory settings
N = reload factory network settings
These values are lost at power-off if not saved with ^JUS.
R = recall last saved settings
S = save current settings
These values are used at power-on.
Default Value: a value must be specified

6/8/10 Zebra Programming Guide P1012728-004

270 ZPL Commands
^JW

^JW
Set Ribbon Tension
Description ^JW sets the ribbon tension for the printer it is sent to.

Format ^JWt

Parameters Details
t = tension Accepted Values:
L = low
M = medium
H = high
Default Value: a value must be specified

Comments ^JW is used only for PAX series printers.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 271
~JX

~JX
Cancel Current Partially Input Format
Description The ~JX command cancels a format currently being sent to the printer. It does
not affect any formats currently being printed, or any subsequent formats that might be sent.

Format ~JX

6/8/10 Zebra Programming Guide P1012728-004

272 ZPL Commands
^JZ

^JZ
Reprint After Error
Description The ^JZ command reprints a partially printed label caused by a Ribbon
Out, Media Out, or Head Open error condition. The label is reprinted as soon as the
error condition is corrected.

This command remains active until another ^JZ command is sent to the printer or the printer
is turned off.

Format ^JZa

Parameters Details
a = reprint after error Accepted Values:
N = no
Y = yes
Initial Value at Power-up: Y

Comments ^JZ sets the error mode for the printer. If ^JZ changes, only labels printed
after the change are affected.

If the parameter is missing or incorrect, the command is ignored.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 273
~KB

~KB
Kill Battery (Battery Discharge Mode)
Description To maintain performance of the rechargeable battery in the portable printers,
the battery must be fully discharged and recharged regularly. The ~KB command places the
printer in battery discharge mode. This allows the battery to be drained without actually
printing.

Format ~KB

Comments While the printer is in Discharge Mode, the green power LED flashes in groups
of three flashes.

Discharge Mode might be terminated by sending a printing format to the printer or by pressing
either of the control panel keys.

If the battery charger is plugged into the printer, the battery is automatically recharged once the
discharge process is completed.

6/8/10 Zebra Programming Guide P1012728-004

274 ZPL Commands
^KD

^KD
Select Date and Time Format (for Real Time Clock)
Description The ^KD command selects the format that the Real-Time Clock’s date and
time information presents as on a configuration label. This is also displayed on the Printer Idle
LCD control panel display, and displayed while setting the date and time.

Format ^KDa

Parameters Details
a = value of date and Accepted Values:
time format 0 = normal, displays Version Number of firmware
1 = MM/DD/YY (24-hour clock)
2 = MM/DD/YY (12-hour clock)
3 = DD/MM/YY (24-hour clock)
4 = DD/MM/YY (12-hour clock)
Default Value: 0

Comments If the Real-Time Clock hardware is not present, Display Mode is set to 0
(Version Number).

If Display Mode is set to 0 (Version Number) and the Real-Time Clock hardware is present,
the date and time format on the configuration label is presented in format 1.

If Display Mode is set to 0 (Version Number) and the Real-Time Clock hardware is present,
the date and time format on the control panel display is presented in format 1.

For more details on select date and time format for the Real Time Clock, see Real Time Clock
on page 999.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 275
^KL

^KL
Define Language
Description The ^KL command selects the language displayed on the control panel.

Format ^KLa

Parameters Details
a = language Accepted Values:
1 = English
2 = Spanish
3 = French
4 = German
5 = Italian
6 = Norwegian
7 = Portuguese
8 = Swedish
9 = Danish
10 = Spanish2
11 = Dutch
12 = Finnish
13 = Japanese
14 = Korean f
15 = Simplified Chinese f
16 = Traditional Chinese f
17 = Russian f
18 = Polish f
Default Value: 1
f. These values are only supported on the Xi4, RXi4, ZM400/ ZM600, and RZ400/RZ600 printers.

6/8/10 Zebra Programming Guide P1012728-004

276 ZPL Commands
^KN

^KN
Define Printer Name
Description The printer’s network name and description can be set using the ^KN
command. ^KN is designed to make your Zebra printer easy for users to identify. The name the
administrator designates is listed on the configuration label and on the Web page generated by
the printer.

Format ^KNa,b

Parameters Details
a = printer name Accepted Values: up to 16 alphanumeric characters
Default Value: if a value is not entered, the current stored value is erased
If more than 16 characters are entered, only the first 16 are used.
b = printer description Accepted Values: up to 35 alphanumeric characters
Default Value: if a value is not entered, the current stored value is erased
If more than 35 characters are entered, only the first 35 are used.
Note • The value of this parameter will be displayed on the printer’s web page
in parentheses.

Example • This is an example of how to change the printer’s network name an description:
This shows how a configuration looks before using this command and after using this
command:
^XA
^KNZebra1,desk_printer
^XZ

Before using this command: After using this command:

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 277
^KP

^KP
Define Password
Description The ^KP command is used to define the password that must be entered to
access the control panel switches and LCD Setup Mode.

Format ^KPa,b

Parameters Details
a = mandatory four-digit Accepted Values: any four-digit numeric sequence
password Default Value: 1234
b = password level Accepted Values: 1, 2, 3, 4
Default Value: 3
Note • The b parameter applies only to the S4M printers.

Example 1 • This example shows how to set a new control panel password:
^XA
^KP5678
^XZ

Example 2 • This example shows how to set a new control panel password (5678) at a
specific password level (level 2) (applicable to the S4M printer only):
^XA
^KP5678,2
^XZ

Comments If you forget your password, the printer can be returned to a default Setup Mode
and the default password 1234 is valid again. Caution should be used, however — this also
sets the printer configuration values back to their defaults.

To return the printer to the default factory settings using ZPL, send this:
^XA
^JUF
^XZ

To return the printer to the default factory settings using the control panel keys, see your
printer’s User Guide for the procedure.

6/8/10 Zebra Programming Guide P1012728-004

278 ZPL Commands
^KV

^KV
Kiosk Values
Description The ^KV command sets several parameters that affect the printers operation
when ^MM is set to K - Kiosk mode

Supported Devices
• KR403

Format ^KVa,b,c,d,e

Parameters Details
a = kiosk cut amount Accepted Values:
0 = normal cut
10-60 = partial cut, value = mm of media left uncut
Default Value: 0
This parameter is ignored if it is missing or invalid. The current value of the
parameter remains unchanged.
b = kiosk cut margin Accepted Values:
2 - 9 = mm of distance
Default Value:
9 = mm of distance
This parameter is ignored if it is missing or invalid. The current value of the
parameter remains unchanged.
c = kiosk present type Accepted Values:
0 = Eject page when new page is printed
1 = Retract page when new page is printed
2 = Do nothing when new page is printed
Default Value: 0
This parameter is ignored if it is missing or invalid. The current value of the
parameter remains unchanged.
d = kiosk present timeout Accepted Values:
0–300 = If label is not taken, retract label when timeout expires. Timeout
is in seconds. Zero (0) indicates that there is no timeout. The label will stay
presented until removed manually or a new label is printed.
Default Value: 0
This parameter is ignored if it is missing or invalid. The current value of the
parameter remains unchanged.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 279
^KV

Parameters Details
e = presenter loop length Accepted Values:
0 = paper is fed straight through the presenter
3-1023 = loop length in mm.
Default Value: 400
400= gives a loop of approximately 400mm
This parameter is ignored if it is missing or invalid. The current value of the
parameter remains unchanged. . If this is greater than loop_length_max (see
SGD media.present.loop_length_max) then it will be set equal to
loop_length_max.

Kiosk Printing Examples

The following examples demonstrate the use of the ^KV, ^CN, ^PN and ^CP commands with
80mm wide continuous media and the printer set to Kiosk Mode (^MMK).

Example 1 • In this example, the ^KV command is set to the following:

• Cut - Full Cut
• Cut Margin - 9 mm
• Present Type - Eject page when the next page is printed
• Present Timeout - 6 seconds after printing, if the document is not taken, it will be
retracted
• Presenter Loop Length - No loop
^XA
^MMK
^KV0,9,0,6,0
^FO50,50^A0N,50,50^FDZebra Technologies^FS
^CN1
^PN0
^XZ

Note • The ^CN1 command (Cut Now) is included to ensure that a full cut is done. The
^PN0 (Present Now) command is included to ensure that the media is ejected when the user
pulls on the leading edge of the media. In this example, if the user does not pull on the
leading edge of the second document, it will be retracted.

6/8/10 Zebra Programming Guide P1012728-004

280 ZPL Commands
^KV

Example 2 • This example contains only one change from the Example 1 - the Presenter
Loop Length is now 100mm, and two documents will be printed instead of one.
^XA
^MMK
^KV0,9,2,6,100
^FO50,50^A0N,50,50^FDZebra Technologies^FS
^CN1^PN0
^PQ2
^XZ

Example 3 • In this example, two documents will be printed, each one will be ejected from
the printer.
^XA
^MMK
^KV0,9,2,6,100
^FO50,50^A0N,50,50^FDZebra Technologies^FS
^CN1^CP0
^PQ2
^XZ

Example 4 • In this example, two documents, with partial cuts, will be printed, and a third
document, with a full cut, will be printed.
^XA
^MMK
^KV50,9,0,0,0
^FO50,50^A0N,50,50^FDPartial Cut^FS
^CN0^PN0
^PQ2
^XZ
^XA
^MMK
^KV0,9,2,6,0
^FO50,50^A0N,50,50^FDFull Cut^FS
^CN1^CP0
^XZ

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 281
^KV

Example 5 • In this example, four documents will be printed – three with a partial cut and
the fourth with a full cut. Additionally, the document length is set to 406 dots and the Media
Tracking mode is set to "Continuous Media, Variable Length". The third document contains
fields that are positioned outside of the 406 dot length – however, because the printer is set to
“Continuous Media, Variable Length" Media Tracking mode, the printer will automatically
adjust the document length to compensate.
^XA
^MMK
^LL406
^KV20,9,0,0,0
^FO50,50^A0N,50,50^FDPartial Cut^FS
^CN0^PN0
^PQ2
^XZ

^XA
^MMK
^MNV
^KV20,9,0,0,0
^FO50,50^A0N,50,50^FDPartial Cut^FS
^FO50,150^A0N,50,50^FDPrinting Line 1^FS
^FO50,250^A0N,50,50^FDPrinting Line 2^FS
^FO50,350^A0N,50,50^FDPrinting Line 3^FS
^FO50,450^A0N,50,50^FDPrinting Line 4^FS
^FO50,550^A0N,50,50^FDPrinting Line 5^FS
^FO50,650^A0N,50,50^FDPrinting Line 6^FS
^FO50,750^A0N,50,50^FDPrinting Line 7^FS
^FO50,850^A0N,50,50^FDPrinting Line 8^FS
^FO50,950^A0N,50,50^FDPrinting Line 9^FS
^FO50,1050^A0N,50,50^FDPrinting Line 10^FS
^FO50,1150^A0N,50,50^FDPrinting Line 11^FS
^FO50,1250^A0N,50,50^FDPrinting Line 12^FS
^FO50,1350^A0N,50,50^FDPrinting Line 13^FS
^FO50,1450^A0N,50,50^FDPrinting Line 14^FS
^FO50,1550^A0N,50,50^FDPrinting Line 15^FS
^CN0^PN0
^XZ

^XA
^MMK
^KV0,9,0,0,0
^FO50,50^A0N,50,50^FDFull Cut^FS
^CN0^PN1^CP0
^PQ1
^XZ

6/8/10 Zebra Programming Guide P1012728-004

282 ZPL Commands
^LF

^LF
List Font Links
This command is available only for printers with firmware version V60.14.x, V50.14.x, or
later.

Description The ^LF command prints out a list of the linked fonts.

Example • This example shows that SWISS721.TTF is the based font. ANMDJ.TTF is the
first linked font, and MSGOTHIC.TTF is the second linked extension:

ZPL II CODE GENERATED LABEL

^XA
^LF
^XZ

This is the code that established the font links:

^XA
^FLE:ANMDJ.TTF,E:SWISS721.TTF,1^FS
^FLE:MSGOTHIC.TTF,E:SWISS721.TTF,1^FS
^XZ

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 283
^LH

^LH
Label Home
Description The ^LH command sets the label home position.

The default home position of a label is the upper-left corner (position 0,0 along the x and y
axis). This is the axis reference point for labels. Any area below and to the right of this point is
available for printing. The ^LH command changes this reference point. For instance, when
working with preprinted labels, use this command to move the reference point below the
preprinted area.

This command affects only fields that come after it. It is recommended to use ^LH as one of
the first commands in the label format.

Format ^LHx,y

Parameters Details
x = x-axis position (in Accepted Values: 0 to 32000
dots) Initial Value at Power-up: 0 or last permanently saved value
y = y-axis position (in Accepted Values: 0 to 32000
dots) Initial Value at Power-up: 0 or last permanently saved value

Depending on the printhead used in your printer, use one of these when figuring the values for
x and y:
6 dots = 1 mm, 152 dots = 1 inch
8 dots = 1 mm, 203 dots = 1 inch
11.8 dots = 1 mm, 300 dots = 1 inch
24 dots = 1 mm, 608 dots = 1 inch

Comments To be compatible with existing printers, this command must come before the
first ^FS (Field Separator) command. Once you have issued an ^LH command, the setting is
retained until you turn off the printer or send a new ^LH command to the printer.

6/8/10 Zebra Programming Guide P1012728-004

284 ZPL Commands
^LL

^LL
Label Length
Description The ^LL command defines the length of the label. This command is necessary
when using continuous media (media not divided into separate labels by gaps, spaces, notches,
slots, or holes).

To affect the current label and be compatible with existing printers, ^LL must come before the
first ^FS (Field Separator) command. Once you have issued ^LL, the setting is retained until
you turn off the printer or send a new ^LL command.

Format ^LLy

Parameters Details
y = y-axis position (in Accepted Values: 1 to 32000, not to exceed the maximum label size.
dots) While the printer accepts any value for this parameter, the amount of
memory installed determines the maximum length of the label.
Default Value: typically set through the LCD (if applicable), or to the
maximum label length capability of the printer.

Comments These formulas can be used to determine the value of y:

For 6 dot/mm printheads... Label length in inches x 152.4 (dots/inch) = y

For 8 dot/mm printheads... Label length in inches x 203.2 (dots/inch) = y

For 12 dot/mm printheads... Label length in inches x 304.8 (dots/inch) = y

For 24 dot/mm printheads... Label length in inches x 609.6 (dots/inch) = y

Values for y depend on the memory size. If the entered value for y exceeds the acceptable
limits, the bottom of the label is cut off. The label also shifts down from top to bottom.

If multiple ^LL commands are issued in the same label format, the last ^LL command affects
the next label unless it is prior to the first ^FS.

This command is ignored on the HC100™ printer.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 285
^LR

^LR
Label Reverse Print
Description The ^LR command reverses the printing of all fields in the label format. It
allows a field to appear as white over black or black over white.

Using the ^LR is identical to placing an ^FR command in all current and subsequent fields.

Format ^LRa

Parameters Details
a = reverse print all fields Accepted Values:
N = no
Y = yes
Initial Value at Power-up: N or last permanently saved value

Example • This is an example that shows printing white over black and black over white.
The ^GB command is used to create the black background.

ZPL II CODE GENERATED LABEL

^XA^LRY
^FO100,50
^GB195,203,195^FS
^FO180,110^CFG
^FDLABEL^FS
^FO130,170
^FDREVERSE^FS
^XZ

Comments The ^LR setting remains active unless turned off by ^LRN or the printer is
turned off.

Note • ^GB needs to be used together with ^LR.

Only fields following this command are affected.

6/8/10 Zebra Programming Guide P1012728-004

286 ZPL Commands
^LS

^LS
Label Shift
Description The ^LS command allows for compatibility with Z-130 printer formats that
are set for less than full label width. It is used to shift all field positions to the left so the same
commands used on a Z-130 or Z-220 Printer can be used on other Zebra printers.

To determine the value for the ^LS command, use this formula:
Z-130 and Z-220 values for ^LHx + ^FOx
(distance from edge of label) = printer value for ^LSa

If the print position is less than 0, set ^LS to 0.

Format ^LSa

Important • The ability to save the ^LS command depends on the version of firmware.

Parameters Details
a = shift left value (in Accepted Values: -9999 to 9999
dots) Initial Value at Power-up: 0

Comments When entering positive values, it is not necessary to use the + sign. The value is
assumed to be positive unless preceded by a negative sign (-).

To be compatible with existing Zebra printers, this command must come before the first ^FS
(Field Separator) command. Once you have issued an ^LS command, the setting is retained
until you turn off the printer or send a new ^LS command to the printer.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 287
^LT

^LT
Label Top
Description The ^LT command moves the entire label format a maximum of
120 dot rows up or down from its current position, in relation to the top edge of the label. A
negative value moves the format towards the top of the label; a positive value moves the
format away from the top of the label.

This command can be used to fine-tune the position of the finished label without having to
change any of the existing parameters.

Important • For some printer models, it is possible to request a negative value large enough
to cause the media to backup into the printer and become unthreaded from the platen. This
condition can result in a printer error or unpredictable results.

Format ^LTx

Parameters Details
x = label top (in dot Accepted Values:
rows) HC100: 0 to 120
XiIIIPlus 600dpi: -240 to 240
All other Zebra printers: -120 to 120
Default Value: a value must be specified or the command is ignored

Comments The Accepted Value range for x might be smaller depending on the printer
platform.

The Label Top value shown on the front panel of the printer is double the value used in the
ZPL format.

The ^LT command does not change the media rest position.

6/8/10 Zebra Programming Guide P1012728-004

288 ZPL Commands
^MA

^MA
Set Maintenance Alerts
This command is available only for printers with firmware version V60.15.x, V50.15.x, or
later.

Description The ^MA command controls how the printer issues printed maintenance alerts.
Maintenance alerts are labels that print with a warning that indicates the printhead needs to be
cleaned or changed.

Supported Devices
• Xi4, RXi4
• ZM400/ZM600, RZ400/RZ600
• S4M with v53.15.5Z or later
• G-Series
Important • ^MA settings do not impact or effect the functionality of the Xi4 Supplies
Warning system.

Format ^MAtype,print,printlabel_threshold,frequency,units

Parameters Details
type = type of alert Accepted Values:
R = head replacement
C = head cleaning
Default Value: This parameter must be specified as R or C for print,
printlabel_threshold, and frequency to be saved. However,
units will always be set.
print = determines Accepted Values:
if the alert prints Y = print a label
a label N = do not print label
Default Value: N
printlabel Accepted Values:
threshold= R = head replacement (unit of measurement for head is km with a range of
distance where 0 to 150 km)
the first alert C = clean head (unit of measurement is 1 meter = 39.37 inches with a
occurs range of 0 to 2000 meters. The range for G-Series printers is 100 to
2000 meters.
0 = off (when set to 0, the selected alert is disabled; otherwise it is
enabled.
Default Value: R = 50 km (1,968,500 inches) and C = 0 (off).

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 289
^MA

Parameters Details
frequency = The unit of measurement is in meters. The range is 0 to 2000. The range for G-
distance before Series printers is 0 or 5 to 2000 meters.When set to 0, the alert label is only
reissuing the printed on power-up or when the printer is reset.
alert Default Value: 0 (print on power-up).
units = odometer The units parameter reports units of the odometer and printhead maintenance
and printhead commands, as follows: ~HQOD,~HQPH,~WQOD, ~WQPH.
maintenance Accepted Values:
commands C = centimeters (displays as: cm)
I = inches (displays as: ")
M = meters (displays as: M)
Default Value: I

Example • This example sets the printed head cleaning message to print after five meters
and to repeat every one meter after that until a ~ROC command is issued.
The Early Warning Maintenance setting must be ON. To enable the maintenance alert system
on the G-Series™ printer the ^JH command is used; on other Zebra printers the front panel
can also be used.
1. To set ^MA to print out a label flagging the need to clean the head, type:
^XA^MAC,Y,5,1^XZ
When the threshold is met a label will print indicating that the head needs to be clean.
2. For this example, the message on the label looks like this:

For details resetting the units of measure, see the ~HQ examples on page 219.

Comments Any values outside the specified range are ignored.

The intent of this command is to cause a label to print when the defined threshold is reached.

6/8/10 Zebra Programming Guide P1012728-004

290 ZPL Commands
^MC

^MC
Map Clear
Description In normal operation, the bitmap is cleared after the format has been printed.
The ^MC command is used to retain the current bitmap. This applies to current and subsequent
labels until cleared with ^MCY.

Format ^MCa

Important • To produce a label template, ^MC must be used with ^FV.

Parameters Details
a = map clear Accepted Values: Y (clear bitmap) or N (do not clear bitmap)
Initial Value at Power-up: Y

Comments The ^MC command retains the image of the current label after formatting. It
appears in the background of the next label printed.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 291
^MD

^MD
Media Darkness
Description The ^MD command adjusts the darkness relative to the current darkness
setting.

Format ^MDa

Parameters Details
a = media darkness level Accepted Values: -30 to 30, depending on current value
Initial Value at Power-up: 0
If no value is entered, this command is ignored.

Example 1 • These examples show setting the printer to different darkness levels:
• If the current value (value on configuration label) is 16, entering the command ^MD-9
decreases the value to 7.
• If the current value (value on configuration label) is 1, entering the command ^MD15
increases the value to 16.
• If the current value (value on configuration label) is 25, entering the command ^MD10
increases only the value to 30, which is the maximum value allowed.
Each ^MD command is treated separately in relation to the current value as printed on the
configuration label.

Note • On Zebra G-Series™ printers the value set with the ^MD command is persistent
across label formats.

Important • The darkness setting range for the XiIIIPlus, Xi4, and RXi4 is 0 to 30 in
increments of 0.1.
The firmware is setup so that the ^MD and ~SD commands (ZPL darkness commands)
accepts that range of settings.

Example 2 • These are examples of the XiIIIPlus, Xi4, and RXi4 Darkness Setting:

^MD8.3

~SD8.3

Example 3 • For example, this is what would happen if two ^MD commands were received:
Assume the current value is 15. An ^MD-6 command is received that changes the current
value to 9. Another command, ^MD2, is received. The current value changes to 17.
The two ^MD commands are treated individually in relation to the current value of 15.

Comments The ~SD command value, if applicable, is added to the ^MD command.

6/8/10 Zebra Programming Guide P1012728-004

292 ZPL Commands
^MF

^MF
Media Feed
Description The ^MF command dictates what happens to the media at power-up and at
head-close after the error clears.

Format ^MFp,h

Parameters Details
p = feed action at power- Accepted Values:
up F = feed to the first web after sensor
C = (see ~JC on page 245 definition)
L = (see ~JL on page 258 definition)
N = no media feed
S = short calibration g
Default Value: C
h = feed action after Accepted Values:
closing printhead F = feed to the first web after sensor
C = (see ~JC on page 245 definition)
L = (see ~JL on page 258 definition)
N = no media feed
S = short calibration g
Default Value: C
g. These values are supported only on Xi4, RXi4, XiIIIPlus, PAX, ZM400/ZM600, RZ400/RZ600, and S4M printers.

Comments It is important to remember that if you choose the N setting, the printer
assumes that the media and its position relative to the printhead are the same as before power
was turned off or the printhead was opened. Use the ^JU command to save changes.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 293
^MI

^MI
Set Maintenance Information Message
This command is available only for printers with firmware version V60.15.x, V50.15.x, or
later.

Description The ^MI command controls the content of maintenance alert messages, which
are reminders printed by the printer to instruct the operator to clean or replace the printhead.

Supported Devices
• Xi4, RXi4
• ZM400/ZM600m RZ400/RZ600
• S4M with v53.15.5Z or later
• G-Series

Format ^MItype,message

Parameters Details
type = identifies the Accepted Values:
type of alert R = head replacement
C = head cleaning
Default Value: R
message = message The maximum length of each message is 63 characters. All characters
that prints on the following the comma and preceding the next tilde (~) or carat (^) define the
label when a message string. Commas (,) are not allowed in the message.
maintenance Default Value:
alert occurs HEAD CLEANING = please clean printhead
HEAD REPLACEMENT = please replace printhead

Example • This example sets the printhead (head) replacement warning message. Printing of
this message is controlled by the ^MA command.
1. To customize the text of this label, type something like this:
^XA^MIR,PRINT HEAD NEEDS REPLACEMENT - CALL EXT 1000^XZ
The label prints whatever you program it to say.
2. For this example, the message on the label looks like this:

6/8/10 Zebra Programming Guide P1012728-004

294 ZPL Commands
^ML

^ML
Maximum Label Length
Description The ^ML command lets you adjust the maximum label length.

Format ^MLa

Parameters Details
a = maximum label Accepted Values: 0 to maximum length of label
length (in dot rows) Default Value: last permanently saved value

Comments For calibration to work properly, you must set the maximum label length equal
to or greater than your actual label length.

This command is ignored on the HC100™ printer.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL II Commands for RFID 295
^MM

^MM
Print Mode
Description The ^MM command determines the action the printer takes after a label or
group of labels has printed.

Note • Refer to the User Guide for your printer to determine which print modes are
supported by your printer.

Format ^MMa,b

Parameters Details
a = desired mode Accepted Values:
T = Tear-off h
P = Peel-off (not available on S-300) h
R = Rewind (depends on printer model)
A = Applicator (depends on printer model) h
C = Cutter (depends on printer model)
D = Delayed cutter h
F = RFID h
L = Reserved h, i
U = Reserved h, i
K = Kiosk j
Default Value:
The values available for parameter a depend on the printer being used and
whether it supports the option.
For RFID printers:
A = R110PAX4 print engines
F = other RFID printers

b = prepeel select Accepted Values:

N = no
Y = yes
Default Value: N
The command is ignored if parameters are missing or invalid. The current
value of the command remains unchanged.
h. This value is not supported on the KR403 printer.
i. This value is supported only on the ZM400/ZM600 and RZ400/RZ600 printers.
j. This value is supported only the KR403 printer.

6/8/10 Zebra Programming Guide P1012728-004

296 ZPL II Commands for RFID
^MM

This list identifies the different modes of operation:

• Tear-off — after printing, the label advances so the web is over the tear bar. The label,
with liner attached, can be torn off manually.
• Peel-off — after printing, the label moves forward and activates a Label Available Sensor.
Printing stops until the label is manually removed from the printer.
Power Peel – liner automatically rewinds using an optional internal rewind spindle.
Value Peel – liner feeds down the front of the printer and is manually removed.
Prepeel – after each label is manually removed, the printer feeds the next label forward to
prepeel a small portion of the label away from the liner material. The printer then
backfeeds and prints the label. The prepeel feature assists in the proper peel operation of
some media types.
• Rewind — the label and liner are rewound on an (optional) external rewind device. The
next label is positioned under the printhead (no backfeed motion).
• Applicator — when used with an application device, the label move far enough forward to
be removed by the applicator and applied to an item. This applies only to printers that
have applicator ports and that are being used in a print-and-apply system.
• Cutter — after printing, the media feeds forward and is automatically cut into
predetermined lengths.
• Delayed cutter — When the printer is in the Delayed Cut PRINT MODE, it will cut the
label when it receives the ~JK (Delayed Cut) command. To activate the ~JK command,
the printer's PRINT MODE must be set to Delayed Cut and there must be a label waiting
to be cut. When the printer is not in the Delayed Cut PRINT MODE, the printer will not
cut the label when it receives the ~JK command.

Note • Send ~JK in a separate file - it cannot be sent at the end of a set of commands.

The Delayed Cut feature can be activated:

• through PRINT MODE on the printer’s control panel
• with a ^MMD command
• RFID — increases throughput time when printing batches of RFID labels by eliminating
backfeed between labels.
• Kiosk — after printing, the media is moved in a presentation position, most applications
maintain a loop of media in the printer.

Comments Be sure to select the appropriate value for the print mode being used to avoid
unexpected results.

This command is ignored on the HC100™ printer.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 297
^MN

^MN
Media Tracking
Description The ^MN command relays to the printer what type of media is being used
(continuous or non-continuous) for purposes of tracking.

This bulleted list shows the types of media associated with this command:
• Continuous Media – this media has no physical characteristic (such as a web, notch,
perforation, black mark) to separate labels. Label length is determined by the ^LL
command.
• Continuous Media, variable length – same as Continuous Media, but if portions of the
printed label fall outside of the defined label length, the label size will automatically be
extended to contain them. This label length extension applies only to the current label.
Note that ^MNV still requires the use of the ^LL command to define the initial desired
label length.
• Non-continuous Media – this media has some type of physical characteristic (such as web,
notch, perforation, black mark) to separate the labels.

Format ^MNa,b

Parameters Details
a = media being used Accepted Values:
N = continuous media
Y = non-continuous media web sensing k, l
W = non-continuous media web sensing k, l
M = non-continuous media mark sensing
A = auto-detects the type of media during calibration k, m
V = continuous media, variable length n
Default Value: a value must be entered or the command is ignored
b = black mark offset in This sets the expected location of the media mark relative to the point of
dots separation between documents. If set to 0, the media mark is expected to be
found at the point of separation. (i.e., the perforation, cut point, etc.)
All values are listed in dots. This parameter is ignored unless the a parameter is
set to M. If this parameter is missing, the default value is used.
Accepted Values:
-80 to 283 for direct-thermal only printers
-240 to 566 for 600 dpi printers
-120 to 283 for all other printers
Default Value: 0
k. Provides the same result.
l. This value is not supported on the KR403 printer.
m. This parameter is supported only on G-series printers.
n. This parameter is supported only on the KR403 printer.

Comments This command is ignored on the HC100™ printer.

6/8/10 Zebra Programming Guide P1012728-004

298 ZPL Commands
^MP

^MP
Mode Protection
Description The ^MP command is used to disable the various mode functions on the
control panel. Once disabled, the settings for the particular mode function can no longer be
changed and the LED associated with the function does not light.

Because this command has only one parameter, each mode must be disabled with an individual
^MP command.

Format ^MPa

Parameters Details
a = mode to protect Accepted Values:
D = disable Darkness Mode
P = disable Position Mode
C = disable Calibration Mode
E = enable all modes
S = disable all mode saves (modes can be adjusted but values are not
saved)
W = disable Pause
F = disable Feed
X = disable Cancel
M = disable menu changes
Default Value: a value must be entered or the command is ignored

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 299
^MP

Example • This example shows the ZPL code that disables modes D and C. It also shows the
effects on the configuration label before and after the ZPL code is sent:
^XA
^MPD
^MPC
^XZ

Before

After

6/8/10 Zebra Programming Guide P1012728-004

300 ZPL Commands
^MT

^MT
Media Type
Description The ^MT command selects the type of media being used in the printer.

These are the choices for this command:

• Thermal Transfer Media – this media uses a high-carbon black or colored ribbon. The
ink on the ribbon is bonded to the media.
• Direct Thermal Media – this media is heat sensitive and requires no ribbon.

Format ^MTa

Parameters Details
a = media type used Accepted Values:
T = thermal transfer media
D = direct thermal media
Default Value: a value must be entered or the command is
ignored

Comments This command is ignored on the HC100™ printer.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 301
^MU

^MU
Set Units of Measurement
Description The ^MU command sets the units of measurement the printer uses. ^MU works
on a field-by-field basis. Once the mode of units is set, it carries over from field to field until a
new mode of units is entered.

^MU also allows for printing at lower resolutions — 600 dpi printers are capable of printing at
300, 200, and 150 dpi; 300 dpi printers are capable of printing at 150 dpi.

Format ^MUa,b,c

Parameters Details
a = units Accepted Values:
D = dots
I = inches
M = millimeters
Default Value: D
b = format base in dots Accepted Values: 150, 200, 300
per inch Default Value: a value must be entered or the command is ignored
c = desired dots-per-inch Accepted Values: 300, 600
conversion Default Value: a value must be entered or the command is ignored

Example 1 • This is an example of Setting Units:

Assume 8 dot/millimeter (203 dot/inch) printer.
Field based on dots:
^MUd^FO100,100^GB1024,128,128^FS
Field based on millimeters:
^MUm^FO12.5,12.5^GB128,16,16^FS
Field based on inches:
^MUi^FO.493,.493^GB5.044,.631,.631^FS

6/8/10 Zebra Programming Guide P1012728-004

302 ZPL Commands
^MU

Example 2 • This is an example of Converting dpi Values.

Convert a 150 dpi format to a 300 dpi format with a base in dots:
^MUd,150,300
Convert a 150 dpi format to a 600 dpi format with a base in dots:
^MUd,150,600
Convert a 200 dpi format to a 600 dpi format with a base in dots:
^MUd,200,600
To reset the conversion factor to the original format, enter matching values for
parameters b and c:
^MUd,150,150
^MUd,200,200
^MUd,300,300
^MUd,600,600

Comments This command should appear at the beginning of the label format to be in
proper ZPL II format.

To turn the conversion off, enter matching values for parameter b and c.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 303
^MW

^MW
Modify Head Cold Warning
Description The ^MW command allows you to set the head cold warning indicator based on
the operating environment.

Format ^MWa

Parameters Details
a = enable head cold Accepted Values:
warning Y = enable head cold warning
N = disable head cold warning

Important • When a parameter is not given, the instruction is ignored.

6/8/10 Zebra Programming Guide P1012728-004

304 ZPL Commands
^NC

^NC
Select the Primary Network Device
Description The ^NC command selects the wired or wireless print server as the primary
network device.

Supported Devices
• Xi4, RXi4
• ZM400/ZM600, RZ400/RZ600

The Xi4, RXi4, ZM400/ZM600, and RZ400/RZ600 printers support the simultaneous
installation of an internal, external, and a wireless print server. Even though all three print
servers may be installed, only one is connected to the network and is the active print server.
Table 15 outlines priorities and identifies which device becomes the active print server when
multiple print servers are installed.

Table 15 • Effect of Primary Network Setting on Active Print Server

If the Installed and Connected to

Primary a Live Ethernet Network Then, the Active
Network is Print Server will be:
set to: Internal External Wireless o

X X X Internal
Wired X X External
X Wireless
X X X Wireless
Wireless X X Internal
X External
o. A wireless option board must have an active radio that can properly associate to an access point.

Format ^NCa

Parameters Details
a = primary network Accepted Values:
device 1 = wired primary
2 = wireless primary
Default Value: 1
must be an accepted value or it is ignored

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 305
~NC

~NC
Network Connect
Description The ~NC command is used to connect a particular printer to a network by
calling up the printer’s network ID number.

Format ~NC###

Parameters Details
### = network ID Accepted Values: 001 to 999
number assigned Default Value: 000 (none)
(must be a three-digit
entry)

Comments Use this command at the beginning of any label format to specify which printer
on the network is going to be used. Once the printer is established, it continues to be used until
it is changed by another ~NC command. This command must be included in the label format to
wake up the printer.

The commands ^MW, ~NC, ^NI, ~NR, and ~NT are used only with RS-422/485 printer
communications.

6/8/10 Zebra Programming Guide P1012728-004

306 ZPL Wireless Commands
^ND

^ND
Change Network Settings
Description The ^ND command changes the network settings on supported printers.

For the external wired print server settings, the ^ND command is the same as the ^NS
command. For the wireless print server settings, the ^ND command is the same as the ^WI
command.

Supported Devices
• Xi4 with firmware V53.17.1Z or later
• RXi4
• RZ400/RZ600 with firmware R53.15.xZ or later
• ZM400/ZM600 with firmware V53.15.xZ or later
• G-Series

Format ^NDa,b,c,d,e,f,g,h,i,j

Parameters Details
a = the device that is Accepted Values:
being modified 1 = external wired
2 = internal wired
3 = wireless
b = IP resolution Accepted Values:
A = All
B = BOOTP
C = DHCP and BOOTP
D = DHCP
G = Gleaning only (Not recommended when the Wireless Print Server or
Wireless Plus Print Server is installed.)
R = RARP
P = Permanent
Default Value: A
c = IP address Accepted Values: Any properly formatted IP address in the xxx.xxx.xxx.xxx
format.
d = subnet mask Accepted Values: Any properly formatted subnet mask in the xxx.xxx.xxx.xxx
format.
e = default gateway Accepted Values: Any properly formatted gateway in the xxx.xxx.xxx.xxx
format.
f = WINS server Accepted Values: Any properly formatted WINS server in the xxx.xxx.xxx.xxx
address format.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Wireless Commands 307
^ND

Parameters Details
g = connection Accepted Values:
timeout checking Y = yes
N = no
Default Value: Y
h = timeout value Time, in seconds, before the connection times out.
Accepted Values: 0 through 9999
Default Value: 300
i = ARP broadcast Time, in minutes, that the broadcast is sent to update the device’s ARP cache.
interval Accepted Values: 0 through 30
Default Value: 0 (no ARP sent)
j = base raw port The port number that the printer should use for its RAW data.
number Accepted Values: 1 through 65535
Default Value: 9100

6/8/10 Zebra Programming Guide P1012728-004

308 ZPL Commands
^NI

^NI
Network ID Number
Description The ^NI command is used to assign a network ID number to the printer. This
must be done before the printer can be used in a network.

Format ^NI###

Parameters Details
### = network ID Accepted Values: 001 to 999
number assigned Default Value: 000 (none)
(must be a three-digit
entry)

Comments The last network ID number set is the one recognized by the system.

The commands ~NC, ^NI, ~NR, and ~NT are used only with RS-485 printer
communications.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 309
~NR

~NR
Set All Network Printers Transparent
Description The ~NR command sets all printers in the network to be transparent, regardless
of ID or current mode.

Format ~NR

Comments The commands ~NC, ^NI, ~NR, and ~NT are used only with RS-485 printer
communications.

6/8/10 Zebra Programming Guide P1012728-004

310 ZPL Commands
^NS

^NS
Change Wired Networking Settings
Description Use this command to change the wired print server network settings.

Format ^NSa,b,c,d,e,f,g,h,i

Parameters Details
a = IP resolution Accepted Values:
A = ALL
B = BOOTP
C = DHCP AND BOOTP
D = DHCP
G = GLEANING ONLY
R = RARP
P = PERMANENT
Default Value: A
Use of GLEANING ONLY is not recommended when the Wireless Print
Server or Wireless Plus Print Server is installed.
b = IP address Accepted Values: Any properly formatted IP address in the xxx.xxx.xxx.xxx
format.
c = subnet mask Accepted Values: Any properly formatted subnet mask in the xxx.xxx.xxx.xxx
format.
d = default gateway Accepted Values: Any properly formatted gateway in the xxx.xxx.xxx.xxx
format.
e = WINS server address Accepted Values: Any properly formatted WINS server in the xxx.xxx.xxx.xxx
format.
f = connection timeout Accepted Values:
checking Y = Yes
N = No
Default Value: Y
g = timeout value Time, in seconds, before the connection times out.
Accepted Values: 0 through 9999
Default Value: 300
h = ARP broadcast Time, in minutes, that the broadcast is sent to update the device’s ARP cache.
interval Accepted Values: 0 through 30
Default Value: 0 (no ARP sent)
i = base raw port number The port number that the printer should use for its RAW data.
Accepted Values: 1 through 65535
Default Value: 9100

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 311
^NS

Comments For the Xi4, RXI4, ZM400/ZM600, and RZ400/RZ600 printers, Zebra
recommends that you use the ^ND command instead of the ^NS command.

Example •
^XA
^NSa,192.168.0.1,255.255.255.0,192.168.0.2
^XZ

6/8/10 Zebra Programming Guide P1012728-004

312 ZPL Commands
~NT

~NT
Set Currently Connected Printer Transparent
Description The ~NT command sets the currently connected network printer to be
transparent.

Format ~NT

Comments With Z Series® printers, the ~NT command functions the same as the ~NR
command. All Z Series printers on a network receive the transmission.

The commands ~NC, ^NI, ~NR, and ~NT are used only with RS-485 printer
communications.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 313
^PA

^PA
Advanced Text Properties
This command is available only for printers with firmware version V60.14.x, V50.14.x, or
later.

Description The ^PA command is used to configure advanced text layout features.

Format ^PAa,b,c,d

Parameters Details
a = default glyph This determines whether the default glyph is a space character or the default
glyph of the base font, which is typically a hollow box.
Accepted Values:
0 = off (space as default glyph)
1 = on (default glyph of font is used, often a hollow box, but depends on
the font.)
Default Value: 0
b = bidirectional text This determines whether the bidirectional text layout is turned on or off.
layout Accepted Values:
0 = off
1 = on
Default Value: 0
c = character shaping This determines whether character shaping is turned on or off.
Accepted Values:
0 = off
1 = on
Default Value: 0
d = OpenType table This determines whether the OpenType support is turned on or off.
support Accepted Values:
0 = off
1 = on
Default Value: 0

6/8/10 Zebra Programming Guide P1012728-004

314 ZPL Commands
^PF

^PF
Slew Given Number of Dot Rows
Description The ^PF command causes the printer to slew labels (move labels at a high
speed without printing) a specified number of dot rows from the bottom of the label. This
allows faster printing when the bottom portion of a label is blank.

Format ^PF#

Parameters Details
# = number of dots rows Accepted Values: 0 to 32000
to slew Default Value: a value must be entered or the command is ignored

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 315
^PH ~PH

^PH ~PH
Slew to Home Position
Description The ^PH or ~PH command causes the printer to feed one blank label.

The ~PH command feeds one label after the format currently being printed is done or when the
printer is placed in pause.

The ^PH command feeds one blank label after the current format prints.

Format ^PH or ~PH

6/8/10 Zebra Programming Guide P1012728-004

316 ZPL Commands
~PL

~PL
Present Length Addition
Description The ~PL command adds an additional amount to how far the paper is ejected
during a present cycle. A standard amount of 50mm is always added to clear the kiosk wall.
This amount is added to that 50mm. The total amount of media ejected when a ^PN is
executed, then, is 50mm + ~PL value + ^PN value.

Supported Devices
• KR403

Format ^PLa

Parameters Details
a = additional eject Accepted Values:
length 000-255 = additional mm of media to eject
Default Value: 000
The command is ignored if parameters are missing or invalid.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 317
^PM

^PM
Printing Mirror Image of Label
Description The ^PM command prints the entire printable area of the label as a mirror
image. This command flips the image from left to right.

Format ^PMa

Parameters Details
a = print mirror image of Accepted Values:
entire label N = no
Y = yes
Default Value: N

Example • This is an example of printing a mirror image on a label:

ZPL II CODE GENERATED LABEL

^XA^PMY
^FO100,100
^CFG
^FDMIRROR^FS
^FO100,160
^FDIMAGE^FS
^XZ

Comments If the parameter is missing or invalid, the command is ignored. Once entered,
the ^PM command remains active until ^PMN is received or the printer is turned off.

6/8/10 Zebra Programming Guide P1012728-004

318 ZPL Commands
^PN

^PN
Present Now
Description The ^PN command causes the printer to run a Presenter cycle. The parameter
defines the amount of media ejected. The total amount of media ejected when a ^PN is
executed, then, is 50mm + ~PL value + ^PN value. (See ~PL on page 316).

Supported Devices
• KR403

Format ^PNa

Parameters Details
a = media eject length Accepted Values:
0-255 = additional mm of media to eject
Default Value: none
The command is ignored if parameters are missing or invalid.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 319
^PO

^PO
Print Orientation
Description The ^PO command inverts the label format 180 degrees. The label appears to
be printed upside down. If the original label contains commands such as ^LL, ^LS, ^LT and
^PF, the inverted label output is affected differently.

Format ^POa

Parameters Details
a = invert label Accepted Values:
180 degrees N = normal
I = invert
Default Value: N

Example • This is an example of printing a label at 180 degrees:

ZPL II CODE GENERATED LABEL

^XA^CFD
^POI
^LH330,10
^FO50,50
^FDZEBRA TECHNOLOGIES^FS
^FO50,75
^FDVernon Hills, IL^FS
^XZ

The ^POI command inverts the x, y coordinates. All image placement is relative to these
inverted coordinates. Therefore, a different ^LH (Label Home) can be used to move the print
back onto the label.

Comments If multiple ^PO commands are issued in the same label format, only the last
command sent to the printer is used.

Once the ^PO command is sent, the setting is retained until another ^PO command is received
or the printer is turned off.

The N value for the a parameter is not supported on the HC100™ printer.

6/8/10 Zebra Programming Guide P1012728-004

320 ZPL Commands
^PP ~PP

^PP ~PP
Programmable Pause
Description The ~PP command stops printing after the current label is complete (if one is
printing) and places the printer in Pause Mode.

The ^PP command is not immediate. Therefore, several labels might print before a pause is
performed. This command pauses the printer after the current format prints.

The operation is identical to pressing PAUSE on the control panel of the printer. The printer
remains paused until PAUSE is pressed or a ~PS (Print Start) command is sent to the printer.

Format ^PP or ~PP

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 321
^PQ

^PQ
Print Quantity
Description The ^PQ command gives control over several printing operations. It controls
the number of labels to print, the number of labels printed before printer pauses, and the
number of replications of each serial number.

Format ^PQq,p,r,o

Parameters Details
q = total quantity of Accepted Value: 1 to 99,999,999
labels to print Default Value: 1
p = pause and cut value Accepted Value: 1 to 99,999,999
(labels between Default Value: 0 (no pause)
pauses)
r = replicates of each Accepted Value: 0 to 99,999,999 replicates
serial number Default Value: 0 (no replicates)
o = override pause count Accepted Values:
N = no
Y = yes
Default Value: N

If the o parameter is set to Y, the printer cuts but does not pause, and the printer does not pause
after every group count of labels has been printed. With the o parameter set to N (default), the
printer pauses after every group count of labels has been printed.

Example • This example shows the control over print operations:

^PQ50,10,1,Y: This example prints a total of 50 labels with one replicate of each serial
number. It prints the total quantity in groups of 10, but does not pause after every group.

^PQ50,10,1,N: This example prints a total of 50 labels with one replicate of each serial
number. It prints the total quantity in groups of 10, pausing after every group.

6/8/10 Zebra Programming Guide P1012728-004

322 ZPL Commands
^PR

^PR
Print Rate
Description The ^PR command determines the media and slew speed (feeding a blank
label) during printing.

The printer operates with the selected speeds until the setting is reissued or the printer is turned
off.

The print speed is application-specific. Because print quality is affected by media, ribbon,
printing speeds, and printer operating modes, it is very important to run tests for your
applications.

Important • Some models go to default print speed when power is turned off.

Format ^PRp,s,b

Parameters Details
p = print speed Accepted Values:
1 = 25.4 mm/sec. (1 inch/sec.) a
A or 2 = 50.8 mm/sec. (2 inches/sec.)
B or 3 = 76.2 mm/sec. (3 inches/sec.)
C or 4 = 101.6 mm/sec. (4 inches/sec.)
5 = 127 mm/sec.(5 inches/sec.)
D or 6 = 152.4 mm/sec. (6 inches/sec.)
E or 8 = 203.2 mm/sec. (8 inches/sec.)
9 = 220.5 mm/sec. 9 inches/sec.)
10 = 245 mm/sec.(10 inches/sec.)
11 = 269.5 mm/sec.(11 inches/sec.)
12 = 304.8 mm/sec. 12 inches/sec.)
13 = 13 in/sec b
14 = 14 in/sec b
Default Value: A
a. This value is supported only on the 110Xi4-600dpi, 110XiIIIPlus-600dpi , and RXi printers.
b. This value is supported only on the Xi4 and RXi4 printers.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 323
^PR

Parameters Details
s = slew speed Accepted Values:
A or 2 = 50.8 mm/sec. (2 inches/sec.)
B or 3 = 76.2 mm/sec. (3 inches/sec.)
C or 4 = 101.6 mm/sec. (4 inches/sec.)
5 = 127 mm/sec. 5 inches/sec.)
D or 6 = 152.4 mm/sec. (6 inches/sec.)
E or 8 = 203.2 mm/sec. (8 inches/sec.)
9 = 220.5 mm/sec. (9 inches/sec.)
10 = 245 mm/sec. (10 inches/sec.)
11 = 269.5 mm/sec. 11 inches/sec.)
12 = 304.8 mm/sec. 12 inches/sec.)
13 = 13 in/sec b
14 = 14 in/sec b
Default Value: D
b = backfeed speed Accepted Values:
A or 2 = 50.8 mm/sec. (2 inches/sec.)
B or 3 = 76.2 mm/sec. (3 inches/sec.)
C or 4 = 101.6 mm/sec. (4 inches/sec.)
5 = 127 mm/sec.(5 inches/sec.)
D or 6 = 152.4 mm/sec. (6 inches/sec.)
E or 8 = 203.2 mm/sec. (8 inches/sec.)
9 = 220.5 mm/sec. 9 inches/sec.)
10 = 245 mm/sec. 10 inches/sec.)
11 = 269.5 mm/sec. 11 inches/sec.)
12 = 304.8 mm/sec. 12 inches/sec.)
13 = 13 in/sec b
14 = 14 in/sec b
Default Value: A
a. This value is supported only on the 110Xi4-600dpi, 110XiIIIPlus-600dpi , and RXi printers.
b. This value is supported only on the Xi4 and RXi4 printers.

Comments The speed setting for p, s, and b is dependent on the limitations of the printer.
If a particular printer is limited to a rate of 6 ips (inches per second), a value of 12 can be
entered but the printer performs only at a 6 ips rate. See your printer’s User Guide for specifics
on performance.

This command is ignored on the HC100 printer.

6/8/10 Zebra Programming Guide P1012728-004

324 ZPL Commands
~PR

~PR
Applicator Reprint
Description If the ~PR command is enabled (see ^JJ on page 256), the last label printed
reprints, similar to the applicator asserting the Reprint signal on the applicator port.

Supported Devices
• XiIIIPlus
• Xi4 with firmware V53.17.1Z or later
• PAX2, PAX4
• S4M
• ZM400/ZM600

Format ~PR

Comments Pressing PREVIOUS on the control panel also causes the last label to reprint.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 325
~PS

~PS
Print Start
Description The ~PS command causes a printer in Pause Mode to resume printing. The
operation is identical to pressing PAUSE on the control panel of the printer when the printer is
already in Pause Mode.

Format ~PS

6/8/10 Zebra Programming Guide P1012728-004

326 ZPL Commands
^PW

^PW
Print Width
Description The ^PW command allows you to set the print width.

Format ^PWa

Parameters Details
a = label width (in dots) Accepted Values: 2, to the width of the label
If the value exceeds the width of the label, the width is set to the label’s
maximum size.
Default Value: last permanently saved value

Comments This command is ignored on the HC100™ printer.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 327
~RO

~RO
Reset Advanced Counters
Description The ~RO command resets the advanced counters used by the printer to monitor
label generation in inches, centimeters, and number of labels.

Format ~ROc

Parameters Details
c = counter number Accepted Values:
1 = reset counter 1
2 = reset counter 2
3 = reset valid RFID label counter
4 = reset voided RFID label counter
C = reset head cleaned counter p
R = reset head replaced counter p
(R resets the head cleaned counter and the head replaced counter)
Default Value: a value must be specified or the command is ignored
p. These values are supported only on Xi4, RXi4, ZM400/ZM600, RZ400/RZ600, S4M, and G-Series printers.

Example 1 • This example shows how the counter portion of the printer configuration labels
looks when counter 1 is reset by sending ~RO1.
Before

After

6/8/10 Zebra Programming Guide P1012728-004 A

328 ZPL Commands
~RO

Example 2 • This example shows how the counter portion of the printer configuration labels
looks when the RFID counters are reset by sending ~RO3 and ~RO4.
Before

After

P1012728-004 A Zebra Programming Guide 6/8/10

 ZPL Commands 329
^SC

^SC
Set Serial Communications
Description The ^SC command allows you to change the serial communications
parameters you are using.

Format ^SCa,b,c,d,e,f

Parameters Details
a = baud rate Accepted Values: 110 q; 300; 600; 1200; 2400; 4800; 9600; 14400;
19200; 28800; 38400; or 57600; 115200
Default Value: must be specified or the parameter is ignored
b = word length (in data Accepted Values: 7 or 8
bits) Default Value: must be specified
c = parity Accepted Values: N (none), E (even), or O (odd)
Default Value: must be specified
d = stop bits Accepted Values: 1 or 2
Default Value: must be specified
e = protocol mode Accepted Values:
X = XON/XOFF
D = DTR/DSR
R = RTS
M = DTR/DSR XON/XOFF r
Default Value: must be specified
f = Zebra protocol Accepted Values:
A = ACK/NAK
N = none
Z = Zebra
Default Value: must be specified
q. This value is not supported on Xi4, RXi4, ZM400/ZM600, RZ400/RZ600, and S4M printers.
r. This parameter is supported only on G-Series printers. Using the DTR/DSR XON/XOFF mode will cause the printer to re-
spond to either DTR/DSR or XON/XOFF, depending on which method is first received from the host device.

Comments If any of the parameters are missing, out of specification, not supported by a
particular printer, or have a ZPL-override DIP switch set, the command is ignored.

A ^JUS command causes the changes in Communications Mode to persist through power-up
and software resets.

6/8/10 Zebra Programming Guide P1012728-004

330 ZPL Commands
~SD

~SD
Set Darkness
Description The ~SD command allows you to set the darkness of printing. ~SD is the
equivalent of the darkness setting parameter on the control panel display.

Format ~SD##

Parameters Details
## = desired darkness Accepted Values: 00 to 30
setting (two-digit Default Value: last permanently saved value
number)

Important • The darkness setting range for the XiIIIPlus, Xi4, and RXi4 is 0 to 30 in
increments of 0.1. The firmware is setup so that the ^MD and ~SD commands (ZPL
darkness commands) accept that range of settings.

Example • These are examples of the XiIIIPlus, Xi4, and RXi4 Darkness Setting:

^MD8.3

~SD8.3

Comments The ^MD command value, if applicable, is added to the ~SD command.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 331
^SE

^SE
Select Encoding Table
Description The ^SE command is used to select the desired ZPL or ZPL II encoding table.

Format ^SEd:o.x

Parameters Details
d = location of encoding Accepted Values: R:, E:, B:, and A:
table Default Value: R:
o = name of encoding Accepted Value: 1 to 8 alphanumeric characters
table Default Value: a value must be specified
x = extension Fixed Value: .DAT

The encoding tables are provided with the font card or downloaded in flash with the font. The
table appears as XXXXXXX.DAT in a directory label printed by the ZPL commands.

The most active encoding table is indicated by the * on the directory label.

Example •
^XA^WD*:*.*^XZ

6/8/10 Zebra Programming Guide P1012728-004

332 ZPL Commands
^SF

^SF
Serialization Field (with a Standard ^FD String)
Description The ^SF command allows you to serialize a standard ^FD string. The
maximum size of the mask and increment string is 3K combined.

In firmware version x.14 and later, strings are serialized from the last character in the backing
store with regard to the alignment of the mask and increment strings. For combining
semantic clusters that do not get incremented, the mask character % needs to be added to the
increment string.

Format ^SFa,b

Parameters Details
a = mask string The mask string sets the serialization scheme. The length of the string mask
defines the number of characters (or in firmware version x.14 and later,
combining semantic clusters) in the current ^FD string to be serialized. The
mask is aligned to the characters (or in firmware version x.14 and later,
combining semantic clusters) in the ^FD string starting with the right-most (or
in firmware x.14 and later, last) in the backing store position.
Mask String placeholders:
D or d – Decimal numeric 0–9
H or h – Hexadecimal 0–9 plus a-f or A-F
O or o – Octal 0–7
A or a – Alphabetic A–Z or a–z
N or n – Alphanumeric 0–9 plus A–Z or a–z
% – Ignore character or skip
b = increment string The increment string is the value to be added to the field on each label. The
default value is equivalent to a decimal value of one. The string is composed of
any characters (or in firmware version x.14 and later, combining semantic
clusters) defined in the serial string. Invalid characters (or in firmware version
x.14 and later, combining semantic clusters) are assumed to be equal to a value
of zero in that characters (or in firmware version x.14 and later, combining
semantic clusters) position.
The increment value for alphabetic strings start with ‘A’ or ‘a’ as the zero
placeholder. This means to increment an alphabetic character (or in firmware
version x.14 and later, combining semantic cluster) by one, a value of ‘B’ or
‘b’ must be in the increment string.

For characters that do not get incremented, the % character needs to be added to the increment
string.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 333
^SF

Example 1 • This is an example of serializing a ^FD string. The ZPL II code generates three
separate labels as seen in Generated Labels:

ZPL II CODE GENERATED LABELS

^XA
^FO100,100
^CF0,100
^FD12A^SFnnA,F^FS
^PQ3
^XZ

This mask has the first characters (or in firmware version x.14 and later, the first combining
semantic clusters) as alphanumeric (nn = 12) and the last digit as uppercase alphabetic (A).
The decimal value of the increment number is equivalent to 5 (F). The number of labels
generated depends on the number specified by the ^PQ command.

In a similar instance, the ^FD string could be replaced with either of the ^FD strings below to
generate a series of label, determined by ^PQ.
Using this ZPL code:
^FDBL0000^SFAAdddd,1
The print sequence on this series of labels is:
BL0000, BL0001,...BL0009, BL0010,...
BL0099, BL0100,...BL9999, BM0000...
Using this ZPL code:
^FDBL00-0^SFAAdd%d,1%1
The print sequence on this series of labels is:
BL00-0, BL01-1, BL02-2,...BL09-9,
BL11-0, BL12-1...

Important notes about masking for firmware version V60.14.x, V50.14.x, or later:
• A single % masks an entire combining semantic cluster rather than a single code
point.
• The mask string and increment string should be aligned at the last code point in their
respective backing stores.
• Control and bidirectional characters do not require a mask and are ignored for
serialization purposes.

The following examples show the importance of capitalization and location within the mask.

6/8/10 Zebra Programming Guide P1012728-004

334 ZPL Commands
^SF

Example 2 • In this example, the printer cycles with every two printed labels and alternates
between H (position 18), and then Z (position 36). With n or N, the serial number increments
from 0 - 9 and a–z or A–Z (36 positions overall). With each completed cycle, the second
cluster (nn) increments one position (from 00, 01, 02 …) per cycle:

ZPL II CODE GENERATED LABELS

^XA
^FO100,50^A0N,50,50^FDzzZ^SFnnN,I^FS
^PQ10
^XZ

Example 3 • In this example, lower case i increments with a mask string of nnN. Nothing
changes because the first cluster (Z) never triggers the second cluster (zz) to change.

ZPL II CODE GENERATED LABELS

^XA
^FO100,50^A0N,50,50^FDzzZ^SFnnN,i^FS
^PQ10
^XZ

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 335
^SI

^SI
Set Sensor Intensity
This command is available only for printers with firmware versions V53.15.x or later.

Description The ^SI command is used to change the values for the media sensors, which
are also set during the media calibration process. The media calibration process is described in
your specific printer’s user’s guide.

Supported Devices
• Xi4 with firmware V53.17.1Z or later
• RXi4 with firmware V53.17.7Z or later
• ZM400/ZM600 with firmware V53.15.xZ or later
• RZ400/RZ600 wtih firmware R53.15.xZ or later

Format ^SIa,b

Parameters Details
a = indicates the setting Accepted Values:
to modify 1 = transmissive sensor brightness setting
2 = transmissive sensor baseline setting
Default Value: must be an accepted value or the entire command is ignored
b = the value to use for The ranges for this parameter are the same for the accepted values in
the sensor being parameter a.
configured Accepted Values: 0 to 196
Default Value: must be an accepted value or the entire command is ignored

6/8/10 Zebra Programming Guide P1012728-004

336 ZPL Commands
^SL

^SL
Set Mode and Language (for Real-Time Clock)
Description The ^SL command is used to specify the Real-Time Clock’s mode of
operation and language for printing information.

Important •
• Time is read when the image is created. If the image stays in the queue longer than the
specified time the image will be recreated with a new time.
• There are incidents when the same time or a larger space of time may be printed on labels.
This is due to the format complexity and print speed.

Format ^SLa,b

Parameters Details
a = mode Accepted Values:
S = Start Time Mode. This is the time that is read from the Real-Time
Clock when label formatting begins (when ^XA is received). The
first label has the same time placed on it as the last label.
T = Time Now Mode. This is the time that is read from the Real-Time
Clock when the label to be printed is placed in print queue. Time Now
is similar to a serialized time or date field.
Numeric Value = With the Enhanced Real Time Clock (V60.13.0.10
or later) a time accuracy tolerance can be specified. Range = 1 to 999
seconds, 0 = one second tolerance
Example: SL30,1 = Accuracy tolerance of 30 seconds and use English.
Default Value: S
s. These values are only supported on the Xi4, RXi4, ZM400/ZM600, and RZ400/RZ600 printers.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 337
^SL

Parameters Details
b = language Accepted Values:
1 = English
2 = Spanish
3 = French
4 = German
5 = Italian
6 = Norwegian
7 = Portuguese
8 = Swedish
9 = Danish
10 = Spanish 2
11 = Dutch
Value 13 is only supported 12 = Finnish
in firmware versions 13 = Japanese
V60.14.x, V50.14.x, or 14 = Korean s
later. 15 = Simplified Chinese s
16 = Traditional Chinese s
17 = Russian s
18 = Polish s
Default Value: the language selected with ^KL or the control panel
s. These values are only supported on the Xi4, RXi4, ZM400/ZM600, and RZ400/RZ600 printers.

Comments These are some comments to be aware of:

• The ^SL command must be placed before the first ^FO command.
• As of V60.13.0.10 all supported printers have Enhanced Real Time Clock capabilities the
RTC will not print time fields that are more than sixty seconds old, rather it will update the
time prior to printing (^SLT or ^SL60). To control time with increments other than sixty
seconds the ^SL command can be used with a numeric value (^SL30).
^SLS can keep times longer than sixty seconds.

For more details on set mode and language with the Real-Time Clock, see Real Time Clock
on page 999.

6/8/10 Zebra Programming Guide P1012728-004

338 ZPL Commands
^SN

^SN
Serialization Data
Description The ^SN command allows the printer to index data fields by a selected
increment or decrement value, making the data fields increase or decrease by a specified value
each time a label is printed. This can be performed on 100 to 150 fields in a given format and
can be performed on both alphanumeric and bar code fields. A maximum of 12 of the right-
most integers are subject to indexing.

In x.13 and earlier, the first integer found when scanning from right to left starts the indexing
portion of the data field.

In x.14 and later, the first integer found when scanning from end of the backing store towards
the beginning starts the indexing portion of the data field.

In x.13 and earlier, if the alphanumeric field to be indexed ends with an alpha character, the
data is scanned, character by character, from right to left until a numeric character is
encountered. Serialization takes place using the value of the first number found.

In x.14 and later, if the backing store of the alphanumeric field to be indexed ends with an
alpha character, the data is scanned, character by character, from the end of the backing store
until a numeric character is encountered. Serialization takes place using the value of the first
number found.

Format ^SNv,n,z

Parameters Details
v = starting value Accepted Values: 12-digits maximum for the portion to be indexed
Default Value: 1
n = increment or Accepted Values: 12-digit maximum
decrement value Default Value: 1
To indicate a decrement value, precede the value with a minus (–) sign.
z = add leading zeros (if Accepted Values:
needed) N = no
Y = yes
Default Value: N

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 339
^SN

Example • This example shows incrementing by a specified value:

ZPL II CODE GENERATED LABELS

^XA
^FO260,110
^CFG
^SN001,1,Y^FS
^PQ3
^XZ

Note: The ZPL II code above will generate

three separate labels, seen to the right.

Comments Incrementing and decrementing takes place for each serial-numbered field
when all replicates for each serial number have been printed, as specified in parameter r of the
^PQ (print quality) command.

If, during the course of printing serialized labels, the printer runs out of either paper or ribbon,
the first label printed (after the media or ribbon has been replaced and calibration completed)
has the same serial number as the partial label printed before the out condition occurred. This
is done in case the last label before the out condition did not fully print. This is controlled by
the ^JZ command.

Using Leading Zeros

In the ^SN command, the z parameter determines if leading zeros are printed or suppressed.
Depending on which value is used (Y = print leading zeros; N = do not print leading zeros),
the printer either prints or suppresses the leading zeros.

The default value for this parameter is N (do not print leading zeros).

Print Leading Zeros

In x.13 and earlier, the starting value consists of the right-most consecutive sequence of
digits.

In x.14 and later, the starting value consists of the first number working backwards in the
backing store consecutive sequence of digits.
The width (number of digits in the sequence) is determined by scanning from right to left
until the first non-digit (space or alpha character) is encountered. To create a specific width,
manually place leading zeros as necessary.

6/8/10 Zebra Programming Guide P1012728-004

340 ZPL Commands
^SN

Suppressing Leading Zeros

In x.13 and earlier, the starting value consists of the right-most consecutive sequence of
digits, including any leading spaces.

In x.14 or later, the starting value consists of the first number working backwards in the
backing store consecutive sequence of digits, including any leading spaces.
The starting value consists of the first number working backwards in the backing store
consecutive sequence of digits, including any leading spaces. The width (number of digits in
the sequence) is determined by scanning from right to left until the first alpha character
(except a space) is encountered. To create a specific width, manually place leading spaces or
zeros as necessary. Suppressed zeros are replaced by spaces. During the serialization process,
when the entire number contains all zeros, the last zero is not suppressed.
The ^SN command replaces the Field Data (^FD) command within a label formatting
program.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 341
^SO

^SO
Set Offset (for Real-Time Clock)
Description The ^SO command is used to set the secondary and the tertiary offset from the
primary Real-Time Clock.

Note • For each label only one SO2 command can be used. If more than one offset is
required, SO3 must be used.

Format ^SOa,b,c,d,e,f,g

Parameters Details
a = clock set Accepted Values:
2 = secondary
3 = third
Default Value: value must be specified
b = months offset Accepted Values: –32000 to 32000
Default Value: 0
c = days offset Accepted Values: –32000 to 32000
Default Value: 0
d = years offset Accepted Values: –32000 to 32000
Default Value: 0
e = hours offset Accepted Values: –32000 to 32000
Default Value: 0
f = minutes offset Accepted Values: –32000 to 32000
Default Value: 0
g = seconds offset Accepted Values: –32000 to 32000
Default Value: 0

For more detail on set offset, see Real Time Clock on page 999.

6/8/10 Zebra Programming Guide P1012728-004

342 ZPL Commands
^SP

^SP
Start Print
Description The ^SP command allows a label to start printing at a specified point before
the entire label has been completely formatted. On extremely complex labels, this command
can increase the overall throughput of the print.

The command works as follows: Specify the dot row at which the ^SP command is to begin.
This creates a label segment. Once the ^SP command is processed, all information in that
segment prints. During the printing process, all of the commands after the ^SP continue to be
received and processed by the printer.

If the segment after the ^SP command (or the remainder of the label) is ready for printing,
media motion does not stop. If the next segment is not ready, the printer stops mid-label and
wait for the next segment to be completed. Precise positioning of the ^SP command requires a
trial-and-error process, as it depends primarily on print speed and label complexity.

The ^SP command can be effectively used to determine the worst possible print quality. You
can determine whether using the ^SP command is appropriate for the particular application by
using this procedure.

If you send the label format up to the first ^SP command and then wait for printing to stop
before sending the next segment, the printed label is a sample of the worst possible print
quality. It drops any field that is out of order.

If the procedure above is used, the end of the label format must be:
^SP#^FS

Comments ^SPa

Parameters Details
a = dot row to start Accepted Values: 0 to 32000
printing Default Value: 0

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 343
^SP

Example • In this example, a label 800 dot rows in length uses ^SP500. Segment 1 prints
while commands in Segment 2 are being received and formatted.

Dot position 0

Label Segment 2

Dot position 500

Label Segment 1
Dot position 800

6/8/10 Zebra Programming Guide P1012728-004

344 ZPL Commands
^SQ

^SQ
Halt ZebraNet Alert
Description The ^SQ command is used to stop the ZebraNet Alert option.

Format ^SQa,b,c

Parameters Details
a = condition type Accepted Values:
A = paper out
B = ribbon out
C = printhead over-temp
D = printhead under-temp
E = head open
F = power supply over-temp
G = ribbon-in warning (Direct Thermal Mode)
H = rewind full
I = cut error
J = printer paused
K = PQ job completed
L = label ready
M = head element out
N = ZBI (Zebra BASIC Interpreter) runtime error
O = ZBI (Zebra BASIC Interpreter) forced error
Q = clean printhead
R = media low
S = ribbon low
T = replace head
U = battery low
V = RFID error (in RFID printers only)
W = all errors (in RFID printers only)
* = all errors (in non-RFID printers)
b = destination Accepted Values:
A = serial port
B = parallel port
C = e-mail address
D = TCP/IP
E = UDP/IP
F = SNMP trap
* = wild card to stop alerts for all destinations

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 345
^SQ

Parameters Details
c = halt messages Accepted Values:
Y = halt messages
N = start messages
Default Value: Y

6/8/10 Zebra Programming Guide P1012728-004

346 ZPL Commands
^SR

^SR
Set Printhead Resistance
Description The ^SR command allows you to set the printhead resistance.

Format ^SR####

Parameters Details
#### = resistance value Accepted Value: 0488 to 1175
(four-digit numeric Default Value: last permanently saved value
value)

Comments To avoid damaging the printhead, this value should be less than or equal to the
value shown on the printhead being used. Setting a higher value could damage the printhead.

Note • New printer models automatically set head resistance.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 347
^SS

^SS
Set Media Sensors
Description The ^SS command is used to change the values for media, web, ribbon, and
label length set during the media calibration process. The media calibration process is
described in your specific printer’s user’s guide.

Format ^SSw,m,r,l,m2,r2,a,b,c

Parameters Details
w = web (three-digit Accepted Values: 000 to 100
value) Default Value: value shown on the media sensor profile or configuration label
m = media (three-digit Accepted Values: 000 to 100
value) Default Value: value shown on the media sensor profile or configuration label
r = ribbon (three-digit Accepted Values: 000 to 100
value) Default Value: value shown on the media sensor profile or configuration label
l = label length (in dots, Accepted Values: 0001 to 32000
four-digit value) Default Value: value calculated in the calibration process
m2 = intensity of media Accepted Values: 000 to 255
LED (three-digit Default Value: value calculated in the calibration process
value)
r2 = intensity of ribbon Accepted Values: 000 to 255
LED (three-digit Default Value: value calculated in the calibration process
value)
a = mark sensing (three- Accepted Values: 000 to 100
digit value) Default Value: value calculated in the calibration process
b = mark media sensing Accepted Values: 000 to 100
(three-digit value) Default Value: value calculated in the calibration process
c = mark LED sensing Accepted Values: 000 to 255
(three-digit value) Default Value: value calculated in the calibration process

6/8/10 Zebra Programming Guide P1012728-004

348 ZPL Commands
^SS

Example • Below is an example of a media sensor profile. Notice the numbers from 000 to
100 and where the words WEB, MEDIA, and RIBBON appear in relation to those numbers.
Also notice the black vertical spike. This represents where the printer sensed the transition
from media-to-web-to-media.

The media and sensor profiles produced vary in appearance from printer to printer.

Comments The m2 and r2 parameters have no effect in Stripe® S-300 and S-500 printers.

This command is ignored on the HC100™ printer.

Maximum values for parameters depend on which printer platform is being used.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 349
^ST

^ST
Set Date and Time (for Real-Time Clock)
Description The ^ST command sets the date and time of the Real-Time Clock.

Format ^STa,b,c,d,e,f,g

Parameters Details
a = month Accepted Values: 01 to 12
Default Value: current month
b = day Accepted Values: 01 to 31
Default Value: current day
c = year Accepted Values: 1998 to 2097
Default Value: current year
d = hour Accepted Values: 00 to 23
Default Value: current hour
e = minute Accepted Values: 00 to 59
Default Value: current minute
f = second Accepted Values: 00 to 59
Default Value: current second
g = format Accepted Values:
A = a.m.
P = p.m.
M = 24-hour military
Default Value: M

For more details on set date and time, see Real Time Clock on page 999.

6/8/10 Zebra Programming Guide P1012728-004

350 ZPL Commands
^SX

^SX
Set ZebraNet Alert
Description The ^SX command is used to configure the ZebraNet Alert System.

Format ^SXa,b,c,d,e,f

Note • The values in this table apply to firmware version V48.12.4 or later.

Parameters Details
a = condition type Accepted Values:
A = paper out
B = ribbon out
C = printhead over-temp
D = printhead under-temp
E = head open
F = power supply over-temp
G = ribbon-in warning (Direct Thermal Mode)
H = rewind full
I = cut error
J = printer paused
K = PQ job completed
L = label ready
M = head element out
N = ZBI (Zebra BASIC Interpreter) runtime error
O = ZBI (Zebra BASIC Interpreter) forced error
P = power on
Q = clean printhead
R = media low
S = ribbon low
T = replace head
U = battery low
V = RFID error (in RFID printers only)
* = all errors
Default Value: if the parameter is missing or invalid, the command is ignored

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 351
^SX

Parameters Details
b = destination for route Accepted Values:
alert A = serial port
B* = parallel port
C = e-mail address
D = TCP/IP
E = UDP/IP
F = SNMP trap
Default Value: if this parameter is missing or invalid, the command is ignored
* Requires bidirectional communication.
c = enable condition set Accepted Values:
alert to this N = no
destination Y = yes
Default Value: Y or previously configured value
d = enable condition Accepted Values:
clear alert to this N = no
destination Y = yes
Default Value: N or previously configured value
Parameters e and f are sub-options based on destination. If the sub-options are
missing or invalid, these parameters are ignored.
e = destination setting Accepted Values:
Internet e-mail address (e.g. [email protected])
IP address (for example, 10.1.2.123)
SNMP trap
IP or IPX addresses
f = port number Accepted Values:
TCP port # (0 to 65535)
UPD port # (0 to 65535)

Example • This is an example of the different (b) destinations that you can send for the
condition type (a):
Serial: ^SXA,A,Y,Y
Parallel: ^SXA,B,Y,Y
E-Mail: ^SXA,C,Y,Y,[email protected]
TCP: ^SXA,D,Y,Y,123.45.67.89,1234
UDP: ^SXA,E,Y,Y,123.45.67.89,1234
SNMP Trap: ^SXA,F,Y,Y,255.255.255.255

Comments In the example above for SNMP Trap, entering 255.255.255.255 broadcasts the
notification to every SNMP manager on the network. To route the device to a single SNMP
manager, enter a specific address (123.45.67.89).

6/8/10 Zebra Programming Guide P1012728-004

352 ZPL Commands
^SZ

^SZ
Set ZPL
Description The ^SZ command is used to select the programming language used by the
printer. This command gives you the ability to print labels formatted in both ZPL and ZPL II.

This command remains active until another ^SZ command is sent to the printer or the printer
is turned off.

Format ^SZa

Parameters Details
a = ZPL version Accepted Values:
1 = ZPL
2 = ZPL II
Default Value: 2

Comments If the parameter is missing or invalid, the command is ignored.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 353
~TA

~TA
Tear-off Adjust Position
Description The ~TA command lets you adjust the rest position of the media after a label is
printed, which changes the position at which the label is torn or cut.

Format ~TA###

Important • These are some important facts about this command:

• For 600 dpi printers, the step size doubles.
• If the number of characters is less than 3, the command is ignored.

Parameters Details
### = change in media Accepted Values:
rest position –120 to 120
(3-digit value in dot
rows must be used.) 0 to 120 (on the HC100)
Default Value: last permanent value saved

Comments If the parameter is missing or invalid, the command is ignored.

6/8/10 Zebra Programming Guide P1012728-004

354 ZPL Commands
^TB

^TB
Text Blocks
This command is available only for printers with firmware version V60.14.x, V50.14.x, or
later.

Description The ^TB command prints a text block with defined width and height. The text
block has an automatic word-wrap function. If the text exceeds the block height, the text is
truncated. This command supports complex text layout features.

Note • ^TB is the preferred command for printing fields or blocks of text, instead of ^FB.

Format ^TBa,b,c

Parameters Details
a = block rotation Accepted Values:
N = normal
R = rotate 90 degrees clockwise
I = invert 180 degrees
B = read from bottom up-270 degrees
Default Value: whatever was specified by the last ^A (which has the default of
^FW)
b = block width in dots Accepted Values:
1 to the width of the label in dots
Default Value: 1 dot
c = block height in dots Accepted Values:
1 to the length of the label in dots
Default Value: 1 dot

Comments Facts about the ^TB command:

• Justification of ^TB command comes from ^FO, ^FT, or ^FN command. If no
justification is determined then the default is auto justification.
• Data between < and > is processed as an escape sequence. This is a list of defined
escape sequences: <<> prints <.
• The ^TB command has an automatic word-wrap function. Soft hyphens do not print
and are not used as a line break position.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 355
^TO

^TO
Transfer Object
Description The ^TO command is used to copy an object or group of objects from one
storage device to another. It is similar to the copy function used in PCs.

Source and destination devices must be supplied and must be different and valid for the action
specified. Invalid parameters cause the command to be ignored.

The asterisk (*) can be used as a wild card for object names and extensions. For instance,
ZEBRA.* or *.GRF are acceptable forms for use with the ^TO command.

At least one source parameter (d, o, or x) and one destination parameter (s, o, or x) must be
specified. If only ^TO is entered, the command is ignored.

Format ^TOs:o.x,d:o.x

Parameters Details
s = source device of Accepted Values: R:, E:, B:, and A:
stored object Default Value: if a drive is not specified, all objects are transferred to the drive
set in parameter s
o = stored object name Accepted Values: any existing object conforming to Zebra conventions
Default Value: if a name is not specified, * is used — all objects are selected
x = extension Accepted Values: any extension conforming to Zebra conventions
Default Value: if an extension is not specified, * is used — all extensions are
selected
d = destination device of Accepted Values: R:, E:, B:, and A:
the stored object Default Value: a destination must be specified
o = name of the object at Accepted Values: up to 8 alphanumeric characters
destination Default Value: if a name is not specified, the name of the existing object is used
x = extension Accepted Values: any extension conforming to Zebra conventions
Default Value: if an extension is not specified, the extension of the existing
object is used

Comments Parameters o, x, and s support the use of the wild card (*).

If the destination device does not have enough free space to store the object being copied, the
command is canceled.

Zebra files (Z:*.*) cannot be transferred. These files are copyrighted by

Zebra Technologies.

6/8/10 Zebra Programming Guide P1012728-004

356 ZPL Commands
^TO

Transferring Objects

These are some examples of using the ^TO command.

Example 1 • To copy the object ZLOGO.GRF from DRAM to an optional Memory Card
and rename it ZLOGO1.GRF, write the following format:
^XA
^TOR:ZLOGO.GRF,B:ZLOGO1.GRF
^XZ

Example 2 • To copy the object SAMPLE.GRF from an optional Memory Card to DRAM
and keep the same name, write this format:
^XA
^TOB:SAMPLE.GRF,R:SAMPLE.GRF
^XZ

Transferring Multiple Objects

The asterisk (*) can be used to transfer multiple object files (except *.FNT) from DRAM to
the Memory Card. For example, assume you have several object files that contain logos. These
files are named LOGO1.GRF, LOGO2.GRF, and LOGO3.GRF.

To transfer all these files to the memory card using the name NEW instead of LOGO, place an
asterisk after the names NEW and LOGO in the transfer command. This copies all files
beginning with LOGO in one command.
^XA
^TOR:LOGO*.GRF,B:NEW*.GRF
^XZ

During a multiple transfer, if a file is too big to be stored on the memory card, that file is
skipped. All remaining files attempt to be transferred. All files that can be stored within the
space limitations are transferred, while other files are ignored.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 357
~WC

~WC
Print Configuration Label
Description The ~WC command is used to generate a printer configuration label. The
printer configuration label contains information about the printer setup, such as sensor type,
network ID, ZPL mode, firmware version, and descriptive data on the R:, E:, B:, and A:
devices.

Format ~WC

Comments This command works only when the printer is idle.

6/8/10 Zebra Programming Guide P1012728-004

358 ZPL Commands
^WD

^WD
Print Directory Label
Description The ^WD command is used to print a label listing bar codes, objects stored in
DRAM, or fonts.

For bar codes, the list shows the name of the bar code. For fonts, the list shows the name of the
font, the number to use with ^A command, and size. For objects stored in DRAM, the list
shows the name of the object, extension, size, and option flags. All lists are enclosed in a
double-line box.

Format ^WDd:o.x

Parameters Details
d = source device — Accepted Values: R:, E:, B:, A: and Z:
optional Default Value: R:
o = object name — Accepted Values: 1 to 8 alphanumeric characters
optional Default Value: *
The use of a ? (question mark) is also allowed.
x = extension — optional Accepted Values: any extension conforming to Zebra conventions
.FNT = font
.BAR = bar code
.ZPL = stored ZPL format
.GRF = GRF graphic
.CO = memory cache
.DAT = font encoding
.BAS = ZBI encrypted program
.TTF and .TTE are only
.BAE = ZBI encrypted program
supported in firmware
version V60.14.x, .STO = data storage
V50.14.x, or later. .PNG = PNG graphic
* = all objects
.TTF = TrueType Font
.TTE = True Type Extension
Default Value: *
The use of a ? (question mark) is also allowed.

Example 1 • To print a label listing all objects in DRAM, enter:

^XA
^WDR:*.*
^XZ

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 359
^WD

Example 2 • To print a label listing all resident bar codes, enter:

^XA
^WDZ:*.BAR
^XZ

Example 3 • To print a label listing all resident fonts, enter:

^XA
^WDZ:*.FNT
^XZ

6/8/10 Zebra Programming Guide P1012728-004

360 ZPL Commands
~WQ

~WQ
Write Query
Description The ~WQ command triggers the printer to print a label with odometer,
maintenance or alert, and printhead history information.

Supported Devices
• Xi4 with firmware V53.17.1Z or later
• RXi4 with firmware V53.17.7Z or later
• ZM400/ZM600 with firmware V53.15.xZ or later
• RZ400/RZ600 with firmware R53.15.xZ or later
• S4M with firmware V53.15.4Z or later
• G-Series

Format ~WQquery-type

Parameter Details
query-type For detailed examples of these parameters, see ~WQ Examples on page 362.
Accepted Values:
ES = requests the printer’s status. For details see, Table 16 on page 360
and Table 17 on page 361.
HA = hardware address of the internal wired print server
JT = requests a summary of the printer’s printhead test results
MA = maintenance alert settings
MI = maintenance information
OD = odometer
PH = printhead life history
PP = printer’s Plug and Play string
SN = printer’s serial number
UI = printer’s USB product ID and BCD release version
Default Value: must be an accepted value or the command is ignored
a3a

Table 16 • Error Flags (~WQES)

Group 2 Group 1 (X = Value can be any hexadecimal number [0-9, A-F])
Error Flags Flag
Nibbles16-9 Nibble8 Nibble7 Nibble6 Nibble5 Nibble4 Nibble3 Nibble2 Nibble1

No Error 0 00000000 0 0 0 0 0 0 0 0
Error Present 1 00000000 X X X X X X X X
Printhead Thermistor Open 1 00000000 X X X X X 2 X X
Invalid Firmware Config. 1 00000000 X X X X X 1 X X
Printhead Detection Error 1 00000000 X X X X X X 8 X
Bad Printhead Element 1 00000000 X X X X X X 4 X
a. This error flag is supported only on KR403 printers.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 361
~WQ

Table 16 • Error Flags (~WQES)

Group 2 Group 1 (X = Value can be any hexadecimal number [0-9, A-F])
Error Flags Flag
Nibbles16-9 Nibble8 Nibble7 Nibble6 Nibble5 Nibble4 Nibble3 Nibble2 Nibble1

Motor Over Temperature 1 00000000 X X X X X X 2 X

Printhead Over Temperature 1 00000000 X X X X X X 1 X
Cutter Fault 1 00000000 X X X X X X X 8
Head Open 1 00000000 X X X X X X X 4
Ribbon Out 1 00000000 X X X X X X X 2
Media Out 1 00000000 X X X X X X X 1
a a a
Clear Paper Path Failed 1 00000000 X X X X 8 X X X
a a a
Paper Feed Error 1 00000000 X X X X 4 X X X
a a a
Presenter Not Running 1 00000000 X X X X 2 X X X
a a a
Paper Jam during Retract 1 00000000 X X X X 1 X X X
a a a
Black Mark not Found 1 00000000 X X X 8 X X X X
a a a
Black Mark Calabrate Error 1 00000000 X X X 4 X X X X
a a a
Retract Function timed out 1 00000000 X X X 2 X X X X
a a a
Paused 1 00000000 X X X 1 X X X X
a. This error flag is supported only on KR403 printers.

Table 17 • Warning Flags (~WQES)

Group 2 Group 1 (X = Value can be any hexadecimal number [0-9, A-F])
Error Flags Flag
Nibbles16-9 Nibble8 Nibble7 Nibble6 Nibble5 Nibble4 Nibble3 Nibble2 Nibble1

No Warning 0 00000000 0 0 0 0 0 0 0 0
Warning Present 1 00000000 X X X X X X X X
b b b
Paper-near-end Sensor 1 00000000 X X X X X X X 8
Replace Printhead 1 00000000 X X X X X X X 4
Clean Printhead 1 00000000 X X X X X X X 2
Need to Calibrate Media 1 00000000 X X X X X X X 1
b b b
Sensor 1 (Paper before head) 1 00000000 X X X X X X 1 X
Sensor 2 (Black mark)
b 1
b 00000000 X X X X X X 2
b X
Sensor 3 (Paper after head)
b 1
b 00000000 X X X X X X 4
b X
Sensor 4 (loop ready)
b 1
b 00000000 X X X X X X 8
b X
Sensor 5 (presenter)
b 1
b 00000000 X X X X X 1
b X X
Sensor 6 (retract ready)
b 1
b 00000000 X X X X X 2
b X X
Sensor 7 (in retract)
b 1
b 00000000 X X X X X 4
b X X
Sensor 8 (at bin)
b 1
b 00000000 X X X X X 8
b X X
b. This error flag is supported only on KR403 printers.

6/8/10 Zebra Programming Guide P1012728-004

362 ZPL Commands
~WQ

~WQ Examples
This section provides detailed examples of all the available parameters.
Example 1 • This example shows how to request the printer’s status.
1. To request the printer’s status, type ~WQES
A label similar to this prints out:

In this example, the Printer Status resolves to these conditions:

• The cover/printhead is open (value = 4).
• Media is out or not loaded into the printer (value = 1).
• The printhead needs to be cleaned (value = 2).
• Error nibble 1 is equal to 5 when the error status values are added together (4+1).

This illustration identifies the printer status definitions:

2 4 6

1 3 5

1 Flag
2 Nibble 16-9
3 Nibble 8-4
4 Nibble 3
5 Nibble 2
6 Nibble 1

Example 2 • This example shows how to request the printer’s status.

1. To request the printer’s status, type ~WQES
A label similar to this prints out:

In the example shown above, the Printer Status resolves to the following conditions:
• The cutter has a fault. (value = 8).
• Ribbon is out or not loaded into the printer (value = 2).
• Media is out or not loaded into the printer (value = 1).
• Error byte 1 is equal to B when the error status values are added together
(8 + 2 + 1 = hexadecimal B).

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 363
~WQ

Example 3 • This is an example of how to print the hardware address of the internal wired
print server.
1. To print the hardware address of the internal wired print server, type ~WQHA
A label similar to this prints out:

Example 4 • This is an example of how to print a summary of the printer’s printhead test
results.
The ^JT command is used to initiate printhead testing, set the testing interval, and set the
element range to be tested. For more details see, ^JT on page 268.
1. To request a summary of the printer’s printhead test, type ~WQJT
A label similar to this prints out:

When the printer has printed enough labels to trigger a printhead test, the initial data
changes.
1. To request a summary of the printer’s printhead test, type ~WQJT
A label similar to this prints out:

6/8/10 Zebra Programming Guide P1012728-004

364 ZPL Commands
~WQ

This illustration identifies the printhead test field definitions:

1 2 3 4 5

1 Element failure
2 Manual (M) or automatic (A) range
3 First test element
4 Last test element
5 Failure count

Example 5 • This is an example of how to print the maintenance alert query for the ~WQ
command.
1. To get the current settings, type ~WQMA
A label similar to this prints out:

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 365
~WQ

Example 6 • This is an example of how to use the odometer query for the ~WQ command.
Note that the units of measure are controlled by the ^MA command. Also, if the "Early
Warning Maintenance State" is turned "ON" the printer response would also list LAST
CLEANED and CURRENT PRINTHEAD LIFE counters.
1. To get the current settings, type ~WQOD
A label similar to this prints out:

The units of measure are set to inches.

1. To change the units of measure to centimeters, type:
^XA^MA,,,,C
^XZ
The units of measure are set to centimeters.
2. To check the settings, type ~WQOD.
A label similar to this prints out:

Example 7 • This is an example of how to print the maintenance information query for the
~WQ command. Note that the message is controlled by the ^MI command.
1. To get the current settings, type ~WQMI
A label similar to this prints out:

6/8/10 Zebra Programming Guide P1012728-004

366 ZPL Commands
~WQ

Example 8 • This is an example of how to print the printhead life query for the ~WQ
command. Note that the units of measure are controlled by the ^MA command.
1. To get the current settings, type ~WQPH
A label similar to this prints out:

1
2

1 The current life of the print head.

2 Line items 2 through 10 (the example only shows 2 through
3) tracks the measurement for each time the print head is
changed.

Example 9 • This is an example of how to print the printer’s Plug and Play string.
1. To print the printer’s Plug and Play string, type ~WQPP
A label similar to this prints out:

Example 10 • This is an example of how to print the printer’s serial number.

1. To get the printer’s serial number, type ~WQSN

A label similar to this prints out:

Example 11 • This is an example of how to print the printer’s USB product ID and BCD
release version.
1. To print the printer’s USB product ID and BCD release version, type ~WQUI
A label similar to this prints out:

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 367
^XA

^XA
Start Format
Description The ^XA command is used at the beginning of ZPL II code. It is the opening
bracket and indicates the start of a new label format. This command is substituted with a single
ASCII control character STX (control-B, hexadecimal 02).

Format ^XA

Comments Valid ZPL II format requires that label formats should start with the ^XA
command and end with the ^XZ command.

6/8/10 Zebra Programming Guide P1012728-004

368 ZPL Commands
^XB

^XB
Suppress Backfeed
Description The ^XB command suppresses forward feed of media to tear-off position
depending on the current printer mode. Because no forward feed occurs, a backfeed before
printing of the next label is not necessary; this improves throughput. When printing a batch of
labels, the last label should not contain this command.

Format ^XB

^XB in the Tear-off Mode

Normal Operation: backfeed, print, and feed to rest
^XB Operation: print (Rewind Mode)

^XB in Peel-off Mode

Normal Operation: backfeed, print, and feed to rest
^XB Operation: print (Rewind Mode)

Note • To prevent jamming in cutter mode, ^XB suppresses backfeed and cutting.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 369
^XF

^XF
Recall Format
Description The ^XF command recalls a stored format to be merged with variable data.
There can be multiple ^XF commands in one format, and they can be located anywhere within
the code.

When recalling a stored format and merging data using the ^FN (Field Number) function, the
calling format must contain the ^FN command to merge the data properly.

While using stored formats reduces transmission time, no formatting time is saved. The ZPL II
format being recalled is saved as text strings that need to be formatted at print time.

Format ^XFd:o.x

Parameters Details
d = source device of Accepted Values: R:, E:, B:, and A:
stored image Default Value: search priority (R:, E:, B:, and A:)
o = name of stored image Accepted Values: 1 to 8 alphanumeric characters
Default Value: if a name is not specified, UNKNOWN is used
x = extension l Fixed Value: .ZPL

For a complete example of the ^DF and ^XF command, see ^DF and ^XF — Download
format and recall format on page 47.

6/8/10 Zebra Programming Guide P1012728-004

370 ZPL Commands
^XG

^XG
Recall Graphic
Description The ^XG command is used to recall one or more graphic images for printing.
This command is used in a label format to merge graphics, such as company logos and piece
parts, with text data to form a complete label.

An image can be recalled and resized as many times as needed in each format. Other images
and data might be added to the format.

Format ^XGd:o.x,mx,my

Parameters Details
d = source device of Accepted Values: R:, E:, B:, and A:
stored image Default Value: search priority (R:, E:, B:, and A:)
o = name of stored image Accepted Values: 1 to 8 alphanumeric characters
Default Value: if a name is not specified, UNKNOWN is used
x = extension l Fixed Value: .GRF
mx = magnification Accepted Values: 1 to 10
factor on the x-axis Default Value: 1
my = magnification Accepted Values: 1 to 10
factor on the y-axis Default Value: 1

Example • This is an example of using the ^XG command to recall the image
SAMPLE.GRF from DRAM and print it in five different sizes in five different locations on
the same label:
^XA
^FO100,100^XGR:SAMPLE.GRF,1,1^FS
^FO100,200^XGR:SAMPLE.GRF,2,2^FS
^FO100,300^XGR:SAMPLE.GRF,3,3^FS
^FO100,400^XGR:SAMPLE.GRF,4,4^FS
^FO100,500^XGR:SAMPLE.GRF,5,5^FS
^XZ

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 371
^XS

^XS
Set Dynamic Media Calibration
Description The ^XS command controls whether dynamic media calibration is performed
to compensate for variations in label length, position, transmissivity, and/or reflectance after a
printer is powered-up or the printer has been opened (for example to change or check the
media).

Supported Devices
• G-Series

Format ^XSlength,threshold

Parameters Details
length = dynamic Accepted Values:
length calibration Y = enable
N = disable
Default Value: Y
threshold = Accepted Values:
dynamic threshold Y = enable
calibration N = disable
Default Value: Y
gain = dynamic Accepted Values:
gain calibration Y = enable
(to be in a future
implementation) N = disable
Default Value: Y

6/8/10 Zebra Programming Guide P1012728-004

372 ZPL Commands
^XZ

^XZ
End Format
Description The ^XZ command is the ending (closing) bracket. It indicates the end of a
label format. When this command is received, a label prints. This command can also be issued
as a single ASCII control character ETX (Control-C, hexadecimal 03).

Format ^XZ

Comments Label formats must start with the ^XA command and end with the ^XZ
command to be in valid ZPL II format.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Commands 373
^ZZ

^ZZ
Printer Sleep
Description The ^ZZ command places the printer in an idle or shutdown mode.

Format ^ZZt,b

Parameters Details
t = number of second Accepted Values: 0 to 999999 – setting 0 disables automatic shutdown
(idle time) prior to Default Value: last permanently saved value or 0
shutdown
b = label status at Accepted Values:
shutdown Y = indicates to shutdown when labels are still queued
N = indicates all labels must be printed before shutting down
Default Value: N

Comments The ^ZZ command is only valid on the PA400 and PT400 battery-powered
printers.

6/8/10 Zebra Programming Guide P1012728-004

374 ZPL Commands
^ZZ

Notes • ___________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

P1012728-004 Zebra Programming Guide 6/8/10

 3
ZPL RFID Commands

This section contains the ZPL II commands for RFID-specific applications.

For additional information, refer to the RFID Programming Guide for your printer. A copy is
available on the User CD provided with your printer and online at
http://www.zebra.com/manuals.

6/8/10 Zebra Programming Guide P1012728-004

376 RFID Commands
RFID Command Overview

RFID Command Overview

In addition to reading or encoding RFID tags, the RFID ZPL commands also provide for RFID
exception handling, such as setting the number of read/write retries before declaring a
transponder defective (set with ^RR, ^RT, and ^WT) or setting the number of labels that will
be attempted if an error occurs (set with ^RS).

For example, if an RFID label fails to program correctly or if the transponder cannot be
detected, the printer ejects the label and prints VOID across it. The printer will try to print
another label with the same data and format for the number of RFID labels specified by the
^RS command. If the problem persists, the printer follows the error handling instructions
specified by the ^RS command: the printer may remove the problematic format from the print
queue and proceed with the next format (if one exists in the buffer), or it may place the printer
in Pause or Error mode.

If a parameter is designated as not applicable for a particular printer, any value entered for the
parameter will be ignored, but the place holder for the field is required.

Printer and Firmware Compatibility

Before using a particular command, verify that it is compatible with your printer and firmware
version. See the following tables:
• Table 18, RXi Series Printer Command and Firmware Compatibility on page 377
• Table 19, RZ Series and R110PAX4 Printer Command and Firmware Compatibility
on page 378
• Table 20, R4Mplus, RP4T, and R2844-Z Printer Command and Firmware Compatibility
on page 379

P1012728-004 Rev. A Zebra Programming Guide 6/8/10

 RFID Commands 377
Printer and Firmware Compatibility

Table 18 • RXi Series Printer Command and Firmware Compatibility

and R170Xi
R110Xi HF
R110Xi4

R110Xi
Command Function

Firmware

all

all

all
^HL or ~HL Return RFID Data Log to Host * * *
on page 380
^HR on page 381 Calibrate RFID Transponder Position * * *

^RA on page 387 Read AFI or DSFID Byte — * —

^RB on page 389 Define EPC Data Structure * * *

^RE on page 391 Enable/Disable E.A.S. Bit — * —

^RF on page 392 Read or Write RFID Format * * *

^RI on page 395 Get RFID Tag ID * * *

(R60.13.0.13ZD
or later)

^RM on page 396 Enable RFID Motion * * *

^RN on page 397 Detect Multiple RFID Tags in Encoding Field * * *

(R60.13.0.3
or later)

~RO on page 327 Reset Advanced Counters * * *

^RQ on page 398 Quick Write EPC Data and Passwords * — *

(R60.15.7Z
or later)

^RR on page 400 Specify RFID Retries for a Block * * *

^RS on page 402 Set Up RFID Parameters * * *

^RT on page 410 Read RFID Tag — *a *a

~RV on page 412 Report RFID Encoding Results * — *

^RW on page 413 Set RF Power Levels for Read and Write * * *

^RZ on page 416 Set RFID Tag Password and Lock Tag * — *

^WF on page 418 Encode AFI or DSFID Byte — * —

^WT on page 420 Write (Encode) Tag — *b *b

^WV on page 422 Verify RFID Encoding Operation — — *

* = Supported
— = Not supported
a. Use the ^RF, ^RM, and ^RR commands rather than the ^RT command.
b. Use the ^RF, ^RM, ^RR, and ^WV commands rather than the ^WT command.

6/8/10 Zebra Programming Guide P1012728-004 Rev. A

378 RFID Commands
Printer and Firmware Compatibility

Table 19 • RZ Series and R110PAX4 Printer Command and Firmware Compatibility

RZ400 and RZ600

R110PAX4
Command Function
Firmware

V53.17.7Z

R53.16.X

R62.X.X

R63.X.X
or later
^HL or ~HL Return RFID Data Log to Host * * * *
on page 380
^HR on page 381 Calibrate RFID Transponder Position * * * *

^RA on page 387 Read AFI or DSFID Byte — — — —

^RB on page 389 Define EPC Data Structure * * * *

^RE on page 391 Enable/Disable E.A.S. Bit — — — —

^RF on page 392 Read or Write RFID Format * * * *

^RI on page 395 Get RFID Tag ID * * * *

(R62.13.0.13ZC (R63.13.0.11Z
or later) or later)

^RM on page 396 Enable RFID Motion * * * *

^RN on page 397 Detect Multiple RFID Tags in Encoding Field * * * —

~RO on page 327 Reset Advanced Counters * * * *

^RQ on page 398 Quick Write EPC Data and Passwords * * * —

(R62.15.7Z or later)

^RR on page 400 Specify RFID Retries for a Block * * * *

^RS on page 402 Set Up RFID Parameters * * * *

^RT on page 410 Read RFID Tag *a *a *a *a

~RV on page 412 Report RFID Encoding Results * * * *

^RW on page 413 Set RF Power Levels for Read and Write * * * *

^RZ on page 416 Set RFID Tag Password and Lock Tag * * * *

^WF on page 418 Encode AFI or DSFID Byte — — — —

^WT on page 420 Write (Encode) Tag *b *b *b *b

^WV on page 422 Verify RFID Encoding Operation * * * *

* = Supported
— = Not supported
a. Use the ^RF, ^RM, and ^RR commands rather than the ^RT command.
b. Use the ^RF, ^RM, ^RR, and ^WV commands rather than the ^WT command.

P1012728-004 Rev. A Zebra Programming Guide 6/8/10

 RFID Commands 379
Printer and Firmware Compatibility

Table 20 • R4Mplus, RP4T, and R2844-Z Printer Command and Firmware Compatibility

R4Mplus

R2844-Z
RP4T
Command Function Firmware

SP1027X

SP1056X

SP1082X
SP994X

SP999X

all

all
^HL or ~HL Return RFID Data Log to Host * * * * * * —
on page 380
^HR on page 381 Calibrate RFID Transponder Position * * * * * * —

^RA on page 387 Read AFI or DSFID Byte — — — — — — —

^RB on page 389 Define EPC Data Structure * * * * * * —

^RE on page 391 Enable/Disable E.A.S. Bit — — — — — — *

^RF on page 392 Read or Write RFID Format * * * * * * —

^RI on page 395 Get RFID Tag ID * * * * * * *

^RM on page 396 Enable RFID Motion * * * * * * —

^RN on page 397 Detect Multiple RFID Tags in Encoding Field — — — — — * —

~RO on page 327 Reset Advanced Counters * * * * * * —

^RQ on page 398 Quick Write EPC Data and Passwords — — — — — * —

^RR on page 400 Specify RFID Retries for a Block * * * * * * —

^RS on page 402 Set Up RFID Parameters * * * * * *c *

^RT on page 410 Read RFID Tag *a *a *a *a *a *a *

~RV on page 412 Report RFID Encoding Results * * * * * * —

(SP994J (SP999C
or later) or later)

^RW on page 413 Set RF Power Levels for Read and Write * * * * * * —

^RZ on page 416 Set RFID Tag Password and Lock Tag * * * * * * —

^WF on page 418 Encode AFI or DSFID Byte — — — — — — —

^WT on page 420 Write (Encode) Tag *b *b *b *b *b *b *

^WV on page 422 Verify RFID Encoding Operation * * * * * * —

* = Supported
— = Not supported
a. Use the ^RF, ^RM, and ^RR commands rather than the ^RT command.
b. Use the ^RF, ^RM, ^RR, and ^WV commands rather than the ^WT command.
c. For parameter e, the only accepted value is N for No Action.

6/8/10 Zebra Programming Guide P1012728-004 Rev. A

380 ZPL RFID Commands
^HL or ~HL

^HL or ~HL
Return RFID Data Log to Host
Description The printer continually logs RFID data and stores it in the printer’s RAM. This
command requests that the RFID data log be returned to the host computer, to clear the current
data log, and to restart data recording.

In the log, RFID data displays in this format:

C,EEEE,DDDDDDDDDDDDDDDDDDDDDDDD

where
C = the RFID operation (R = read, W = write, L = lock, S = RFID settings,
E = log file reset)
EEEE = the RFID error code or the RFID setting (RPWR = read power, WPWR = write
power, ANT = antenna, PPOS = program position, FFFF = indicates that the log file
was reset)
DDDDDDDDDDDDDDDDDDDDDDDD = data read or written

Format ^HL or ~HL

Comments
• Data is shown in the format specified by the ^RFW command (ASCII, Hex, or EPC).
• If the log exceeds 64K (approximately 2000 operations), the data log is cleared
automatically, and data recording restarts. When this happens, the following appears in the
log:
E,FFFF,Logfile automatically reset
• If the printer loses power, the log is lost. If the log results are important to you, retrieve the
information frequently.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL RFID Commands 381
^HR

^HR
Calibrate RFID Transponder Position
Important • Consider the following before using this command:
• For the R110Xi4 printer, remove all transponders from the first 1.25 in. (32 mm) of
media. Allow this portion of the media to extend out the front of the printer to allow for
backfeed during the transponder calibration procedure.
• This command is not supported by all printers or firmware. See Printer and Firmware
Compatibility on page 376 for the list of printers and firmware with which you can use
this command.
• Do not perform transponder calibration for RFID media that meets the transponder
placement specifications for your printer. Doing so will slow the printer’s throughput
unnecessarily. To order media that is designed for use with your RFID printer, contact
your authorized Zebra reseller, or go to http://www.zebra.com/transponders for more
information.

Description Use this command to initiate transponder calibration for RFID media that does
not meet the transponder placement specifications for the printer. During the process, the
printer moves the media, calibrates the RFID transponder position, and determines the optimal
programming position for the RFID media being used. For the R110Xi4 printer, this command
also selects the best antenna element and read/write power level for the media.

Results of the transponder calibration are returned to the host computer. The RUN option in the
RFID TAG CALIB control panel parameter and the "RUN" option in the rfid.tag.calibrate
SGD command perform the same calibration but do not create a results table.
To return to the printer’s default programming position at any time, use one of the following:
• the RESTORE option in the RFID TAG CALIB control panel parameter
• the "RESTORE" option in the rfid.tag.calibrate SGD command (see rfid.tag.calibrate
on page 703)

Format ^HRa,b,c,d,e

Parameters Details
a = start string This parameter specifies the user text to appear before the results table.
Accepted values: any string less than 65 characters
Default value: start
b = end string This parameter specifies the user text to appear after the results table.
Accepted values: any string less than 65 characters
Default value: end

6/8/10 Zebra Programming Guide P1012728-004

382 ZPL RFID Commands
^HR

Parameters Details
c = start position This parameter specifies the start position of the calibration range. All numeric
values are in millimeters. Forward or backward designations assume that the
label's initial position is with the leading edge at the print line.
Accepted Values:
Forward: F0 to Fxxx (where xxx is the label length in millimeters or 999,
whichever is less)
The printer feeds the label forward for the specified distance and
then begins transponder calibration.
Backward: B0 to B30
The printer backfeeds the label for the specified distance and then
begins transponder calibration. Allow at least 1.25 in. (32 mm) of
empty media liner to extend out of the front of the printer.
Default value:
For the R110Xi4: B20
The printer backfeeds 20 mm before starting transponder calibration.
For all other supported printers: F0
The printer moves the media to the start position relative to the
leading edge of the label and then performs the RFID tag calibration.
d = end position This parameter specifies the end position of the calibration range (last program
position to check). All numeric values are in millimeters. Forward or backward
designations assume that the label's initial position is with the leading edge at
the print line.
Accepted Values:
Forward: F0 to Fxxx (where xxx is the label length in millimeters or 999,
whichever is less)
The printer performs transponder calibration until it reaches the
specified end position and then ends the process.
Backward: B0 to B30
The printer performs transponder calibration until it reaches the
specified end position and then ends the process. Valid only with a
backward start position that is greater than the end position.
A = Automatic (valid only on the R110Xi4 printer)
The printer automatically ends the transponder calibration process
after successfully reading and encoding a consecutive range of 5 mm
on the label.
Default value:
For the R110Xi4: A
For all other supported printers: Label length as shown on the printer
configuration label

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL RFID Commands 383
^HR

Parameters Details
e = antenna and Note • This parameter is valid only on the R110Xi4 printer.
read/write power
level detection
This parameter selects the option to select the antenna and read/write power
level automatically.
Accepted Values:
A = Automatic. The printer automatically scans through the antennas and
read/write power during calibration.
M = Manual. The printer uses the current antenna and read/write power
level settings.
Default value: A

6/8/10 Zebra Programming Guide P1012728-004

384 ZPL RFID Commands
^HR

Example 1 • When the printer is using Absolute mode and the following command is sent to
the printer:
^XA^HR^XZ
the printer starts the transponder calibration and returns a results table such as the following:
start
position=195
215, ,
214, ,
213, ,
212, ,
211, ,
210, ,W
209,R,
208, ,
207, ,
206, ,W
205,R,
204, ,
203, ,
202, ,W
201,R,W
200,R,W
199,R,W
198,R,W
197,R,W
196,R,W
195,R,W <---****
194,R,W
193,R,W
192,R,W
191,R,W
190,R,W
189,R,
188, ,
187, ,
186, ,
185, ,
.
.
.
end
Each line in the results table appears as:
Row, Read Result, Write Result
where
Row = the dot row where calibration occurred
Read Result = results of calibration (R = read, “ ” = unable to read)
Write Result = results of calibration (W = write, “ ” = unable to write)

The optimal programming position is 195. This is identified at the top of the table
(position=195) and with an the arrow (<---****) in the table.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL RFID Commands 385
^HR

Example 2 • When the printer is using Relative mode and the following command is sent to
the printer:
^HRstart,end,B20,F42,M
the printer starts the transponder calibration and returns a results table such as the following:
start
position=F0 MM
leading edge
B20, ,
B19, ,
B18, ,
B17, ,
…
B8, ,
B7, ,
B6, ,
B5, ,
B4,R,W
B3,R,W
B2,R,W
B1,R,W
F0,R,W<---**** F0 MM
F1,R,W
F2,R,W
F3,R,W
F4, ,
F5, ,
F6, ,
F7, ,
F8, ,
F9, ,
F10, ,
…
F38, ,
F39, ,
F40, ,
F41, ,
F42, ,
trailing edge
end
Each line in the results table appears as:
Row, Read Result, Write Result
where
Row = the position from the leading edge of the label where calibration occurred
Read Result = results of calibration (R = read, “ ” = unable to read)
Write Result = results of calibration (W = write, “ ” = unable to write)

The optimal programming position is F0 (program with the leading edge of the label at the
print line). This is identified at the top of the table (position=F0 MM) and with an the
arrow (<---****) in the table.

6/8/10 Zebra Programming Guide P1012728-004

386 ZPL RFID Commands
^HR

Example 3 • When an R110Xi4 printer is using Relative mode and the following command
is sent to the printer:
^HRstart,end,B20,A,A
the printer starts the transponder calibration and returns a results table such as the following:
start
position=F0 MM,A3,29,27
leading edge
B20,R,W,B3,15,17
B19,R,W,B3,11,13
B18,R,W,B3,9,11
B17,R,W,B3,7,9
B16,R,W,B3,5,9
B15,R,W,B3,5,9
B14,R,W,A3,27,29
B13,R,W,A3,27,29
B12,R,W,A3,27,27
B11,R,W,A3,25,25
B10,R,W,A3,15,19
B9,R,W,A3,11,15
B8,R,W,A3,9,13
B7,R,W,A3,7,11
B6,R,W,A3,7,9
B5,R,W,A3,7,9
B4,R,W,A3,7,9
B3,R,W,A3,7,9
B2,R,W,A3,7,11
B1,R,W,A3,11,13
F0,R,W,A3,13,17<---**** F0 MM,A3,29,27
F1,R,W,A3,19,19
F2,R,W,A3,27,25
trailing edge
end

Each line in the results table appears as:

Row, Read Result, Write Result, Antenna Element, Read Power, Write Power
where
Row = the position from the leading edge of the label where calibration occurred
Read Result = results of calibration (R = read, “ ” = unable to read)
Write Result = results of calibration (W = write, “ ” = unable to write)
Antenna Element = results of calibration (A1, A2, A3, A4, B1, B2, B3, B4, C1, C2,
C3, C4, D2, D3, D4, E2, E3, E4, F2, F3, or F4)
Read Power = results of calibration (0 – 30)
Write Power = results of calibration (0 – 30)

The results are identified at the top of the table (position=F0 MM,A3,29,27) and
with an the arrow (<---****) in the table. These results indicate that the optimal
programming position is F0 (program with the leading edge of the label at the print line). The
optimal antenna element is A3. The optimal read power is 29, and the optimal write power
is 27.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL RFID Commands 387
^RA

^RA
Read AFI or DSFID Byte
Important • This command is not supported by all printers or firmware. See Printer and
Firmware Compatibility on page 376 for the list of printers and firmware with which you can
use this command.

Description Use this command to read the AFI or DSFID byte. The data can be returned to
the host via the ^HV command.

Format ^RA#,f,r,m,b

Parameters Details
# = field number The value assigned to this parameter should be the same as the one used in the
specified with ^RT command.
another command Accepted values: 0 to 9999
Default value: 0
f = format Accepted values:
0 = ASCII
1 = Hexadecimal
Default value: 0
r = number of retries Accepted values: 0 to 10
Default value: 0
m = motion Accepted values:
0 = Feed label after writing.
1 = No Feed after writing. Other ZPL may cause a feed.
Default value: 0
b = type of byte to read Accepted values:
A = AFI byte
D = DSFID byte
Default value: A

Example 1 •This example reads the AFI byte in ASCII format and returns AFI Byte:x
to the host. The printer will retry the command five times if necessary. A voided label is
generated if the read is unsuccessful after these retries. The data read will go into the ^FN1
location of the recalled format.
^XA
^FO20,120^A0N,60^FN1^FS
^RA1,0,5,0^FS
^HV1,,AFI Byte:^FS
^XZ

6/8/10 Zebra Programming Guide P1012728-004

388 ZPL RFID Commands
^RA

Example 2 •This example reads the DSFID byte in ASCII format and returns
DSFID Byte:x to the host. The printer will retry the command three times if necessary. A
voided label is generated if the read is unsuccessful after these retries. The data read will go
into the ^FN1 location of the recalled format.
^XA
^FO20,120^A0N,60^FN1^FS
^RA1,0,3,0,D^FS
^HV1,,DSFID Byte:^FS
^XZ

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL RFID Commands 389
^RB

^RB
Define EPC Data Structure
Important • This command is not supported by all printers or firmware. See Printer and
Firmware Compatibility on page 376 for the list of printers and firmware with which you can
use this command.

Description Use this command to define the structure of EPC data, which can be read from
or written to an RFID transponder. For more information about EPC specifications, refer to the
EPC Global web site. All parameters in this command are persistent and will be used in
subsequent formats if not provided. The values are initially set to the default values.

RFID transponders can have different partitions defined. This command specifies the number
of partitions and how many bits are in each partition.

Format ^RBn,p0,p1,p2, ..., p15

Parameters Details
n = total bit size of the Specify the number of bits to include in the partitions.
partitions Accepted values: 1 to n, where n is the bit size of the tag.
Default value: 96
p0 ... p15 = Specify the number of bits to include in the individual partitions. The partition
partition sizes sizes must add up to the bit size specified for the previous parameter. The
largest individual partition size is 64 bits.
Accepted values: 1 to 64
Default value: 1

Example 1 • The following command specifies that there are 96 bits used with three fields.
Fields 1, 2, and 3 contain 10, 26, and 60 bits, respectively.
^RB96,10,26,60

The ZPL code to encode a tag with this format would look like this:
^RFW,E^FD1000.67108000.1122921504606846976^FS
When the tag is being encoded, the tag stores the data in the following way:
• Field 1 contains 1000. This value is stored in the first 10 bits
• Field 2 contains 67108000. This value is stored in the next 26 bits.
• Field 3 contains 1122921504606846976. This value is stored in the remaining
60 bits.

6/8/10 Zebra Programming Guide P1012728-004

390 ZPL RFID Commands
^RB

Example 2 • The following command specifies that there are 64 bits used with eight 8-bit
fields.
^RB64,8,8,8,8,8,8,8,8^FS
The ZPL code to encode a tag with this format would look like this:
^RFW,E^FD1.123.160.200.249.6.1.0^FS
When writing to the tag, each set of data is written in its respective 8-bit field.

Example 3 • This example uses the SGTIN-96 standard, which defines 96-bit structure in
the following way:

Company Item Serial

Header Filter Value Partition
Prefix Index Reference Number

SGTIN-96 8 bits 3 bits 3 bits 20–40 bits 24 bits 38 bits

10 8 8 16,383 9 to 1,048,575 33,554,431
(binary value) (decimal (decimal (decimal (decimal (decimal
capacity) capacity) capacity) capacity*) capacity)
* Capacity of Item Reference field varies with the length of the company prefix.

The ZPL code to encode a tag with this format would look like this:
^XA
^RB96,8,3,3,20,24,38^FS
^RFW,E^FD48,1,6,770289,10001025,1^FS
^XZ
These commands would put
• 48 in the header
• 1 as the filter value
• 6 as the partition (indicates a 20-bit prefix and 24-bit item reference)
• 770289 as the company prefix
• 10001025 as the item reference
• 1 as the serial number
To read this EPC data and print the results on the label, you would use the following code:
^XA
^RB96,8,3,3,20,24,38^FS
^FO50,50^A0N,40^FN0^FS
^FN0^RFR,E^FS
^XZ
The resulting label would look like this:

48.1.6.770289.10001025.1

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL RFID Commands 391
^RE

^RE
Enable/Disable E.A.S. Bit
Important • This command is not supported by all printers or firmware. See Printer and
Firmware Compatibility on page 376 for the list of printers and firmware with which you can
use this command.

Description Use this command to enable or disable the Electronic Article Surveillance
(E.A.S.) bit that is available in some ISO15693 tags (such as Philips). This command works
only on those ISO15693 transponders and will be ignored if the tag does not support E.A.S.

Format ^REt,r

Parameters Details
t = Enable/disable the Accepted values:
E.A.S. bit in the N = Disable E.A.S.
ISO15693 Y = Enable E.A.S.
transponder
Default value: N
r = number of retries Accepted values: 0 to 10
Default value: 0

Example • This example enables the E.A.S. bit in the transponder. It will retry the command
five times if necessary.
^XA
^REy,5
^XZ

6/8/10 Zebra Programming Guide P1012728-004

392 ZPL RFID Commands
^RF

^RF
Read or Write RFID Format
Important • This command is not supported by all printers or firmware. See Printer and
Firmware Compatibility on page 376 for the list of printers and firmware with which you can
use this command.

Description Use this command to read or write to (encode) an RFID tag. When using this
command to read a tag, you may use a field variable to print the tag data on the label or to
return the data to the host. For more information on how memory is stored on a Gen 2 tag or
for examples that use a field variable, refer to the RFID Programming Guide for your printer.
A copy of the manual is located on the User CD that came with your printer, or you can
download a copy from http://www.zebra.com/manuals.

Format ^RFo,f,b,n,m

Parameters Details
o = operation Specifies the action to be performed.
Accepted Values:
W = write to (encode) the tag
L = write with LOCK (if supported by tag type; Gen 2 tag type does not
use this locking function)
R = read the tag
P = read password (Gen 2 tag type only)
Default Value: W
f = format Accepted Values:
A = ASCII
H = Hexadecimal
E = EPC (ensure proper setup with the ^RB command)
Default Value: H

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL RFID Commands 393
^RF

Parameters Details
b = starting block For tag types other Gen 2:
number Specifies the starting block number.
Accepted Values: 0 to n, where n is the maximum number of blocks for the tag.
Default Value: 0
For Gen 2 tag type only:
What you specify for this parameter depends on what you entered for the
operation parameter.
• When W, L, or R are specified for the operation parameter, this parameter
specifies a 16-bit word block number.
Accepted Values: 0 to n, where n is the maximum number of blocks for the
bank specified in the memory bank parameter
Default Value: 0
• When P is specified for the operation parameter, this parameter specifies
which password to read.
Accepted Values:
K = kill password
A = access password
Default Value: K
n = number of bytes to Specifies the number of bytes to read or write.
read or write For high-frequency (HF) printers:
Accepted Values: 1 to n, where n is the maximum number of bytes for the tag.
Default Value: 1
For Gen 2 tag type only:
When E is specified for the memory bank parameter, this value is not required.
Accepted Values: 1 to n, where n is the maximum number of bytes for the tag.
Default Value: 1
For all other printers and tag types:
This parameter applies only when the starting block number is 1.
Accepted Values: 1 to n, where n is the maximum number of bytes for the tag.
For UCODE EPC 1.19, n is 32.
Default Value: 1
m = memory bank Note • This parameter applies to Gen 2 tags only.

Specifies the Gen 2 memory bank. For more information about Gen 2 memory,
refer to the RFID Programming Guide for your printer.
Accepted Values:
E = EPC 96-bit (command automatically performs operation on Gen 2 bit
address 20h and accesses 12 bytes of the EPC memory bank)
0 = Reserved
1 = EPC
2 = TID (Tag ID)
3 = User
Default Value: E

6/8/10 Zebra Programming Guide P1012728-004

394 ZPL RFID Commands
^RF

Example 1 • This example encodes 96-bit data in ASCII format.

^XA
^RS8
^RFw,a^FD00 my data^FS
^XZ

Example 2 • This example encodes 96-bit EPC data, as specified by the ^RB command.
^XA
^RB96,8,3,3,20,24,38
^RFw,e^FD16,3,5,78742,146165,1234567891^FS
^XZ

Example 3 • This example encodes 4 bytes of hexadecimal formatted data, starting in

block 3 of Gen 2 EPC bank 1.
^XA
^RS8
^RFW,H,3,4,1^FD11112222^FS
^XZ

Example 4 • This example reads the extended Gen 2 tag ID (TID), which is not read by the
^RI command, and returns the results to the host computer. The results are labeled with the
header “8-byte Tag ID Data.”
^XA
^RS8
^RFR,H,0,8,2^FN1^FS^HV1,,8-byte Tag ID Data:^FS
^XZ

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL RFID Commands 395
^RI

^RI
Get RFID Tag ID
Important • This command is not supported by all printers or firmware. See Printer and
Firmware Compatibility on page 376 for the list of printers and firmware with which you can
use this command.

Description Use this command to get the unique serial number of the tag and return it in
hexadecimal format. The data can be sent back to the host via the ^HV command.

For Gen 2 tag types, this command returns the 32-bit tag ID (TID) for the tag. If your Gen 2
tag supports TID data beyond 32 bits, see ^RF on page 392 to access the TID memory bank.

Format ^RIa,b,c,d

Parameters Details
a = number to be Accepted values: 0 to 9999
assigned to the field Default value: 0
b = specify data order Note • This parameter applies only to the R110Xi HF and R2844-Z
printers.

Accepted Values:
0 = Most significant byte first for Tag*It and PicoTag. Least significant
byte first for I*code and ISO15693.
1 = Reverse the data order
Default value: 0

c = number of retries Accepted values: 0 to 10

Default value: 0
d = motion Accepted values:
0 = Feed label after writing
1 = No Feed after writing (other ZPL commands may cause a feed)
Default value: 0

Example • This example reads a tag ID, prints it on a label, and sends string
Tag ID:xxxxxxxx to the host. The data read will go into the ^FN0 location of the
format. The printer will retry the command five times, if necessary.
^XA
^FO20,120^A0N,60^FN0^FS
^RI0,,5^FS
^HV0,,Tag ID:^FS
^XZ

6/8/10 Zebra Programming Guide P1012728-004

396 ZPL RFID Commands
^RM

^RM
Enable RFID Motion
Important • This command is not supported by all printers or firmware. See Printer and
Firmware Compatibility on page 376 for the list of printers and firmware with which you can
use this command.

Description Use this command to enable or disable RFID motion. By default, labels
automatically print at the end of the format. This command allows you to inhibit the label from
actually moving when it reaches the program position, which is useful for debugging, setup,
and custom applications. This parameter is not persistent (carried over from label to label).

Format ^RMe

Parameters Details
e = enable Accepted values:
Y = Yes, move the label
N = No, do not move the label
Default value: Y

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL RFID Commands 397
^RN

^RN
Detect Multiple RFID Tags in Encoding Field
Important • This command is not supported by all printers or firmware. See Printer and
Firmware Compatibility on page 376 for the list of printers and firmware with which you can
use this command.

Description Use this command to enable or disable detection of multiple RFID tags in the
encoding field. By default, the printer checks for more than one tag in the field before
attempting to read or write. If more than one tag is found, the label over the antenna support is
voided, and the RFID ERR STATUS parameter on the control panel displays
MULTIPLE TAGS. To speed up printing and encoding by up to 200 ms, the check may be
disabled. This parameter is persistent (carried over from label to label).

Format ^RNe

Parameters Details
e = enable Accepted Values:
Y = Yes, check for multiple tags
N = No, do not check for multiple tags
Default Value: Y

6/8/10 Zebra Programming Guide P1012728-004

398 ZPL RFID Commands
^RQ

^RQ
Quick Write EPC Data and Passwords
Important • This command is not supported by all RFID tags, printers, or firmware. See
Printer and Firmware Compatibility on page 376 for the list of printers and firmware with
which you can use this command.

Description Use this command with an Alien Higgs RFID tag and appropriate firmware to
write the EPC data, access password, and kill password with one command. Doing so reduces
the encoding time.

Note • The access password on the tag to be written to must be 00000000 prior to sending
this command.

Format ^RQf,c,o[data]

Parameters Details
f = format Accepted Values:
A = ASCII
H = Hexadecimal
E = EPC
Default Value: H
c = chip type Accepted Values: 0 (Higgs IC tag)
Default Value: 0
o = option Accepted Values: 0 (write 96-bit EPC)
Default Value: 0
data = the EPC data, Use the ^FD command to specify the passwords in the following format:
access password, and
^FD[EPC],[access],[kill]
kill password
where:
EPC = the EPC data in the format specified by the f parameter. The data
should match what would be programmed with the ^RF command.
access = an optional access password in hexadecimal format. If this field
is left blank, 0x00000000 is written as the access password.
kill = an optional kill password in hexadecimal format. If this field is left
blank, 0x00000000 is written as the kill password.

Example 1 • This example writes the EPC data to the tag in hexadecimal format. The
unspecified access and kill passwords are written as zeroes (0x00000000).
^XA^RQ^FD112233445566778899001122^XZ

Example 2 • This example writes the EPC data to the tag in hexadecimal format. The access
password is written as 0xAAAAAAAA, and the kill password is written as 0xBBBBBBBB.
^XA^RQ^FD112233445566778899001122,AAAAAAAA,BBBBBBBB^XZ

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL RFID Commands 399
^RQ

Example 3 • This example writes the EPC data to the tag in EPC format. The unspecified
access and kill passwords are written as zeroes (0x00000000).
^XA^RB96,30,30,30,6^RQE^FD1234.5678.9012.12^XZ

Example 4 • This example writes the EPC data to the tag in hexadecimal format. The access
password is written as 0xAAAAAAAA, and the unspecified kill password is written as
zeroes (0x00000000).
^XA^RB96,30,30,30,6^RQE^FD1234.5678.9012.12,AAAAAAAA^XZ

6/8/10 Zebra Programming Guide P1012728-004

400 ZPL RFID Commands
^RR

^RR
Specify RFID Retries for a Block
Important • This command is not supported by all printers or firmware. See Printer and
Firmware Compatibility on page 376 for the list of printers and firmware with which you can
use this command.

Description Use this command to change the number of times that the printer attempts to
read or write to a particular block of a single RFID tag. This command is persistent and will be
used in subsequent formats if not provided.

Note • This command’s function is different than the “number of labels” parameter in the
^RS command.

Format ^RRn,a

Parameters Details
n = number of retries Accepted Values: 0 to 10
Default Value: 6
a = adaptive antenna Note • This parameter is valid only on the R110Xi4 printer with a label
element selection that is 2 in. (51 mm) or longer.

After the printer has exhausted the number of retries specified by parameter n,
the printer may try other antenna elements. This parameter enables this ability.
If the printer is unsuccessful communicating with the RFID tag after trying the
neighboring antenna elements, the printer voids the label.
Note • Activating this parameter may slow throughput on damaged or
weak RFID tags.

Accepted Values: 0 or 1
0 = None. The printer uses only the current antenna element selection.
1 = Neighbors. The printer attempts to read the tag using the antenna
elements to the left/right and above/below the current antenna
element. The antenna element that is successful is used for all
subsequent RFID commands until the next unsuccessful attempt,
until the printhead is opened, or until the printer is power cycled.
Default Value: 0

Example 1 • This example sets the read block retries to 5.

^XA
^FN1^RR5^RFR,H^FS
^HV1^FS
^XZ

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL RFID Commands 401
^RR

Example 2 • This example sets the write block retries to 2.

^XA
^RR2^RFW,H^FD1234^FS
^XZ

Example 3 • On an R110Xi4 printer, this example sets the write retries to 2 and allows the
printer to try neighboring antennas in the event that the current antenna cannot write to the
RFID tag.
^XA
^RR2,1^RFW,H^FD1234^FS
^XZ

6/8/10 Zebra Programming Guide P1012728-004

402 ZPL RFID Commands
^RS

^RS
Set Up RFID Parameters
Use this command to set up RFID parameters including tag type, read/write position of the
transponder, and error handling.

Use care when using this command in combination with ^RT or ^RF for reading tag data.
Problems can occur if the data read from the tag is going to be printed on the label. Any data
read from the transponder must be positioned to be printed above the read/write position.
Failure to do this will prevent read data from being printed on the label.

Format ^RSt,p,v,n,e,a,c,s

Parameters Details
t = tag type Tells the printer/print engine which tag type you are using. If you specify a tag
type that is not supported by your printer or firmware, the printer uses its
default value. For the supported tag types and defaults, see Table 7 on page 87.
Accepted Values:

UHF Printers
0 = None
1 = EPC Class 0
2 = EPC Class 0 Plus
3 = EPC Class 1 64-bit
4 = EPC Class 1 96-bit
5 = UCODE EPC 1.19
6 = Impinj Class 0 Plus
7 = ISO 18000-06A
8 = EPC Class 1, Generation 2 (Gen 2)
9 = ISO 18000-06B
HF Printers
Note • Only the R110Xi HF printer (firmware version R65.X.X)
supports the use of letters for this parameter. All other printers use the
numbers.
A or 0 = None
B or 1 = Auto detect (query tag to determine)
C or 2 = Tag*It (Texas Instruments Tagit tags)
D or 3 = I*code (Phillips Icode tags)
E or 4 = Pico Tag (Inside Technology’s)
F or 5 = ISO 15693
G or 6 = EPC tag (13.56 MHz)
H or 7 = UID Tag
I or 8 = Mifare UltraLight
Default Value: varies by printer (see Table 7 on page 87)

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL RFID Commands 403
^RS

Parameters Details
p = read/write position of This parameter sets the read/write position of the transponder in one of two
the transponder ways: absolute mode (available in all RFID firmware versions) or relative
(programming mode (available in firmware versions V53.17.7Z and later). For more
position) information on these modes, refer to the RFID Programming Guide 2. A copy
is available at http://www.zebra.com/manuals.
Important • If a label format specifies a value for the programming
position, this value will be used for the programming position for all
labels until a new position is specified or until the transponder
calibration procedure is run.
Accepted Values:
Absolute Mode:
xxxx = 0 to label length (in dot rows). Move the media to the specified
position xxxx on the label, measured in dot rows from the label top,
before encoding. Set to 0 (no movement) if the transponder is already
in the effective area without moving the media.
Relative Mode Forward:
Fxxx = F0 to Fxxx (where xxx is the label length in millimeters or 999,
whichever is less). Move media forward, printing bitmap, for xxx
millimeters before reading or encoding.
Relative Mode Backward:
Byy = B0 to B30 (in millimeters, 30 mm maximum). Move media backward
for yy millimeters before reading or encoding. (Does not apply to the
RP4T printer.)

Note • When using a backward program position, allow enough media

or liner to ensure that the printer can back up the media without the
leading edge disappearing under the printhead mechanism.
Default value:
For the R2844-Z and RPAX: 0 (no movement)
For printers using V53.17.7Z and later: F0 (which moves the leading
edge of the label to the print line)
For all other printers or firmware: label length minus 1 mm (1/16 in.)

v = length of void Sets the length of the void printout in vertical (Y axis) dot rows.
printout Accepted values: 0 to label length
Default value: label length
n = number of labels The number of labels that will be attempted in case of read/encode failure.
Accepted values: 1 to 10
Default value: 3

6/8/10 Zebra Programming Guide P1012728-004

404 ZPL RFID Commands
^RS

Parameters Details
e = error handling If an error persists after the specified number of labels are tried, perform this
error handling action.
Accepted values:
N = No action (printer drops the label format causing the error and moves
to the next queued label)
P = Place printer in Pause mode (label format stays in the queue until the
user cancels)
E = Place printer in Error mode (label format stays in the queue until the
user cancels)
Default value: N
Note • You can set the printer to send an error message to the host for
each failure. To enable or disable this unsolicited error message, refer to
the ^SX and ^SQ ZPL commands. Use V for the condition type for an
RFID error.
a = signals on applicator Note • This parameter does not apply to the R2844-Z. For the
R4Mplus, this parameter applies only to printers with firmware version
SP994X (R4Mplus European version).

Single Signal Mode

In this mode, one start print signal starts printing. Then, at the program position
(parameter p), the printer automatically stops and encodes the tag. Printing
continues, and a single end print signal signifies the completion of the label.
Double Signal Mode
With RFID, when there is a non-zero program position, the label is logically
split into two parts. The first part is printed, the tag encodes, and then the
second part prints. If this parameter is set to “D,” then the label is split into two
and requires both portions of the label to be controlled by the applicator. This
means that a start print signal triggers the first portion of the label, and then
when the printer reaches the RFID program position (and the motor stops), an
end print signal is provided. In this mode, a second start print signal is required
to print the rest of the label. When the label is complete, a final end print signal
is provided.
Note • If parameter p is zero, then single signal mode is used
(parameter ignored). If p is F0 (or B0) with backfeed-after, then single
signal mode is used (parameter ignored).
Accepted values:
S = single signal
D = double signal (For the R110PAX4, Double mode will work only if the
read/write position is changed from the default of zero.)
Default value: S
c = reserved Not applicable.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL RFID Commands 405
^RS

Parameters Details
s = void print speed Note • This parameter does not apply to the R2844-Z. For the
R4Mplus, this parameter applies only to printers with firmware version
SP994X (R4Mplus European version).
If a label is voided, the speed at which “VOID” will be printed across the label.
Accepted values: any valid print speed
Default value: the printer’s maximum print speed

Supported Tag Types Table 21 shows the tag types supported by different RFID
printers/print engines and firmware versions. Depending on your country or on the firmware
version that you are using, your printer may not support all of the tag types listed. If you
specify an unsupported tag type, the printer uses the default value. If a tag type is shown as
supported but does not work with your printer, you may need to upgrade the printer’s firmware
(see http://www.zebra.com/firmware).

Table 21 • Supported Tag Types and Default Values

UHF Printers HF Printers

RZ400/ RZ600
Printer

R110Xi HF
R110PAX4

R4Mplus

R2844-Z
R110Xi4

R170Xi
R110Xi

SP994O, SP999E, SP1027E,

SP994P, SP999F, SP1027F,

SP1082E, and earlier

SP1056D and earlier

SP1082F, and later

SP1056E and later

R60.15.X and later

R62.15.X and later

R63.15.X and later

R53.16.X and later

R65.15.X and later

V53.17.7 and later

Firmware Version
R60.13.X

R62.13.X

R63.13.X

R65.13.X

all
Tag Type

UHF Tag Types and Options

None (no tag type specified) — * * * * — — — — — — — — — —

EPC Class 0 — * * * * — — — — — — — — — —

EPC Class 0 Plus — * * * * — — — — — — — — — —

EPC Class 1 64-bit — * * * * — — — — — — — — — —

EPC Class 1 96-bit — # * # * — * * * — — — — — —

UCODE EPC 1.19 — *a * — * # * # * # * — — — —

Impinj Class 0 Plus — * * * * — — — — — — — — — —

ISO 18000-06A — — — * — — * * * — — — — — —

EPC Class 1, Generation 2 (Gen 2) # * # * # — # * # * # # — — —

ISO 18000-06B — * * * * — * * * * * — — — —

# = Default value * = Accepted value — = Not supported

a. Requires R60.13.0.13ZD or later.

6/8/10 Zebra Programming Guide P1012728-004

406 ZPL RFID Commands
^RS

Table 21 • Supported Tag Types and Default Values (Continued)

UHF Printers HF Printers

RZ400/ RZ600
Printer

R110Xi HF
R110PAX4

R4Mplus

R2844-Z
R110Xi4

R170Xi
R110Xi

SP994O, SP999E, SP1027E,

SP994P, SP999F, SP1027F,

SP1082E, and earlier

SP1056D and earlier

SP1082F, and later

SP1056E and later

R60.15.X and later

R62.15.X and later

R63.15.X and later

R53.16.X and later

R65.15.X and later

Firmware Version V53.17.7 and later

R60.13.X

R62.13.X

R63.13.X

R65.13.X

all
Tag Type

HF Tag Types and Options —

Auto-detect the tag type by querying the tag — — — — — — — — — — — — — — #

Tag*It (Texas Instruments Tagit tags) — — — — — — — — — — — — — — *

I*code (Phillips Icode tags) — — — — — — — — — — — — — — *

Pico Tag (Inside Technology’s) — — — — — — — — — — — — — — *

ISO 15693 — — — — — — — — — — — — # # *

EPC tag — — — — — — — — — — — — — — *

UID Tag — — — — — — — — — — — — — — —

Mifare UltraLight — — — — — — — — — — — — * * —

# = Default value * = Accepted value — = Not supported

a. Requires R60.13.0.13ZD or later.

Example 1 • The following are examples of Absolute Mode and Relative Mode for the
transponder position parameter (parameter p).
Absolute Mode
1. ^RS,520 sets the encode position at 520 dots from the top edge of the label.
2. ^RS,0 programs the tag without moving the media.
Relative Mode
1. ^RS,F1 sets the encode position 1 mm forward from the leading edge of the label.
2. ^RS,B10 sets the encode position 10 mm backwards from the leading edge of the label.
3. ^RS,F0 sets the encode position at the leading edge of the label.
4. ^RS,B0 sets the encode position at the leading edge of the label.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL RFID Commands 407
^RS

Example 2 • The following shows the difference between absolute and relative
programming positions for the transponder position parameter (parameter p) with a 6-inch
(152-mm, 1216-dot) label length. The end results are that the tag is programmed with the
label in the same position.

print direction

encoding area 1
print line
tear bar
2

1 ^RS,496, Absolute Mode, 496 dots

from the top of the label
2 ^RS,F90, Relative Mode, 90 mm
from the leading edge of the label

6/8/10 Zebra Programming Guide P1012728-004

408 ZPL RFID Commands
^RS

Example 3 • This example sets the printer to move the media to 800 dots from the top of the
media [or label length minus 800 from the bottom (leading edge) of the media] and voids the
rest of the media in case of an error. The printer will try to print two labels and then will
pause if printing and encoding fail.
^XA
^RS,800,,2,P^FS
^XZ
Figure 3 shows the resulting voided label. Note where the void starts. The media has been
moved 800 dot rows from the top of the label (label length minus 800 dot rows from the
bottom (leading edge) of a label) to bring the transponder into the effective area to read/write
a tag. If the printer fails the operation, the rest of the media is voided.

Figure 3 • Sample Void Label

Top of label

800 dot rows

Start of RFID
operation

Label length minus

800 dot rows

Bottom of label

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL RFID Commands 409
^RS

Example 4 • This example sets the printer to move the media to 800 dots from the top of the
media [or label length - 500 from the bottom (leading edge) of the media] and prints “VOID”
500 dots in vertical length (Y axis) in case of an error.
^XA
^RS,800,500,2,P^FS
^XZ
Figure 4 shows the resulting voided label. Note where the void starts. The media has been
moved 800 dot rows from the top of the label [label length minus 800 dot rows from the
bottom (leading edge) of a label] to bring the transponder into the effective area to read/write
a tag. If the printer fails the operation, an area that is 500 dot rows of the media is voided
instead of the entire rest of the media.

Figure 4 • Sample Void Label, 500 Dot Row Area Voided

Top of label

800 dot rows

500 dot rows

Start of RFID
operation

Label length minus

800 dot rows

Bottom of label

6/8/10 Zebra Programming Guide P1012728-004

410 ZPL RFID Commands
^RT

^RT
Read RFID Tag
Note • The ^RT command is provided only for backward-compatibility with label formats
that were developed for older Zebra RFID printers. See Printer and Firmware Compatibility
on page 376 for the list of printers and firmware with which you should not use this
command.

Description Use this command to tell the printer to read the current RFID tag data. The data
can be returned to the host via the ^HV command.

Format ^RT#,b,n,f,r,m,s

Parameters Details
# = number to be Accepted values: 0 to 9999
assigned to the field Default value: 0
b = starting block Accepted values: 0 to n, where n is the maximum number of blocks for the tag.
number Default value: 0
n = number of Accepted values: 1 to n, where n is the maximum number of blocks for the tag
blocks/bytes to read type minus the starting block number. For example, if the tag has 8 blocks
(starting with block 0) and you start with block 6, n can be 2. This would return
block 6 and block 7 information.
Default value: 1
f = format Accepted values:
0 = ASCII
1 = Hexadecimal
Default value: 0
r = number of retries Changes the number of times that the printer attempts to read a particular block
of a single RFID tag. (Same retry rules as the ^RR command.)
Accepted values: 0 to 10
Default value: 0
m = motion Enables or disables RFID motion for the current field.
Accepted values:
0 = Feed label after writing.
1 = No feed after writing. Other ZPL may cause a feed.
Default value: 0

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL RFID Commands 411
^RT

Parameters Details
s = special mode Note • This parameter is used only for the printers referenced here.

For R4Mplus printers with firmware version SP920X (U.S. version):

Specify actions for mismatched checksums. For EPC Class 1 (Alien reader)
only. Not applicable for EPC class 0.
Default value: 0
Accepted values:
0 = Do not read if mismatched checksum
1 = Read even if mismatched checksum
For R110Xi HF and R2844-Z printers:
Specify data order.
Default value: 0
Accepted values:
0 = least significant byte first
1 = most significant byte first

Example 1 •This example reads a tag, prints the data on a label, and sends the string
Tag Data:xxxxxxxx back to the host. The data read will go into the ^FN1 location of
the format. The printer will retry the command five times, if necessary.
^XA
^FO20,120^A0N,60^FN1^FS
^RT1,,,,5^FS
^HV1,,Tag Data:^FS
^XZ

Example 2 •This example reads from a tag twice and prints the results on a label.
^XA
^FO20,120^A0N,60^FN1^FS
^FO20,100^A0N,20^FN2^FS
^RT1,7,3,,5^FS
^RT2,3,2,,5^FS
^XZ
The first ^RT command starts at block 7 and reads three blocks of data in ASCII format. The
data read will go into the ^FN1 location of the format. The printer will retry the command
five times, if necessary.
The second ^RT command starts at block 2 and reads two blocks of data in ASCII format.
The data read will go into the ^FN2 location of the format. The printer will retry the
command five times, if necessary.

6/8/10 Zebra Programming Guide P1012728-004

412 ZPL RFID Commands
~RV

~RV
Report RFID Encoding Results
Important • This command is not supported by all printers or firmware. See Printer and
Firmware Compatibility on page 376 for the list of printers and firmware with which you can
use this command.

Description Use this command to tell the printer to send RFID encoding success or failure
results to the host computer after each label format completes.

Format ~RVa

Parameters Details
a = enable/disable Enables or disables the results reporting feature.
Accepted Values:
E = Enable
D = Disable
Default Value: D

Example 1 • Assume that the following code is sent and that there is no RFID tag in the
field.
~RVE
^XA
^RS8,0,,3
^RMY
^RFR,H
^XZ
The printer attempts to program a tag three times and then returns the following to the host:
_-,3_
The minus sign indicates that the programming attempt failed entirely and voided three
labels.

Example 2 • Assume that the same code is sent and that the first two attempts at
programming a tag are unsuccessful. The third attempt succeeds.
~RVE
^XA
^RS8,0,,3
^RMY
^RFR,H
^XZ
The printer attempts to program a tag three times and then returns the following to the host:
_+,2_
The plus sign indicates that the programming attempt was successful and voided two labels.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL RFID Commands 413
^RW

^RW
Set RF Power Levels for Read and Write
Important • This command is not supported by all printers or firmware. See Printer and
Firmware Compatibility on page 376 for the list of printers and firmware with which you can
use this command.

Description Use this command to set the RFID read and write power levels. This function
is useful when using different tag types or transponders that require different power levels to
obtain the best read and write abilities. If not enough power is applied, the transponder may
not have sufficient power for programming, and tag data will fail to encode. If too much power
is applied, the extra power may cause data communication errors.

Note • The R110Xi4 printer automatically selects the best antenna element and read/write
power levels for the media during RFID transponder calibration. It may also set the levels
during an adaptive antenna sweep. Use the ~HL command (see ^HL or ~HL on page 380) to
view the antenna element and power settings being used.

Format ^RWr,w,a

Parameters Details
r = read power This parameter sets the power level to match the desired output as calibrated in
the factory.
R53.16.3, V53.17.7Z, and later:
Values: 0 to 30
Default Value: 16
R60.16.4, R62.16.4, R63.16.4, SP994Q, SP999G, SP1027G, SP1056F,
SP1082G, and later:
Values: 0 to 30, H (high), M (medium), L (low)
Default Value: L
R65.X and older versions of other firmware:
Accepted Values:
H = high
M = medium
L = low
Default Value: L

6/8/10 Zebra Programming Guide P1012728-004

414 ZPL RFID Commands
^RW

Parameters Details
w = write power Note • This parameter is ignored on the R110Xi HF printer (firmware
version R65.X) because read and write powers cannot be specified
separately. The printer uses the value that you specified for read power
for both the read and write power settings.
This parameter sets the power level to match the desired output as calibrated in
the factory.
R53.16.3, V53.17.7Z, and later:
Values: 0 to 30
Default Value: 16
R60.16.4, R62.16.4, R63.16.4, SP994Q, SP999G, SP1027G, SP1056F,
SP1082G, and later:
Values: 0 to 30, H (high), M (medium), L (low)
Default Value: L
Older versions of firmware:
Accepted Values:
H = high
M = medium
L = low
Default Value: L

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL RFID Commands 415
^RW

Parameters Details
a = RFID antenna Note • This parameter is valid only on the R110Xi4 printer.
element selection

Note • This parameter applies only to the R110Xi HF and the R110Xi4
printers.
R110Xi HF (R65.X):
This parameter selects the antenna port that provides the best results for
reading and writing.
Accepted Values:
1 = antenna port 1
2 = antenna port 2
Default Value: 1
R110Xi4 (V53.17.7Z and later):
This parameter selects an antenna element from the printer’s antenna array.
Accepted Values:
A1, A2, A3, A4, B1, B2, B3, B4, C1, C2, C3, C4, D2, D3, D4, E2, E3, E4,
F2, F3, F4 (combinations D1, E1, and F1 are invalid)

Default Value: A4

Example 1 • The following command selects the antenna at row D, column 3 on an R110Xi4
printer:
^RW,,D3
Example 2 • The following command sets the read/write power level to Medium and selects
antenna 2 on an R110Xi HF printer:
^RWM,,2
Example 3 • The following command sets the read and write power levels to High on an
R110PAX4 printer:
^RWH,H

6/8/10 Zebra Programming Guide P1012728-004

416 ZPL RFID Commands
^RZ

^RZ
Set RFID Tag Password and Lock Tag
Important • This command is not supported by all printers or firmware. See Printer and
Firmware Compatibility on page 376 for the list of printers and firmware with which you can
use this command.

Description Use this command to define a password for a tag during writing.

With Gen 2 tags, you can lock a tag’s memory bank with an access password or define a kill
password that can be used to permanently disable the tag. If you do not set access or kill
passwords for a tag, the tag ignores any read or write commands that try to use these functions.

Note • The printer can set a kill password, but the printer cannot kill a tag.

Format ^RZp,m,l

Parameters Details
p = password This parameter sets a password for the RFID tag.
For tag types other than Gen 2:
The password is 8 bits. The memory bank and lock style parameters are
ignored. The password must be 2 hexadecimal characters long.
Accepted Values: 00 to FF (hexadecimal)
Default Value: 00
For Gen 2 tag type only:
Gen 2 tags use a 32-bit password and specify the memory bank and lock style.
The password must be 8 hexadecimal characters long. Use ^RF on page 392 to
read the passwords.
Accepted Values: 00000000 to FFFFFFFF (hexadecimal)
Default Value: none
m = memory bank Note • This parameter applies to Gen 2 tags only.

This parameter specifies the type of RFID tag password.

Accepted Values:
K = kill password
A = access password
E = EPC
T = tag identifier (TID)
U = user
Default Value: none

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL RFID Commands 417
^RZ

Parameters Details
l = lock style Note • This parameter applies to Gen 2 tags only.

This parameter specifies the RFID tag password status.

Accepted Values:
U = unlocked
L = locked
O = permanently unlocked (open)
P = permanently locked (protected)
W = write value (used only for the kill password memory bank)
Default Value: none

Example 1 • On a tag that is not Gen 2, this example encodes 5A as the tag password.
^XA
^RZ5A^FS
^XZ

Example 2 • On a Gen 2 tag, this example encodes EPC data

112233445566778899001122 to the tag in Hex format, write protects the tag’s EPC
data with password 1234ABCD, and leaves the tag’s access password unlocked.
^XA
^RFW,H^FD112233445566778899001122^FS
^RZ1234ABCD,E,L^FS
^XZ

Example 3 • On a Gen 2 tag, this example encodes EPC data

112233445566778899001122 to the tag in Hex format, write protects the tag’s EPC
data with password 1234ABCD, and makes the tag’s access password unreadable.
^XA
^RFW,H^FD112233445566778899001122^FS
^RZ1234ABCD,E,L^FS
^RZ1234ABCD,A,L^FS
^XZ
The following code unprotects EPC data 112233445566778899001122 using the
password 1234ABCD, encodes EPC data newdata to the tag in ASCII format, and then
write protects the tag’s new EPC data. The access password and its lock state are not
changed, so the access password remains unreadable.
^XA
^RZ1234ABCD,E,U^FS
^RFW,A^FDnewdata^FS
^RZ1234ABCD,E,L^FS
^xz

Example 4 • This example unlocks the locked access password from the previous example.
^XA
^RZ1234ABCD,A,U^FS
^XZ

6/8/10 Zebra Programming Guide P1012728-004

418 ZPL RFID Commands
^WF

^WF
Encode AFI or DSFID Byte
Important • This command is not supported by all printers or firmware. See Printer and
Firmware Compatibility on page 376 for the list of printers and firmware with which you can
use this command.

Description Use this command to encode the AFI or DSFID byte to a tag. Error handling is
set by the ^RS command.

Format ^WFr,m,w,f,b

Parameters Details
r = number of retries Accepted values: 0 to 10
Default value: 0
m = motion Accepted values:
0 = Feed label after writing.
1 = No Feed after writing. Other ZPL may cause a feed.
Default value: 0
w = write protect Accepted values:
0 = Not write protected
1 = Write protect
Default value: 0
f = data format Accepted values:
0 = ASCII
1 = Hexadecimal
Default value: 0
b = type of byte to read Accepted values:
A = AFI byte
D = DSFID byte
Default value: A

Example 1 • This example encodes data “R” (hex 52) as the AFI byte. The printer will try
the command up to five times, if necessary.
^XA
^WF5^FDR
^XZ

Example 2 • This example encodes data hex 66 as the AFI byte. The printer will try the
command up to three times, if necessary.
^XA
^WF3,,,1^FD66
^XZ

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL RFID Commands 419
^WF

Example 3 • This example encodes data hex 77 as the DSFID byte. The printer will try the
command up to four times, if necessary.
^XA
^WF4,,,1,D^FD77
^XZ

6/8/10 Zebra Programming Guide P1012728-004

420 ZPL RFID Commands
^WT

^WT
Write (Encode) Tag
Note • The ^WT command is provided only for backward-compatibility with label formats
that were developed for older Zebra RFID printers. See Printer and Firmware Compatibility
on page 376 for the list of printers and firmware with which you should not use this
command.

Description Use this command to encode the current RFID tag. Check the amount of data
memory available for the tag that you will be using. If you send more data than the memory
can hold, the printer truncates the data.

Format ^WTb,r,m,w,f,v

Parameters Details
b = block number Specifies the block number to encode. This parameter is tag-dependent.
• For most tags, use block 0.
• For EPC Class 0 Plus, block 0 is EPC data, and block 1 is user data.
• For the R4Mplus, this parameter does not apply to printers with firmware
version SP902X. With other versions of firmware in this printer, you can
encode 12 bytes (96 bits) to block 0, but you can encode only the first byte
of block 1.
Accepted Values: 0 to n, where n is the maximum number of blocks for the tag.
Default Value: 0
r = number of retries Changes the number of times that the printer attempts to encode a particular
block of a single RFID tag. (Same function as the ^RR command.)
Accepted Values: 0 to 10
Default Value: 0
m = motion Enables or disables RFID motion. (Same function as the ^RM command.)
Accepted Values:
0 = Feed label after writing
1 = No feed after writing (other ZPL may cause a feed)
Default Value: 0
w = write protect Accepted Values:
0 = Not write protected
1 = Write protected
Default Value: 0
f = data format Accepted Values:
0 = ASCII
1 = Hexadecimal
Default Value: 0

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL RFID Commands 421
^WT

Parameters Details
This parameter is not used in the R2844-Z.
For the R110Xi HF: For the R110Xi HF:
v = reverse the data order Reverses the data order.
Accepted Values:
N = Do not reverse the data order (Most significant byte first for Tag*It
and PicoTag. Last significant byte first for I*code and ISO 15693)
Y = Reverse the data order
Default Value: N
For other supported For other supported printers:
printers: For reliability, some manufacturers encode tags with known data (such as
v = verify valid data A5A5). This parameter flags whether the preprogrammed data is verified.
(Same function as the ^WV command.)
Accepted Values:
N = Do not verify
Y = Verify valid data before writing
Default Value: N

Example • This sample encodes data “RFIDRFID” and will try writing up to five times, if
necessary.
^XA
^WT,5^FDRFIDRFID^FS
^XZ

6/8/10 Zebra Programming Guide P1012728-004

422 ZPL RFID Commands
^WV

^WV
Verify RFID Encoding Operation
Important • This command is not supported by all printers or firmware. See Printer and
Firmware Compatibility on page 376 for the list of printers and firmware with which you can
use this command.

Description Use this command to enable or disable the write verify function. When write
verify is enabled, this command verifies the RFID encoding operation to ensure that the tag
about to be programmed contains the hex data “A5A5” in the first two bytes. This parameter is
not persistent (carried over from label to label).

Format ^WVe

Parameters Details
e = enable Accepted values: Y or N
Default value: N

P1012728-004 Zebra Programming Guide 6/8/10

 4
ZPL Wireless Commands

This section contains ZPL commands for the Wireless and Wireless Plus print servers.

6/8/10 Zebra Programming Guide P1012728-004

424 ZPL Wireless Commands
^KC

^KC
Set Client Identifier (Option 61)
Description The ^KC command allows the print server to have its own client identifier
(CID).

Format ^KCa,b,c,d

Parameters Details
a = enable or disable Accepted Values:
0 = disable (default)
1 = enabled, use MAC address
2 = enabled, ASCII value
3 = enabled, HEX value
Default Value: 0
b = device Accepted Values:
0 = all devices
1 = wireless
2 = external wired e
3 = internal wired
Default Value: 1
c = prefix (optional) Accepted Values: 11 ASCII characters or 22 hexadecimal values.
The prefix can be cleared by defaulting the network settings on the printer.
d = identifier Accepted Values: 60 ASCII characters or 120 hexadecimal values. Minimum
field length is 2 bytes.
The suffix can be cleared by defaulting the network settings on the printer.
e. This applies only to the Xi4, RXi4, ZM400, ZM600, RZ400, or RZ600 printers when it is used with the external ZebraNet
10/100 print server using firmware v1.1.5 or later.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Wireless Commands 425
^NB

^NB
Search for Wired Print Server during Network Boot
Description Use this command to tell the printer whether to search for a wired print server
at bootup. This command is ignored on the Xi4, RXi4, ZM400, ZM600, RZ400, and RZ600
printers.

Note • Only one print server can be installed in the S4M at one time, so this check does not
occur.

Table 22 identifies which device becomes the active print server under different conditions.

Table 22 • Results of Check for Wired Print Server

If the Check Installed and Connected to

for Wired Print a Live Ethernet Network Then, the Active Print
Server is Server will be:
set to: Wired Wireless f

X X Wireless
Skip X Wired
X Wireless
X X Wired
Check X Wired
X Wireless
f. A wireless option board must have an active radio that can properly associate to an access point.

Format ^NBa

Parameters Details
a = check for wired print Accepted Values: C (CHECK), S (SKIP CHECK)
server at boot time Default Value: S

6/8/10 Zebra Programming Guide P1012728-004

426 ZPL Wireless Commands
^NN

^NN
Set SNMP
Description Use this command to set the Simple Network Management Protocol (SNMP)
parameters.

Format ^NNa,b,c,d,e,f

Parameters Details
a = system name Same as printer name.
Accepted Values: Up to 17 alphanumeric characters
b = system contact Any contact information as desired (such as a name or phrase)
Accepted Values: Up to 50 alphanumeric characters
c = system location The printer’s model information.
Accepted Values: Up to 50 alphanumeric characters
d = get community name Accepted Values: Up to 19 alphanumeric characters
Default Value: public
e = set community name Accepted Values: Up to 19 alphanumeric characters
Default Value: public
f = trap community Accepted Values: Up to 20 alphanumeric characters
name Default Value: public

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Wireless Commands 427
^NP

^NP
Set Primary/Secondary Device
Description Use this command to specify whether to use the printer’s or the print server’s
LAN/WLAN settings at boot time. The default is to use the printer’s settings.

When the printer is set as the primary device, you can set it up using ZPL commands or the
Wireless Setup Wizard utility, and any wired print server inserted into the printer will use those
settings.The drawbacks to using the printer as primary are:

Any wired print server inserted into the printer will lose its original settings if the printer is set
to check for the wired print server and the Primary Device is set to PRINTER (see ^NB
on page 425).

Format ^NPa

Parameters Details
a = device to use as Accepted Values:
primary P = PRINTER
M = MPS/PRINTSERVER
Default Value: P

6/8/10 Zebra Programming Guide P1012728-004

428 ZPL Wireless Commands
^NT

^NT
Set SMTP
Description Use this command to set the Simple Mail Transfer Protocol (SMTP)
parameters. This allows you to set the e-mail settings for alerts.

Format ^NTa,b

Parameters Details
a = SMTP server address Accepted Values: Any properly formatted server address in the
xxx.xxx.xxx.xxx format
b = print server domain Accepted Values: Any properly formatted print server domain name. A domain
name is one or more labels separated by a period (“dot”), and a label consists of
letters, numbers, and hyphens. An example of a domain name is zebra.com

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Wireless Commands 429
^NW

^NW
Set Web Authentication Timeout Value
Description Use this command to set the timeout value for the printer home page. The
printer will prompt for the printer password only the first time that certain screens are accessed
until 1) the web authentication timeout value is reached (default value is 5 minutes) or
2) the printer is reset. At that time, the printer will prompt for the password again.

Format ^NWa

Parameters Details
a = timeout value The timeout value in minutes for an IP address to be authenticated to the printer
web pages.
Accepted Values: 0 (no secure pages can be accessed without entering the
printer password) to 255 minutes
Default Value: 5

6/8/10 Zebra Programming Guide P1012728-004

430 ZPL Wireless Commands
^WA

^WA
Set Antenna Parameters
Description Use this command to set the values for the receive and transmit antenna.

Format ^WAa,b

Parameters Details
a = receive antenna Accepted Values: D (Diversity), L (Left), R (Right)
Default Value: D
b = transmit antenna Accepted Values: D (Diversity), L (Left), R (Right)
Default Value: D

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Wireless Commands 431
^WE

^WE
Set WEP Mode
Note • The ^WE command is provided only for backward-compatibility with printers using
firmware prior to V50.15.x, V53.15.x, or X60.15.x. For these firmware versions and later,
use ^WX on page 442 to set the security type and related parameters.

Description Use this command to command enable Wired Equivalent Privacy (WEP) mode
and set WEP values. WEP is a security protocol for wireless local area networks (WLANs).

Be careful to include the exact number of commas required for this command when setting
encryption keys (parameters e through h). A missing or extra comma will cause the keys to be
stored in the wrong slots and can prevent the printer from joining the wireless network.

Format ^WEa,b,c,d,e,f,g,h

Parameters Details
a = encryption mode Accepted Values: OFF, 40 (40-bit encryption), 128 (128-bit encryption)
Default Value: OFF
b = encryption index Tells the printer which encryption key to use.
Accepted Values: 1 (Key 1), 2 (Key 2), 3 (Key 3), 4 (Key 4)
Default Value: 1
c = authentication type Accepted Values: O (Open System), S (Shared Key)
Default Value: O
Note • If you enable Shared Key authentication with Encryption Mode
set to OFF, this value resets to Open.

d = encryption key Accepted Values: H (Hex key storage), S (string key storage)
storage Default Value: H
e, f, g, h = Accepted Values: The actual value for the encryption key
encryption keys The encryption mode affects what can be entered for the encryption keys:
1 through 4 • For 40-bit, encryption keys can be set to any 5 hex pairs or any 10
alphanumeric characters.
• For 128-bit, encryption keys can be set to any 13 hex pairs or any 26
alphanumeric characters.
Note • When using hex storage, do not add a leading 0x on the
WEP key.

Example 1 • This example sets encryption to 40-bit, activates encryption key 1, and sets
encryption key 1 to the string 12345.
^WE40,,,,12345
In this example, the Encryption Index, Authentication Type, and Encryption Key Storage
parameters are left blank with commas as placeholders for the fields. The printer uses the
default values for these parameters.

6/8/10 Zebra Programming Guide P1012728-004

432 ZPL Wireless Commands
^WE

Example 2 • This example sets encryption to 128-bit, activates encryption key 2, and sets
encryption keys 1 and 2 to hex values.
^WE128,2,,H,12345678901234567890123456,98765432109876543
210987654
The value for encryption key 1 is stored and can be activated in the future by the following
command:
^WE128,1

Example 3 • This example sets encryption to 128-bit, activates encryption key 4, and sets
encryption key 4 to a hex value.
^WE128,4,,H,,,,98765432109876543210987654
Values are not required for encryption keys 1 through 3 when setting encryption key 4. In this
example, commas are used as placeholders for the fields for encryption keys 1 through 3.
Any previously stored values for these encryption keys do not change.
Important • Make sure that you include the exact number of commas required to get
to the slot for encryption key 4 (parameter h).

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Wireless Commands 433
^WI

^WI
Change Wireless Network Settings
Description Use this command to change the wireless network settings.

Zebra recommends using ^ND on page 306 for these settings if you have any of the following
printers:
• Xi4 printers with firmware V53.17.1Z or later
• RXi4 printers with firmware V53.17.7Z or later
• ZM400, ZM600, or S4M printers with firmware V53.15.xZ or later
• RZ400/RZ600 printers with firmware R53.16.x or later

Format ^WIa,b,c,d,e,f,g,h,i

Parameters Details
a = IP resolution Accepted Values:
A = All
B = BOOTP
C = DHCP and BOOTP
D = DHCP
G = Gleaning only (Not recommended when the Wireless Print Server or
Wireless Plus Print Server is installed.)
R = RARP
P = Permanent
Default Value: A
b = IP address Accepted Values: Any properly formatted IP address in the xxx.xxx.xxx.xxx
format.
Default Value: 000.000.000.000
c = subnet mask Accepted Values: Any properly formatted subnet mask in the xxx.xxx.xxx.xxx
format.
Default Value: 000.000.000.000
d = default gateway Accepted Values: Any properly formatted gateway in the xxx.xxx.xxx.xxx
format.
Default Value: 000.000.000.000
e = WINS server address Accepted Values: Any properly formatted WINS server in the xxx.xxx.xxx.xxx
format.
Default Value: 000.000.000.000
f = connection timeout Accepted Values:
checking Y = yes
N = no
Default Value: Y

6/8/10 Zebra Programming Guide P1012728-004

434 ZPL Wireless Commands
^WI

Parameters Details
g = timeout value Time, in seconds, before the connection times out.
Accepted Values: 0 through 9999
Default Value: 300
h = ARP broadcast Time, in minutes, that the broadcast is sent to update the device’s ARP cache.
interval Accepted Values: 0 through 30
Default Value: 0 (no ARP sent)
i = base raw port number The port number that the printer should use for its RAW data.
Accepted Values: 1 through 65535
Default Value: 9100

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Wireless Commands 435
^WL

^WL
Set LEAP Parameters
Note • The ^WL command is provided only for backward-compatibility with printers using
firmware prior to V50.15.x or X60.15.x. For these firmware versions and later, use ^WX
on page 442 to set the security type and related parameters.

Description Use this command to enable Cisco® Lightweight Extensible Authentication

Protocol (LEAP) mode and set parameters. LEAP is user authentication method that is
available with some wireless radio cards.

Format ^WLa,b,c

Parameters Details
a = mode Accepted Values: OFF, ON
Default Value: OFF
b = user name Accepted Values: Any 1 to 32 alphanumeric including special characters
Default Value: user
c = password Accepted Values: Any 1 to 32 alphanumeric including special characters
Default Value: password

6/8/10 Zebra Programming Guide P1012728-004

436 ZPL Wireless Commands
~WL

~WL
Print Network Configuration Label
Description Use this command to generate a network configuration label (Figure 5).

Format ~WL

Figure 5 • Network Configuration Label

Wireless Print Server Wireless Plus Print Server

and Internal Wireless Plus Print Server
Xi4, R110Xi4, ZM400, ZM600, Other Printers/
RZ400, RZ600 Print Engines

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Wireless Commands 437
^WP

^WP
Set Wireless Password

Note • This command does not apply to the S4M.

Description Use this command to set the four-digit wireless password (not the same as the
general printer password). If the wireless password is 0000, the Wireless and Wireless Plus
print servers run in an “unprotected” mode, which means that you do not need to enter the
wireless password through the control panel to view or modify wireless settings.

If a wireless password is set, the values for the following parameters will not appear through
the control panel until the wireless password is entered:
• MAC Address
• ESSID
• WLAN Security
• WEP Type
• WEP Index
• Reset Network

Format ^WPa,b

Parameters Details
a = old wireless Accepted Values: 0000 through 9999
password Default Value: 0000
b = new wireless Accepted Values: 0000 through 9999
password Default Value: 0000

6/8/10 Zebra Programming Guide P1012728-004

438 ZPL Wireless Commands
^WR

^WR
Set Transmit Rate
Description Use this command to change the transmission parameters.

Format ^WRa,b,c,d,e

Parameters Details
a = rate 1 Sets the 1 Mb/s transmit rate.
Accepted Values: Y (On), N (Off)
b = rate 2 Sets the 2 Mb/s transmit rate.
Accepted Values: Y (On), N (Off)
c = rate 5.5 Sets the 5.5 Mb/s transmit rate.
Accepted Values: Y (On), N (Off)
d = rate 11 Sets the 11 Mb/s transmit rate.
Accepted Values: Y (On), N (Off)
e = transmit power Accepted Values: 1, 5, 20, 30, 50, 100

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Wireless Commands 439
~WR

~WR
Reset Wireless Radio Card and Print Server
Description Use this command to reinitialize the wireless radio card and the print server
(wired or wireless) when the Wireless or Wireless Plus print server is running. The command
also causes any wireless radio card in the printer to reassociate to the wireless network.

Format ~WR

6/8/10 Zebra Programming Guide P1012728-004

440 ZPL Wireless Commands
^WS

^WS
Set Wireless Radio Card Values
Description Use this command to set the wireless radio card values for ESSID, Operating
Mode, and Card Preamble.

Format ^WSe,o,p,h,i,j,k

Parameters Details
e = ESSID value Accepted Values: Any value up to 32 characters, including all ASCII and
Extended ASCII characters, including the space character. When this
parameter is left blank, the ESSID is not changed.
Default Value: 125
o = operating mode Accepted Values: I (Infrastructure), A (Adhoc)
Default Value: I
p = wireless radio card Accepted Values:
preamble L = long
S = short
Default Value: L
h = wireless pulse Adds a pulse to the network traffic generated by the printer. This pulse is
necessary with some network configurations to keep the printer online.
Accepted Values:
This parameter is 0 = disabled
supported in firmware 1 = enabled
version V60.15.x, Default Value: 1
V50.15.x, R6x.15.x,
R53.15.x, ZSPx, or later.
i = wireless pulse Sets the interval at which the wireless pulse is sent when the wireless pulse
interval feature is enabled.
Accepted Values: 5 to 300 seconds
Default Value: 15
This parameter is
supported in firmware
version V60.15.x,
V50.15.x, R6x.15.x,
R53.15.x, ZSPx, or later.
j = channel mask For commonly used channel masks, see Table 23.
Accepted Values: 4 Hexadecimal digits preceded by “0x” (0x0000 to 0xFFFF)
Default Value: 0x7FF
This parameter is
supported in firmware
version X60.15.x,
V50.15.x, or later.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Wireless Commands 441
^WS

Parameters Details
k = international mode Accepted Values: 0 (Disabled), 1 (Enabled)
Default Value: 0

This parameter is
supported in firmware
version X60.15.x,
V50.15.x, or later.

Table 23 • Channel Mask Settings

Region Channel Mask

United States, Canada, Latin America 0x7FF
Europe, Middle East, Africa, other 0x1FFF
Japan 0x3FFF

6/8/10 Zebra Programming Guide P1012728-004

442 ZPL Wireless Commands
^WX

^WX
Configure Wireless Securities
Description Use this command to configure the wireless security settings for your printer.
Values entered for this command must match what is configured on your WLAN and must be
supported by the wireless radio card that you are using.

This command applies to printers with firmware version X60.15.x, V53.15.x, V50.15.x, or
later.

Note • When using certificate files, your printer supports:

• Using Privacy Enhanced Mail (PEM) formatted certificate files.
• Using the client certificate and private key as two files, each downloaded separately.
• Using exportable PAC files for EAP-FAST.

The ^WX command replaces individual ZPL commands for different security types.

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Wireless Commands 443
^WX

Format ^WXa,[zero or more supporting parameters]

Note • The supporting parameters that are required vary based on the security type that you
select. See Supporting Parameters for Different Security Types on page 446 for instructions
for each security type.

Parameters Details
a = security type Enter the two-digit code for the security type that your WLAN uses. For which
supporting parameters (b through n) to use with the different security types, see
Supporting Parameters for Different Security Types on page 446.
Note • Configuring the printer for WPA also allows the printer to be
used in WPA2 environments.
Accepted Values: 01 to 15
01 = No wireless security is active
02 = WEP 40-bit
03 = WEP 128-bit
04 = EAP-TLS
05 = EAP-TTLS
06 = EAP-FAST
07 = PEAP
08 = LEAP
09 = WPA PSK (R6x15.x, R53.15.x, ZSPx, and later.)
10 = WPA EAP-TLS
11 = WPA EAP-TTLS
12 = WPA EAP-FAST
13 = WPA PEAP
14 = WPA LEAP
15 = Kerberos
Default Value: 01
b = WEP encryption Specifies which encryption key to use for WEP encryption. A value must be
index* specified if using WEP 40-bit or WEP 128-bit.
Accepted Values: 1, 2, 3, 4
Default Value: 1
c = WEP authentication Enables the WEP key authentication type. A value must be specified if using
type* WEP 40-bit or WEP 128-bit.
Accepted Values: O or S
O = open system
S = shared key
Default Value: O
* Not used for all security types

6/8/10 Zebra Programming Guide P1012728-004

444 ZPL Wireless Commands
^WX

Parameters Details
d = WEP key type* Specifies the format of the WEP key. A value must be specified if using
WEP 40-bit or WEP 128-bit.
Accepted Values: H or S
H = hex key storage
S = string key storage
Default Value: S
e,f,g,h = Specifies the actual values of any WEP encryption keys to be used. A value
WEP encryption keys must be specified for at least one WEP encryption key if you specify 40-bit or
1 through 4* 128-bit WEP encryption for the security type.
Important • Be careful to include the exact number of commas
required for this command when setting encryption keys (parameters e
through h). A missing or extra comma will cause the keys to be stored
in the wrong slots and can prevent the printer from joining the wireless
network.
The encryption mode affects what can be entered for the
encryption keys:
• For 40-bit, encryption keys can be set to any 5 hex pairs or any 10
alphanumeric characters.
• For 128-bit, encryption keys can be set to any 13 hex pairs or any 26
alphanumeric characters.
Note • When using hex storage, do not add a leading 0x on the
WEP key.

Accepted Values: The actual value for the encryption key

Default Value: None
i = user ID* Specifies a user ID for security types that require one. A value must be
specified if using the following security types:
• EAP-TTLS
• LEAP
• WPA LEAP
• PEAP
• WPA PEAP
• WPA EAP-TTLS
• Kerberos
Accepted Values: The actual value for the user ID.
Default Value: user
* Not used for all security types

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Wireless Commands 445
^WX

Parameters Details
j = password* Specifies a password for security types that require one. A value must be
specified if using the following security types:
• EAP-TTLS
• LEAP
• WPA LEAP
• PEAP
• WPA PEAP
• WPA EAP-TTLS
• Kerberos
Accepted Values: The actual value for the password.
Default Value: password
k = optional private key Specifies an optional private key password for security types that require one.
password* A value must be specified if using the following security types:
• EAP-TLS
• EAP-FAST
• WPA EAP-TLS
• WPA EAP-FAST
Accepted Values: The actual value for the optional private key.
Default Value: None
l = realm* Specifies the realm for security types that require it. A value must be
specified if using Kerberos.
Accepted Values: The actual value for the realm.
Default Value: kerberos
m = Key Distribution Specifies the KDC for security types that require it. A value must be specified
Center (KDC)* if using Kerberos.
Accepted Values: The actual value for the KDC.
Default Value: krbtgt"
n = Pre-Shared Key Enter the PSK value. This value is calculated and must be the same for each
(PSK) value* device on the WLAN. Use ZebraNet Bridge to generate the PSK value. A value
must be specified if using WPA PSK.
Important • Do not enter a pass phrase for this field in this command.
To use a pass phrase, use the ZebraNet Bridge Enterprise Wireless
Setup Wizard.
Accepted Values: a minimum of 64 hexadecimal digits
Default Value: None
* Not used for all security types

6/8/10 Zebra Programming Guide P1012728-004

446 ZPL Wireless Commands
^WX

Supporting Parameters for Different Security Types

The supporting parameters required for this command vary based on the security type that you
select. You should not use all of the supporting parameters each time that you use this
command, nor will you use extra commas to separate unused fields. Follow the example and
format for your specific security type in this section, substituting your own wireless network
data.

Security Type 01: No Wireless Security Active

Format ^WX01

Example • This example turns off all wireless securities controlled under this command, but
it does not reset the printer’s wireless settings to their defaults.
^XA
^WX01
^JUS^XZ

Security Type 02: WEP 40-Bit

Format ^WX02,b,c,d,e,f,g,h

Example • This example configures the printer for WEP 40-bit encryption using index
key 1, open authentication, and a hexadecimal WEP key with a value of “A1B2C3D4F5.”
^XA
^WX02,1,O,H,A1B2C3D4F5,,,
^JUS
^XZ

Security Type 03: WEP 128-Bit

Format ^WX03,b,c,d,e,f,g,h

Example • This example configures the printer for WEP 128-bit encryption using index
key 2, open authentication, and four hexadecimal WEP keys.
^XA
^WX03,2,O,H,001122334455667788,112233445566778899,223344
556677889900,334455667788990011
^JUS
^XZ

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Wireless Commands 447
^WX

Security Type 04: EAP-TLS

Format ^WX04,k

Example • This example configures the printer for EAP-TLS authentication with an optional
private key password with a value of “private.”
^XA
^WX04,private
^JUS
^XZ

Security Type 05: EAP-TTLS

Format ^WX05,i,j

Example • This example configures the printer for EAP-TTLS authentication, including a
user ID of “user” and a password of “password.”
^XA
^WX05,user,password
^JUS
^XZ

Security Type 06: EAP-FAST

Format ^WX06,i,j,k

Example • This example configures the printer for EAP-FAST authentication, including a
user ID of “user,” a password of “password,” and an optional private key of
“private.”
^XA
^WX06,user,password,private
^JUS
^XZ

6/8/10 Zebra Programming Guide P1012728-004

448 ZPL Wireless Commands
^WX

Security Type 07: PEAP

Format ^WX07,i,j

Example • This example configures the printer for PEAP authentication, including a user ID
with a value of “user” and a password with a value of “password.”
^XA
^WX07,user,password
^JUS
^XZ

Security Type 08: LEAP

Format ^WX08,i,j

Example • This example configures the printer for LEAP authentication, including a user ID
with a value of “user” and a password with a value of “password.”
^XA
^WX08,user,password
^JUS
^XZ

Security Type 09: WPA PSK

Note • Configuring the printer for WPA also allows the printer to be used in WPA2
environments (R6x15.x, R53.15.x, ZSPx, and later.)

Format ^WX09,n

Example • This example configures the printer for WPA PSK authentication with a PSK
value of all zeroes (64 hexadecimal digits).
^XA
^WX09,00000000...
^JUS
^XZ

P1012728-004 Zebra Programming Guide 6/8/10

 ZPL Wireless Commands 449
^WX

Security Type 10: WPA EAP-TLS

Note • Configuring the printer for WPA also allows the printer to be used in WPA2
environments.

Format ^WX10,k

Example • This example configures the printer for WPA EAP-TLS authentication with an
optional private key password with a value of “private.”
^XA
^WX10,private
^JUS
^XZ

Security Type 11: WPA EAP-TTLS

Note • Configuring the printer for WPA also allows the printer to be used in WPA2
environments.

Format ^WX11,i,j

Example • This example configures the printer for WPA EAP-TTLS authentication,
including a user ID with a value of “user” and a password with a value of “password.”
^XA
^WX11,user,password
^JUS
^XZ

Security Type 12: WPA EAP-FAST

Note • Configuring the printer for WPA also allows the printer to be used in WPA2
environments.

Format ^WX12,i,j,k

Example • This example configures the printer for WPA EAP-FAST authentication,
including a user ID of “user,” a password of “password,” and an optional private key of
“private.”
^XA
^WX12,user,password,private
^JUS
^XZ

6/8/10 Zebra Programming Guide P1012728-004

450 ZPL Wireless Commands
^WX

Security Type 13: WPA PEAP

Note • Configuring the printer for WPA also allows the printer to be used in WPA2
environments.

Format ^WX13,i,j

Example • This example configures the printer for WPA PEAP authentication, including a
user ID with a value of “user” and a password with a value of “password.”
^XA
^WX13,user,password
^JUS
^XZ

Security Type 14: WPA LEAP

Note • Configuring the printer for WPA also allows the printer to be used in WPA2
environments.

Format ^WX14,i,j

Example • This example configures the printer for WPA LEAP authentication, including a
user ID with a value of “user” and a password with a value of “password.”
^XA
^WX14,user,password
^JUS
^XZ

Security Type 15: Kerberos

Format ^WX15,i,j,l,m

Example • This example configures the printer for Kerberos encryption, including a
Kerberos user ID with a value of “user,” a Kerberos password with a value of
“password,” a realm of “zebra,” and a KDC of “krbtgt.”
^XA
^WX15,user,password,zebra,krbtgt
^JUS
^XZ

P1012728-004 Zebra Programming Guide 6/8/10

 5
ZBI Commands

This section explains the Zebra Basic Interpreter, its commands, descriptions, formats, and
parameters.

6/8/10 Zebra Programming Guide P1012728-004

452 ZBI Commands
Command and Function Reference Format

Command and Function Reference Format

This section describes how commands and functions are presented in this document.

Command/Function NAME
Description This heading has a description of how the command is used, its capabilities,
and its characteristics.

Format The Format section explains how the command is arranged and its parameters. For
example, the AUTONUM command starts the auto-numbering option. The format for the
command is AUTONUM <A>,<B>. The <A> and <B> are parameters of this command and
are replaced with values determined by the user.

For functions, parameters are enclosed within parentheses and separated by commas, such as
EXTRACT$(A$,START$,STOP$).

Numeric parameters are written as a name, while string parameters are written as a name
followed by a dollar sign.

Parameters If a command has parameters that make a command or function more specific,
they are listed under this heading. Still using the AUTONUM example, the <A> parameter is
defined as:
<A> = number used to start the auto-numbering sequence

Return Value (functions only)

The return value is the result of evaluating the function or expression.

Example When a command is best clarified in a programming context, an example of the

ZBI code is provided. Text indicating parameters, exact code to be entered, or data returned
from the host is printed in the Courier font to be easily recognizable.

Example • An example of PRINT code is:

10 PRINT "HELLO WORLD"
RUN
HELLO WORLD

Comments This section is reserved for notes that are of value to a programmer, warnings of
potential command interactions, or command-specific information that should be taken into
consideration. An example comment could be: This is a program command and must be
preceded by a line number.

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 453
Introduction to Zebra Basic Interpreter (ZBI)

Function Rules
Functions built into this interpreter can be used in expressions only. The function names are
not case sensitive.

If input parameters exist, they are enclosed in parentheses. If no parameters exist, no

parentheses are used.

Variables referenced in the functions could be substituted by functions or expressions of the

same type. If the function name ends with a $, it returns a string value. Otherwise, it returns a
numeric value.

Introduction to Zebra Basic Interpreter (ZBI)

What is ZBI and why is it for me?

ZBI is an "on-the-printer" programing language that offers many of the functions found in
ANSI BASIC. The ZBI language allows the user to create applications that are run on the
printer to manipulate data streams. By using ZBI, it is possible to have the printer perform the
same functions that a computer or programmable terminal might otherwise be used for.

With the connectivity options available on Zebra printers, you may not need a separate
computer. Simply load a ZBI program on your printers, add them to your network, and let the
printers serve as the gateway for moving data.

Here are some of the applications that can be written using ZBI:
• Connect a barcode scanner to the printer. Based on scanned data, reprint tags, verify
printed output, and manage a list of items.
• Connect a scale to the printer and print labels, tags, or receipts based on the weight of an
item.
• Connect the printer to a PC-based database and send queries from the printer to retrieve or
upload data.
• Convert incoming data into the commands that can be used to print a label. This is useful
for replacing other brands of printers with new Zebra units.
• Provide fail-over to another printer when the target printer is in an error state.

6/8/10 Zebra Programming Guide P1012728-004

454 ZBI Commands
Introduction to Zebra Basic Interpreter (ZBI)

Printers, ZBI Keys, & ZBI Versions

Information about ZBI 1.x and ZBI 2.x:

ZBI versions 1.0 through 1.5: ZBI 1.x was available on printers with X.10 or higher
firmware (such as V48.10.x). To determine if the printer supports ZBI version 1, check the
firmware version loaded on the printer. This can be determined by the absence of a “Z” in the
firmware version number (for example, firmware V60.13.0.12 supports ZBI version 1, while
V60.13.0.12Z does not). The following printers support the ZBI 1.x firmware:
• LP/TLP 284x-Z and 384x-Z
• S300/S400/S500/S600
• Z4000/Z6000
• Z4M/Z6M
• Z4Mplus/Z6Mplus
• 105SL
• PAX3
• XiII
• XiIII

ZBI-Developer can be used to create programs for use on printers that support ZBI version
1.x., however, the features that are only available in ZBI v2.x cannot be used with printers
running ZBI v1.x. For example, “on-printer” debugging advanced file encryption and
commands added in ZBI 2 are not supported in printers running ZBI 1.x. If you do not have a
printer that meets this requirement, contact your reseller.

Note • Support for ZBI versions 1.0 through 1.5 is limited to syntax checking only.
On-printer debugging is not supported for ZBI versions 1.0 through 1.5.

ZBI versions 2.0 and higher: Printers with firmware versions X.16 or later (for
example, V60.16.x and V53.16.x) can support ZBI version 2.0 and later. The following
printers support the ZBI 2.x firmware:
• XiIII Plus
• Z4Mplus/Z6Mplus
• 105SL
• S4M
• PAX4
• ZM400/ZM600, RZ400/RZ600
• G-Series
• HC100
• Xi4, RXi4
• LP/TLP2824+
• KR403

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 455
Introduction to Zebra Basic Interpreter (ZBI)

These printers can be either ZBI-Ready or ZBI-Enabled, depending on whether or not a ZBI
Key file has been loaded on the printer. ZBI Keys can be loaded onto printers during
manufacturing or later purchased at www.zebrasoftware.com. A Downloader Utility/ZBI Key
Manager software utility is available to assist in the task of sending ZBI Keys to printers.

The ZBI.nrd file is required to be present on the printer for ZBI 2.0 to be enabled. The ZBI
Key is stored on the printer’s E: memory location with the name ZBI.nrd. The file is persistent.
It cannot be deleted even if the printer’s memory is initialized. For example, if the ^JB
command is used to initialize the location, the ZBI Key file will not be deleted.

When a printer is ZBI-Ready but not ZBI-Enabled, the firmware version will display a "Z" at
the end of the version string (for example, V60.16.0Z). Additionally, the printer’s
configuration label will show that the printer is not ZBI-Enabled.

When a printer is ZBI-Enabled, the firmware version will not display a "Z" at the end of the
version string (for example, V60.16.0Z). Additionally, the printer’s configuration label will
show that the printer is ZBI-Enabled.

Note • Each single ZBI Key can only be used once. When multiple printers are to be ZBI-
Enabled multiple Keys will be needed. The ZBI Key cannot retrieved from printer to a host
system.

6/8/10 Zebra Programming Guide P1012728-004

456 ZBI Commands
Section Organization

Section Organization
The sections in this guide are arranged based on programming topics. A brief description of
the sections is listed below.

Editing Commands This section describes the commands which are used to manipulate
the interpreter and enter programs.

Running and Debugging Outlines the control commands used to run and debug
programs.

Base Types and Expressions Fundamental structure for manipulating strings and
computing numeric and boolean values.

Control and Flow Commands to conditionally execute code and control the flow of the
program

Input and Output Outlines how to communicate with the physical ports, internal ports, and
network.

File System Shows how programs and formats can be saved and recalled

Comma Separated Values Identifies how to load and store comma separated data

Events Explains how to capture and trigger internal events in the printer

Systems Contains miscellaneous systems interface functions

String Functions Handles string manipulation

Math Functions Handles mathematical calculations

Array Functions Describes how to search, resize, and query arrays

Time and Date Functions Functions to access the real time clock option

Set/Get/Do Interface Functions to directly interface with the Set/Get/Do system

Example Programs More examples to give a head start in creating your applications

Writing ZBI Programs

There are two main ways to develop ZBI programs. The preferred method is to use the
ZBI-Developer application. ZBI-Developer allows you to create and test programs before a
printer is even turned on. In addition, many features of this program allow for quicker program
creation and more meaningful debugging. ZBI-Developer can be downloaded from the Zebra
web site.

An alternate method for developing a program is through a direct connection to the printer
using a terminal emulation program.

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 457
Editing Commands

Editing Commands
This section details the Editing Commands. This section describes the commands which are
used to manipulate the interpreter and enter programs. These commands are used while
controlling the ZBI environment from a console connection. Here is a quick list of these
commands:

NEW – Clears out the program and variables currently in memory

REM and ! – Comment commands

LIST – Lists the program currently in memory

AUTONUM – Automatically generates the next line number

RENUM – Renumbers the program currently in memory

ECHO – Controls whether characters received on the console are echoed back

If you are using ZBI-Developer, the commands that will be most useful are AUTONUM and
REM/!.

The following example shows the use of Editing commands from within a console connection.

Preview:
NEW
AUTONUM 10,5
Entered
automatically 10 REM "Hello World" Application
when 15 PRINT "Hello World" ! comment...
AUTONUM is
used 20 A blank line
stops
LIST AUTONUM

10 REM "Hello World" Application

15 PRINT "Hello World"

NEW
LIST

Preview when viewed in ZBI-Developer

AUTONUM 10,5
REM "Hello World" Application
PRINT "Hello World" ! comment...

6/8/10 Zebra Programming Guide P1012728-004

458 ZBI Commands
Editing Commands

NEW
Description This command clears the interpreter’s memory, including the line buffer and
variables, but not any open ports. Use this command when creating code to restart the coding
process or before resending a program from a file to the interpreter.

Format NEW

Parameters N/A

Example • This is an example of how to use the NEW command:

10 PRINT "Hello World"
RUN
Hello World

LIST
10 PRINT "Hello World"

NEW
LIST

Comments This is an interactive command that takes effect as soon as it is received by the
printer.

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 459
Editing Commands

REM
Description A numbered remark line starts with REM and includes text in any form after it.
This line is ignored by the interpreter.

Format REM <comment>

Parameters The comment string can contain any character and is terminated by a carriage
return.

Example • This is an example of how to use the REM command:

10 REM COMMAND LINES 20-100 PRINT A LABEL

Comments Remarks are used for program description and are included as a separate
program line. To append a comment to the end of a program line, use the exclamation mark
(!).

A useful method to keep comments in a stored file (but not in the printer) is to always start the
REM line with the number 1. When all of the lines are sent to the printer, only the last REM
line will stay resident in the printer. This will require less RAM for large programs.

Example • This is an example of how to re-use the REM command:

1 REM MYPROGRAM COPYRIGHT ME Inc. 2008
1 REM While debugging a port may be left open
5 CLOSE ALL
1 REM Open the ports this program will use
10 OPEN #0: NAME: "SER" ! Restart the console

6/8/10 Zebra Programming Guide P1012728-004

460 ZBI Commands
Editing Commands

! (EXCLAMATION MARK)
Description The exclamation mark is the marker for adding comments to the end of
numbered programming lines. Any text following the ! is ignored when the line or command is
processed.

Format !<comment>

Parameters The comment string can contain any character and is terminated by the carriage
return.

Example • This is an example of how to use the ! (comments) command:

10 LET A=10 ! Indicates number of labels to print

Comments None

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 461
Editing Commands

LIST
Description This command lists the program lines currently in memory.

Format
LIST
LIST <A>
LIST <A>-<B>

Parameters
default = lists all lines in memory
<A> = line to start listing the program
<B> = line to stop listing the program. If not specified, only the line at <A> will print.

Example • This is an example of how to use the LIST command:

1 REM MYPROGRAM COPYRIGHT ME Inc. 2008
1 REM While debugging a port may be left open
5 CLOSE ALL
1 rem Open the ports this program will use
10 OPEN #0: NAME: "SER" ! Restart the console
20 PRINT #0: "Hello World"
LIST
1 REM Open the ports this program will use
5 CLOSE ALL
10 OPEN #0: NAME: "SER" ! Restart the console
20 PRINT #0: "Hello World"

LIST 1
1 REM Open the ports this program will use

LIST 5-10
5 CLOSE ALL
10 OPEN #0: NAME: "SER" ! Restart the console

Comments The output of the LIST command may not match exactly what was entered. It is
based on how the program lines are stored in memory. Notice that the last comment line the
REM is entered in lower case characters. When it is listed, the REM is displayed in uppercase.

This is an interactive command that takes effect as soon as it is received by the printer.

6/8/10 Zebra Programming Guide P1012728-004

462 ZBI Commands
Editing Commands

AUTONUM
Description This command automatically generates sequential program line numbers.

Format AUTONUM <A>,<B>

Parameters
A = the number used to start the auto-numbering sequence
B = the automatic increment between the new line numbers

Example • This example shows specifying the starting line number in the increment between
new line number. Type the following at the prompt:
AUTONUM 10,5
SUB START
PRINT "HELLO WORLD"
GOTO START

LIST
Will produce:
AUTONUM 10,5
10 SUB START
15 PRINT "HELLO WORLD"
20 GOTO START

The three lines are automatically started with the AUTONUM parameters; in this case, the first
line starts with 10 and each subsequent line increments by 5.

Comments This feature is disabled by overwriting the current line number and entering the
desired interactive mode commands, or leaving the line blank.

Use of the SUB command allows for GOTO and GOSUB statements that do not require line
numbers in your program.

This is an interactive command that takes effect as soon as it is received by the printer.

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 463
Editing Commands

RENUM
Description This command renumbers the lines of the program being edited. RENUM can
reorganize code when line numbers become over- or under-spaced. The line references
following GOTO and GOSUB statements are renumbered if they are constant numeric values.
Renumbering does not occur if the line numbers are outside of the range limits of 1 to 10000.

Format RENUM <A>,<B>

Parameters
<A> = the number to start the renumbering sequence
<B> = the automatic increment between the new line numbers

Example • This is an example of how to use the RENUM command:

LIST
13 LET A=6
15 LET B=10
17 GOTO 13
RENUM 10,5
LIST
10 LET A=6
15 LET B=10
20 GOTO 10

Note • The target of the GOTO command changes from 13 to 10 to reflect the renumbering.

Comments This is an interactive command that takes effect as soon as it is received by the
printer.

6/8/10 Zebra Programming Guide P1012728-004

464 ZBI Commands
Editing Commands

ECHO
Description When Console Mode is enabled, this command controls whether the printer
echoes the characters back to the communications port. If ECHO ON is entered, keystroke
results return to the screen. If ECHO OFF is entered, keystroke results do not return to the
screen.

Format
ECHO ON
ECHO OFF

Parameters
<ON/OFF> = toggles the ECHO command on or off

Example N/A

Comments This can be an interactive command that takes effect as soon as it is received by
the printer, or a program command that is preceded by a line number.

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 465
Running and Debugging Commands

Running and Debugging Commands

The following commands were written before the development of the ZBI-Developer
application. With that application, and when using ZBI version 1, the following commands are
essentially obsolete. However, for those who started developing ZBI applications before
ZBI-Developer, the following reference will be helpful.

RUN – Starts executing the program currently in memory at the first line of the program

CTRL-C Sends an end-of-transmission character, ETX , to the console to terminate the ZBI
program currently running.

RESTART – Starts executing the program currently in memory where it was last stopped

STEP – Executes one line of the program in memory where it was last stopped

DEBUG – This mode controls whether or not the TRACE and BREAK commands are
processed

TRACE – Shows which lines have been executed and which variables have been changed

BREAK – Stops the currently running program

ADDBREAK – Adds a break to an existing line

DELBREAK – Deletes an existing break

ZPL Terminates and exits the ZBI environment.

6/8/10 Zebra Programming Guide P1012728-004

466 ZBI Commands
Running and Debugging Commands

This example shows many of the Running and Debug Commands in practice.

Example • Preview:
10 PRINT "TEN"
ZBI Program 20 PRINT "TWENTY"
30 PRINT "THIRTY"
RUN Runs the whole program
TEN
TWENTY
THIRTY

STEP Runs one line

TEN

Completes running the

RESTART program where STEP left
TWENTY off

THIRTY

Adds a
ADDBREAK 20 breakpoint on line
RUN 20

TEN
<Program Break> on line: 20

Turn Trace DEBUG ON

On TRACE ON
RESTART
<TRACE> 20
TWENTY
<TRACE> 30
THIRTY

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 467
Running and Debugging Commands

RUN
Description This command executes the current program, starting with the lowest line
number. The interpreter will continue to execute the program lines in order unless a control
statement directs the flow to a different point. When a higher line number does not exist or the
END command is processed, the RUN command will stop.

Format RUN

Parameters N/A

Example • This is an example of how to use the RUN command:

10 PRINT "ZBI"
20 PRINT "Programming"
RUN
ZBI
Programming

15 END
RUN
ZBI

Comments Ports that are open when the application is activated will remain open after the
application has terminated. Variables also remain after the application has terminated.

To execute programs when the printer is powered on, use the ^JI command in the
Autoexec.zpl file.

This is an interactive command that takes effect as soon as it is received by the printer.

6/8/10 Zebra Programming Guide P1012728-004

468 ZBI Commands
Running and Debugging Commands

CTRL-C
Description Sending an end-of-transmission character, ETX (3 in hex), to the console (port
0) terminates the ZBI program currently running.

Format N/A

Parameters N/A

Example N/A

Comments In most terminal programs, you terminate the program using the Ctrl-C key
sequence. Another method is to store an ETX character in a file and have the terminal program
send the file to the console port.

Note • It is not recommended to use RESTART after using a CTRL-C because a command
may have been prematurely interrupted. Restarting will have an undefined result.

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 469
Running and Debugging Commands

RESTART
Description If a program was halted by a break point or the BREAK command, the
RESTART command can be used to reactivate the program at the point it stopped. RESTART
functions similar to RUN, except the program attempts to restart from the point where it was
last terminated. It also works in conjunction with the STEP command, picking up where the
STEP command ended.

Format RESTART

Parameters N/A

Example • An example of the RESTART command:

10 PRINT "TEN"
20 PRINT "TWENTY"
30 PRINT "THIRTY"
RUN
TEN
TWENTY
THIRTY

STEP
TEN

RESTART
TWENTY
THIRTY

ADDBREAK 20
RUN
TEN
<Program Break> on line: 20

DEBUG ON
TRACE ON
RESTART
<TRACE> 20
TWENTY
<TRACE> 30
THIRTY

6/8/10 Zebra Programming Guide P1012728-004

470 ZBI Commands
Running and Debugging Commands

Comments If the program has not been run or has finished, RESTART runs the program
from the beginning.

This is an interactive command that takes effect as soon as it is received by the printer.

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 471
Running and Debugging Commands

STEP
Description If a program was stopped by a BREAK command, STEP attempts to execute
the program one line from where it last ended. If the program has not been run or has been
completed, this executes the lowest numbered line.

Format STEP

Parameters N/A

Example • This is an example of how to use the STEP command:

10 PRINT "Hello World"
20 Print "TWENTY"
STEP
Hello World

STEP
TWENTY

Comments This is an interactive command that takes effect as soon as it is received by the
printer.

6/8/10 Zebra Programming Guide P1012728-004

472 ZBI Commands
Running and Debugging Commands

DEBUG
Description DEBUG enables and disables the TRACE and BREAK commands.

Format
DEBUG ON
DEBUG OFF

Parameters
ON = turns the debug mode on enabling the TRACE and BREAK commands to be
processed.
OFF = turns the debug mode off. This disables the TRACE mode and causes BREAK
commands to be ignored.

Example • See TRACE on page 473 and BREAK on page 474.

Comments This command has no effect on the processing of break points in ZBI-
Developer. It is recommended that you avoid using the DEBUG command when writing
programs in the ZBI-Developer environment, instead use the Debug capabilities of ZBI-
Developer.

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 473
Running and Debugging Commands

TRACE
Description This command enables you to debug an application by outputting the executed
line numbers and changed variables to the console.

Format
TRACE ON
TRACE OFF

Parameters
<ON/OFF> = controls whether TRACE is active (ON) or disabled (OFF).
If DEBUG is activated and the TRACE command is on, trace details are displayed. When
any variables are changed, the new value displays as follows:
<TRACE> Variable = New Value
Every line processed has its line number printed as follows:
<TRACE> Line Number
Example • An example of TRACE command in use:
10 LET A=5
20 GOTO 40
30 PRINT "Error"
40 PRINT A
DEBUG ON
TRACE ON
RUN
<TRACE> 10
<TRACE> A=5
<TRACE> 20
<TRACE> 40
5

Comments This can be an interactive command that takes effect as soon as it is received by
the printer, or a program command that is preceded by a line number.

It is recommended that you avoid using the TRACE command when writing programs in the
ZBI-Developer environment, instead use the Debug capabilities of ZBI-Developer.

6/8/10 Zebra Programming Guide P1012728-004

474 ZBI Commands
Running and Debugging Commands

BREAK
Description This command allows you to stop the program when the program reaches this
line.

Format BREAK

Parameters N/A

Example • An example of BREAK command in use:

10 LET A=5
20 BREAK
30 PRINT A
DEBUG ON
TRACE ON
RUN
<TRACE> 10
<TRACE> A=5
<TRACE> 20
<USER BREAK>

Comments This command is available only when the DEBUG function has been activated.
When DEBUG is on, BREAK halts processing. RUN starts the program from the beginning.
RESTART allows the program to continue from where it left off.

When using ZBI-Developer, this command will interfere with the debugging operations built
into the application.

This is a program command that must be preceded by a line number.

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 475
Running and Debugging Commands

ADDBREAK
Description This command allows you to stop the program when the program reaches a
specified line.

Format ADDBREAK <A>

Parameters
A = the line number to break on. If the number specified is not in the program, the program
will not break.

Example • An example of the ADDBREAK command.

10 LET A=5
20 PRINT A
ADDBREAK 20
RUN
<PROGRAM BREAK> ON LINE:20

RESTART
5

Comments This command is available only when the DEBUG function has been activated.
When DEBUG is on, BREAK halts processing. RUN starts the program from the beginning.
RESTART allows the program to continue from where it left off.

This is the command used internally by ZBI-Developer when the user right-clicks over a
program line and adds a Breakpoint via the "Toggle Breakpoint" selection.

It is the recommended method for setting breakpoints in ZBI.

A maximum of 16 breakpoints can be set in an application.

This is an interactive command that takes effect as soon as it is received by the printer.

6/8/10 Zebra Programming Guide P1012728-004

476 ZBI Commands
Running and Debugging Commands

DELBREAK
Description This command allows you to remove existing breakpoints.

Format DELBREAK <A>

Parameters A = the line number from which to remove the break. If 0 is specified, all break
points will be removed. If the number specified is not a breakpoint, the command will have no
effect.

Example • An example of the DELBREAK command:

10 LET A=5
20 PRINT A
ADDBREAK 20
DEBUG ON
TRACE ON
RUN
<TRACE> 10
<TRACE> A=5
<PROGRAM BREAK> ON LINE:20

RESTART
<TRACE> 20
5

DELBREAK 20
RUN
<TRACE> 10
<TRACE> A=5
<TRACE> 20
5

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 477
Running and Debugging Commands

Comments This command is available only when the DEBUG function has been activated.
When DEBUG is on, BREAK halts processing, RUN starts the program from the beginning, and
RESTART allows the program to continue where it left off.

This is the command used internally by ZBI-Developer when the user right-clicks over a
program line and removes a Breakpoint via the "Toggle Breakpoint" selection.

A maximum of 16 breakpoints can be set in an application.

This is an interactive command that takes effect as soon as it is received by the printer.

6/8/10 Zebra Programming Guide P1012728-004

478 ZBI Commands
Running and Debugging Commands

ZPL
Description This command terminates and exits the ZBI environment.

Format ZPL

Parameters N/A

Example • An example of the ZPL command.

ZPL
ZBI TERMINATED

Comments This is an interactive command that takes effect as soon as it is received by the
printer.

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 479
Base Types and Expressions

Base Types and Expressions

There are two base types in the ZBI language. These types are Integers and Strings. Integers
are whole numbers that contain no fractional part. The range of values for integers is:
-2,147,483,648 to +2,147,483,647

Strings are character arrays. The string length is only limited by the amount of memory in the
system (version 2.0 and higher). Each character can have a value between 0 and 255 (version
2.0 and higher).

The use of control characters (0-31) may be difficult to debug based on the handling of control
characters in different communications programs. In addition the ETX (3) will terminate a ZBI
application when it is received on the console port. Use the CHR$ function when control
characters must be placed into strings.

Note • In ZBI version 1.4 and lower, there was a string length limit of 255 characters.

This section is organized as follows:

• Variable Names
• Variable Declarations
• Constants
• Arrays
• Assignment
• Numeric Expressions
• String Concatenation (&)
• Sub-strings
• Boolean Expressions
• Combined Boolean Expressions

6/8/10 Zebra Programming Guide P1012728-004

480 ZBI Commands
Base Types and Expressions

Variable Names
To distinguish strings from integers, string variable names must end in a $. Variable names
must start with a letter and can include any sequence of letters, digits, and underscores.
Function and command names must not be used as a variable name. Variable names are not
case sensitive and are converted to uppercase by the interpreter.

A common mistake is to use a command or function name as a variable. To avoid using these
reserved words, ZBI-Developer can be a useful resource. Reserved words are highlighted
making it easier to spot this occurrence and thus, saving debugging time.

Valid variable names:

I, J, K, VARNAME, VARSTR$, MYSTR$,MY_STR9$

Invalid Names:

STR$ = Reserved word

ORD = Reserved word

VAL = Reserved word

W# = Invalid character (# )

9THSTR = Variable can not start with a number

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 481
Base Types and Expressions

Variable Declarations
ZBI will allow storage of up to 255 variables. If more variables are needed, consider using
arrays to store data. The base array will take up one of the 255 variable slots, but it can be
declared to allow for many indices.

Variables can be declared explicitly or implicitly. If a variable has not been used before, it will
be declared when used. The default value for an integer will be zero and the default value of a
string will be an empty string.

Explicit:
DECLARE NUMERIC <variable_name>
DECLARE STRING <variable_name$>
If the variable existed before the DECLARE statement, it will be defaulted.

Implicit:
LET <variable_name> = NUMERIC EXPRESSION
LET <variable_name$> = STRING EXPRESSION

The Interpreter is limited to 255 variables. If more variables are required, consider using
arrays.

Constants
Integers are represented simply by numbers, such as 5, -10, 10000. Do not use commas in
integer constants. Strings are enclosed by quotes. If a quote is required in the string, use double
quotes, such as “Look here->””<-“ would result in the string – Look here->”<-.

Arrays
An array is a collection of string or integer values used by a program. Array indices are
accessed through parentheses. Array indices start at 1 and end at the length of an array (for
example, MyArray(3) returns the value in the third location of the variable array). One- and
two-dimensional arrays are allowed. Two-dimensional arrays are referenced with two indices
in parentheses, separated by a comma.

Arrays must be allocated through the use of the DECLARE command. Arrays can be re-
dimensioned by using DECLARE, however, this will replace the original array.

Array size is limited only by the size of the memory available.

Format

DECLARE STRING <ARRAYNAME$>(<SIZE>)

DECLARE STRING <ARRAYNAME$>(<ROWS>,<COLUMNS>)

DECLARE NUMERIC <ARRAYNAME>(<SIZE>)

DECLARE NUMERIC <ARRAYNAME>(<ROWS>,<COLUMNS>)

6/8/10 Zebra Programming Guide P1012728-004

482 ZBI Commands
Base Types and Expressions

Parameters
<SIZE> = number of entries in a single dimension array
<ROWS> = number of rows in a two dimensional array
<COLUMNS> = number of columns in a two dimensional array

Example • An example of ARRAY code is:

10 DECLARE STRING INARRAY$(3)
20 FOR I = 1 TO 3
30 PRINT "Name "; I; ": ";
40 INPUT INARRAY$(I)
50 NEXT I
60 PRINT INARRAY$(1); ", "; INARRAY$(2); ", and ";
INARRAY$(3);
70 PRINT " went to the park"
RUN
Name 1: Jim
Name 2: Jose
Name 3: Jack
Jim, Jose, and Jack went to the park

Comments If you attempt to access an array outside of its allocated bounds, an error will
occur.

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 483
Base Types and Expressions

Assignment
All lines must start with a command. In order to assign a value to a variable, use the LET
command. Multiple variables can be placed before the =. The variable types must match the
expression type.

The right side of the assignment is always calculated completely before the assignment is
made. This allows a variable to be the target and source of the assignment.

When a value is assigned to a string variable with a sub-string qualifier, it replaces the value of
the sub-string qualifier. The length of the value of the string variable may change as a result of
this replacement.

Example • An ASSIGNMENT example:

10 LET A=5
20 LET B$="HELLO"
30 LET B$(5:5)=B$

6/8/10 Zebra Programming Guide P1012728-004

484 ZBI Commands
Base Types and Expressions

LET
Description The LET command is used to assign value to a specific variable. The
expression is evaluated and assigned to each variable in the variable list. See Assignment
on page 483.

Format
LET <variable> [,<variable>]* = <expression>
The variable types must match the expression type or an error message will be displayed.
Error: Poorly formed expression.
When a value is assigned to a string variable with a sub-string qualifier, it replaces the
value of the sub-string qualifier. The length of the value of the string variable may change
as a result of this replacement.

Parameters N/A

Example • This is an example of how to use the LET command:

10 LET A$= "1234"
15 LET A$(2:3)= "55" ! A$ NOW = 1554
20 LET A$(2:3)= "" ! A$ NOW = 14

10 LET A$= "1234"

15 LET A$(2:3)= A$(1:2) ! A$ NOW = 1124

10 LET A$= "1234"

15 LET A$(2:1)= "5" ! A$ NOW = 15234

Comments This can be an interactive command that takes effect as soon as it is received by
the printer, or a program command that is preceded by a line number.

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 485
Base Types and Expressions

Numeric Expressions
A base numerical expression can be either a constant, variable, or another numerical
expression enclosed in parentheses. The five types used (addition, subtraction, multiplication,
division, and exponentiation) are listed below. When evaluating an expression exceeding the
maximum or minimum values at any point creates an undefined result. (maximum value:
2,147,487,647; minimum value: -2,147,483,648)

Floating point is not supported.

When using division, the number is always rounded down. For example, 5/2=2. Use MOD to
determine the remainder.

Format

1. + (addition) Addition expressions use this format:

<A>+<B>
5+2 result = 7
VAL ("25") +2 result =27

2. – (subtraction) Subtraction expressions use this format:

<A>-<B>
5-2 result = 3
VAL ("25") -2 result =23

3. * (multiplication) Multiplication expressions use this format:

<A>*<B>
5*2 result = 10
VAL ("25") *2 result =50

4. / (division) Division expressions use this format:

<A>/<B>
5/2 result = 2
VAL ("25") /2 result =12

5. ^ (exponentiation) Exponentiation expressions use this format:

<A>^<B>
5^2 result = 25
VAL ("25") ^2 result =625

6/8/10 Zebra Programming Guide P1012728-004

486 ZBI Commands
Base Types and Expressions

Order of Precedence
In mathematics, the order of precedence describes the sequence that items in an expression are
processed. All expressions have a predefined order of precedence.

The order of precedence is listed below:

Functions
Parenthetical Expressions ()
^
* and /
+ and -

The * and / have the same precedence, and the + and - have the same precedence. Items with
the same order of precedence are processed from left to right.

For example, this expression 5+(8+2)/5 is processed as 8+2=10, followed by 10/5=2, then 5+2
to give a result of 7.

Functions and parenthetical expressions always have the highest order of precedence, meaning
that they are processed first.

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 487
Base Types and Expressions

String Concatenation (&)

The basic string expression may be either a constant or a variable, and concatenation (&) is
supported. Using the concatenation operator (&) adds the second string to the first string.
<A$> & <B$>

Example • This is an example of how to use the STRING CONCATENATION (&)

command:
10 LET A$= "ZBI-"
20 LET B$= "Programming"
30 LET C$= A$ & B$
40 PRINT C$
RUN
ZBI-Programming

Sub-strings
Description Using a sub-string operator on a string allows a specific portion of the string to
be accessed. This portion may be the target of an assignment operation or a reference to a
portion of the string. To determine the coordinates of the string portion to be used, count the
characters from the beginning to the end of the string, including spaces.

Format
LET <STRVAR$>(<A>:<B>)=<C$>
LET <C$> = <STRVAR$>(<A>:<B>)

Parameters
<A> = the position of the first character in the desired string
<B> = the position of the last character in the desired string.
<STRVAR$> = base string variable
If the A parameter is less than 1, it is automatically assigned a value of 1. Because the
string is calculated starting with 1, the A parameter cannot be less than 1.
If B is greater than the length of the string, it is replaced with the length of the string.
If A is greater than B, a NULL string (""), which points to the location of the smaller of A
or the end of the string, is returned. This is used when adding a string in the middle of
another string without removing a character.

6/8/10 Zebra Programming Guide P1012728-004

488 ZBI Commands
Base Types and Expressions

Example • This is an example of a sub-string reference:

LET A$="Zebra Quality Printers"
LET B$=A$(1:13)
PRINT B$
Zebra Quality

Example • This is an example of a sub-string assignment.

LET A$= "1234"
LET A$(2:3)= "55" ! A$ NOW = 1554
LET A$(2:3)= "" ! A$ NOW = 14

LET A$= "1234"

LET A$(2:3)= A$(1:2) ! A$ NOW = 1124

LET A$= "1234"

LET A$(2:1)= "5" ! A$ NOW = 15234

The best way to think of assignment to a sub-string is as follows: an assignment is like

selecting a word, and pasting over the selection with the new string.

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 489
Base Types and Expressions

Boolean Expressions
Description A Boolean expression holds 0 (zero) as false and non-zero as true.

Formats
<STRING EXPRESSION> <BOOLEAN COMPARE> <STRING EXPRESSION>
<NUMERIC EXPRESSION> <BOOLEAN COMPARE> <NUMERIC EXPRESSION>
NOT(<BOOLEAN EXPRESSION>)

Parameters
<STRING EXPRESSION> = a string variable, string constant or any combination with
concatenation
<NUMERIC EXPRESSION> = any mathematical operation

Comments A numeric expression cannot be compared to a string expression.

Numeric expressions can substitute a Boolean expression where a value of 0 (zero) represents
false and a non-zero value represents true.

Base Boolean expressions:

1. < (less than)

Expression Result
1< 2 true
2<2 false
2<1 false

2. <= (less than or equal to)

Expression Result
1<=2 true
2<=2 true
2<=1 false

3. > (greater than)

Expression Result
1> 2 false
2>2 false
2>1 true

6/8/10 Zebra Programming Guide P1012728-004

490 ZBI Commands
Base Types and Expressions

4. >= (greater than or equal to)

Expression Result
1>=2 false
2>=2 true
2>=1 true

5. = (equal to)

Expression Result
1=2 false
2=2 true
"A"="AA" false
"A"="A" true

6. <> (not equal to)

Expression Result
1<>2 true
2<>2 false
"A"<>"AA" true
"A"<>"A" false

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 491
Base Types and Expressions

Combined Boolean Expressions

AND, OR, and NOT can be used in conjunction with base Boolean expressions to recreate
expanded Boolean expressions.

1. NOT — Negate the target expression.

Expression Result
NOT 1=2 true
NOT 1=1 false

2. AND — Both expressions must be true for a true result.

Expression Result
1=2 AND 1=2 false
2=2 AND 1=2 false
1=2 AND 2=2 false
2=2 AND 2=2 true

3. OR — If either expression is true, the result will be true.

Expression Result
1=2 OR 1=2 false
1=2 OR 2=2 true
2=2 OR 1=2 true
2=2 OR 2=2 true

Order of Precedence
The order of precedence is listed below:

Expressions and Functions

Parenthetical expressions ()
<, <=, <>, =, =>, >
NOT, AND, OR

6/8/10 Zebra Programming Guide P1012728-004

492 ZBI Commands
Control and Flow

Control and Flow

This section outlines the commands to conditionally execute code and control the flow of the
program. Here is a quick list of these commands:

IF Statements Executes or skips a sequence of statements, depending on the value of a

Boolean expression.

DO Loops Repeats instructions based on the results of a comparison.

FOR Loops A control flow statement which allows code to be executed iteratively.

GOTO/GOSUB Causes an unconditional jump or transfer of control from one point in a

program to another.

SUB Allows you to “substitute” names instead of actual line numbers as the target of
GOSUBs and GOTOs.

EXIT Used to exit the DO and FOR loops.

END Terminates any program currently running.

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 493
Control and Flow

IF Statements
Description If the value of the <Boolean expression> in an IF statement is true
and a program line follows the keyword THEN, this program line is executed. If the value of
the Boolean expression is false and a program line follows the keyword ELSE, this program
line is executed. If ELSE is not present, then execution continues in sequence, with the line
following the END IF statement.

Nesting of blocks is permitted, subject to the same nesting constraints as DO-LOOPs (no
overlapping blocks).

ELSE IF statements are treated as an ELSE line followed by an IF line, with the exception
that the ELSE IF shares the END IF line of the original IF statement.

Format
IF <Boolean expression> THEN
~~BODY~~
[ELSE IF <Boolean expression> THEN
~~BODY~~]*
[ELSE
~~BODY~~]
END IF

Parameters N/A

Example • This is an example of how to use the IF statement command:

10 IF A$="0" THEN
20 PRINT "ZBI IS FUN"
30 ELSE IF A$="1" THEN
40 PRINT "ZBI IS EASY"
50 ELSE IF TIME=1 THEN
60 PRINT "It is one second past midnight"
70 ELSE
80 PRINT "X=0"
90 END IF

6/8/10 Zebra Programming Guide P1012728-004

494 ZBI Commands
Control and Flow

DO Loops
Description Processing of the loop is controlled by a <WHILE/UNTIL> expression
located on the DO or LOOP line.

Processing a WHILE statement is the same on either the DO or LOOP lines. The Boolean
expression is evaluated and if the statement is true, the LOOP continues at the line after the DO
statement. Otherwise, the line after the corresponding LOOP is the next line to be processed.

Processing an UNTIL statement is the same on either the DO or LOOP lines. The Boolean
expression is evaluated and if the statement is false, the LOOP continues at the line after the
DO statement. Otherwise, the line after the corresponding LOOP is the next to be processed.

If <WHILE/UNTIL> is on the LOOP line, the BODY of the loop is executed before the
Boolean expression is evaluated.

If neither the DO or LOOP line has a <WHILE/UNTIL> statement, the loop continues
indefinitely.

Some notes about DO-LOOPs:

• can be nested
• cannot overlap
• have two formats

Format
DO [<WHILE/UNTIL> <Boolean expression>]
~~BODY~~
LOOP [<WHILE/UNTIL> <Boolean expression>]

Example • This is an example of how to use the DO-LOOP command with the conditional
on the DO line:
10 DO WHILE A$="70"
20 INPUT A$
30 LOOP

Example • This is an example of how to use the DO UNTIL LOOP command with
conditional on the LOOP line:
10 DO
20 INPUT A$
30 LOOP UNTIL A$="EXIT"

Comments This is a program command that is preceded by a line number.

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 495
Control and Flow

FOR Loops
Description FOR loops are an easy way to iterate through a range of values and run a body
of code for each value iterated.

Format
FOR <I> = <A> TO <B> [STEP <C>]
~~BODY~~
NEXT <I>

Parameters
<I> = indicates a numeric variable is used. <I> increments each time through the
FOR-LOOP.
<A> = the value assigned to <I> the first time through the loop
<B> = the last value through the loop
<C> = (Optional) the amount <I> increments each time through the loop
Values of I for the following situations:

Statement Result
FOR I=1 TO 10 {1, 2, 3, 4, 5, 6, 7, 8, 9, 10}
FOR I=10 TO 1 {10, 9, 8, 7, 6, 5, 4, 3, 2, 1}
FOR I=1 TO 10 STEP 2 {1, 3, 5, 7, 9}
FOR I=10 TO 1 STEP 2 {10, 8, 6, 4, 2}
FOR I=10 TO 1 STEP 2 { } FOR LOOP skipped

Example • This is an example of how to use the FOR LOOP command:

10 FOR X=1 TO 10 STEP 1
20 PRINT X; ":ZBI IS FUN"
30 NEXT X

Comments FOR loops can be nested but cannot overlap. Variables cannot be reused by the
nested loops.

6/8/10 Zebra Programming Guide P1012728-004

496 ZBI Commands
Control and Flow

GOTO/GOSUB
Description GOSUB is followed by a line number. The program will attempt to process the
line the GOSUB command points to rather than the next line of the program. Upon executing
the GOSUB statement, the interpreter continues running at the line number specified following
GOSUB. If the line number referenced does not exist, an error will occur.

Before executing the next line, the GOSUB command stores the line number of the GOSUB
line. When the RETURN statement is called, the program moves back to the next line
following the GOSUB.

Executing a RETURN statement without a corresponding GOSUB statement causes an error.

GOSUB statements can be nested.

GOTO works the same way as GOSUB except that no return address will be stored.

Format
GOSUB <A>
RETURN
GOTO <A>

Parameters <A> = the program location executed immediately after the GOTO or
GOSUB.

Example • This is an example of how to use the GOSUB command:

10 PRINT "Call Subroutine"
20 GOSUB 1000
30 PRINT "Returned from Subroutine"
40 END
1000 PRINT "In Subroutine"
1010 RETURN
Example • This is an example of how to use the GOTO command:
10 PRINT "Prepare to Jump!"
20 GOTO 1000
30 PRINT "Jump Missed..."
1000 PRINT "Jump Successful"
1010 END

Comments These are program commands and must be preceded by line numbers.

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 497
Control and Flow

SUB
Description This command allows you to use names instead of actual line numbers as the
target of GOSUBs and GOTOs. AUTONUM can be used at the beginning of a file and there is no
need to compute the line number where the jump will go.

Format 10 SUB <A>

Parameters <A> = the integer variable to use as a target for the GOTO/GOSUB

Example • This is an example of how to use the SUB command:

AUTONUM 1,1
GOSUB INITCOMM
DO
GOSUB GETINPUT
GOSUB PROCESSINPUT
LOOP
SUB INITCOMM
OPEN #1:NAME "SER"
RETURN
SUB GETINPUT
INPUT #1: A$
RETURN
SUB PROCESSINPUT
PRINT A$
RETURN

Comments <A> is a numeric variable. If this variable is changed in the program, any
GOSUB/GOTO to this variable may fail.

6/8/10 Zebra Programming Guide P1012728-004

498 ZBI Commands
Control and Flow

EXIT
Description This command is used to exit the DO and FOR loops.

Format
EXIT DO
EXIT FOR

Parameters The specified loop type is exited. For the DO command, the program will
continue execution on the line following the next LOOP. Likewise for the FOR command, the
program will continue on the line after the next NEXT command.

Example N/A

Comments This is a program command that is preceded by a line number. To be explicit and
reduce errors, it is recommended to use GOTO instead of EXIT.

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 499
Control and Flow

END
Description The END command terminates any program currently running. When the END
command is received, the interpreter returns to interpreting commands (>).

Format END

Parameters N/A

Example • This is an example of how to use the END command:

10 PRINT "THIS PROGRAM WILL TERMINATE"
20 PRINT "WHEN THE END COMMAND IS RECEIVED"
30 END
40 PRINT "THIS SHOULD NOT PRINT"
RUN
THIS PROGRAM WILL TERMINATE
WHEN THE END COMMAND IS RECEIVED

Comments This is a program command and is preceded by a line number.

6/8/10 Zebra Programming Guide P1012728-004

500 ZBI Commands
Input and Output

Input and Output

This section oulines how to communicate with physical ports, internal ports, and the network.

ZBI allows access to the physical and network connections in the printer. Most ports are, by
default, connected to the ZPL processor. When a port is opened in ZBI, the port will be
disconnected from ZPL and connected into the interpreter. Depending on the type of
connection, there are two methods you may use to start the connection. For the static
connections, the OPEN command should be used. These are the connections that you open
when starting your program and leave open for the duration of your program. For dynamic
connections, servers and clients are set up following the "Sockets" model. On servers, the
actual connections are started upon successful calls to ACCEPT. Below are the available
connections that can be made and the preferred accessors.

Available Ports

Port/Connection ZBI Name Preferred Access Commands/Functions

Serial "SER" OPEN, CLOSE
Parallel "PAR" OPEN, CLOSE
USB "USB" OPEN, CLOSE
ZPL parser "ZPL" OPEN, CLOSE
TCP Server "TCP", SERVERSOCKET, SERVERCLOSE, ACCEPT,
"TCPX" CLOSE
TCP Client "TCP" CLIENTSOCKET, CLOSE
UDP Server "UDP" SERVERSOCKET, SERVERCLOSE, ACCEPT,
CLOSE
UDP Client "UDP" CLIENTSOCKET, CLOSE
Email Sender "EML" OPEN, CLOSE
Bluetooth "BLU" OPEN, CLOSE
Note: TCPx will not work on PS2 or PS100 print servers.

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 501
Input and Output

Creating Connections
Here is a quick list of the commands in this section:

OPEN Opens a port for transmitting and receiving data.

CLOSE Closes specific ports that are in use.

DATAREADY Determines if there is data received on a specified port.

SERVERSOCKET Opens a listening socket for incoming UDP packets or TCP connections.

SERVERCLOSE Closes a listening server socket.

CLIENTSOCKET Creates an outgoing TCP connection or sets up UDP transmissions.

ACCEPT Accepts incoming TCP or UDP connections and assigns a channel for the
connection.

6/8/10 Zebra Programming Guide P1012728-004

502 ZBI Commands
Input and Output

OPEN
Description This command is used to open a port for transmitting and receiving data.

Format OPEN #<CHANNEL>: NAME <PORT$>

Parameters
<CHANNEL> = a number to use as a handle to the port for all future communications
Accepted Values: 0 to 9
Default Value: a port must be specified
<PORT$> = port name to open. See Available Ports on page 500.

Example • This is an example of how to use the OPEN command:

10 OPEN #1: NAME "ZPL"

The port being opened no longer allows data to pass directly into its buffer, it disconnects, and
the interpreter now controls the data flow.

Data already in the buffer stays in the buffer.

Comments This can be an interactive command that takes effect as soon as it is received by
the printer, or a program command that is preceded by a line number.

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 503
Input and Output

CLOSE
Description This command is implemented to close specific ports that are in use. If a port is
open on a channel and the CLOSE command is entered, the port closes and returns to
communicating with the ZPL buffer.

Format
CLOSE #<A>
CLOSE ALL

Parameters
<A> = Numeric value of port to close
Accepted Values: 0 through 9
All = closes all open ports and network connections

Note • CLOSE ALL will close the console.

Example • This example shows the closing of channel 1:

10 CLOSE #1

Comments This can be an interactive command that takes effect as soon as it is received by
the printer, or a program command that is preceded by a line number.

6/8/10 Zebra Programming Guide P1012728-004

504 ZBI Commands
Input and Output

DATAREADY
Description This function is used to determine if there is data received on a specified port.

Format DATAREADY (A)

Parameters A = the port to check

Returns 1 if there is data, 0 if there is no data.

Example • This is an example of how to check if there is a data on a port:

10 PRINT DATAREADY(0)
RUN
The result, assuming no data is waiting, is:
0

Comments If this command follows the INPUT command, it may return 1 if the line
received was ended with a CRLF. In this case, INBYTE can be used to take the LF out of the
buffer.

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 505
Input and Output

SERVERSOCKET
Description This function opens a listening socket for incoming UDP packets or TCP
connections. It must be used in conjunction with the ACCEPT function.

Format SERVERSOCKET (TYPE$,PORT)

Parameters
TYPE$ = listens for any of the following communication protocols:
"TCP" = TCP – PORT parameter is ignored. The current port will be used.
"TCPX" = TCP – any open port
"UDP" = UDP – any open port

Returns NUMERIC = returns the handle of the server upon success.

Example • See the examples for TCP Server on page 522 and UDP Server on page 524.

Comments When using TCPX, care needs to be taken not to use a port that is already open
on the printer. No error message will be returned until the ACCEPT function is called.

6/8/10 Zebra Programming Guide P1012728-004

506 ZBI Commands
Input and Output

SERVERCLOSE
Description This function closes a listening server socket created by SERVERSOCKET.

Format SERVERCLOSE(SOCKET)

Parameters
SOCKET = the socket handle returned from a successful SERVERSOCKET invocation.

Returns Returns a 0 if the socket was already closed or a 1 if the socket was closed
successfully.

Example • This example shows how to close a listening server socket.

10 LET SERVER_HANDLE = SERVERSOCKET("TCPX", 19100)
20 LET SCERR = SERVERCLOSE(SERVER_HANDLE)

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 507
Input and Output

CLIENTSOCKET
Description This function creates an outgoing TCP connection or sets up UDP
transmissions. Once set up for UDP, packets can be sent by printing to the socket. Packets are
sent when the size limit is met or a EOT character is written.

Format CLIENTSOCKET (TYPE$, IPADDR$, PORT)

Parameters
TYPE$ = set to "UDP" or "TCP".
IPADDR$ = connects to this address.
PORT = connects to this IP port.

Returns The port number assigned to the connection.

Example • See the examples for TCP Server on page 522 and UDP Server on page 524.

Comments Multiple communications connections can be made up to the maximum of 10.

Each protocol may have a different limit based on the support of the print server used. Test the
worst case situation based on your application’s needs or use ONERROR to recover from failed
connection attempts.

6/8/10 Zebra Programming Guide P1012728-004

508 ZBI Commands
Input and Output

ACCEPT
Description This function will accept incoming TCP or UDP connections and assign a
channel for the connection. SERVERSOCKET must be used to set up the listening socket
before ACCEPT can be used.

Format ACCEPT (SERVER, CLIENT_INFO$)

Parameters
SERVER = the handle returned by the SERVERSOCKET call.
CLIENT_INFO$ = string variable will have the connecting client’s IP address and port
separated by a space when using UDP.

Returns The channel number to use to communicate with the client.

Example • See the examples for TCP Server on page 522 and UDP Server on page 524.

Comments It is best to poll this function at regular intervals. When there is no connection
waiting, this function will trigger an error. Follow this function with the ON ERROR command
to divert to a section of code that handles an unsuccessful connection.

ACCEPT can be called before closing a previous connection. This allows for processing
multiple incoming streams of data. There are limits on the number of simultaneous incoming
connections based on the print server model on the printer.

Connection closure can be detected when any input or output command to the port triggers an
error. These commands should be followed by an ON ERROR statement to send the program
into a recovery state and to shutdown the connection cleanly.

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 509
Input and Output

Reading and Writing

This manual has detailed various functions to read and write to all of the ports. The following
section gives an overview of the commands, functions, and when each should be used.

To start, it is important to understand the term "blocking". In communications code, a function

or command is "blocking" if it waits for all of the requested data to be received before it
returns.

INPUT (blocking) Reads one line into each string specified.

PRINT (blocking) Simple method to write specified expressions out.

OUTBYTE (blocking) Writes one byte out.

INBYTE (blocking) Reads in one byte.

READ (non-blocking) Reads in all available data up to the maximum amount specified.

WRITE (non-blocking) Writes out as much data as possible up to a maximum specified

amount.

SEARCHTO$ (blocking) Reads in data (does not keep) until a search parameter is found.
Non-matching data can be redirected to another port.

6/8/10 Zebra Programming Guide P1012728-004

510 ZBI Commands
Input and Output

INPUT
Description If the variable is numeric and the value entered cannot be converted to a
number, it writes as 0. This operation scans the data from left to right, shifting any number into
the variable. It ignores any non-numeric character except the return character, which
terminates the input, or Ctrl-C (^C) which terminates the program. The variable can be in
string or numeric form.

Format
INPUT [<CHANNEL>:] <A$> [,<B$>]*
INPUT [<CHANNEL>:] <A>[,<B>]*

If the [<channel>:] is omitted, the default port, 0, will be used.

Parameters
<CHANNEL> = read data from this port. Default = 0.
<A,B,...,N> = variables to write.
When using multiple variables as targets, a corresponding number of lines are read. String
and numeric variables can be intermixed.

Example • This is an example of how to use the INPUT command:

10 OPEN #1: NAME "ZPL"
20 PRINT #1: "~HS"
30 FOR I = 1 TO 3
40 INPUT #1: A$
50 PRINT A$
60 NEXT I

In this example, a host status prints to the console after submitting the host status request ~HS
to the ZPL port.

The Input/Output command of the ZBI interpreter is limited to the communications ports. File
I/O is not supported.

INPUT ends processing a line with a CR or LF. This leads to a tricky situation. There are many
ways different systems end a line: CR, CRLF, LF. If the ZBI program only uses INPUT, the
next execution of the INPUT command will remove the extra LF or CR, in case of LFCR.
However, if the program instead uses INBYTE, DATAREADY or the other commands, the
extra LF will show up on the port. Here’s a simple workaround to explicitly look for the CRLF
that is in use:
SEARCHTO(<PORT>,CHR$(13)&CHR$(10),<INSTRING$>)

Note • The INPUT command does not accept control characters or the delete character. If
these characters need to be processed, please use the READ command.

Comments This can be an interactive command that takes effect as soon as it is received by
the printer, or a program command that is preceded by a line number.

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 511
Input and Output

If an invalid port is specified, Error: Invalid port is returned.

Example • This shows the input command reading in multiple lines.

10 INPUT A$,B,C,D$,E$
Five lines would be read in: 3 strings and 2 numbers.

6/8/10 Zebra Programming Guide P1012728-004

512 ZBI Commands
Input and Output

PRINT
Description This command sends data to the printer to be printed.

Format PRINT [CHANNEL:] <expression> [,or; <expression>]* [;]

Parameters
<CHANNEL> = write data to this port
<expression> = the value to write

The expression can be either a string or a numeric expression.

Using a , to separate expressions adds a space between them.
Using a ; to separate expressions does not put a space between them.
Using a ; at the end of a line ends the print statement without adding a new line (CR/LF).

Example • This is an example of how to use the PRINT command:

10 LET A$ = "This is an example"
20 LET B$ = "of the PRINT Command."
30 PRINT A$, B$ ! adds a space between expressions
40 PRINT A$; B$ ! no space added
RUN

The result is:

This is an example of the PRINT Command.
This is an exampleof the PRINT Command.

Comments This can be an interactive command that takes effect as soon as it is received by
the printer, or a program command that is preceded by a line number.

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 513
Input and Output

OUTBYTE
Description This command outputs a byte to a port.

Format
OUTBYTE [<CHANNEL>:] <A>
OUTBYTE [<CHANNEL>:] <A$>

Parameters
<CHANNEL> = sends the byte to this port. Default = 0.
<A> = This is a numeric expression.
Accepted Values: 0 through 255. If it is not within that range, it is truncated.
<A$> = This is the string expression. The first character is used. In the case of a NULL
string, 0 is sent.

Example • This is an example of how to use the OUTBYTE command:

LET A$="Hello"
OUTBYTE A$
This would only print the H character to the console.
OUTBYTE 4
This would print the control character EOT to the console. See an ASCII table for a list of
the control characters.

Comments This can be an interactive command that takes effect as soon as it is received by
the printer, or a program command that is preceded by a line number.

6/8/10 Zebra Programming Guide P1012728-004

514 ZBI Commands
Input and Output

INBYTE
Description This command forces the interpreter to pause until data is available. Use the
DATAREADY function to determine if there is data on the port.

Format
INBYTE [<CHANNEL>:] <A>
INBYTE [<CHANNEL>:] <A$>

Parameters
<CHANNEL> = reads from this port. Default = 0.
<A> = integer value is set to the byte received.
<A$> = A single byte string is created with the byte received.The first character is used.
In the case of a NULL string, 0 is sent.

Example • This is an example of how to use the INBYTE to create an echo program:
10 INBYTE A$ !Takes one byte (char) from port #0
20 PRINT A$ !Prints the character to the console
30 GOTO 10

In this example, the interpreter pauses until the data is entered, then continues processing. This
command enters all bytes in a string or integer, including control codes.

Comments INBYTE will block until a byte is received on the specified port. This can be an
interactive command that takes effect as soon as it is received by the printer, or a program
command that is preceded by a line number.

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 515
Input and Output

READ
Description This is a non-blocking input function. It will read in all of the bytes available
on the specified port.

Format READ (<CHANNEL>, <A>, <MAXBYTES>)

Parameters
<CHANNEL> = reads from this port. Default = 0.
<A$> = the string where the data will be placed
<MAXBYTES> = the maximum number of bytes to read

Returns The number of bytes read.

Example • This is an example of the READ command:

1 CLOSE ALL
2 LET INPORT = CLIENTSOCKET("TCP","192.168.0.1",9100)
3 ON ERROR GOTO RECOVERY
4 LET WATERMARK = 5000
5 DO WHILE 1
6 IF LEN(DATA$) < WATERMARK THEN
7 LET BYTESREAD = READ(INPORT,DATA$,500)
8 ON ERROR GOTO RECOVERY
9 END IF
10 IF (LEN(DATA$) > 0) THEN
11 LET BYTES_WRITTEN = WRITE(INPORT,DATA$,LEN(DATA$))
12 ON ERROR GOTO RECOVERY
13 LET DATA$(1,BYTES_WRITTEN) = ""
14 END IF
15 IF BYTESREAD = 0 AND BYTESWRITTEN = 0 THEN
16 SLEEP 1 ! DON'T BOMBARD IF IDLE
17 END IF
18 LOOP
19 SUB RECOVERY
20 CLOSE #INPORT

6/8/10 Zebra Programming Guide P1012728-004

516 ZBI Commands
Input and Output

WRITE
Description This is a non-blocking output function. It will write as many bytes as the
output buffer can hold.

Format WRITE (<CHANNEL>, <A>, <BYTES>)

Parameters
<CHANNEL> = reads from this port. Default = 0.
<A$> = the string to write out.
<MAXBYTES> = The number of bytes to write

Returns The number of bytes written.

Example • This is an example of WRITE command:

1 CLOSE ALL
2 LET INPORT = CLIENTSOCKET("TCP","192.168.0.1",9100)
3 ON ERROR GOTO RECOVERY
4 LET WATERMARK = 5000
5 DO WHILE 1
6 IF LEN(DATA$) < WATERMARK THEN
7 LET BYTESREAD = READ(INPORT,DATA$,500)
8 ON ERROR GOTO RECOVERY
9 END IF
10 IF (LEN(DATA$) > 0) THEN
11 LET BYTES_WRITTEN = WRITE(INPORT,DATA$,LEN(DATA$))
12 ON ERROR GOTO RECOVERY
13 LET DATA$(1,BYTES_WRITTEN) = ""
14 END IF
15 IF BYTESREAD = 0 AND BYTESWRITTEN = 0 THEN
16 SLEEP 1 ! DON'T BOMBARD IF IDLE
17 END IF
18 LOOP
19 SUB RECOVERY
20 CLOSE #INPORT

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 517
Input and Output

SEARCHTO$
Description This function performs a search until a specified string is found. The string the
search yields is displayed.

Format
SEARCHTO$(A,B$)
SEARCHTO$(A,B$,C)
SEARCHTO$(A$,B$)
SEARCHTO$(A$,B$,C$)

Parameters
A = port number (0 to 9) to which requested data is sent
A$ = string to search for B$
B$ = string variable or string array. If B$ is an array, this command searches for all
non-null strings in the B$ array.
C = a port in which the input is directed until B$ is found
C$ = a string in which the characters in A$ are directed until B$ is found

Returns The string found.

Example • This example shows how to use SEARCHTO to find a string on a port:
10 OPEN #1: NAME "SER"
20 LET A$ = SEARCHTO$(1,"^XA")
30 PRINT "FOUND:", A$

Example • This example shows how to search for an array of strings:

10 OPEN #1: NAME "SER"
20 DECLARE STRING FIND$(3)
30 LET FIND$(1) = "ONE"
40 LET FIND$(2) = "TWO"
50 LET FIND$(3) = "THREE"
60 LET A$ = SEARCHTO$(1,FIND$)
70 PRINT "FOUND:", A$

6/8/10 Zebra Programming Guide P1012728-004

518 ZBI Commands
Input and Output

Example • This example shows unused data routed to a port.

10 OPEN #1: NAME "PAR"
20 OPEN #2: NAME "SER"
30 DECLARE STRING FIND$(3)
40 LET FIND$(1) = "ONE"
50 LET FIND$(2) = "TWO"
60 LET FIND$(3) = "THREE"
70 LET A$ = SEARCHTO$(1,FIND$,2)
80 PRINT "FOUND:", A$

Example • This example shows how to use SEARCHTO to find a string within a string and
direct the unused part of the string to another string:
10 LET A$ = "The faster you go, the shorter you are - Einstein"
20 LET B$ = SEARCHTO$(A$,"you", C$)
30 PRINT "FOUND:", B$
40 PRINT "DISCARDED:", C$

Comments SEARCHTO will block (wait) until the search string is found. If you want to be
able to run other code while doing something similar, consider using READ with POS.

When using SEARCHTO with ports, it will block (wait) until the search string is found. If you
want to be able to run other code while doing something similar, consider using READ to place
data into a string. That string can be passed to SEARCHTO for processing.

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 519
Input and Output

Port Usage Examples

Before diving into the syntax of all the commands, let’s look at some simple applications using
the different features of the communications systems in ZBI.

Physical Ports (Serial, Parallel, USB)

Though the types of devices interacting with the printer's ports may vary greatly, internal to the
printer, the ports are all handled in the same way. These ports are opened with the ZBI OPEN
command and closed with the ZBI CLOSE command. When one of these ports is opened, it is
disconnected from the ZPL parser and any data in the buffer will be redirected to the ZBI
environment.

Example • In the following example, "SER" could be replaced by "PAR" or "USB"

depending on the application.
10 CLOSE ALL
20 LET INPORT = 1
30 OPEN #INPORT: NAME "SER"
40 PRINT #INPORT: "Enter your name:";
50 INPUT #INPORT: YOURNAME$
60 PRINT #INPORT: "You entered: "; YOURNAME$
70 CLOSE #INPORT

6/8/10 Zebra Programming Guide P1012728-004

520 ZBI Commands
Input and Output

ZPL Parser
To make a ZBI program print, it is necessary to create a connection from the program to the
ZPL parser on the printer. The connection will function in the same way as a connection to a
physical port, except that the connection will not automatically terminate. The ZPL parser in
the printer can handle many incoming connections simultaneously. For example, a ZBI
program could take control of the serial port and send label formats to the ZPL parser, while
the parallel port (unopened by ZBI) could also be used to send label formats directly into the
parser.

Note • The ZPL parser will lock onto one port once a format is started (via the ^XA
command). So, in some cases, is it desirable to start and stop your communications to ZPL in
one continuous sequence.

Another use of ZBI is to check printer status, while another application prints to another port.

Example • Here is how that can be done:

10 OPEN #1: NAME "ZPL"
20 PRINT #1: "~HS"
30 FOR I = 1 TO 3
40 INPUT #1: A$
50 PRINT A$
60 NEXT I

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 521
Input and Output

TCP Client
There are two methods for making a TCP connection to another server. The first method uses
the OPEN command while the second method uses the CLIENTSOCKET method.

CLIENTSOCKET is the preferred method.

Example • The following example demonstrates this method:

10 CLOSE ALL
20 LET INPORT = CLIENTSOCKET("TCP","192.168.0.1",9100)
40 LET OUTSTR$ = "REQUESTING SERVER NAME";
50 DO WHILE (LEN(OUTSTR$) > 0)
60 LET BYTES_WRITTEN =
WRITE(INPORT,OUTSTR$,LEN(OUTSTR$))
70 ON ERROR GOTO RECOVERY
80 LET OUTSTR$ = OUTSTR$(1+BYTES_WRITTEN:LEN(OUTSTR$))
90 LOOP
100 INPUT #INPORT: YOURNAME$
110 PRINT #INPORT: "Server returned: "; YOURNAME$
120 CLOSE #INPORT
130 SUB RECOVERY
140 END

6/8/10 Zebra Programming Guide P1012728-004

522 ZBI Commands
Input and Output

TCP Server
Setting up a listening server in the printer can be accomplished with the SERVERSOCKET
function. To connect to incoming TCP sessions, use the ACCEPT function.

When starting the application, call SERVERSOCKET. This function will create a handle for
this listening server. Check for incoming connections at regular intervals with the ACCEPT
function. If there are no pending sessions, the ACCEPT function will return with an error.
Handle the error using the ON ERROR command and continue looking for other sessions later.

Depending on how the program is set up, it is possible to handle one or more sessions at a
time. If the program is configured to allow only one session, the other connections will remain
pending until they are shut down by the requesting client or the ZBI program connects them.

Example • Here is an example of the SERVERSOCKET and ACCEPT commands:

10 CLOSE ALL
20 LET SERVER_HANDLE = SERVERSOCKET("TCPX",19100)
30 REM There are no connections yet we are just listening
for them
40 REM Lets loop until we get a connection
50 SLEEP 1
60 LET INPORT = ACCEPT(SERVER_HANDLE,CLIENT_INFO$)
70 ON ERROR GOTO 50
80 PRINT #INPORT: "You have successfully connected!"
90 PRINT #INPORT: "Login:";
100 INPUT #INPORT: LOGIN$
110 PRINT #INPORT: "Password:";
120 INPUT #INPORT: PASSWORD$
130 REM We will not be nice and reject the connection
130 PRINT #INPORT: "Login failed"
140 CLOSE #INPORT
150 GOTO 60 ! Go look for the next connection
160 END

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 523
Input and Output

UDP Client
There are also two methods for making a UDP connection to another server. The first method
uses the OPEN command, while the second method uses the CLIENTSOCKET method. UDP
is a one way communication medium, thus, you can only use output commands. Because UDP
is connectionless, the output will be queued up until an EOT character is written or the
maximum packet size is exceeded. Once the EOT character is written, the packet is formatted
and sent.

With UDP, it is important to be careful about understanding what the network being used will
support.

In many cases, there will be a limit to the size of the packet that can be used, typically between
1000 and 1500 bytes, but some networks cut this down into the 500 to 600 byte range. To be
safe, keep your packets less than 500 bytes.

UDP does not guarantee transmission. See UDP specifications for more details.

Example • Since CLIENTSOCKET is the preferred method, an example is shown below.

10 CLOSE ALL
20 LET INPORT = CLIENTSOCKET("UDP","192.168.0.1",22222)
30 LET EOT$ = CHR$(4)
40 PRINT #INPORT: "Packet #"; I; EOT$;
50 LET I = I + 1
60 SLEEP 1
70 GOTO 40

6/8/10 Zebra Programming Guide P1012728-004

524 ZBI Commands
Input and Output

UDP Server
Setting up a listening server in the printer can be accomplished with the SERVERSOCKET
function. Then, to connect to incoming UDP packets, use the function ACCEPT. When starting
your application, call SERVERSOCKET. This function will create a handle for this listening
server. Check for incoming packets at a regular interval with the ACCEPT function. If there are
no pending sessions, the ACCEPT function will return with an error. Just handle the error using
the ON ERROR command and continue looking for other sessions later. You will need to call
ACCEPT for each incoming packet. When the accept is successful, all of the data will be
available. Call READ with a MAX string size of 2000 and you will have the whole packet in
your string. Close the port and wait for the next packet. You can only read in data using a UDP
server.

Example • Here is an example of how to set up to receive UDP messages:

10 CLOSE ALL
20 LET ZPLPORT = 1
35 OPEN #ZPLPORT: NAME "ZPL"
40 LET SERVER_HANDLE = SERVERSOCKET("UDP",33333)
50 REM There are no connections yet: listening
60 REM Let’s loop until we get a connection
70 SLEEP 1
80 LET INPORT = ACCEPT(SERVER_HANDLE,CLIENT_INFO$)
90 ON ERROR GOTO 70
100 LET PACKET_SIZE = READ(INPORT,PACKET$,2000)
110 PRINT #ZPLPORT: "^XA^FO100,100^A0N,40,40^FDPACKET FROM:";
115 PRINT #ZPLPORT: CLIENT_INFO$; "^FS"
120 PRINT #ZPLPORT: "^FO100,150^A0N,40,40^FDPACKET SIZE:";
125 PRINT #ZPLPORT: PACKET_SIZE; "^FS"
130 PRINT #ZPLPORT: "^FO100,200^A0N,40,40^FDPACKET DATA:";
135 PRINT #ZPLPORT: PACKET$; "^FS^XZ"
140 CLOSE #INPORT
150 GOTO 60 ! go look for the next connection
160 END

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 525
Input and Output

E-mail
ZBI can be used to enhance the printer’s ability to send status via e-mail messages. The
process is simple: open the email port "EML", send the recipient list, send the header, and send
the body of the message.

The printer can only process a limited number of outgoing email messages at one time. For
this reason, error handling should be used when opening the connection to wait for the printer
to be ready to send the message. The EOT character is important for delimiting sections of the
email message. If it is left out, the message will not be sent properly.

Before the following code will work, the email settings for the print server must be set up.
Consult the print server manual to learn how to configure the unit.

Example • Here is an example of how to send e-mails:

1 REM EOT$ this is used to denote end of transmission
5 LET EOT$ = CHR$(4)
1 REM Open a connection to the e-mail port and if it errors
1 REM try again until complete
10 OPEN #1: NAME "EML"
15 ON ERROR GOTO 10
1 REM Specify address to send message to then end signal end
1 REM of recipients with EOT$
1 REM To send to multiple addressees separate addressees by
1 REM space
20 PRINT #1: "[email protected]";EOT$;
1 REM Fill in the message information
30 PRINT #1: "From: HAL"
40 PRINT #1: "To: Dave"
50 PRINT #1: "Subject: A message from HAL"
60 PRINT #1: ""
70 PRINT #1: "Dave, I am sorry I can not let you do that."
80 PRINT #1: i
1 REM Terminate message
90 PRINT #1: "";EOT$
1 REM You must close the port, each open port is only good
1 REM for sending one message
100 CLOSE #1

6/8/10 Zebra Programming Guide P1012728-004

526 ZBI Commands
File System

File System
This section shows how programs and formats can be saved and recalled. Here’s a quick list of
these commands:

STORE Saves the program currently in memory as the specified file name.

LOAD Transfers a program file previously stored in the printer’s memory and opens it in the
ZBI Program Memory.

DIR With no filter included, prompts the printer to list all of the ZBI programs residing in all
printer memory locations.

DELETE Removes a specified file from the printer’s memory.

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 527
File System

Runtime Access
The following example is a method to store runtime data in the printer memory. The file
system in the printer is limited to writing one file at a time. Since only one component of the
printer can have write access to the file system, the ZPL parser is the component with this
access. For ZBI to use the ZPL parser as a gateway into printer memory, the ZPL comment
command (^FX) is used.

Example • Here is an example:

AUTONUM 1,1
REM ******* TEST FOR SUBROUTINES **********************
LET ZPLPORT = 1 OPEN #ZPLPORT: NAME "ZPL"
LET SIZE = 5
LET FILENAME$ = "R:TESTSYS.ZPL"
DECLARE STRING DATAIN$(SIZE)
LET DATAIN$(1) = "ONE"
LET DATAIN$(2) = "TWO"
LET DATAIN$(3) = "THREE"
LET DATAIN$(4) = "FOUR"
LET DATAIN$(5) = "FIVE"
GOSUB STOREDATA
GOSUB GETDATA
FOR I = 1 TO SIZE
IF DATAIN$(I) <> DATAOUT$(I) THEN
PRINT #ZPLPORT: "^XA^FO100,100^A0N,50,50^FDERROR:";
PRINT #ZPLPORT: DATAOUT$(I);"^XZ"
END IF
NEXT I
END
REM **** SUBROUTINE STOREDATA **************************
REM INPUT: ZPLPORT, DATAIN$, SIZE, FILENAME$ ***********
SUB STOREDATA
PRINT #ZPLPORT: "^XA^DF" & FILENAME$ & "^FS"
PRINT #ZPLPORT: "^FX"; SIZE; "^FS"
FOR I = 1 TO SIZE

6/8/10 Zebra Programming Guide P1012728-004

528 ZBI Commands
File System

PRINT #ZPLPORT: "^FX" & DATAIN$(I) & "^FS"

NEXT I
PRINT #ZPLPORT: "^XZ"
RETURN
REM **** SUBROUTINE GETDATA - **************************
REM INPUT: ZPLPORT, FILENAME$ **************************
REM ** OUTPUT: DECLARES AND FILLS DATAOUT$ AND FILLS SIZE
SUB GETDATA
PRINT #ZPLPORT: "^XA^HF" & FILENAME$ & "^XZ"
SLEEP 1
LET RESULT$ = ""
FOR J = 1 TO 25
LET A = READ(ZPLPORT,TEMP$,5000)
LET RESULT$ = RESULT$ & TEMP$
IF POS(RESULT$,"^XZ") <> 0 THEN
EXIT FOR
END IF
SLEEP 1
NEXT J
LET RESULT$(1:POS(RESULT$,"^FX")+2) = ""
LET SIZE = VAL(EXTRACT$(RESULT$,"","^"))
DECLARE STRING DATAOUT$(SIZE)
FOR I = 1 TO SIZE
LET RESULT$(1:POS(RESULT$,"^FX")+2) = ""
LET DATAOUT$(I) = EXTRACT$(RESULT$,"","^")
NEXT I
LET RESULT$ = ""
LET TEMP$ = ""
RETURN

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 529
File System

STORE
Description This command saves the program currently in memory as the specified file
name. The format listed below is used.

Format STORE <filename$>

Parameters <filename$> = the name of the file to be stored. Drive location and file
name must be in quotation marks.

Example • This is an example of how to use the STORE command:

STORE "E:PROGRAM1.BAS"

Comments For a file name to be valid, it must conform to the 8.3 Rule: each file must have
no more than eight characters in the file name and have a three-character extension. Here the
extension is always .BAS (for example, MAXIMUM8.BAS).

This is an interactive command that takes effect as soon as it is received by the printer.

The ZBI-Developer IDE will take care of this for you with the SEND TO option on your
program.

6/8/10 Zebra Programming Guide P1012728-004

530 ZBI Commands
File System

LOAD
Description This command transfers a program file previously stored in the printer’s
memory and opens it in the ZBI Program Memory.

If the program file does not exist, the ZBI Program Memory is cleared and no program is
opened.

Format LOAD <filename$>

Parameters <filename$> = the file name to be loaded into memory. Drive location and
file name must be in quotation marks. If the drive location is not specified, all drives will be
searched.

Example • Here are examples of how to use the LOAD command:

LOAD "PROGRAM1.BAS"
LOAD "E:PROGRAM1.BAS"

Comments This is an interactive command that takes effect as soon as it is received by the
printer.

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 531
File System

DIR
Description This command, with no filter included, prompts the printer to list all of the ZBI
programs residing in all printer memory locations.

Including a filter signals the printer to limit the search; including a drive location signals the
printer to search in only one location.

Asterisks (*) are used as wild cards. A wild card (*) finds every incidence of a particular
request. The example here, DIR "B:*.BAS", signals the printer to search for every file
with a .BAS extension in B: memory.

Format DIR [<filter$>]

Parameters [<filter$>] = the name of the file to be accessed (optional). Drive location
and file name must be in quotation marks.
Default = "*:*.bas"

Important • Quotes must be around what you are doing. This shows you how to use the
wildcard (*) to search for all .BAS files in B: memory:

Quotes surrounding action

DIR "B:*.BAS" file type

memory wildcard

Example N/A

Comments This is an interactive command that takes effect as soon as it is received by the
printer.

6/8/10 Zebra Programming Guide P1012728-004

532 ZBI Commands
File System

DELETE
Description This command removes a specified file from the printer’s memory.

Format DELETE <filename$>

Parameters <filename$> = the name of the file to be deleted. Drive location and
filename must be in quotation marks.

Example • This is an example of deleting a specified file from printer memory:

DELETE "E:PROGRAM1.BAS"

Comments This is an interactive command that takes effect as soon as it is received by the
printer.

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 533
Comma Separated Values (CSV)

Comma Separated Values (CSV)

Accessing Comma Separated Value (CSV) and Text File Functions

This section describes the functions to access CSV files and ASCII plain-text files. Here is a
quick list of these commands:

CSVLOAD Loads the contents of a CSV file in a two dimensional string array.

CSVSTORE Stores the contents of a two dimensional string array in a CSV file.

TXTLOAD Loads the contents of an ASCII plain-text file into a string variable.

TXTSTORE Stores the contents of a string variable in an ASCII plain text file.

6/8/10 Zebra Programming Guide P1012728-004

534 ZBI Commands
Comma Separated Values (CSV)

CSVLOAD
Description This function will load the delimited values from a CSV file, defined by
FILENAME$, and store them in the two-dimensional array, DEST$.

Format
CSVLOAD(DEST$, FILENAME$)
CSVLOAD(DEST$, FILENAME$, DELIM$)

Parameters
DEST$ = two dimensional array that will hold the rows and columns from the CSV file
specified by the FILENAME$ variable. If there is not enough room in DEST$, or if it has
the wrong size, it will be changed to fit the data from the file. The data originally in
DEST$ will be overwritten.
FILENAME$ = name of the file to load. Drive location and file name must be in quotation
marks. The file extension must be either ".CSV" or ".TXT".
DELIM$ = optional delimiter that is used in the CSV file instead of a comma. If DELIM$
is not provided a comma will be used by default. The delimiter must be a single character
that is not a quote, carriage return, or newline.

Returns The number of elements in each row of the CSV file. The function will return 0 if
errors were detected in the CSV file, or if the file could not be read.

Example • This example shows how to print the values in a CSV file with a comma
delimiter.
10 DECLARE STRING CSVDB$(1,2)
20 LET FILENAME$ = "E:RECORDS.CSV"
30 LET NUMOFCOLS = CSVLOAD(CSVDB$, FILENAME$)
40 LET NUMOFROWS = ROWSIZE(CSVDB$)
100 FOR I = 1 TO NUMOFROWS STEP 1
110 FOR J = 1 TO NUMOFCOLS STEP 1
120 PRINT CSVDB$(I, J), " ";
200 NEXT J
210 PRINT ""
300 NEXT I

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 535
Comma Separated Values (CSV)

Example • This example shows how to print the values in a CSV file that uses a '|' as a
delimiter.
10 DECLARE STRING CSVDB$(1,2)
20 LET FILENAME$ = "E:EMPLOYEE.CSV"
30 LET NUMOFCOLS = CSVLOAD(CSVDB$, FILENAME$, "|")
40 LET NUMOFROWS = ROWSIZE(CSVDB$)
100 FOR I = 1 TO NUMOFROWS STEP 1
110 FOR J = 1 TO NUMOFCOLS STEP 1
120 PRINT CSVDB$(I, J), " ";
200 NEXT J
210 PRINT ""
300 NEXT I

Comments The maximum CSV file size supported will vary based upon available RAM
within the printer.

CSV File Information

The file format should follow the rules in IETF RFC 4180: http://tools.ietf.org/html/rfc4180

The maximum number of columns per row in a CSV file is 256.

Each row must be 2048 characters or less including the delimiter. The carriage return/line feed
(CRLF) does not count toward the limit.

Each row in the CSV file must have the same number of elements. If there are any missing
elements in the CSV file (indicated by two adjacent commas or a comma at the end of a row),
they will be represented as empty strings.

If an element in the CSV file contains a quote, it should be represented as two quotes.
Additionally, if an element contains a quote, a new line, a carriage return, or the delimiter
character, the element must be within quotes. For example, a value that is used to store a
measurement in feet and inches (4' 5") must be formatted as "4' 5""" within the CSV file.

6/8/10 Zebra Programming Guide P1012728-004

536 ZBI Commands
Comma Separated Values (CSV)

CSVSTORE
Description This function will store the values of a two dimensional array into a CSV file
on the file system. Each element within the array is treated as a single value within the CSV
file.

Format
CSVSTORE(SRC$, FILENAME$)
CSVSTORE(SRC$, FILENAME$, DELIM$)

Parameters
SRC$ = two dimensional array of strings to be written to a CSV file.
FILENAME$ = name of the file to store the array contents. Drive location and file name
must be in quotation marks. The file extension must be either ".CSV" or ".TXT".
DELIM$ = optional delimiter that is used in the CSV file instead of a comma. If DELIM$
is not provided a comma will be used by default. The delimiter must be a single character
that is not a quote, carriage return, or newline.

Returns A 0 if there were no errors. A 1 is returned if SRC$ is not a string array, if the file
could not be written, or if SRC$ contains errors that prevent the file from being stored.

Example • This example shows how to convert a comma delimited CSV file into a "^"
delimited TXT file and print the contents.
10 DECLARE STRING CSVDB$(1,2)
20 LET NUMOFCOLS = CSVLOAD(CSVDB$, "E:RECORDS.CSV")
30 LET CSVERROR = CSVSTORE(CSVDB$, "E:NEWREC.TXT", "^")
40 LET NUMOFCOLS = CSVLOAD(CSVDB$, "E:NEWREC.TXT", "^")
50 LET NUMOFROWS = ROWSIZE(CSVDB$)
100 FOR I = 1 TO NUMOFROWS STEP 1
110 FOR J = 1 TO NUMOFCOLS STEP 1
120 PRINT CSVDB$(I, J), " ";
200 NEXT J
210 PRINT ""
300 NEXT I

Comments The elements of the array should follow the rules in IETF RFC 4180:
http://tools.ietf.org/html/rfc4180

There is no limit on the number of columns per row when storing to a CSV file. However, a
file stored with rows that exceed the column limit imposed by CSVLOAD will not be loaded by
the CSVLOAD function.

There is no limit on the size of a row when stored to a CSV file. However, a file stored with
rows that exceed the size limit imposed by CSVLOAD will not be loaded by the CSVLOAD
function.

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 537
Comma Separated Values (CSV)

TXTLOAD
Description This function will read the contents of an ASCII text file into a ZBI string
variable.

Format TXTLOAD(DEST$, FILENAME$)

Parameters
DEST$ = string to store the contents of FILENAME$.
FILENAME$ = name of the file to read. Drive location and file name must be in quotation
marks. The file extension must be either ".CSV" or ".TXT".

Returns The number of bytes read from the file. The function will return 0 if the file could
not be read.

Example • This example shows how to print out the contents of a file.
10 LET TXTSIZE = TXTLOAD(TXTDATA$, "E:MYDATA.TXT")
20 PRINT STR$(TXTSIZE), "bytes:", TXTDATA$

Comments The data originally in DEST$ will be overwritten upon completion of this
function.

6/8/10 Zebra Programming Guide P1012728-004

538 ZBI Commands
Comma Separated Values (CSV)

TXTSTORE
Description This function will store the contents of a ZBI string in an ASCII text file.

Format TXTSTORE(SRC$, FILENAME$)

Parameters
SRC$ = string to store to FILENAME$.
FILENAME$ = name of the file to store. Drive location and file name must be in quotation
marks. The file extension must be either ".CSV" or ".TXT".

Returns Returns a 0 if there were no errors, otherwise a 1 is returned.

Example • This example shows how to append a text file.

10 LET TXTSIZE = TXTLOAD(TXTDATA$, "E:MYDATA.TXT")
11 REM Append a date/time stamp to the file
20 LET TXTDATA$ = TXTDATA$ & " " & DATE$ & " " & TIME$
30 LET TXTSIZE = TXTSTORE(TXTDATA$, "E:MYDATA.TXT")
40 PRINT TXTDATA$

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 539
Events

Events
This section explains how to capture and trigger internal events in the printer. Here’s a quick
list of these commands:

Available Events A table that correlates a ZBI event with an identification number.

ZBI Key Names Details the names of each printer’s front panel buttons, ZBI names, and
ZBI event ID.

REGISTEREVENT Sets up the HANDLEEVENT function to receive notification when the

specified event has occurred.

UNREGISTEREVENT Allows events that are currently set to be captured by the program to
no longer be captured.

HANDLEEVENT Once events have been registered, this function is used to see what events
have occurred.

TRIGGEREVENT Allows for front panel buttons to be triggered programatically.

There are certain events in the printer that a ZBI 2.0 program can receive. To do this, the
program first registers for the event. On a regular basis, call a function to handle events. When
an event occurs that the program is registered for, the function will return the event’s
identification number.

6/8/10 Zebra Programming Guide P1012728-004

540 ZBI Commands
Events

Available Events

ZBI
ZBI Event
Event ID
1 menu key
2 pause key
3 feed key
4 cancel key
5 up arrow key
6 plus key
7 minus key
8 enter key
9 setup exit key
10 select key
11 cancel all event
12 config label
13 timer1
14 timer2
15 timer3
16 timer4
17 timer5
18 spare unused
19 previous key
20 next save key
21 calibrate key
22 paper out set
23 paper out clear
24 ribbon out set
25 ribbon out clear
26 head too hot set
27 head too hot clear
28 head cold set
29 head cold clear
30 head open set
31 head open clear
32 supply too hot set
33 supply too hot clear
34 ribbon in set
35 ribbon in clear
36 rewind full set
37 rewind full clear
38 cutter jammed set
39 cutter jammed clear

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 541
Events

ZBI
ZBI Event
Event ID
40 paused set
41 paused clear
42 pq completed set
43 pq completed clear
44 label ready set
45 label ready clear
46 head element bad set
47 head element bad clear
48 basic runtime set
49 basic runtime clear
50 basic forced set
51 basic forced clear
52 power on set
53 power on clear
54 clean printhead set
55 clean printhead clear
56 media low set
57 media low clear
58 ribbon low set
59 ribbon low clear
60 replace head set
61 replace head clear
62 battery low set
63 battery low clear
64 rfid error set
65 rfid error clear
66 any messages set
67 any messages clear
68 auto baud
69 factory default
70 networking default
71 networking factory
72 print width
73 darkness adjust
74 calibrate
75 scroll key

6/8/10 Zebra Programming Guide P1012728-004

542 ZBI Commands
Events

ZBI Key Names

This section details the names to use for each printer’s front panel buttons when creating
ZBI 2.0 programs to capture the buttons.

Xi4/RXi4/XiIIIPlus/PAX4/105SL

XiIIIPlus/PAX4/Xi4/RXi4 105SL ZBI

ZBI Name
Front Panel Key Front Panel Key Event ID
Right Oval Plus (+) 6 plus key
Left Oval Minus (-) 7 minus key
Previous 19 previous key
Next/Save 20 next save key
Setup/Exit 9 setup exit key
Pause 2 pause key
Feed 3 feed key
Cancel 4 cancel key
Calibrate 21 calibrate key

HC100

ZBI
Front Panel Key ZBI Name
Event ID
Pause pause key
Feed feed key
Eject eject key

ZM400/ZM600/RZ400/RZ600/Z4Mplus/Z6Mplus

ZBI
Front Panel Key ZBI Name
Event ID
Feed 3 feed key
Pause 2 pause key
Cancel 4 cancel key
Setup/Exit 9 setup exit key
Select 10 select key
Plus (+) 6 plus key
Minus (-) 7 minus key

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 543
Events

S4M

ZBI
Front Panel Key ZBI Name
Event ID
Menu 1 menu key
Enter 8 enter key
Cancel 4 cancel key
Feed 3 feed key
Pause 2 pause key
Left Arrow 4 cancel key
Right Arrow 3 feed key
Up Arrow 5 up arrow key
Down Arrow 2 pause key

G-Series

ZBI
Front Panel Key ZBI Name
Event ID
Feed key 3 Feed key
Select key 10 Select key
Scroll key 75 Scroll key

2824 Plus Series

ZBI
Front Panel Key ZBI Name
Event ID
Feed key 3 Feed key

KR403

ZBI
Front Panel Key ZBI Name
Event ID
Feed key 3 Feed key

6/8/10 Zebra Programming Guide P1012728-004

544 ZBI Commands
Events

REGISTEREVENT
Description This function will set up the HANDLEEVENT function to receive notification
when the specified event has occurred. Events can be registered for one time or until the
program is exited.

Important • If an event occurs twice or more before the HANDLEEVENT function is called,
only one event will be received.

Format
REGISTEREVENT(X)
REGISTEREVENT(X,Y)
REGISTEREVENT(X,Y,Z)

Parameters
(X) = This is the ID of the event being registered for.
(Y) = If Y=1: the event happens once; If Y=0: the event stays registered for the duration
of the program, or until it is unregistered.
(Z) = For System Events: if Z=0, the event will still be handled by the printer. If Z=1,
then only ZBI will receive the event.
For Timer Events: this is the timer interval in mSec. If the interval is less than 0 or greater
than 1,000,000,000, it is set to 1000.

Returns The ID of the successfully registered event. If an event was not successfully
registered, a -1 is returned.

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 545
Events

Example • Here is an example of how to use the REGISTEREVENT command:

1 REM This example shows how to override the functionality of the feed
1 REM key
1 REM using the event system. After all why waste a label when you
1 REM could put
1 REM valuable information there
AUTONUM 1,1
CLOSE ALL
LET ZPLPORT = 1
OPEN #ZPLPORT: NAME "ZPL"
LET FEEDKEY = 3
LET TMP = REGISTEREVENT(FEEDKEY, 0, 1)
DO WHILE 1 = 1
LET EVT = HANDLEEVENT()
IF EVT = FEEDKEY THEN
GOSUB PRINTINFO
END IF
SLEEP 1
LOOP
REM **** SUBROUTINE PRINTINFO *** expects ZPLPORT *******
SUB PRINTINFO
PRINT #ZPLPORT: "^XA"
PRINT #ZPLPORT: "^FO30,30^A0N,50,50^FDZebra Technologies^FS"
PRINT #ZPLPORT: "^FO30,85^A0N,35,35^FDwww.zebra.com^FS"
PRINT #ZPLPORT: "^FO30,125^A0N,35,35^FDsupport.zebra.com^FS"
PRINT #ZPLPORT: "^FO30,165^A0N,35,35^FDFW Version: "
PRINT #ZPLPORT: GETVAR$("appl.name") & "^FS"
PRINT #ZPLPORT: "^FO30,205^A0N,35,35^FDPrinter Unique ID:"
PRINT #ZPLPORT: GETVAR$("device.unique_id") & "^FS"
PRINT #ZPLPORT: "^FO30,245^A0N,35,35^FDActive Network: "
PRINT #ZPLPORT: GETVAR$("ip.active_network") & "^FS"
PRINT #ZPLPORT: "^FO30,285^A0N,35,35^FDZBI Memory Usage: "
PRINT #ZPLPORT: GETVAR$("zbi.start_info.memory_alloc") & "^FS"
PRINT #ZPLPORT: "^FO30,325^A0N,35,35^FDOdometer: "
PRINT #ZPLPORT: GETVAR$("odometer.total_print_length") & "^FS"
PRINT #ZPLPORT: "^XZ"

Comments None

6/8/10 Zebra Programming Guide P1012728-004

546 ZBI Commands
Events

UNREGISTEREVENT
Description This function allows events that are currently set to be captured by the
program to no longer be captured. Once called events will return to the normal method of
processing if the REGISTEREVENT function Z parameter was set to 1.

Format UNREGISTEREVENT(X)

Parameters (X) = the ID of the event to stop

Returns 0 if the event is a valid event to unregister. A -1 if the event does not exist.

Example • Here is an example of how to use the UNREGISTEREVENT command:

AUTONUM 1,1
LET OUTSTR$ = "Processing"
LET LOOPCTR = 200
LET TIMER5 = 17
LET TMP = REGISTEREVENT(TIMER5, 0, 1000)
DO WHILE LOOPCTR > 0
LET EVT = HANDLEEVENT()
IF EVT = TIMER5 THEN
LET A = SETVAR("device.frontpanel.line2",OUTSTR$)
LET OUTSTR$ = OUTSTR$ & "."
IF LEN(OUTSTR$) >16 THEN
LET OUTSTR$ = "Processing"
END IF
END IF
LET LOOPCTR = LOOPCTR - 1
SLEEP 1
LOOP
LET TMP = UNREGISTEREVENT(TIMER5)
LET A = SETVAR("device.frontpanel.line2","")
END

Comments None

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 547
Events

HANDLEEVENT
Description Once events have been registered, this function is used to see what events
have occurred.

Format HANDLEEVENT()

Parameters N/A

Returns The ID of the event that occurred. One event at a time will be returned through this
function. The order of the events are based on priority. The priority is based on the ID number
of the event, with the exception of the timer events, which have the highest priority.

Example • Here are examples of how to use the HANDLEEVENT command:

1 REM This example shows how to override the feed key functionality
1 REM using the event system. Why waste a label when you could put
1 REM valuable information there
AUTONUM 1,1
CLOSE ALL
LET ZPLPORT = 1
OPEN #ZPLPORT: NAME "ZPL"
LET FEEDKEY = 3
LET TMP = REGISTEREVENT(FEEDKEY, 0, 1)
DO WHILE 1 = 1
LET EVT = HANDLEEVENT()
IF EVT = FEEDKEY THEN
GOSUB PRINTINFO
END IF
SLEEP 1
LOOP
REM ******** SUBROUTINE PRINTINFO ***
REM *** expects ZPLPORT *************
SUB PRINTINFO
PRINT #ZPLPORT: "^XA"
PRINT #ZPLPORT: "^FO30,30^A0N,50,50";
PRINT #ZPLPORT: "^FDZebra Technologies^FS"

6/8/10 Zebra Programming Guide P1012728-004

548 ZBI Commands
Events

PRINT #ZPLPORT: "^FO30,85^A0N,35,35";

PRINT #ZPLPORT: "^FDwww.zebra.com^FS"
PRINT #ZPLPORT: "^FO30,125^A0N,35,35";
PRINT #ZPLPORT: "^FDsupport.zebra.com^FS"
PRINT #ZPLPORT: "^FO30,165^A0N,35,35";
PRINT #ZPLPORT: "^FDFW Version: ";
PRINT #ZPLPORT: GETVAR$("appl.name") & "^FS"
PRINT #ZPLPORT: "^FO30,205^A0N,35,35";
PRINT #ZPLPORT: "^FDPrinter Unique ID:";
PRINT #ZPLPORT: GETVAR$("device.unique_id") & "^FS"
PRINT #ZPLPORT: "^FO30,245^A0N,35,35";
PRINT #ZPLPORT: "^FDActive Network: ";
PRINT #ZPLPORT: GETVAR$("ip.active_network") & "^FS"
PRINT #ZPLPORT: "^FO30,285^A0N,35,35";
PRINT #ZPLPORT: "^FDZBI Memory Usage: ";
PRINT #ZPLPORT: GETVAR$("zbi.start_info.memory_alloc") & "^FS"
PRINT #ZPLPORT: "^FO30,325^A0N,35,35";
PRINT #ZPLPORT: "^FDOdometer: ";
PRINT #ZPLPORT: GETVAR$("odometer.total_print_length") & "^FS"
PRINT #ZPLPORT: "^XZ"

Comments None

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 549
Events

TRIGGEREVENT
Description This function allows for front panel buttons to be triggered programatically.

Format TRIGGEREVENT(X)

Parameters
X = the ID of the event from the possible event list to TRIGGER.
See the following printer tables for events that can be triggered by this command:
• Xi4/RXi4/XiIIIPlus/PAX4/105SL on page 542
• 105SL Front Panel Key on page 542
• ZM400/ZM600/RZ400/RZ600/Z4Mplus/Z6Mplus on page 542
• S4M on page 543

Returns Always returns 0.

Example • Here are examples of how to use the TRIGGEREVENT command:

1 REM THIS IS AN EXAMPLE OF HOW TO TRIGGER AN EVENT
AUTONUM 1,1
LET PAUSEKEY = 2
DO WHILE 1 = 1
LET A = TRIGGEREVENT(PAUSEKEY)
LET A = SETVAR("device.frontpanel.line2",str$(A))
SLEEP 2
LOOP

Comments None

6/8/10 Zebra Programming Guide P1012728-004

550 ZBI Commands
Systems

Systems
This section contain miscellaneous systems interface functions. Here’s a quick list of these
commands:

ISERROR Returns a non-zero value if there is an internal error set in the printer.

ISWARNING Returns a non-zero value if there is an internal warning set in the printer.

SLEEP Specifies the time that the interpreter pauses.

SETERR Sends a message to the printer to set the error flag.

CLRERR Sends a message to the printer to clear the error flag.

ON ERROR Prevents a program from halting in the event of an error.

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 551
Systems

ISERROR
Description This function returns a non-zero value if there is an internal error set in the
printer. Otherwise, the numeral returned will 0.

Format ISERROR

Parameters N/A

Returns 0 for no errors; 1 if there is an error.

Example • Here is an example of the ISERROR command.

10 PRINT ISERROR
RUN
0

Comments None

6/8/10 Zebra Programming Guide P1012728-004

552 ZBI Commands
Systems

ISWARNING
Description This function returns a non-zero value if there is an internal warning set in the
printer. Otherwise, the numeral returned will 0.

Format ISWARNING

Parameters N/A

Returns 0 for no errors; 1 if there is an error.

Example • Here is an example of the ISWARNING command.

10 PRINT ISWARNING
RUN
0

Comments None

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 553
Systems

SLEEP
Description This command specifies the time that the interpreter pauses. This command
could be sent to the printer after sending a label format to be printed. The interpreter pauses in
its processing for the amount of time specified.

Format SLEEP <A>

Parameters <A> = the time in seconds (0 to 500) the interpreter pauses.

Example • This is an example of how to use the SLEEP command:

10 SLEEP 450

Comments If a timer is needed, use the Event system. The timer will allow for processing
other items, where SLEEP will stop execution of any ZBI commands for the specified SLEEP
period.

This is a program command and must be preceded by a line number.

Calling SLEEP with <A> set to zero will force the ZBI task to yield to the rest of the system
and allow any pending tasks to run (e.g., pending ZPL commands). If there are no pending
tasks, ZBI will sleep for a minimum of 8 milliseconds.

6/8/10 Zebra Programming Guide P1012728-004

554 ZBI Commands
Systems

SETERR
Description This command sends a message to the printer to set the error flag. A logical
interpreter flag is triggered in the printer. This error is referenced as a BASIC Forced Error.

Format SETERR

Parameters N/A

Example • An example of the SETERR and CLRERR commands.

AUTONUM 1,1
OPEN #1:NAME "ZPL"
PRINT #1: "^XA^SXO,A,Y,Y^XZ"
CLOSE #1
FOR I=1 TO 10
SLEEP 5
IF MOD(I,2)=1 THEN
SETERR
ELSE
CLRERR
ENDIF
NEXT I

Comments This is a program command and must be preceded by a line number.

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 555
Systems

CLRERR
Description This command sends a message to the printer to clear the error flag. A logical
interpreter flag is cleared in the printer. This error is referenced as a BASIC Forced Error.

Format 10 CLRERR

Parameters N/A

Example • See SETERR on page 554.

Comments This is a program command that is preceded by a line number.

6/8/10 Zebra Programming Guide P1012728-004

556 ZBI Commands
Systems

ON ERROR
Description The ON ERROR command can be used to prevent a program from halting in
the event of an error. If an error occurs in a previous line during program execution, the ON
ERROR statement calls the GOTO or GOSUB statement and allows the program to continue.

Format
ON ERROR GOTO <A>
ON ERROR GOSUB <A>

Parameters <A> = the destination location in the program should an error be triggered on
the previous line.

Example • This is an example of how to use the ON ERROR command:

30 LET A = B/C
40 ON ERROR GOTO 100
...
100 PRINT "DIVIDE BY ZERO OCCURRED"
110 LET A = 0
120 GOTO 50
...
Example • See TCP Server on page 522 or UDP Server on page 524.

Comments

If there is no error, this line is ignored.

This is a program command that is preceded by a line number.

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 557
Systems

Applicator Functions
The printer applicator port option can be controlled in part or completely by ZBI 2. When ZBI
takes control of a pin, the printer’s built-in applicator functionality will not have access to that
pin. This function will allow the printer to perform some of the functionality that a
programmable logic controller (PLC) could.

AUXPORT_STEALPIN Takes control of a pin and allows ZBI to perform other actions on
the pin.

AUXPORT_SETPIN Sets the output level on an applicator pin.

AUXPORT_GETPIN Retrieves the state of the applicator pin.

AUXPORT_RELEASEPIN Returns a pin controlled by ZBI to normal printer operation.

6/8/10 Zebra Programming Guide P1012728-004

558 ZBI Commands
Systems

AUXPORT_STEALPIN
Description This function will take control of a pin and allow ZBI to perform other actions
on the pin.

Format AUXPORT_STEALPIN(X)

Parameters X = perform action on this applicator port pin.

Returns This function returns -1 upon failure and 0 upon success.

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 559
Systems

Example • This is an example of the AUXPORT_STEALPIN command:

1 REM Demo applicator to show control of applicator pins
1 REM on the printer
1 REM The application is to create a light pole with an
1 REM external feed button
AUTONUM 1,1
LET RED = 9
LET YELLOW = 10
LET GREEN = 11
LET BUTTON = 4
LET FEED_KEY = 3
LET TMP = AUXPORT_STEALPIN(RED)
LET TMP = AUXPORT_STEALPIN(YELLOW)
LET TMP = AUXPORT_STEALPIN(GREEN)
LET TMP = AUXPORT_STEALPIN(BUTTON)
DO WHILE 1 = 1
SLEEP 1
IF ISERROR = 1 THEN
LET TMP = AUXPORT_SETPIN(RED,1)
LET TMP = AUXPORT_SETPIN(YELLOW,0)
LET TMP = AUXPORT_SETPIN(GREEN,0)
ELSE IF ISWARNING = 1 THEN
LET TMP = AUXPORT_SETPIN(RED,0)
LET TMP = AUXPORT_SETPIN(YELLOW,1)
LET TMP = AUXPORT_SETPIN(GREEN,0)
ELSE
LET TMP = AUXPORT_SETPIN(RED,0)
LET TMP = AUXPORT_SETPIN(YELLOW,0)
LET TMP = AUXPORT_SETPIN(GREEN,1)
END IF
IF AUXPORT_GETPIN(BUTTON) = 1 THEN
LET A = TRIGGEREVENT(FEED_KEY)
END IF
LOOP

Comments If this pin is not controlled via ZBI (power pin), this function will return -1.

6/8/10 Zebra Programming Guide P1012728-004

560 ZBI Commands
Systems

AUXPORT_SETPIN
Description This function sets the output level on an applicator pin.

Format AUXPORT_SETPIN(X,Y)

Parameters
X = perform action on this applicator port pin.
Y = The value to set on the pin (1 = high, 0 = low).

Returns This function returns -1 upon failure and 0 upon success.

Example • See AUXPORT_STEALPIN on page 558.

Comments If this pin is not controlled via ZBI (power pin), this function will return -1. See
AUXPORT_STEALPIN on page 558.

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 561
Systems

AUXPORT_GETPIN
Description This function will retrieve the state of the applicator pin.

Format AUXPORT_GETPIN(X)

Parameters X = perform action on this applicator port pin.

Returns This function returns 1 if pin is in high state, 0 in low state, and -1 upon failure.

Example • See AUXPORT_STEALPIN on page 558.

Comments If this pin is not controlled via ZBI (power pin), this function will return -1. See
AUXPORT_STEALPIN on page 558.

6/8/10 Zebra Programming Guide P1012728-004

562 ZBI Commands
Systems

AUXPORT_RELEASEPIN
Description This function returns a pin controlled by ZBI to normal printer operation.

Format AUXPORT_RELEASEPIN(X)

Parameters X = perform action on this applicator port pin.

Returns This function returns -1 upon failure and 0 upon success.

Example • This is an example of the AUXPORT_RELEASEPIN command:

90 LET TMP = AUXPORT_RELEASEPIN(X)

Comments If this pin is not controlled via ZBI (power pin), this function will return -1. See
AUXPORT_STEALPIN on page 558.

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 563
String Functions

String Functions
This section identifies how to handle string manipulation. Here is a quick list of these
commands:

LCASE$ Converts a string to all lowercase characters.

CHR$ Takes a value between 0 and 255 and puts that value into a string.

LTRIM$ Removes leading spaces from a string.

REPEAT$ Creates multiple copies of a string combined into a new string.

RTRIM$ Returns a string with trailing spaces removed

SPLIT Splits a string into sub-strings

SPLITCOUNT Returns the number of sub-strings that would be returned by the SPLIT
function.

UCASE$ Converts a string to all uppercase characters

EXTRACT$ Searches for a string based on a starting and ending string.

ORD Returns the ASCII value of the first character of string A$.

POS Returns the location of the first occurrence of a search string in the target string.

LEN Returns the length of a string.

6/8/10 Zebra Programming Guide P1012728-004

564 ZBI Commands
String Functions

LCASE$
Description This function will convert a string to all lowercase characters.

Format LCASE$ (A$)

Parameters (A$) = the string that will be converted

Returns The characters in A$ converted to lowercase.

Example • This is an example of how to use the LCASE$ command.

10 LET B$=LCASE$ ("Hello World")
20 PRINT B$
RUN
hello world

Comments This will only work on non-accented Latin characters, A-Z.

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 565
String Functions

CHR$
Description This function takes a value between 0 and 255 and puts that value into a string.

Format CHR$(VAL)

Parameters (VAL)= The numeric value of the string character.

Returns A single character string containing the value entered.

Example • This is an example of how to use the CHR$ command to easily put control
characters into strings:
10 LET NULL$=CHR$(0)
20 LET STX$=CHR$(2)
30 LET ETX$=CHR$(3)
40 LET EOT$=CHR$(4)

Comments None

6/8/10 Zebra Programming Guide P1012728-004

566 ZBI Commands
String Functions

LTRIM$
Description This function removes leading spaces from a string.

Format LTRIM$(A$)

Parameters (A$) = the string to convert.

Returns The string in A$ with no spaces.

Example • This is an example of how to use the LTRIM$(A$)command:

10 LET A$=" Hello"
20 PRINT LTRIM$(A$)
RUN
Hello

Comments None

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 567
String Functions

REPEAT$
Description This function creates multiple copies of a string combined into a new string.

Format REPEAT$(A$,M)

Parameters
A$ = the base string to duplicate
M = the number of times to duplicate A$

Returns A string containing M copies of A$. Note: When M=0, an empty string is returned.

Example • This is an example of how to use the REPEAT$(A$,M)command:

10 PRINT REPEAT$("Hello",3)
RUN
HelloHelloHello

Comments None

6/8/10 Zebra Programming Guide P1012728-004

568 ZBI Commands
String Functions

RTRIM$
Description This function returns a string with trailing spaces removed.

Format RTRIM$(A$)

Parameters (A$) = the base string

Returns A$ with trailing spaces removed.

Example • This is an example of how to use the RTRIM$(A$)command:

10 LET A$="Hello "
20 LET B$="World"
30 PRINT A$ & B$
40 PRINT RTRIM$(A$)& B$
RUN
Hello World
HelloWorld

Comments None

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 569
String Functions

SPLIT
Description This function allows a string to be split into sub-strings

Format
SPLIT(DEST$,SOURCE$,DELIMITER$)
SPLIT(DEST$,SOURCE$,DELIMITER$,MAXCOUNT)

Parameters
DEST$ = the array to populate with the sub-strings created by the split
SOURCE$ = the string that will be searched for the provided delimiter
DELIMITER$ = the delimiter string (may be more than one character) to search for
MAXCOUNT = the maximum number of sub-strings the string should be split into. A
negative value will return every sub-string created by the split. A value of zero will return
empty strings in the array. If not specified, the limit will be the maximum size of the array.

Returns The number of sub-strings placed into the DEST$ array. If the number of sub-
strings is less than the size of DEST$, the remaining elements of the array will be set to empty
strings.

Example • This is an example of how to use the SPLIT command:

1 REM Example - This example show how the SPLIT and SPLITCOUNT
1 REM commands can be
1 REM used to merge a comma separated variable string(CSV)
1 REM into a stored format
AUTONUM 1,1
SLEEP 10
DECLARE STRING TESTDATA$(5)
REM data format = <Format Name>,<VAR 1>,<VAR 2>,...,<VAR N>
LET TESTDATA$(1) = "E:PRICETAG.ZPL,FRED'S OATS,$1.25,C:126789:325,123456789"
LET TESTDATA$(2) = "E:PRICETAG.ZPL,FRED'S OATS,$2.25,C:126789:325,123456789"
LET TESTDATA$(3) = "E:PRICETAG.ZPL,FRED'S OATS,$3.25,C:126789:325,123456789"
LET TESTDATA$(4) = "E:PRICETAG.ZPL,FRED'S OATS,$4.25,C:123489:325,123456789"
LET TESTDATA$(5) = "E:PRICETAG.ZPL,FRED'S OATS,$5.25,C:123459:325,123456789"
LET ZPLPORT = 2
OPEN #ZPLPORT: NAME "ZPL"
FOR T = 1 TO 5
LET DATA$ = TESTDATA$(T)
GOSUB CSVPRINTER
NEXT T
END

6/8/10 Zebra Programming Guide P1012728-004

570 ZBI Commands
String Functions

REM ******* Subroutine CSVPRINTER, expects DATA$ and ZPLPORT ****************

SUB CSVPRINTER
LET CNT = SPLITCOUNT(DATA$, ",")
DECLARE STRING SPLITSTRING$(CNT)
ON ERROR GOTO RECOVERY
LET CNT = SPLIT(SPLITSTRING$,DATA$,",")
PRINT #ZPLPORT: "^XA^XF";SPLITSTRING$(1);"^FS"
IF CNT >= 2 THEN
FOR I = 2 TO CNT
PRINT #ZPLPORT: "^FN";I-1;"^FD";SPLITSTRING$(I);"^FS"
NEXT I
END IF
PRINT #ZPLPORT: "^XZ"
SUB RECOVERY
RETURN

Example • This is an example of how to use the SPLIT command:

1 REM Example - Shows how the SPLIT and SPLITCOUNT commands can be used to
1 REM merge a comma separated variable string(CSV) into a stored format
AUTONUM 1,1
SLEEP 10
DECLARE STRING TESTDATA$(5)
REM data format = <Format Name>,<VAR 1>,<VAR 2>,...,<VAR N>
LET F$="E:PRICETAG.ZPL"
LET TESTDATA$(1) = F$&",FRED'S ROLLED OATS,$1.25,C:123456789:325,123456789"
LET TESTDATA$(2) = F$&",FRED'S ROLLED OATS,$2.25,C:123456789:325,123456789"
LET TESTDATA$(3) = F$&",FRED'S ROLLED OATS,$3.25,C:123456789:325,123456789"
LET TESTDATA$(4) = F$&",FRED'S ROLLED OATS,$4.25,C:123456789:325,123456789"
LET TESTDATA$(5) = F$&",FRED'S ROLLED OATS,$5.25,C:123456789:325,123456789"
LET ZPLPORT = 2
OPEN #ZPLPORT: NAME "ZPL"
FOR T = 1 TO 5
LET DATA$ = TESTDATA$(T)
GOSUB CSVPRINTER
NEXT T
END
REM ******* Subroutine CSVPRINTER, expects DATA$ and ZPLPORT *****************
SUB CSVPRINTER
LET CNT = SPLITCOUNT(DATA$, ",")
DECLARE STRING SPLITSTRING$(CNT)
ON ERROR GOTO RECOVERY
LET CNT = SPLIT(SPLITSTRING$,DATA$,",")
PRINT #ZPLPORT: "^XA^XF";SPLITSTRING$(1);"^FS"
IF CNT >= 2 THEN
FOR I = 2 TO CNT
PRINT #ZPLPORT: "^FN";I-1;"^FD";SPLITSTRING$(I);"^FS"
NEXT I
END IF
PRINT #ZPLPORT: "^XZ"
SUB RECOVERY
RETURN

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 571
String Functions

Comments If the delimiter is an empty string, or does not appear in the SOURCE$ string,
the first entry of the array will be the source string and all other elements will be empty strings.

When the SPLIT function encounters a delimiter at the beginning or end of the source string,
or two delimiters in a row, it populates the corresponding array element with an empty string.

If MAXCOUNT is larger than the number of returned sub-strings (N), the last MAXCOUNT - N
array elements will be empty strings. If MAXCOUNT is larger than the destination array or is
negative, the size of the array will be used as the MAXCOUNT. Therefore, the smallest value
among the value of MAXCOUNT, the size of the return array, or the number of sub-strings found
determines the maximum number of sub-strings that will be returned.

If MAXCOUNT is less than the number of delimiters in a string the last string in the array will
hold the end of the string starting from where the last delimiter was found. For example, if
SOURCE$ = "one,two,three,four,five", DELIMITER$ = ",", and MAXCOUNT = 2, the output
would be two strings: "one" and "two,three,four,five".

If a two dimensional array is provided for DEST$, the array will be filled linearly. For
example, an array that is 2 x 3 (for example, DELCARE STRING MYARRAY$(2,3)) will be
filled from (0,0), then (0,1) up to (2,3).

6/8/10 Zebra Programming Guide P1012728-004

572 ZBI Commands
String Functions

SPLITCOUNT
Description This function returns the number of sub-strings that would be returned by the
SPLIT function.

Format SPLITCOUNT(SOURCE$, DELIMITER$)

Parameters
SOURCE$ = the string that will be searched for the provided delimiter.
DELIMITER$ =5

Returns The number of sub-strings that would be returned by the SPLITCOUNT function.

Example • This function shows how to determine the number of sub-strings that the
SPLITCOUNT command would produce
10 LET CNT = SPLITCOUNT("ONE,,,FOUR,FIVE,,SEVEN,", ",")
20 PRINT "Number of sub-strings returned is", STR$(CNT)
RUN
Number of sub-strings returned is 8

Comments None

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 573
String Functions

UCASE$
Description This function converts a string to all uppercase characters.

Format UCASE$(A$)

Parameters A$ = the base string to convert

Returns A$ converted to uppercase.

Example • This is an example of how to use the UCASE$(A$)command:

10 LET A$="Zebra Technologies"
20 PRINT UCASE$(A$)
RUN
ZEBRA TECHNOLOGIES

Example • This is an example of how to capitalize a line.

10 LET A$="The Cow jUmped Over THE Moon."
20 LET A$=LCASE$(A$)
30 LET A$(1:1)=UCASE$(A$(1:1))
40 PRINT A$
RUN
The cow jumped over the moon.

Comments This will only convert non-accented Latin characters, a-z.

6/8/10 Zebra Programming Guide P1012728-004

574 ZBI Commands
String Functions

EXTRACT$
Description This function searches for a string based on a starting and ending string. When
these two strings are found, the string between them is returned.

Important • If the EXTRACT$ command encounters a carriage return line feed before
encountering the beginning character or the ending character, it returns null.

Format
EXTRACT$ (CHANNEL, START$, STOP$)
EXTRACT$ (A$, START$, STOP$)

Parameters
CHANNEL = extracts data from this channel
A$ = the source string
START$ = Once this string is found, the extract pulls characters immediately following.
STOP$ = the extraction stops when this string is found

Example • This example shows how to extract the word Technologies from this string:
Zebra,Technologies,Corporation.
This is what the program looks like to accomplish this:
10 LET A$ = "Zebra,Technologies,Corporation,"
20 LET DATA$ = EXTRACT$(A$,",",",")

Example • This example shows how the EXTRACT$ command works from an open port:
10 OPEN #1: NAME "SER"
20 LET DATA$ = EXTRACT$(1,",",",")
Notice how the quotes are used to show a literal character, in this case a comma.

Example • This example shows how the start and stop points are variable; a variable name is
used instead of the literal:
10 LET B$ = ","
20 LET A$ = "Zebra,Technologies,Corporation"
30 LET DATA$ = EXTRACT$(A$,B$,B$)
40 PRINT DATA$
RUN
Technologies

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 575
String Functions

Example • This example shows how an empty string can be used to extract from the start of
the input string to the end string:
10 LET IN$ = "BLAH BLAH <END>"
20 LET B$ = EXTRACT$(IN$, "", "<END>")
30 PRINT B$
RUN
BLAH BLAH

Example • This example will use an empty string to extract to the end of a line:
10 LET IN$ = "BLAH <START> THE DATA"
20 LET B$ = EXTRACT$(IN$, "<START>", "")
30 PRINT B$
RUN
THE DATA

Comments EXTRACT$ reads in and discards data until the start criteria is met. Then, all
data is returned up to the stop criteria.

6/8/10 Zebra Programming Guide P1012728-004

576 ZBI Commands
String Functions

ORD
Description This function returns the ASCII value of the first character of string A$.

Format ORD(A$)

Parameters A$ = Input string: only the first character will be used.

Returns The ASCII value of the first character.

Example • This is an example of how to use the ORD(A$)command:

10 LET A$="ABC"
20 PRINT ORD(A$)
RUN
65

Comments None

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 577
String Functions

POS
Description This function returns the location of the first occurrence of a search string in the
target string. It can be assigned an index.

Format
POS(A$,B$)
POS(A$,B$,M)

Parameters
A$ = the target string to search
B$ = the search string to find in A$
M = The index to start looking for B$. If omitted, the search will start at the beginning of
the string. M must be greater than zero.

Returns The location of the string. If the string is not found, this will return 0.

Example • This is an example of how to use the POS command:

10 LET A$="Hello World"
20 LET B$="o"
30 PRINT POS(A$,B$)
40 PRINT POS(A$,B$,1)
50 PRINT POS(A$,B$,6)
RUN
5
5
8

Comments None

6/8/10 Zebra Programming Guide P1012728-004

578 ZBI Commands
String Functions

LEN
Description This function returns the length of a string.

Format LEN(A$)

Parameters A$ = the target string from which to determine the length.

Returns The length of the string.

Example • This example identifies the length of a string. Hello World is 11 characters, as
follows:
10 LET A$="Hello World"
20 PRINT LEN(A$)
RUN
11

Comments None

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 579
Math Functions

Math Functions
This section identifies how to handle mathematical calculations. Here is a quick list of these
commands:

STR$ Converts a number to a string.

MAX Returns the greater value between two numbers.

MIN Returns the smaller value of two numbers.

MAXNUM returns the largest number permitted by this machine.

MOD Computes the remainder from division.

VAL Evaluates the number represented by a string.

INTTOHEX$ Takes a numeric value and converts it into a hexadecimal string.

HEXTOINT Converts hexadecimal strings to integers.

6/8/10 Zebra Programming Guide P1012728-004

580 ZBI Commands
Math Functions

STR$
Description This function converts a number to a string.

Format STR$(X)

Parameters X = the number to convert to a string

Returns A string representing X.

Example • This is an example of how to use the STR$(X)command:

10 LET A=53
20 PRINT STR$(A)
RUN
53

Comments None

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 581
Math Functions

MAX
Description This function returns the greater value between two numbers.

Format MAX(X,Y)

Parameters
X = the first number to compare
Y = the second number to compare

Returns The greater of X or Y.

Example • This is an example of how to use the MAX(X,Y)command:

10 LET A=-2
20 LET B=1
30 PRINT MAX(A,B)
RUN
1

Comments None

6/8/10 Zebra Programming Guide P1012728-004

582 ZBI Commands
Math Functions

MIN
Description This function returns the smaller value of two numbers.

Format MIN(X,Y)

Parameters
X = the first number to compare
Y = the second number to compare

Returns The smaller of X or Y.

Example • This is an example of how to use the MIN(X,Y)command:

10 LET A=-2
20 LET B=0
30 PRINT MIN(A,B)
RUN
-2

Comments None

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 583
Math Functions

MAXNUM
Description This function returns the largest number permitted by this machine:
2,147,483,647.

Format MAXNUM

Parameters N/A

Returns The largest number that the NUMERIC type can handle (2,147,483,647).

Example • This is an example of how to use the MAXNUM command:

10 PRINT MAXNUM
RUN
2147483647

Comments None

6/8/10 Zebra Programming Guide P1012728-004

584 ZBI Commands
Math Functions

MOD
Description This function computes the remainder from division. (This is known as the
modulus.)

Format MOD(X,Y)

Parameters
X = the value to be modulated (numerator).
Y = the base number or divisor (denominator).

Returns The remainder of the division (X/Y).

Example • This is an example of how to use the MOD(X,Y)command:

10 PRINT MOD(25,10)
20 PRINT MOD(2,1)
30 PRINT MOD(3,2)
40 PRINT MOD(9,2)
50 PRINT MOD(-2,9)
60 PRINT MOD(2,0)
RUN
5
0
1
1
-2
ERROR OCCURRED ON LINE 60:DIVIDE BY ZERO

Comments None

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 585
Math Functions

VAL
Description This function evaluates the number represented by a string.

Format VAL(A$)

Parameters A$ = This is the input string to pull the number from. Non-numbers are
ignored.

Returns The numeric representation of the string.

Example • This is an example of how to use the VAL(A$)command:

10 LET A$="123"
20 LET C=VAL(A$)
30 PRINT C
RUN
123

PRINT VAL("321A123")
321123

Comments None

6/8/10 Zebra Programming Guide P1012728-004

586 ZBI Commands
Math Functions

INTTOHEX$
Description This function will take a numeric value and convert it into a hexadecimal
string. The range of values for integers is:
-2,147,483,648 to +2,147,483,647

Format INTTOHEX$(A)

Parameters A = The numeric value to convert.

Returns A string representing the integer in hex.

Example • These print statements show the output of the INTTOHEX$ function given
different values.
PRINT INTTOHEX$(1)
1

PRINT INTTOHEX$(10)
A

PRINT INTTOHEX$(16)
10

PRINT INTTOHEX$(20)
14

PRINT INTTOHEX$(30)
1E

PRINT INTTOHEX$(100)
64

PRINT INTTOHEX$(123124)
1EOF4

PRINT INTTOHEX$(-5)
0

PRINT INTTOHEX$(-99)
0

Comments Negative values will be returned as 0.

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 587
Math Functions

HEXTOINT
Description This function will convert hexadecimal strings to integers.

Format HEXTOINT(A$)

Parameters A$ = The hex string to convert.

Returns A integer string computed from the hexadecimal string.

Example • These print statements show the output of the INTTOHEX function given
different values.
PRINT HEXTOINT("0")
0

PRINT HEXTOINT("A")
10

PRINT HEXTOINT("a")
10

PRINT HEXTOINT("1A")
26

PRINT HEXTOINT("10")
16

PRINT HEXTOINT("AaAa")
43690

PRINT HEXTOINT("AAAA")
43690

PRINT HEXTOINT("-1")
0

PRINT HEXTOINT("-A")
0

Comments Negative values will be returned as 0.

6/8/10 Zebra Programming Guide P1012728-004

588 ZBI Commands
Array Functions

Array Functions
This section describes the functions to search, resize, and query arrays.

REDIM Changes the size of an array.

INSERTROW Inserts a new row into an existing array.

DELROW Deletes a new row from an existing array

ROWSIZE Returns the number of rows in an array.

COLUMNSIZE Returns the number of columns in an array.

FIND Searches a string array for an occurrence of a sub-string.

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 589
Array Functions

REDIM
Description This command will change the dimensions of an array.

Format
REDIM <ARRAYNAME>(<SIZE>)
REDIM <ARRAYNAME>(<ROWS>,<COLUMNS>)
REDIM <ARRAYNAME$>(<SIZE>)
REDIM <ARRAYNAME$>(<ROWS>,<COLUMNS>)

Parameters
<SIZE> = new number of entries in a single dimension array.
<ROWS> = new number of rows in a two dimensional array.
<COLUMNS> = new number of columns in a two dimensional array.

Example • This example shows how to change a one dimensional numeric array.
10 DECLARE NUMERIC SCORES(3)
20 LET SCORES(1) = 85
30 LET SCORES(2) = 92
40 LET SCORES(3) = 98
50 REDIM SCORES(2) ! Discard the last one

Example • This example shows how to change a two dimensional string array.
10 DECLARE STRING NAMEAGES$(3,2)
20 LET NAMEAGES$(1,1) = "Abraham"
30 LET NAMEAGES$(1,2) = "Lincoln"
40 LET NAMEAGES$(2,1) = "Dwight"
50 LET NAMEAGES$(2,2) = "Eisenhower"
60 LET NAMEAGES$(3,1) = "Theodore"
70 LET NAMEAGES$(3,2) = "Roosevelt"
80 REDIM NAMEAGES$(5,2) ! Make room for more

Comments The REDIM must have the same number of dimensions as the original
declaration of the array.

If the array has two dimensions, the second array bound cannot change. It must have the same
value as the original declaration.

If REDIM makes an array smaller, elements (or rows, for a two dimensional array) at the end of
the array are discarded.

6/8/10 Zebra Programming Guide P1012728-004

590 ZBI Commands
Array Functions

If REDIM makes an array larger, elements (or rows) are added at the end of the array, and
initialized as they would be with a DECLARE.

This can be an interactive command that takes effect as soon as it is received by the printer, or
a program command that is preceded by a line number.

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 591
Array Functions

INSERTROW
Description This command will insert a new row into an existing array.

Format INSERTROW (<ARRAYNAME>, <INDEX>)

Parameters
<ARRAYNAME> = array where the row will be inserted
<INDEX> = index of the row in the array that the new row will be inserted before

Example • This example shows how to insert a row into the middle of an array.
10 DECLARE NUMERIC SCORES(3)
20 LET SCORES(1) = 85
30 LET SCORES(2) = 92
40 LET SCORES(3) = 98
50 INSERTROW(SCORES, 2)
60 LET SCORES(2) = 100

Example • This example shows how to add a row into the end of an array.
10 DECLARE NUMERIC SCORES(3)
20 LET SCORES(1) = 85
30 LET SCORES(2) = 92
40 LET SCORES(3) = 98
50 INSERTROW(SCORES, 4)
60 LET SCORES(4) = 100

Comments Inserting a row increases the size of the array by one row, and moves all the
rows from INDEX to the end of the array up one row, leaving an empty row at position
INDEX.

INDEX cannot be any larger the number of rows in the array plus one. If the number of rows
plus one is provided, the new row will be added to the end of the array.

This can be an interactive command that takes effect as soon as it is received by the printer, or
a program command that is preceded by a line number.

6/8/10 Zebra Programming Guide P1012728-004

592 ZBI Commands
Array Functions

DELROW
Description This command will delete a row from an existing array.

Format DELROW (<ARRAYNAME>, <INDEX>)

Parameters
<ARRAYNAME> = the array where the row will be deleted
<INDEX> = index of the row to delete from the array

Example • This example shows how to delete a row from the middle of an array.
10 DECLARE NUMERIC SCORES(5)
20 LET SCORES(1) = 85
30 LET SCORES(2) = 92
40 LET SCORES(3) = 98
50 LET SCORES(4) = 45
60 LET SCORES(5) = 100
70 DELROW(SCORES, 4) ! Remove the low score

Comments This decreases the size of A by one row, and moves all the rows from INDEX to
the end of the array down by one, overwriting the row at position INDEX.

INDEX cannot be any larger the number of rows in the array.

If the array only has one row, that row may not be deleted.

This can be an interactive command that takes effect as soon as it is received by the printer, or
a program command that is preceded by a line number.

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 593
Array Functions

ROWSIZE
Description This function will return the number of rows in an array.

Format
ROWSIZE(A)
ROWSIZE(A$)

Parameters
A = integer array to query for the number of rows.
A$ = string array to query for the number of rows.

Returns Returns a 0 if the variable is not an array. Returns the number of elements in the
array if the array has only one dimension. Returns the size of the first dimension if the array
has two dimensions.

Example • This example shows how to determine the number of elements in a one
dimensional string array.
10 DECLARE STRING NAMES$(3)
20 LET NAMES$(1) = "Fred"
30 LET NAMES$(2) = "Wilma"
40 LET NAMES$(3) = "Barney"
50 REDIM NAMES$(4) ! Make room for Betty
60 LET NAMES$(4) = "Betty"
70 LET NUMOFNAMES = ROWSIZE(NAMES$)
80 PRINT NUMOFNAMES

Example • This example shows how to determine the number of rows in a two dimensional
numeric array.
10 DECLARE NUMERIC SQROFTWOLOOKUP(3,2)
20 LET SQROFTWOLOOKUP (1,1) = 1
30 LET SQROFTWOLOOKUP (1,2) = 2
40 LET SQROFTWOLOOKUP (2,1) = 2
50 LET SQROFTWOLOOKUP (2,2) = 4
60 LET SQROFTWOLOOKUP (3,1) = 3
70 LET SQROFTWOLOOKUP (3,2) = 8
80 LET NUMOFSQRS = ROWSIZE(SQROFTWOLOOKUP)
90 PRINT NUMOFSQRS

6/8/10 Zebra Programming Guide P1012728-004

594 ZBI Commands
Array Functions

COLUMNSIZE
Description This function will return the number of columns in an array.

Format
COLUMNSIZE(A)
COLUMNSIZE(A$)

Parameters
A = integer array to query for the number of columns.
A$ = string array to query for the number of columns.

Returns A 0 if the variable is not an array. Returns 1 if the array has only one dimension.
Returns the size of the second dimension if the array has two dimensions.

Example • This example shows how to determine the number of elements in a one
dimensional string array.
10 DECLARE STRING NAMES$(3)
20 LET NAMES$(1) = "Fred"
30 LET NAMES$(2) = "Wilma"
40 LET NAMES$(3) = "Barney"
50 REDIM NAMES$(4) ! Make room for Betty
60 LET NAMES$(4) = "Betty"
70 LET NUMOFCOLS = COLUMNSIZE(NAMES$)
80 PRINT NUMOFCOLS

Example • This example shows how to determine the number of columns in a two
dimensional numeric array.
10 DECLARE NUMERIC SQROFTWOLOOKUP(3,2)
20 LET SQROFTWOLOOKUP (1,1) = 1
30 LET SQROFTWOLOOKUP (1,2) = 2
40 LET SQROFTWOLOOKUP (2,1) = 2
50 LET SQROFTWOLOOKUP (2,2) = 4
60 LET SQROFTWOLOOKUP (3,1) = 3
70 LET SQROFTWOLOOKUP (3,2) = 8
80 LET COLCNT = COLUMNSIZE(SQROFTWOLOOKUP)
90 PRINT COLCNT

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 595
Array Functions

FIND
Description This function will find an element of a string array that contains an identified
search string.

Format
FIND(A$, B$)
FIND(A$, B$, START)
FIND(A$, COLUMN, B$)
FIND(A$, COLUMN, B$, START)

Parameters
A$ = string array to search for B$.
B$ = string to search for within A$.
START = index within a single dimensional array, or row for a two dimensional array, to
start the search.
COLUMN = column to isolate search to in a two dimensional array. This must be supplied
if A$ is a two dimensional array.

Returns Returns a 0 if B$ is not found or if there was an error. Otherwise, returns the index
that contains the first occurrence of the string B$ (the element index for one dimensional
arrays, the row for two dimensional arrays).

Example • This example shows how to find a string in a one dimensional array.
10 DECLARE STRING NAMES$(4)
20 LET NAMES$(1) = "Fred"
30 LET NAMES$(2) = "Wilma"
40 LET NAMES$(3) = "Barney"
50 LET NAMES$(4) = "Betty"
60 LET BARNEYIX = FIND(NAMES$, "Bar")
70 PRINT "Found Barney in element "; STR$(BARNEYIX)

6/8/10 Zebra Programming Guide P1012728-004

596 ZBI Commands
Array Functions

Example • This example shows how to find a string that occurs more than once in a two
dimensional array.
10 DECLARE STRING CLOTHING$(5,2)
20 LET TYPECOL = 1
30 LET MATERIALCOL = 2
40 LET CLOTHING$(1,1) = "Gloves"
50 LET CLOTHING$(1,2) = "Knit"
60 LET CLOTHING$(2,1) = "Pants"
70 LET CLOTHING$(2,2) = "Cotton"
80 LET CLOTHING$(3,1) = "Gloves"
90 LET CLOTHING$(3,2) = "Leather"
100 LET CLOTHING$(4,2) = "Shirts"
110 LET CLOTHING$(4,2) = "Polyester"
120 LET CLOTHING$(5,2) = "Pants"
130 LET CLOTHING$(5,2) = "Denim"
140 LET GLOVEIX = 1
150 DO
160 LET GLOVEIX = FIND(CLOTHING$, TYPECOL, "Gloves", GLOVEIX)
170 IF NOT GLOVEIX = 0 THEN
180 PRINT CLOTHING$(GLOVEIX, MATERIALCOL), "gloves are available"
190 LET GLOVEIX = GLOVEIX + 1
200 END IF
210 LOOP WHILE NOT GLOVEIX = 0

Comments COLUMN must be greater than 0.

If START is given, it must be greater than 0.

FIND will match the first occurrence of B$, even if it is a substring of a string within the A$
array. For example, “Coat” will be found in both locations 1 and 4.
5 DECLARE STRING A$(5)
10 LET A$(1) = “Over Coat”
20 LET A$(2) = “Hat”
30 LET A$(3) = “Jacket”
40 LET A$(4) = “Coat”
50 LET A$(5) = “Boots”
If an exact match is needed, FIND should be called until 0 is returned or the item is found and
confirmed. To confirm, check the item against the expected item, it should match exactly. See
CSV Program on page 607 for an example showing how to do this.

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 597
Time and Date Functions

Time and Date Functions

This section describes the functions to access the real time clock option. Here is a quick list of
these commands:

DATE$ Returns the date as a string

TIME$ Returns the current time in a string.

DATE Gets the current date as a number.

TIME Gets the current time as a number.

6/8/10 Zebra Programming Guide P1012728-004

598 ZBI Commands
Time and Date Functions

DATE$
Description This function returns the date as a string.

Format DATE$

Parameters N/A

Returns The current date in string form YYYYMMDD. If the Real-Time Clock is not installed,
an empty string is returned.

Example • This is an example of how to use the DATE$ command:

10 PRINT DATE$
RUN
The result, assuming the date is January 1, 2003 is:
20030101

Example • This is another example of the DATE$ command used with the sub-string
operator to get the day of the month:
10 LET A$=DATE$(7:8)
20 IF A$ <> DATE$(7:8)
30 LET A$=DATE$(7:8)
40 IF A$="01"
50 PRINT "IT IS THE FIRST OF THE MONTH"
60 END IF
70 END IF
80 SLEEP 100
90 GOTO 20

Comments None

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 599
Time and Date Functions

TIME$
Description This function returns the current time in a string.

Format TIME$

Parameters N/A

Returns This function returns the time of day in format HH:MM:SS

(hours:minutes:seconds). If the Real-Time Clock is not installed, an empty string is returned.

Example • This is an example of how to use the TIME$command:

10 PRINT TIME$
RUN
10:00:00

Comments None

6/8/10 Zebra Programming Guide P1012728-004

600 ZBI Commands
Time and Date Functions

DATE
Description This function gets the current date as a number.

Format DATE

Parameters N/A

Returns This function returns the current date in YYYYDDD format, where YYYY is the year
and DDD is the number of days since the beginning of the year. If the Real-Time Clock is not
installed, 0 is returned.

Example • This example assumes the current date is January 1, 2003:

10 PRINT DATE
RUN
2003001

Comments None

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 601
Time and Date Functions

TIME
Description This function gets the current time as a number.

Format TIME

Parameters N/A

Returns This function returns the time past midnight (2400h) in seconds. If the Real-Time
Clock is not installed, 0 is returned.

This is an example of how to use the TIME command [assuming the time is one minute past
midnight]:
Example •
10 PRINT TIME
RUN
60

Comments None

6/8/10 Zebra Programming Guide P1012728-004

602 ZBI Commands
Set/Get/Do Interactions

Set/Get/Do Interactions
The printer’s Set/Get/Do data can be directly accessed via ZBI. For a complete listing of what
can be accessed, see SGD Printer Commands on page 627, or type the following:
! U1 getvar "allcv"

Here’s a quick list of these commands:

SETVAR Allows the direct setting of printer parameters.

GETVAR$ Retrieves printer parameters.

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 603
Set/Get/Do Interactions

SETVAR
Description SETVAR allows the direct setting of printer parameters.

Format SETVAR (PARAM$, VALUE$)

Parameters
PARAM$ = The printer parameter to set.
VALUE$ = the value to set

Returns Parameter dependent.

Example • This is an example of the SETVAR command:

AUTONUM 1,1
LET OUTSTR$ = "Processing"
LET LOOPCTR = 200
LET TIMER5 = 17
LET TMP = REGISTEREVENT(TIMER5, 0, 1000)
DO WHILE LOOPCTR > 0
LET EVT = HANDLEEVENT()
IF EVT = TIMER5 THEN
LET A = SETVAR("device.frontpanel.line2",OUTSTR$)
LET OUTSTR$ = OUTSTR$ & "."
IF LEN(OUTSTR$) >16 THEN
LET OUTSTR$ = "Processing"
END IF
END IF
LET LOOPCTR = LOOPCTR - 1
SLEEP 1
LOOP
LET TMP = UNREGISTEREVENT(TIMER5)
LET A = SETVAR("device.frontpanel.line2","")
END

Comments None

6/8/10 Zebra Programming Guide P1012728-004

604 ZBI Commands
Set/Get/Do Interactions

GETVAR$
Description This function retrieves printer parameters.

Format GETVAR$ (PARAM$)

Parameters
PARAM$ = the printer parameter to get.

Returns The value of the parameter. Refer to SGD Printer Commands on page 627 for
specific parameters.

Example • This is an example of the GETVAR$ command:

AUTONUM 1,1
LET SGDCOUNT = 7
DECLARE STRING SGDQUERY$(2,SGDCOUNT)
LET SGDQUERY$(1,1) = "appl.name"
LET SGDQUERY$(1,2) = "device.printhead.serialnum"
LET SGDQUERY$(1,3) = "internal_wired.ip.addr"
LET SGDQUERY$(1,4) = "internal_wired.ip.netmask"
LET SGDQUERY$(1,5) = "internal_wired.ip.gateway"
LET SGDQUERY$(1,6) = "internal_wired.ip.port"
LET SGDQUERY$(1,7) = "internal_wired.mac_addr"
FOR I = 1 TO SGDCOUNT
LET SGDQUERY$(2,I) = GETVAR$(SGDQUERY$(1,I))
NEXT I
OPEN #1: NAME "ZPL"
PRINT #1: "^XA"
FOR I = 1 TO SGDCOUNT
PRINT #1: "^FO50,";50*I;"^A0N,25,25^FD";SGDQUERY$(1,I);"=";
PRINT #1: SGDQUERY$(2,I);"^FS"
NEXT I
PRINT #1: "^XZ"

Comments None

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 605
Example Programs

Example Programs
The next section provides example programs of common tasks using ZBI commands.

These programs are also available for download at: http://www.zebra.com/zbi

Array Program
This program prompts a user to enter first a name; when it is entered, it is added to an array of
all names entered. The user is them prompted to enter an address, which is then added to an
array of all addresses entered. After the user enters a total or five names and addresses, the
program uses the arrays to print the entered data on five labels.

Example • This is an example of Array

1 rem ********************************************************
1 rem Zebra Technologies ZBI Sample Program
1 rem
1 rem Professional programming services are available. Please contact
1 rem [email protected] for more information.
1 rem
1 rem This is an example of using arrays to store and use data within
1 rem ZBI.
1 rem ********************************************************
1 rem close all ports except for the console
1 rem*********************************************************
10 for i = 1 to 9 step 1
20 close #i
30 next i
1 rem ********************************************************
1 rem open a port to the print engine
1 rem ******************************************************
40 open #1: name "ZPL"
1 rem ********************************************************
1 rem create string arrays five elements in size to hold names and
1 rem addresses
1 rem ********************************************************
50 declare string name$(5)
60 declare string address$(5)
1 rem ********************************************************
1 rem infinite loop to put name and address data from console into
1 rem arrays
1 rem ********************************************************

6/8/10 Zebra Programming Guide P1012728-004

606 ZBI Commands
Example Programs

70 do
80 for i = 1 to 5 step 1
90 print "PLEASE ENTER THE NAME"
1 rem ********************************************************
1 rem get data from console; input command looks for CRLF
1 rem ********************************************************
100 input name$(i)
1 rem ********************************************************
1 rem if the user inputs end or END, the program will end
1 rem ********************************************************
110 if name$(i) = "END" or name$(i) = "end" then
120 end
130 end if
140 print "PLEASE ENTER THE ADDRESS"
150 input address$(i)
160 if address$(i) = "END" or address$(i) = "end" then
170 end
180 end if
190 next i
200 for index = 1 to 5 step 1 ! For loop To Print data no label
1 rem ********************************************************
1 rem semicolon at the end prints with no CRLF
1 rem ********************************************************
210 print #1: "^XA^FO30,30^A0N,30,30^FD"&NAME$(INDEX)&"^FS";
1 rem ********************************************************
1 rem ampersand used to concatenate data into strings
1 rem ********************************************************
220 print #1: "^FO30,70^A0N,30,30^FD"&ADDRESS$(INDEX)&"^FS^XZ"
230 next index
240 loop ! loops back To Line 60
250 end

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 607
Example Programs

CSV Program
The following program will initialize and then execute continuously, repeating the same series
of operations; process events, read input from the serial port, write any processed data out to
the ZPL port, and then process the data read from the serial port.

The program first loads the CSV database E:PRODUCTS.CSV (in PROGRAMINIT
subroutine). Then, data read from the serial port is compared against the first column in the
database. If an entry is found in the first column of a row (in FINDITEM subroutine), the data
for the respective row is inserted into the ZPL format E:PRICELBL.ZPL and printed on a
label.

Example • This is an example of a CSV program.

1 REM SUBROUTINES BELOW....
2 REM
3 REM
************************************************************************
4 REM MAIN LOOP - DO NOT MODIFY
5 REM
************************************************************************
6 REM
7 GOSUB PROGRAMINIT
8 DO WHILE 1 = 1
9 GOSUB PROCESSEVENTS
10 GOSUB GETINPUT
11 GOSUB WRITEOUTPUT
12 GOSUB PROCESSDATA
13 LOOP
14 REM SUBROUTINES BELOW....
15 REM
16 REM
************************************************************************
17 REM Program Init
18 REM
************************************************************************
19 REM
20 SUB PROGRAMINIT
21 LET INPORT = 1
22 LET OUTPORT = 2
23 LET ENDLINE$ = CHR$ ( 13 ) & CHR$ ( 10 )
24 OPEN # INPORT : NAME "SER"
25 OPEN # OUTPORT : NAME "ZPL"
26 DECLARE STRING DATABASE$ ( 1 , 1 )
27 LET COLUMNCOUNT = CSVLOAD ( DATABASE$ , "E:PRODUCTS.CSV" )
28 LET OUTDATA$ = "TABLE WITH " & STR$ ( COLUMNCOUNT ) & " COLUMNS LOADED"
& ENDLINE$
29 RETURN
30 REM
31 REM

6/8/10 Zebra Programming Guide P1012728-004

608 ZBI Commands
Example Programs

Example • This is an example of a CSV program (continued).

************************************************************************
32 REM Process Events
33 REM
************************************************************************
34 REM
35 SUB PROCESSEVENTS
36 RETURN
37 REM
38 REM
************************************************************************
39 REM Get Input
40 REM
41 REM Writes All Data from the serial port to the string INDATA$
42 REM
************************************************************************
43 REM
44 SUB GETINPUT
45 IF LEN ( INDATA$ ) < 5000 THEN
46 LET INCOUNT = READ ( INPORT , A$ , 1024 )
47 LET INDATA$ = INDATA$ & A$
48 END IF
49 RETURN
50 REM
51 REM
************************************************************************
52 REM Write Output
53 REM
54 REM Writes All Data from the string OUTDATA$ to the ZPL Port
55 REM
************************************************************************
56 REM
57 SUB WRITEOUTPUT
58 LET OUTCOUNT = WRITE ( OUTPORT , OUTDATA$ , LEN ( OUTDATA$ ) )
59 IF OUTCOUNT > 0 THEN
60 LET OUTDATA$ ( 1 : OUTCOUNT ) = ""
61 END IF
62 RETURN
63 REM
64 REM

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 609
Example Programs

Example • This is an example of a CSV program (continued).

************************************************************************
***
65 REM Process Data
66 REM
67 REM Parse the data in the string INDATA$ and write output to OUTDATA$
68 REM
************************************************************************
69 REM
70 SUB PROCESSDATA
71 IF LEN ( OUTDATA$ ) > 1000 THEN
72 RETURN
73 END IF
74 REM REMOVE ALL LINE FEEDS
75 DO
76 LET LOC = POS ( INDATA$ , CHR$ ( 10 ) )
77 LET INDATA$ ( LOC : LOC ) = ""
78 LOOP WHILE LOC > 0
79 REM COMPLETED LINE FEED REMOVAL
80 LET LOC = POS ( INDATA$ , CHR$ ( 13 ) ) ! Line ends with CR
81 IF LOC > 0 THEN
82 LET INLINE$ = INDATA$ ( 1 : LOC - 1 )
83 LET INDATA$ ( 1 : LOC ) = ""
84 GOSUB FINDITEM
85 IF ROW > 0 THEN
86 LET OUTDATA$ = OUTDATA$ & "^XA^XFE:PRICELBL.ZPL^FS" & ENDLINE$
87 LET OUTDATA$ = OUTDATA$ & "^FN1^FD" & DATABASE$ ( ROW , 1 ) & "^FS" &
ENDLINE$
88 LET OUTDATA$ = OUTDATA$ & "^FN2^FD" & DATABASE$ ( ROW , 2 ) & "^FS" &
ENDLINE$
89 LET OUTDATA$ = OUTDATA$ & "^FN3^FD" & DATABASE$ ( ROW , 3 ) & "^FS^XZ"
& ENDLINE$
90 END IF
91 END IF
92 RETURN
93 REM
94 REM

6/8/10 Zebra Programming Guide P1012728-004

610 ZBI Commands
Example Programs

Example • This is an example of a CSV program (continued).

************************************************************************
95 REM Find Item
96 REM
97 REM Search the first column of the database for the exact item
requested
98 REM
************************************************************************
99 REM
100 SUB FINDITEM
101 LET ROW = 0
102 LET EXPECTED$ = INLINE$
103 DO
104 LET FOUNDENTRY$ = ""
105 LET ROW = FIND ( DATABASE$ , 1 , EXPECTED$ , ROW + 1 )
106 IF ROW <> 0 THEN
107 LET FOUNDENTRY$ = DATABASE$ ( ROW , 1 )
108 END IF
109 LOOP WHILE ( ROW <> 0 AND FOUNDENTRY$ <> EXPECTED$ )
110 RETURN

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 611
Example Programs

DPI Conversion Program

This program converts a ZPL format being sent to the printer on the parallel port to 300 dpi
(dots per inch) from 200 dpi (dots per inch). This is done by searching for and extracting ZPL
commands with resolution-dependent arguments and scaling the arguments for a 300 dpi
printer.

Example • This is an example of dpi conversion:

1 rem **************************************************
1 rem Zebra Technologies ZBI Sample Program
1 rem
1 rem Professional programming services are available. Please contact
1 rem [email protected] for more information.
1 rem
1 rem This is an example of converting a printer from 200 dpi (dots 1
rem per inch
1 rem to 300 dpi. This example covers only some of the ZPL commands 1
rem that
1 rem could be affected by converting from 200 to 300 dpi printing.
1 rem **************************************************
1 rem open the ports for input and output
1 rem **************************************************
10 close #1
20 close #2
30 open #1 : name "PAR"
40 open #2 : name "ZPL"
1 rem **************************************************
1 rem create an array with the search parameters
1 rem **************************************************
50 declare string find$(20)
60 let find$(1) = "^FO"
70 let find$(2) = "^A0"
80 let find$(3) = "^GB"
90 let find$(4) = "^XZ"
100 let find$(5) = "^A@"
110 let find$(6) = "^LL"
120 let find$(7) = "^LH"
130 let find$(8) = "FO"
140 let find$(9) = "A0"
150 let find$(10) = "GB"
160 let find$(11) = "XZ"
170 let find$(12) = "A@"
180 let find$(14) = "LH"
190 let find$(15) = "^BY"
200 let find$(16) = "BY"
210 let find$(17) = "^B3"
220 let find$(18) = "B3"

6/8/10 Zebra Programming Guide P1012728-004

612 ZBI Commands
Example Programs

1 rem *******************************************************
1 rem search for the parameters
1 rem *******************************************************
300 do
310 let in$ = searchto$(1, find$, 2)
1 rem ********************************************************
1 rem once a parameter is found, determine how to handle it
1 rem ********************************************************
320 if in$ = "^FO" or in$ = "FO" then
330 gosub 520
340 else if in$ = "^LH" or in$ = "LH" then
350 gosub 520
360 else if in$ = "^A0" or in$ = "A0" then
370 gosub 700
380 else if in$ = "^A@" or in$ = "A@" then
390 gosub 700
400 else if in$ = "^GB" or in$ = "GB" then
410 gosub 1100
420 else if in$ = "^LL" then
430 gosub 1300
440 else if in$ = "^BY" or in$ = "BY" then
450 gosub 1400
460 else if in$ = "^B3" or in$ = "B3" then
470 gosub 1600
480 else if in$ = "^XZ" then
490 print #2: in$;
500 end if
510 loop
1 rem ********************************************************
1 rem convert the ^FO and ^LH commands from 200 to 300 dpi
1 rem ********************************************************
520 inbyte #1: a$
530 let a = ord(a$)
540 if a >= 65 then
550 print #2: in$&a$;
560 goto 660
570 end if
580 let x$ = extract$(1, "", ", ")
590 let x2$ = a$&x$
600 let y$ = extract$(1, "", "^")
610 let x = val(x2$)
620 let y = val(y$)
630 let x2 = (x/2)+x
640 let y2 = (y/2)+y
650 print #2: in$; x2; ","; y2; "^";
660 return

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 613
Example Programs

1 rem ********************************************************
1 rem convert the ^A0 and ^A@ commands from 200 to 300 dpi
1 rem ********************************************************
700 inbyte #1: a$
710 let a = ord(a$)
720 let b = 0
730 let c = 0
740 if a >= 65 then
750 print #2: in$&a$; ",";
760 let b = 1
770 end if
780 inbyte #1: a$
790 let h$ = extract$(1, "", ",")
800 if in$ = "^A@" or in$ = "A@" then
810 let c = 1
820 let w$ = extract$(1, "", ",")
830 let m$ = extract$(1, "", "^")
840 else
850 let w$ = extract$(1, "", "^")
860 end if
870 let h = val(h$)
880 let w = val(w$)
900 let h2 = (h/2) + h
910 let w2 = (w/2) + w
920 if b = 1 then
930 print #2: h2; ","; w2;
940 else
950 print #2: in$&"N,"; h2; ","; w2;
960 end if
970 if c = 1 then
980 print #2: ","; m$;
990 end if
1000 print #2: "^";
1010 return
1 rem ********************************************************
1 rem convert the ^GB command from 200 to 300 dpi
1 rem ********************************************************
1020 let w$ = extract$(1, "", ",")
1030 let h$ = extract$(1, "", ",")
1040 let t$ = extract$(1, "", "^")
1050 let h = val(h$)
1060 let w = val(w$)
1070 let t = val(t$)
1080 let h2 = (h/2)+ h
1090 let w2 = (w/2)+ w
1100 let t2 = (t/2)+ t
1110 print #2: in$; w2; ","; h2; ","; t2; "^";
1120 return

6/8/10 Zebra Programming Guide P1012728-004

614 ZBI Commands
Example Programs

1 rem ********************************************************
1 rem convert the ^LL command from 200 to 300 dpi
1 rem ********************************************************
1300 let l$ = extract$(1, "", "^")
1310 let l = VAL(l$)
1320 let l2 = (l/2) + l
1330 print #2: in$; l2; "^";
1340 return
1 rem ********************************************************
1 rem convert the ^BY command from 200 to 300 dpi
1 rem ********************************************************
1400 inbyte #1: a$
1410 let a = ord(a$)
1420 if a >= 48 and a <= 57 then
1460 let x$ = extract$(1, "", ", ")
1470 let x2$ = a$&x$
1480 let x = val(x2$)
1490 let x2 = (x/2) + x
1500 if x2 > 10 then
1510 let x2 = 10
1520 end if
1530 print #2: in$; x2; ",";
1540 else
1550 print #2: in$; a$;
1560 end if
1570 return
1 rem ********************************************************
1 rem convert the ^B3 command from 200 to 300 dpi
1 rem ********************************************************
1600 let o$ = extract$(1, "", ", ")
1610 let e$ = extract$(1, "", ", ")
1620 let h$ = extract$(1, "", ", ")
1630 let h = val(h$)
1640 let h2 = (h/2) + h
1650 print #2: in$; o$; ","; e$; ","; h2; ",";
1660 return

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 615
Example Programs

Email Program
This program sends a simple email message to [email protected], assuming a valid email
server is set up by identifying the SMTP server on the print server. In order to write email via
ZBI, the port written to must be named "EML".

Example • This is an example of email

1 rem **************************************************
1 rem Zebra Technologies ZBI Sample Program
1 rem
1 rem Professional programming services are available. Please contact
1 rem [email protected] for more information.
1 rem
1 rem This is an example of connecting to an email server to send
1 rem email.
1 rem **************************************************
1 rem EOT$ is the special character used to denote end of transmission
1 rem **************************************************
5 let EOT$ = chr$(4)
1 rem **************************************************
1 rem Open a connection to the email port; if there is an error, try
1 rem again
1 rem **************************************************
10 open #1: name "EML"
15 on error goto 10
1 rem **************************************************
1 rem Specify address to send message to, signal end of recipients
1 rem with EOT$
1 rem Note: To send to multiple addressees, separate addressees with
1 rem a space
1 rem **************************************************
20 print #1: "[email protected]";EOT$;
1 rem **************************************************
1 rem Fill in the message information
1 rem **************************************************
30 print #1: "From: Sample User"
40 print #1: "To: Recipient"
50 print #1: "Subject: This is a test"
60 print #1: ""
70 print #1: "Hello!"
80 print #1: i
1 rem **************************************************
1 rem Terminate message
1 rem **************************************************
90 print #1: "";EOT$

6/8/10 Zebra Programming Guide P1012728-004

616 ZBI Commands
Example Programs

1 rem **************************************************
1 rem Close the port, since each open port is only good for sending
1 rem one message
1 rem **************************************************
100 close #1
110 sleep 2
120 let i = i + 1
130 goto 10

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 617
Example Programs

Extraction 1 Program
This program finds and stores data of interest, which in this case is found in a format after the
string "DATA = ". The extract command is used to get the data from the input stream, and it
is inserted into a simple ZPL format to be printed.

Example • This is an example of Extraction 1.

1 rem **************************************************
1 rem Zebra Technologies ZBI Sample Program
1 rem
1 rem Professional programming services are available. Please contact
1 rem [email protected] for more information.
1 rem
1 rem This is an example of using ZBI for data extraction.
1 rem There are two methods for doing extraction; this example shows
1 rem data extraction using a string.
1 rem
1 rem The data to extract is as follows:
1 rem START
1 rem DATA = "hello":
1 rem DATA = "goodbye":
1 rem END
1 rem **************************************************
1 rem close ports except console, open channels to parallel and serial
1 rem ports
1 rem **************************************************
05 for i = 1 to 9 step 1
10 close #i
20 next i
30 open #1: name "PAR"
40 open #2: name "ZPL"
1 rem **************************************************
1 rem create string array to hold data
1 rem **************************************************
50 declare string format$(3)
60 let format$(1) = "START"
70 let format$(2) = "END"
80 let format$(3) = "DATA"
1 rem **************************************************
1 rem main program; look for "START" keyword, if found print ^XA to
ZPL port
1 rem **************************************************
90 do
100 let begin$ = searchto$(1,format$,2)
110 if begin$ = "START" then
120 print #2: "^XA";

6/8/10 Zebra Programming Guide P1012728-004

618 ZBI Commands
Example Programs

1 rem **************************************************
1 rem if "DATA" keyword is found, get two data strings
1 rem **************************************************
130 else if begin$ = "DATA" then
140 input #1: data_string1$
150 input #1: data_string2$
1 rem **************************************************
1 rem get data from between quotes and print to ZPL port with
formatting
1 rem **************************************************
160 let extracted_data1$ = extract$(data_string1$,"""","""")
170 let extracted_data2$ = extract$(data_string2$,"""","""")
180 print #2:"^FO30,30^A0N,30,30^FD"&extracted_data1$&"^FS";
190 print #2:"^FO30,70^A0N,30,30^FD"&extracted_data2$&"^FS";
200 else if begin$ = "END" then
210 print #2: "^XZ"
220 end if
230 loop

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 619
Example Programs

Extraction 2 Program
This program finds and stores data of interest, which in this case is found in a format after the
string "DATA = ". The input command is used to get the data from the input stream, and it is
inserted into a simple ZPL format to be printed.

Example • This is an example of Extraction 2.

1 rem******************************************************
1 rem Zebra Technologies ZBI Sample Program
1 rem
1 rem Professional programming services are available. Please contact
1 rem [email protected] for more information.
1 rem
1 rem This is an example of using ZBI for data extraction.
1 rem There are two methods for doing extraction; this example shows
1 rem data extraction from the port directly.
1 rem
1 rem The data to extract is as follows:
1 rem START
1 rem DATA = "hello":
1 rem DATA = "goodbye":
1 rem END
1 rem******************************************************
1 rem close ports except console, open channels to parallel and serial
ports
1 rem******************************************************
05 for i = 1 to 9 step 1
10 close #i
20 next i
30 open #1: name "PAR"
40 open #2: name "ZPL"
1 rem******************************************************
1 rem create string array to hold data
1 rem*******quotes and print to ZPL port with formatting
1 rem***************************************************
50 declare string format$(3)
60 let format$(1) = "START"
70 let format$(2) = "END"
80 let format$(3) = "DATA"
1 rem******************************************************
1 rem main program; look for "START" keyword, if found print ^XA to
ZPL port
1 rem******************************************************

6/8/10 Zebra Programming Guide P1012728-004

620 ZBI Commands
Example Programs

90 do
100 let begin$ = searchto$(1, format$, 2)
110 if begin$ = "START" then
120 print #2: "^XA";
1 rem******************************************************
1 rem if "DATA" keyword is found, get two data strings
1 rem******************************************************
130 else if begin$ = "DATA" then
1 rem***************************************************
1 rem get data from between q
140 let extracted_data1$ = extract$(1,"""","""")
150 input #1: junk$
170 let extracted_data2$ = extract$(1,"""","""")
180 print #2:"^FO30,30^A0N,30,30^FD" &extracted_data1$& "^FS";
190 print #2:"^FO30,70^A0N,30,30^FD" &extracted_data2$& "^FS";
200 else if begin$ = "END" then
210 print #2: "^XZ"
220 end if
230 loop

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 621
Example Programs

Front Panel Control

This example shows how to intercept front panel button presses and write to the display to
create a simple menu. The buttons used in this demo are set up for a Z4M/Z6M,
ZM400/ZM600, or RZ400/RZ600. This could be reconfigured to work with any other printer.

Example • This is an example of front panel control.

1 REM This example shows how to override the functionality of the feed
key
1 REM and use the front panel display to show a option list
AUTONUM 1,1
REM CLOSE ALL
DECLARE STRING OPTIONS$(5)
FOR I = 1 TO 5
LET OPTIONS$(I) = "Option " & STR$(I)
NEXT I
LET ZPLPORT = 1
OPEN #ZPLPORT: NAME "ZPL"
LET FEEDKEY = 3
LET SELECTKEY = 10
LET PLUSKEY = 6
LET MINUSKEY = 7
LET EXITKEY = 9
LET TMP = REGISTEREVENT(FEEDKEY, 0, 1)
SUB NORMALLOOP
DO WHILE 1 = 1
LET EVT = HANDLEEVENT()
IF EVT = FEEDKEY THEN
LET INDEX = 1
GOSUB REGISTERKEYS
GOSUB SHOWMENU
GOTO FEEDLOOP
END IF
SLEEP 1
LOOP
SUB FEEDLOOP
DO WHILE 1 = 1
LET EVT = HANDLEEVENT()
IF EVT = FEEDKEY THEN
GOSUB RELEASEKEYS
GOSUB HIDEMENU
GOTO NORMALLOOP
ELSE IF EVT = SELECTKEY THEN
GOSUB HANDLEOPTION
ELSE IF EVT = PLUSKEY THEN
LET INDEX = INDEX + 1
IF INDEX > 5 THEN
LET INDEX = 1
END IF

6/8/10 Zebra Programming Guide P1012728-004

622 ZBI Commands
Example Programs

GOSUB SHOWMENU
ELSE IF EVT = MINUSKEY THEN
LET INDEX = INDEX - 1
IF INDEX < 1 THEN
LET INDEX = 5
END IF
GOSUB SHOWMENU
ELSE IF EVT = EXITKEY THEN
GOSUB RELEASEKEYS
GOSUB HIDEMENU
GOTO NORMALLOOP
END IF
SLEEP 1
LOOP
REM ******** SUBROUTINE SHOWMENU ***
SUB SHOWMENU
LET LINE1$ = "FEED DISPLAY"
LET LINE2$ = OPTIONS$(INDEX)
GOSUB UPDATEDISPLAY
RETURN
REM ******** SUBROUTINE HIDEMENU ***
SUB HIDEMENU
LET LINE1$ = ""
LET LINE2$ = ""
GOSUB UPDATEDISPLAY
RETURN
SUB UPDATEDISPLAY
LET A = SETVAR("device.frontpanel.line1",LINE1$)
LET A = SETVAR("device.frontpanel.line2",LINE2$)
RETURN
SUB REGISTERKEYS
LET TMP = REGISTEREVENT(SELECTKEY, 0, 1)
LET TMP = REGISTEREVENT(PLUSKEY, 0, 1)
LET TMP = REGISTEREVENT(MINUSKEY, 0, 1)
LET TMP = REGISTEREVENT(EXITKEY, 0, 1)
RETURN
SUB RELEASEKEYS
LET TMP = UNREGISTEREVENT(SELECTKEY)
LET TMP = UNREGISTEREVENT(PLUSKEY)
LET TMP = UNREGISTEREVENT(MINUSKEY)
LET TMP = UNREGISTEREVENT(EXITKEY)
RETURN
SUB HANDLEOPTION
PRINT #ZPLPORT: "^XA^FO100,100^A0N,100,100^FD"; OPTIONS$(INDEX);"^XZ"
RETURN

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 623
Example Programs

Recall Program
This program searches for a ZPL format named "FORMAT.ZPL" that is already saved in
printer memory. If the format is found, a number within the format is extracted and shown on
the console. The user is then prompted to enter a new number, which is then substituted into
the format.

Example • This is an example of Recall.zpl

1 rem ********************************************************
1 rem Zebra Technologies ZBI Sample Program
1 rem
1 rem Professional programming services are available. Please contact
1 rem [email protected] for more information.
1 rem
1 rem This is an example of recalling a ZPL format and extracting data
1 rem from it.
1 rem ********************************************************
1 rem close ports except console, open ZPL port and declare search
1 rem array
1 rem ********************************************************
10 for i = 1 to 9 step 1 ! Close all ports
20 close #i
30 next i
40 let zplport = 2
50 open #zplport: name "ZPL"
60 declare string search_zpl$(2)
70 let search_zpl$(1) = chr$(03)
80 let search_zpl$(2) = "FORMAT.ZPL"
1 rem ********************************************************
1 rem main program; look for format to recall on printer
1 rem ********************************************************
90 do
100 print #zplport: "^XA^HWE:*.ZPL^FS^XZ"
110 let present = 0
115 let find$ = ""
120 do until find$ = chr$(03)
130 let find$ = searchto$(zplport, search_zpl$)
140 if find$ = "FORMAT.ZPL" then
150 let present = 1 ! format is present
160 end if
170 loop

6/8/10 Zebra Programming Guide P1012728-004

624 ZBI Commands
Example Programs

1 rem ********************************************************
1 rem if format is not found, create a format and set data value to
1 rem 000
1 rem ********************************************************
180 if present = 0 then
190 print #zplport:"^XA^DFE:FORMAT.ZPL^FS";
200 print #zplport:"^FX000^FS^XZ"
210 let counter$ = "000"
1 rem ********************************************************
1 rem if format is found, extract the data from ^FX field
1 rem ********************************************************
220 else
230 print #zplport:"^XA^HFE:FORMAT.ZPL^FS^XZ"
240 let stop$ = searchto$(zplport, "^FX")
250 let counter$ = extract$(zplport, "", "^FS")
260 let stop$ = searchto$(zplport, "^XZ")
270 end if
1 rem ********************************************************
1 rem print current data value, prompt user to replace data
1 rem ********************************************************
280 print ""
290 print "Current number in format is " & counter$
300 print "Please enter new number (type EXIT to end) ";
310 input new_counter$
320 if new_counter$ = "EXIT" then
330 print "Program ending"
340 end
350 else
360 print #zplport:"^XA^DFE:FORMAT.ZPL^FS";
370 print #zplport:"^FX" & new_counter$ & "^FS^XZ"
380 end if
390 loop

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Commands 625
Example Programs

Scale Program
This program reads data from a scale connected to the serial port by sending a "W" to the
scale and waiting for a weight to be returned. When the weight is received, it is inserted into a
simple label format and printed.

Example • This is an example of Scale

1 rem ********************************************************
1 rem Zebra Technologies ZBI Sample Program
1 rem
1 rem Professional programming services are available. Please contact
1 rem [email protected] for more information.
1 rem
1 rem This is an example of using ZBI to read scale data from the
1 rem serial port.
1 rem ********************************************************
1 rem close all ports except console, open channels to parallel and
1 rem serial ports
1 rem ********************************************************
05 for i = 1 to 9 step 1
10 close #i
20 next i
30 open # 2 : name "SER"
40 open # 1 : name "ZPL"
1 rem ********************************************************
1 rem main program; send serial port a 'W' in order to get a weight
1 rem ********************************************************
50 do
60 do
70 sleep 1 ! sleep so scale is not bombarded with incoming
1 rem data
80 print # 2 : "W" ; ! semicolon ends sent W without a CRLF
1 rem ********************************************************
1 rem get response from scale; note that input requires a CRLF to be
1 rem entered
1 rem ********************************************************
90 input # 2 : a$
100 if a$ = "EXIT" then! back door exit - if EXIT is received, ZBI ends
110 close # 2
120 print #1: "^XZ"
130 close #1
140 end
150 end if
1 rem ********************************************************
1 rem loop until valid weight is received, then print on label
1 rem ********************************************************
160 loop while pos ( a$ , "000.00" ) = 1 or pos ( a$ , "?" ) = 1
170 print # 1 : "~SD25^XA^FS";
180 print # 1 : "^LH0,0^FS";
190 print # 1 : "^FO56,47^A0N,69,58^FDThis weighs^FS";
1 rem ********************************************************
1 rem print weight on label; & character concatenates strings
1 rem ********************************************************
200 print # 1 : "^FO56,150^A0N,69,58^FD" & A$ & " lbs^FS";
210 print # 1 : "^PQ1,0,0,N";
220 print # 1 : "^XZ"
1 rem ********************************************************
1 rem loop until weight is off scale, then repeat for next item
1 rem weighed
1 rem ********************************************************
230 do
240 print # 2 : "W" ;
250 input # 2 : A$
260 loop until pos(A$ , "000.00") = 1 or pos(A$ , "?") = 1
270 loop

6/8/10 Zebra Programming Guide P1012728-004

626 ZBI Commands
Example Programs

Notes • ___________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

P1012728-004 Zebra Programming Guide 6/8/10

 6
SGD Printer Commands

This chapter provides a high-level overview of printer setting Set / Get / Do (SGD)
commands. For printer support of these SGD commands, see SGD Command Support
on page 1019.

SGD commands are available in printers with the following firmware versions or later:
• V60.16.2Z or later • V53.15.2Z or later
• V60.15.xZ or later • R53.16.3Z or later
• V50.15.xZ or later • R60.15.8Z or later
• V61.15.xZ or later • R62.15.8Z or later
• V56.15.xZ or later • R63.15.8Z or later
• V53.16.x or later • R65.15.8Z or later

Important • These are important points to note when using ZPL and SGD commands:
• SGD commands are case-sensitive.
• ZPL and SGD commands should be sent to the printer as separate files.
• Certain settings can be controlled by both ZPL and SGD. Configuration changes made in
ZPL can affect configuration changes made in SGD.
• Changes made with one command type (ZPL or SGD) will affect the data returned to the
host in response to both ZPL and getvar commands. The command type (ZPL or SGD)
that was sent last determines the current setting.
• Some RF cards do not support all of the SGD commands.

Important • These are important points to note when using a Zebra G-Series printer:
• You can send instructions to the printer using multiple programming languages: EPL,
ZPL, or SGD. EPL and ZPL commands configure the printer, print labels, and get device
status information. SGD commands set and get configuration details. These three
languages can be used without the need to send the printer instructions to switch from one
language to another.
• EPL, ZPL, and SGD commands must be sent to the printer as separate files. They cannot
be used together in one format, or set of commands. For example, if you send a series of
SGD commands to the printer and they are followed by a printable format, this needs to
be done using separate files.

6/8/10 Zebra Programming Guide P1012728-004

628 SGD Printer Commands
Overview

Overview
This section describes how and why to use the Set / Get / Do (SGD) commands. It also
provides an example of a typical command structure.

Note • SGD commands must be terminated by a carriage return or a space and line feed.

SGD commands are commands that allow you to configure all printers with firmware versions
V60.15.xZ, V50.15.xZ, V61.15.xZ, V56.15.xZ, V53.15.xZ, or later. The printer performs the
specified function immediately after receiving the command. The commands are:
• setvar
• getvar
• do

setvar Command
Setvar commands:
• are used to configure printer settings to specific values by setting them in the printer
• must be terminated by a space character or a CR/ LF (0x0D, 0x0A)

Important • The setvar command and attributes must be specified in lower case.

getvar Command
Getvar commands:
• are used to get the current value of the printer settings
• must be terminated by a space character or CR/LF (0x0D, 0x0A)

The printer responds with the printer setting of “?” if:

• the printer setting does not exist (usually due to incorrect spelling of the printer setting)
• it has not been configured yet

Important • The printer settings and attributes must be specified in lower case.

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Printer Commands 629
Overview

do Command
Do commands:
• are used to instruct the printer to perform predefined actions
• must be terminated by a space character or a CR/LF (0x0D, 0x0A)

Some Do commands require additional settings which must be enclosed in double quotes.

Important • The values must be specified in lower case.

6/8/10 Zebra Programming Guide P1012728-004

630 SGD Printer Commands
Command Structure

Command Structure
It is important to understand the structure of the command and its components. A command
structure illustration is provided for each command in this guide.

Example • This is an example of a command structure illustration:

! U1 setvar "ip.addr" "value"

1 2 3

1 Command—always preceded with an exclamation point (!) and must be specified in

lower case. A space resides between the !and U1 and between U1 and the command
(setvar or getvar).
2 Attribute—always in double quotes and must be specified in lower case.
3 Chosen value—always in double quotes. Only applicable for setvar and do.

This command must be terminated by a space character or a CR/ LF (0x0D, 0x0A).

How to Send Multiple SGD Commands

For any getvar, setvar, or do command, if you issue the syntax without the "1" and use
the END command followed by a space, multiple SGD commands are sent simultaneously.

Example • This syntax shows how you can send multiple getvar commands:

1 ! U getvar "ip.telnet.enable"

getvar "ip.dhcp.enable"
2
getvar "ip.dhcp.cid_prefix"

3 END

1 The command portion of the string does not use the "1" after the "! U".
2 Commands issued after the first command do not require the "! U".
3 The string of commands is terminated by the word "END" with a space after the
word, and by a carriage return/ line feed.

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Printer Commands 631
appl.option_board_version

appl.option_board_version
Description This command returns the version number of the firmware running on the
wireless option board. For printer support, see SGD Command Support on page 1019.

Type getvar

Commands Details
getvar This command returns the version number of the firmware running on the wireless option
board.
Format: ! U1 getvar "appl.option_board_version"

Note • For details on SGD command structure, see Command Structure on page 630.

Example • This command returns the version number of the firmware running on the
wireless option board.
! U1 getvar "appl.option_board_version"
"0.0.0 *"

6/8/10 Zebra Programming Guide P1012728-004

632 SGD Printer Commands
appl.bootblock

appl.bootblock
Description This command refers to the bootblock version. On the configuration label, the
bootblock number is identified as the hardware ID. For printer support, see SGD Command
Support on page 1019.

Type getvar

Commands Details
getvar This command returns the bootblock version number that appears on the configuration label
.
Format: ! U1 getvar "appl.bootblock"

Note • For details on SGD command structure, see Command Structure on page 630.

Example • In this example, the getvar returns the bootblock version number.
! U1 getvar "appl.bootblock"

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Printer Commands 633
appl.name

appl.name
Description This command refers to the printer’s firmware version. For printer support, see
SGD Command Support on page 1019.

Type getvar

Commands Details
getvar This command returns the printer’s firmware version.
Format: ! U1 getvar "appl.name"

Note • For details on SGD command structure, see Command Structure on page 630.

Example • In this example, the getvar returns the printer’s firmware version.
! U1 getvar "appl.name"

6/8/10 Zebra Programming Guide P1012728-004

634 SGD Printer Commands
CISDFCRC16

CISDFCRC16
Download Files
The CISDFCRC16 command downloads supported files types to the printer. For printer
support, see SGD Command Support on page 1019.

Note • When using certificate files, your printer supports:

• Using Privacy Enhanced Mail (PEM) formatted certificate files.
• Using the client certificate and private key as two files, each downloaded separately.
• Using exportable PAC files for EAP-FAST.

Type
! CISDFCRC16
<crc>
<filename>
<size>
<checksum>
<data>

Note • For details on SGD command structure, see Command Structure on page 630.

Important • Each line should be terminated with a CR/LF.

Note • This command can be used in place of the ~DG and ~DY command for more saving
and loading options. ~DY is the preferred command to download TrueType fonts on printers
with firmware later than X.13. The CISDFCRC16 command also supports downloading
wireless certificate files.

Parameters Details
<crc> = CRC value Accepted Values: a four digit CRC value in hexadecimal. If 0000 is entered,
then the CRC validation is ignored. For examples, see below.
<filename> = file Accepted Values: file name that is stored on the printer’s file system. An
name extension must be specified. Files must be saved to the E: drive.
<size> = file size Accepted Values: an eight digit file size specified in hexadecimal which
indicates the number of bytes in the <data> section.
<checksum> = Accepted Values: a four digit checksum value in hexadecimal. If 0000 is
checksum value entered, then the CRC validation is ignored. The checksum value is calculated
using the sum of the bytes in the <data> section. For examples, see below.
<data> = data Accepted Values: Binary data saved on the printer’s file system as
<filename>. Number of bytes in this field must match the <size>
parameter.

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Printer Commands 635
CISDFCRC16

Example 1 • This example shows the CISDFCRC16 command used to download a private key
file (privkey.nrd) to the printer. The different sections of the command are on separate lines.
! CISDFCRC16
BA0B
privkey.nrd
0000037B
E3AF
-----BEGIN RSA PRIVATE KEY-----
MIICXgIBAAKBgQDQXu/E9YuGlScfWQepZa8Qe/1mJRpmk8oPhPVvam/4M5/WaWQp
3/p1f8J17/hDH8fFq5Dnx3/tHaU7A4SKO8GeghX5hnp/mt4tuQEvsXkCrcgS1puz
z5dbO7ThhuzxYClnr7uiXPvSRXawgwDTPas+0q/6gHeUSXtA0EofuIyv7wIDAQAB
AoGBAJPnf3wn6wT5pE59DJIyakRiLmkt1wKOzvObJfgS7i2Yv1EbeAy9PnPe3vKG
Bovm6A+oi2/qTSTLUTiFc7QHXJPVxLmRiHMbf1Q8j+VJkGTpWt8EY/Px+HSM2HAP
jqd+Im0IiE9RQPsxWQH9UaauF6nl5gIfMF74BIPsVzFXLFfxAkEA6zSrCKCycE/P
14cjZibnLiWxdL3U3I9eWuhmIS37RB6UJFBCWUPWr26HlHzOKqhOUMbFf5hOmvkZ
gciN9A8kxwJBAOLK7Gyorre8iK9IMMWc7OIJc7H8pH1y/N2OtyaC1XuPfqz0H4PH
w2W2m3BhZ7ggHJLLiiFVF+Hr5X7cibFDo5kCQQDFe5lHSzXHWxvViN/N+0gL1RYk
QOcisTW1+n8VyLe5wDr+Km0q6eytq44mvIuWAW6QH/TfZxBIynICKFQX4UctAkAm
P80iAkz9RfnTfhxjp7S35poxoYdodPU6tLAk+ZnhrfDSYJXUFuPYirSqfnMMtbW7
+EICnyRZAP0CqVU7pUm5AkEAnH2O6dKvUvwOEX+CsCVATRrejKLCeJ+6YZWqiD9X
0XGJgrHNXGpDtQiVSGM59p0XnHTZJYjvVNdNOMnhg333nQ==
-----END RSA PRIVATE KEY-----

Example 2 • These are examples of CRC and checksum values:

CRC example

The value of the <crc> field is calculated the CRC-16 for the contents of a specified file using
the CRC16-CCITT polynomial which is x^16 + x^12 + x^5 + 1. It is calculated using an initial
CRC of 0x0000.

checksum example
Given 4 bytes of data : 0x25, 0x62, 0x3F, 0x52:

1. Adding all bytes together gives 0x118.

2. Drop the carry nibble to get 0x18.

3. Get the two's complement of the 0x18 to get 0xE8.

This is the checksum byte.

6/8/10 Zebra Programming Guide P1012728-004

636 SGD Printer Commands
cutter.clean_cutter

cutter.clean_cutter
Description This command determines if the clean cutter option is enabled or disabled. For
printer support, see SGD Command Support on page 1019.

Type getvar;setvar

Commands Details
getvar This command retrieves the status of the clean cutter option.
Format: ! U1 getvar "cutter.clean_cutter"
setvar This command instructs the printer to set the clean cutter option.
Format: ! U1 setvar "cutter.clean_cutter"
Values:
"on" = turns on clean cutter
"off" = turns off clean cutter
Default: "on"

Note • For details on SGD command structure, see Command Structure on page 630.

Example • This setvar example shows the value set to "on".

! U1 setvar "cutter.clean_cutter" "on"
When the setvar value is set to "on", the getvar result is "on".

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Printer Commands 637
device.download_connection_timeout

device.download_connection_timeout
Description This command instructs the printer to abort a firmware download if the printer
fails to receive any download data in the set amount of seconds. If the set amount of seconds is
exceeded, the download will be aborted, and the printer automatically restarts. This command
prevents the printer from being locked into the downloading state, if the communication to the
host is interrupted. For printer support, see SGD Command Support on page 1019.

Type getvar;setvar

Commands Details
getvar This command retrieves the connection time out value (in seconds).
Format:
! U1 getvar "device.download_connection_timeout"
setvar This command instructs the printer to abort a firmware download if the printer fails to
receive any download data in the set amount of seconds.
Format:
! U1 setvar "device.download_connection_timeout" "value"
Values: "0" through "65535"
Default: "0" ("0" disables this feature)

Note • For details on SGD command structure, see Command Structure on page 630.

Example • This setvar example shows the value set to "0".

! U1 setvar "device.download_connection_timeout" "0"
When the setvar value is set to "0", the getvar result is "0".

6/8/10 Zebra Programming Guide P1012728-004

638 SGD Printer Commands
device.epl_legacy_mode

device.epl_legacy_mode
Description This command places the printer in a 2824/2844 compatibility mode for
vertical registration. For printer support, see SGD Command Support on page 1019.

Supported Devices
• G-Series printers
• LP2824 Plus and TLP 2824 Plus

Type getvar;setvar

Commands Details
getvar This command causes the printer to return the current setting for the
device.epl_legacy_mode setting.
Format: ! U1 getvar "device.epl_legacy_mode"
setvar* This command instructs the printer to change the epl_legacy_mode setting.
Format: ! U1 setvar "device.epl_legacy_mode" "value"
Values:
off = epl_legacy_mode not active
registration = EPL legacy registration mode on

Default Value: "epl_zpl"

Note • For details on SGD command structure, see Command Structure on page 630.

Example • This setvar example shows setting the value to "registration".

! U1 setvar "device.epl_legacy_mode" "registration"

Note • This setting is not defaulted as part of a factory default (^JUF or ^default). The
setting is persistent across a power cycle or reset (~JR or device.reset)

When printing labels using EPL commands, printing starts 1mm from the top edge of the label
(from the gap). This is known as the "no print zone". When printing in ZT mode, the "no print
zone" starts at the gap on the leading edge of the label. When printing in ZB mode, the "no
print zone" starts from the gap on the trailing edge of the label. In the TLP2844, LP2844,
TLP2824, LP2824, and TLP3842 printers, the distance from gap to start of print (the "no print
zone") is not always 1mm. The table below shows the nominal distance.

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Printer Commands 639
device.epl_legacy_mode

Distance from Edge of Label to First Print Line (No Print Zone)

Legacy Printer
New Printer Model ZT Mode ZB Mode
Model
LP2844 GX420, GK420 (direct thermal) 1.9 mm 0.0 mm
TLP2844 GX420, GK420 (thermal transfer) 0.4 mm 1.6 mm
TLP3842 GX430 (thermal transfer) 0.0 mm 1.2 mm
LP2824 LP 2824 Plus (direct thermal) 1.5 mm 0.4 mm
TLP2824 TLP 2824 Plus (thermal transfer) 0.1 mm 1.8 mm
a. Setting epl_legacy_mode to "registration" selects the distance shown in the table.
b. Setting epl_legacy_mode to "off" selects a no print zone distance of 1mm.

6/8/10 Zebra Programming Guide P1012728-004

640 SGD Printer Commands
device.friendly_name

device.friendly_name
Description This command shows the name assigned to the printer. For printer support, see
SGD Command Support on page 1019.

Type getvar;setvar

Commands Details
getvar This command retrieves the name assigned to the printer.
Format: ! U1 getvar "device.friendly_name"
setvar This command sets the printer’s name.
Format: ! U1 setvar "device.friendly_name" "value"
Default: "xxxxxxxxxx" ("xxxxxxxxxx"represents the main logic board serial
number)

Note • For details on SGD command structure, see Command Structure on page 732.

Example • This setvar example shows the value set to "xxxxxxxxxx".

! U1 setvar "device.friendly_name" "xxxxxxxxxx"
When the setvar value is set to "xxxxxxxxxx", the getvar result is
"xxxxxxxxxx".

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Printer Commands 641
device.frontpanel.key_press

device.frontpanel.key_press
Description This command instructs the printer to press a button on the front panel. For
printer support, see SGD Command Support on page 1019.

Type setvar

Commands Details
setvar This command instructs the printer to press a button on the front panel.
Format: ! U1 setvar "device.frontpanel.key_press"
Values: The values vary per printer, as follows:
ZM400, Z4M/Z6M, and RZ400/RZ600: S4M:
"A" = Pause "A" = Pause
"B" = Feed "B" = Feed
"C" = Cancel "C" = Up Arrow
"D" = Setup/Exit "D" = Cancel
"E" = Minus "E" = Menu
"F" = Select "F" = Enter
"G" = Plus Xi4, RXi4:
XiIIIplus: "A" = Pause
"A" = Pause "B" = Feed
"B" = Feed "C" = Cancel
"C" = Cancel "D" = Setup/Exit
"D" = Setup/Exit "E" = Previous
"E" = Previous "F" = Next/Save
"F" = Next/Save "G" = Minus
"G" = Minus "H" = Plus
"H" = Plus "I" = Calibrate
"I" = Calibrate

Note • For details on SGD command structure, see Command Structure on page 630.

Example • This setvar example shows the value set to "A".

! U1 setvar "device.frontpanel.key_press" "A"

6/8/10 Zebra Programming Guide P1012728-004

642 SGD Printer Commands
device.frontpanel.line1

device.frontpanel.line1
Description This command overrides the content that is shown on the first line of the front
panel when the printer is showing the idle display. Use of the getvar function is dependent
on first using the setvar function. For example, to have the first line of the idle display to
show HELLO, you must first send a setvar command; then a getvar command can be
sent to retrieve the value HELLO. For printer support, see SGD Command Support
on page 1019. For details on the supported character set, see Character Set on page 1016.

Type getvar;setvar

Commands Details
getvar This command retrieves the content that is shown on line one of the front panel.
Format: ! U1 getvar "device.frontpanel.line1"
setvar This command instructs the printer to set the content that is shown on line one of the front
panel.
Format:
! U1 setvar "device.frontpanel.line1" "value"
Values: The maximum amount of alphanumeric ASCII characters available for line 1 on the
printer’s front panel
Default: ""

Note • For details on SGD command structure, see Command Structure on page 630.

Example • This setvar example shows the value set to "sample line 1".
! U1 setvar "device.frontpanel.line1" "sample line 1"
When the setvar value is set to "sample line 1", the getvar result is "sample
line 1".

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Printer Commands 643
device.frontpanel.line2

device.frontpanel.line2
Description This command overrides the content that is shown on the second line of the
front panel when the printer is showing the idle display. Use of the getvar function is
dependent on using the setvar function. For example, to have the second line of the idle
display show HELLO, you must first send a setvar command; then a getvar command
can be sent to retrieve the value HELLO. For printer support, see SGD Command Support
on page 1019. For details on the supported character set, see Character Set on page 1016.

Type getvar;setvar

Commands Details
getvar This command retrieves the content that shows on line two of the front panel.
Format: ! U1 getvar "device.frontpanel.line2"
setvar This command instructs the printer to set the content that shows on line two of the front
panel.
Format:
! U1 setvar "device.frontpanel.line2" "value"
Values: The maximum amount of alphanumeric ASCII characters available for line two on
the printer’s front panel
Default: ""

Note • For details on SGD command structure, see Command Structure on page 630.

Example • This setvar example shows the value set to "sample line 2".
! U1 setvar "device.frontpanel.line2" "sample line 2"
When the setvar value is set to "sample line 2", the getvar result is "sample
line 2".

6/8/10 Zebra Programming Guide P1012728-004

644 SGD Printer Commands
device.frontpanel.xml

device.frontpanel.xml
Description This command retrieves the current content of the front panel in an XML
format. For printer support, see SGD Command Support on page 1019.

Type getvar

Commands Details
getvar This command retrieves the file that determines the representation of the front panel.
Format: ! U1 getvar "device.frontpanel.xml"

Note • For details on SGD command structure, see Command Structure on page 630.

Example • In this example, the getvar shows the status of the LEDs and the two lines of
the front panel in XML formatted text. The text below is formatted for easy reading. When
you use this command the response will not contain line feeds.
! U1 getvar "device.frontpanel.xml"

<FRONT-PANEL>
<LCD>
<LINE1>PRINTER READY</LINE1>
<LINE2>V53.16.0</LINE2>
</LCD>
<LEDS>
<PAUSE-LED>STEADY-OFF</PAUSE-LED>
<DATA-LED>STEADY-OFF</DATA-LED>
<ERROR-LED>STEADY-OFF</ERROR-LED>
</LEDS>
</FRONT-PANEL>

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Printer Commands 645
device.jobs_print

device.jobs_print
Description This command identifies the number of jobs to be printed. For printer support,
see SGD Command Support on page 1019.

Type getvar

Commands Details
getvar This command retrieves the number of jobs to be printed.
Format: ! U1 getvar "device.jobs_print"

Note • For details on SGD command structure, see Command Structure on page 630.

Example • In this example, the getvar retrieves the jobs currently being printed or last
printed.
! U1 getvar "device.jobs_print"

"1"

6/8/10 Zebra Programming Guide P1012728-004

646 SGD Printer Commands
device.languages

device.languages
Description This command identifies the programming language that the printer is currently
using. For printer support, see SGD Command Support on page 1019.

Supported Devices
• Printers running V60.15.8Z, V53.15.2Z, and later.

Type getvar;setvar

Commands Details
getvar This command retrieves the programming language that the printer is currently using.
Table 24shows the possible response values.
Format: ! U1 getvar "device.languages"
setvar* This command instructs the printer to set the printer to the required programming language .
Format: ! U1 setvar "device.languages"
Values:
"epl" = Eltron Programming Language
"zpl" = Zebra Programming Language
"epl_zpl" = Eltron Programming Language and Zebra Programming Language
"hybrid_xml_zpl" = XML and ZPL Programming Languages
Default Value: "epl_zpl"

* The setvar command is supported only on Zebra G-Series™ printers.

Note • For details on SGD command structure, see Command Structure on page 630.

Example • In this example, the getvar result is the current programming language that the
printer is using.
! U1 getvar "device.languages"

Table 24 • Programming Languages

zpl (Zebra Programming Language)
epl (Eltron Programming Language)
epl_zpl (Eltron and Zebra Programming Languages)
hybrid_xml_zpl (both XML and ZPL)

P1012728-004 Zebra Programming Guide 6/8/10

 SDG Printer Commands 647
device.orientation

device.orientation
Description This printer setting determines the installation orientation of the KR403 printer,
either horizontal or vertical. It is intended for use only by the system integrator. Modification
by an end user can result in unexpected printer behaviour.

Supported Devices
• KR403

Type getvar; setvar

Commands Details
getvar This command instructs the printer to respond with the currently set presenter
loop length.
Format: ! U1 getvar "device.orientation"

setvar This command instructs the printer to change the presenter loop length.
Format: ! U1 setvar "device.orientation" "value"
Values:
0 = printer is installed horizontally
1 = is installed vertically
Default:
0 = printer is installed horizontally (original factory default only, value will
not change when defaulting the printer with ^JUF)

Note • For details on SGD command structure, see Command Structure on page 630.

6/8/10 Zebra Programming Guide P1012728-004

648 SGD Printer Commands
device.pnp_option

device.pnp_option
Description This command defines the type of Plug and Play response that is sent by the
printer after the printer is started. The printer must be restarted for a new PNP string to be
reported. For printer support, see SGD Command Support on page 1019.

Type getvar;setvar

Commands Details
getvar This command retrieves the Plug and Play option setting.
Format: ! U1 getvar "device.pnp_option"
setvar This command instructs the printer to select the desired Plug and Play response option.
Format: ! U1 setvar "device.pnp_option" "value"
Values:
"epl" = Eltron Programming Language
"zpl" = Zebra Programming Language
Default: "zpl"

Note • For details on SGD command structure, see Command Structure on page 630.

Example • This setvar example shows the value set to "zpl".

! U1 setvar "device.pnp_option" "epl"
When the setvar value is set to "epl", the getvar result is "epl".

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Printer Commands 649
device.reset

device.reset
Description This command instructs the printer to perform a soft reset. For printer support,
see SGD Command Support on page 1019.

Type setvar

Commands Details
setvar This command instructs the printer to perform a soft reset.
Format: ! U1 setvar "device.reset" ""

Note • For details on SGD command structure, see Command Structure on page 732.

Example • In this example, the setvar performs a soft reset.

! U1 setvar "device.reset" ""

6/8/10 Zebra Programming Guide P1012728-004

650 SGD Printer Commands
device.restore_defaults

device.restore_defaults
Description This command restores to the default of all settings within the specified SGD
branch. For printer support, see SGD Command Support on page 1019.

Type do;setvar

Commands Details
do This command restores the default setting for all items within the specified branch.
Format: ! U1 do "device.restore_default" "value"
Values:
"ip" = default all parameters in the ip branch
"wlan" = default all parameters in the wlan branch
"internal_wired" = default all parameters in the internal wired branch
setvar This command restores to the default of all settings within the specified branch.
Format: ! U1 setvar "device.restore_default" "value"
Values:
"ip" = default all parameters in the IP branch
"wlan" = default all parameters in the wlan branch
"internal_wired" = default all parameters in the internal wired branch

Note • For details on SGD command structure, see Command Structure on page 785.

Example • These do and setvar examples restore the network card’s wlan parameters to
their default values.

do ! U1 do "device.restore_default" "wlan"

setvar ! U1 setvar "device.restore_default" "wlan"

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Printer Commands 651
device.unique_id

device.unique_id
Description This command retrieves the printer identifier. For printer support, see SGD
Command Support on page 1019.

Type getvar

Commands Details
getvar This command retrieves the established printer identifier.
Format: ! U1 getvar "device.unique_id"

Note • For details on SGD command structure, see Command Structure on page 630.

Example • In this example, assuming the printer’s unique ID is 12345, the getvar shows
"12345".
! U1 getvar "device.unique_id"

6/8/10 Zebra Programming Guide P1012728-004

652 SGD Printer Commands
device.uptime

device.uptime
Description This command identifies the amount of time the printer has been powered on.
The string format is: xx days, xx hours, xx minutes, and xx seconds. For printer support, see
SGD Command Support on page 1019.

Type getvar

Commands Details
getvar This command retrieves the amount of time the print has been powered on. It responds in
the following format (days, hours, minutes, and seconds).
Format: ! U1 getvar "device.uptime"

Note • For details on SGD command structure, see Command Structure on page 630.

Example • In this example, the getvar retrieves the amount of time the printer has been
turned on.
! U1 getvar "device.uptime"

"00 days 02 hours 45 mins 30 secs"

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Printer Commands 653
device.user_p1

device.user_p1
Description This command saves and retrieves user specified values. For printer support,
see SGD Command Support on page 1019.

Type getvar;setvar

Commands Details
getvar This command saves and retrieves user specified parameters.
Format: ! U1 getvar "device.user_p1"
setvar This command instructs the printer to set user parameters.
Format: ! U1 setvar "device.user_p1" "value"
Values: alphanumeric text string (1 - 20)
Default Value: ""

Note • For details on SGD command structure, see Command Structure on page 630.

Example • This setvar example shows the value set to "test".

! U1 setvar "device.user_p1" "test"
When the setvar value is set to "test", the getvar result is "test".

6/8/10 Zebra Programming Guide P1012728-004

654 SGD Printer Commands
device.user_p2

device.user_p2
Description This command saves and retrieves user specified values. For printer support,
see SGD Command Support on page 1019.

Type getvar;setvar

Commands Details
getvar This command saves and retrieves user specified parameters.
Format: ! U1 getvar "device.user_p2"
setvar This command instructs the printer to set user parameters.
Format: ! U1 setvar "device.user_p2" "value"
Values: alphanumeric text string (1 - 20)
Default: ""

Note • For details on SGD command structure, see Command Structure on page 630.

Example • This setvar example shows the value set to "test".

! U1 setvar "device.user_p2" "test"
When the setvar value is set to "test", the getvar result is "test".

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Printer Commands 655
device.xml.enable

device.xml.enable
Description This command enables and disables language parsing support for XML. When
enabled (on), the printer will parse both ZPL and XML. When disabled (off), the printer will
not parse XML data. For printer support, see SGD Command Support on page 1019.

Type setvar;getvar

Commands Details
getvar This command enables and disables language parsing support for XML.
Format: ! U1 getvar "device.xml.enable"
setvar This command instructs the printer to disable or enable the language parsing support for
XML.
Format: ! U1 getvar "device.xml.enable" "value"
Values:
"on" = enables language parsing support for XML
"off" = disables language parsing support for XML
Default Value: on

Note • For details on SGD command structure, see Command Structure on page 630.

Example • This setvar example shows the language parsing support for XML set to
"on".
! U1 setvar "device.xml.enable" "on"
When the setvar value is set to "on", the getvar result is language parsing support for
XML set to "on".

6/8/10 Zebra Programming Guide P1012728-004

656 SGD Printer Commands
display.text

display.text
Description This command retrieves the text data that is being used on the printer’s LCD.
For printer support, see SGD Command Support on page 1019.

Type getvar

Commands Details
getvar This command retrieves the text data that appears on the printer’s LCD.
Format: ! U1 getvar "display.text"

Note • For details on SGD command structure, see Command Structure on page 630.

Example • In this example, the getvar displays text content that appears on the printer’s
LCD.
! U1 getvar "display.text"

"PRINTER READY V60.16.4Z"

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Printer Settings 657
file.delete

file.delete
Description This command instructs the printer to delete specified files. For printer support,
see SGD Command Support on page 1019.

Type do

Commands Details
do This command instructs the printer to delete specified files.
Format: ! U1 do "file.delete" "value"
Values: file name
Important • Be sure to always specify the memory location.

Note • For details on SGD command structure, see Command Structure on page 732.

Example • This do example shows the specified file to delete.

! U1 do "file.delete" "e:abcd.zpl"

6/8/10 Zebra Programming Guide P1012728-004 Rev. A

658 SGD Printer Commands
file.dir

file.dir
Description This command displays a directory listing on the same port the command was
received. For printer support, see SGD Command Support on page 1019.

Type do;getvar;setvar

Commands Details
do This command sets the directory name from which to retrieve files.
Format: ! U1 do "file.dir" "value"
Values: directory letter
Important • Be sure to always specify the memory location.

getvar This command retrieves a directory listing of the specified directory.

Format: ! U1 getvar "file.dir"
Important • Be sure to always specify the memory location.

setvar This command sets the directory name from which to retrieve files.
Format: ! U1 setvar "file.dir" "value"
Values: directory letter
Important • Be sure to always specify the memory location.

Note • For details on SGD command structure, see Command Structure on page 732.

Example • This do example shows the directory listing of the specified directory.
! U1 do "file.dir" "R:"

- DIR R:*.*
- 11172192 bytes free R: RAM

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Printer Commands 659
file.type

file.type
Description This command displays the contents of the specified file. For printer support,
see SGD Command Support on page 1019.

Type do;setvar

Commands Details
do This command displays the content of a file on the same port the command was received.
Format: ! U1 do "file.type" "value"
Values: the drive letter, file name, file extension, such as R:TEST.ZPL
Important • Be sure to always specify the memory location.

setvar This command instructs the printer to display the content of a file on the same port the
command was received.
Format: ! U1 setvar "file.type" "value"
Values: the drive letter, file name, file extension, such as R:TEST.ZPL
Important • Be sure to always specify the memory location.

Note • For details on SGD command structure, see Command Structure on page 630.

Example • This setvar example shows the value set to "R:TEST.ZPL".

! U1 setvar "file.type" "R:TEST.ZPL"
When the setvar value is set to "R:TEST.ZPL", the contents of the file TEST.ZPL
located on the R: drive will be displayed.

6/8/10 Zebra Programming Guide P1012728-004

660 SGD Printer Commands
file.run

file.run
Description This command instructs the printer to send a specified file to the parser. For
printer support, see SGD Command Support on page 1019.

Type do; setvar

Commands Details
do This command instructs the printer to send a specified file to the parser.
Format: ! U1 do "file.run" "value"
Values: drive:filename.extension
Important • Be sure to always specify the memory location.

setvar This command instructs the printer to send a specified file to the parser.
Format: ! U1 setvar "file.run" "values"
Values: drive:filename.extension
Important • Be sure to always specify the memory location.

Note • For details on SGD command structure, see Command Structure on page 630.

Example • This setvar example will send the file "text.zpl" stored in RAM to the parser.
! U1 setvar "file.run" "R:text.zpl"

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Printer Commands 661
head.latch

head.latch
Description This command identifies if the printhead is open or closed. For printer support,
see SGD Command Support on page 1019.

Type getvar

Commands Details
getvar This command retrieves the status of the printhead, open or closed.
Format: ! U1 getvar "head.latch"
Values:
"ok" = closed
"open" = open

Note • For details on SGD command structure, see Command Structure on page 630.

Example • In this example, the getvar retrieves the status of the print head.
! U1 getvar "head.latch"

"ok"

6/8/10 Zebra Programming Guide P1012728-004

662 SGD Printer Commands
interface.network.active.gateway

interface.network.active.gateway
Description This command retrieves the gateway address of the active print server. For
printer support, see SGD Command Support on page 1019.

Type getvar

Commands Details
getvar This command retrieves the gateway address of the active print server.
Format:
! U1 getvar "interface.network.active.gateway"

Note • For details on SGD command structure, see Command Structure on page 630.

Example • In this example, the getvar retrieves the gateway address of the active print
server.
! U1 getvar "interface.network.active.gateway"

"10.3.5.1"

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Printer Commands 663
interface.network.active.ip_addr

interface.network.active.ip_addr
Description This command retrieves the IP address of the active print server. For printer
support, see SGD Command Support on page 1019.

Type getvar

Commands Details
getvar This command retrieves the IP address of the active print server.
Format:
! U1 getvar "interface.network.active.ip_addr"

Note • For details on SGD command structure, see Command Structure on page 630.

Example • In this example, the getvar retrieves the IP address of the active print server.
! U1 getvar "interface.network.active.ip_addr"

"10.3.5.92"

6/8/10 Zebra Programming Guide P1012728-004

664 SGD Printer Commands
interface.network.active.mac_addr

interface.network.active.mac_addr
Description This command retrieves the MAC address of the active print server. For printer
support, see SGD Command Support on page 1019.

Type getvar

Commands Details
getvar This command retrieves the MAC address of the active print server.
Format:
! U1 getvar "interface.network.active.mac_addr"

Note • For details on SGD command structure, see Command Structure on page 630.

Example • In this example, the getvar retrieves the MAC address of the active print
server.
! U1 getvar "interface.network.active.mac_addr"

"00:07:4d:24:08:ff"

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Printer Commands 665
interface.network.active.mac_raw

interface.network.active.mac_raw
Description This command identifies the RAW MAC address of the active print server. The
raw mac address is the mac address without the colons (":"). For printer support, see SGD
Command Support on page 1019.

Type getvar

Commands Details
getvar This command retrieves the RAW MAC address of the active print server.
Format:
! U1 getvar "interface.network.active.mac_raw"

Note • For details on SGD command structure, see Command Structure on page 630.

Example • In this example, the getvar retrieves the RAW MAC address of the active print
server.
! U1 getvar "interface.network.active.mac_raw"

"00074d2408ff"

6/8/10 Zebra Programming Guide P1012728-004

666 SGD Printer Commands
interface.network.active.netmask

interface.network.active.netmask
Description This command retrieves the netmask of the active print server. For printer
support, see SGD Command Support on page 1019.

Type getvar

Commands Details
getvar This command retrieves the netmask of the active print server.
Format:
! U1 getvar "interface.network.active.netmask"

Note • For details on SGD command structure, see Command Structure on page 630.

Example • In this example, the getvar retrieves the netmask of the active print server.
! U1 getvar "interface.network.active.netmask"

"255.255.255.0"

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Printer Commands 667
interface.network.active.protocol

interface.network.active.protocol
Description This command retrieves IP protocol of the active print server. For printer
support, see SGD Command Support on page 1019.

Type getvar

Commands Details
getvar This command retrieves the IP protocol of the active print server.
Format:
! U1 getvar "interface.network.active.protocol"

Note • For details on SGD command structure, see Command Structure on page 630.

Example • In this example, the getvar retrieves the IP protocol of the active print server.
! U1 getvar "interface.network.active.protocol"

Possible values include:

"bootp"
"dhcp"
"rarp"
"glean"
"permanent"

6/8/10 Zebra Programming Guide P1012728-004

668 SGD Printer Commands
media.cartridge.part_number

media.cartridge.part_number
Description This printer command retrieves the part number of the media cartridge used in
the printer.

Supported Devices
• HC100

Type getvar

Commands Details
getvar This command instructs the printer to respond with the media cartridge part number
currently being used by the printer.
Format: ! U1 getvar "media.cartridge.part_number"

Note • For details on SGD command structure, see Command Structure on page 630.

Example • In this example, the getvar returns the part number of the media cartridge.
! U1 getvar "media.cartridge.part_number" "10006999"

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Printer Commands 669
media.cut_now

media.cut_now
Description This command instructs the printer cycle the media cutter. If the printer is in
Print Mode Kiosk (media.printmode “K”) then the cutter will execute a cut based on the value
of media.present.cut_amount – either a normal cut or a partial cut. If the printer is not in Print
Mode Kiosk (media.printmode “K”), this command does nothing. See
media.present.cut_amount on page 673.

Supported Devices
• KR403

Type do; setvar

Commands Details
do This command instructs the printer to cycle the media cutter.
Format: ! U1 do "media.cut_now" ""

setvar This command instructs the printer to cycle the media cutter.
Format: ! U1 setvar "media.cut_now" ""
Note • See media.present.cut_amount on page 673.

Note • For details on SGD command structure, see Command Structure on page 630.

6/8/10 Zebra Programming Guide P1012728-004

670 SGD Printer Commands
media.darkness_mode

media.darkness_mode
Description This command instructs the printer to set the darkness mode. For printer
support, see SGD Command Support on page 1019.

Type setvar

Commands Details
setvar This command instructs the printer to set the darkness mode.
Format:
! U1 setvar "media.darkness_mode" "value"
Values:
"cartridge" = cartridge mode (no changes allowed
"user" = user mode (Darkness is set by the user, and the cartridge value is ignored.
This value is used for all cartridges inserted in the printer).
"relative" = relative mode (the specified darkness value is added to the cartridge
default value)
Default Value: "cartridge"

Note • For details on SGD command structure, see Command Structure on page 630.

Example • This setvar example shows the darkness mode set to "cartridge".
! U1 setvar "media.darkness_mode" "cartridge"

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Printer Commands 671
media.media_low.external

media.media_low.external
Description This printer setting gets the status of the external media_low warning. For
printer support, see SGD Command Support on page 1019.

Supported Devices
• KR403

Type getvar

Commands Details

getvar This command instructs the printer to respond with the currently set media print mode.
Format:
! U1 getvar "media.media_low.external"
Values:
0 = Paper present at sensor position
1 = No paper present

Note • The status of the sensor is sampled every time the printout is cut. If three
succeeding samples show "no paper", the status reply changes to 1. This is to
prevent a false alarm if the side of the paper roll is not clean. If the current status of
the sensor is required, use ~HQES and extract the paper near-end sensor bit.

Note • For details on SGD command structure, see Command Structure on page 630.

6/8/10 Zebra Programming Guide P1012728-004

672 SGD Printer Commands
media.media_low.warning

media.media_low.warning
Description This command retrievs the value of, or enables or disables the Supplies
Warning system. For printer support, see SGD Command Support on page 1019.

Supported Devices
• Xi4
• RXi4

Type getvar; setvar

Commands Details
getvar This command retrieves the setting for the Supplies Warning system.
Format: ! U1 getvar "media.media_low.warning"
setvar This command enables or disables the Supplies Warning System.
Format: ! U1 setvar "media.media_low.warning" "value"
Values:
"disabled" = not active
"enabled" = active
Default: "disabled"

Note • For details on SGD command structure, see Command Structure on page 630.

Example 1 • This setvar example disables the Supplies Warning system.

! U1 setvar "media.media_low.warning" "disabled"

Example 2 • This setvar example enables the Supplies Warning system.

! U1 setvar "media.media_low.warning" "enabled"

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Printer Commands 673
media.present.cut_amount

media.present.cut_amount
Description This printer setting determines the type of cut made by the printer cutter
(normal or partial) and, if partial, the length of the partial cut on each side, in mm. For printer
support, see SGD Command Support on page 1019.

Supported Devices
• KR403

Type getvar; setvar

Commands Details
getvar This command instructs the printer to respond with the currently set media cut amount.
Format:
! U1 getvar "media.present.cut_amount"

setvar This command instructs the printer to change the media cut amount.
Format:
! U1 setvar "media.present.cut_amount" "value"
Values:
0 = normal cut
10-60 = partial cut, value = mm of media left uncut

Note • For details on SGD command structure, see Command Structure on page 630.

6/8/10 Zebra Programming Guide P1012728-004

674 SGD Printer Commands
media.present.eject

media.present.eject
Description This command instructs the printer to eject the document through the presenter
module. The value is the amount to eject, in mm. The value of media.present.length_addition
gets added to the value to determine the total length of media ejected. For printer support, see
SGD Command Support on page 1019.

Supported Devices
• KR403

Type do; setvar

Commands Details
do This command instructs the printer to eject the document through the presenter module.
Format: ! U1 do "media.present.eject" "value"

setvar This command instructs the printer to eject the document through the presenter module.
Format: ! U1 setvar "media.present.eject" "value"
Values:
0 - 255 = amount of media to eject in mm
Note • See media.present.length_addition on page 675.

Note • For details on SGD command structure, see Command Structure on page 630.

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Printer Commands 675
media.present.length_addition

media.present.length_addition
Description This printer setting adds an additional amount to how far the paper is ejected
during a present cycle. A standard amount of 50mm is always added to clear the kiosk wall.
This amount is added to that 50mm. The total amount of media ejected this command is
executed, then, is 50mm + media.present.length_addition + media.present.eject. For printer
support, see SGD Command Support on page 1019.

Supported Devices
• KR403

Type getvar; setvar

Commands Details

getvar This command instructs the printer to respond with the currently set media
present length addition.
Format: :
! U1 getvar "media.present.length_addition"
setvar This command instructs the printer to change the media present length addition.
Format:
! U1 setvar "media.present.length_addition" "value"
Values:
0-255 = additional mm of media to eject

Note • For details on SGD command structure, see Command Structure on page 630.

6/8/10 Zebra Programming Guide P1012728-004

676 SGD Printer Commands
media.present.loop_length

media.present.loop_length
Description This printer setting determines the length of the presenter loop. If loop_length
is greater than loop_length_max (see media.present.loop_length_max) then it will be set equal
to loop_length_max. For printer support, see SGD Command Support on page 1019.

Supported Devices
• KR403

Type getvar; setvar

Commands Details

getvar This command instructs the printer to respond with the currently set presenter loop length.
Format: ! U1 getvar "media.present.loop_length"

setvar This command instructs the printer to change the presenter loop length.
Format:
! U1 setvar "media.present.loop_length" "value"
Values:
0 = paper is fed straight through the presenter
3-1023 = loop length in mm.
Default:
400 = gives a loop of approximately 400mm

Note • For details on SGD command structure, see Command Structure on page 630.

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Printer Commands 677
media.present.loop_length_max

media.present.loop_length_max
Description This printer setting determines the maximum allowed length of the presenter
loop. For printer support, see SGD Command Support on page 1019.

Supported Devices
• KR403

Type getvar; setvar

Commands Details
getvar This command instructs the printer to respond with the currently set presenter loop length.
Format:
! U1 getvar "media.present.loop_length_max"

setvar This command instructs the printer to change the presenter loop length.
Format:
! U1 setvar "media.present.loop_length_max" "value"
Values:
0 = paper is fed straight through the presenter
3-1023 = loop length in mm.
Default:
400 = gives a loop of approximately 400mm

Note • For details on SGD command structure, see Command Structure on page 630.

6/8/10 Zebra Programming Guide P1012728-004

678 SGD Printer Commands
media.present.cut_margin

media.present.cut_margin
Description This printer setting determines the margin between the cutter and the printhead.
For printer support, see SGD Command Support on page 1019.

Supported Devices
• KR403

Type getvar; setvar

Commands Details

getvar This command instructs the printer to respond with the currently set media cut margin
amount.
Format:
! U1 getvar "media.present.cut_margin"
setvar This command instructs the printer to change the media cut amount.
Format:
! U1 setvar "media.present.cut_margin" "value"
Values:
2 - 9 = mm of distance
Default: :
9 = mm of distance

Note • For details on SGD command structure, see Command Structure on page 630.

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Printer Commands 679
media.present.present_timeout

media.present.present_timeout
Description This printer setting determines how long the printer will wait after a present
event to clear the label. See ^KV ZPL command. For printer support, see SGD Command
Support on page 1019.

Supported Devices
• KR403

Type getvar; setvar

Commands Details

getvar This command instructs the printer to respond with the currently set presenter
function mode.
Format:
! U1 getvar "media.present.present_timeout"
setvar This command instructs the printer to change the presenter function mode.
Format:
! U1 setvar "media.present.present_timeout" "value"
Values:
0 – 300 = If label is not taken, retract label when timeout expires. Timeout is
in seconds. Zero (0) indicates that there is no timeout. The label
will stay presented until removed manually or a new label is
printed.

Note • For details on SGD command structure, see Command Structure on page 630.

6/8/10 Zebra Programming Guide P1012728-004

680 SGD Printer Commands
media.present.present_type

media.present.present_type
Description This printer setting determines the way that the printer performs a present
command. See ^KV ZPL command. For printer support, see SGD Command Support
on page 1019.

Supported Devices
• KR403

Type getvar; setvar

Commands Details
getvar This command instructs the printer to respond with the currently set presenter
function mode.
Format:
! U1 getvar "media.present.present_type"
setvar This command instructs the printer to change the presenter function mode.
Format:
! U1 setvar "media.present.present_type" "value"
Values:
0 = Eject page when new page is printed
1 = Retract page when new page is printed
2 = Do nothing when new page is printed

Note • For details on SGD command structure, see Command Structure on page 630.

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Printer Commands 681
media.printmode

media.printmode
Description This printer setting determines the action the printer takes after a label or group
of labels has printed. For printer support, see SGD Command Support on page 1019.

Type getvar; setvar

Commands Details
getvar This command instructs the printer to respond with the the currently set media print mode.
Format: ! U1 getvar "media.printmode"
setvar This command instructs the printer to change the media print mode.
Format: ! U1 setvar "media.printmode" "value"
Values:
"T" = tear off
"P" = peel off c
"R" = rewind
"A" = applicator c
"C" = cutter
"D" = delayed cutter c
"L" = reserved c, d
"U" = reserved c
"K" = kiosk e
c. This value is not supported on the KR403 printer.
d. This value is supported only on the ZM400/ZM600 and RZ400/RZ600 printers.
e. This value is supported only on the KR403 printer.

Note • For details on SGD command structure, see Command Structure on page 630.

Example • This setvar example shows the value set to "T".

! U1 setvar "media.printmode" "T"
What the setvar value is set to is the getvar result. In this example, the getvar result is
"tear off".

For more details on how each setvar value relates to the getvar responses, see Table 25,
Setvar / Getvar Relation on page 682.

6/8/10 Zebra Programming Guide P1012728-004

682 SGD Printer Commands
media.printmode

Table 25 • Setvar / Getvar Relation

If the setvar is set to … Then the getvar response and control panel display is …
"T" TEAR OFF
"P" PEEL OFF
"R" REWIND
"A" APPLICATOR
"C" CUTTER
"D" DELAYED CUT
"L" RESERVED
"U" RESERVED
"K" KIOSK

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Printer Commands 683
media.speed

media.speed
Description This command specifies media print speed in inches per second (ips). For
printer support, see SGD Command Support on page 1019.

Type getvar;setvar

Commands Details
getvar This command retrieves the currently set media print speed.
Format: ! U1 getvar "media.speed"
setvar This command instructs the printer to set the media print speed.
Format: ! U1 setvar "media.speed" "value"
Values:
2-12 ips
"up" = increments the printer speed by one unit
"down" = decrements the speed by one unit
Default: "2"

Note • For details on SGD command structure, see Command Structure on page 630.

Example 1 • This setvar example shows the value set to "2".

! U1 setvar "media.speed" "2"
When the setvar value is set to "2", the getvar result is "2".

Example 2 • This setvar example shows the value set to "up".

! U1 setvar "media.speed" "up"
If the current print speed is 2: When the setvar value is set to "up", the getvar result is
"3".

Example 3 • This setvar example shows the value set to "down".

! U1 setvar "media.speed" "down"
If the current print speed is 2: When the setvar value is set to "down", the getvar result
is "1".

6/8/10 Zebra Programming Guide P1012728-004

684 SGD Printer Commands
odometer.headclean

odometer.headclean
Description This printer setting refers to the head clean odometer count. This counter tracks
how many inches and centimeters have passed through the printer since the head was last
cleaned. For printer support, see SGD Command Support on page 1019.

Type getvar; setvar

Commands Details
getvar This command instructs the printer to retrieve the values for the head clean counter.
Format: ! U1 getvar "odometer.headclean"
setvar This command instructs the printer to reset the head clean counter.
Format: ! U1 setvar "odometer.headclean" "value"
Values:
"0" = reset the head clean counter
Default: must be an accepted value or it is ignored

Note • For details on SGD command structure, see Command Structure on page 630.

Example • This example shows how to get the odometer head clean, how to reset it, and how
to confirm the settings changed.

1. To see the current settings, type:

! U1 getvar "odometer.headclean"
Something similar to this is shown:
"1489 INCHES, 3784 CENTIMETERS"

2. To reset the these values to 0, type:

! U1 setvar "odometer.headclean" "0"

3. To confirm this settings were reset, type:

! U1 getvar "odometer.headclean"
If the resetting was successful, this is shown:
"0 INCHES, 0 CENTIMETERS"

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Printer Commands 685
odometer.headnew

odometer.headnew
Description This printer setting refers to the head replaced odometer count. This counter
tracks how many inches and centimeter passed through the printer since the head was last
replaced. For printer support, see SGD Command Support on page 1019.

Type getvar; setvar

Commands Details
getvar This command instructs the printer to retrieve the values for the head new counter.
Format: ! U1 getvar "odometer.headnew"
setvar This command instructs the printer to reset the head new counter.
Format: ! U1 setvar "odometer.headnew" "value"
Values:
"0" = resets the head new counter
Default: must be an accepted value or it is ignored

Note • For details on SGD command structure, see Command Structure on page 630.

Example • This example shows how to get the odometer head new, how to reset it, and how
to confirm the settings changed:

1. To see the current settings, type:

! U1 getvar "odometer.headnew"
Something similar to this is shown:
"1489 INCHES, 3784 CENTIMETERS"

2. To reset the these values to 0, type:

! U1 setvar "odometer.headnew" "0"

3. To confirm this settings were reset, type:

! U1 getvar "odometer.headnew"
If the resetting was successful, this is shown:
"0 INCHES, 0 CENTIMETERS

6/8/10 Zebra Programming Guide P1012728-004

686 SGD Printer Commands
odometer.label_dot_length

odometer.label_dot_length
Description This command returns the length of the last label printed or fed (in dots). For
printer support, see SGD Command Support on page 1019.

Type getvar

Commands Details
getvar This command returns the length of the last label printed or fed (in dots).
Format:
! U1 getvar "odometer.label_dot_length"

Note • For details on SGD command structure, see Command Structure on page 630.

Example • This is an example of how to reset the length using the ^LL command and how to
use the getvar to confirm the change. For the ^LL command to work the printer must be in
continuous mode.

1. To change the odometer label dot length, type:

^XA
^LL500
^XZ

2. To get the current odometer label dot length, type:

! U1 getvar "odometer.label_dot_length"
Something similar to this is shown:
"500"

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Printer Commands 687
odometer.media_marker_count1

odometer.media_marker_count1
Description This printer setting refers to the value of the first (count1) user resettable
counter. The user resettable counters track how much media has passed through the printer in
both inches or centimeters. For printer support, see SGD Command Support on page 1019.

Type getvar; setvar

Commands Details
getvar This command instructs the printer to return the current value of the first (count1) user
resettable counter in both inches and centimeters.
Format: ! U1 getvar "odometer.media_marker_count1"
setvar This command instructs the printer to reset the first user resettable counter.
Format:
! U1 setvar "odometer.media_marker_count1" "value"
Values:
"0" = reset the counter
Default: must be an accepted value or it is ignored

Note • For details on the command structure of SGD commands, see Command Structure
on page 630.

Example • This example shows how to get the first user resettable counter, how to reset it,
and how to confirm the settings have changed:

1. To see the current settings, type:

! U1 getvar "odometer.media_marker_count1"
Something similar to this is shown:
"8516 INCHES, 21632 CENTIMETERS"

2. To reset the these values to 0, type:

! U1 setvar "odometer.media_marker_count1" "0"

3. To confirm these settings were reset, type:

! U1 getvar "odometer.media_marker_count1"
If the resetting was successful, this is shown:
"0 INCHES, 0 CENTIMETERS"

6/8/10 Zebra Programming Guide P1012728-004

688 SGD Printer Commands
odometer.media_marker_count2

odometer.media_marker_count2
Description This printer setting refers to the value of the second (count2) user resettable
counter. The user resettable counters track how much media has passed through the printer in
both inches or centimeters. For printer support, see SGD Command Support on page 1019.

Type getvar; setvar

Commands Details
getvar This command instructs the printer to return the current value of the second (count2) user
resettable counter in both inches and centimeters.
Format: ! U1 getvar "odometer.media_marker_count2"
setvar This command instructs the printer to reset the second user resettable counter.
Format:
! U1 setvar "odometer.media_marker_count2" "value"
Values:
"0" = reset the counter
Default: must be an accepted value or it is ignored

Note • For details on SGD command structure, see Command Structure on page 630.

Example • This example shows how to get the second user resettable counter, how to reset
it, and how to confirm the settings have changed:

1. To see the current settings, type:

! U1 getvar "odometer.media_marker_count2"
Something similar to this is shown:
"8516 INCHES, 21632 CENTIMETERS"

2. To reset the these values to 0, type:

! U1 setvar "odometer.media_marker_count2" "0"

3. To confirm these settings were reset, type:

! U1 getvar "odometer.media_marker_count2"
If the resetting was successful, this is shown:
"0 INCHES, 0 CENTIMETERS"

P1012728-004 Zebra Programming Guide 6/8/10

 SDG Printer Commands 689
odometer.retracts_count

odometer.retracts_count
Description This printer value records the number of times a label has been retracted since
the last time the counter has been reset.

Supported Devices
• KR403

Type getvar; setvar

Commands Details
getvar This command instructs the printer to respond with the current number of retractions that
have happened since the last time the counter was reset.
Format:
! U1 getvar "odometer.retracts_count"
setvar This command instructs the printer to reset the current count of retractions.
Format:
! U1 setvar "odometer.retracts_count" "value"
Values:
0 = reset the counter
Default: none

Note • For details on SGD command structure, see Command Structure on page 630.

6/8/10 Zebra Programming Guide P1012728-004

690 SGD Printer Settings
odometer.rfid.valid_resettable

odometer.rfid.valid_resettable
Description This command resets the RFID valid label counter to zero.

Type getvar; setvar

Note • For details on SGD command structure, see Command Structure on page 630.

This table identifies the command for this format:

Commands Details
getvar This command instructs the printer to respond with the current RFID valid counter value.
Format: ! U1 getvar "odometer.rfid.valid_resettable"
setvar This command instructs the printer to set the RFID valid counter to zero.
Format: ! U1 setvar "odometer.rfid.valid_resettable" "value"
Values: “reset”

Example • This setvar example shows how the counter portion of the printer
configuration labels looks when the RFID valid counter is reset by sending:
! U1 setvar "odometer.rfid.valid_resettable" "reset"
Before

After

P1012728-004 A Zebra Programming Guide 6/8/10

 SGD Printer Settings 691
odometer.rfid.void_resettable

odometer.rfid.void_resettable
Description This command resets the RFID void label counter to zero.

Type getvar; setvar

Note • For details on SGD command structure, see Command Structure on page 630.

This table identifies the command for this format:

Commands Details
getvar This command instructs the printer to respond with the current RFID void counter value.
Format: ! U1 getvar "odometer.rfid.void_resettable"
setvar This command instructs the printer to set the RFID void counter to zero.
Format: ! U1 setvar "odometer.rfid.void_resettable" "value"
Values: “reset”

Example • This setvar example shows how the counter portion of the printer
configuration labels looks when the RFID void counter is reset by sending:
! U1 setvar "odometer.rfid.void_resettable" "reset"
Before

After

6/8/10 Zebra Programming Guide P1012728-004 A

692 SGD Printer Commands
odometer.total_print_length

odometer.total_print_length
Description This command tracks the total length of media that printed over the life of the
printer. For printer support, see SGD Command Support on page 1019.

Type getvar

Commands Details
getvar This command returns the value of the total length of media that printed over the life of the
printer.
Format: ! U1 getvar "odometer.total_print_length"

Note • For details on SGD command structure, see Command Structure on page 630.

Example • This example shows how to get the total length of media that printed over the life
of the printer.

1. To get the total length of media that has printed to date, type:
! U1 getvar "odometer.total_print_length"
Something similar to this is shown:
"8560 INCHES, 21744 CENTIMETERS"

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Printer Commands 693
print.tone

print.tone
Description This command specifies the printer darkness. For printer support, see SGD
Command Support on page 1019.

Type getvar;setvar

Commands Details
getvar This command retrieves the printer’s current darkness setting.
Format: ! U1 getvar "print.tone"
setvar This command instructs the printer to set the darkness and relative darkness.
Format: ! U1 setvar "print.tone" "value"
Values:
"0.0" to "30.0" = darkness
"-0.1" to "-30.0" and "+0.1" to "+30.0" = incremental adjustments
Default: "4.0"

Note • For details on SGD command structure, see Command Structure on page 630.

Example • This setvar example shows the value set to "4.0".

! U1 setvar "print.tone" "4.0"
When the setvar value is set to "4.0", the getvar result is "4.0".

6/8/10 Zebra Programming Guide P1012728-004

694 SGD Printer Settings
rfid.error.response

rfid.error.response
Description During an error condition, an error message shows on the second line of the
display. This command can be used to retrieve that error message. For printer support, see
SGD Command Support on page 1019.

Type getvar
\

Note • For details on SGD command structure, see Command Structure on page 630.

This table identifies the command for this format:

Commands Details
getvar This command instructs the printer to respond with any active RFID error messages.
Format: ! U1 getvar "rfid.error.response"

Example • This getvar example shows responses that you may get in different situations:
! U1 getvar "rfid.error.response"
If no RFID tag is present, you get the following response:
NO TAG FOUND
If an RFID tag is present and there are no errors, you get the following response:
RFID OK

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Printer Settings 695
rfid.position.program

rfid.position.program
Description This command sets the read/write position of the transponder (programming
position) in one of two ways: absolute mode (available in all RFID firmware versions) or
relative mode (available in firmware versions V53.17.7 and later). For more information on
these modes, refer to the RFID Programming Guide 2. A copy is available at
http://www.zebra.com/manuals. For printer support, see SGD Command Support
on page 1019.

Important • If this command is used to specify a value for the programming position, this
value will be used for the programming position for all labels until a new position is specified
or until the transponder calibration procedure is run.

Type getvar; setvar

Note • For details on SGD command structure, see Command Structure on page 630.

This table identifies the command for this format:

6/8/10 Zebra Programming Guide P1012728-004

696 SGD Printer Settings
rfid.position.program

Commands Details
getvar This command instructs the printer to respond with the current programming position.
Format: ! U1 getvar "rfid.position.program"
setvar This command instructs the printer to set the programming position.
Format: ! U1 setvar "rfid.position.program" "value"
Values:
Absolute Mode:
"xxxx" = 0 to label length (in dot rows). Move the media to the specified position xxxx
on the label, measured in dot rows from the label top, before encoding. Set to 0
(no movement) if the transponder is already in the effective area without moving
the media.
Relative Mode Forward:
"Fxxx" = F0 to Fxxx (where xxx is the label length in millimeters or 999, whichever is
less). Move media forward, printing bitmap, for xxx millimeters before reading or
encoding.
Relative Mode Backward:
"Byy" = B0 to B30 (in millimeters, 30 mm maximum). Move media backward for yy
millimeters before reading or encoding.

Note • When using a backward program position, allow enough media or liner to
ensure that the printer can back up the media without the leading edge disappearing
under the printhead mechanism.
Accepted Values:
Default value:
For the R2844-Z and RPAX: 0 (no movement)
For printers using V53.17.7Z and later: F0 (which moves the leading edge of the label
to the print line)
For all other printers or firmware: label length minus 1 mm (1/16 in.)

Example • This setvar example shows the programming position being set at 15 mm from
the leading edge of the label.
! U1 setvar "rfid.position.program" "F15"
When the setvar value is set to "15", the getvar result is "F15".

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Printer Settings 697
rfid.reader_1.antenna_port

rfid.reader_1.antenna_port
Description This command selects the RFID antenna port. For printer support, see SGD
Command Support on page 1019.

Note • The R110Xi4 printer automatically selects the best antenna element and read/write
power levels for the media during RFID transponder calibration. It may also set the levels
during an adaptive antenna sweep. Use the ~HL command (see ^HL or ~HL on page 380) to
view the antenna element and power settings being used.

Type getvar; setvar

Note • For details on SGD command structure, see Command Structure on page 630.

6/8/10 Zebra Programming Guide P1012728-004

698 SGD Printer Settings
rfid.reader_1.antenna_port

Commands Details
getvar This command instructs the printer to respond with the current antenna port.
Format: ! U1 getvar "rfid.reader_1.antenna_port"
setvar R110Xi HF (R65.X):
This command instructs the printer to set the antenna port.
Format: ! U1 setvar "rfid.reader_1.antenna_port" "value"
Values:
1 = antenna port 1
2 = antenna port 2
Default: 1
R110Xi4 (V53.17.7Z and later):
This command instructs the printer to set the antenna from an array of antennas.
Format: ! U1 setvar "rfid.reader_1.antenna_port" "value"
Values:
a two-digit antenna value:
A1, A2, A3, A4, B1, B2, B3, B4, C1, C2, C3, C4, D2, D3, D4, E2, E3, E4, F2, F3, F4
(combinations D1, E1, and F1 are invalid)

Default: A4

Example • This setvar example shows the selection of antenna port D3.
! U1 setvar "rfid.reader_1.antenna_port" "D3"
When the setvar value is set to "D3", the getvar result is "D3".

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Printer Settings 699
rfid.reader_1.power.read

rfid.reader_1.power.read
Description This command sets the RFID reader power level for reading RFID tags. For
printer support, see SGD Command Support on page 1019.

Note • The R110Xi4 printer automatically selects the best antenna element and read/write
power levels for the media during RFID transponder calibration. It may also set the levels
during an adaptive antenna sweep. Use the ~HL command (see ^HL or ~HL on page 380) to
view the antenna element and power settings being used.

Type getvar; setvar

Note • For details on SGD command structure, see Command Structure on page 630.

Commands Details
getvar This command instructs the printer to respond with the antenna’s current read power level.
Format: ! U1 getvar "rfid.reader_1.power.read"
setvar This command instructs the printer to set the antenna’s read power level.
Format: ! U1 setvar "rfid.reader_1.power.read" "value"
R53.16.3Z:
Values: 0 to 30
Default Value: 16
R53.16.4Z, V53.17.7, and later:
Values: 0 to 30, up, down (up and down change the current value by 1)
Default Value: 16
R60.16.x, R62.16.x, R63.16.x, R65.16.x, SP994Q, SP999G, SP1027G, SP1056F,
SP1082G, and later:
Values: 0 to 30, high, medium, low
Default Value: low
Older firmware:
Values:
high
medium
low
Default: low

Example • This setvar example sets the antenna to high power for reading RFID tags.
! U1 setvar "rfid.reader_1.power.read" "16"
When the setvar value is set to "16", the getvar result is "16".

6/8/10 Zebra Programming Guide P1012728-004

700 SGD Printer Settings
rfid.reader_1.power.single_power

rfid.reader_1.power.single_power
Description This command sets the RFID reader power level for reading and writing to
RFID tags for readers with a single power level. For printer support, see SGD Command
Support on page 1019.

Note • This command applies only to the R110Xi HF printer, firmware version R65.X.

Type getvar; setvar

Note • For details on SGD command structure, see Command Structure on page 630.

This table identifies the command for this format:

Commands Details
getvar This command instructs the printer to respond with the current power
level.
Format: ! U1 getvar
"rfid.reader_1.power.single_power"
setvar This command instructs the printer to set the power level for reading and
writing.
Format: ! U1 setvar
"rfid.reader_1.power.single_power" "value"
Values:
high
medium
low
Default: low

Example • This setvar example sets the antenna to high power for writing to RFID tags.
! U1 setvar "rfid.reader_1.power.single_power" "high"
When the setvar value is set to "high", the getvar result is "high".

P1012728-004 Zebra Programming Guide 06/08/2010

 SGD Printer Settings 701
rfid.reader_1.power.write

rfid.reader_1.power.write
Description This command sets the RFID reader power level for writing to RFID tags. For
printer support, see SGD Command Support on page 1019.

Note • The R110Xi4 printer automatically selects the best antenna element and read/write
power levels for the media during RFID transponder calibration. It may also set the levels
during an adaptive antenna sweep. Use the ~HL command (see ^HL or ~HL on page 380) to
view the antenna element and power settings being used.

Note • This parameter is ignored on the R110Xi HF printer because read and write powers
cannot be specified separately. See rfid.reader_1.power.single_power on page 700 to set the
power level for the R110Xi HF printer.

Type getvar; setvar

Note • For details on SGD command structure, see Command Structure on page 630.

This table identifies the command for this format:

Commands Details
getvar This command instructs the printer to respond with the antenna’s current write power level.
Format: ! U1 getvar "rfid.reader_1.power.write"
setvar This command instructs the printer to set the write power level on the RFID reader.
Format: ! U1 setvar "rfid.reader_1.power.write" "value"
R53.16.3Z:
Values: 0 to 30
Default Value: 16
R53.16.4Z, V53.17.7, and later:
Values: 0 to 30, up, down (up and down change the current value by 1)
Default Value: 16
R60.16.x, R62.16.x, R63.16.x, R65.16.x, SP994Q, SP999G, SP1027G, SP1056F,
SP1082G, and later:
Values: 0 to 30, high, medium, low
Default Value: low
Older firmware:
Values:
high
medium
low
Default: low

6/8/10 Zebra Programming Guide P1012728-004

702 SGD Printer Settings
rfid.reader_1.power.write

Example • This setvar example sets the antenna to high power for writing to RFID tags.
! U1 setvar "rfid.reader_1.power.write" "16"
When the setvar value is set to "16", the getvar result is "16".

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Printer Settings 703
rfid.tag.calibrate

rfid.tag.calibrate
Description This command sets the RFID programming position through a tag calibration,
or it restores the programming position back to the printer default. For the R110Xi4 printer,
this option also selects the best antenna element and read/write power levels for the media.

For more information about RFID tag calibration, refer to the RFID Programming Guide for
your printer. A copy is available online at http://www.zebra.com/manuals. For printer support,
see SGD Command Support on page 1019.

Type setvar

Note • For details on SGD command structure, see Command Structure on page 630.

This table identifies the command for this format:

Commands Details
setvar This command instructs the printer to set the programming position.
Format: ! U1 setvar "rfid.tag.calibrate" "value"
Values:
restore
run

Example 1 • This setvar example restores the programming position back to the printer’s
default value.
! U1 setvar "rfid.tag.calibrate" "restore"

Example 2 • This setvar example performs RFID tag calibration.

To use this command, load the printer with RFID media, and close the printhead.
! U1 setvar "rfid.tag.calibrate" "run"

6/8/10 Zebra Programming Guide P1012728-004 Rev. A

704 SGD Printer Settings
rfid.tag.data

rfid.tag.data
Description This command tells the RFID reader to attempt to read a tag over the RFID
antenna, even if the printhead is open. Results are returned to the host.

Before running this command, position an RFID label over the printer’s RFID antenna.

For more information about this option and for the location of the RFID antenna, refer to the
RFID Programming Guide for your printer. A copy is available online at
http://www.zebra.com/manuals. For printer support, see SGD Command Support
on page 1019.

Type getvar

Note • For details on SGD command structure, see Command Structure on page 630.

This table identifies the command for this format:

Commands Details
getvar This command instructs the printer to respond with the current tag’s data.
Format: ! U1 getvar "rfid.tag.data"

Example 1 • This getvar example gets the current tag’s data, assuming that an RFID label
with data “0123456789ABCDEF12345678” is in place over the antenna.
! U1 setvar "rfid.tag.data"
The printer responds with 0123456789ABCDEF12345678.

Example 2 • This getvar example gets the current tag’s data, assuming that no tag data
can be read or that no tag is present.
! U1 setvar "rfid.tag.data"
The printer responds with NO DATA.

P1012728-004 Rev. A Zebra Programming Guide 6/8/10

 SGD Printer Settings 705
rfid.tag.test

rfid.tag.test
Description This command performs an RFID test. In the RFID test, the printer attempts to
read and write to a transponder that you place over the RFID antenna. Results are displayed on
the printer’s control panel display. For more information about the RFID antenna location,
refer to the RFID Programming Guide for your printer. A copy is available online at
http://www.zebra.com/manuals.

In the slow version of the RFID test, the printer first displays the hardware version, the reader
firmware version, and the program position.For printer support, see SGD Command Support
on page 1019.

Note • This command is valid only on RP4T printers.

Type setvar

Note • For details on SGD command structure, see Command Structure on page 630.

This table identifies the command for this format:

Commands Details
setvar This command instructs the printer to set the programming position.
Format: ! U1 setvar "rfid.tag.test" "value"
Values:
quick
slow

Example 1 • This setvar example performs a quick RFID test, which shows a pass or fail
message.
! U1 setvar "rfid.tag.test" "quick"

Example 2 • This setvar example performs a slow RFID test, which shows the success or
failure of each read or write tag operation.
! U1 setvar "rfid.tag.test" "slow"

6/8/10 Zebra Programming Guide P1012728-004 Rev. A

706 SGD Printer Settings
rfid.tag.type

rfid.tag.type
Description This command sets the reader’s RFID tag type. For printer support, see SGD
Command Support on page 1019.

Type getvar; setvar

Note • For details on SGD command structure, see Command Structure on page 630.

This table identifies the command for this format:

Commands Details
getvar This command instructs the printer to respond with the reader’s current tag type.
Format: ! U1 getvar "rfid.tag.type"
setvar This command instructs the printer to set the reader’s tag type. For the supported tag types,
see Table 27 on page 706.
Format: ! U1 setvar "rfid.tag.type" "value"
Values:
UHF Printers
none = None
class0 = EPC Class 0
class0+ = EPC Class 0 Plus
class1_64bit = EPC Class 1 64-bit
class1_96bit = EPC Class 1 96-bit
ucode_epc_1_19 = UCODE EPC 1.19
class0+_impinj = Impinj Class 0 Plus
ISO18000A = ISO 18000-06A
gen2 = EPC Class 1, Generation 2 (Gen 2)
ISO18000B = ISO 18000-06B
HF Printers
none = None
detect = Auto detect (query tag to determine)
tagit = Tag*It (Texas Instruments Tagit tags)
icode = I*code (Phillips Icode tags)
pico = Pico Tag (Inside Technology’s)
ISO15693 = ISO 15693
EPC = EPC tag (13.56 MHz)
UIC = UID Tag
mifare_ultralight = Mifare UltraLight

Example • This setvar example shows the reader’s tag type being set to Gen 2.
! U1 setvar "rfid.tag.type" "gen2"

P1012728-004 A Zebra Programming Guide 6/8/10

 SGD Printer Settings 707
rfid.tag.type

Supported Tag Types Table 26 shows the tag types supported by different RFID
printers/print engines and firmware versions. Depending on your country or on the firmware
version that you are using, your printer may not support all of the tag types listed. If you
specify an unsupported tag type, the printer uses the default value. If a tag type is shown as
supported but does not work with your printer, you may need to upgrade the printer’s firmware
(see http://www.zebra.com/firmware).

Table 26 • Supported Tag Types and Default Values

UHF Printers HF Printers

RZ400/ RZ600
Printer

R110Xi HF
R110PAX4

R4Mplus

R2844-Z
R110Xi4

R170Xi
R110Xi

SP994O, SP999E, SP1027E,

SP994P, SP999F, SP1027F,

SP1082E, and earlier

SP1056D and earlier

SP1082F, and later

SP1056E and later

R60.15.X and later

R62.15.X and later

R63.15.X and later

R53.16.X and later

R65.15.X and later

V53.17.7 and later

Firmware Version
R60.13.X

R62.13.X

R63.13.X

R65.13.X

all
Tag Type

UHF Tag Types and Options

None (no tag type specified) — * * * * — — — — — — — — — —

EPC Class 0 — * * * * — — — — — — — — — —

EPC Class 0 Plus — * * * * — — — — — — — — — —

EPC Class 1 64-bit — * * * * — — — — — — — — — —

EPC Class 1 96-bit — # * # * — * * * — — — — — —

UCODE EPC 1.19 — *a * — * # * # * # * — — — —

Impinj Class 0 Plus — * * * * — — — — — — — — — —

ISO 18000-06A — — — * — — * * * — — — — — —

EPC Class 1, Generation 2 (Gen 2) # * # * # — # * # * # # — — —

ISO 18000-06B — * * * * — * * * * * — — — —

HF Tag Types and Options —

Auto-detect the tag type by querying the tag — — — — — — — — — — — — — — #

Tag*It (Texas Instruments Tagit tags) — — — — — — — — — — — — — — *

I*code (Phillips Icode tags) — — — — — — — — — — — — — — *

Pico Tag (Inside Technology’s) — — — — — — — — — — — — — — *

ISO 15693 — — — — — — — — — — — — # # *

EPC tag — — — — — — — — — — — — — — *

# = Default value * = Accepted value — = Not supported

a. Requires R60.13.0.13ZD or later.

6/8/10 Zebra Programming Guide P1012728-004 A

708 SGD Printer Settings
rfid.tag.type

Table 26 • Supported Tag Types and Default Values (Continued)

UHF Printers HF Printers

RZ400/ RZ600
Printer

R110Xi HF
R110PAX4

R4Mplus

R2844-Z
R110Xi4

R170Xi
R110Xi

SP994O, SP999E, SP1027E,

SP994P, SP999F, SP1027F,

SP1082E, and earlier

SP1056D and earlier

SP1082F, and later

SP1056E and later

R60.15.X and later

R62.15.X and later

R63.15.X and later

R53.16.X and later

R65.15.X and later

Firmware Version V53.17.7 and later

R60.13.X

R62.13.X

R63.13.X

R65.13.X

all
Tag Type

UID Tag — — — — — — — — — — — — — — —

Mifare UltraLight — — — — — — — — — — — — * * —

# = Default value * = Accepted value — = Not supported

a. Requires R60.13.0.13ZD or later.

P1012728-004 A Zebra Programming Guide 6/8/10

 SGD Printer Commands 709
zbi.control.add_breakpoint

zbi.control.add_breakpoint
Description This command instructs the printer to set a ZBI program break point. For
printer support, see SGD Command Support on page 1019.

Type setvar

Commands Details
setvar This command instructs the printer to set a ZBI program break point.
Format: ! U1 setvar "zbi.control.add_breakpoint" "value"
Values: Any line number of the program currently being debugged.

Note • For details on SGD command structure, see Command Structure on page 630.

Example • This setvar example shows setting the breakpoint at line "30".
! U1 setvar "zbi.control.add_breakpoint" "30"

6/8/10 Zebra Programming Guide P1012728-004

710 SGD Printer Commands
zbi.control.break

zbi.control.break
Description This command breaks the execution of the ZBI 2.0 program that is currently
running. For printer support, see SGD Command Support on page 1019.

Type setvar

Commands Details
setvar This command breaks the execution of the ZBI program that is currently running.
Format: ! U1 setvar "zbi.control.break" ""
Values:
""

Note • For details on SGD command structure, see Command Structure on page 630.

Example • This setvar example shows the value set to "".

! U1 setvar "zbi.control.break" ""

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Printer Commands 711
zbi.control.clear_breakpoints

zbi.control.clear_breakpoints
Description This command deletes all breakpoints in the current ZBI 2.0 program. For
printer support, see SGD Command Support on page 1019.

Type setvar

Commands Details
setvar This command instructs the printer to delete all breakpoints.
Format: ! U1 setvar "zbi.control.clear_breakpoints" ""
Values: ""

Note • For details on SGD command structure, see Command Structure on page 630.

Example • This setvar example shows the value set to "".

! U1 setvar "zbi.control.clear_breakpoints" ""

6/8/10 Zebra Programming Guide P1012728-004

712 SGD Printer Commands
zbi.control.delete_breakpoint

zbi.control.delete_breakpoint
Description This command deletes a breakpoint in the current ZBI 2.0 program. For printer
support, see SGD Command Support on page 1019.

Type setvar

Commands Details
setvar This command instructs the printer to delete the breakpoint at the line indicated by the value
parameter.
Format: ! U1 setvar "zbi.control.delete_breakpoint" "value"
Values: you can use the same value as add_breakpoint.

Note • For details on SGD command structure, see Command Structure on page 630.

Example • This setvar example shows the breakpoint set to "30".

! U1 setvar "zbi.control.delete_breakpoint" "30"

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Printer Commands 713
zbi.control.line_number

zbi.control.line_number
Description This command gives you control and information about which line of a stopped
ZBI 2.0 program is being executed. For printer support, see SGD Command Support
on page 1019.

Type getvar;setvar

Commands Details
getvar This command returns the line number that is currently being executed in the ZBI 2.0
program.
Format: ! U1 getvar "zbi.control.line_number"
setvar This command sets which line of the current ZBI 2.0 program should be executed.
Format: ! U1 setvar "zbi.control.line_number" "value"
Values: Any line number of the currently stopped ZBI program.
Default: "0"

Note • For details on SGD command structure, see Command Structure on page 630.

Example • This setvar example shows the value parameter set to "30".
! U1 setvar "zbi.control.line_number" "30"
When the setvar value is set to "30", the getvar result is "30".

6/8/10 Zebra Programming Guide P1012728-004

714 SGD Printer Commands
zbi.control.restart

zbi.control.restart
Description This command restarts a ZBI 2.0 program that is currently stopped. For printer
support, see SGD Command Support on page 1019.

Type setvar

Commands Details
setvar This command restarts a ZBI 2.0 program that is currently stopped.
Format: ! U1 setvar "zbi.control.restart" "value"
Values:
""

Note • For details on SGD command structure, see Command Structure on page 630.

Example • This setvar example shows the value set to "".

! U1 setvar "zbi.control.restart" ""

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Printer Commands 715
zbi.control.run

zbi.control.run
Description This command runs the current ZBI 2.0 program that is loaded in the
interpreter. For printer support, see SGD Command Support on page 1019.

Type setvar

Commands Details
setvar This command runs the ZBI 2.0 program that is loaded in the interpreter.
Format: ! U1 setvar "zbi.control.run" ""
Values:
""

Note • For details on SGD command structure, see Command Structure on page 630.

Example • This setvar example shows the value set to "".

! U1 setvar "zbi.control.run" ""

6/8/10 Zebra Programming Guide P1012728-004

716 SGD Printer Commands
zbi.control.step

zbi.control.step
Description This command restarts the execution of the currently stopped ZBI 2.0program
for one line. For printer support, see SGD Command Support on page 1019.

Type setvar

Commands Details
setvar This command instructs the printer to restart the execution of the currently stopped ZBI 2.0
program for one line.
Format: ! U1 setvar "zbi.control.step" ""
Values:
""
Default: ""

Note • For details on SGD command structure, see Command Structure on page 630.

Example • This setvar example shows the value set to "".

! U1 setvar "zbi.control.step" ""
When the setvar value is set to "".

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Printer Commands 717
zbi.control.terminate

zbi.control.terminate
Description This command instructs the ZBI 2.0 program to terminate and shuts down the
interpreter. For printer support, see SGD Command Support on page 1019.

Type setvar

Commands Details
setvar This command instructs the ZBI 2.0 program to terminate and shuts down the interpreter.
Format: ! U1 setvar "zbi.control.terminate" "value"
Values: ""

Note • For details on SGD command structure, see Command Structure on page 630.

Example • This setvar example shows the value set to "".

! U1 setvar "zbi.control.terminate" ""

6/8/10 Zebra Programming Guide P1012728-004

718 SGD Printer Commands
zbi.control.variable_name

zbi.control.variable_name
Description This command sets the name of the variable that is to be read or modified
through variable_value. For printer support, see SGD Command Support on page 1019.

Type getvar;setvar

Commands Details
getvar This command retrieves the variable value that is to show on the front panel.
Format: ! U1 getvar "zbi.control.variable_name"
setvar This command sets the variable that is to show on the front panel.
Format: ! U1 setvar "zbi.control.variable_name" "value"
Values: Any ZBI variable in the program that is currently being debugged.
Default: ""

Note • For details on SGD command structure, see Command Structure on page 630.

Example • This setvar example shows the value set to "MYVAR$".

! U1 setvar "zbi.control.variable_name" "MYVAR$"
When the setvar value is set to "MYVAR$", the getvar result is "MYVAR$".

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Printer Commands 719
zbi.control.variable_value

zbi.control.variable_value
Description This command identifies the variable name. For printer support, see SGD
Command Support on page 1019.

Type getvar;setvar

Commands Details
getvar This command retrieves the variable name that is loaded into the variable_name.
Format: ! U1 getvar "zbi.control.variable_value"
setvar This command sets a value to the variable referenced by a variable_name.
Format: ! U1 setvar "zbi.control.variable_value" "value"
Values: A string or integer that is dependent on the variable type in variable_name.
Default: The current value of the variable referenced via variable_name

Note • For details on SGD command structure, see Command Structure on page 630.

Example • This setvar example shows the value set to "Hello World".
! U1 setvar "zbi.control.variable_value" "Hello World"
When the setvar value is set to "Hello World", the getvar result is "Hello
World".

6/8/10 Zebra Programming Guide P1012728-004

720 SGD Printer Commands
zbi.key

zbi.key
Description This command identifies if the ZBI 2.0 option is enabled or disabled on the
printer. For printer support, see SGD Command Support on page 1019.

Type getvar

Commands Details
getvar This command retrieves the status of the ZBI 2.0 option on the printer.
Format: ! U1 getvar "zbi.key"

Note • For details on SGD command structure, see Command Structure on page 630.

Example • In this example, the getvar shows the status of ZBI on the printer.
! U1 getvar "zbi.key"
"ENABLED"

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Printer Commands 721
zbi.last_error

zbi.last_error
Description This command identifies the last error that the ZBI 2.0 interpreter encountered.
For printer support, see SGD Command Support on page 1019.

Type getvar

Commands Details
getvar This command shows the last error that the ZBI 2.0 interpreter encountered.
Format: ! U1 getvar "zbi.last_error"

Note • For details on SGD command structure, see Command Structure on page 630.

Example • This example demonstrates how to make the ZBI 2.0 interpreter return the last
error it encountered.
! U1 getvar "zbi.last_error"

6/8/10 Zebra Programming Guide P1012728-004

722 SGD Printer Commands
zbi.reseller_key

zbi.reseller_key
Description This command allows programs that are encrypted with this key in ZBI-
Developer to run. For printer support, see SGD Command Support on page 1019.

Type setvar

Commands Details
setvar This command allows programs that are encrypted with this key in ZBI developer to run.
Format: ! U1 setvar "zbi.reseller_key" "value"
Values: Any valid encryption key provided by ZBI Developer.

Note • For details on SGD command structure, see Command Structure on page 630.

Example • This setvar example shows the value set to "abc123".

! U1 setvar "zbi.reseller_key" "abc123".

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Printer Commands 723
zbi.revision

zbi.revision
Description This command identifies the current ZBI version. For printer support, see SGD
Command Support on page 1019.

Type getvar

Commands Details
getvar This command retrieves the current ZBI version.
Format: ! U1 getvar "zbi.revision"

Note • For details on SGD command structure, see Command Structure on page 630.

Example • In this example, the getvar shows the current ZBI version.
! U1 getvar "zbi.revision"

6/8/10 Zebra Programming Guide P1012728-004

724 SGD Printer Commands
zbi.running_program_name

zbi.running_program_name
Description This command identifies the name of the ZBI 2.0 program that is currently
running. For printer support, see SGD Command Support on page 1019.

Type getvar

Commands Details
getvar This command retrieves the name of the currently running ZBI 2.0 program.
Format: ! U1 getvar "zbi.running_program_name"

Note • For details on SGD command structure, see Command Structure on page 630.

Example • In this example, the getvar command causes the printer to respond that the
program choices.bas is currently running.
! U1 getvar "zbi.running_program_name"
"CHOICES.BAS"

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Printer Commands 725
zbi.start_info.execute

zbi.start_info.execute
Description This command instructs the ZBI 2.0 environment to execute the program listed
in the file_name. For printer support, see SGD Command Support on page 1019.

Type setvar

Commands Details
setvar This command instructs the ZBI 2.0 environment to execute the program listed in the
file_name.
Format: ! U1 setvar "zbi.start_info.execute"

Note • For details on SGD command structure, see Command Structure on page 630.

Example • This setvar example executes the "choices.bas" program.

! U1 setvar "zbi.start_info.execute" "choices.bas"

6/8/10 Zebra Programming Guide P1012728-004

726 SGD Printer Commands
zbi.start_info.file_name

zbi.start_info.file_name
Description This command prepares a program to run when the
zbi.start_info.execute command is used. This command does not run the program.
For printer support, see SGD Command Support on page 1019.

Type getvar;setvar

Commands Details
getvar This command is used to return the file path and file name of a ZBI 2.0 program to run using
the zbi.start_info.execute command.
Format: ! U1 getvar "zbi.start_info.file_name"
Default: The last program run. If nothing has been run, "*:\.BAZ".
setvar This command is used to prepare a ZBI 2.0 program to be executed using the
zbi.start_info.execute command.
Format:
! U1 setvar "zbi.start_info.file_name" "value"
Values: a file name or path of a basic program

Note • For details on SGD command structure, see Command Structure on page 630.

Example • This setvar example shows the value set to "E:PROGRAM1.BAS".

! U1 setvar "zbi.start_info.file_name" "E:PROGRAM1.BAS"
When the setvar value is set to "E:PROGRAM1.BAS", the getvar result is
"E:PROGRAM1.BAS".

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Printer Commands 727
zbi.start_info.memory_alloc

zbi.start_info.memory_alloc
Description This command identifies the amount of memory currently in use in a ZBI 2.0
program. For printer support, see SGD Command Support on page 1019.

Type getvar

Commands Details
getvar This command shows the amount of memory currently in use in bytes.
Format: ! U1 getvar "zbi.start_info.memory_alloc"

Note • For details on SGD command structure, see Command Structure on page 630.

Example • In this example, the getvar shows the amount of memory currently in use.
! U1 getvar "zbi.start_info.memory_alloc"
"17203"

6/8/10 Zebra Programming Guide P1012728-004

728 SGD Printer Commands
zbi.state

zbi.state
Description This command shows the current state of the ZBI 2.0 program. For printer
support, see SGD Command Support on page 1019.

Type getvar

Commands Details
getvar This command retrieves the current state of ZBI.
Format: ! U1 getvar "zbi.state"
Values:
"running" = ZBI Interpreter is active and running a program
"off" = ZBI Interpreter is inactive
"stopped" = ZBI Interpreter is active but not executing a program

Note • For details on SGD command structure, see Command Structure on page 630.

Example • In this example, the getvar shows that state of ZBI.

! U1 getvar "zbi.state"
"running"

P1012728-004 Zebra Programming Guide 6/8/10

 7
SGD Wired Commands

This chapter provides a high-level overview of the wired Set / Get / Do (SGD) commands. For
printer support of these SGD commands, see SGD Command Support on page 1019.

SGD commands are available in printers with the following firmware versions or later:
• V60.16.2Z or later • V53.15.2Z or later
• V60.15.xZ or later • R53.16.3Z or later
• V50.15.xZ or later • R60.15.8Z or later
• V61.15.xZ or later • R62.15.8Z or later
• V56.15.xZ or later • R63.15.8Z or later
• V53.16.x or later • R65.15.8Z or later

Important • These are important points to note when using ZPL and SGD commands:
• SGD commands are case-sensitive.
• ZPL and SGD commands should be sent to the printer as separate files.
• Certain settings can be controlled by both ZPL and SGD. Configuration changes made in
ZPL can affect configuration changes made in SGD.
• Changes made with one command type (ZPL or SGD) will affect the data returned to the
host in response to both ZPL and getvar commands. The command type (ZPL or SGD)
that was sent last determines the current setting.
• Some RF cards do not support all of the SGD commands.

Important • These are important points to note when using a Zebra G-Series printer:
• You can send instructions to the printer using multiple programming languages: EPL,
ZPL, or SGD. EPL and ZPL commands configure the printer, print labels, and get device
status information. SGD commands set and get configuration details. These three
languages can be used without the need to send the printer instructions to switch from one
language to another.
• EPL, ZPL, and SGD commands must be sent to the printer as separate files. They cannot
be used together in one format, or set of commands. For example, if you send a series of
SGD commands to the printer and they are followed by a printable format, this needs to
be done using separate files.

6/8/10 Zebra Programming Guide P1012728-004

730 SGD Wired Commands
Overview

Overview
This section describes how and why to use the Set / Get / Do (SGD) commands. It also
provides an example of a typical command structure.

Note • SGD commands must be terminated by a carriage return or a space and line feed.

SGD commands are commands that allow you to configure all printers with firmware version
V60.15.x, V50.15.x, V61.15.x, V56.15.x, V53.15.xZ, or later. The printer performs the
specified function immediately after receiving the command. The commands are:
• setvar
• getvar
• do

setvar Command
Setvar commands:
• are used to configure printer settings to specific values by setting them in the printer
• must be terminated by a space character or a CR/ LF (0x0D, 0x0A)

Important • The setvar command and attributes must be specified in lower case.

getvar Command
Getvar commands:
• are used to get the current value of the printer settings
• must be terminated by a space character or CR/LF (0x0D, 0x0A)

The printer responds with the printer setting of “?” if:

• the printer setting does not exist (usually due to incorrect spelling of the printer setting)
• it has not been configured yet

Important • The printer settings and attributes must be specified in lower case.

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wired Commands 731
Overview

do Command
Do commands:
• are used to instruct the printer to perform predefined actions
• must be terminated by a space character or a CR/LF (0x0D, 0x0A)

Some Do commands require additional settings which must be enclosed in double quotes.

Important • The values must be specified in lower case.

6/8/10 Zebra Programming Guide P1012728-004

732 SGD Wired Commands
Command Structure

Command Structure
It is important to understand the structure of the command and its components. A command
structure illustration is provided for each command in this guide.

Example • This is an example of a command structure illustration:

! U1 setvar "ip.addr" "value"

1 2 3

1 Command—always preceded with an exclamation point (!) and must be specified in

lower case. A space resides between the !and U1 and between U1 and the command
(setvar or getvar).
2 Attribute—always in double quotes and must be specified in lower case.
3 Chosen value—always in double quotes. Only applicable for setvar and do.

This command must be terminated by a space character or a CR/ LF (0x0D, 0x0A).

How to Send Multiple SGD Commands

For any getvar, setvar, or do command, if you issue the syntax without the "1" and use
the END command followed by a space, multiple SGD commands are sent simultaneously.

Example • This syntax shows how you can send multiple getvar commands:

1 ! U getvar "ip.telnet.enable"

getvar "ip.dhcp.enable"
2
getvar "ip.dhcp.cid_prefix"

3 END

1 The command portion of the string does not use the "1" after the "! U".
2 Commands issued after the first command do not require the "! U".
3 The string of commands is terminated by the word "END" with a space after the
word, and by a carriage return/ line feed.

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wired Commands 733
external_wired.check

external_wired.check
Description This command controls whether to check for external print server during the
network interface search. For printer support, see SGD Command Support on page 1019.

Type getvar;setvar

Commands Details
getvar This command retrieves the status of the network interface search.
Format: ! U1 getvar "external_wired.check"
setvar This command instructs the printer to set the network interface search.
Format: ! U1 setvar "external_wired.check" "value"
Values:
"on" = turn on external wired network interface search
"off" = turn off external wired network interface search
Default:
"on" = If wireless option board is not installed
"off" = If wireless option board is installed

Note • For details on SGD command structure, see Command Structure on page 732.

Example • This setvar example shows the value set to "off".

! U1 setvar "external_wired.check" "off"
When the setvar value is set to "off", the getvar result is "off".

6/8/10 Zebra Programming Guide P1012728-004

734 SGD Wired Commands
external_wired.ip.addr

external_wired.ip.addr
Description This command allows you to get or set the external wired print servers’s IP
address. For printer support, see SGD Command Support on page 1019.

Important • For a set IP address to take affect, the IP protocol must be set to permanent and
the print server must be reset.

Type getvar; setvar

Commands Details
getvar * This command instructs the printer to respond with its current external wired print server IP
address.
Format: ! U1 getvar "external_wired.ip.addr"
setvar This command instructs the printer to change its current external wired print server IP
address upon powering the printer on.
Format: ! U1 setvar "external_wired.ip.addr" "value"
Values: any valid IP address
Default: "0.0.0.0"

* On SEH print server models PS102-Z or the PS105-Z, only the getvar command is
supported.

Note • For details on SGD command structure, see Command Structure on page 732.

Note • The setvar value of this command can be affected by the

external_wired.ip.dhcp.enable command.

Example • This setvar example shows the value set to "10.14.4.235".

! U1 setvar "external_wired.ip.addr" "10.14.4.235"
What the setvar value is set to is the getvar result. In this example, the getvar result is
"10.14.4.235".

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wired Commands 735
external_wired.ip.arp_interval

external_wired.ip.arp_interval
Description This print server setting allows you to specify the ARP (Address Resolution
Protocol) interval or the ARP cache time out for the external wired print server. For printer
support, see SGD Command Support on page 1019.

Type getvar; setvar

Commands Details
getvar * This command instructs the printer to respond with the ARP interval or the ARP cache time
out value for the external wired print server.
Format: ! U1 getvar "external_wired.ip.arp_interval"
setvar This command instructs the printer to change the ARP interval or the ARP cache time out
for the external wired print server.
Format: ! U1 setvar "external_wired.ip.arp_interval" "value"
Values: 0 - 30
Default: "0"

* On SEH print server models PS102-Z or the PS105-Z, only the getvar command is
supported.

Note • For details on SGD command structure, see Command Structure on page 732.

Example • This setvar example shows the value set to "0".

! U1 setvar "external_wired.ip.arp_interval" "0"
What the setvar value is set to is the getvar result. In this example, the getvar result is
"0".

6/8/10 Zebra Programming Guide P1012728-004

736 SGD Wired Commands
external_wired.ip.default_addr_enable

external_wired.ip.default_addr_enable
Description This command allows you to default the external wired print server’s IP
address. For printer support, see SGD Command Support on page 1019.

Important • For a set IP address to take affect, the IP protocol must be set to permanent and
the print server must be reset.

Type getvar; setvar

Commands Details
getvar * This command instructs the printer to show the status of the setting of external wired print
server’s default IP address feature.
Format: ! U1 getvar "external_wired.ip.default_addr_enable"
setvar This command tells the printer to use it’s default address, if no address is provided through
DHCP or BOOTP. If you do not assign an IP address after 2 minutes, the 10/100 Internal PS
defaults to IP address 192.168.254.254.
Format:
! U1 setvar "external_wired.ip.default_addr_enable" "value"
Values:
"on" = enabled
"off" = disabled
Default: "on"

* On SEH print server models PS102-Z or the PS105-Z, only the getvar command is
supported.

Note • For details on SGD command structure, see Command Structure on page 732.

Example • This setvar example shows the value set to "on".

! U1 setvar "external_wired.ip.default_addr_enable" "on"
What the setvar value is set to is the getvar result. In this example, the getvar result is
"on".

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wired Commands 737
external_wired.ip.dhcp.cid_all

external_wired.ip.dhcp.cid_all
Description This printer setting defines the entire client identifier (DHCP option 61) if
DHCP is enabled on the external print server and
"external_wired.ip.dhcp.cid_type" is set to "0", or "2". The MAC address is
used if the type is set to "1". For printer support, see SGD Command Support on page 1019.

Type getvar; setvar

Commands Details
getvar * This command instructs the printer to respond with the client identifier prefix and suffix of
the external wired print server.
Format: ! U1 getvar "external_wired.ip.dhcp.cid_all"
setvar This command instructs the printer to change the client identifier prefix and suffix of the
external wired print server. The prefix gets cleared and the suffix contains the entire client
identifier.
Format: ! U1 setvar "external_wired.ip.dhcp.cid_all" "value"
Values: A maximum length of 60 characters if the CID type is ASCII, or 120 characters if
the CID type is hexadecimal.
Default Value: ""

* On SEH print server models PS102-Z or the PS105-Z, only the getvar command is
supported.

Note • For details on SGD command structure, see Command Structure on page 732.

Example • This setvar example shows the value set to "printer".

! U1 setvar "external_wired.ip.dhcp.cid_all" "printer"
What the setvar value is set to is the getvar result. In this example, the getvar result is
"printer".

6/8/10 Zebra Programming Guide P1012728-004

738 SGD Wired Commands
external_wired.ip.dhcp.cid_enable

external_wired.ip.dhcp.cid_enable
Description This command determines if DHCP (option 61) on the external wired print
server is turned on or off. For printer support, see SGD Command Support on page 1019.

Type getvar; setvar

Commands Details
getvar * This command instructs the printer to respond with the status of the client identifier of the
external wired print server.
Format: ! U1 getvar "external_wired.ip.dhcp.cid_enable"
setvar This command instructs the printer to set the status of the client identifier of the external
wired print server.
Format: ! U1 setvar "external_wired.ip.dhcp.cid_enable" "value"
Values:
"off" = client identifier is turned off
"on" = client identifier is turned on
Default: "off"

* On SEH print server models PS102-Z or the PS105-Z, only the getvar command is
supported.

Note • For details on SGD command structure, see Command Structure on page 732.

Example • This setvar example shows the value set to "off".

! U1 setvar "external_wired.ip.dhcp.cid_enable" "off"
What the setvar value is set to is the getvar result. In this example, the getvar result is
"off".

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wired Commands 739
external_wired.ip.dhcp.cid_prefix

external_wired.ip.dhcp.cid_prefix
Description This printer setting defines the prefix to be prepended to the DHCP client
identifier (option 61) when DHCP is enabled on the external wired print server and
"external_wired.ip.dhcp.cid_type" is set to "0" or "2". For printer support,
see SGD Command Support on page 1019.

Type getvar; setvar

Commands Details
getvar * This command instructs the printer to respond with the client identifier prefix of the external
wired print server.
Format: ! U1 getvar "external_wired.ip.dhcp.cid_prefix"
setvar This command instructs the printer to change the CID prefix of the external wired print
server.
Format: ! U1 setvar "external_wired.ip.dhcp.cid_prefix" "value"
Values: Any text string up to 10 characters if the CID type is ASCII, or 20 characters if the
CID type is hexadecimal.
Default Value: ""

* On SEH print server models PS102-Z or the PS105-Z, only the getvar command is
supported.

Note • For details on SGD command structure, see Command Structure on page 732.

Example • This setvar example shows the value set to "PRT001".

! U1 setvar "external_wired.ip.dhcp.cid_prefix" "PRT001"
What the setvar value is set to is the getvar result. In this example, the getvar result is
"PRT001".

6/8/10 Zebra Programming Guide P1012728-004

740 SGD Wired Commands
external_wired.ip.dhcp.cid_suffix

external_wired.ip.dhcp.cid_suffix
Description This printer setting defines the unique suffix to be used as the client identifier
(DHCP option 61) if DHCP is enabled repeated on the external wired print server and
external_wired.ip.dhcp.cid_type on page 741 is set to "0" or "2", not "1". For printer
support, see SGD Command Support on page 1019.

Type getvar; setvar

Commands Details
getvar * This command instructs the printer to respond with the client identifier suffix on the external
wired print server.
Format: ! U1 getvar "external_wired.ip.dhcp.cid_suffix"
setvar This command instructs the printer to change the client identifier suffix value.
Format: ! U1 setvar "external_wired.ip.dhcp.cid_suffix" "value"
Values: The maximum length of a value allowed is 60 ASCII characters when the CID type
is ASCII, or 120 hexadecimal values when the CID type is hexadecimal.
Default: ""

* On SEH print server models PS102-Z or the PS105-Z, only the getvar command is
supported.

Note • For details on SGD command structure, see Command Structure on page 732.

Example • This setvar example shows setting the suffix to "printer".

! U1 setvar "external_wired.ip.dhcp.cid_suffix" "printer"
What the setvar value is set to is the getvar result. In this example, the getvar result is
"printer".

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wired Commands 741
external_wired.ip.dhcp.cid_type

external_wired.ip.dhcp.cid_type
Description This printer setting defines the type of client identifier (DHCP option 61) that
will be sent if DHCP is enabled on the external wired print server. A value of "1" means the
type of "Ethernet" and the printer’s MAC address will be used. A value of "0" or "2" means
the client identifier sent will be "external_wired.ip.dhcp.cid_prefix"
concatenated with "external_wired.ip.dhcp.cid_suffix". For printer support,
see SGD Command Support on page 1019.

Type getvar; setvar

Commands Details
getvar * This command instructs the printer to respond with the client identifier type for the external
wired print server.
Format: ! U1 getvar "external_wired.ip.dhcp.cid_type"
setvar This command instructs the printer to enable "synthetic" Client Identifier for the external
wired print server.
Format: ! U1 setvar "external_wired.ip.dhcp.cid_type" "value"
Values:
"0" = ASCII string
"1" = wired print server’s MAC address
"2" = HEX value
Default Value: "1"

* On SEH print server models PS102-Z or the PS105-Z, only the getvar command is
supported.

Note • For details on SGD command structure, see Command Structure on page 732.

Example • This setvar example shows the value set to "1".

! U1 setvar "external_wired.ip.dhcp.cid_type" "1"
When the setvar value is set to "1", the getvar result is "1".

6/8/10 Zebra Programming Guide P1012728-004

742 SGD Wired Commands
external_wired.ip.gateway

external_wired.ip.gateway
Description This command instructs the printer to change the external wired print server’s
gateway address. For printer support, see SGD Command Support on page 1019.

Important • This setting refers to the gateway address. A set value is ignored if the IP
protocol is not set to permanent.

Type getvar; setvar

Commands Details
getvar * This command instructs the printer to respond with the external wired printer server’s
gateway address.
Format: ! U1 getvar "external_wired.ip.gateway"
setvar This command instructs the printer to change the external wired printer server’s gateway
address.
Format: ! U1 setvar "external_wired.ip.gateway" "value"
Values: Any valid gateway address
Default: "0.0.0.0"

* On SEH print server models PS102-Z or the PS105-Z, only the getvar command is
supported.

Note • For details on SGD command structure, see Command Structure on page 732.

Example • This setvar example shows the value set to "10.3.5.1".

! U1 setvar "external_wired.ip.gateway" "10.3.5.1"
When the setvar value is set to "10.3.5.1", the getvar result is "10.3.5.1".

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wired Commands 743
external_wired.ip.netmask

external_wired.ip.netmask
Description This setting refers to the external wired print server’s subnet mask address.
This value is ignored if the IP protocol is not set to permanent. For printer support, see SGD
Command Support on page 1019.

Type getvar; setvar

Commands Details
getvar * This command instructs the printer to respond with the external wired print server’s subnet
mask.
Format: ! U1 getvar "external_wired.ip.netmask"
setvar This command instructs the printer to change the external wired print servers’s subnet mask.
Format:
! U1 setvar "external_wired.ip.netmask" "value"
Values: Any valid subnet mask.
Default: "255.255.255.0"

* On SEH print server models PS102-Z or the PS105-Z, only the getvar command is
supported.

Note • For details on SGD command structure, see Command Structure on page 732.

Example • This setvar example shows the value set to "255.255.255.0".

! U1 setvar "external_wired.ip.netmask" "255.255.255.0"
When the setvar value is set to "255.255.255.0", the getvar result is
"255.255.255.0".

6/8/10 Zebra Programming Guide P1012728-004

744 SGD Wired Commands
external_wired.ip.port

external_wired.ip.port
Description This printer setting refers to the external wired print server’s port number that
the TCP print service is listening on. Normal TCP communications from the host should be
directed to this port. For printer support, see SGD Command Support on page 1019.

Type getvar; setvar

Commands Details
getvar * This command instructs the printer to respond with the external wired printer server’s
TCP/UDP port number.
Format: ! U1 getvar "external_wired.ip.port"
setvar This command instructs the printer to set the external wired print server’s TCP/UDP port
number.
Format: ! U1 setvar "external_wired.ip.port" "value"
Values: 1 - 65535 (excluding any ports currently used by other services, such as 21, 23, 80,
and 515).
Default: "9100"

* On SEH print server models PS102-Z or the PS105-Z, only the getvar command is
supported.

Note • For details on SGD command structure, see Command Structure on page 732.

Example • This setvar example shows the value set to "9100".

! U1 setvar "external_wired.ip.port" "9100"
When the setvar value is set to "9100", the getvar result is "9100".

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wired Commands 745
external_wired.ip.protocol

external_wired.ip.protocol
Description This command configures the IP addressing method used by the external wired
print server. For printer support, see SGD Command Support on page 1019.

Type getvar; setvar

Commands Details
getvar * This command returns the IP addressing method used by the external print server.
Format: ! U1 getvar "external_wired.ip.protocol"
setvar This command instructs the printer to configure the IP addressing method used by the
external wired print server.
Format: ! U1 setvar "external_wired.ip.protocol" "value"
Values:
"bootp" = uses the standard bootp addressing method to obtain an IP address and
configuration
"dhcp" = uses the standard dhcp addressing method to obtain an IP address and
configuration for a server specified period of time
"rarp" = uses the standard rarp addressing method to obtain an IP address
"glean" = uses the IP address from a PING packet that is sent to its hardware
address (unicast address)
“permanent” = uses static values assigned through other commands
"all" = tries all of the dynamic addressing methods, not permanent, to obtain an IP
address
Default: "all"

* On SEH print server models PS102-Z or the PS105-Z, only the getvar command is
supported.

Note • For details on SGD command structure, see Command Structure on page 732.

Example • In this example, the setvar result is the current programming language that the
printer is using.
! U1 setvar "external_wired.ip.protocol" "bootp"
What the setvar value is set to is the getvar result. In this example, the getvar result is
"bootp".

6/8/10 Zebra Programming Guide P1012728-004

746 SGD Wired Commands
external_wired.ip.timeout.enable

external_wired.ip.timeout.enable
Description This network setting refers to enabling the connection timeout on the external
wired 10/100 print server. For this to take effect, the print server must be reset. For printer
support, see SGD Command Support on page 1019.

Type getvar; setvar

Commands Details
getvar * This command instructs the printer to return whether the timeout checking is enabled on the
external wired print server.
Format:
! U1 getvar "external_wired.ip.timeout.enable"
setvar This command instructs the printer to enable or disable the timeout checking on the external
wired print server.
Format:
! U1 setvar "external_wired.ip.timeout.enable" "value"
Values:
"off" = turns off the connection checking
"on" = turns on the connection checking
Default: "on"

* On SEH print server models PS102-Z or the PS105-Z, only the getvar command is
supported.

Note • For details on SGD command structure, see Command Structure on page 732.

Example • This setvar example shows the value set to "on".

! U1 setvar "external_wired.ip.timeout.enable" "on"
When the setvar value is set to "on", the getvar result is "on".

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wired Commands 747
external_wired.ip.timeout.value

external_wired.ip.timeout.value
Description This network setting refers to the number of seconds before the connection
times out for the external wired print server. For printer support, see SGD Command Support
on page 1019.

Type getvar; setvar

Commands Details
getvar * This command instructs the printer to respond with the time of the external wired print
server, in seconds, before the connection times out.
Format:
! U1 getvar "external_wired.ip.timeout.value"
setvar This command instructs the printer to set the time of the external wired print server, in
seconds, before the connection times out.
Format:
! U1 setvar "external_wired.ip.timeout.value" "value"
Values: "1" through "3600"
Default: "300"

* On SEH print server models PS102-Z or the PS105-Z, only the getvar command is
supported.

Note • For details on SGD command structure, see Command Structure on page 732.

Example • This setvar example shows the value set to "300".

! U1 setvar "external_wired.ip.timeout.value" "300"
When the setvar value is set to "300", the getvar result is "300".

6/8/10 Zebra Programming Guide P1012728-004

748 SGD Wired Commands
external_wired.ip.v6.addr

external_wired.ip.v6.addr
Description This command retrieves the IPv6 address of the SEH wired print server. This
command is only supported on SEH print server models PS105-Z and PS102-Z with firmware
version V60.16.5Z or V53.16.5Z and later. For printer support, see SGD Command Support
on page 1019.

Supported Devices
• SEH print server model PS105-Z with firmware version V60.16.5Z or V53.16.5Z and
later.
• SEH print server model PS102-Z with firmware version V60.16.5Z or V53.16.5Z and
later.

Type getvar

Commands Details
getvar This command retrieves the IPv6 address of the SEH wired print server.
Format: ! U1 getvar "external_wired.ip.v6.addr"
Values:
8 group of four hexadecimal digits with a colon delimiter
character set = A-F or 0-9 (39-character maximum)

Note • For details on SGD command structure, see Command Structure on page 732.

Example • In this example, the getvar returns the IPv6 address of the wired print server.
! U1 getvar "external_wired.ip.v6.addr"

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wired Commands 749
external_wired.ip.v6.gateway

external_wired.ip.v6.gateway
Description This command retrieves the IPv6 gateway of the SEH wired print server. For
printer support, see SGD Command Support on page 1019.

Supported Devices
• SEH print server model PS105-Z with firmware version V60.16.5Z or V53.16.5Z and
later.
• SEH print server model PS102-Z with firmware version V60.16.5Z or V53.16.5Z and
later.

Type getvar

Commands Details
getvar This command retrieves the IPv6 gateway of the SEH wired print server.
Format: ! U1 getvar "external_wired.ip.v6.gateway"
Values:
8 group of four hexadecimal digits with a colon delimiter
character set = A-F or 0-9 (39-character maximum)

Note • For details on SGD command structure, see Command Structure on page 732.

Example • In this example, the getvar returns the IPv6 gateway of the wired print server.
! U1 getvar "external_wired.ip.v6.gateway"

6/8/10 Zebra Programming Guide P1012728-004

750 SGD Wired Commands
external_wired.ip.v6.prefix_length

external_wired.ip.v6.prefix_length
Description This command retrieves the IPv6 address prefix length of the SEH wired print
server. For printer support, see SGD Command Support on page 1019.

Supported Devices
• SEH print server model PS105-Z with firmware version V60.16.5Z or V53.16.5Z and
later.
• SEH print server model PS102-Z with firmware version V60.16.5Z or V53.16.5Z and
later.

Type getvar

Commands Details
getvar This command retrieves the IPv6 address prefix length of the SEH wired print server.
Format:
! U1 getvar "external_wired.ip.v6.prefix_length"
Values: character set = 0-9 (3-character maximum)

Note • For details on SGD command structure, see Command Structure on page 732.

Example • In this example, the getvar returns the IPv6 address prefix length of the wired
print server.
! U1 getvar "external_wired.ip.v6.prefix_length"

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wired Commands 751
external_wired.mac_addr

external_wired.mac_addr
Description This command retrieves the MAC address of the external wired print server.
For printer support, see SGD Command Support on page 1019.

Type getvar

Commands Details
getvar This command instructs the printer to respond with the MAC address of the external wired
print server.
Format: ! U1 getvar "external_wired.mac_addr"

Note • For details on SGD command structure, see Command Structure on page 732.

Example • In this example, the getvar result is the MAC address of the external wired
print server.
! U1 getvar "external_wired.mac_addr"

6/8/10 Zebra Programming Guide P1012728-004

752 SGD Wired Commands
external_wired.mac_raw

external_wired.mac_raw
Description This command specifies the RAW MAC address of the external print server.
The raw mac address is the mac address without the colons (":"). For printer support, see
SGD Command Support on page 1019.

Type getvar

Commands Details
getvar This command retrieves the RAW MAC address of the external print server.
Format: ! U1 getvar "external_wired.mac_raw"

Note • For details on SGD command structure, see Command Structure on page 630.

Example • In this example, the getvar retrieves the RAW MAC address of the external
print server.
! U1 getvar "external_wired.mac_raw"

"00074d2408ff"

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Printer Settings 753
internal_wired.auto_switchover

internal_wired.auto_switchover
Description This command instructs the printer to switch from wireless to the internal wired
print server when an Ethernet cable is plugged into the printer and the printer detects an active
data link. For printer support, see SGD Command Support on page 1019.

Supported Devices
• ZM400/ZM600
• RZ400/RZ600

Important • For this command to work, be sure:

• you are using a ZM400/ZM600 or RZ400/RZ600 printer with both the internal 10/100
wired print server and wireless option board installed
• the value for this command is set to "on" (switchover enabled)
• the printer is currently communicating to the network through a wireless connection
• a Ethernet cable is plugged into the ZM400/ZM600 or RZ400/RZ600 printer and the
printer recognizes a data link connection
When the above conditions exist and an active Ethernet cable is plugged into an internal
wired print server, the printer will detect the wired data link and automatically switch to the
wired interface. The printer will automatically switch back to the wireless interface when the
Ethernet cable is disconnected.

Type getvar;setvar

Commands Details
getvar This command retrieves the current automatic switchover value.
Format: ! U1 getvar "internal_wired.auto_switchover"
setvar This command configures switches between the wireless and wired interfaces.
Format: ! U1 setvar "internal_wired.auto_switchover" "value"
Values:
"on" = switchover enabled
"off" = switchover disabled
Default: "off"

Note • For details on SGD command structure, see Command Structure on page 630.

Example • This setvar example shows the value set to "off".

! U1 setvar "internal_wired.auto_switchover" "off"
When the setvar value is set to "off", the getvar result is "off".

6/8/10 Zebra Programming Guide P1012728-004

754 SGD Wired Commands
internal_wired.ip.addr

internal_wired.ip.addr
Description This command allows you to get or set the internal wired print servers’s IP
address. For printer support, see SGD Command Support on page 1019.

Important • For a set IP address to take affect, the IP protocol must be set to permanent and
the print server must be reset.

Type getvar; setvar

Commands Details
getvar This command instructs the printer to respond with its current internal wired print server IP
address.
Format: ! U1 getvar "internal_wired.ip.addr"
setvar This command instructs the printer to change its current internal wired print server IP
address upon powering the printer on.
Format: ! U1 setvar "internal_wired.ip.addr" "value"
Values: any valid IP address
Default: "0.0.0.0"

Note • For details on SGD command structure, see Command Structure on page 732.

Note • The setvar value of this command can be affected by the

internal_wired.ip.dhcp.enable command.

Example • This setvar example shows the value set to "10.14.4.235".

! U1 setvar "internal_wired.ip.addr" "10.14.4.235"
What the setvar value is set to is the getvar result. In this example, the getvar result is
"10.14.4.235".

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wired Commands 755
internal_wired.ip.arp_interval

internal_wired.ip.arp_interval
Description This print server setting allows you to specify the ARP (Address Resolution
Protocol) interval or the ARP cache time out for the internal wired print server. For printer
support, see SGD Command Support on page 1019.

Type getvar; setvar

Commands Details
getvar This command instructs the printer to respond with the ARP interval or the ARP cache time
out value for the internal wired print server.
Format: ! U1 getvar "internal_wired.ip.arp_interval"
setvar This command instructs the printer to change the ARP interval or the ARP cache time out
for the internal wired print server.
Format: ! U1 setvar "internal_wired.ip.arp_interval" "value"
Values: 0 - 30
Default: "0"

Note • For details on SGD command structure, see Command Structure on page 732.

Example • This setvar example shows the value set to "0".

! U1 setvar "internal_wired.ip.arp_interval" "0"
What the setvar value is set to is the getvar result. In this example, the getvar result is
"0".

6/8/10 Zebra Programming Guide P1012728-004

756 SGD Wired Commands
internal_wired.ip.default_addr_enable

internal_wired.ip.default_addr_enable
Description This command allows you to default the internal wired print server’s IP
address. For printer support, see SGD Command Support on page 1019.

Important • For a set IP address to take affect, the IP protocol must be set to permanent and
the print server must be reset.

Type getvar; setvar

Commands Details
getvar This command instructs the printer to show the status of the setting of internal wired print
server’s default IP address feature.
Format: ! U1 getvar "internal_wired.ip.default_addr_enable"
setvar This command tells the printer to use it’s default address, if no address is provided through
DHCP or BOOTP. If you do not assign an IP address after 2 minutes, the 10/100 Internal PS
defaults to IP address 192.168.254.254.
Format:
! U1 setvar "internal_wired.ip.default_addr_enable" "value"
Values:
"on" = enabled
"off" = disabled
Default: "on"

Note • For details on SGD command structure, see Command Structure on page 732.

Example • This setvar example shows the value set to "on".

! U1 setvar "internal_wired.ip.default_addr_enable" "on"
What the setvar value is set to is the getvar result. In this example, the getvar result is
"on".

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wired Commands 757
internal_wired.ip.dhcp.cache_ip

internal_wired.ip.dhcp.cache_ip
Description This command enables or disables the IP cache on the internal wired print
server. For printer support, see SGD Command Support on page 1019.

Supported Devices
• ZM400/ZM600
• RZ400/RZ600

Type getvar;setvar

Commands Details
getvar This command retrieves the status of the IP cache on the internal wired print server.
Format: ! U1 getvar "internal_wired.ip.dhcp.cache_ip"
setvar This command sets the status of the IP cache.
Format: ! U1 setvar "internal_wired.ip.dhcp.cache_ip" "value"
Values:
"on" = enabled
"off" = disabled
Default: "off"

Note • For details on SGD command structure, see Command Structure on page 732.

Example • This setvar example shows the value set to "off".

! U1 setvar "internal_wired.ip.dhcp.cache_ip" "off"
When the setvar value is set to "off", the getvar result is "off".

6/8/10 Zebra Programming Guide P1012728-004

758 SGD Wired Commands
internal_wired.ip.dhcp.cid_all

internal_wired.ip.dhcp.cid_all
Description This printer setting defines the entire client identifier (DHCP option 61) if
DHCP is enabled on the internal print server and
"internal_wired.ip.dhcp.cid_type" is set to "0", or "2". The MAC address is
used if the type is set to "1". For printer support, see SGD Command Support on page 1019.

Type getvar;setvar

Commands Details
getvar This command instructs the printer to respond with the client identifier prefix and suffix of
the internal wired print server.
Format: ! U1 getvar "internal_wired.ip.dhcp.cid_all"
setvar This command instructs the printer to change the client identifier prefix and suffix of the
internal wired print server. The prefix gets cleared and the suffix contains the entire client
identifer.
Format: ! U1 setvar "internal_wired.ip.dhcp.cid_all" "value"
Values: A maximum length of 60 characters if the CID type is ASCII, or 120 characters if
the CID type is hexadecimal.
Default Value: ""

Note • For details on SGD command structure, see Command Structure on page 732.

Example • This setvar example shows the value set to "printer".

! U1 setvar "internal_wired.ip.dhcp.cid_all" "printer"
What the setvar value is set to is the getvar result. In this example, the getvar result is
"printer".

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wired Commands 759
internal_wired.ip.dhcp.cid_enable

internal_wired.ip.dhcp.cid_enable
Description This command determines if DHCP (option 61) is turned on or off of the
internal wired print server. For printer support, see SGD Command Support on page 1019.

Type getvar; setvar

Commands Details
getvar This command instructs the printer to respond with the status of the client identifier of the
internal wired print server.
Format: ! U1 getvar "internal_wired.ip.dhcp.cid_enable"
setvar This command instructs the printer to set the status of the client identifier of the internal
wired print server.
Format: ! U1 setvar "internal_wired.ip.dhcp.cid_enable" "value"
Values:
"off" = client identifier is turned off
"on" = client identifier is turned on
Default: "off"

Note • For details on SGD command structure, see Command Structure on page 732.

Example • This setvar example shows the value set to "off".

! U1 setvar "internal_wired.ip.dhcp.cid_enable" "off"
What the setvar value is set to is the getvar result. In this example, the getvar result is
"off".

6/8/10 Zebra Programming Guide P1012728-004

760 SGD Wired Commands
internal_wired.ip.dhcp.cid_prefix

internal_wired.ip.dhcp.cid_prefix
Description This printer setting defines the prefix to be prepended to the DHCP client
identifier (option 61) when DHCP is enabled on the internal wired print server and
"internal_wired.ip.dhcp.cid_type" is set to "0" or "2". For printer support,
see SGD Command Support on page 1019.

Type getvar;setvar

Commands Details
getvar This command instructs the printer to respond with the client identifier prefix of the internal
wired print server.
Format: ! U1 getvar "internal_wired.ip.dhcp.cid_prefix"
setvar This command instructs the printer to change the CID prefix of the internal wired print
server.
Format: ! U1 setvar "internal_wired.ip.dhcp.cid_prefix" "value"
Values: Any text string up to 10 characters if the CID type is ASCII, or 20 characters if the
CID type is hexadecimal.
Default Value: ""

Note • For details on SGD command structure, see Command Structure on page 732.

Example • This setvar example shows the value set to "PRT001".

! U1 setvar "internal_wired.ip.dhcp.cid_prefix" "PRT001"
What the setvar value is set to is the getvar result. In this example, the getvar result is
"PRT001".

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wired Commands 761
internal_wired.ip.dhcp.cid_suffix

internal_wired.ip.dhcp.cid_suffix
Description This printer setting defines the unique suffix to be used as the client identifier
(DHCP option 61) if DHCP is enabled on the internal wired 10/100 print server and
"internal_wired.ip.dhcp.cid_type" is set to "0" or "2". For printer support,
see SGD Command Support on page 1019.

Type getvar; setvar

Commands Details
getvar This command instructs the printer to respond with the client identifier suffix of the internal
wired 10/100 print server.
Format: ! U1 getvar "internal_wired.ip.dhcp.cid_suffix"
setvar This command instructs the printer to change the client identifier suffix value of the internal
wired 10/100 print server.
Format: ! U1 setvar "internal_wired.ip.dhcp.cid_suffix" "value"
Values: The maximum length of a value allowed is 60 ASCII characters when the CID type
is ASCII, or 120 hexadecimal values when the CID type is hexadecimal.
Default: ""

Note • For details on SGD command structure, see Command Structure on page 732.

Example • This setvar example shows the value set to "printer".

! U1 setvar "internal_wired.ip.dhcp.cid_suffix" "printer"

What the setvar value is set to is the getvar result. In this example, the getvar result is
"printer".

6/8/10 Zebra Programming Guide P1012728-004

762 SGD Wired Commands
internal_wired.ip.dhcp.cid_type

internal_wired.ip.dhcp.cid_type
Description This printer setting defines the type of client identifier (DHCP option 61) that
will be sent if DHCP is enabled on the internal wired print server. A value of "1" means the
type of "Ethernet" and the printer’s MAC address will be used.A value of "0" or "2" means
the client identifier sent will be "internal_wired.ip.dhcp.cid_prefix"
concatenated with "internal_wired.ip.dhcp.cid_suffix". For printer support,
see SGD Command Support on page 1019.

Type getvar; setvar

Commands Details
getvar This command instructs the printer to respond with the client identifier type for the internal
wired print server.
Format: ! U1 getvar "internal_wired.ip.dhcp.cid_type"
setvar This command instructs the printer to enable "synthetic" Client Identifier for the internal
wired print server.
Format: ! U1 setvar "internal_wired.ip.dhcp.cid_type" "value"
Values:
"0" = ASCII string
"1" = wired print server’s MAC address
"2" = HEX value
Default Value: "1"

Note • For details on SGD command structure, see Command Structure on page 732.

Example • This setvar example shows the value set to "1".

! U1 setvar "internal_wired.ip.dhcp.cid_type" "1"
When the setvar value is set to "1", the getvar result is "1".

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wired Commands 763
internal_wired.ip.dhcp.lease.last_attempt

internal_wired.ip.dhcp.lease.last_attempt
Description This command retrieves the last time a DHCP request was sent from the
internal wired print server. For printer support, see SGD Command Support on page 1019.

Supported Devices
• ZM400/ZM600
• RZ400/RZ600

Type getvar

Commands Details
getvar This command retrieves the last time a DHCP request was sent from the internal wired print
server.
Format: ! U1 getvar "internal_wired.ip.dhcp.lease.last_attempt"

Note • For details on SGD command structure, see Command Structure on page 732.

Example • In this example, the getvar retrieves the last time a DHCP request was sent to
the internal wired print server.
! U1 getvar "internal_wired.ip.dhcp.lease.last_attempt"

6/8/10 Zebra Programming Guide P1012728-004

764 SGD Wired Commands
internal_wired.ip.dhcp.lease.length

internal_wired.ip.dhcp.lease.length
Description This command retrieves the original length (in seconds) of the DHCP lease on
the internal wired print server. For printer support, see SGD Command Support on page 1019.

Supported Devices
• ZM400/ZM600
• RZ400/RZ600

Type getvar

Commands Details
getvar This command retrieves the original length (in seconds) of the DHCP lease on the internal
wired print server.
Format: ! U1 getvar "internal_wired.ip.dhcp.lease.length"

Note • For details on SGD command structure, see Command Structure on page 732.

Example • In this example, the getvar returns the original length of the DHCP lease on
the internal wired print server.
! U1 getvar "internal_wired.ip.dhcp.lease.length"

"691200"

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wired Commands 765
internal_wired.ip.dhcp.lease.server

internal_wired.ip.dhcp.lease.server
Description This command retrieves the address of the server that provided the DHCP lease
on the internal wired print server. For printer support, see SGD Command Support
on page 1019.

Supported Devices
• ZM400/ZM600
• RZ400/RZ600

Type getvar

Commands Details
getvar This command retrieves the address of the server that provided the DHCP lease on the
internal wired print server.
Format: ! U1 getvar "internal_wired.ip.dhcp.lease.server"

Note • For details on SGD command structure, see Command Structure on page 732.

Example • In this example, the getvar retrieves the address of the server that provided the
DHCP lease on the internal wired print server.
! U1 getvar "internal_wired.ip.dhcp.lease.server"

"10.3.1.98"

6/8/10 Zebra Programming Guide P1012728-004

766 SGD Wired Commands
internal_wired.ip.dhcp.lease.time_left

internal_wired.ip.dhcp.lease.time_left
Description This command retrieves the time (in seconds) left in the current DHCP lease on
the internal wired print server. For printer support, see SGD Command Support on page 1019.

Supported Devices
• ZM400/ZM600
• RZ400/RZ600

Type getvar

Commands Details
getvar This command retrieves the time (in seconds) left in the current DHCP lease on the internal
wired print server.
Format: ! U1 getvar "internal_wired.ip.dhcp.lease.time_left"

Note • For details on SGD command structure, see Command Structure on page 732.

Example • In this example, the getvar retrieves the time left in the current DHCP lease on
the wired internal print server.
! U1 getvar "internal_wired.ip.dhcp.lease.time_left"

"10.3.1.98"

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wired Commands 767
internal_wired.ip.dhcp.option12

internal_wired.ip.dhcp.option12
Description This command specifies if the DHCP option 12 (host name) is on or off in the
discovery packet that is sent from the internal wired print server. For printer support, see SGD
Command Support on page 1019.

Supported Devices
• ZM400/ZM600
• RZ400/RZ600

Type getvar;setvar

Commands Details
getvar This command retrieves the status of the DHCP option 12 (host name) in the discovery
packet of the internal wired print server.
Format:
! U1 getvar "internal_wired.ip.dhcp.option12"
setvar This command instructs the printer to set the DHCP option 12 (host name) in the discovery
packet of the internal wired print server.
Format:
! U1 setvar "internal_wired.ip.dhcp.option12" "values"
Values:
"on" = turns on option 12
"off" = turns off option 12
Default Value: "on"

Note • For details on SGD command structure, see Command Structure on page 732.

Example • This setvar example shows the value set to "on".

! U1 setvar "internal_wired.ip.dhcp.option12" "on"
When the setvar value is set to "on", the getvar result is "on".

6/8/10 Zebra Programming Guide P1012728-004

768 SGD Wired Commands
internal_wired.ip.dhcp.option12_format

internal_wired.ip.dhcp.option12_format
Description This command specifies the value which will be used for option 12 (host name)
to be used in the DHCP discovery packet of the internal wired print server. For printer support,
see SGD Command Support on page 1019.

Supported Devices
• ZM400/ZM600
• RZ400/RZ600

Type getvar;setvar

Commands Details
getvar This command retrieves the value which will be used for option 12 (host name) to be used in
the DHCP discovery packet of the internal wired print server.
Format:
! U1 getvar "internal_wired.ip.dhcp.option12_format"
setvar This command instructs the printer to set value which will be used for option 12 (host name)
to be used in the DHCP discovery packet of the internal wired print server.
Format:
! U1 setvar "internal_wired.ip.dhcp.option12_format" "value"
Values: 0 to 109 alphanumeric characters
Default Value: ""

Note • For details on SGD command structure, see Command Structure on page 732.

Example • This setvar example shows configuring the

internal_wired.ip.dhcp.option12_format to the value contained in the device.friendly_name.

It is necessary to surround the SGD entry to be used as source for the data with the < and >
characters.

! U1 setvar "internal_wired.ip.dhcp.option12_format"
"<device.friendly_name>"

To further explain, if the above command was issued and the value currently stored in the
device.friendly_name parameter was "ShipPrinter", then the response to following
command would be "ShipPrinter":

! U1 getvar "internal_wired.ip.dhcp.option12_value"

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wired Commands 769
internal_wired.ip.dhcp.option12_value

internal_wired.ip.dhcp.option12_value
Description This command retrieves the actual value which will be used in the discovery
packet of the internal wired print server. For printer support, see SGD Command Support
on page 1019.

Supported Devices
• ZM400/ZM600
• RZ400/RZ600

Type getvar

Commands Details
getvar This command retrieves the actual value which will be used in the discovery packet of the
internal wired print server.
Format: ! U1 getvar "internal_wired.ip.dhcp.option12_value"

Note • For details on SGD command structure, see Command Structure on page 732.

Example • This setvar example shows configuring the

internal_wired.ip.dhcp.option12_format to the value contained in the device.friendly_name.

It is necessary to surround the SGD entry to be used as source for the data with the < and >
characters.

! U1 setvar "internal_wired.ip.dhcp.option12_format"
"<device.friendly_name>"

To further explain, if the above command was issued and the value currently stored in the
device.friendly_name parameter was "ShipPrinter", then the response to following
command would be "ShipPrinter":

! U1 getvar "internal_wired.ip.dhcp.option12_value"

6/8/10 Zebra Programming Guide P1012728-004

770 SGD Wired Commands
internal_wired.ip.dhcp.request_timeout

internal_wired.ip.dhcp.request_timeout
Description This command retrieves the maximum amount of time to wait (in seconds) for
a response for a DHCP discover requests on the internal print server. For printer support, see
SGD Command Support on page 1019.

Supported Devices
• ZM400/ZM600
• RZ400/RZ600

Type getvar;setvar

Commands Details
getvar This command retrieves the currently set maximum amount of time to wait for a response
before timing out DHCP discover requests.
Format:
! U1 getvar "internal_wired.ip.dhcp.request_timeout"
setvar This command instructs the printer to set the maximum amount of time to wait for a
response before timing out DHCP discover requests.
Format:
! U1 setvar "internal_wired.ip.dhcp.request_timeout"
"value"
Values: 2-30
Default: "2"

Note • For details on SGD command structure, see Command Structure on page 630.

Example • This setvar example shows the value set to "2".

! U1 setvar "ip.dhcp.request_timeout" "2"
When the setvar value is set to "2", the getvar result is "2".

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wired Commands 771
internal_wired.ip.dhcp.requests_per_session

internal_wired.ip.dhcp.requests_per_session
Description This command retrieves the maximum amount of DHCP discover requests for
a single DHCP session on the internal wired print server. For printer support, see SGD
Command Support on page 1019.

Supported Devices
• ZM400/ZM600
• RZ400/RZ600

Type getvar;setvar

Commands Details
getvar This command retrieves the currently set maximum amount of DHCP discover requests for
a single DHCP session on the internal wired print server.
Format:
! U1 getvar "internal_wired.ip.dhcp.requests_per_session"
setvar This command instructs the printer to set the maximum amount of DHCP discover requests
for a single DHCP session on the internal wired print server.
Format:
! U1 setvar "internal_wired.ip.dhcp.requests_per_session" "value"
Values: 1-10
Default: "2"

Note • For details on SGD command structure, see Command Structure on page 732.

Example • This setvar example shows the value set to "2".

! U1 setvar "internal_wired.ip.dhcp.requests_per_session" "2"
When the setvar value is set to "2", the getvar result is "2".

6/8/10 Zebra Programming Guide P1012728-004

772 SGD Wired Commands
internal_wired.ip.dhcp.session_interval

internal_wired.ip.dhcp.session_interval
Description This command retrieves how long it will take (in seconds) for a DHCP session
to time out before a new DHCP session begins. For printer support, see SGD Command
Support on page 1019.

Supported Devices
• ZM400/ZM600
• RZ400/RZ600

Type getvar;setvar

Commands Details
getvar This command retrieves the current DHCP session time out.
Format: ! U1 getvar "internal_wired.ip.dhcp.session_interval"
setvar This command instructs the printer to set the DHCP session time out.
Format:
! U1 setvar "internal_wired.ip.dhcp.session_interval" "value"
Values: 0-60
Default: "10"

Note • For details on SGD command structure, see Command Structure on page 732.

Example • This setvar example shows the value set to "10".

! U1 setvar "internal_wired.ip.dhcp.session_interval" "10"
When the setvar value is set to "10", the getvar result is "10".

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wired Commands 773
internal_wired.ip.gateway

internal_wired.ip.gateway
Description This command instructs the printer to change the internal wired print servers
gateway address. For printer support, see SGD Command Support on page 1019.

Important • This setting refers to the gateway address. A set value is ignored if the IP
protocol is not set to permanent.

Type getvar; setvar

Commands Details
getvar This command instructs the printer to respond with the internal wired printer servers
gateway address.
Format: ! U1 getvar "internal_wired.ip.gateway"
setvar This command instructs the printer to change the internal wired printer servers gateway
address.
Format: ! U1 setvar "internal_wired.ip.gateway" "value"
Values: Any valid gateway address
Default: "0.0.0.0"

Example • This setvar example shows the value set to "10.3.5.1".

! U1 setvar "internal_wired.ip.gateway" "10.3.5.1"
When the setvar value is set to "10.3.5.1", the getvar result is "10.3.5.1".

Note • For details on SGD command structure, see Command Structure on page 785.

6/8/10 Zebra Programming Guide P1012728-004

774 SGD Wired Commands
internal_wired.ip.netmask

internal_wired.ip.netmask
Description This setting refers to the internal wired print server’s subnet mask address. This
value is ignored if the IP protocol is not set to permanent. For printer support, see SGD
Command Support on page 1019.

Type getvar; setvar

Commands Details
getvar This command instructs the printer to respond with internal wired print servers subnet mask.
Format: ! U1 getvar "internal_wired.ip.netmask"
setvar This command instructs the printer to change the internal wired print servers subnet mask.
Format: ! U1 setvar "internal_wired.ip.netmask" "value"
Values: Any valid subnet mask.
Default: "255.255.255.0"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "255.255.255.0".

! U1 setvar "internal_wired.ip.netmask" "255.255.255.0"
When the setvar value is set to "255.255.255.0", the getvar result is
"255.255.255.0".

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wired Commands 775
internal_wired.ip.port

internal_wired.ip.port
Description This printer setting refers to the internal wired print servers port number that
the TCP print service is listening on. Normal TCP communications from the host should be
directed to this port. For printer support, see SGD Command Support on page 1019.

Type getvar; setvar

Commands Details
getvar This command instructs the printer to respond with the internal wired printer servers
TCP/UDP port number.
Format: ! U1 getvar "internal_wired.ip.port"
setvar This command instructs the printer to set the internal wired print servers TCP/UDP port
number.
Format: ! U1 setvar "internal_wired.ip.port" "value"
Values: 1 - 65535 (excluding any ports currently used by other services, such as 21, 23, 80,
and 515).
Default: "9100"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "9100".

! U1 setvar "internal_wired.ip.port" "9100"
When the setvar value is set to "9100", the getvar result is "9100".

6/8/10 Zebra Programming Guide P1012728-004

776 SGD Wired Commands
internal_wired.ip.protocol

internal_wired.ip.protocol
Description This command configures the IP addressing method used by the internal wired
print server. For printer support, see SGD Command Support on page 1019.

Type getvar;setvar

Commands Details
getvar This command returns the IP addressing method used by the internal wired print server.
Format: ! U1 getvar "internal_wired.ip.protocol"
setvar This command instructs the printer to configure the IP addressing method used by the
internal wired print server.
Format: ! U1 setvar "internal_wired.ip.protocol" "value"
Values:
"bootp" = uses the standard bootp addressing method to obtain an IP address and
configuration
"dhcp" = uses the standard dhcp addressing method to obtain an IP address and
configuration for a server specified period of time
"rarp" = uses the standard rarp addressing method to obtain an IP address
"glean" = uses the IP address from a PING packet that is sent to its hardware
address (unicast address)
“permanent” = uses static values assigned through other commands
"all" = tries all of the dynamic addressing methods, not permanent, to obtain an IP
address
Default: "all"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • In this example, the setvar result is the current programming language that the
printer is using.
! U1 setvar "internal_wired.ip.protocol" "bootp"
What the setvar value is set to is the getvar result. In this example, the getvar result is
"bootp".

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wired Commands 777
internal_wired.ip.timeout.enable

internal_wired.ip.timeout.enable
Description This network setting refers to enabling the connection timeout on the internal
wired print server. For this to take effect, the print server must be reset. For printer support, see
SGD Command Support on page 1019.

Type getvar; setvar

Commands Details
getvar This command instructs the printer to return whether the timeout checking is enabled on the
internal wired print server.
Format: ! U1 getvar "internal_wired.ip.timeout.enable"
setvar This command instructs the printer to enable or disable the timeout checking on the internal
wired print server.
Format: ! U1 setvar "internal_wired.ip.timeout.enable" "value"
Values:
"off" = turns off the connection checking
"on" = turns on the connection checking
Default: "on"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "on".

! U1 setvar "internal_wired.ip.timeout.enable" "on"
When the setvar value is set to "on", the getvar result is "on".

6/8/10 Zebra Programming Guide P1012728-004

778 SGD Wired Commands
internal_wired.ip.timeout.value

internal_wired.ip.timeout.value
Description This network setting refers to the number of seconds before the connection
times out for the internal wired print server. For this to take effect, the print server must be
reset. For printer support, see SGD Command Support on page 1019.

Type getvar; setvar

Commands Details
getvar This command instructs the printer to respond with the time of the internal wired print
server, in seconds, before the connection times out.
Format: ! U1 getvar "internal_wired.ip.timeout.value"
setvar This command instructs the printer to set the time of the internal wired print server, in
seconds, before the connection times out.
Format: ! U1 setvar "internal_wired.ip.timeout.value" "value"
Values: "1" through "3600"
Default: "300"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "300".

! U1 setvar "internal_wired.ip.timeout.value" "300"
When the setvar value is set to "300", the getvar result is "300".

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wired Commands 779
internal_wired.mac_addr

internal_wired.mac_addr
Description This command retrieves the MAC address of the internal wired print server.
For printer support, see SGD Command Support on page 1019.

Type getvar

Commands Details
getvar This command instructs the printer to respond with the MAC address of the internal wired
print server.
Format: ! U1 getvar "internal_wired.mac_addr"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • In this example, the getvar result is the MAC address of the internal wired
print server.
! U1 getvar "internal_wired.mac_addr"

6/8/10 Zebra Programming Guide P1012728-004

780 SGD Wired Commands
internal_wired.mac_raw

internal_wired.mac_raw
Description This command identifies the RAW MAC address of the internal wired print
server. The raw mac address is the mac address without the colons (":"). For printer support,
see SGD Command Support on page 1019.

Supported Devices
• ZM400/ZM600
• RZ400/RZ600

Type getvar

Commands Details
getvar This command retrieves the RAW MAC address of the internal wired print server.
Format: ! U1 getvar "internal_wired.mac_raw"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • In this example, the getvar retrieves the RAW MAC address of the internal
wired print server.
! U1 getvar "internal_wired.mac_raw"

P1012728-004 Zebra Programming Guide 6/8/10

 8
SGD Wireless Commands

This chapter provides a high-level overview of the wireless Set / Get / Do (SGD) commands
and details on each SGD command. For printer support of these SGD commands, see SGD
Command Support on page 1019.

SGD commands are available in printers with the following firmware versions or later:
• V60.16.2Z or later • V53.15.2Z or later
• V60.15.xZ or later • R53.16.3Z or later
• V50.15.xZ or later • R60.15.8Z or later
• V61.15.xZ or later • R62.15.8Z or later
• V56.15.xZ or later • R63.15.8Z or later
• V53.16.x or later • R65.15.8Z or later

Note • The commands listed in this chapter are for use with the Wireless Print Server and
Wireless Plus Print Server, when used with firmware version V60.15.x, V50.15.x, or later.

Important • These are important points to note when using ZPL and SGD commands:
• SGD commands are case-sensitive.
• ZPL and SGD commands should be sent to the printer as separate files.
• Certain settings can be controlled by both ZPL and SGD. Configuration changes made in
ZPL can affect configuration changes made in SGD.
• Changes made with one command type (ZPL or SGD) will affect the data returned to the
host in response to both ZPL and getvar commands. The command type (ZPL or SGD)
that was sent last determines the current setting.
• Some RF cards do not support all of the SGD commands.

6/8/10 Zebra Programming Guide P1012728-004

782 SGD Wireless Commands

Important • These are important points to note when using a Zebra G-Series printer:
• You can send instructions to the printer using multiple programming languages: EPL,
ZPL, or SGD. EPL and ZPL commands configure the printer, print labels, and get device
status information. SGD commands set and get configuration details. These three
languages can be used without the need to send the printer instructions to switch from one
language to another.
• EPL, ZPL, and SGD commands must be sent to the printer as separate files. They cannot
be used together in one format, or set of commands. For example, if you send a series of
SGD commands to the printer and they are followed by a printable format, this needs to
be done using separate files.

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wireless Commands 783
Overview

Overview
This section describes how and why to use the Set / Get / Do (SGD) commands. It also
provides an example of a typical command structure.

Note • SGD commands must be terminated by a carriage return or a space and line feed.

SGD commands are commands that allow you to configure all printers with firmware version
V60.15.x, V50.15.x, V61.15.x, V56.15.x, V53.15.xZ, or later. The printer performs the
specified function immediately after receiving the command. The commands are:
• setvar
• getvar
• do

setvar Command
Setvar commands:
• are used to configure printer settings to specific values by setting them in the printer
• must be terminated by a space character or a CR/ LF (0x0D, 0x0A)

Important • The setvar command and attributes must be specified in lower case.

getvar Command
Getvar commands:
• are used to get the current value of the printer settings
• must be terminated by a space character or CR/LF (0x0D, 0x0A)

The printer responds with the printer setting of “?” if:

• the printer setting does not exist (usually due to incorrect spelling of the printer setting)
• it has not been configured yet

Important • The printer settings and attributes must be specified in lower case.

6/8/10 Zebra Programming Guide P1012728-004

784 SGD Wireless Commands
Overview

do Command
Do commands:
• are used to instruct the printer to perform predefined actions
• must be terminated by a space character or a CR/LF (0x0D, 0x0A)

Some Do commands require additional settings which must be enclosed in double quotes.

Important • The values must be specified in lower case.

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wireless Commands 785
Command Structure

Command Structure
It is important to understand the structure of the command and its components. A command
structure illustration is provided for each command in this guide.

Example • This is an example of a command structure illustration:

! U1 setvar "ip.addr" "value"

1 2 3

1 Command—always preceded with an exclamation point (!) and must be specified in

lower case. A space resides between the !and U1 and between U1 and the command
(setvar or getvar).
2 Attribute—always in double quotes and must be specified in lower case.
3 Chosen value—always in double quotes. Only applicable for setvar and do.

This command must be terminated by a space character or a CR/ LF (0x0D, 0x0A).

How to Send Multiple SGD Commands

For any getvar, setvar, or do command, if you issue the syntax without the "1" and use
the END command followed by a space, multiple SGD commands are sent simultaneously.

Example • This syntax shows how you can send multiple getvar commands:

1 ! U getvar "ip.telnet.enable"

getvar "ip.dhcp.enable"
2
getvar "ip.dhcp.cid_prefix"

3 END

1 The command portion of the string does not use the "1" after the "! U".
2 Commands issued after the first command do not require the "! U".
3 The string of commands is terminated by the word "END" with a space after the
word, and by a carriage return/ line feed.

6/8/10 Zebra Programming Guide P1012728-004

786 SGD Wireless Commands
bluetooth.address

bluetooth.address
Description This command returns the printer’s Bluetooth device address. For printer
support, see SGD Command Support on page 1019.

Type getvar

Commands Details
getvar This command retrieves the printer’s Bluetooth address.
Format: ! U1 getvar "bluetooth.address"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • In this example, the getvar command causes the printer to return the printer’s
Bluetooth address.
! U1 getvar "bluetooth.address"

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wireless Commands 787
bluetooth.afh_map

bluetooth.afh_map
Description This command sets or retrieves the default AFH (adaptive frequency hopping)
channel map (Bluetooth radios 1.2 and later); 20 bytes. For printer support, see SGD
Command Support on page 1019.

Type getvar;setvar

Commands Details
getvar This command retrieves default AFH channel map.
Format: ! U1 getvar "bluetooth.afh_map"
setvar This command selectively enables or disables individual Bluetooth channels for use when
AFH mode is set to "on".
Format: ! U1 setvar "bluetooth.afh_map" "value"
Values: 20-byte string of hexadecimal characters
Default: "7FFFFFFFFFFFFFFFFFFF"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "7FFFFFFFFFFFFFFFFFFF".

! U1 setvar "bluetooth.afh_map" "7FFFFFFFFFFFFFFFFFFF"
What the setvar value is set to is the getvar result. In this example, the getvar result is
"7FFFFFFFFFFFFFFFFFFF".

6/8/10 Zebra Programming Guide P1012728-004

788 SGD Wireless Commands
bluetooth.afh_map_curr

bluetooth.afh_map_curr
Description This command retrieves the current AFH (adaptive frequency hopping)
channel map (Bluetooth radios 1.2 and later). For printer support, see SGD Command Support
on page 1019.

Type getvar

Commands Details
getvar This command retrieves the current AFH channel map.
Format: ! U1 getvar "bluetooth.afh_map_curr"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • In this example, the getvar command causes the printer to retrieve the current
AFH channel map.
! U1 getvar "bluetooth.afh_map_curr"

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wireless Commands 789
bluetooth.afh_mode

bluetooth.afh_mode
Description This command sets or retrieves AFH (adaptive frequency hopping) mode
setting (Bluetooth radios 1.2 and later). For printer support, see SGD Command Support
on page 1019.

Type getvar;setvar

Commands Details
getvar This command retrieves the current setting of the AFH mode.
Format: ! U1 getvar "bluetooth.afh_mode"
setvar This command enables and disables AFH mode.
Format: ! U1 setvar "bluetooth.afh_mode" "value"
Values:
"on" = enables AFH mode
"off" = disables AFH mode
Default: "off"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "on".

! U1 setvar "bluetooth.afh_mode" "on"
What the setvar value is set to is the getvar result. In this example, the getvar result is
"on".

6/8/10 Zebra Programming Guide P1012728-004

790 SGD Wireless Commands
bluetooth.authentication

bluetooth.authentication
Description This command sets or retrieves Bluetooth authentication mode and works in
combination with the bluetooth.bluetooth_pin. For printer support, see SGD
Command Support on page 1019.

Type getvar;setvar

Commands Details
getvar This command retrieves the current Bluetooth authentication mode.
Format: ! U1 getvar "bluetooth.authentication"
setvar This command enables and disables Bluetooth authentication.
Format: ! U1 setvar "bluetooth.authentication" "value"
Values:
"off" = disables authentication (can connect to master device without PIN)
"setpin" = enables authentication (requires PIN or passkey to connect to a master
device)
Default: "off"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "setpin".

! U1 setvar "bluetooth.authentication" "setpin"
What the setvar value is set to is the getvar result. In this example, the getvar result is
"setpin".

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wireless Commands 791
bluetooth.bluetooth_pin

bluetooth.bluetooth_pin
Description This command is used to connect to the printer only when the command
bluetooth.authentication is set to "setpin". For printer support, see SGD
Command Support on page 1019.

Type getvar;setvar

Commands Details
getvar This command retrieves the current Bluetooth pin.
Format: ! U1 getvar "bluetooth.bluetooth_pin"
setvar This command sets the Bluetooth pin value.
Format: ! U1 setvar "bluetooth.bluetooth_pin" "value"
Values: Any text string up to 16 characters
Default: ""

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "1234567890".

! U1 setvar "bluetooth.bluetooth_pin" "1234567890"
What the setvar value is set to is the getvar result. In this example, the getvar result is
"1234567890".

6/8/10 Zebra Programming Guide P1012728-004

792 SGD Wireless Commands
bluetooth.date

bluetooth.date
Description This command shows the release date of the Bluetooth module. For printer
support, see SGD Command Support on page 1019.

Type getvar

Commands Details
getvar This command shows the release date of the Bluetooth module.
Format: ! U1 getvar "bluetooth.date"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • In this example, the getvar command returns the release date of the Bluetooth
module.
! U1 getvar "bluetooth.date"

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wireless Commands 793
bluetooth.discoverable

bluetooth.discoverable
Description This command enables or disables the Bluetooth discoverable mode. For
printer support, see SGD Command Support on page 1019.

Type getvar;setvar

Commands Details
getvar This command retrieves the current Bluetooth discoverable mode.
Format: ! U1 getvar "bluetooth.discoverable"
setvar This command enables or disables the Bluetooth discoverable mode.
Format: ! U1 setvar "bluetooth.discoverable" "value"
Values:
"on" = enables Bluetooth discoverable mode
"off" = disables Bluetooth discoverable mode
Default: "on"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "on".

! U1 setvar "bluetooth.discoverable" "on"
What the setvar value is set to is the getvar result. In this example, the getvar result is
"on".

6/8/10 Zebra Programming Guide P1012728-004

794 SGD Wireless Commands
bluetooth.enable

bluetooth.enable
Description This command enables or disables the Bluetooth radio. For printer support, see
SGD Command Support on page 1019.

Type getvar;setvar

Commands Details
getvar This command retrieves the current status of the Bluetooth radio.
Format: ! U1 getvar "bluetooth.enable"
setvar This command enables or disables the Bluetooth radio.
Format: ! U1 setvar "bluetooth.enable"
Values:
"on" = enables the Bluetooth radio
"off" = disables the Bluetooth radio
Default: "on"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "on".

! U1 setvar "bluetooth.enable" "on"
What the setvar value is set to is the getvar result. In this example, the getvar result is
"on".

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wireless Commands 795
bluetooth.friendly_name

bluetooth.friendly_name
Description This command sets the friendly name, which is used during service discovery.
For changes to take effect, you must power cycle the printer or issue the device.reset
command. If bluetooth.friendly_name is not set by you, it will default to the printer
serial number. For printer support, see SGD Command Support on page 1019.

Type getvar;setvar

Commands Details
getvar This command retrieves the current Bluetooth discoverable mode.
Format: ! U1 getvar "bluetooth.friendly_name"
setvar This command sets the Bluetooth discoverable mode.
Format: ! U1 setvar "bluetooth.friendly_name" "value"
Values: Any text string up to 17 characters

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "1234567".

! U1 setvar "bluetooth.friendly_name" "1234567"
What the setvar value is set to is the getvar result. In this example, the getvar result is
"1234567".

6/8/10 Zebra Programming Guide P1012728-004

796 SGD Wireless Commands
bluetooth.local_name

bluetooth.local_name
Description This command retrieves the local name that is provided during service
discovery. For printer support, see SGD Command Support on page 1019.

Type getvar

Commands Details
getvar This command retrieves the local name that is provided during service discovery.
Format: ! U1 getvar "bluetooth.local_name"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • In this example, the getvar command returns the local name that is provided
during service discovery.
! U1 getvar "bluetooth.local_name"

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wireless Commands 797
bluetooth.radio_auto_baud

bluetooth.radio_auto_baud
Description This command retrieves the Bluetooth radio data rate. For printer support, see
SGD Command Support on page 1019.

Type getvar

Commands Details
getvar This command retrieves Bluetooth radio data rate.
Format: ! U1 getvar "bluetooth.radio_auto_baud"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • In this example, the getvar retrieves the short Bluetooth address.
! U1 getvar "bluetooth.radio_auto_baud"

6/8/10 Zebra Programming Guide P1012728-004

798 SGD Wireless Commands
bluetooth.radio_version

bluetooth.radio_version
Description This command returns the version of the currently installed Bluetooth radio.
For printer support, see SGD Command Support on page 1019.

Type getvar

Commands Details
getvar This command returns the version of the currently installed Bluetooth radio.
Format: ! U1 getvar "bluetooth.radio_version"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • In this example, the getvar command returns the currently installed Bluetooth
radio.
! U1 getvar "bluetooth.radio_version"

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wireless Commands 799
bluetooth.short_address

bluetooth.short_address
Description This command shortens the Bluetooth address by removing the colons (":").
For printer support, see SGD Command Support on page 1019.

Type getvar

Commands Details
getvar This command retrieves the shortened Bluetooth address.
Format: ! U1 getvar "bluetooth.short_address"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • In this example, the getvar retrieves the short Bluetooth address.
! U1 getvar "bluetooth.short_address"

6/8/10 Zebra Programming Guide P1012728-004

800 SGD Wireless Commands
bluetooth.version

bluetooth.version
Description This command returns the Bluetooth library version number. For printer
support, see SGD Command Support on page 1019.

Type getvar

Commands Details
getvar This command returns the Bluetooth library version number.
Format: ! U1 getvar "bluetooth.version"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • In this example, the getvar command returns the Bluetooth library version
number.
! U1 getvar "bluetooth.version"

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wireless Commands 801
card.mac_addr

card.mac_addr
Description This command retrieves the MAC address of the wireless radio card. For
printer support, see SGD Command Support on page 1019.

Type getvar

Commands Details
getvar This command instructs the printer to respond with the MAC address.
Format: ! U1 getvar "card.mac_addr"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • In this example, the getvar result is the MAC address for the wireless radio
card.
! U1 getvar "card.mac_addr"

6/8/10 Zebra Programming Guide P1012728-004

802 SGD Wireless Commands
card.inserted

card.inserted
Description This command indicates whether the wireless radio card is or is not inserted.
For printer support, see SGD Command Support on page 1019.

Type getvar

Commands Details
getvar This command instructs the printer to respond with the wireless radio card status. It’s
inserted or it’s not inserted.
Format: ! U1 getvar "card.inserted"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • In this example, the getvar result is "Inserted".

! U1 getvar "card.inserted"

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Printer Commands 803
comm.type

comm.type
Description This printer setting determines the behavior of the serial port interface. It
selects one of three serial communication states: DTE, DCE or Autodetect. For printer
support, see SGD Command Support on page 1019.

Supported Devices
• LP 2824 Plus

Type getvar;setvar

Commands Details
getvar This command instructs the printer to respond with the curently set sreial port interface type.
Format: ! U1 getvar "comm.type"
setvar This command instructs the printer to change the serial port interface type.
Format: ! U1 setvar "comm.type" "value"
Values:
"auto" = Autodetect
"dte" = Force DTP (Tx on pin 2)
"dcs" = Force DCE (Rx on pin 2)
Default: "auto"

Note • For details on SGD command structure, see Command Structure on page 630.

Example 1 • In this example, the getvar retrieves the serial port communications state.
! U1 getvar "comm.type"

Example 2 • This setvar example sets the communications port state to Autodetect.
! U1 setvar "comm.type" "auto"

6/8/10 Zebra Programming Guide P1012728-004

804 SGD Wireless Commands
ip.active_network

ip.active_network
Description This command displays if the printer is actively connected to wireless, external
wired, or internal wired. For printer support, see SGD Command Support on page 1019.

Type getvar

Commands Details
getvar This command instructs the printer to respond with what the printer is currently connected
to internal wired, wireless, external wired, or unknown. Table 27 provides details on the
potential return values.
Format: ! U1 getvar "ip.active_network"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • In this example, the getvar will return the current active network the printer is
connected to.
! U1 getvar "ip.active_network"

Table 27 • Printer Responses

Return Values Details

“internal wired” This is the return value when an internal wired device is detected.
“wireless” This is the return value when a wireless device is detected.
“external wired” This is the return value when an external wired device is detected.
“unknown” This is the return value:
• if the printer has not established a network connection on any of
the devices
• if you don't have any of the network devices plugged in
• if the printer is still trying to establish a connection (i.e. on
wireless it is going through the association process).

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wireless Commands 805
ip.addr

ip.addr
Description This command allows you to get or set the printer’s IP address. For printer
support, see SGD Command Support on page 1019.

Important • For a set IP address to take affect, the IP protocol must be set to permanent and
the print server must be reset.

Type getvar; setvar

Commands Details
getvar This command instructs the printer to respond with its current IP address.
Format: ! U1 getvar "ip.addr"
setvar This command instructs the printer to change its current IP address upon powering the
printer on.
Format: ! U1 setvar "ip.addr" "value"
Values: any valid IP address
Default: "0.0.0.0"

Note • For details on SGD command structure, see Command Structure on page 785.

Note • The setvar value of this command can be affected by the ip.dhcp.enable
command.

Example • This setvar example shows the value set to "10.14.4.235".

! U1 setvar "ip.addr" "10.14.4.235"
What the setvar value is set to is the getvar result. In this example, the getvar result is
"10.14.4.235".

6/8/10 Zebra Programming Guide P1012728-004

806 SGD Wireless Commands
ip.arp_interval

ip.arp_interval
Description This printer setting allows you to specify the ARP (Address Resolution
Protocol) interval or the ARP cache time out. For printer support, see SGD Command Support
on page 1019.

Type getvar; setvar

Commands Details
getvar This command instructs the printer to respond with the ARP interval or the ARP cache time
out value in seconds.
Format: ! U1 getvar "ip.arp_interval"
setvar This command instructs the printer to change the ARP interval or the ARP cache time out.
Format: ! U1 setvar "ip.arp_interval" "value"
Values: 0 - 30
Default: "0"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "0".

! U1 setvar "ip.arp_interval" "0"
What the setvar value is set to is the getvar result. In this example, the getvar result is
"0".

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wireless Commands 807
ip.bootp.enable

ip.bootp.enable
Description This printer setting turns BOOTP on or off. BOOTP is a method for acquiring
an IP address, netmask, and gateway automatically on printer power-up. It requires a BOOTP
server on the local network. For printer support, see SGD Command Support on page 1019.

Note • If you are using static IP addressing, the IP protocol must be set to permanent.

Type getvar; setvar

Commands Details
getvar This command instructs the printer to respond with the current BOOTP setting.
Format: ! U1 getvar "ip.bootp.enable"
setvar This command instructs the printer to turn BOOTP on or off.
Format: ! U1 setvar "ip.bootp.enable" "value"
Values:
"off" = printer does not use BOOTP to get the IP address
"on" = printer uses BOOTP to get the IP address
Default: "on"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "on".

! U1 setvar "ip.bootp.enable" "on"
When the setvar value is set to "on", the getvar result is "on".

6/8/10 Zebra Programming Guide P1012728-004

808 SGD Wireless Commands
ip.dhcp.cache_ip

ip.dhcp.cache_ip
Description This command enables or disables the IP caching. For printer support, see SGD
Command Support on page 1019.

Type getvar;setvar

Commands Details
getvar This command retrieves the status of the IP cache.
Format: ! U1 getvar "ip.dhcp.cache_ip"
setvar This command sets the status of the IP cache.
Format: ! U1 setvar "ip.dhcp.cache_ip" "value"
Values:
"on" = enabled
"off” = disabled
Default: "off”

Note • For details on SGD command structure, see Command Structure on page 630.

Example • This setvar example shows the value set to "off”.

! U1 setvar "ip.dhcp.cache_ip" "off”
When the setvar value is set to "off", the getvar result is "off".

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wireless Commands 809
ip.dhcp.cid_all

ip.dhcp.cid_all
Description This printer setting defines the entire client identifier (DHCP option 61) if the
DHCP is enabled and "ip.dhcp.cid_type" is set to "0", or "2". The MAC address is
used if the type is set to "1". For printer support, see SGD Command Support on page 1019.

Type getvar; setvar

Commands Details
getvar This command instructs the printer to respond with the client identifier prefix and suffix.
Format: ! U1 getvar "ip.dhcp.cid_all"
setvar This command instructs the printer to change the CID prefix and suffix.
Format: ! U1 setvar "ip.dhcp.cid_all" "value"
Values: A maximum length of 60 characters if the CID type is ASCII, or 120 characters if
the CID type is hexadecimal.
Default Value: ""

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "printer".

! U1 setvar "ip.dhcp.cid_all" "printer"
What the setvar value is set to is the getvar result. In this example, the getvar result is
"printer".

6/8/10 Zebra Programming Guide P1012728-004

810 SGD Wireless Commands
ip.dhcp.cid_enable

ip.dhcp.cid_enable
Description This command determines if DHCP (option 61) is turned on or off. For printer
support, see SGD Command Support on page 1019.

Type getvar; setvar

Commands Details
getvar This command instructs the printer to respond with the status of the client identifier.
Format: ! U1 getvar "ip.dhcp.cid_enable"
setvar This command instructs the printer to set the status of the client identifier.
Format: ! U1 setvar "ip.dhcp.cid_enable" "value"
Values:
"off" = client identifier is turned off
"on" = client identifier is turned on
Default: "off"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "off".

! U1 setvar "ip.dhcp.cid_enable" "off"
What the setvar value is set to is the getvar result. In this example, the getvar result is
"off".

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wireless Commands 811
ip.dhcp.cid_prefix

ip.dhcp.cid_prefix
Description This printer setting defines the prefix to be prepended to the DHCP client
identifier (option 61) when DHCP is enabled and "ip.dhcp.cid_type" is set to "0"or
"2". For printer support, see SGD Command Support on page 1019.

Type getvar; setvar

Commands Details
getvar This command instructs the printer to respond with the client identifier prefix.
Format: ! U1 getvar "ip.dhcp.cid_prefix"
setvar This command instructs the printer to change the CID prefix.
Format: ! U1 setvar "ip.dhcp.cid_prefix" "value"
Values: Any text string up to 10 characters if the CID type is ASCII, or 20 characters if the
CID type is hexadecimal.
Default Value: ""

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "PRT001".

! U1 setvar "ip.dhcp.cid_prefix" "PRT001"
What the setvar value is set to is the getvar result. In this example, the getvar result is
"PRT001".

6/8/10 Zebra Programming Guide P1012728-004

812 SGD Wireless Commands
ip.dhcp.cid_suffix

ip.dhcp.cid_suffix
Description This printer setting defines the unique suffix to be used as the client identifier
(DHCP option 61) if DHCP is enabled and "ip.dhcp.cid_type" is set to "0" or "2".
For printer support, see SGD Command Support on page 1019.

Type getvar; setvar

Commands Details
getvar This command instructs the printer to respond with the client identifier suffix.
Format: ! U1 getvar "ip.dhcp.cid_suffix"
setvar This command instructs the printer to change the CID value.
Format: ! U1 setvar "ip.dhcp.cid_suffix" "value"
Values: The maximum length of a value allowed is 60 ASCII characters when the CID type
is ASCII, or 120 hexadecimal values when the CID type is hexadecimal.
Default Value: ""

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "printer".

! U1 setvar "ip.dhcp.cid_suffix" "printer"
What the setvar value is set to is the getvar result. In this example, the getvar result is
"printer".

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wireless Commands 813
ip.dhcp.lease.length

ip.dhcp.lease.length
Description This command retrieves the original length of the DHCP lease on the wireless
print server. For printer support, see SGD Command Support on page 1019.

Type getvar

Commands Details
getvar This command retrieves the original length of the DHCP lease on the wireless print server.
Format: ! U1 getvar "ip.dhcp.lease.length"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This command retrieves the original length of the DHCP lease on the wireless
print server.
! U1 getvar "ip.dhcp.lease.length"

"1296000"

6/8/10 Zebra Programming Guide P1012728-004

814 SGD Wireless Commands
ip.dhcp.cid_type

ip.dhcp.cid_type
Description This printer setting defines the type of client identifier (DHCP option 61) that
will be sent if DHCP is enabled. A value of "1" means the type of "Ethernet" and the printer’s
MAC address will be used. A value of "0" or "2" means the client identifier sent will be
"ip.dhcp.cid_prefix" concatenated with "ip.dhcp.cid_suffix". For printer
support, see SGD Command Support on page 1019.

Type getvar; setvar

Commands Details
getvar This command instructs the printer to respond with the client identifier type.
Format: ! U1 getvar "ip.dhcp.cid_type"
setvar This command instructs the printer to enable "synthetic" Client Identifier.
Format: ! U1 setvar "ip.dhcp.cid_type" "value"
Values:
"0" = ASCII string
"1" = wireless radio card’s MAC address
"2" = HEX value
Default Value: "1"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "1".

! U1 setvar "ip.dhcp.cid_type" "1"
When the setvar value is set to "1", the getvar result is "1".

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wireless Commands 815
ip.dhcp.enable

ip.dhcp.enable
Definition This printer setting turns DHCP on or off. DHCP is a method for acquiring an IP
address, netmask, and gateway automatically on printer power-up. It requires a DHCP server
on the local network. For printer support, see SGD Command Support on page 1019.

Note • If you are using static IP addressing, the IP protocol must be set to permanent.

Type getvar; setvar

Commands Details
getvar This command instructs the printer to respond with the DHCP status.
Format: ! U1 getvar "ip.dhcp.enable"
setvar This command instructs the printer to turn DHCP on or off.
Format: ! U1 setvar "ip.dhcp.enable" "value"
Values:
"off" = printer does not use DHCP to get the IP address
"on" = printer uses DHCP to get the IP address
Default: "on"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "on".

! U1 setvar "ip.dhcp.enable" "on"
When the setvar value is set to "on", the getvar result is "on".

6/8/10 Zebra Programming Guide P1012728-004

816 SGD Wireless Commands
ip.dhcp.lease.last_attempt

ip.dhcp.lease.last_attempt
Description This command retrieves the time from the DHCP server of when the last DHCP
request was sent. For printer support, see SGD Command Support on page 1019.

Type getvar

Commands Details
getvar This command retrieves the last time a DHCP request was sent.
Format: ! U1 getvar "ip.dhcp.lease.last_attempt"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • In this example, the getvar retrieves the last time a DHCP request was sent to
the wireless print server.
! U1 getvar "ip.dhcp.lease.last_attempt"

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wireless Commands 817
ip.dhcp.lease.server

ip.dhcp.lease.server
Description This command retrieves the address of the server that provided the DHCP lease
on the wireless print server. For printer support, see SGD Command Support on page 1019.

Type getvar

Commands Details
getvar This command retrieves the address of the server that provided the DHCP lease on the
wireless print server.
Format: ! U1 getvar "ip.dhcp.lease.server"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • In this example, the getvar retrieves the server that provided the DHCP lease
on the wireless print server.
! U1 getvar "ip.dhcp.lease.server"

"10.3.5.1"

6/8/10 Zebra Programming Guide P1012728-004

818 SGD Wireless Commands
ip.dhcp.lease.time_left

ip.dhcp.lease.time_left
Description This command retrieves the time left in the current DHCP lease on the wireless
print server. For printer support, see SGD Command Support on page 1019.

Type getvar

Commands Details
getvar This command retrieves the time left in the current DHCP lease on the wireless print server.
Format: ! U1 getvar "ip.dhcp.lease.time_left"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • In this example, the getvar retrieves the time left in the current DHCP lease on
the wireless print server.
! U1 getvar "ip.dhcp.lease.time_left"

"1192518"

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wireless Commands 819
ip.dhcp.option12

ip.dhcp.option12
Description This command specifies if the DHCP option 12 (host name) is on or off in the
discovery packet that is sent from the wireless print server. For printer support, see SGD
Command Support on page 1019.

Type getvar;setvar

Commands Details
getvar This command retrieves the status of the DHCP option 12 (host name) in the discovery
packet that is sent from the wireless print server.
Format: ! U1 getvar "ip.dhcp.option12"
setvar This command instructs the printer to set the DHCP option 12 (host name) in the discovery
packet that is sent from the wireless print server.
Format: ! U1 setvar "ip.dhcp.option12" "value"
Values:
"on" = turns on option 12
"off" = turns off option 12
Default Value: "on"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "on".

! U1 setvar "ip.dhcp.option12" "on"
When the setvar value is set to "on", the getvar result is "on".

6/8/10 Zebra Programming Guide P1012728-004

820 SGD Wireless Commands
ip.dhcp.option12_format

ip.dhcp.option12_format
Description This command specifies the value which will be used for option 12 (host name)
to be used in the DHCP discovery packet of the wireless print server. For printer support, see
SGD Command Support on page 1019.

Type getvar;setvar

Commands Details
getvar This command retrieves the value which will be used for option 12 (host name) to be used in
the DHCP discovery packet of the wireless print server.
Format: ! U1 getvar "ip.dhcp.option12_format"
setvar This command instructs the printer to set the value which will be used for option 12 (host
name) to be used in the DHCP discovery packet of the wireless print server.
Format: ! U1 setvar "ip.dhcp.option12_format" "value"
Values: string
Default Value: ""

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows configuring the ip.dhcp.option12_format to the

value contained in the device.friendly_name.

It is necessary to surround the SGD entry to be used as source for the data with the < and >
characters.

! U1 setvar "ip.dhcp.option12_format" "<device.friendly_name>"

To further explain, if the above command was issued and the value currently stored in the
device.friendly_name parameter was "ShipPrinter", then the response to following
command would be "ShipPrinter":

! U1 getvar "ip.dhcp.option12_value"

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wireless Commands 821
ip.dhcp.option12_value

ip.dhcp.option12_value
Description This command retrieves the actual value which will be used in the discovery
packet of the wireless print server. For printer support, see SGD Command Support
on page 1019.

Type getvar

Commands Details
getvar This command retrieves the actual value which will be used in the discovery packet of the
wireless print server.
Format: ! U1 getvar "ip.dhcp.option12_value"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows configuring the ip.dhcp.option12_format to the

value contained in the device.friendly_name.

It is necessary to surround the SGD entry to be used as source for the data with the < and >
characters.

! U1 setvar "ip.dhcp.option12_format" "<device.friendly_name>"

To further explain, if the above command was issued and the value currently stored in the
device.friendly_name parameter was "ShipPrinter", then the response to following
command would be "ShipPrinter":

! U1 getvar "ip.dhcp.option12_value"

6/8/10 Zebra Programming Guide P1012728-004

822 SGD Wireless Commands
ip.dhcp.request_timeout

ip.dhcp.request_timeout
Description This command retrieves the maximum amount of time (in seconds) for a DHCP
discovery requests on the wireless print server. For printer support, see SGD Command
Support on page 1019.

Type getvar;setvar

Commands Details
getvar This command retrieves the currently set the amount of time (in seconds) to wait before
timing out a DHCP discovery request.
Format: ! U1 getvar "ip.dhcp.request_timeout"
setvar This command instructs the printer to set the amount of time (in seconds) to wait before
timing out a DHCP discovery request.
Format: ! U1 setvar "ip.dhcp.request_timeout" "value"
Values: "2" through "30"
Default: "2"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "2".

! U1 setvar "ip.dhcp.request_timeout" "2"
When the setvar value is set to "2", the getvar result is "2".

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wireless Commands 823
ip.dhcp.requests_per_session

ip.dhcp.requests_per_session
Description This command retrieves the maximum amount of DHCP discovery requests for
a single DHCP session on the wireless print server. For printer support, see SGD Command
Support on page 1019.

Type getvar;setvar

Commands Details
getvar This command retrieves the currently set maximum amount of DHCP discovery requests for
a single DHCP session on the wireless print server.
Format: ! U1 getvar "ip.dhcp.requests_per_session"
setvar This command instructs the printer to set the maximum amount of DHCP discovery requests
for a single DHCP session on the wireless print server.
Format: ! U1 setvar "ip.dhcp.requests_per_session" "value"
Values: "1" through "10"
Default: "2"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "2".

! U1 setvar "ip.dhcp.requests_per_session" "2"
When the setvar value is set to "2", the getvar result is "2".

6/8/10 Zebra Programming Guide P1012728-004

824 SGD Wireless Commands
ip.dhcp.session_interval

ip.dhcp.session_interval
Description This command configures the time interval (in seconds) before a new DHCP
session is started on the wireless print server. For printer support, see SGD Command Support
on page 1019.

Type getvar;setvar

Commands Details
getvar This command retrieves the current DHCP session time out value (in seconds).
Format: ! U1 getvar "ip.dhcp.session_interval"
setvar This command instructs the printer to set the DHCP session time out value (in seconds).
Format: ! U1 setvar "ip.dhcp.session_interval" "value"
Values: "0" through "60"
Default: "10"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "10".

! U1 setvar "ip.dhcp.session_interval" "10"
When the setvar value is set to "10", the getvar result is "10".

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wireless Commands 825
ip.dns.domain

ip.dns.domain
Description This command identifies the network domain of the wireless print server. For
printer support, see SGD Command Support on page 1019.

Type getvar

Commands Details
getvar This command retrieves the network domain of the wireless print server.
Format: ! U1 getvar "ip.dns.domain"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • In this example, the getvar retrieves the network domain of the wireless print
server.
! U1 getvar "ip.dns.domain"

6/8/10 Zebra Programming Guide P1012728-004

826 SGD Wireless Commands
ip.dns.servers

ip.dns.servers
Description This command retrieves a space delimited list of the domain name servers from
a wireless print server. For printer support, see SGD Command Support on page 1019.

Type getvar

Commands Details
getvar This command retrieves a list of space delimited DNS wireless print servers.
Format: ! U1 getvar "ip.dns.servers"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • In this example, the getvar retrieves a list of space delimited DNS wireless
print servers.
! U1 getvar "ip.dns.servers"

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wireless Commands 827
ip.ftp.enable

ip.ftp.enable
Description This printer setting refers to the FTP protocol setting. This command tells the
printer to turn FTP on or off. For printer support, see SGD Command Support on page 1019.

Type getvar; setvar

Commands Details
getvar This command instructs the printer to respond with the FTP status.
Format: ! U1 getvar "ip.ftp.enable"
setvar This command instructs the printer to turn FTP on or off.
Format: ! U1 setvar "ip.ftp.enable" "value"
Values:
"off" = disables FTP
"on" = enables FTP
Default: "on"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the FTP status set to "on".
! U1 setvar "ip.ftp.enable" "on"
When the setvar value is set to "on", the getvar result is that the FTP status is "on".

6/8/10 Zebra Programming Guide P1012728-004

828 SGD Wireless Commands
ip.ftp.execute_file

ip.ftp.execute_file
Description This command setting controls the printers’ ability to process or not process
commands received via the FTP protocol using the printers ZPL engine. For printer support,
see SGD Command Support on page 1019.

Type getvar;setvar

Commands Details
getvar This command instructs the printer to respond with the FTP processing ability status.
Format: ! U1 getvar "ip.ftp.execute_file"
setvar This command instructs the printer to turn FTP processing ability on or off.
Format: ! U1 setvar "ip.ftp.execute_file" "value"
Values:
"off" = disables the printer’s ability to process FTP commands
"on" = enables the printer’s ability to process FTP commands
Default: "on"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the FTP processing ability set to "on".
! U1 setvar "ip.ftp.execute_file" "on"

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wireless Commands 829
ip.gateway

ip.gateway
Description This command instructs the printer to change the gateway address. For printer
support, see SGD Command Support on page 1019.

Important • This setting refers to the gateway address. A set value is ignored if the IP
protocol is not set to permanent.

Type getvar; setvar

Commands Details
getvar This command instructs the printer to respond with the gateway address.
Format: ! U1 getvar "ip.gateway"
setvar This command instructs the printer to change the gateway address.
Format: ! U1 setvar "ip.gateway" "value"
Values: Any valid gateway address
Default: "0.0.0.0"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "10.3.5.1".

! U1 setvar "ip.gateway" "10.3.5.1"
When the setvar value is set to "10.3.5.1", the getvar result is "10.3.5.1".

6/8/10 Zebra Programming Guide P1012728-004

830 SGD Wireless Commands
ip.http.enable

ip.http.enable
Description This printer setting refers to the HTTP protocol/web server setting. For printer
support, see SGD Command Support on page 1019.

Type getvar; setvar

Commands Details
getvar This command instructs the printer to respond with the HTTP status.
Format: ! U1 getvar "ip.http.enable"
setvar This command instructs the printer to change HTTP to on or off.
Format: ! U1 setvar "ip.http.enable" "value"
Values:
"off" = disables HTTP protocol
"on" = enables HTTP protocol
Default: "on"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "on".

! U1 setvar "ip.http.enable" "on"
When the setvar value is set to "on", the getvar result is "on".

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wireless Commands 831
ip.lpd.enable

ip.lpd.enable
Description This printer setting refers to the LPD (Line Printer Daemon) protocol setting.
For printer support, see SGD Command Support on page 1019.

Important • LPD communications from the host should be directed to port 515.

Type getvar; setvar

Commands Details
getvar This command instructs the printer to respond with the LPD status.
Format: ! U1 getvar "ip.lpd.enable"
setvar This command instructs the printer to turn LPD on or off.
Format: ! U1 setvar "ip.lpd.enable" "value"
Values:
"off" = disables LPD protocol
"on" = enables LPD protocol
Default: "on"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "on".

! U1 setvar "ip.lpd.enable" "on"
When the setvar value is set to "on", the getvar result is "on".

6/8/10 Zebra Programming Guide P1012728-004

832 SGD Wireless Commands
ip.mac_raw

ip.mac_raw
Description This command specifies the RAW MAC address of the wireless print server.
The raw mac address is the mac address without the colons (":"). For printer support, see
SGD Command Support on page 1019.

Type getvar

Commands Details
getvar This command retrieves the RAW MAC address of the wireless print server.
Format: ! U1 getvar "ip.mac_raw"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • In this example, the getvar retrieves the RAW MAC address of the wireless
print server.
! U1 getvar "ip.mac_raw"

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wireless Commands 833
ip.mirror.auto

ip.mirror.auto
Description This command enables the ability to automatically perform a mirror update
(fetch) command on power up. For printer support, see SGD Command Support on page 1019.

Type getvar;setvar

Commands Details
getvar This command will report whether the printer will perform a mirror update (fetch)
automatically on power up.
Format: ! U1 getvar "ip.mirror.auto"
setvar This command instructs the printer to perform a mirror update (fetch) command when the
printer is turned on using the interval that is set for "ip.mirror.freq" or
"ip.mirror.freq_hours".
Format: ! U1 setvar "ip.mirror.auto" "values"
Values:
"on" = turns on the auto mirroring feature
"off" = turns off the auto mirroring feature
Default Value: "off"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "off".

! U1 setvar "ip.mirror.auto" "off"
When the setvar value is set to "off", the getvar result is "off".

6/8/10 Zebra Programming Guide P1012728-004

834 SGD Wireless Commands
ip.mirror.error_retry

ip.mirror.error_retry
Description This command identifies how many times mirroring is retried when an error
occurs. For printer support, see SGD Wireless Commands on page 781.

Type getvar;setvar

Commands Details
getvar This command retrieves the number of times the printer retries mirroring when an error
occurs.
Format: ! U1 getvar "ip.mirror.error_retry"
setvar This command instructs the printer to set the required times that mirroring retries when an
error occurs.
Format: ! U1 setvar "ip.mirror.error_retry" "value"
Values: numeric values (0 - 65535)
Default Value: "0"

Note • For details on SGD command structure, see SGD Command Support on page 1019.

Example • This setvar example shows the value set to "0".

! U1 setvar "ip.mirror.error_retry" "0"
When the setvar value is set to "0", the getvar result is "0".

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wireless Commands 835
ip.mirror.feedback.auto

ip.mirror.feedback.auto
Description This command identifies if a feedback file is pushed to the mirroring server by
the printer when a mirroring update (fetch) is complete. For printer support, see SGD
Command Support on page 1019.

Type getvar;setvar

Commands Details
getvar This command retrieves the mirror feedback setting that the printer is currently using.
Format: ! U1 getvar "ip.mirror.feedback.auto"
setvar This command instructs the printer to set the mirror feedback feature to on or off.
Format: ! U1 setvar "ip.mirror.feedback.auto" "value"
Values:
"on" = turns on mirror feedback
"off" = turns off mirror feedback
Default Value: "off"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "off".

! U1 setvar "ip.mirror.feedback.auto" "off"
When the setvar value is set to "off", the getvar result is "off".

6/8/10 Zebra Programming Guide P1012728-004

836 SGD Wireless Commands
ip.mirror.feedback.freq

ip.mirror.feedback.freq
Description This command specifies the time interval (in minutes) between performing
feedback file uploads. For printer support, see SGD Command Support on page 1019.

Type getvar;setvar

Commands Details
getvar This command retrieves the number of minutes set to wait between feedback file uploads.
Format: ! U1 getvar "ip.mirror.feedback.freq"
setvar This command instructs the printer to set the number of minutes to wait between feedback
file uploads.
Format: ! U1 setvar "ip.mirror.feedback.freq" "value"
Values: numeric value (0 - 65535)
Default Value: "0"

Note • For details on SGD command structure, see Command Structure on page 630.

Example • This setvar example shows the value set to "0".

! U1 setvar "ip.mirror.feedback.freq" "0"
When the setvar value is set to "0", the getvar result is "0".

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wireless Commands 837
ip.mirror.feedback.odometer

ip.mirror.feedback.odometer
Description This command instructs the printer to set the mirror feedback odometer. For
printer support, see SGD Command Support on page 1019.

Type getvar;setvar

Commands Details
getvar This command retrieves the mirror feedback odometer.
Format: ! U1 getvar "ip.mirror.feedback.odometer"
setvar This command instructs the printer to set the odometer counter.
Format: ! U1 setvar "ip.mirror.feedback.odometer" "values"
Values: numeric value between 0 and 2632
Default Value: "0"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "0".

! U1 setvar "ip.mirror.feedback.odometer" "0"
When the setvar value is set to "0", the getvar result is "0".

6/8/10 Zebra Programming Guide P1012728-004

838 SGD Wireless Commands
ip.mirror.feedback.path

ip.mirror.feedback.path
Description This command identifies where the feedback file is stored on the mirroring
server. For printer support, see SGD Command Support on page 1019.

Type getvar;setvar

Commands Details
getvar This command retrieves the path on the mirroring sever that the printer is currently using to
store the feedback file.
Format: ! U1 getvar "ip.mirror.feedback.path"
setvar This command instructs the printer to set the path on the mirroring server that stores the
feedback file.
Format: ! U1 setvar "ip.mirror.feedback.path" "value"
Values: alphanumeric text (1 to 50 characters)
Default Value: "Zebra/feedback"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "Zebra/feedback".

! U1 setvar "ip.mirror.feedback.path" "Zebra/feedback"
When the setvar value is set to "Zebra/feedback", the getvar result is
"Zebra/feedback".

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wireless Commands 839
ip.mirror.fetch

ip.mirror.fetch
Description This command forces a mirroring update sequence. For printer support, see
SGD Command Support on page 1019.

Type do;setvar

Commands Details
do This command forces a mirroring update sequence.
Format: ! U1 do "ip.mirror.fetch" ""
setvar This command forces a mirroring update sequence.
Format: ! U1 setvar "ip.mirror.fetch" ""

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example forces a mirroring update sequence.

! U1 setvar "ip.mirror.fetch" ""

6/8/10 Zebra Programming Guide P1012728-004

840 SGD Wireless Commands
ip.mirror.freq

ip.mirror.freq
Description This command defines the frequency of mirroring updates (in minutes). For
printer support, see SGD Command Support on page 1019.

Type getvar;setvar

Commands Details
getvar This command retrieves the number of minutes to wait before performing another mirror
update.
Format: ! U1 getvar "ip.mirror.freq"
setvar This command instructs the printer to set the mirror frequency.
Format: ! U1 setvar "ip.mirror.freq" "value"
Values: "0" through "65535" (minutes)
Default Value: "0" (disables this feature)
Important • When the "ip.mirror.freq" is set to a low value (other than zero)
the printer will spend a lot of time performing the mirroring process.

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "1000".

! U1 setvar "ip.mirror.freq" "1000"
When the setvar value is set to "1000", the getvar result is "1000" and mirroring
will be attempted every 1000 minutes.

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wireless Commands 841
ip.mirror.freq_hours

ip.mirror.freq_hours
Description This command defines the frequency of mirroring updates (in hours). For
printer support, see SGD Command Support on page 1019.

Type getvar;setvar

Commands Details
getvar This command retrieves the frequency of mirroring updates (in hours) that the printer is
currently using.
Format: ! U1 getvar "ip.mirror.freq_hours"
setvar This command instructs the printer to set the frequency of mirroring updates (in hours).
Format: ! U1 setvar "ip.mirror.freq_hours" "values"
Values: "0" through "100"
Default Value: "0" (disables this feature)

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "8".

! U1 setvar "ip.mirror.freq_hours" "8"
When the setvar value is set to "8", the getvar result is "8" and mirroring will be
attempted every 8 hours.

6/8/10 Zebra Programming Guide P1012728-004

842 SGD Wireless Commands
ip.mirror.last_error

ip.mirror.last_error
Description This command retrieves the last error encountered during a mirroring
operation. For printer support, see SGD Command Support on page 1019.

Type getvar

Commands Details
getvar This command retrieves the error code of the last mirroring update (fetch).
Format: ! U1 getvar "ip.mirror.last_error"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • In this example, the getvar retrieves the error code of the last mirroring update.
! U1 getvar "ip.mirror.last_error"

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wireless Commands 843
ip.mirror.last_time

ip.mirror.last_time
Description This command retrieves the timestamp, in seconds, of the last time the system
attempted a mirror update (fetch). For printer support, see SGD Command Support
on page 1019.

Type getvar

Commands Details
getvar This command retrieves the timestamp, in seconds, of the last time the system attempted a
mirror update (fetch).
Format: ! U1 getvar "ip.mirror.last_time"

Note • For details on SGD command structure, see Command Structure on page 630.

Example • In this example, the getvar retrieves the timestamp, in seconds, of the last time
the system attempted a mirror update.
! U1 getvar "ip.mirror.last_time"

6/8/10 Zebra Programming Guide P1012728-004

844 SGD Wireless Commands
ip.mirror.password

ip.mirror.password
Description This command specifies the user password on the mirroring server assigned for
mirroring updates (fetch). For printer support, see SGD Command Support on page 1019.

Type getvar;setvar

Commands Details
getvar This command retrieves the user password the printer is currently using for mirroring
updates (fetch).
Format: ! U1 getvar "ip.mirror.password"
setvar This command instructs the printer to use a specific password for mirroring updates (fetch).
Format: ! U1 setvar "ip.mirror.password" "value"
Values: alphanumeric text string (1 to 20 characters)
Default Value: "password"

Note • For details on SGD command structure, see Command Structure on page 630.

Example • This setvar example shows the value set to "password".

! U1 setvar "ip.mirror.password" "password"
When the setvar value is set to "password", the getvar result is "*". For security
purposes, the printer does not return password information.

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wireless Commands 845
ip.mirror.path

ip.mirror.path
Description This command identifies the base path on the FTP server where the mirror
directory resides. For printer support, see SGD Command Support on page 1019.

Type getvar;setvar

Commands Details
getvar This command retrieves the base path of the FTP server where the mirror directory resides.
Format: ! U1 getvar "ip.mirror.path"
setvar This command sets the base path on the FTP server where the mirror directory resides.
Format: ! U1 setvar "ip.mirror.path" "value"
Values: alphanumeric text string (1 to 50 characters)
Default Value: "zebra"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "zebra".

! U1 setvar "ip.mirror.path" "zebra"
When the setvar value is set to "zebra", the getvar result is "zebra".

6/8/10 Zebra Programming Guide P1012728-004

846 SGD Wireless Commands
ip.mirror.reset_delay

ip.mirror.reset_delay
Description This command specifies the number of seconds between when the printer
receives the last byte of the last file from the /commands directory and when the printer
resets during a mirror event. For printer support, see SGD Wireless Commands on page 781.

Note • This command is available in V53.17.5Z, V56.17.4Z, V60.17.5Z, V61.17.4Z and

later versions.

Type getvar;setvar

Commands Details
getvar This command retrieves the number of seconds between when the printer receives the last
byte of the last file from the /commands directory and when the printer resets during a
mirror event.
Format: ! U1 getvar "ip.mirror.reset_delay"
setvar This command sets the number of seconds between when the printer receives the last byte of
the last file from the /commands directory and when the printer resets during a mirror event.
Format: ! U1 setvar "ip.mirror.reset_delay" "value"
Values: 0 - 900 (seconds)
Default Value: "5"
The default setting for the ip.mirror.reset_delay command is 5 seconds;
in some cases it may be necessary to use a longer delay to allow for full processing
of longer or more complex files.

Note • For details on SGD command structure, see SGD Command Support on page 1019.

Example • This setvar example shows the value set to "10".

! U1 setvar "ip.mirror.reset_delay" "10"
When the setvar value is set to "10", the getvar result is "10".

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wireless Commands 847
ip.mirror.server

ip.mirror.server
Description This command identifies the IP address of the mirroring server. For printer
support, see SGD Command Support on page 1019.

Type getvar;setvar

Commands Details
getvar This command retrieves the IP address of the mirroring server.
Format: ! U1 getvar "ip.mirror.server"
setvar This command sets the IP address of the mirroring server.
Format: ! U1 setvar "ip.mirror.server" "value"
Values: a valid IP address
Default Value: "127.0.0.1"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "10.3.1.1".

! U1 setvar "ip.mirror.server" "10.3.1.1"
When the setvar value is set to "10.3.1.1", the getvar result is "10.3.1.1".

6/8/10 Zebra Programming Guide P1012728-004

848 SGD Wireless Commands
ip.mirror.success

ip.mirror.success
Description This command reports the success or failure of the last mirroring update
(fetch). For printer support, see SGD Wireless Commands on page 781.

Type getvar

Commands Details
getvar This command retrieves the success or failure of the last mirroring update (fetch).
Format: ! U1 getvar "ip.mirror.success"
Values:
"yes" = successful
"no" = unsuccessful

Note • For details on SGD command structure, see Command Structure on page 785.

Example • In this example, the getvar retrieves the success or failure of the last mirroring
update (fetch).
! U1 getvar "ip.mirror.success"

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wireless Commands 849
ip.mirror.success_time

ip.mirror.success_time
Description This command provides the timestamp, in seconds, of the last time the system
successfully completed a mirror update (fetch). For printer support, see SGD Command
Support on page 1019.

Type getvar

Commands Details
getvar This command retrieves the timestamp, in seconds, of the last time the system successfully
completed a mirror update (fetch).
Format: ! U1 getvar "ip.mirror.success_time"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • In this example, the getvar retrieves the timestamp of the last time the system
successfully completed a mirror update.
! U1 getvar "ip.mirror.success_time"

6/8/10 Zebra Programming Guide P1012728-004

850 SGD Wireless Commands
ip.mirror.username

ip.mirror.username
Description This command specifies the user name on the mirroring server assigned for
mirroring updates (fetch). For printer support, see SGD Command Support on page 1019.

Type getvar;setvar

Commands Details
getvar This command retrieves the user name the printer is currently using for mirroring updates
(fetch).
Format: ! U1 getvar "ip.mirror.username"
setvar This command instructs the printer to use a specific user name for mirroring updates (fetch).
Format: ! U1 setvar "ip.mirror.username" "value"
Values: alphanumeric text string (1 to 20 characters)
Default Value: "user"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "user".

! U1 setvar "ip.mirror.username" "user"
When the setvar value is set to "user", the getvar result is "user".

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wireless Commands 851
ip.mirror.version

ip.mirror.version
Description This command retrieves the mirror code build date. For printer support, see
SGD Command Support on page 1019.

Type getvar

Commands Details
getvar This command retrieves the mirror code build date.
Format: ! U1 getvar "ip.mirror.version"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • In this example, the getvar retrieves the mirror code build date.
! U1 getvar "ip.mirror.version"

6/8/10 Zebra Programming Guide P1012728-004

852 SGD Wireless Commands
ip.netmask

ip.netmask
Description This setting refers to the subnet mask address. This value is ignored if the IP
protocol is not set to permanent. For printer support, see SGD Command Support
on page 1019.

Type getvar; setvar

Commands Details
getvar This command instructs the printer to respond with subnet mask.
Format: ! U1 getvar "ip.netmask"
setvar This command instructs the printer to change the subnet mask.
Format: ! U1 setvar "ip.netmask" "value"
Values: Any valid subnet mask.
Default: "255.255.255.0"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "255.255.255.0".

! U1 setvar "ip.netmask" "255.255.255.0"
When the setvar value is set to "255.255.255.0", the getvar result is
"255.255.255.0".

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wireless Commands 853
ip.pop3.enable

ip.pop3.enable
Description This printer setting determines if the printer queries a POP3 mailbox for mail.
For printer support, see SGD Command Support on page 1019.

Type getvar; setvar

Commands Details
getvar This command instructs the printer to respond with the POP3 status.
Format: ! U1 getvar "ip.pop3.enable"
setvar This command instructs the printer to turn POP3 on or off.
Format: ! U1 setvar "ip.pop3.enable" "value"
Values:
"off" = disables POP3
"on" = enables POP3
Default: "on"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "on".

! U1 setvar "ip.pop3.enable" "on"
When the setvar value is set to "on", the getvar result is "on".

6/8/10 Zebra Programming Guide P1012728-004

854 SGD Wireless Commands
ip.pop3.password

ip.pop3.password
Description This printer setting refers to the POP3 mailbox password. This only applies if
"ip.pop3.enable" is set to on. For printer support, see SGD Command Support
on page 1019.

Type getvar; setvar

Commands Details
getvar This command instructs the printer to respond with the POP3 password.
Format: ! U1 getvar "ip.pop3.password"
For protection a single "*" prints.
setvar This command instructs the printer to change the POP3 password.
Format: ! U1 setvar "ip.pop3.password" "value"
Values: A maximum of 20 alphanumeric characters
Default: " "

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "password".

! U1 setvar "ip.pop3.password" "password"
When the setvar value is set to "password", the getvar result is "*".

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wireless Commands 855
ip.pop3.poll

ip.pop3.poll
Description This printer setting refers to how frequent (in seconds) the printer queries a
POP3 mailbox for new mail. This only applies if the "ip.pop3.enable" is set to on. For
printer support, see SGD Command Support on page 1019.

Type getvar; setvar

Commands Details
getvar This command instructs the printer to respond with the POP3 poll frequency (in seconds).
Format: ! U1 getvar "ip.pop3.poll"
setvar This command instructs the printer to change the POP3 poll interval. A value of "0" causes
the printer to only query the POP3 mailbox one time, on printer power up, or following a
network reset.
Format: ! U1 setvar "ip.pop3.poll" "value"
Values: "0" through "65535"
Default: "0"
Note • A poll value of less then thirty seconds is not recommended. The printer is
unresponsive for several seconds when polling for email depending on data transfer
time from the server to the printer.

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "0".

! U1 setvar "ip.pop3.poll" "0"
When the setvar value is set to "0", the getvar result is "0".

6/8/10 Zebra Programming Guide P1012728-004

856 SGD Wireless Commands
ip.pop3.server_addr

ip.pop3.server_addr
Description This printer setting refers to the POP3 server IP address that the printer contacts
when checking for new mail. This only applies if "ip.pop3.enable" is set to on. For
printer support, see SGD Command Support on page 1019.

Type getvar; setvar

Commands Details
getvar This command instructs the printer to respond with the POP3 server address.
Format: ! U1 getvar "ip.pop3.server_addr"
setvar This command instructs the printer to change the POP3 server address.
Format: ! U1 setvar "ip.pop3.server_addr" "value"
Values: Any valid POP3 server address
Default: "0.0.0.0"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "10.3.5.10".

! U1 setvar "ip.pop3.server_addr" "10.3.5.10"
When the setvar value is set to "10.3.5.10", the getvar result is "10.3.5.10".

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wireless Commands 857
ip.pop3.username

ip.pop3.username
Description This printer setting refers to the POP3 user name. This only applies if the
"ip.pop3.enable" is set to on. For printer support, see SGD Command Support
on page 1019.

Type getvar; setvar

Commands Details
getvar This command instructs the printer to respond with the POP3 user name.
Format: ! U1 getvar "ip.pop3.username"
setvar This command instructs the printer to change the POP3 user name.
Format: ! U1 setvar "ip.pop3.username" "value"
Values: A maximum of 20 alphanumeric characters
Default: " "

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "user".

! U1 setvar "ip.pop3.username" "user"
When the setvar value is set to "user", the getvar result is "user".

6/8/10 Zebra Programming Guide P1012728-004

858 SGD Wireless Commands
ip.port

ip.port
Description This printer setting refers to the port number that the TCP print service is
listening on. Normal TCP communications from the host should be directed to this port. For
printer support, see SGD Command Support on page 1019.

Type getvar; setvar

Commands Details
getvar This command instructs the printer to respond with the TCP/UDP port number.
Format: ! U1 getvar "ip.port"
setvar This command instructs the printer to set the TCP/UDP port number.
Format: ! U1 setvar "ip.port" "value"
Values: 1 - 65535 (excluding any ports currently used by other services, such as 21, 23, 80,
and 515).
Default: "9100"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "9100".

! U1 setvar "ip.port" "9100"
When the setvar value is set to "9100", the getvar result is "9100".

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wireless Commands 859
ip.primary_network

ip.primary_network
Description This command allows you to set the primary network to either wired or
wireless. For printer support, see SGD Command Support on page 1019.

Type getvar; setvar

Commands Details
getvar This command instructs the printer to respond with the name of the current primary network
device.
Format: ! U1 getvar "ip.primary_network"
setvar This command instructs the printer to set the primary network device.
Format: ! U1 setvar "ip.primary_network" "value"
Values:
1 = wired
2 = wireless
Default: "1"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "1".

! U1 setvar "ip.primary_network" "1"
What the setvar value is set to is the getvar result. In this example, the getvar result is
"1".

6/8/10 Zebra Programming Guide P1012728-004

860 SGD Wireless Commands
ip.smtp.domain

ip.smtp.domain
Description This printer setting refers to the domain name used by the printer in sending
email with respect to the SMTP server. For printer support, see SGD Command Support
on page 1019.

Type getvar; setvar

Commands Details
getvar This command instructs the printer to return the SMTP domain name.
Format: ! U1 getvar "ip.smtp.domain"
setvar This command instructs the printer to change the SMTP domain name.
Format: ! U1 setvar "ip.smtp.domain" "value"
Values: A maximum of 24 alphanumeric characters
Default: "ZBRPrintServer"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "ZBRPrintServer.com".

! U1 setvar "ip.smtp.domain" "ZBRPrintServer.com"
When the setvar value is set to "ZBRPrintServer.com", the getvar result is
"ZBRPrintServer.com".

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wireless Commands 861
ip.smtp.enable

ip.smtp.enable
Description This printer setting refers to the SMTP protocol. For printer support, see SGD
Command Support on page 1019.

Type getvar; setvar

Commands Details
getvar This command instructs the printer to return the SMTP status.
Format: ! U1 getvar "ip.smtp.enable"
setvar This command instructs the printer to turn SMTP on or off.
Format: ! U1 setvar "ip.smtp.enable" "value"
Values:
"off" = disables SMTP
"on" = enables SMTP
Default: "on"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "on".

! U1 setvar "ip.smtp.enable" "on"
When the setvar value is set to "on", the getvar result is "on".

6/8/10 Zebra Programming Guide P1012728-004

862 SGD Wireless Commands
ip.smtp.server_addr

ip.smtp.server_addr
Description This printer setting refers to the IP address of the SMTP server used for sending
email. For printer support, see SGD Command Support on page 1019.

Type getvar; setvar

Commands Details
getvar This command instructs the printer to respond with the current SMTP server address.
Format: ! U1 getvar "ip.smtp.server_addr"
setvar This command instructs the printer to change the SMTP server address.
Format: ! U1 setvar "ip.smtp.server_addr" "value"
Values: Any valid IP address.
Default: 0.0.0.0

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to 10.10.10.10.

! U1 setvar "ip.smtp.server_addr" "10.10.10.10"
When the setvar value is set to "10.10.10.10", the getvar result is
"10.10.10.10".

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wireless Commands 863
ip.snmp.get_community_name

ip.snmp.get_community_name
Description This printer setting is used when making SNMP queries. The SNMP client
must supply the get community name that matches the printer’s get community name in order
to query any SNMP data. For printer support, see SGD Command Support on page 1019.

Type getvar; setvar

Commands Details
getvar This command instructs the printer to get the SNMP get community name string.
Format: ! U1 getvar "ip.snmp.get_community_name"
For protection a single "*" prints.
setvar This command instructs the printer to set the SNMP get community name string.
Format:
! U1 setvar "ip.snmp.get_community_name" "value"
Values: A maximum of 19 alphanumeric characters.
Default: "public"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "public".

! U1 setvar "ip.snmp.get_community_name" "public"
When the setvar value is set to "public", the getvar result is "*".

6/8/10 Zebra Programming Guide P1012728-004

864 SGD Wireless Commands
ip.snmp.set_community_name

ip.snmp.set_community_name
Description This printer setting is used when changing SNMP data remotely. To alter any
SNMP data, the SNMP client must supply the set community name that matches the printer’s
set community name. For printer support, see SGD Command Support on page 1019.

Type getvar; setvar

Commands Details
getvar This command instructs the printer to return the printer’s SNMP set community name string.
Format: ! U1 getvar "ip.snmp.set_community_name"
For protection a single "*" returns.
setvar This command instructs the printer to set the SNMP set community name string.
Format: ! U1 setvar "ip.snmp.set_community_name" "value"
Values: A maximum of 19 alphanumeric characters
Default: "public"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "public".

! U1 setvar "ip.snmp.set_community_name" "public"
When the setvar value is set to "public", the getvar result is "*".

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wireless Commands 865
ip.snmp.enable

ip.snmp.enable
Description This printer setting refers to the SNMP protocol. For printer support, see SGD
Command Support on page 1019.

Type getvar; setvar

Commands Details
getvar This command instructs the printer to respond with the SNMP status.
Format: ! U1 getvar "ip.snmp.enable"
setvar This command instructs the printer to enable or disable the SNMP protocol.
Format: ! U1 setvar "ip.snmp.enable" "value"
Values:
"on" = enable the SNMP protocol
"off" = disable the SNMP protocol
Default: "on"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "on".

! U1 setvar "ip.snmp.enable" "on"
When the setvar value is set to "on", the getvar result is "on".

6/8/10 Zebra Programming Guide P1012728-004

866 SGD Wireless Commands
ip.telnet.enable

ip.telnet.enable
Description This printer setting refers to the TELNET (port 23) protocol. For printer
support, see SGD Command Support on page 1019.

Type getvar; setvar

Commands Details
getvar This command instructs the printer to respond with the TELNET status.
Format: ! U1 getvar "ip.telnet.enable"
setvar This command instructs the printer to turn TELNET on or off.
Format: ! U1 setvar "ip.telnet.enable" "value"
Values:
"off" = disables telnet protocol
"on" = enables telnet protocol
Default: "on"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "on".

! U1 setvar "ip.telnet.enable" "on"
When the setvar value is set to "on", the getvar result is "on".

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wireless Commands 867
ip.tcp.enable

ip.tcp.enable
Description This printer setting refers to the TCP socket protocol. For printer support, see
SGD Command Support on page 1019.

Type getvar; setvar

Commands Details
getvar This command instructs the printer to respond with the TCP status.
Format: ! U1 getvar "ip.tcp.enable"
setvar This command instructs the printer to turn the TCP on or off.
Format: ! U1 setvar "ip.tcp.enable" "value"
Values:
"off" = disables TCP protocol
"on" = enables TCP protocol
Default: "on"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "on".

! U1 setvar "ip.tcp.enable" "on"
When the setvar value is set to "on", the getvar result is "on".

6/8/10 Zebra Programming Guide P1012728-004

868 SGD Wireless Commands
ip.udp.enable

ip.udp.enable
Description This printer setting refers to the UDP socket protocol. For printer support, see
SGD Command Support on page 1019.

Type getvar; setvar

Commands Details
getvar This command instructs the printer to respond with the UDP status.
Format: ! U1 getvar "ip.udp.enable"
setvar This command instructs the printer to turn UDP on or off.
Format: ! U1 setvar "ip.udp.enable" "value"
Values:
"off" = disables UDP protocol
"on" = enables UDP protocol
Default: "off"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "on".

! U1 setvar "ip.udp.enable" "on"
When the setvar value is set to "on", the getvar result is "on".

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wireless Commands 869
wlan.adhocautomode

wlan.adhocautomode
Description This printer setting refers to enabling or disabling the adhoc auto mode. For
printer support, see SGD Command Support on page 1019.

Type getvar; setvar

Commands Details
getvar This command instructs the printer to respond with the adhoc auto mode status.
Format: ! U1 getvar "wlan.adhocautomode"
setvar This command instructs the printer to set the adhoc auto mode.
Format: ! U1 setvar "wlan.adhocautomode" "value"
Values:
"on" = adhoc auto mode enabled
"off" = adhoc auto mode disabled
Default: "off"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "on".

! U1 setvar "wlan.adhocautomode" "on"
When the setvar value is set to "on", the getvar result is "on".

6/8/10 Zebra Programming Guide P1012728-004

870 SGD Wireless Commands
wlan.adhocchannel

wlan.adhocchannel
Description This printer setting refers to specifying the wireless channel for adhoc channel.
For printer support, see SGD Command Support on page 1019.

Type getvar; setvar

Commands Details
getvar This command instructs the printer to respond with the wireless channel for adhoc channel
mode.
Format: ! U1 getvar "wlan.adhocchannel"
setvar This command instructs the printer to set the wireless channel for adhoc channel mode.
Format: ! U1 setvar "wlan.adhocchannel" "value"
Values: Decimal value between 1 and 16 inclusive
Default: "1"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "1".

! U1 setvar "wlan.adhocchannel" "1"
When the setvar value is set to "1", the getvar result is "1".

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wireless Commands 871
wlan.associated

wlan.associated
Description This command refers to if the printer is or is not associated with an access point
(AP). For printer support, see SGD Command Support on page 1019.

Type getvar

Commands Details
getvar This command instructs the printer to respond with yes or no, which identifies if it is
associated with the AP.
Format: ! U1 getvar "wlan.associated"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • In this example, the getvar result is "yes".

! U1 getvar "wlan.associated"

6/8/10 Zebra Programming Guide P1012728-004

872 SGD Wireless Commands
wlan.bssid

wlan.bssid
Description This command returns the MAC address of the access point (AP) with which
the printer is associated. For printer support, see SGD Command Support on page 1019.

Type getvar

Commands Details
getvar This command retrieves the MAC address of the access point (AP).
Format: ! U1 getvar "wlan.bssid"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • In this example, the getvar result is the MAC address of the access point.
! U1 getvar "wlan.bssid"

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wireless Commands 873
wlan.channel

wlan.channel
Description This command retrieves the current WI-FI channel the printer is using. For
printer support, see SGD Command Support on page 1019.

Type getvar

Commands Details
getvar This command retrieves the current WI-FI channel the printer is using.
Format: ! U1 getvar "wlan.channel"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • In this example, the getvar retrieves the current WI-FI channel the printer is
using.
! U1 getvar "wlan.channel"

6/8/10 Zebra Programming Guide P1012728-004

874 SGD Wireless Commands
wlan.channel_mask

wlan.channel_mask
Description This printer setting refers to specifying the wireless channel masks to enable
and disable various channels. For printer support, see SGD Command Support on page 1019.

Type getvar; setvar

Commands Details
getvar This command instructs the printer to respond with the wireless channel mask value.
Format: ! U1 getvar "wlan.channel_mask"
setvar This command instructs the printer to set the wireless channel mask value.
Format: ! U1 setvar "wlan.channel_mask" "value"
Values: 4 Hexadecimal digits preceded by "0x" (0x0000 to 0xFFFF). For commonly used
channel masks, see Table 28.
Default: "0x7FF"

Note • For details on SGD command structure, see Command Structure on page 785.

Table 28 • Channel Mask Settings

Region Channel Mask

United States, Canada, Latin America 0x7FF
Europe, Middle East, Africa, other 0x1FFF
Japan 0x3FFF

Example • This setvar example shows the value set to "0x7FF".

! U1 setvar "wlan.channel_mask" "0x7FF"
When the setvar value is set to "0x7FF", the getvar result is "0x7FF".

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wireless Commands 875
wlan.current_tx_rate

wlan.current_tx_rate
Description This command retrieves the transmission rate of the wireless print server. For
printer support, see SGD Command Support on page 1019.

Type getvar

Commands Details
getvar This command instructs the printer to retrieve the current transmit rate of the wireless print
server.
Format: ! U1 getvar "wlan.current_tx_rate"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • In this example, the getvar retrieves the transmission rate of the wireless print
server.
! U1 getvar "wlan.current_tx_rate"

6/8/10 Zebra Programming Guide P1012728-004

876 SGD Wireless Commands
wlan.essid

wlan.essid
Description This printer setting refers to the printer’s stored ESSID. Setting the ESSID to ""
will set the printer in a "broadcast" mode. For printer support, see SGD Command
Support on page 1019.

Type getvar; setvar

Commands Details
getvar This command instructs the printer to respond with the stored ESSID value.
Format: ! U1 getvar "wlan.essid"
setvar This command instructs the printer to change the ESSID.
Format: ! U1 setvar "wlan.essid" "value"
Values: 32 character alphanumeric string
Default: "125"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "125".

! U1 setvar "wlan.essid" "125"
When the setvar value is set to "125", the getvar result is "125".

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wireless Commands 877
wlan.firmware_version

wlan.firmware_version
Description This command refers to the firmware version of the wireless radio card. For
printer support, see SGD Command Support on page 1019.

Type getvar

Commands Details
getvar This command instructs the printer to respond with the current version of the wireless radio
card firmware.
Format: ! U1 getvar "wlan.firmware_version"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • In this example, the getvar result is the version of Symbol 4137 card (for
example, "F3.91-69").
! U1 getvar "wlan.firmware_version"

6/8/10 Zebra Programming Guide P1012728-004

878 SGD Wireless Commands
wlan.ip.addr

wlan.ip.addr
Description This command allows you to get or set the wireless print servers’s IP address.
For printer support, see SGD Command Support on page 1019.

Important • For a set IP address to take affect, the IP protocol must be set to permanent and
the print server must be reset.

Type getvar; setvar

Commands Details
getvar This command instructs the printer to respond with its current wireless print server IP
address.
Format: ! U1 getvar "wlan.ip.addr"
setvar This command instructs the printer to change its current wireless print server IP address
upon powering the printer on.
Format: ! U1 setvar "wlan.ip.addr" "value"
Values: any valid IP address
Default: "0.0.0.0"
Note • The setvar value of this command can be affected by the
wlan.ip.dhcp.enable command.

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "10.14.4.235".

! U1 setvar "wlan.ip.addr" "10.14.4.235"
What the setvar value is set to is the getvar result. In this example, the getvar result is
"10.14.4.235".

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wireless Commands 879
wlan.ip.arp_interval

wlan.ip.arp_interval
Description This print server setting allows you to specify the ARP (Address Resolution
Protocol) interval or the ARP cache time out for the wireless print server. For printer support,
see SGD Command Support on page 1019.

Type getvar; setvar

Commands Details
getvar This command instructs the printer to respond with the ARP interval or the ARP cache time
out value (in seconds) for the wireless print server.
Format: ! U1 getvar "wlan.ip.arp_interval"
setvar This command instructs the printer to respond with the ARP interval or the
ARP cache time out value for the wireless print server.
Format: ! U1 setvar "wlan.ip.arp_interval" "value"
Values: 0 to 30 seconds
Default: "0"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "0".

! U1 setvar "wlan.ip.arp_interval" "0"
What the setvar value is set to is the getvar result. In this example, the getvar result is
"0".

6/8/10 Zebra Programming Guide P1012728-004

880 SGD Wireless Commands
wlan.ip.default_addr_enable

wlan.ip.default_addr_enable
Description This command allows you to default the wireless print server’s IP address. For
printer support, see SGD Command Support on page 1019.

Important • For a set IP address to take affect, the IP protocol must be set to permanent and
the print server must be reset.

Type getvar; setvar

Commands Details
getvar This command instructs the printer to show the status of the setting of the wireless print
server’s default IP address feature.
Format: ! U1 getvar "wlan.ip.default_addr_enable"
setvar This command tells the printer to use it’s default address, if no address is provided through
DHCP or BOOTP. If you do not assign an IP address after 2 minutes, the 10/100 Internal PS
defaults to IP address 192.168.254.254.
Format: ! U1 setvar "wlan.ip.default_addr_enable" "value"
Values:
"on" = enabled
"off" = disabled
Default: "on"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "on".

! U1 setvar "wlan.ip.default_addr_enable" "on"
What the setvar value is set to is the getvar result. In this example, the getvar result is
"on".

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wireless Commands 881
wlan.ip.dhcp.cache_ip

wlan.ip.dhcp.cache_ip
Description This command enables or disables the IP cache of the wireless print server. For
printer support, see SGD Command Support on page 1019.

Type getvar;setvar

Commands Details
getvar This command retrieves the status of the IP cache.
Format: ! U1 getvar "wlan.ip.dhcp.cache_ip"
setvar This command sets the status of the IP cache.
Format: ! U1 setvar "ip.dhcp.cache_ip" "value"
Values:
"on" = enabled
"off” = disabled
Default: "off”

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "off".

! U1 setvar "wlan.ip.dhcp.cache_ip" "off"
When the setvar value is set to "off", the getvar result is "off".

6/8/10 Zebra Programming Guide P1012728-004

882 SGD Wireless Commands
wlan.ip.dhcp.cid_all

wlan.ip.dhcp.cid_all
Description This printer setting defines the entire client identifier (DHCP option 61) if
DHCP is enabled on the wireless print server and "wlan.ip.dhcp.cid_type" is set to
"0", or "2". The MAC address is used if the type is set to "1". For printer support, see SGD
Command Support on page 1019.

Type getvar; setvar

Commands Details
getvar This command instructs the printer to respond with the client identifier prefix and suffix of
the wireless print server.
Format: ! U1 getvar "wlan.ip.dhcp.cid_all"
setvar This command instructs the printer to change the client identifer prefix and suffix of the
wireless print server. The prefix gets cleared and the suffix contains the entire client
identifer.
Format: ! U1 setvar "wlan.ip.dhcp.cid_all" "value"
Values: A maximum length of 60 characters if the CID type is ASCII, or 120 characters if
the CID type is hexadecimal.
Default Value: ""

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "printer".

! U1 setvar "wlan.ip.dhcp.cid_all" "printer"
What the setvar value is set to is the getvar result. In this example, the getvar result is
"printer".

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wireless Commands 883
wlan.ip.dhcp.cid_enable

wlan.ip.dhcp.cid_enable
Description This command determines if DHCP (option 61) is turned on or off of the
wireless print server. For printer support, see SGD Command Support on page 1019.

Type getvar; setvar

Commands Details
getvar This command instructs the printer to respond with the status of the client identifier of the
wireless print server.
Format: ! U1 getvar "wlan.ip.dhcp.cid_enable"
setvar This command instructs the printer to set the status of the client identifier of the wireless
print server.
Format: ! U1 setvar "wlan.ip.dhcp.cid_enable" "value"
Values:
"off" = client identifier is turned off
"on" = client identifier is turned on
Default: "off"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "off".

! U1 setvar "wlan.ip.dhcp.cid_enable" "off"
What the setvar value is set to is the getvar result. In this example, the getvar result is
"off".

6/8/10 Zebra Programming Guide P1012728-004

884 SGD Wireless Commands
wlan.ip.dhcp.cid_prefix

wlan.ip.dhcp.cid_prefix
Description This printer setting defines the prefix to be prepended to the DHCP client
identifier (option 61) when DHCP is enabled on the wireless print server and
"wlan.ip.dhcp.cid_type" is set to "0" or "2". For printer support, see SGD
Command Support on page 1019.

Type getvar; setvar

Commands Details
getvar This command instructs the printer to respond with the client identifier prefix of the wireless
print server.
Format: ! U1 getvar "wlan.ip.dhcp.cid_prefix"
setvar This command instructs the printer to change the CID prefix of the wireless print server.
Format: ! U1 setvar "wlan.ip.dhcp.cid_prefix" "value"
Values: Any text string up to 10 characters if the CID type is ASCII, or 20 characters if the
CID type is hexadecimal.
Default Value: ""

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "PRT001".

! U1 setvar "wlan.ip.dhcp.cid_prefix" "PRT001"
What the setvar value is set to is the getvar result. In this example, the getvar result is
"PRT001".

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wireless Commands 885
wlan.ip.dhcp.cid_suffix

wlan.ip.dhcp.cid_suffix
Description This printer setting defines the unique suffix to be used as the client identifier
(DHCP option 61) if DHCP is enabled on the wireless print server and
"wlan.ip.dhcp.cid_type" is set to "0" or "2". For printer support, see SGD
Command Support on page 1019.

Type getvar; setvar

Commands Details
getvar This command instructs the printer to respond with the client identifier suffix on the
wireless print server.
Format: ! U1 getvar "wlan.ip.dhcp.cid_suffix"
setvar This command instructs the printer to change the client identifier suffix value on the
wireless print server.
Format: ! U1 setvar "wlan.ip.dhcp.cid_suffix" "value"
Values: The maximum length of a value allowed is 60 ASCII characters when the CID type
is ASCII, or 120 hexadecimal values when the CID type is hexadecimal.
Default: ""

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "printer".

! U1 setvar "wlan.ip.dhcp.cid_suffix" "printer"
What the setvar value is set to is the getvar result. In this example, the getvar result is
"printer".

6/8/10 Zebra Programming Guide P1012728-004

886 SGD Wireless Commands
wlan.ip.dhcp.cid_type

wlan.ip.dhcp.cid_type
Description This printer setting defines the type of client identifier (DHCP option 61) that
will be sent if DHCP is enabled on the wireless print server. A value of "1" means the type of
"Ethernet" and the printer’s MAC address will be used. A value of "0" or "2" means the
client identifier sent will be "wlan.ip.dhcp.cid_prefix" concatenated with
"wlan.ip.dhcp.cid_suffix". For printer support, see SGD Command Support
on page 1019.

Type getvar; setvar

Commands Details
getvar This command instructs the printer to respond with the client identifier type for the wireless
print server.
Format: ! U1 getvar "wlan.ip.dhcp.cid_type"
setvar This command instructs the printer to enable "synthetic" client identifier for the wireless
print server.
Format: ! U1 setvar "wlan.ip.dhcp.cid_type" "value"
Values:
"0" = ASCII string
"1" = wireless radio card’s MAC address
"2" = HEX value
Default Value: "1"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "1".

! U1 setvar "wlan.ip.dhcp.cid_type" "1"
What the setvar value is set to is the getvar result. In this example, the getvar result is
"1".

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wireless Commands 887
wlan.ip.dhcp.lease.last_attempt

wlan.ip.dhcp.lease.last_attempt
Description This command retrieves the last time a DHCP request was sent from the
wireless print server. For printer support, see SGD Command Support on page 1019.

Type getvar

Commands Details
getvar This command retrieves the last time a DHCP request was sent from the wireless print
server.
Format: ! U1 getvar "wlan.ip.dhcp.lease.last_attempt"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • In this example, the getvar retrieves the last time a DHCP request was sent to
the wireless print server.
! U1 getvar "wlan.ip.dhcp.lease.last_attempt"

6/8/10 Zebra Programming Guide P1012728-004

888 SGD Wireless Commands
wlan.ip.dhcp.lease.length

wlan.ip.dhcp.lease.length
Description This command retrieves the original length (in seconds) of the DHCP lease on
the wireless print server. For printer support, see SGD Command Support on page 1019.

Type getvar

Commands Details
getvar This command retrieves the original length (in seconds) of the DHCP lease on the wireless
print server.
Format: ! U1 getvar "wlan.ip.dhcp.lease.length"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This command retrieves the original length of the DHCP lease on the wireless
print server.
! U1 getvar "wlan.ip.dhcp.lease.length"

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wireless Commands 889
wlan.ip.dhcp.lease.server

wlan.ip.dhcp.lease.server
Description This command retrieves the address of the print server that provided the DHCP
lease on the wireless print server. For printer support, see SGD Command Support
on page 1019.

Type getvar

Commands Details
getvar This command retrieves the address if the print server that provided the DHCP lease on the
wireless print server.
Format: ! U1 getvar "wlan.ip.dhcp.lease.server"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • In this example, the getvar retrieves the server that provided the DHCP lease
on the wireless print server.
! U1 getvar "wlan.ip.dhcp.lease.server"

6/8/10 Zebra Programming Guide P1012728-004

890 SGD Wireless Settings
wlan.ip.dhcp.lease.time_left

wlan.ip.dhcp.lease.time_left
Description This command retrieves the time (in seconds) left in the current DHCP lease on
the wireless print server. For printer support, see SGD Command Support on page 1019.

Type getvar

Commands Details
getvar This command retrieves the time (in seconds) left in the current DHCP lease on the wireless
print server.
Format: ! U1 getvar "wlan.ip.dhcp.lease.time_left"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • In this example, the getvar retrieves the time left in the current DHCP lease on
the wireless print server.
! U1 getvar "wlan.ip.dhcp.lease.time_left"

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wireless Commands 891
wlan.ip.dhcp.option12

wlan.ip.dhcp.option12
Description This command specifies if the DHCP option 12 (host name) is on or off in the
discovery packet that is sent from the wireless print server. For printer support, see SGD
Command Support on page 1019.

Type getvar;setvar

Commands Details
getvar This command retrieves the status of the DHCP option 12 (host name) is on or off in the
discovery packet that is sent from the wireless print server.
Format: ! U1 getvar "wlan.ip.dhcp.option12"
setvar This command instructs the printer to set the DHCP option 12 (host name) is on or off in the
discovery packet that is sent from the wireless print server.
Format: ! U1 setvar "wlan.ip.dhcp.option12" "value"
Values:
"on" = turns on option 12
"off" = turns off option 12
Default Value: "on"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "on".

! U1 setvar "wlan.ip.dhcp.option12" "on"
When the setvar value is set to "on", the getvar result is "on".

6/8/10 Zebra Programming Guide P1012728-004

892 SGD Wireless Commands
wlan.ip.dhcp.option12_format

wlan.ip.dhcp.option12_format
Description This command specifies the format of the option 12 value to be used in the
discovery packet of the wireless print server. For printer support, see SGD Command Support
on page 1019.

Type getvar;setvar

Commands Details
getvar This command retrieves the format of option 12 value to be used in the discovery packet of
the wireless print server.
Format: ! U1 getvar "wlan.ip.dhcp.option12_format"
setvar This command instructs the printer to set the format of option 12 value to be used in the
discovery packet of the wireless print server.
Format: ! U1 setvar "wlan.ip.dhcp.option12_format" "value"
Values: string
Default Value: ""

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows configuring the wlan.ip.dhcp.option12_format to

the value contained in the device.friendly_name.

It is necessary to surround the SGD entry to be used as source for the data with the < and >
characters.

! U1 setvar "wlan.ip.dhcp.option12_format"
"<device.friendly_name>"

To further explain, if the above command was issued and the value currently stored in the
device.friendly_name parameter was "ShipPrinter", then the response to following
command would be "ShipPrinter":

! U1 getvar "wlan.ip.dhcp.option12_value"

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wireless Commands 893
wlan.ip.dhcp.option12_value

wlan.ip.dhcp.option12_value
Description This command retrieves the actual value which will be used in the discovery
packet of the wireless print server. For printer support, see SGD Command Support
on page 1019.

Type getvar

Commands Details
getvar This command retrieves the actual value which will be used in the discovery packet of the
wireless print server.
Format: ! U1 getvar "wlan.ip.dhcp.option12_value"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows configuring the wlan.ip.dhcp.option12_format to

the value contained in the device.friendly_name.

It is necessary to surround the SGD entry to be used as source for the data with the < and >
characters.

! U1 setvar "wlan.ip.dhcp.option12_format"
"<device.friendly_name>"

To further explain, if the above command was issued and the value currently stored in the
device.friendly_name parameter was "ShipPrinter", then the response to following
command would be "ShipPrinter":

! U1 getvar "wlan.ip.dhcp.option12_value"

6/8/10 Zebra Programming Guide P1012728-004

894 SGD Wireless Commands
wlan.ip.dhcp.request_timeout

wlan.ip.dhcp.request_timeout
Description This command sets the maximum time (in seconds) to wait for a response to a
DHCP discovery request on the wireless print server. For printer support, see SGD Command
Support on page 1019.

Type getvar;setvar

Commands Details
getvar This command retrieves the maximum time (in seconds) to wait for a response to a DHCP
discovery request on the wireless print server.
Format: ! U1 getvar "wlan.ip.dhcp.request_timeout"
setvar This command instructs the printer to set the maximum time (in seconds) to wait for a
response to a DHCP discovery request on the wireless print server.
Format: ! U1 setvar "wlan.ip.dhcp.request_timeout" "value"
Values: "2" through "30"
Default: "2"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "2".

! U1 setvar "wlan.ip.dhcp.request_timeout" "2"
When the setvar value is set to "2", the getvar result is "2".

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wireless Commands 895
wlan.ip.dhcp.requests_per_session

wlan.ip.dhcp.requests_per_session
Description This command retrieves the maximum amount of DHCP discover requests for
a single DHCP session on the wireless print server. For printer support, see SGD Command
Support on page 1019.

Type getvar;setvar

Commands Details
getvar This command retrieves the currently set maximum amount of DHCP discover requests for
a single DHCP session on the wireless print server.
Format: ! U1 getvar "wlan.ip.dhcp.requests_per_session"
setvar This command instructs the printer to set the maximum amount of DHCP discover requests
for a single DHCP session on the wireless print server.
Format: ! U1 setvar "wlan.ip.dhcp.requests_per_session" "value"
Values: "1" through "10"
Default: "2"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "2".

! U1 setvar "wlan.ip.dhcp.requests_per_session" "2"
When the setvar value is set to "2", the getvar result is "2".

6/8/10 Zebra Programming Guide P1012728-004

896 SGD Wireless Commands
wlan.ip.dhcp.session_interval

wlan.ip.dhcp.session_interval
Description This command retrieves how long it will take for a DHCP session to time out
before a new DHCP session begins on the wireless print server. For printer support, see SGD
Command Support on page 1019.

Type getvar;setvar

Commands Details
getvar This command retrieves the current DHCP session time out.
Format: ! U1 getvar "wlan.ip.dhcp.session_interval"
setvar This command instructs the printer to set the DHCP session time out.
Format: ! U1 setvar "wlan.ip.dhcp.session_interval" "value"
Values: "0" through "60"
Default: "10"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "10".

! U1 setvar "wlan.ip.dhcp.session_interval" "10"
When the setvar value is set to "10", the getvar result is "10".

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wireless Commands 897
wlan.ip.gateway

wlan.ip.gateway
Description This command instructs the printer to change the wireless print server’s
gateway address. For printer support, see SGD Command Support on page 1019.

Note • This setting refers to the gateway address. A set value is ignored if the IP protocol is
not set to permanent.

Type getvar; setvar

Commands Details
getvar This command instructs the printer to respond with the wireless printer server’s gateway
address.
Format: ! U1 getvar "wlan.ip.gateway"
setvar This command instructs the printer to change the wireless printer server’s gateway address.
Format: ! U1 setvar "wlan.ip.gateway" "value"
Values: Any valid gateway address
Default: "0.0.0.0"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "10.3.5.1".

! U1 setvar "wlan.ip.gateway" "10.3.5.1"
When the setvar value is set to "10.3.5.1", the getvar result is "10.3.5.1".

6/8/10 Zebra Programming Guide P1012728-004

898 SGD Wireless Commands
wlan.ip.netmask

wlan.ip.netmask
Description This setting refers to the wireless print server’s subnet mask address. This value
is ignored if the IP protocol is not set to permanent. For printer support, see SGD Command
Support on page 1019.

Type getvar; setvar

Commands Details
getvar This command instructs the printer to respond with wireless print server’s subnet mask.
Format: ! U1 getvar "wlan.ip.netmask"
setvar This command instructs the printer to change the wireless print servers’s subnet mask.
Format: ! U1 setvar "wlan.ip.netmask" "value"
Values: Any valid subnet mask.
Default: "255.255.255.0"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "255.255.255.0".

! U1 setvar "wlan.ip.netmask" "255.255.255.0"
When the setvar value is set to "255.255.255.0", the getvar result is
"255.255.255.0".

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wireless Commands 899
wlan.ip.port

wlan.ip.port
Description This printer setting refers to the wireless print server’s port number that the
TCP print service is listening on. Normal TCP communications from the host should be
directed to this port.For printer support, see SGD Command Support on page 1019.

Type getvar; setvar

Commands Details
getvar This command instructs the printer to respond with the wireless printer server’s TCP/UDP
port number.
Format: ! U1 getvar "wlan.ip.port"
setvar This command instructs the printer to set the wireless print server’s TCP/UDP port number.
Format: ! U1 setvar "wlan.ip.port" "value"
Values: 1 - 65535 (excluding any ports currently used by other services, such as 21, 23, 80,
and 515).
Default: "9100"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "9100".

! U1 setvar "wlan.ip.port" "9100"
When the setvar value is set to "9100", the getvar result is "9100".

6/8/10 Zebra Programming Guide P1012728-004

900 SGD Wireless Commands
wlan.ip.protocol

wlan.ip.protocol
Description This command configures the IP addressing method used by the wireless print
server. For printer support, see SGD Command Support on page 1019.

Type getvar; setvar

Commands Details
getvar This command returns the value of the currently selected IP protocol used by the wireless
print server.
Format: ! U1 getvar "wlan.ip.protocol"
setvar This command instructs the printer to configure the IP addressing method used by the
wireless print server.
Format: ! U1 setvar "wlan.ip.protocol" "value"
Values:
"bootp" = uses the standard bootp addressing method to obtain an IP address and
configuration
"dhcp" = uses the standard dhcp addressing method to obtain an IP address and
configuration for a server specified period of time
"rarp" = uses the standard rarp addressing method to obtain an IP address
"glean only" = uses the IP address from a PING packet that is sent to its hardware
address (unicast address)
“permanent” = uses static values assigned through other commands
"all" = tries all of the dynamic addressing methods, not permanent, to obtain an IP
address
Default: "all"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • In this example, the setvar result is the current programming language that the
printer is using.
! U1 setvar "wlan.ip.protocol" "bootp"
What the setvar value is set to is the getvar result. In this example, the getvar result is
"bootp".

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wireless Commands 901
wlan.ip.timeout.enable

wlan.ip.timeout.enable
Description This network setting refers to enabling the connection timeout on the wireless
print server. For this to take effect, the print server must be reset. For printer support, see SGD
Command Support on page 1019.

Type getvar; setvar

Commands Details
getvar This command instructs the printer to return whether the timeout checking is enabled on the
wireless print server.
Format: ! U1 getvar "wlan.ip.timeout.enable"
setvar This command instructs the printer to enable or disable the timeout checking on the wireless
print server.
Format: ! U1 setvar "wlan.ip.timeout.enable" "value"
Values:
"off" = turns off the connection checking
"on" = turns on the connection checking
Default: "on"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "on".

! U1 setvar "wlan.ip.timeout.enable" "on"
When the setvar value is set to "on", the getvar result is "on".

6/8/10 Zebra Programming Guide P1012728-004

902 SGD Wireless Commands
wlan.ip.timeout.value

wlan.ip.timeout.value
Description This network setting refers to the number of seconds before the connection
times out for the wireless print server. For this to take effect, the print server must be reset. For
printer support, see SGD Command Support on page 1019.

Type getvar; setvar

Commands Details
getvar This command instructs the printer to respond with the time, in seconds, before the
connection times out.
Format: ! U1 getvar "wlan.ip.timeout.value"
setvar This command instructs the printer to set the the time value of the wireless print server, in
seconds, before the connection times out.
Format: ! U1 setvar "wlan.ip.timeout.value" "value"
Values: "1" through "3600"
Default: "300"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "300".

! U1 setvar "wlan.ip.timeout.value" "300"
When the setvar value is set to "300", the getvar result is "300".

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wireless Commands 903
wlan.keep_alive.enable

wlan.keep_alive.enable
Description This setting controls the printers ability to send a LSAP (link service access
point) packet to the access point on an user controllable interval. This feature is included to
accommodate access points that require a regular confirmation that wireless clients are still
active. For printer support, see SGD Command Support on page 1019.

Type getvar; setvar

Commands Details
getvar This command instructs the printer to respond with the wlan.keep_alive.enable
setting.
Format: ! U1 getvar "wlan.keep_alive.enable"
setvar This command instructs the printer to send a LSAP (link service access point) packet to the
access point on an user controllable interval.
Format: ! U1 setvar "wlan.keep_alive.enable" "value"
Values:
"on" = turns on keep_alive
"off" = turns off keep_alive
Default: "on"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "on".

! U1 setvar "wlan.keep_alive.enable" "on"
When the setvar value is set to "on", the getvar result is "on".

6/8/10 Zebra Programming Guide P1012728-004

904 SGD Wireless Commands
wlan.keep_alive.timeout

wlan.keep_alive.timeout
Description This printer setting manages the interval at which the LSAP (link service
access point) packet is sent. For printer support, see SGD Command Support on page 1019.

Type getvar; setvar

Commands Details
getvar This command instructs the printer to respond with the wlan.keep_alive.timeout
interval value.
Format: ! U1 getvar "wlan.keep_alive.timeout"
setvar This command instructs the printer to configure the frequency at which the printer sends the
wlan.keep_alive packet.
Format: ! U1 setvar "wlan.keep_alive.timeout" "value"
Values: 5 to 300 seconds
Default: "15"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "15".

! U1 setvar "wlan.keep_alive.timeout" "15"
When the setvar value is set to "15", the getvar result is "15".

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wireless Commands 905
wlan.kerberos.kdc

wlan.kerberos.kdc
Description This printer setting refers to the Kerberos Key Distribution Center (KDC). The
KDC is a trusted server which maintains a database with account information for all security
principals (users) for a particular site or administrative domain (realm). For printer support,
see SGD Command Support on page 1019.

Type getvar; setvar

Commands Details
getvar This command instructs the printer to respond with the current Kerberos KDC.
Format: ! U1 getvar "wlan.kerberos.kdc"
setvar This command instructs the printer to change the Kerberos KDC.
Format: ! U1 setvar "wlan.kerberos.kdc" "value"
Values: 0-32 ASCII characters
Default: "krbtgt"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "krbtgt".

! U1 setvar "wlan.kerberos.kdc" "krbtgt"
When the setvar value is set to "krbtgt", the getvar result is "krbtgt".

6/8/10 Zebra Programming Guide P1012728-004

906 SGD Wireless Commands
wlan.kerberos.password

wlan.kerberos.password
Description This printer setting refers to the Kerberos password. The password must
correspond to a user profile established on the Kerberos KDC server in use. For printer
support, see SGD Command Support on page 1019.

Type getvar; setvar

Commands Details
getvar This command instructs the printer to respond with the current Kerberos password.
Format: ! U1 getvar "wlan.kerberos.password"
For protection a single "*" prints.
setvar This command instructs the printer to set the Kerberos password.
Format: ! U1 setvar "wlan.kerberos.password" "value"
Values: 0-32 alphanumeric characters
Default: "password"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "password".

! U1 setvar "wlan.kerberos.password" "password"
When the setvar value is set to "password", the getvar result is "*".

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wireless Commands 907
wlan.kerberos.realm

wlan.kerberos.realm
Description This printer setting refers to the Kerberos realm, an administrative domain with
its own Kerberos server (KDC). For printer support, see SGD Command Support
on page 1019.

Important • If you are using a Windows 2000 Server the realm must be all upper-case. For
details, see Example 2 below.

Type getvar; setvar

Commands Details
getvar This command instructs the printer to respond with the current Kerberos realm.
Format: ! U1 getvar "wlan.kerberos.realm"
setvar This command instructs the printer to change the Kerberos realm.
Format: ! U1 setvar "wlan.kerberos.realm" "value"
Values: 0-64 alphanumeric characters
Default: "kerberos"

Note • For details on SGD command structure, see Command Structure on page 785.

Example 1 • This setvar example shows the value set to "zebra".

! U1 setvar "wlan.kerberos.realm" "zebra"
When the setvar value is set to "zebra", the getvar result is "zebra".

Example 2 • This setvar example shows the value set to "ZEBRA" on a Windows 2000
server.
! U1 setvar "wlan.kerberos.realm" "ZEBRA"
When the setvar value is set to "ZEBRA", the getvar result is "ZEBRA".

6/8/10 Zebra Programming Guide P1012728-004

908 SGD Wireless Commands
wlan.kerberos.username

wlan.kerberos.username
Description This printer setting refers to the Kerberos user name. The user name must
correspond to a user profile established on the Kerberos KDC server in use. For printer
support, see SGD Command Support on page 1019.

Type getvar; setvar

Commands Details
getvar This command instructs the printer to respond with the current Kerberos user name.
Format: ! U1 getvar "wlan.kerberos.username"
setvar This command instructs the printer to change the Kerberos user name.
Format: ! U1 setvar "wlan.kerberos.username" "value"
Values: 0-32 alphanumeric characters
Default: "user"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "user".

! U1 setvar "wlan.kerberos.username" "user"
When the setvar value is set to "user", the getvar result is "user".

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wireless Commands 909
wlan.mac_addr

wlan.mac_addr
Description This command retrieves the MAC address of the wireless print server. For
printer support, see SGD Command Support on page 1019.

Type getvar

Commands Details
getvar This command instructs the printer to respond with the MAC address of the wireless print
server.
Format: ! U1 getvar "wlan.mac_addr"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • In this example, the getvar result is the MAC address for the wireless print
server.
! U1 getvar "wlan.mac_addr"

6/8/10 Zebra Programming Guide P1012728-004

910 SGD Wireless Commands
wlan.mac_raw

wlan.mac_raw
Description This command specifies the RAW MAC address of the wireless print server.
The raw mac address is the mac address without the colons (":"). For printer support, see
SGD Command Support on page 1019.

Type getvar

Commands Details
getvar This command retrieves the RAW MAC address of the wireless print server.
Format: ! U1 getvar "wlan.mac_raw"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • In this example, the getvar retrieves the RAW MAC address of the wireless
print server.
! U1 getvar "wlan.mac_raw"

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wireless Commands 911
wlan.operating_mode

wlan.operating_mode
Description This printer setting refers to the network operating mode. Infrastructure mode
means that the printer will try to associate with an access point. Ad hoc mode means that the
printer will try to associate with a device other than an access point and join a standalone
network. For printer support, see SGD Command Support on page 1019.

To use "ad hoc" mode configure the printer as follows:

• Set the ESSID to the new network’s ESSID.
• Turn off the DHCP and assign an IP Address to the printer.
• Set the subnet mask on the printer to the new network’s subnet mask.
• Change the operating mode on the printer to "ad hoc".

Type getvar; setvar

Commands Details
getvar This command instructs the printer to respond with the network-mode value.
Format: ! U1 getvar "wlan.operating_mode"
setvar This command instructs the printer to set the network operating mode.
Format: ! U1 setvar "wlan.operating_mode" "value"
Values:
"adhoc" = printer will try to associate with a network device
"infrastructure" = printer will try to associate with an access point
Default: "infrastructure"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "infrastructure".

! U1 setvar "wlan.operating_mode" "infrastructure"
When the setvar value is set to "infrastructure", the getvar result is
"infrastructure".

6/8/10 Zebra Programming Guide P1012728-004

912 SGD Wireless Commands
wlan.password

wlan.password
Description This printer setting refers to the generic password that is used by the wireless
securities that need a password. For printer support, see SGD Command Support
on page 1019.

Important • Kerberos has its own password field

Type getvar; setvar

Commands Details
getvar This command instructs the printer to respond with a generic password for wireless
securities.
Format: ! U1 getvar "wlan.password"
For protection a single "*" prints.
setvar This command instructs the printer to set a generic password for the wireless securities that
need a password.
Format: ! U1 setvar "wlan.password" "value"
Values: A maximum of 32 alphanumeric characters.
Default: "password"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "password".

! U1 setvar "wlan.password" "password"
When the setvar value is set to "password", the getvar result is "*".

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wireless Commands 913
wlan.preamble

wlan.preamble
Description This printer setting selects the radio preamble length to be used. For printer
support, see SGD Command Support on page 1019.

Type getvar; setvar

Commands Details
getvar This command instructs the printer to respond with the current preamble length.
Format: ! U1 getvar "wlan.preamble"
setvar This command instructs the printer to set the preamble length.
Format: ! U1 setvar "wlan.preamble" "value"
Values:
"long" = enables long preamble
"short" = enables short preamble
Default: "long"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "long".

! U1 setvar "wlan.preamble" "long"
When the setvar value is set to "long", the getvar result is "long".

6/8/10 Zebra Programming Guide P1012728-004

914 SGD Wireless Commands
wlan.private_key_password

wlan.private_key_password
Description This printer setting allows the setting of the optional private key password. For
printer support, see SGD Command Support on page 1019.

Type getvar; setvar

Commands Details
getvar This command instructs the printer to respond with the value of the private key password.
Format: ! U1 getvar "wlan.private_key_password"
For protection a single "*" prints.
setvar This command instructs the printer to set the private key password.
Format: ! U1 setvar "wlan.private_key_password" "value"
Values: A maximum of 32 alphanumeric characters
Default: ""

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "password".

! U1 setvar "wlan.private_key_password" "password"
When the setvar value is set to "password", the getvar result is "*".

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wireless Commands 915
wlan.roam.interchannel_delay

wlan.roam.interchannel_delay
Description This command sets how long of a delay before scanning the next channel when
roaming. For printer support, see SGD Command Support on page 1019.

Type getvar;setvar

Commands Details
getvar This command retrieves the current set delay time before scanning the next channel when
roaming.
Format: ! U1 getvar "wlan.roam.interchannel_delay"
setvar This command sets how long of a delay before scanning the next channel when roaming.
The values are in milliseconds.
Format: ! U1 setvar "wlan.roam.interchannel_delay" "value"
Values: 10 to 30000
Default: "400"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "400".

! U1 setvar "wlan.roam.interchannel_delay" "400"
The getvar result returns the current setvar value. In this example, the getvar result is
"400".

6/8/10 Zebra Programming Guide P1012728-004

916 SGD Wireless Commands
wlan.roam.interval

wlan.roam.interval
Description This printer setting refers to specifying the wireless roam interval. For printer
support, see SGD Command Support on page 1019.

Type getvar; setvar

Commands Details
getvar This command instructs the printer to respond with the specified roam interval.
Format: ! U1 getvar "wlan.roam.interval"
setvar This command instructs the printer to set the wireless roam interval.
Format: ! U1 setvar "wlan.roam.interval" "value"
Values: Decimal values between 5 and 255 inclusive
Default: "20"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "20".

! U1 setvar "wlan.roam.interval" "20"
When the setvar value is set to "20", the getvar result is "20".

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wireless Commands 917
wlan.roam.max_chan_scan_time

wlan.roam.max_chan_scan_time
Description This command sets how long the radio waits on a channel looking for probe
responses. For printer support, see SGD Command Support on page 1019.

Type getvar;setvar

Commands Details
getvar This command retrieves the current setting for how long the radio waits on a channel
looking for probe responses.
Format: ! U1 getvar "wlan.roam.max_chan_scan_time"
setvar This command sets how long the radio waits on a channel looking for probe responses. The
values are in milliseconds.
Format: ! U1 setvar "wlan.roam.max_chan_scan_time" "value"
Values: 10 to 500
Default: "100"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "100".

! U1 setvar "wlan.roam.max_chan_scan_time" "100"
The getvar result returns the current setvar value. In this example, the getvar result is
"100".

6/8/10 Zebra Programming Guide P1012728-004

918 SGD Wireless Commands
wlan.roam.signal

wlan.roam.signal
Description This printer setting refers to specifying the wireless roam signal. For printer
support, see SGD Command Support on page 1019.

Type getvar; setvar

Commands Details
getvar This command instructs the printer to respond with the specified wireless roam signal.
Format: ! U1 getvar "wlan.roam.signal"
setvar This command instructs the printer to set the wireless roam signal.
Format: ! U1 setvar "wlan.roam.signal" "value"
Values: Decimal values between 1 and 75 inclusive.
Default: "50"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "50".

! U1 setvar "wlan.roam.signal" "50"
When the setvar value is set to "50", the getvar result is "50".

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wireless Commands 919
wlan.security

wlan.security
Description This printer setting allows you to specify both the wireless encryption type and
authentication type in one command. For printer support, see SGD Command Support
on page 1019.

Note • The supporting parameters that are required vary based on the security type that you
select. See Supporting SGD Commands for Different Security Types on page 920 for
instructions for each security type.

When using certificate files, Zebra printers support:

• using Privacy Enhanced Mail (PEM) formatted certificate files.
• using the client certificate and private key as two files, each downloaded separately.
• using exportable PAC files for EAP-FAST.

These certificate files can only be sent using ZPL, not SGD. The ZPL command to use when
sending these certificate files is the ~DY command.

Configuring the printer for WPA also allows the printer to be used in WPA2 environments.

Type getvar; setvar

Commands Details
getvar This command instructs the printer to return the name and not the type. If an invalid security
mode is entered the printer returns Invalid Mode.
Format: ! U1 getvar "wlan.security" "value"
setvar This command instructs the printer to set the wireless security value.
Format: ! U1 setvar "wlan.security" "value"
Values:
"1" = No wireless security or "none"
"2" = WEP 40-bit or "wep 40-bit"
"3" = WEP 128-bit or "wep 128-bit"
"4" = EAP-TLS or "eap-tls"
"5" = EAP-TTLS or "eap-ttls"
"6" = EAP-FAST or "eap-fast"
"7" = PEAP or "peap"
"8" = LEAP or "leap"
"9" = WPA PSK or "wpa psk" (Key rotation for WPA2 PSK is supported in
firmware versions V53.15.8Z , V60.15.8Z, and later.)
"10" = WPA EAP-TLS or "wpa eap-tls"
"11" = WPA EAP-TTLS or "wpa eap-ttls"
"12" = WPA EAP-FAST or "wpa eap-fast"
"13" = WPA PEAP or "wpa peap"
"14" = WPA LEAP or "wpa leap"
"15" = Kerberos or "kerberos"
Default: "1"

6/8/10 Zebra Programming Guide P1012728-004

920 SGD Wireless Commands
wlan.security

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "1".

! U1 setvar "wlan.security" "1"
When the setvar value is set to "1", the getvar result is "none".

Supporting SGD Commands for Different Security Types

The supporting SGD commands required for wlan.security vary based on the security
type that you select. You must send the additional commands for your printer to be able to
work on your wireless network. Follow the example and format for your specific security type
in this section, substituting your own wireless network data.

Security Type 1: No Wireless Security Active

Additional parameters that need to be set: none

Example • This example turns off all wireless securities controlled under this command, but
it does not reset the printer’s wireless settings to their defaults.
! U1 setvar "wlan.security" "1"

Security Type 2: WEP 40-Bit

Additional parameters that need to be set and the SGD commands to use:
• WEP encryption index (see wlan.wep.index on page 935)
• WEP authentication type (see wlan.wep.auth_type on page 934)
• WEP key type (see wlan.wep.key_format on page 941)
• the actual values of any WEP encryption keys to be used (see wlan.wep.key1 on page 936,
wlan.wep.key2 on page 937, wlan.wep.key3 on page 938, or wlan.wep.key4 on page 939)

Example • This example configures the printer for WEP 40-bit encryption using index
key 1, open authentication, and a hexadecimal WEP key with a value of “A1B2C3D4F5.”
! U1 setvar "wlan.security" "2"
! U1 setvar "wlan.wep.index" "1"
! U1 setvar "wlan.wep.auth_type" "open"
! U1 setvar "wlan.wep.key_format" "hex"
! U1 setvar "wlan.wep.key1" "A1B2C3D4F5"

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wireless Commands 921
wlan.security

Security Type 3: WEP 128-Bit

Additional parameters that need to be set and the SGD commands to use:
• WEP encryption index (see wlan.wep.index on page 935)
• WEP authentication type (see wlan.wep.auth_type on page 934)
• WEP key type (see wlan.wep.key_format on page 941)
• the actual values of any WEP encryption keys to be used (see wlan.wep.key1 on page 936,
wlan.wep.key2 on page 937, wlan.wep.key3 on page 938, or wlan.wep.key4 on page 939)

Example • This example configures the printer for WEP 128-bit encryption using index
key 2, open authentication, and four hexadecimal WEP keys.
! U1 setvar "wlan.security" "3"
! U1 setvar "wlan.wep.index" "2"
! U1 setvar "wlan.wep.auth_type" "open"
! U1 setvar "wlan.wep.key_format" "hex"
! U1 setvar "wlan.wep.key1" "001122334455667788"
! U1 setvar "wlan.wep.key2" "112233445566778899"
! U1 setvar "wlan.wep.key3" "223344556677889900"
! U1 setvar "wlan.wep.key4" "334455667788990011"

Security Type 4: EAP-TLS

Additional parameters that need to be set and the SGD commands to use:
• optional private key password (see wlan.private_key_password on page 914)

Example • This example configures the printer for EAP-TLS authentication with an optional
private key password with a value of “private.”
! U1 setvar "wlan.security" "4"
! U1 setvar "wlan.private_key_password" "private"

6/8/10 Zebra Programming Guide P1012728-004

922 SGD Wireless Commands
wlan.security

Security Type 5: EAP-TTLS

Additional parameters that need to be set and the SGD commands to use:
• user ID (see wlan.username on page 933)
• password (see wlan.password on page 912)

Example • This example configures the printer for EAP-TTLS authentication, including a
user ID with a value of “user” and a password with a value of “password.”
! U1 setvar "wlan.security" "5"
! U1 setvar "wlan.username" "user"
! U1 setvar "wlan.password" "password"

Security Type 6: EAP-FAST

Additional parameters that need to be set and the SGD commands to use:
• user ID (see wlan.username on page 933)
• password (see wlan.password on page 912)
• optional private key password (see wlan.private_key_password on page 914)

Example • This example configures the printer for EAP-FAST authentication, including a
user ID of “user,” a password of “password,” and an optional private key of
“private.”
! U1 setvar "wlan.security" "6"
! U1 setvar "wlan.username" "user"
! U1 setvar "wlan.password" "password"
! U1 setvar "wlan.private_key_password" "private"

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wireless Commands 923
wlan.security

Security Type 7: PEAP

Additional parameters that need to be set and the SGD commands to use:
• user ID (see wlan.username on page 933)
• password (see wlan.password on page 912)

Example • This example configures the printer for PEAP authentication, including a user ID
with a value of “user” and a password with a value of “password.”
! U1 setvar "wlan.security" "7"
! U1 setvar "wlan.username" "user"
! U1 setvar "wlan.password" "password"

Security Type 8: LEAP

Additional parameters that need to be set and the SGD commands to use:
• user ID (see wlan.username on page 933)
• password (see wlan.password on page 912)

Example • This example configures the printer for LEAP authentication, including a user ID
with a value of “user” and a password with a value of “password.”
! U1 setvar "wlan.security" "8"
! U1 setvar "wlan.username" "user"
! U1 setvar "wlan.password" "password"

Security Type 9: WPA PSK

Note • Configuring the printer for WPA also allows the printer to be used in WPA2
environments. Key rotation for WPA2 PSK is supported in firmware version 60.15.8Z and
later and in firmware version 53.15.8Z and later.

Additional parameters that need to be set and the SGD commands to use:
• Pre-Shared Key (PSK) value (see wlan.wpa.psk on page 940)

Example • This example configures the printer for WPA PSK authentication with a PSK
value of all zeroes (64 hexadecimal digits).
! U1 setvar "wlan.security" "9"
! U1 setvar "wlan.wpa.psk" "00000000..."

6/8/10 Zebra Programming Guide P1012728-004

924 SGD Wireless Commands
wlan.security

Security Type 10: WPA EAP-TLS

Note • Configuring the printer for WPA also allows the printer to be used in WPA2
environments.

Additional parameters that need to be set and the SGD commands to use:
• optional private key password (see wlan.private_key_password on page 914)

Example • This example configures the printer for WPA EAP-TLS authentication with an
optional private key password with a value of “private.”
! U1 setvar "wlan.security" "10"
! U1 setvar "wlan.private_key_password" "private"

Security Type 11: WPA EAP-TTLS

Note • Configuring the printer for WPA also allows the printer to be used in WPA2
environments.

Additional parameters that need to be set and the SGD commands to use:
• user ID (see wlan.username on page 933)
• password (see wlan.password on page 912)

Example • This example configures the printer for WPA EAP-TTLS authentication,
including a user ID with a value of “user” and a password with a value of “password.”
! U1 setvar "wlan.security" "11"
! U1 setvar "wlan.username" "user"
! U1 setvar "wlan.password" "password"

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wireless Commands 925
wlan.security

Security Type 12: WPA EAP-FAST

Note • Configuring the printer for WPA also allows the printer to be used in WPA2
environments.

Additional parameters that need to be set and the SGD commands to use:
• user ID (see wlan.username on page 933)
• password (see wlan.password on page 912)
• optional private key password (see wlan.private_key_password on page 914)

Example • This example configures the printer for WPA EAP-FAST authentication,
including a user ID of “user,” a password of “password,” and an optional private key of
“private.”
! U1 setvar "wlan.security" "12"
! U1 setvar "wlan.username" "user"
! U1 setvar "wlan.password" "password"
! U1 setvar "wlan.private_key_password" "private"

Security Type 13: WPA PEAP

Note • Configuring the printer for WPA also allows the printer to be used in WPA2
environments.

Additional parameters that need to be set and the SGD commands to use:
• user ID (see wlan.username on page 933)
• password (see wlan.password on page 912)

Example • This example configures the printer for WPA PEAP authentication, including a
user ID with a value of “user” and a password with a value of “password.”
! U1 setvar "wlan.security" "13"
! U1 setvar "wlan.username" "user"
! U1 setvar "wlan.password" "password"

6/8/10 Zebra Programming Guide P1012728-004

926 SGD Wireless Commands
wlan.security

Security Type 14: WPA LEAP

Note • Configuring the printer for WPA also allows the printer to be used in WPA2
environments.

Additional parameters that need to be set and the SGD commands to use:
• user ID (see wlan.username on page 933)
• password (see wlan.password on page 912)

Example • This example configures the printer for WPA LEAP authentication, including a
user ID with a value of “user” and a password with a value of “password.”
! U1 setvar "wlan.security" "14"
! U1 setvar "wlan.username" "user"
! U1 setvar "wlan.password" "password"

Security Type 15: Kerberos

Additional parameters that need to be set and the SGD commands to use:
• Kerberos user ID (see wlan.kerberos.username on page 908)
• Kerberos password (see wlan.kerberos.password on page 906)
• realm (see wlan.kerberos.realm on page 907)
• Key Distribution Center (KDC) (see wlan.kerberos.kdc on page 905)

Example • This example configures the printer for Kerberos encryption, including a
Kerberos user ID with a value of “user,” a Kerberos password with a value of
“password,” a realm of “zebra,” and a KDC of “krbtgt.”
! U1 setvar "wlan.security" "15"
! U1 setvar "wlan.kerberos.username" "user"
! U1 setvar "wlan.kerberos.password" "password"
! U1 setvar "wlan.kerberos.realm" "zebra"
! U1 setvar "wlan.kerberos.kdc" "krbtgt"

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wireless Commands 927
wlan.signal_noise

wlan.signal_noise
Description This command returns the signal noise on the wireless network. Values above
40% represent a very significant noise, and radio communication is not reliable. For printer
support, see SGD Command Support on page 1019.

Type getvar

Commands Details
getvar This command instructs the printer to return the current signal noise on the wireless
network.
Format: ! U1 getvar "wlan.signal_noise"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • In this example, the getvar result is the current signal_noise value.
! U1 getvar "wlan.signal_noise"

6/8/10 Zebra Programming Guide P1012728-004

928 SGD Wireless Commands
wlan.signal_quality

wlan.signal_quality
Description This command instructs the printer to return the current signal quality of the
wireless network. Values below 40% represent a very poor signal quality, and radio
communication is not reliable. For printer support, see SGD Command Support on page 1019.

Type getvar

Commands Details
getvar This command instructs the printer to return the current signal quality of the wireless
network.
Format: ! U1 getvar "wlan.signal_quality"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • In this example, the getvar result is the current signal_quality value.
! U1 getvar "wlan.signal_quality"

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wireless Commands 929
wlan.signal_strength

wlan.signal_strength
Description This command returns the signal strength of the connection to the access point
as a percentage value between zero (not connected) and 100 (strongest signal). Values below
40% represent a very poor signal and radio communication is not reliable. For printer support,
see SGD Command Support on page 1019.

Type getvar

Commands Details
getvar This command instructs the printer to respond with the current signal strength.
Format: ! U1 getvar "wlan.signal_strength"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • In this example, the getvar result is "93".

! U1 getvar "wlan.signal_strength"

6/8/10 Zebra Programming Guide P1012728-004

930 SGD Wireless Commands
wlan.station_name

wlan.station_name
Description This printer setting refers to the station name. For printer support, see SGD
Command Support on page 1019.

Type setvar;getvar

Commands Details
getvar This command instructs the printer to respond with the station name value.
Format: ! U1 getvar "wlan.station_name"
setvar This command instructs the printer to set the station name.
Format: ! U1 setvar "wlan.station_name" "value"
Values: A maximum of 32 alphanumeric characters
Default: "ZEBRA"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "ZEBRA".

! U1 setvar "wlan.station_name" "ZEBRA"
When the setvar value is set to "ZEBRA", the getvar result is "ZEBRA".

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wireless Commands 931
wlan.tx_power

wlan.tx_power
Description This printer setting refers to specifying the wireless transmit power. For printer
support, see SGD Command Support on page 1019.

Type getvar; setvar

Commands Details
getvar This command instructs the printer to respond with the wireless transmit power.
Format: ! U1 getvar "wlan.tx_power"
setvar This command instructs the printer to set the wireless transmit power.
Format: ! U1 setvar "wlan.tx_power" "value"
Values: Decimal values of 1, 5, 20, 30, 50, 100
Default: "100"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "100".

! U1 setvar "wlan.tx_power" "100"
When the setvar value is set to "100", the getvar result is "100".

6/8/10 Zebra Programming Guide P1012728-004

932 SGD Wireless Commands
wlan.tx_rate

wlan.tx_rate
Description This printer setting refers to specifying the wireless transmit rate. For printer
support, see SGD Command Support on page 1019.

Type getvar; setvar

Commands Details
getvar This command instructs the printer to respond with the wireless transmit rate.
Format: ! U1 getvar "wlan.tx_rate"
setvar This command instructs the printer to set the wireless transmit rate.
Format: ! U1 setvar "wlan.tx_rate" "value"
Values: 1, 2, 5.5, 11, all
Default: "all"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "all".

! U1 setvar "wlan.tx_rate" "all"
When the setvar value is set to "all", the getvar result is "all".

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wireless Commands 933
wlan.username

wlan.username
Description This printer setting refers to the generic user name that is used by the wireless
securities that need a user name. For printer support, see SGD Command Support
on page 1019.

Important • Kerberos has its own user name field.

Type getvar; setvar

Commands Details
getvar This command instructs the printer to respond with a generic user name for the wireless
securities that need a user name.
Format: ! U1 getvar "wlan.username"
setvar This command instructs the printer to set a generic user name for wireless securities that
need a user name.
Format: ! U1 setvar "wlan.username" "value"
Values: A maximum of 32 alphanumeric characters
Default: "user"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "user".

! U1 setvar "wlan.username" "user"
When the setvar value is set to "user", the getvar result is "user".

6/8/10 Zebra Programming Guide P1012728-004

934 SGD Wireless Commands
wlan.wep.auth_type

wlan.wep.auth_type
Description For the WEP security type, this printer setting selects the authentication type to
be used between the printer and the access point. The authentication types are open system and
shared key. For printer support, see SGD Command Support on page 1019.

Type getvar; setvar

Commands Details
getvar This command instructs the printer to retrieve the current WEP authentication type.
Format: ! U1 getvar "wlan.wep.auth_type"
setvar This command instructs the printer to set the WEP authentication type.
Format: ! U1 setvar "wlan.wep.auth_type" "value"
Values:
"open" = enables the open authentication type
"shared" = enables the shared authentication type
Default: "open"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "open".

! U1 setvar "wlan.wep.auth_type" "open"
When the setvar value is set to "open", the getvar result is "open".

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wireless Commands 935
wlan.wep.index

wlan.wep.index
Description This printer setting refers to the WEP (Wired Equivalent Privacy) encryption
key index. This printer setting determines which one of the four encryption keys is to be used
by the client (printer). For printer support, see SGD Command Support on page 1019.

Type getvar; setvar

Commands Details
getvar This command instructs the printer to respond with the encryption key index.
Format: ! U1 getvar "wlan.wep.index"
setvar This command instructs the printer to set the encryption key index.
Format: ! U1 setvar "wlan.wep.index" "value"
Values:
"1" = enables encryption key 1
"2" = enables encryption key 2
"3" = enables encryption key 3
"4" = enables encryption key 4
Default: "1"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "1".

! U1 setvar "wlan.wep.index" "1"
When the setvar value is set to "1", the getvar result is "1".

6/8/10 Zebra Programming Guide P1012728-004

936 SGD Wireless Commands
wlan.wep.key1

wlan.wep.key1
Description This printer setting refers to the first indexed WEP encryption key. The WEP
encryption key is a hexadecimal or string value. This key should match the wireless network
WEP encryption key 1. For printer support, see SGD Command Support on page 1019.

Type getvar; setvar

Commands Details
getvar This command instructs the printer to respond with the encryption key.
Format: ! U1 getvar "wlan.wep.key1"
For protection a single "*" prints.
setvar This command instructs the printer to set the encryption key.
Format: ! U1 setvar "wlan.wep.key1" "value"
Values:
10 hexadecimal characters for 40-bit encryption
26 hexadecimal characters for 128-bit encryption
Default: All zeros

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "A1B2C3D4F5".

! U1 setvar "wlan.wep.key1" "A1B2C3D4F5"
When the setvar value is set to "A1B2C3D4F5", the getvar result is "*".

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wireless Commands 937
wlan.wep.key2

wlan.wep.key2
Description This printer setting refers to the second indexed WEP encryption key. The
WEP encryption key is a hexadecimal string value. This key should match the wireless
network WEP encryption key 2. For printer support, see SGD Command Support
on page 1019.

Type getvar; setvar

Commands Details
getvar This command instructs the printer respond with the encryption key.
Format: ! U1 getvar "wlan.wep.key2"
For protection a single "*" prints.
setvar This command instructs the printer to set the encryption key.
Format: ! U1 setvar "wlan.wep.key2" "value"
Values:
10 hexadecimal characters for 40-bit encryption
26 hexadecimal characters for 128-bit encryption
Default: All zeros

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "A1B2C3D4F5".

! U1 setvar "wlan.wep.key2" "A1B2C3D4F5"
When the setvar value is set to "A1B2C3D4F5", the getvar result is "*".

6/8/10 Zebra Programming Guide P1012728-004

938 SGD Wireless Commands
wlan.wep.key3

wlan.wep.key3
Description This printer setting refers to the third indexed WEP encryption key. The WEP
encryption key is a hexadecimal string value. This key should match the wireless network
WEP encryption key 3. For printer support, see SGD Command Support on page 1019.

Type getvar; setvar

Commands Details
getvar This command instructs the printer to respond with the encryption key.
Format: ! U1 getvar "wlan.wep.key3"
For protection a single "*" prints.
setvar This command instructs the printer to set the encryption key.
Format: ! U1 setvar "wlan.wep.key3" "value"
Values:
10 hexadecimal characters for 40-bit encryption
26 hexadecimal characters for 128-bit encryption
Default: All zeros

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "A1B2C3D4F5".

! U1 setvar "wlan.wep.key3" "A1B2C3D4F5"
When the setvar value is set to "A1B2C3D4F5", the getvar result is "*".

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wireless Commands 939
wlan.wep.key4

wlan.wep.key4
Description This printer setting refers to the fourth indexed WEP encryption key. The WEP
encryption key is a hexadecimal string value. This key should match the wireless network
WEP encryption key 4. For printer support, see SGD Command Support on page 1019.

Type getvar; setvar

Commands Details
getvar This command instructs the printer respond with the encryption key.
Format: ! U1 getvar "wlan.wep.key4"
For protection a single "*" prints.
setvar This command instructs the printer to set the encryption key.
Format: ! U1 setvar "wlan.wep.key4" "value"
Values:
10 hexadecimal characters for 40-bit encryption
26 hexadecimal characters for 128-bit encryption
Default: All zeros

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "A1B2C3D4F5".

! U1 setvar "wlan.wep.key4" "A1B2C3D4F5"
When the setvar value is set to "A1B2C3D4F5", the getvar result is "*".

6/8/10 Zebra Programming Guide P1012728-004

940 SGD Wireless Commands
wlan.wpa.psk

wlan.wpa.psk
Description This printer setting specifies the pre-shared key (PSK) value to use when the
WPA authentication is set to PSK. For printer support, see SGD Command Support
on page 1019.

Type getvar; setvar

Commands Details
getvar This command instructs the printer to respond with the pre-shared key.
Format: ! U1 getvar "wlan.wpa.psk"
For protection a single "*" prints.
setvar This command instructs the printer to set the pre-shared key.
Format: ! U1 setvar "wlan.wpa.psk" "value"
Values: 64 hexadecimal digits
Default: 64 zeros (00000000...)

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "00000000...".

! U1 setvar "wlan.wpa.psk" "00000000..."
When the setvar value is set to "00000000...", the getvar result is "*".

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Wireless Commands 941
wlan.wep.key_format

wlan.wep.key_format
Description This printer setting specifies the format for the WEP key. For printer support,
see SGD Command Support on page 1019.

Important • This printer setting should proceed any of the wep.key settings if you select a
non-default value.

Type getvar; setvar

Commands Details
getvar This command instructs the printer to respond with the WEP key format.
Format: ! U1 getvar "wep.key_format"
setvar This command instructs the printer to set the WEP key format.
Format: ! U1 setvar "wlan.wep.key_format" "value"
Values:
"ascii" = WEP key is set by ASCII string
"hex" = WEP key is a Hex string
Default: "hex"

Note • For details on SGD command structure, see Command Structure on page 785.

Example • This setvar example shows the value set to "ascii".

! U1 setvar "wlan.wep.key_format" "ascii"
When the setvar value is set to "ascii", the getvar result is "ascii".

6/8/10 Zebra Programming Guide P1012728-004

942 SGD Wireless Commands
wlan.wep.key_format

Notes • ___________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

P1012728-004 Zebra Programming Guide 6/8/10

 A
Zebra Code Pages

This section provides you with a visual of the different Zebra Code pages.

6/8/10 Zebra Programming Guide P1012728-004

944 Zebra Code Pages
Zebra Code Page 850 — Latin Character Set

Zebra Code Page 850 — Latin Character Set

This is the Zebra Code Page 850:

Note • For hex 5C, a cent sign prints for all printer resident fonts. A backslash prints for
downloaded fonts.

P1012728-004 Zebra Programming Guide 6/8/10

 Zebra Code Pages 945
Zebra Code Page 850 — Latin Character Set

6/8/10 Zebra Programming Guide P1012728-004

946 Zebra Code Pages
Zebra Code Page 1250 (Scalable/Downloaded TTF) —Central and Eastern European Latin Character Set

Zebra Code Page 1250 (Scalable/Downloaded TTF) —

Central and Eastern European Latin Character Set
This is the Zebra Code Page 1250 that supports scalable/downloaded TTF fonts:

Note • Font 0 (zero) was used to display this chart.

P1012728-004 Zebra Programming Guide 6/8/10

 Zebra Code Pages 947
Zebra Code Page 1250 (Scalable/Downloaded TTF) —Central and Eastern European Latin Character Set

6/8/10 Zebra Programming Guide P1012728-004

948 Zebra Code Pages
Zebra Code Page 1252— Latin Character Set

Zebra Code Page 1252— Latin Character Set

This is the Zebra Code Page 1252:

P1012728-004 Zebra Programming Guide 6/8/10

 Zebra Code Pages 949
Zebra Code Page 1252— Latin Character Set

6/8/10 Zebra Programming Guide P1012728-004

950 Zebra Code Pages
Zebra Code Page 1253 — Modern Greek Character Set

Zebra Code Page 1253 — Modern Greek Character Set

This is the Zebra Code Page 1253:
CHR HEX DEC CHR HEX DEC CHR HEX DEC CHR HEX DEC CHR HEX DEC CHR HEX DEC CHR HEX DEC CHR HEX DEC

P1012728-004 Zebra Programming Guide 6/8/10

 Zebra Code Pages 951
Zebra Code Page 1253 — Modern Greek Character Set

CHR HEX DEC CHR HEX DEC CHR HEX DEC CHR HEX DEC CHR HEX DEC CHR HEX DEC CHR HEX DEC CHR HEX DEC

6/8/10 Zebra Programming Guide P1012728-004

952 Zebra Code Pages
Zebra Code Page 1254 — Turkish Character Set

Zebra Code Page 1254 — Turkish Character Set

This is the Zebra Code Page 1254:
CHR HEX DEC CHR HEX DEC CHR HEX DEC CHR HEX DEC CHR HEX DEC CHR HEX DEC CHR HEX DEC CHR HEX DEC

P1012728-004 Zebra Programming Guide 6/8/10

 Zebra Code Pages 953
Zebra Code Page 1254 — Turkish Character Set

CHR HEX DEC CHR HEX DEC CHR HEX DEC CHR HEX DEC CHR HEX DEC CHR HEX DEC CHR HEX DEC CHR HEX DEC

6/8/10 Zebra Programming Guide P1012728-004

954 Zebra Code Pages
Zebra Code Page 1255 — Hebrew Character Set

Zebra Code Page 1255 — Hebrew Character Set

This is the Zebra Code Page 1255:
CHR HEX DEC CHR HEX DEC CHR HEX DEC CHR HEX DEC CHR HEX DEC CHR HEX DEC CHR HEX DEC CHR HEX DEC

P1012728-004 Zebra Programming Guide 6/8/10

 Zebra Code Pages 955
Zebra Code Page 1255 — Hebrew Character Set

CHR HEX DEC CHR HEX DEC CHR HEX DEC CHR HEX DEC CHR HEX DEC CHR HEX DEC CHR HEX DEC CHR HEX DEC

6/8/10 Zebra Programming Guide P1012728-004

956 Zebra Code Pages
Zebra Code Page 1255 — Hebrew Character Set

Notes • ___________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

P1012728-004 Zebra Programming Guide 6/8/10

 B
ASCII

This section shows the American Standard Code for Information Interchange (ASCII) code
used by Zebra printers.

6/8/10 Zebra Programming Guide P1012728-004

958 ASCII
ASCII Code Chart

ASCII Code Chart

Shaded areas in Table 29 indicate characters not recommended for command prefix, format
prefix, or delimiter characters.

Table 29 • Zebra Used ASCII Code

HEX Character HEX Character HEX Character HEX Character

00 NUL 20 Space 40 @ 60 ‘
01 SOH 21 ! 41 A 61 a
02 STX 22 “ 42 B 62 b
03 ETX 23 # 43 C 63 c
04 EOT 24 $ 44 D 64 d
05 ENQ 25 % 45 E 65 e
06 ACK 26 & 46 F 66 f
07 BEL 27 ‘ 47 G 67 g
08 BS 28 ( 48 H 68 h
09 HT 29 ) 49 I 69 i
0A LF 2A * 4A J 6A j
0B VT 2B + 4B K 6B k
0C FF 2C , 4C L 6C l
0D CR 2D - 4D M 6D m
0E SO 2E . 4E N 6E n
0F SI 2F / 4F O 6F o
10 DLE 30 0 50 P 70 p
11 DC1 31 1 51 Q 71 q
12 DC2 32 2 52 R 72 r
13 DC3 33 3 53 S 73 s
14 DC4 34 4 54 T 74 t
15 NAK 35 5 55 U 75 u
16 SYN 36 6 56 V 76 v
17 ETB 37 7 57 W 77 w
18 CAN 38 8 58 X 78 x
19 EM 39 9 59 Y 79 y
1A SUB 3A : 5A Z 7A z
1B ESC 3B ; 5B [ 7B {
1C FS 3C < 5C \ 7C |
1D GS 3D = 5D ] 7D }
1E RS 3E > 5E ^ 7E ~
1F US 3F ? 5F _ 7F DEL

P1012728-004 Zebra Programming Guide 6/8/10

 C
Fonts and Bar Codes

This section provides information about different fonts (type faces) and bar codes that can be
used with the printer.

Contents
Standard Printer Fonts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 960
Proportional and Fixed Spacing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 962
Scalable Versus Bitmapped Fonts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 964
Font Matrices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 966
Bar Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 968

6/8/10 Zebra Programming Guide P1012728-004

960 Fonts and Bar Codes
Standard Printer Fonts

Standard Printer Fonts

Most Zebra printers come standard with 15 bitmapped fonts and one scalable font, see
Figure 6. Additional downloadable bitmapped and scalable fonts are also available. Character
size and density (how dark it appears) depend on the density of the printhead and the media
used.

Figure 6 • Examples of the Standard Printer Fonts

zero

Accessed with the ^GS command.

To use one of these fonts, you must either use the change alphanumeric default font command
(^CF) or specify an alphanumeric field command (^A).

The standard Zebra character set is Code 850 for character values greater than 20 HEX. There
are six HEX character values below 20 HEX that are also recognized. Figure 7 shows how
these character values are printed.

Note • Unidentified characters should default to a space.

P1012728-004 Zebra Programming Guide 6/8/10

 Fonts and Bar Codes 961
Standard Printer Fonts

Figure 7 • Recognized HEX Values below 20 HEX

6/8/10 Zebra Programming Guide P1012728-004

962 Fonts and Bar Codes
Proportional and Fixed Spacing

Proportional and Fixed Spacing

Proportional spacing is different than fixed spacing. In Table 30, the intercharacter gap (ICG),
the space between characters, is constant for fonts A through H, which means that the spacing
between all characters is the same. For example, the spacing between the letters MW is the same
as between the letters IE.

Figure 8 is an example of fixed space fonts:

Figure 8 • Fixed Space Fonts Proportion

The baseline is the imaginary line on which the bottom (base) of all characters (except any
descenders) rest. The area between the baseline and the bottom of the matrix is used for any
character “descenders.” Baseline numbers define where the baseline is located in relationship
to the top of the matrix. For example, the baseline for font “E” is 23 dots down from the top of
the matrix.
Table 30 • Intercharacter Gap and Baseline Parameters

Intercharacter Gap Baseline

Font H x W (in dots) Type
(in dots) (in dots)
A 9x5 U-L-D 1 7
B 11 x 7 U 2 11
C,D 18 x 10 U-L-D 2 14
E 28 x 15 OCR-B 5 23
F 26 x 13 U-L-D 3 21
G 60 x 40 U-L-D 8 48
H 21 x 13 OCR-A 6 21

P1012728-004 Zebra Programming Guide 6/8/10

 Fonts and Bar Codes 963
Proportional and Fixed Spacing

Table 30 • Intercharacter Gap and Baseline Parameters

Intercharacter Gap Baseline

Font H x W (in dots) Type
(in dots) (in dots)
GS 24 x 24 SYMBOL PROPORTIONAL 3 x HEIGHT/4
0 DEFAULT: 15 x 12 PROPORTIONAL 3 x HEIGHT/4

6/8/10 Zebra Programming Guide P1012728-004

964 Fonts and Bar Codes
Scalable Versus Bitmapped Fonts

Scalable Versus Bitmapped Fonts

For scalable fonts, setting the height and width equally produces characters that appear the
most balanced. Balanced characters are pleasing to the eye because actual height and width are
approximately equal to each other. This is achieved through the use of a smooth-scaling
algorithm in the printer.

For bitmapped fonts, this balancing is built into the font. In actuality, the height of a bitmap
font is slightly larger than the width. Bitmap fonts are always at the maximum size of the
character’s cell.

Scalable Fonts
All dot parameters used in the commands to create scalable fonts are translated into a point
size because scalable fonts are measured in point sizes, not dots. To determine how many dots
to enter to obtain a particular point size, use the following formula. The actual point size will
be an approximate value.

Dots = (Point size) x (Dots per inch of Printer)

72

• For printers using a 6 dot/mm printhead the “dots per inch of printer” value is 152.4
• For printers using a 8 dot/mm printhead the “dots per inch of printer” value is 203.2
• For printers using a 12 dot/mm printhead the “dots per inch of printer” value is 304.8
• For printers using a 24 dot/mm printhead the “dots per inch of printer” value is 609.6

The actual height and width of the character in dots will vary, depending on the font style and
the particular character. Therefore, some characters will be smaller and some will be larger
than the actual dot size requested. The baselines for all scalable fonts are calculated against the
dot size of the cell. The baseline is 3/4 down from the top of the cell. For example, if the size
of the cell is 80 dots, the baseline will be 60 dots (3/4) down from the top of the cell.

For more information concerning fonts and related commands, see ~DB on page 160 and ~DS
on page 169.

Bitmapped Fonts
Internal bitmapped fonts can be magnified from 1 to 10 times their normal (default) size. The
magnification factor is in whole numbers. Therefore, if the normal size of a bitmapped font is
9 dots high and 5 dots wide, a magnification factor of 3 would produce a character of 27 dots
high and 15 dots wide. Height and width can be magnified independently.

Magnification Factor
The font commands contain parameters for entering the height and width of printed characters.
The values are always entered in dots. When entering these values for bitmapped fonts, use the
following formula:
Base Height x Magnification Factor = Height Parameter Value

P1012728-004 Zebra Programming Guide 6/8/10

 Fonts and Bar Codes 965
Scalable Versus Bitmapped Fonts

The same principle applies when calculating width.

Example:
Base height = 9 dots
Base width = 5 dots

To magnify a bitmapped character with the above specifics 3 times its size:
Height parameter = 27 [9 x 3]
Width parameter = 15 [5 x 3]

Changing Bitmapped Font Size

Alphanumeric field command (^A) parameters h and w control the magnification and,
therefore, the ultimate size of the font. The parameter is specified in dots, but ZPL II actually
uses an integer multiplier times the original height/width of the font. For example, if you
specify
^AD,54
you get characters three times their normal size (54 dots high), but if you specify
^AD,52
you receive the same result, not characters 52 dots high.

Defining only the height or width of a bitmapped font forces the magnification to be
proportional to the parameter defined. If neither is defined, the ^CF height and width are used.
For example, if the height is twice the standard height, the width will be twice the standard
width.

Example • If a ^CF command, with height and width parameters defined, is used to set the
first font, any ^A commands (to select a different font) that follow must have the height and
width parameter filled in.
If this is not done, the newly selected font will be magnified using values for the ^CF height
and width parameters. This is an example of what happens:.

ZPL II CODE GENERATED LABEL

^XA^LL1800
^FO50,50^CFD,26,10^FDZEBRA....^FS
^FO50,100^FD"Bar Code, Bar None"^FS
^FO50,200^AA^FDZEBRA....^FS
^FO50,250^FD"Bar Code, Bar None"^FS
^XZ

6/8/10 Zebra Programming Guide P1012728-004

966 Fonts and Bar Codes
Font Matrices

Font Matrices
Type Key U = Uppercase, L = Lowercase, D = Descenders

Table 31 • 6 dot/mm Printhead

Matrix Character Size

Font Type
HxW (in dots) HxW (in in.) Char./in. HxW (in mm) Char. /mm
A 9x5 U-L-D 0.059 x 0.039 25.4 1.50 x 0.99 1.01
B 11 x 7 U 0.072 x 0.059 16.9 1.82 x 1.50 0.066
C, D 18 x 10 U-L-D 0.118 x 0.079 12.7 2.99 x 2.00 0.05
E 21 x 10 OCR-B 0.138 x 0.085 11.7 3.50 x 2.16 0.46
F 26 x 13 U-L-D 0.170 x 0.105 9.53 4.32 x 2.67 0.37
G 60 x 40 U-L-D 0.394 x 0.315 3.18 10.0 x 8.00 0.125
H 17 x 11 OCR-A 0.111 x 0.098 10.2 2.81 x 2.48 0.40
GS 24 x 24 SYMBOL 0.157 x 0.157 6.35 3.98 x 3.98 0.251
0 Default: 15 x 12

Table 32 • 8 dot/mm (203 dpi) Printhead

Matrix Character Size

Font Type
HxW (in dots) HxW (in in.) Char./in. HxW (in mm) Char. /mm
A 9X5 U-L-D 0.044 x 0.030 33.3 1.12 x 0.76 1.31
B 11 X 7 U 0.054 x 0.044 22.7 1.37 x 1.12 0.89
C, D 18 X 10 U-L-D 0.089 x 0.059 16.9 2.26 x 1.12 0.66
E 28 x 15 OCR-B 0.138 x 0.098 10.2 3.50 x 2.49 0.40
F 26 x 13 U-L-D 0.128 x 0.079 12.7 3.25 x 2.00 0.50
G 60 x 40 U-L-D 0.295 x 0.197 4.2 7.49 x 5.00 0.167
H 21 x 13 OCR-A 0.103 x 0.093 10.8 2.61 x 2.36 0.423
GS 24 x 24 SYMBOL 0.118 x 0.118 8.5 2.99 x 2.99 0.334
P 20 x 18 U-L-D 0.098 x 0.089 N/A 2.50 x 2.25 N/A
Q 28 x 24 U-L-D 0.138 x 0.118 N/A 3.50 x 3.00 N/A
R 35 x 31 U-L-D 0.172 x 0.153 N/A 4.38 x 3.88 N/A
S 40 x 35 U-L-D 0.197 x 0.172 N/A 5.00 x 4.38 N/A
T 48 x 42 U-L-D 0.236 x 0.207 N/A 6.00 x 5.25 N/A
U 59 x 53 U-L-D 0.290 x 0.261 N/A 7.38 x 6.63 N/A
V 80 x 71 U-L-D 0.394 x 0.349 N/A 10.00 x 8.88 N/A
0 Default: 15 x 12 U-L-D Scalable Scalable

P1012728-004 Zebra Programming Guide 6/8/10

 Fonts and Bar Codes 967
Font Matrices

Table 33 • 12 dot/mm (300 dpi) Printhead

Matrix Character Size

Font Type
HxW (in dots) HxW (in in.) Char./in. HxW (in mm) Char. /mm
A 9X5 U-L-D 0.030 x 0.020 50.8 0.75 x 0.50 2.02
B 11 X 7 U 0.036 x 0.030 33.8 0.91 x 0.75 1.32
C, D 18 X 10 U-L-D 0.059 x 0.040 25.4 1.50 x 1.00 1.00
E 42 x 20 OCR-B 0.138 x 0.085 23.4 1.75 x 1.08 0.92
F 26 x 13 U-L-D 0.085 x 0.053 19.06 2.16 x 1.34 0.74
G 60 x 40 U-L-D 0.197 x 0.158 6.36 5.00 x 4.00 0.25
H 34 x 22 OCR-A 0.111 x 0.098 10.20 2.81 x 2.48 0.40
GS 24 x 24 SYMBOL 0.079 x 0.079 12.70 1.99 x 1.99 0.52
P 20 x 18 U-L-D 0.067 x 0.060 N/A 1.69 x 1.52 N/A
Q 28 x 24 U-L-D 0.093 x 0.080 N/A 2.37 x 2.03 N/A
R 35 x 31 U-L-D 0.117 x 0.103 N/A 2.96 x 2.62 N/A
S 40 x 35 U-L-D 0.133 x 0.177 N/A 3.39 x 2.96 N/A
T 48 x 42 U-L-D 0.160 x 0.140 N/A 4.06 x 3.56 N/A
U 59 x 53 U-L-D 0.197 x 0.177 N/A 5.00 x 4.49 N/A
V 80 x 71 U-L-D 0.267 x 0.237 N/A 6.77 x 6.01 N/A
0 Default: 15 x 12 U-L-D Scalable Scalable

aa

Table 34 • 24 dot/mm (600 dpi) Printhead

Matrix Character Size

Font Type
HxW (in dots) HxW (in in.) Char./in. HxW (in mm) Char. /mm
A 9X5 U-L-D 0.015 x 0.010 100.00 0.38 x 0.25 4.00
B 11 X 7 U 0.018 x 0.015 66.66 0.46 x 0.38 2.60
C, D 18 X 10 U-L-D 0.030 x 0.020 50.00 0.77 x 0.51 2.0
E 42 x 20 OCR-B 0.137 x 0.087 11.54 3.47 x 2.20 0.45
F 26 x 13 U-L-D 0.043 x 0.027 37.5 1.10 x 0.68 1.50
G 60 x 40 U-L-D 0.100 x 0.080 12.50 2.54 x 2.04 0.50
H 34 x 22 OCR-A 0.100 x 0.093 10.71 2.54 x 2.37 0.42
GS 24 x 24 SYMBOL 0.040 x 0.040 25.00 1.02 x 1.02 1.00
P 20 x 18 U-L-D 0.067 x 0.060 N/A 1.69 x 1.52 N/A
Q 28 x 24 U-L-D 0.093 x 0.080 N/A 2.37 x 2.03 N/A
R 35 x 31 U-L-D 0.117 x 0.103 N/A 2.96 x 2.62 N/A
S 40 x 35 U-L-D 0.133 x 0.117 N/A 3.39 x 2.96 N/A
T 48 x 42 U-L-D 0.160 x 0.140 N/A 4.06 x 3.56 N/A
U 59 x 53 U-L-D 0.197 x 0.177 N/A 5.00 x 4.49 N/A
V 80 x 71 U-L-D 0.267 x 0.237 N/A 6.77 x 6.01 N/A
0 Default: 15 x 12 U-L-D Scalable Scalable

6/8/10 Zebra Programming Guide P1012728-004

968 Fonts and Bar Codes
Bar Codes

Bar Codes
Every bar code contains data made up of a sequence of light spaces and dark bars that
represent letters, numbers, or other graphic characters. The usable characters differ among the
various kinds of bar codes. Each bar code section in the ZPL Commands on page 37 provides a
table of applicable characters. Start and stop characters and check digits are used by many, but
not all, bar codes. These will be indicated in the specific bar code explanations.

Zebra printers can print the following kinds of bar codes:

Bar code modulus “X” dimensions Linear bar codes

• Picket fence (non-rotated) orientation: • Codabar
• 203 dpi = 0.0049 in. mil to 0.049 in. • Code 11
• 300 dpi = 0.0033 in. mil to 0.033 in. • Code 39
• Ladder (rotated) orientation: • Code 93
• 203 dpi = 0.0049 in. mil to 0.049 in. • Code 128 with subsets A/B C and
UCC Case Codes
• 300 dpi = 0.0039 in. mil to 0.039 in.
• ISBT-128
Two-dimensional bar codes • UPC-A
• Aztec • UPC-E
• Code 49 • EAN-8
• Maxi Code • EAN-13
• TLC39 • UPC and EAN 2 or 5 digit extensions
• PDF-417 • Planet Code
• QR Code • Plessey
• Codablock • Postnet
• DataMatrix • Standard 2 of 5
• Micro-PDF417 • Industrial 2 of 5
Bar code ratios • Interleaved 2 of 5
• 2:1 • LOGMARS
• 7:3 • MSI
• 5:2 • GS1 DataBar Omnidirectional
• 3:1

Basic Format for Bar Codes

The basic format for bar codes is quiet zone, start character, data, check digit, stop character,
and quiet zone. Not all bar codes require each of these elements.

Every bar code requires a quiet zone. A quiet zone (sometimes called a “clear area”) is an area
adjacent to the machine-readable symbols that ensure proper reading (decoding) of the
symbols. No printing is permissible within this area. Preprinted characters, borders, and
background color are acceptable if they are invisible to the reading device; these are used in
some applications but restrict the type of reading device that can be used. The size of the quiet
zone depends on the size of bar widths (usually 10 times the width of the narrow bar).

P1012728-004 Zebra Programming Guide 6/8/10

 Fonts and Bar Codes 969
Bar Codes

Figure 9 • Quiet Zone in a Bar Code

Quiet Zone Quiet Zone

Bar Code Field Instructions

To create a bar code, a bar code field command must be contained in the label format. Table 35
shows the bar code field commands. The number in brackets denotes the print ratio. Each
command produces a unique bar code.

Important • (*) for Fixed Printing Ratio means that the ratio between the width of the bars in
the code is a fixed standard and cannot be changed.

As another reference to the bar code field commands ratio, see Table 11 on page 139.

Table 35 • Bar Code Field Commands

ZPL Command Command Description Ratio

^B0 Aztec Bar Code Parameters [Fixed]
^B1 Code 11 (USD-8) [2.0 - 3.0]
^B2 Interleaved 2 of 5 [2.0 - 3.0]
^B3 Code 39 (USD-3 and 3 of 9) [2.0 - 3.0]
^B4 Code 49 (*) [Fixed]
^B5 Planet Code Bar Code [Fixed]
^B7 PDF417 (*) [Fixed]
^B8 EAN-8 (*) [Fixed]
^B9 UPC-E [Fixed]
^BA Code 93 (USS-93)(*) [Fixed]
^BB CODABLOCK A, E, F (*) [Fixed]
^BC Code 128 (USD-6) (*) [Fixed]
^BD UPS MaxiCode (*) [Fixed]
^BE EAN-13 [Fixed]
^BF Micro-PDF417 [Fixed]

6/8/10 Zebra Programming Guide P1012728-004

970 Fonts and Bar Codes
Bar Codes

Table 35 • Bar Code Field Commands

ZPL Command Command Description Ratio

^BI Industrial 2 of 5 [2.0 - 3.0]
^BJ Standard 2 of 5 [2.0 - 3.0]
^BK ANSI Codabar (USD-4 and 2 of 7) [2.0 - 3.0]
^BL LOGMARS [2.0 - 3.0]
^BM MSI [2.0 - 3.0]
^BO Aztec Bar Code Parameters [Fixed]
^BP Plessey [2.0 - 3.0]
^BQ QR Code (*) [Fixed]
^BR GS1 Databar (formerly RSS) [Fixed]
^BS UPC/EAN Extensions (*) [Fixed]
^BU UPC-A (*) [Fixed]
^BX Data Matrix (*) [Fixed]
^BZ PostNet (*), USPS Intelligent Mail, and Planet bar [Fixed]
codes

Additionally, each bar code field command can be issued with a definition parameter string.
The parameter string defines field rotation, height, and interpretation line status for all bar
codes. For some bar codes, the parameter string also sets a check digit, start character, and/or
stop character. Use the definition parameter string to command the printer to print bar codes of
appropriate heights and densities that conform to the specifications of the application.

The use of the parameter string is optional because all parameters have default values. If the
default values for all of the bar code parameters suit the application, then only the bar code
command needs to be entered.

Parameters in bar code field commands are “position specific.” If a value (other than the
default value) is manually entered for one parameter the ZPL II delimiter character (a comma)
must be used to mark the position of the preceding parameters in the string.

To change just the third parameter, enter two commas and then the value for the third
parameter. The default values will be automatically used for the first and second parameters.

P1012728-004 Zebra Programming Guide 6/8/10

 Fonts and Bar Codes 971
Bar Codes

Bar Code Command Groups

Bar code commands are organized into four groups. Each group represents a type of bar code.
Table 36 through Table 39 identify the groups and the bar codes they contain:

Table 36 • Numeric Only Bar Codes

ZPL Command Command Description

^B0 Aztec Bar Code Parameters
^B1 Code 11
^B5 Planet Code Bar Code
^BI Industrial 2 of 5
^BJ Standard 2 of 5
^BK ANSI Codabar (or NW-7)
^BM MSI
^BO Aztec Bar Code Parameters
^BP Plessey
^BZ PostNet (*), USPS Intelligent Mail, and Planet bar codes

Table 37 • Retail Labeling Bar Codes

ZPL Command Command Description

^B0 Aztec Bar Code Parameters
^B8 EAN-8
^B9 UPC-E
^BE EAN-13
^BO Aztec Bar Code Parameters
^BS UPC/EAN extensions
^BU UPC-A

Table 38 • Alphanumeric Bar Codes

ZPL Command Command Description

^B0 Aztec Bar Code Parameters
^B3 Code 39
^BA Code 93
^BC Code 128
^BL LOGMARS
^BO Aztec Bar Code Parameters

6/8/10 Zebra Programming Guide P1012728-004

972 Fonts and Bar Codes
Bar Codes

Table 39 • Two-Dimensional Bar Codes

ZPL Command Command Description

^B0 Aztec Bar Code Parameters
^B4 Code 49
^B7 PDF417
^BB CODABLOCK
^BD UPS MaxiCode
^BF MicroPDF417
^BQ QR Code
^BO Aztec Bar Code Parameters
^BR GS1 Databar (formerly RSS)
^BT TLC39
^BX Data Matrix

P1012728-004 Zebra Programming Guide 6/8/10

 D
Mod 10 and Mod 43
Check Digits

This section provides information about Mod 10 and Mod 43 check digits.

Contents
Mod 10 Check Digit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 974
Mod 43 Check Digit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 975

6/8/10 Zebra Programming Guide P1012728-004

974 Mod 10 and Mod 43 Check Digits
Mod 10 Check Digit

Mod 10 Check Digit

The calculations for determining the Mod 10 Check Digit character are as follows:

1. Start at the first position and add the value of every other position together.
0 + 2 + 4 + 6 + 8 + 0 = 20

2. The result of Step 1 is multiplied by 3.

20 x 3 = 60

3. Start at the second position and add the value of every other position together.
1 + 3 + 5 + 7 + 9 = 25

4. The results of steps 1 and 3 are added together.

60 + 25 = 85

5. The check character (12th character) is the smallest number which, when added to the
result in step 4, produces a multiple of 10.
85 + X = 90 (next higher multiple of 10)
X = 5 Check Character

This bar code illustrates the above example. The digit on the right (5) is the check digit.

P1012728-004 Zebra Programming Guide 6/8/10

 Mod 10 and Mod 43 Check Digits 975
Mod 43 Check Digit

Mod 43 Check Digit

The calculations for determining the Mod 43 check Digit character are as follows:

Each character in the Code 39 character set has a specific value, as follows:
0=0 B=11 M=22 X=33
1=1 C=12 N=23 Y=34
2=2 D=13 O=24 Z=35
3=3 E=14 P=25 - =36
4=4 F=15 Q=26 . = 37
5=5 G=16 R=27 Space=38
6=6 H=17 S=28 $=39
7=7 I=18 T=29 /=40
8=8 J=19 U=30 +=41
9=9 K=20 V=31 %=42
A=10 L=21 W=32

Example • Data string 2345ABCDE/

1. Add the sum of all the character values in the data string. Using the chart above, the sum
of the character values is as follows:
1 + 2 + 3 + 4 + 5 + 10 + 11 + 12 + 13 + 14 + 40 =115

2. Divide the total by 43. Keep track of the remainder.

115/43 = 2 Remainder is 29

3. The “check digit” is the character that corresponds to the value of the remainder.
Remainder = 29
29 is the value for the letter T.
T is the check digit.

Below is a bar code that illustrates the example. The character on the right, T, is the check
digit.

6/8/10 Zebra Programming Guide P1012728-004

976 Mod 10 and Mod 43 Check Digits
Mod 43 Check Digit

Notes • ___________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

P1012728-004 Zebra Programming Guide 6/8/10

 E
Error Detection Protocol

This section explains the Zebra protocol that has been supplanted in TCP/IP based applications
because of the error detection compatibility inherent in the TCP/IP protocol.

Contents
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 978
What is a Protocol? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 978
How Protocols Work . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 978
Request Packet Formats from the Host Computer . . . . . . . . . . . . . . . . . . . . . . . . . . . . 979
Header Block Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 979
Data Block Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 980
Response From the Zebra Printer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 981
Zebra Packet Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 981
Header Block Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 981
Data Block Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 982
Disguising Control Code Characters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 983
Error Detection Protocol Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 984
Error Conditions and System Faults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 984
How the Zebra Printer Processes a Request Packet. . . . . . . . . . . . . . . . . . . . . . . . . 985
How the Zebra Printer Responds to Host Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . 986

06/08/2010 Zebra Programming Guide P1012728-004 Rev. A

978 Error Detection Protocol
Introduction

Introduction
There are many instances when it is vitally important that the information sent to the Zebra
printer is received completely Error-Free. ZPL II supports an error detection protocol called
Zebra Packet Response Protocol to meet this need.

Note • This protocol only works when using serial interface. It does not function when using
parallel interface.

What is a Protocol?
A protocol is a precisely defined set of rules. In the case of data communications, a Protocol
defines how data is transmitted, received, and acknowledged between two devices.

The sole purpose of the Packet Response Protocol is to ensure that the information sent from a
Host computer to the Zebra printer is received accurately. Remember, the protocol cannot
insure the accuracy of the data that is actually sent from the Host computer. The commands
and data needed to make a label (ZPL II Format) are encapsulated within the information sent
from the Host computer.

How Protocols Work

The basic unit of data transfer in the Packet Response Protocol is called a “Transaction.” A
Transaction is a two-way communication procedure that consists of information being sent
from the Host computer to the Zebra printer, and the printer sending back a response to the
Host computer. This response is an indication that the Zebra printer has either accepted or
rejected the information sent from the Host computer.

Information is sent in the form of “Packets.” Packets sent from the Host computer are called
Request Packets.

When a Request Packet is received, the Zebra printer analyzes the information in the Packet. If
the Request Packet is accepted, the Zebra printer will send a positive response back to the Host
computer. The Host computer can then send the next Request Packet. If the information is
rejected, the Zebra printer will send a negative response back to the Host computer. The Host
computer then sends the same Request Packet again.

The Zebra Packet Response Protocol can be used in both single-printer applications, where
there is only one Zebra printer connected to the Host computer, and multi-drop systems in
which several Zebra printers are connected to the same Host computer.

P1012728-004 Rev. A Zebra Programming Guide 06/08/2010

 Error Detection Protocol 979
Request Packet Formats from the Host Computer

Request Packet Formats from the Host Computer

The first part of each data transfer Transaction is the sending of a Request Packet by the Host
computer. The Request Packet contains a fixed length “Header” block and a variable length
“Data” block. Each Packet sent from the Host computer to the Zebra printer must always use
the following format.

The Request Packet Header Block is comprised of five fixed-length fields. The Request Packet
Data Block is comprised of four fixed-length fields and one variable-length field. These fields
are defined as follows.

Header Block Data Block

SOH DST. Z-ID SRC. Z-ID TYPE SEQ. # STX FORMAT EXT CRC EOT
1 3 3 1 1 1 1024 1 2 1

Header Block Fields

• SOH (start of header character)
The Zebra printer interprets this character as the beginning of a new Request Packet. The
ASCII Control Code character SOH (01H) is used as the Start of Header Character.
• DST. Z-ID (destination Zebra-ID)
This is the three-digit ASCII I.D. number used to identify which Zebra printer is to receive
the Request Packet. The Zebra printer compares this number to the Network ID number
assigned to it during Printer Configuration. The Zebra printer will act on the Request
Packet only if these numbers match.
• SRC. Z-ID (source Zebra-ID)
This is a three-digit ASCII number used to identify the Host computer. This number is
determined by the user.
• TYPE (packet type)
This field is used to define the type of Request Packet being sent by the Host. Only two
characters are valid in this field:
• ‘P’ indicates a Print Request Packet
• ‘I’ indicates an Initialize Request Packet
Most of the Packets sent by the Host to the Zebra printer will be of the ‘P’ variety,
requesting a label to be printed.
The ‘I’ character tells the Zebra printer to initialize the packet sequence numbering. It is
required in the first packet of a new printing session, after starting up the Host computer or
the Zebra printer.
• SEQ. # (the sequence number of the request packet)
This block contains a single digit number used to denote the current Transaction Number.
The Host computer must increment this number by “1" for each new Request/Response
Transaction pair, i.e. 0, 1, 2,..., 9. The numbers repeat after every 10 Transactions.

06/08/2010 Zebra Programming Guide P1012728-004 Rev. A

980 Error Detection Protocol
Request Packet Formats from the Host Computer

Data Block Fields

• STX (Start of Text)
The Zebra printer interprets this character as the beginning of the variable-length Data
Format portion of the Request Packet. The ASCII Control Code character STX (02H) is
used as the Start of Text Character.
• DATA FORMAT (Label Information)
A variable-length portion of the Request Packet that contains the complete or partial ZPL
II label format, or partial data string (such as a downloaded graphic).
This field can contain from 0 to 1024 characters. If the Format of a label is longer than
1024 characters, the Data Format fields from consecutive packets will be concatenated
together in the printer’s Receive Data Buffer as if they were sent as one long direct
transmission.
Special consideration has been given to the possible requirement to include ASCII Control
Characters (values less than 20H) in the Data Format portion of a Request Packet.
Characters such as EOT (04H), STX (02H), SOH (01H), and ETX (03H), are part of the
Error Detection Protocol and could interrupt normal communication procedures if
received at the wrong time.
• ETX (End of Text)
The Zebra printer interprets this character as the end of the variable length Data Format
portion of the Request Packet. The ASCII Control Code character ETX (03H) is used as
the End of Text Character.
• CRC (Cyclic Redundancy Check)
The CRC is a 2 character field. A Cyclic Redundancy Check is a type of error checking
used to maintain the validity and integrity of the information transmitted between the Host
computer and the Zebra printer. This Protocol uses the 16-bit CCITT method of producing
a CRC.
The CRC is a two-byte value derived from the contents of the packet between, but not
including, the SOH character and the CRC code itself. The Zebra printer will calculate a
CRC of the Request Packet received and compare the value with the CRC Value in this
field. The CRC of the Request Packet must match the CRC calculated by the Zebra printer
in order for the Request Packet to be valid.
• EOT (End of Transmission)
The Zebra printer interprets this character as the end of the Request Packet. The ASCII
Control Code character EOT (04H) is used as the End of Transmission Character.

P1012728-004 Rev. A Zebra Programming Guide 06/08/2010

 Error Detection Protocol 981
Response From the Zebra Printer

Response From the Zebra Printer

When the Zebra printer receives the EOT character, it will begin acting on the Request Packet
received. The printer will compare certain characters and numeric values within the received
Request Packet and send a response back to the Host computer.

Zebra Packet Response

The Packet Response protocol provides the highest degree of error checking and is well suited
to the Host-Multiple Printer application. The Response Packet from the Zebra printer will
always use the following format.

The Request Packet Header Block is comprised of five fixed-length fields. The Request Packet
Data Block is comprised of four fixed-length fields and one variable-length field. These fields
are defined as follows.

Header Block Data Block

SOH DST. Z-ID SRC. Z-ID TYPE SEQ. # STX FORMAT EXT CRC EOT
1 3 3 1 1 1 1024 1 2 1

Header Block Fields

• SOH (Start of Header Character)
The Zebra printer sends this character as the beginning of a new Response Packet. The
ASCII Control Code character SOH (01H) is used as the Start of Header Character.
• DST. Z-ID (Destination Zebra-ID)
This is the same three-digit ASCII number used to identify the Host Computer that was
contained in the SRC. Z-ID field of the Request Packet that initiated this Response Packet.
The Host compares this number to its known value to insure it is the proper destination.
• SRC. Z-ID (Source Zebra-ID)
This is the three character ASCII Network I.D. of the Zebra printer that is sending the
Response Packet.
• TYPE (Packet Type)
This block is used to define the type of Response Packet being sent to the Host. Only three
characters are valid in this field.
• ‘A’ This is a Positive Acknowledgment to the Host computer. It indicates that the
Request Packet was received without a CRC error. The Host computer may send the
next Request Packet.
• ‘N’ This is the Negative Acknowledgment to the Host computer. It indicates that an
error was detected in the packet sent from the Host computer. The Host computer
must retransmit the same Request Packet again.
• ‘S’ This character indicates that the Response Packet contains the Zebra Printer Status
requested by a ~HS (Host Status) command received from the Host.

06/08/2010 Zebra Programming Guide P1012728-004 Rev. A

982 Error Detection Protocol
Response From the Zebra Printer

• SEQ. # (Used to denote the current message sequence number)

This number is identical to the message sequence number in the Request Packet. It denotes
the message sequence number to which the Response Packet is replying.

Data Block Fields

• STX (Start of Text)
The Zebra printer sends this character as the beginning of the variable length Data Format
portion of the Response Packet. The ASCII Control Code character STX (02H) is used as
the Start of Text Character.
• DATA FORMAT (Label Information)
The ‘variable length’ portion of the Response Packet. If the Packet Type field in the
Response Header contains an ‘A’ or an ‘N’, no data will appear in this field. If the Packet
Type field contains an ‘S‘, this field will contain the Printer Status Message.
• ETX (End of Text)
The Zebra printer sends this character as the end of the variable length Data Format
portion of the Request Packet. The ASCII Control Code character ETX (03H) is used as
the End of Text Character.
• CRC (Cyclic Redundancy Check)
This is the CRC of the Response Packet as calculated by the Zebra printer. This Cyclic
Redundancy Check maintains the validity and integrity of the information transmitted
between the Zebra printer and the Host computer.
This CRC is a two Byte value derived from the contents of the packet between, but not
including, the SOH character and the CRC code itself. The Host computer will calculate a
CRC of the received Response Packet and compare it to the CRC value in this field. The
CRC of the Response Packet must match the CRC calculated by the Host computer in
order for the Response Packet to be valid.
• EOT (End of Transmission)
The Zebra printer sends this character as the end of the Response Packet. The ASCII
Control Code character EOT (04H) is used as the End of Transmission Character.

P1012728-004 Rev. A Zebra Programming Guide 06/08/2010

 Error Detection Protocol 983
Response From the Zebra Printer

Disguising Control Code Characters

There may be occasions when ASCII Control Codes (00H - 19H) must be included as part of
the Data Format block of a Request Packet. To eliminate any problems, these characters must
be disguised so that the communication protocol does not act on them.

This procedure must be used to disguise each Control Code.

• A SUB (1AH) character must precede each Control Code placed in the Data Format block.
• The value of 40H must be added to the Hex value of the Control Code.
• The ASCII Character corresponding to the total value produced in step 2 must be entered
in the Data Format right after the SUB character.

The Zebra printer automatically converts the modified control character back to its correct
value by discarding the SUB (1AH) character and subtracting 40H from the next character.

Example • To include a DLE (10H) character in the Data Format block:

1. Enter a SUB (1AH) character into the Data Format.

2. Add 40H to the DLE value of 10H for a resulting value of 50H.

3. Enter the ASCII character “P” (50H) in the Data Format after the SUB character.

Note • This technique is counted as two characters of the 1024 allowed in the Data Format
block.

Rules for Transactions

• Every Transaction is independent of every other Transaction and can only be initiated by
the Host computer.
• A valid Response Packet must be received by the Host computer to complete a
Transaction before the next Request Packet is sent.
• If an error is encountered during a Transaction, the entire Transaction (i.e., Request Packet
and Response Packet) must be repeated.
• The Zebra printer does not provide for system time-outs and has no responsibility for
insuring that its Response Packets are received by the Host computer.
• The Host computer must provide time-outs for all of the Transactions and insure that
communication continues.
• If any part of a Transaction is lost or received incorrectly, it is the responsibility of the
Host computer to retry the whole Transaction.

06/08/2010 Zebra Programming Guide P1012728-004 Rev. A

984 Error Detection Protocol
Response From the Zebra Printer

Error Detection Protocol Application

The following are the basic requirements for setting up the Zebra printer to use the Error
Detection Protocol.

Activating the Protocol Protocol is a front panel selection, or can be done with the ZPL
command ^SC.

Setting Up Communications Insure that the Host computer and the Zebra printer are
characterized with the same communication parameters; i.e., Parity, Baud Rate, etc. The
communications must be set up for 8 data bits.

Setting the Printer ID Number The Protocol uses the printer’s Network ID number to
insure communication with the proper unit. The Network ID is programmed into the printer by
sending the printer a ^NI (Network ID Number) command or done through the front panel.

If there is only one printer connected to the Host computer, the Network ID number should be
set to all zeros (default).

If there is more than one printer, such as in a broadcast or multi-drop environment, each printer
should be assigned its own unique ID number. Printers in this environment, with an ID of all
zeros, will receive ALL label formats regardless of the actual printer ID number in the DST. Z-
ID block of the Request Packet.

Error Conditions and System Faults

Restarting a Transmission If a break in communication occurs, the Host must restart the
transmission of the current label format with an Initialization Request Packet. The Zebra
printer will not respond to Request Packets sent out of sequence. However, the Zebra printer
will respond to an Initialization Request Packet and restart its internal counting with the
sequence number of the Request Packet.

CRC Error Conditions and Responses A CRC error condition can be detected when
the printer receives a Request Packet or when the Host computer receives a Response Packet.
The following list defines these errors and how the Host computer should respond to them.

Error Response
The CRC calculated by the Zebra The Zebra printer will return a Negative
printer does not match the one Acknowledgment Response Packet. The Host
received as part of the Request Packet. computer should retry the same Transaction with
the same Sequence Number.
The CRC calculated by the Host The Host computer should retry the same
computer does not match the one Transaction with the same Sequence Number.
received as part of the Response
Packet.

P1012728-004 Rev. A Zebra Programming Guide 06/08/2010

 Error Detection Protocol 985
Response From the Zebra Printer

Time-Out Error Conditions and Responses

There are certain conditions at the Zebra printer that might cause the Host computer to time-
out while processing a Transaction. The following list illustrates these conditions and how the
Host computer should respond to them.

Error Response
A Request Packet from the Host The Host computer times out and resends the
computer is not received by the Zebra Request Packet of the same Transaction with the
printer. same Sequence Number.
A Request Packet from the Host The Host computer times out and resends the
computer is partially received by the Request Packet of the same Transaction with the
Zebra printer. same Sequence Number.
A Response Packet from the Zebra The Host computer times out and resends the
printer is not received by the Host Request Packet of the same Transaction with the
computer. same Sequence Number.
A Response Packet from the Zebra The Host computer times out and resends the
printer is partially received by the Request Packet of the same Transaction with the
Host computer. same Sequence Number.

How the Zebra Printer Processes a Request Packet

The following describes the steps taken at the Zebra printer to process a Request Packet.

1. The Zebra printer looks for a SOH (Start of Header) character. As soon as it finds one, it
places the SOH and all the data after it into its Receive Data Buffer. This process
continues until the printer receives an EOT (End of Transmission) character.

Note • If a second SOH is received before an EOT is detected, the contents of the Receive
Buffer will be discarded. All of the data after the second SOH will be placed in the
Receive Data Buffer.

2. After detecting the EOT, the printer checks for the following:
* The DST. Z-ID matches the printer’s Network I.D.

Note • If the Network ID at the printer is all zeros, the printer will accept all Request
Packets regardless of the DST. Z-ID received. If a Request Packet is received with the
DST. Z-ID all zeros, it is accepted by all printers regardless of their Network ID setting.

*The Data Format begins with STX and ends with ETX.
*The Sequence Number has not been used before.

If the check is satisfactory, proceed to Step 3 on the following page.

If any part of the check is unsatisfactory, the printer discards the data in its Receive Data
Buffer and waits for another SOH. No response is sent to the computer.

06/08/2010 Zebra Programming Guide P1012728-004 Rev. A

986 Error Detection Protocol
Response From the Zebra Printer

Exceptions
It is possible that the printer will send a response to the host that the host does not receive.
Therefore, the host will send the same request packet to the printer again. If this happens, the
printer will not use the data if it already used it before. However, the printer will send a
response back to the host.

The printer calculates the CRC and compares it with the one received in the Request Packet. If
the CRC is valid, the printer sends a Positive Response Packet to the Host computer. It then
transfers the ‘Variable Length’ data from the Receive Buffer to its memory for processing. If
the CRC does not match, and the printer is set up to return a Negative Response Packet, the
following will take place:

1. The printer assumes that the DST. Z-ID, SRC. Z-ID, and Sequence Number are correct
and that the error was in the variable data.

2. The same DST. Z-ID, printers SRC. Z-ID, and Sequence Number will be returned back to
the host in the Negative Response Packet.

3. If the assumption in (a) is incorrect, the Host computer can time-out and retransmit the
original Request Packet.

How the Zebra Printer Responds to Host Status

If a ~HS (Host Status) command is received by the Zebra printer, the printer will send back an
acknowledgment for the receipt of the packet. It then sends an additional packet that includes
the Host Status information in the Variable Length portion of the packet.

P1012728-004 Rev. A Zebra Programming Guide 06/08/2010

 F
ZB64 Encoding and
Compression

This section describes the Base 64 MIME (ZB64) encoding and compression. This is the same
type of MIME encoding that is used in e-mail.

For more information on ZB64 Encoding and Compression, please contact your Reseller or
Zebra Representative.

Contents
Introduction to B64 and Z64. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 988
B64 and Z64 Encoding. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 990

6/8/10 Zebra Programming Guide P1012728-004

988 ZB64 Encoding and Compression
Introduction to B64 and Z64

Introduction to B64 and Z64

The first encoding, known as B64, encodes the data using the MIME Base64 scheme. Base64
is used to encode e-mail attachments and is specifically designed to address communications
path limitations, such as control characters and 7-bit data links. It encodes the data using only
the printable ASCII characters:

With the use of ZPL, this has the added benefit of avoiding the caret (^) and tilde (~)
characters. Base64 encodes six bits to the byte, for an expansion of 33 percent over the un-
enclosed data. This is much better than the 100 percent expansion given by the existing ASCII
hexadecimal encoding.

The second encoding, known as Z64, first compresses the data using the LZ77 algorithm to
reduce its size. (This algorithm is used by the PKWARE® compression program PKZIP™ and
is integral to the PNG graphics format.) The compressed data is then encoded using the MIME
Base64 scheme as described above.

A CRC is calculated across the Base64-encoded data. If the CRC-check fails or the download
is aborted, the object can be invalidated by the printer.

The robust encodings can be piggybacked on the existing download commands with full
backward compatibility. This is done by prefacing the new encodings with a header that
uniquely identifies them. The download routines in the printer firmware can key-off the header
to determine whether the data is in the old ASCII hexadecimal encoding or one of the new
encodings. This allows existing downloadable objects to be used in their present format, while
new objects can be created using the same download commands with the new encodings for
increased integrity and reduced download times.

For easy reference, B64 and Z64 are referred to as ZB64. In any reference to the ZB64
encoding, assume that both Base64-only (B64) and LZ77/Base64 (Z64) encodings are
accepted.

Example • The following is an example of an existing download command using the new
encoding:

~DTARIAL,59494,:Z64:H4sICMB8+DMAC0FSSUFMLlRURgDsmnd8VEW7x5+ZO
edsyibZNNJhlyWhbEJIwYSwJDGNkmwghJIgJYEEEhQIPSggKAjEAiIiVaSoIJ
YNBAkIGgGxUBVUUCGU0JQSC0WFnPvbE+SF18+9H+8f973X+3Jm93umzzNznvn
NSSFGRJ6ARAVZvXK7XDaXLyTiR5B7ontuZPQ824I5RKIa6ew+aba8+pU1rVDZ
iciv

[multiple lines deleted]

/O6DU5wZ7ie2+g4xzDPwCpwm3nqW2GAPcdclxF4fIP66jHjncmKvKzh/ZUNCx
l9/QQx2HXHYB4m/PkQcdCdx2G7OYt+mszkMh4iZxoifvkh89BFipo87kwD/Bf
/dOcycAAEA:a1b2

P1012728-004 Zebra Programming Guide 6/8/10

 ZB64 Encoding and Compression 989
Introduction to B64 and Z64

The parameters are identical to the existing ~DT command:

Table 40 • ~DT Command Parameters

Parameter Details
o = font name Accepted Values: any valid TrueType name, up to 8 characters
Default Value: if a name is not specified, UNKNOWN is used
In this example, Arial is the specified font.
s = font size Accepted Values: the number of memory bytes required to hold
the Zebra-downloadable format of the font
Default Value: if an incorrect value or no value is entered, the
command is ignored
In this example, 59494 is the size.
To maintain compatibility with the existing ASCII hexadecimal
encoding, this field must contain the size of the un-enclosed and
uncompressed object — the number of bytes that are finally
placed into the printer’s memory, not the number of bytes
downloaded.
data = data string Accepted Values: a string of ASCII hexadecimal values (two
hexadecimal digits/byte). The total number of two-digit values
must match parameter s.
Default Value: if no data is entered, the command is ignored
Everything following the size field is data. The new encoding
imposes a header with a unique signature. The new encoding must
start with the characters :B64: (data encoded in Base-64 only) or
:Z64: (data compressed with LZ77, then encoded in Base-64)
followed by the encoded data.
After the data is presented, another colon (:) and four hexadecimal
digits comprise the CRC. The Base64 standard allows new-line
characters (carriage returns and line feeds) to be inserted into the
encoded data for clarity. These characters are ignored by the
printer.

When downloading graphics, the colon is used in the current ASCII hexadecimal encoding
indicate “repeat the previous dot row.” Since this shorthand is invalid for the first character of
data (no previous dot row has been downloaded), it is safe for the printer to detect the leading
colon character as the lead-in for the new encodings.

6/8/10 Zebra Programming Guide P1012728-004

990 ZB64 Encoding and Compression
B64 and Z64 Encoding

B64 and Z64 Encoding

These download encodings, B64 and Z64, are created as drop-in replacements for the existing
ASCII hexadecimal encoding.

B64 encoding do the following:

• Encode the compressed data using the MIME Base64 algorithm.
• Calculate a CRC across the encoded data.
• Add a unique header to differentiate the new format from the existing ASCII hex
encoding.

Z64 encoding do the following:

• Compress the data using the LZ77 algorithm.
• Encode the compressed data using the MIME Base64 algorithm.
• Calculate a CRC across the encoded data.
• Add a unique header to differentiate the new format from the existing ASCII hexadecimal
encoding.

The data field have this format:

:id:encoded_data:crc

This table identifies the parameters for this format:

Table 41 • Format Parameters

Parameter Details
:id the identifying string B64 or Z64
:iencoded_data data to download, compressed with LZ77 (if the id parameter is
set to Z64) and encoded with Base64.
:crc four hexadecimal digits representing the CRC calculated over the
:encoded_data field.

The printer calculates a CRC across the received data bytes and compare this to the CRC in the
header. A CRC mismatch is treated as an aborted download.

The B64 and Z64 encodings can be used in place of the ASCII hexadecimal encoding in any
download command. The commands are:
~DB – Download Bitmap Font
~DE – Download Encoding
~DG – Download Graphic
~DL – Download Unicode Bitmap Font
~DS – Download Scalable Font
~DT – Download TrueType Font
~DU – Download Unbounded TrueType Font
^GF – Graphic Field (with compression type set to “ASCII hex”)

P1012728-004 Zebra Programming Guide 6/8/10

 ZB64 Encoding and Compression 991
B64 and Z64 Encoding

The ~DB (Download Bitmap Font) command can use the new encodings in place of the ASCII
hexadecimal encoding in data sub-fields. Each character is encoded individually. However, for
small amounts of data, the identifying B64 or Z64 header and trailing CRC may negate any
gains made by using the new format.

For backward compatibility, the ^HG (Host Graphic) command uses the ASCII hexadecimal
encoding. It does not use the new encodings.

6/8/10 Zebra Programming Guide P1012728-004

992 ZB64 Encoding and Compression
B64 and Z64 Encoding

Notes • ___________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

P1012728-004 Zebra Programming Guide 6/8/10

 G
Field Interactions

This section provides you with examples that show how commands interact with various
justification parameters. The examples are in charts for these orientations:
• Normal
• Rotated
• Bottom-up
• Inverted

These charts are designed so that you can identify the location of the field origin and
interactions between the rotation, formatting and justification commands.

6/8/10 Zebra Programming Guide P1012728-004

994 Field Interactions
Normal Orientation

Normal Orientation
Table 42 shows you the various normal orientation outputs:

Table 42 • Normal Orientation Examples

^FPH ^FPV ^FPR

^FO
Left
Justified

^FT
Left
Justified

^FO
Right
Justified

^FT
Right
Justified

P1012728-004 Zebra Programming Guide 6/8/10

 Field Interactions 995
Rotated Orientation

Rotated Orientation
Table 43 shows you the various rotated orientation outputs:

Table 43 • Rotated Orientation Examples

^FPH ^FPV ^FPR

^FO
Left
Justified

^FT
Left
Justified

^FO
Right
Justified

^FT
Right
Justified

6/8/10 Zebra Programming Guide P1012728-004

996 Field Interactions
Bottom Up Orientation

Bottom Up Orientation
Table 44 shows you the various bottom up orientation outputs:

Table 44 • Bottom Orientation Examples

^FPH ^FPV ^FPR

^FO
Left
Justified

^FT
Left
Justified

^FO
Right
Justified

^FT
Right
Justified

P1012728-004 Zebra Programming Guide 6/8/10

 Field Interactions 997
Inverted Orientation

Inverted Orientation
Table 45 shows you the various inverted orientation outputs:

Table 45 • Inverted Orientation Examples

^FPH ^FPV ^FPR

^FO
Left
Justified

^FT
Left
Justified

^FO
Right
Justified

^FT
Right
Justified

6/8/10 Zebra Programming Guide P1012728-004

998 Field Interactions
Inverted Orientation

Notes • ___________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

P1012728-004 Zebra Programming Guide 6/8/10

 H
Real Time Clock

This appendix contains the information needed to install, program, and operate the Real Time
Clock (RTC) option.

6/8/10 Zebra Programming Guide P1012728-004

1000 Real Time Clock
Overview

Overview
This hardware option is available as either a factory-installed or field-installable option in
specific printer products manufactured and sold by Zebra Technologies Corporation.

The Real Time Clock option is currently available for following printers, and requires that the
firmware version shown is installed on that printer.

Requires this
Supported Zebra Printer and Print Engine Models Firmware Version
or Later
105SL printers that meet any one of the following criteria: 60.13.0.13Z
• if the printer was manufactured after April 2006
• if the RTC Date and the RTC Time fields are printed on the
configuration label
• if the RTC Date and the RTC Time appear on the LCD
display
DA402 & T402 printers 32.8.4
LP2844-Z, TPL2844-Z, and TPL3844-Z printers 45.10.x
PAX Series 170PAX2 print engines 29.9.x or 31.9.x
print engines 110PAX3 print engines using Standard Font 34.10.x
110PAX3 print engines using TT Font 49.10.x
116PAX3 print engines using TT Font 35.10.x
170PAX3 print engines using Standard Font 37.10.x
170PAX3 print engines using TT Font 38.10.x
110PAX4 and 170PAX4 print engines 60.13.0.12
S4M printers (field-installable kit) 50.13.x
S600 printers 27.10.3
Xi Series 90XiII, 140XiII, 170XiII & 220XiII printers 18.9.x
printers 90XiIII, 96XiIII, 140XiIII, 170XiIII, and 220XiIII 33.10.0
printers
90XiIIIPlus, 96XiIIIPlus, 140XiIIIPlus, 60.13.0.12
170XiIIIPlus, and 220XiIIIPlus printers
Z4Mplus and Z6Mplus printers 60.13.0.12
ZM400/ZM600/RZ400/RZ600 printers 53.15.xZ

P1012728-004 Zebra Programming Guide 6/8/10

 Real Time Clock 1001
Control Panel Programming

Control Panel Programming

New parameters for the Real Time Clock have been added to the Control Panel Configuration.
These parameters are located immediately following the FORMAT CONVERT prompt. Refer
to the printer/print engine User Guide for complete configuration information.
• X.9.x firmware added the parameters to XiII printers and 170PAX/170PAX2 print engines.
• X.10.x firmware added the parameters to XiIII printers and PAX3 print engines.
• X.13.x firmware added the parameters to XiIIIPlus printers, PAX4 print engines.
• X.13.0.13Z firmware added the parameters to 105SL printers.

Real Time Clock Parameters

The parameters listed on the following pages are added to the Control Panel Configuration
prompts only when both the Real Time Clock hardware option and the appropriate version of
firmware are installed:
• X.9.x or later firmware installed in the XiII series printers or the 170PAX/170PAX2 series
print engines.
• X.10.x or later firmware installed in the XiIII series printers or the PAX3 series print
engines.
• X.13.0.13Z or later firmware installed in the 105SL printers
• X.13.x or later firmware installed in the XiIIIPlus series printers, the PAX4 series print
engines, or the S4M printers.

The RTC ZPL II commands apply to all printers/print engines with the Real Time Clock
hardware option and proper firmware.

Idle Display
Selects the printer/print engine Idle Display format and the method of displaying the time/date
information. This parameter also affects the Configuration Label printout and the RTC DATE
and RTC TIME formats.

Selections
• FW VERSION
• MM/DD/YY 24HR
• MM/DD/YY 12HR
• DD/MM/YY 24HR
• DD/MM/YY 12HR

If FW VERSION is selected, the format on the Configuration Label and on the RTC DATE
and RTC TIME parameters is MM/DD/YY 24HR.

6/8/10 Zebra Programming Guide P1012728-004

1002 Real Time Clock
Control Panel Programming

RTC Date
Allows entry of the RTC date in the format selected by the IDLE DISPLAY parameter.

Note • The RTC parameters are password-protected. Refer to your printer’s user guide for
specific instructions on accessing and modifying printer parameters.

Printer Model Action

PAX Series print 1. Use the LEFT oval key to select the position to be adjusted
engines, Xi Series 2. Then, use the RIGHT oval key to select the correct value for that
printers, and 105SL position.
printers
Z4Mplus and 1. Press SELECT to select the parameter.
Z6Mplus printers 2. Use the MINUS (-) key to select the position to be adjusted
3. Then, use the PLUS (+) key to select the correct value for that
position.
4. Press SELECT to accept any changes and deselect the parameter.
S4M printer 1. Press ENTER. The printer displays the current RTC date.
2. Modify the values as follows:
• Press the right arrow to move to the next digit position.
• To increase the value, press the up arrow.
• To decrease the value, press the down arrow.
3. Press ENTER to accept the value shown.

Note • Invalid dates, such as 2/29/1999, may be entered, but will not be saved.

P1012728-004 Zebra Programming Guide 6/8/10

 Real Time Clock 1003
Control Panel Programming

RTC Time
Allows entry of the RTC time in the format selected by the IDLE DISPLAY parameter.

Note • The RTC parameters are password-protected. Refer to your printer’s user guide for
specific instructions on accessing and modifying printer parameters.

Printer Model Action

PAX Series print 1. Use the LEFT oval key to select the position to be adjusted
engines, Xi Series 2. Use the RIGHT oval key to select the correct value for that
printers, and 105SL position.
printers
Z4Mplus and 1. Press SELECT to select the parameter.
Z6Mplus printers 2. Use the MINUS (-) key to select the position to be adjusted.
3. Use the PLUS (+) key to select the correct value for that position.
4. Press SELECT to accept any changes and deselect the parameter.
S4M printer 1. Press ENTER. The printer displays the current RTC date.
2. Modify the values as follows:
• Press the right arrow to move to the next digit position.
• To increase the value, press the up arrow.
• To decrease the value, press the down arrow.
3. Press ENTER to accept the value shown.

6/8/10 Zebra Programming Guide P1012728-004

1004 Real Time Clock
RTC General Information

RTC General Information

The Real Time Clock commands are only applicable if the Real Time Clock option is installed
in the printer. For those printers with an LCD control panel display, additional control panel
configuration parameters are also included.

The ZPL II Field Clock ^FC command is used to specify the clock-indicator character for the
primary, secondary, and third clocks. This command must be included within each label field
command string whenever the date or time clock values are required within the field. No date
or time clock information can be printed in a label field unless this command is included. The
^FC command can now be combined with the ^SN command in V60.13.0.10 and later.

A clock-indicator can be any printable character except the ZPL II Format Prefix, Control
Prefix, or Delimiter characters. The default value for the primary clock-indicator is the percent
sign %. The secondary and third clock-indicators have no defaults and must be specified in
order for that clock to be used.

The Field Data ^FD command has been expanded to recognize the clock-indicators and
associated command characters, and to replace them during the printing process with the
corresponding time or date parameter. For example, if the primary clock-indicator is the
percent sign %, then during printing, the character sequence %H in the ^FD statement would be
replaced by the 2-digit current hour.

Note • If the Real Time Clock is not installed, or the ^FC command has not preceded the
^FD statement, no replacement would occur. In this case, the characters %H would print as
text on the label.

P1012728-004 Zebra Programming Guide 6/8/10

 Real Time Clock 1005
RTC General Information

The name of the day of the week, the name of the month, and the AM or PM designation can
also be inserted in place of a specific clock-indicator/command character sequence. See
Table 46 for the list of command characters and their functions.

Table 46 • Command Characters

Command
Function
Character
%a is replaced by the abbreviated weekday name
%A is replaced by the weekday name
%b is replaced by the abbreviated month name
%B is replaced by the month name
%d is replaced by the day of the month number, 01 to 31
%H is replaced by the hour of the day (military), 00 to 23
%I is replaced by the hour of the day (civilian), 01 to 12
%j is replaced by the day of the year, 001 to 366
%m is replaced by the month number, 01 to 12
%M is replaced by the minute, 00 to 59
%p is replaced by the AM or PM designation
%S is replaced by the seconds, 00 to 59
%U is replaced by the week# of the year, 00 to 53, Sunday is 1st day*
%W is replaced by the week# of the year, 00 to 53, Monday is 1st day**
%w is replaced by the day# of the week, 00 (Sunday) to 06 (Saturday)
%y is replaced by the 2 digits of the year, 00 to 99
%Y is replaced by the full 4 digit year number—where% is the specified
clock-indicator character

*. %U establishes Sunday as the first day of the year.

**.%W establishes Monday as the first day of the year.

The Set Offset ^SO command permits the printing of specific times and dates relative to the
primary clock. The secondary (or third) clock is enabled when secondary (or third) offsets are
entered using this command. The secondary (or third) clock time and date are determined by
adding the offsets to the current clock reading.

One ^SO command is required to set the secondary offset; an additional ^SO command is
required for a third offset. The offsets remain until changed or until the printer is either
powered down or reset.

Note • Only dates from January 1, 1998 to December 31, 2097 are supported. Setting the
offsets to values that result in dates outside this range is not recommended and may have
unexpected results.

6/8/10 Zebra Programming Guide P1012728-004

1006 Real Time Clock
RTC General Information

The Set Mode/Language ^SL (see page 336) command is used to select the language the days
of the week and the months are printed in. This command also sets the printing mode, which
can be S for START TIME, T for TIME NOW, or a Numeric Value for the time accuracy. In
START TIME mode, the time printed on the label is the time that is read from the Real Time
Clock when the label formatting begins (when the ^XA command is received by the printer).
In TIME NOW mode, the time printed on the label is the time that is read from the Real Time
Clock when the label is placed in the queue to be printed. In Numeric Value mode, a time
accuracy tolerance can be specified.

First Day of the Week Affects Calendar Week

The %U and %W commands set the first day of the week. The week numbering starts at the
beginning of the year with Week 01 representing the first full week of the year. Any day(s)
before that established first day of the week are part of the Week 00. The following examples
show how setting different days as the first day of the week affect the calendar week.

Important • The %U and %W commands determine the numbering for all weeks in the year.

Example 1 • January, 2005 with Week 00

Set Sunday as the first day of the week using the %U command. In this example,
notice that Saturday, January 1st is Week 00 and Sunday, January 2nd begins
Week 01.

Sun Mon Tue Wed Thu Fri Sat

1 Week 00
First Day of
the Week 2 3 4 5 6 7 8 Week 01

9 10 11 12 13 14 15

16 17 18 19 20 21 22

23 24 25 26 27 28 29

30 31

P1012728-004 Zebra Programming Guide 6/8/10

 Real Time Clock 1007
RTC General Information

Example 2 • January, 2005 with Week 00

Set Monday as the first day of the week using the %W command. In this example,
notice that Saturday, January 1st and Sunday, January 2nd are Week 00 and Monday,
January 3rd begins Week 01.

Mon Tue Wed Thu Fri Sat Sun

1 2 Week 00
First Day of
the Week 3 4 5 6 7 8 9 Week 01

10 11 12 13 14 15 16

17 18 19 20 21 22 23

24 25 26 27 28 29 30

31

Example 3 • January, 2006 without Week 00

Set Sunday as the first day of the week using the %U command. Since 2006 begins on
a Sunday, there is no Week 00 in this example.

Sun Mon Tue Wed Thu Fri Sat

No Week 00
First Day of
the Week 1 2 3 4 5 6 7 Week 01

8 9 10 11 12 13 14

15 16 17 18 19 20 21

22 23 24 25 26 27 28

29 30 31

6/8/10 Zebra Programming Guide P1012728-004

1008 Real Time Clock
RTC General Information

Example 4 • January, 2006 with Week 00

Set Monday as the first day of the week using the %W command. In this example,
Saturday, January 1st is Week 00 and Sunday, January 2nd begins Week 01.

Mon Tue Wed Thu Fri Sat Sun

1 Week 00
First Day of
the Week 2 3 4 5 6 7 8 Week 01

9 10 11 12 13 14 15

16 17 18 19 20 21 22

23 24 25 26 27 28 29

30 31

P1012728-004 Zebra Programming Guide 6/8/10

 Real Time Clock 1009
RTC General Information

Time and Date Precision

As of V60.13.0.1 firmware, the ^CO command is now ignored. While the S4M printer has a
lower firmware version number (V50.x), its firmware was recently released and follows the
rule to ignore the ^CO command.

The time and date placed in a label field is determined at the time the label bitmap is created by
the printer (start time mode). If a batch of labels is formatted, the date and time will be the
same for all labels in the batch. If the printer is paused during the printing process and remains
in that state for a period of time, when printing resumes, the time and date will still be the same
as when the batch was first started.

If more precise time and date stamps are required on versions prior to V60, follow the process
below. For versions after V60, use the Numeric Value mode shown on page 336.

Cycle the printer/print engine power Off (O) and On (l) to clear the memory before performing
the steps below.

1. Print a Memory Usage Label (^XA^WD*:*.*^XZ)

and note the following value: (A) __________
Available RAM (in BYTES)
2. Print a Configuration Label and note these values:
Printer “Print Width” (in DOTS) (B) __________
(NOT the Label Width)
Label Length (in DOTS) (C) __________

3. Determine the desired maximum number of queued labels with the (D) __________
same Time and Date value.

Note • Increasing the number of queued labels will improve throughput performance, but
Real Time Clock values will be less accurate. Two is usually a good compromise.

4. Substitute the values for B through D from the previous page into
the following formula:
The “label queue” memory required (in BYTES)
(E) __________
(B x C x D)/8 =
5. Substitute the values for A and E into the following formula:
The ^CO command memory required (in KBYTES) (F) __________
(A-E)/1024)-5=

Note • If the value of (F) is less than zero, then no ^CO command is needed. If the value
of (F) is greater than zero, use the integer portion in the ^CO command.

6/8/10 Zebra Programming Guide P1012728-004

1010 Real Time Clock
RTC General Information

Example •

Available RAM (A) = 71478 BYTES

Print Width (B) = 832 DOTS
Label Length (C) = 1000 DOTS
Max Labels Queued (D) = 2
Then —
The label queue memory required (E) =
(B x C x D)/8 = 208000 BYTES
And —
The ^CO command memory required (F) =
(71478-208000)/1024)-5=489.87 KBYTES
Therefore, the correct ^CO command string to add to
the label format would be:
^XA^COY,489^XZ

This command string will cause 489 KBYTES to be set aside as Font Memory and make it
unavailable as label format memory. The memory remaining will only allow two labels to be
formatted at one time, and the time and date will be more precise for those two labels.

Note • For the 170PAX2 print engine, you must disable the Reprint Function for the Time
Now Mode to function properly.

P1012728-004 Zebra Programming Guide 6/8/10

 Real Time Clock 1011
ZPL II Samples

ZPL II Samples
The ZPL II scripts shown on this page establish the initial settings for the date and time clock.
The script below then references these settings to provide the output shown in Figure 10
on page 1012.

Setting the date and time for the Real Time Clock only needs to be done once. The date and
time are maintained by an on-board battery when the printer is reset or the printer is turned
Off (O).

To set the date and time to April 23, 2005 at 2:30pm, the following command string should be
sent to the printer:
^XA
^ST04,23,2005,02,30,0,P^FS
^XZ
To initialize the Real Time Clock and set up two offset values (offset #2 set to 3 months and 1
hour in the future, offset #3 set to 1 year in the past), the following command sequence should
be sent to the printer:
^XA
^SL
^SO2,3,0,0,1,0,0^FS
^SO3,0,0,-1,0,0,0^FS
^XZ
The above ZPL II scripts initialize the RTC date and time and must be sent to a printer to
provide proper date and time parameters for the ZPL II script below.

The following ZPL II script illustrates the various methods of printing the date and time
initialized in the script above within separate fields on continuous media. Figure 10
on page 1012 illustrates the printout of this script on a label.

6/8/10 Zebra Programming Guide P1012728-004

1012 Real Time Clock
ZPL II Samples

For the below example, the ^FC command delimiters are:

% Primary clock indicator

{ Secondary clock indicator
# Third clock indicator
^XA
^LL175
^FO10,025^AD^FC%,{,#^FD1: Mil: %H:%M:%S Civ: %I:%M:%S
%p^FS
^FO10,050^AD^FC%,{,#^FD2: Mil: {H:{M:{S Civ: {I:{M:{S
{p^FS
^FO10,075^AD^FC%,{,#^FD3: Mil: #H:#M:#S Civ: #I:#M:#S
#p^FS
^FO10,100^AD^FC%,{,#^FD1: On %A, %B %d
, %Y (%a, %m/%d/%y, %d %b %Y).^FS
^FO10,125^AD^FC%,{,#^FD2: On {A, {B {d, {Y (
{a, {m/{d/{y, {d {b {Y).^FS
^FO10,150^AD^FC%,{,#^FD3: On #A, #B #d, #Y (
#a, #m/#d/#y, #d #b #Y).^FS
^XZ

Figure 10 • Printed Result of the Above ZPL II Script

1: Mil: 14:30:00 Civ: 02:30:00 PM

2: Mil: 15:30:00 Civ: 03:30:00 PM
3: Mil: 14:30:00 Civ: 02:30:00 PM
1: On Wed, April 23, 2005 (Fri, 04/23/05, 23 Apr 2005)
2: On Saturday, July 23, 2005 (Fri, 07/23/05, 23 Jul 2005)
3: On Friday, April 23, 2004 (Fri, 04/23/04, 23 Apr 2004)

P1012728-004 Zebra Programming Guide 6/8/10

 Real Time Clock 1013
ZPL II Samples

The following are examples of the time stamp using the ^SL1 and ^SL5 at 2 ips and 10 ips
for the Enhanced Real Time Clock (V60.13.0.10 and later).

Note • They show the variation of time due to print speed and label complexity.

^XA
^SL1^FS
^FO187,184^A0N,101,121^FC%^FD%H:%M:%S^FS
^PQ10
^XZ

Figure 11 • Example of ^SL1, 2 ips and 10 ips

2 ips 10 ips

15:42:31 10 15:47:10

15:42:29 9 15:47:09

15:42:27 8 15:47:08

15:42:24 7 15:47:07

15:42:22 6 15:47:06

15:42:20 5 15:47:05

15:42:18 4 15:47:04

15:42:16 3 15:47:03

15:42:13 2 15:47:02

15:42:11 1 15:47:01

1 Label 1 6 Label 6
2 Label 2 7 Label 7
3 Label 3 8 Label 8
4 Label 4 9 Label 9
5 Label 5 10 Label 10

6/8/10 Zebra Programming Guide P1012728-004

1014 Real Time Clock
ZPL II Samples

^XA
^SL5^FS
^FO187,184^A0N,101,121^FC%^FD%H:%M:%S^FS
^PQ10
^XZ

Figure 12 • Example of ^SL5, 2 ips and 10 ips

2 ips 10 ips

15:43:55 10 15:48:22

15:43:55 9 15:48:22

15:43:55 8 15:48:22

15:43:50 7 15:48:22

15:43:50 6 15:48:22

15:43:50 5 15:48:22

15:43:47 4 15:48:22

15:43:42 3 15:48:22

15:43:42 2 15:48:22

15:43:42 1 15:48:22

1 Label 1 6 Label 6
2 Label 2 7 Label 7
3 Label 3 8 Label 8
4 Label 4 9 Label 9
5 Label 5 10 Label 10

P1012728-004 Zebra Programming Guide 6/8/10

 I
ZBI Character Set

This section provides you with the set of characters that are supported on the front panel of the
following Zebra printers with ZBI 2.0: XiIIIPlus, 105SL, Z4M/Z6M, ZM400/ZM600,
RZ400/RZ600, PAX4 and S4M when V60.16.0Z or V53.16.0Z, or later firmware are loaded.
These characters can be used in ZBI programs to display content on the LCD.

6/8/10 Zebra Programming Guide P1012728-004

1016 ZBI Character Set
Character Set

Character Set
These are the supported characters for these Zebra printers:
• XiIIIPlus
• 105SL
• Z4M/Z6M
• PAX4
• S4M:

P1012728-004 Zebra Programming Guide 6/8/10

 ZBI Character Set 1017
Character Set

These are the supported characters for these Zebra printers:

• ZM400/ZM600
• RZ400/RZ600
• Xi4
• RXi4

6/8/10 Zebra Programming Guide P1012728-004

1018 ZBI Character Set
Character Set

Notes • ___________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

P1012728-004 Zebra Programming Guide 6/8/10

 J
SGD Command Support

This appendix provides you with details identifying which SGD commands can be used with
different printers and firmware versions.

6/8/10 Zebra Programming Guide P1012728-004

1020 SGD Command Support
Printer and Firmware Compatibility

Printer and Firmware Compatibility

This section provides supported printer models and minumum firmware versions for all SGD
commands. In order to set and get configurations, the SGD commands can be used through the
Ethernet, serial, parallel, and USB interfaces.

Note • The printer responds with the printer setting of "?" if the printer setting:
• does not exist
• has not been configured yet

Printer Type
Which type of printer do you have?

If you have a … Then…

Standard Printer Go to Table 47, SGD Standard Printer and Firmware
Compatibility on page 1020.
RFID printer Go to Table 48, SGD RFID Printer and Firmware
Compatibility on page 1032.

Standard Printer

Important • All the firmware versions noted in Table 47 refer to the minimum firmware
version required. For RFID printer support, see Table 48.

Table 47 • SGD Standard Printer and Firmware Compatibility

XiIIIPlus,
105SL,
ZM400,
PAX4, S4M Xi4 HC100 G-Series KR403
ZM600
SGD Commands Z4MPlus,
Z6MPlus

appl.bootblock V60.15.8Z V53.15.5Z V53.15.5Z V53.17.1Z V54.16.1Z V61.15.6Z, V66.17.2Z

V56.15.6Z

appl.name V60.15.8Z V53.15.5Z V53.15.5Z V53.17.1Z V54.16.1Z V61.15.6Z, —

V56.15.6Z

appl.option_board_version V60.16.4Z V53.16.4Z V53.16.4Z V53.17.1Z V54.16.1ZC V61.16.5Z, —

V56.16.5Z

bluetooth.address — — — — — V61.15.6Z, —
V56.15.6Z

bluetooth.afh_map — — — — — V61.15.6Z, —
V56.15.6Z

bluetooth.afh_map_curr — — — — — V61.15.6Z, —
V56.15.6Z

bluetooth.afh_mode — — — — — V61.15.6Z, —
V56.15.6Z

bluetooth.authentication — — — — — V61.15.6Z, —
V56.15.6Z

bluetooth.bluetooth_pin — — — — — V61.15.6Z, —
V56.15.6Z

* On these printers with ZebraNet™ 10/100 Internal Print Server.

** On these printers with ZebraNet™ 10/100 External Print Server, firmware version 1.1.5

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Command Support 1021
Printer and Firmware Compatibility

Table 47 • SGD Standard Printer and Firmware Compatibility (Continued)

XiIIIPlus,
105SL,
ZM400,
PAX4, S4M Xi4 HC100 G-Series KR403
ZM600
SGD Commands Z4MPlus,
Z6MPlus

bluetooth.date — — — — — V61.15.6Z, —
V56.15.6Z

bluetooth.discoverable — — — — — V61.15.6Z, —
V56.15.6Z

bluetooth.enable — — — — — V61.15.6Z, —
V56.15.6Z

bluetooth.friendly_name — — — — — V61.15.6Z, —
V56.15.6Z

bluetooth.local_name — — — — — V61.15.6Z, —
V56.15.6Z

bluetooth.radio_auto_baud — — — — — V61.15.6Z, —
V56.15.6Z

bluetooth.radio_version — — — — — V61.15.6Z, —
V56.15.6Z

bluetooth.short_address — — — — — V61.15.6Z, —
V56.15.6Z

bluetooth.version — — — — — V61.15.6Z, —
V56.15.6Z

card.inserted V60.15.2Z V50.15.2Z V53.15.5Z V53.17.1Z — V61.15.6Z, —

V56.15.6Z

card.mac_addr V60.15.2Z V50.15.2Z V53.15.5Z V53.17.1Z V54.16.1Z V61.15.6Z, —

V56.15.6Z

CISDFCRC16 V60.16.4Z V53.16.4Z V53.16.4Z V53.17.1Z V54.16.1ZC — —

comm.type — — — — — V61.17.3Z, —
V56.17.3Z

cutter.clean_cutter — — — — — V61.15.6Z, —
V56.15.6Z

device.download_connection_timeout V60.16.4Z V53.16.4Z V53.16.4Z V53.17.1Z V54.16.1ZC V61.16.5Z, —

V56.16.5Z

device.epl_legacy_mode — — — — — V61.17.7Z, —
V56.17.7Z

device.friendly_name V60.16.4Z V53.16.4Z V53.16.4Z V53.17.1Z V54.16.1ZC V61.16.5Z, —

V56.16.5Z

device.frontpanel.key_press V60.16.2Z V53.16.2Z V53.16.2Z V53.17.1Z — V61.16.5Z, —

V56.16.5Z

device.frontpanel.line1 V60.16.2Z V53.16.2Z V53.16.2Z V53.17.1Z — V61.16.5Z, —

V56.16.5Z

device.frontpanel.line2 V60.16.2Z V53.16.2Z V53.16.2Z V53.17.1Z — V61.16.5Z, —

V56.16.5Z

device.frontpanel.xml V60.16.2Z V53.16.2Z V53.16.2Z V53.17.1Z — V61.16.5Z, —

V56.16.5Z

device.jobs_print V60.16.4Z V53.16.4Z V53.16.4Z V53.17.1Z V54.16.1ZC — —

device.languages V60.15.8Z V53.15.5Z V53.15.5Z V53.17.1Z V54.16.1ZC V61.15.6Z, —

V56.15.6Z

device.orientation — — — — — — V66.17.2Z

device.pnp_option — — — — — V61.15.6Z, —
V56.15.6Z

device.reset V60.16.4Z V53.16.4Z V53.16.4Z V53.17.1Z V54.16.1ZC V61.16.5Z, —

V56.16.5Z

* On these printers with ZebraNet™ 10/100 Internal Print Server.

** On these printers with ZebraNet™ 10/100 External Print Server, firmware version 1.1.5

6/8/10 Zebra Programming Guide P1012728-004

1022 SGD Command Support
Printer and Firmware Compatibility

Table 47 • SGD Standard Printer and Firmware Compatibility (Continued)

XiIIIPlus,
105SL,
ZM400,
PAX4, S4M Xi4 HC100 G-Series KR403
ZM600
SGD Commands Z4MPlus,
Z6MPlus

device.restore_defaults V60.16.4Z V53.16.4Z V53.16.4Z V53.17.1Z V54.16.1ZC V61.16.5Z, —

V56.16.5Z

device.unique_id V60.16.2Z V53.16.2Z V53.16.2Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

device.uptime V60.16.4Z V53.16.4Z V53.16.4Z V53.17.1Z V54.16.1ZC V61.16.5Z, —

V56.16.5Z

device.user_p1 V60.16.4Z V53.16.4Z V53.16.4Z V53.17.1Z V54.16.1ZC V61.16.5Z, —

V56.16.5Z

device.user_p2 V60.16.4Z V53.16.4Z V53.16.4Z V53.17.1Z V54.16.1ZC V61.16.5Z, —

V56.16.5Z

device.xml.enable V60.15.8Z V53.15.8Z V53.15.8Z V53.17.1Z V54.16.1ZC V61.16.5Z, —

V56.16.5Z

display.text V60.16.4Z V53.16.4Z V53.16.4Z V53.17.1Z — V56.16.5Z —

external_wired.check V60.16.4Z V53.16.4Z V53.16.4Z V53.17.1Z — V61.16.5Z, —

V56.16.5Z

external_wired.ip.addr V60.15.8Z **V53.15.5Z **V53.15.5Z V53.17.1Z — V61.16.5Z, —

V56.16.5Z

external_wired.ip.arp_interval V60.15.8Z V53.15.5Z V53.15.5Z V53.17.1Z — V61.16.5Z, —

V56.16.5Z

external_wired.ip.default_addr_enable V60.15.8Z V53.15.5Z V53.15.5Z V53.17.1Z — V61.16.5Z, —

V56.16.5Z

external_wired.ip.dhcp.cid_all V60.15.8Z **V53.15.5Z **V53.15.5Z V53.17.1Z — V61.16.5Z, —

V56.16.5Z

external_wired.ip.dhcp.cid_enable V60.15.8Z **V53.15.5Z **V53.15.5Z V53.17.1Z — V61.16.5Z, —

V56.16.5Z

external_wired.ip.dhcp.cid_prefix V60.15.8Z **V53.15.5Z **V53.15.5Z V53.17.1Z — V61.16.5Z, —

V56.16.5Z

external_wired.ip.dhcp.cid_suffix V60.15.8Z **V53.15.5Z **V53.15.5Z V53.17.1Z — V61.16.5Z, —

V56.16.5Z

external_wired.ip.dhcp.cid_type V60.15.8Z V53.15.5Z **V53.15.5Z V53.17.1Z — V61.16.5Z, —

V56.16.5Z

external_wired.ip.gateway V60.15.8Z V53.15.5Z V53.15.5Z V53.17.1Z — V61.16.5Z, —

V56.16.5Z

external_wired.ip.netmask V60.15.8Z V53.15.5Z V53.15.5Z V53.17.1Z — V61.16.5Z, —

V56.16.5Z

external_wired.ip.port V60.15.8Z V53.15.5Z V53.15.5Z V53.17.1Z — V61.16.5Z, —

V56.16.5Z

external_wired.ip.protocol V60.15.8Z V53.15.5Z V53.15.5Z V53.17.1Z — V61.16.5Z, —

V56.16.5Z

external_wired.ip.timeout.enable V60.15.8Z V53.15.5Z V53.15.5Z V53.17.1Z — V61.16.5Z, —

V56.16.5Z

external_wired.ip.timeout.value V60.15.8Z V53.15.5Z V53.15.5Z V53.17.1Z — V61.16.5Z, —

V56.16.5Z

external_wired.ip.v6.addr V60.16.5Z v53.16.5Z v53.16.5Z V53.17.1Z — V61.16.5Z, —

V56.16.5Z

external_wired.ip.v6.gateway V60.16.5Z v53.16.5Z v53.16.5Z V53.17.1Z — V61.16.5Z, —

V56.16.5Z

external_wired.ip.v6.prefix_length V60.16.5Z v53.16.5Z v53.16.5Z V53.17.1Z — V61.16.5Z, —

V56.16.5Z

external_wired.mac_addr V60.15.8Z V53.15.5Z V53.15.5Z V53.17.1Z — V61.16.5Z, —

V56.16.5Z

* On these printers with ZebraNet™ 10/100 Internal Print Server.

** On these printers with ZebraNet™ 10/100 External Print Server, firmware version 1.1.5

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Command Support 1023
Printer and Firmware Compatibility

Table 47 • SGD Standard Printer and Firmware Compatibility (Continued)

XiIIIPlus,
105SL,
ZM400,
PAX4, S4M Xi4 HC100 G-Series KR403
ZM600
SGD Commands Z4MPlus,
Z6MPlus

external_wired.mac_raw V60.16.4Z V53.16.4Z V53.16.4Z V53.17.1Z — V61.16.5Z, —

V56.16.5Z

file.delete V60.16.4Z V53.16.4Z V53.16.4Z V53.17.1Z V54.16.1ZC V61.16.5Z, —

V56.16.5Z

file.dir V60.16.4Z V53.16.4Z V53.16.4Z V53.17.1Z V54.16.1ZC V61.16.5Z, —

V56.16.5Z

file.run V60.16.4Z V53.16.4Z V53.16.4Z V53.17.1Z V54.16.1ZC V61.16.5Z, —

V56.16.5Z

file.type V60.16.4Z V53.16.4Z V53.16.4Z V53.17.1Z V54.16.1ZC V61.16.5Z, —

V56.16.5Z

head.latch V60.16.4Z V53.16.4Z V53.16.4Z V53.17.1Z V54.16.1ZC V61.16.5Z, —

V56.16.5Z

interface.network.active.gateway V60.16.4Z V53.16.4Z V53.16.4Z V53.17.1Z V54.16.1ZC V61.16.5Z, —

V56.16.5Z

interface.network.active.ip_addr V60.16.4Z V53.16.4Z V53.16.4Z V53.17.1Z V54.16.1ZC V61.16.5Z, —

V56.16.5Z

interface.network.active.mac_addr V60.16.4Z V53.16.4Z V53.16.4Z V53.17.1Z V54.16.1ZC V61.16.5Z, —

V56.16.5Z

interface.network.active.mac_raw V60.16.4Z V53.16.4Z V53.16.4Z V53.17.1Z V54.16.1ZC V61.16.5Z, —

V56.16.5Z

interface.network.active.netmask V60.16.4Z V53.16.4Z V53.16.4Z V53.17.1Z V54.16.1ZC V61.16.5Z, —

V56.16.5Z

interface.network.active.protocol V60.16.4Z V53.16.4Z V53.16.4Z V53.17.1Z V54.16.1ZC V61.16.5Z, —

V56.16.5Z

internal_wired.auto_switchover V60.16.4Z V53.16.4Z V53.16.4Z V53.17.1Z V54.16.1Z V61.15.6Z, —

V56.15.6Z

internal_wired.ip.addr — — * V53.15.5Z V53.17.1Z V54.16.1Z V61.15.6Z, —

V56.15.6Z

internal_wired.ip.arp_interval — — * V53.15.5Z V53.17.1Z V54.16.1Z V61.15.6Z, —

V56.15.6Z

internal_wired.ip.default_addr_enable — — * V53.15.5Z V53.17.1Z V54.16.1Z V61.15.6Z, —

V56.15.6Z

internal_wired.ip.dhcp.cache_ip V60.16.4Z V53.16.4Z V53.16.4Z V53.17.1Z V54.16.1Z V61.15.6Z, —

V56.15.6Z

internal_wired.ip.dhcp.cid_all — — * V53.15.5Z V53.17.1Z V54.16.1Z V61.15.6Z, —

V56.15.6Z

internal_wired.ip.dhcp.cid_enable — — * V53.15.5Z V53.17.1Z V54.16.1Z V61.15.6Z, —

V56.15.6Z

internal_wired.ip.dhcp.cid_prefix — — * V53.15.5Z V53.17.1Z V54.16.1Z V61.15.6Z, —

V56.15.6Z

internal_wired.ip.dhcp.cid_suffix — — * V53.15.5Z V53.17.1Z V54.16.1Z V61.15.6Z, —

V56.15.6Z

internal_wired.ip.dhcp.cid_type — — * V53.15.5Z V53.17.1Z V54.16.1Z V61.15.6Z, —

V56.15.6Z

internal_wired.ip.dhcp.lease.last_attempt V60.16.4Z V53.16.4Z V53.16.4Z V53.17.1Z V54.16.1Z V61.15.6Z, —

V56.15.6Z

internal_wired.ip.dhcp.lease.length V60.16.4Z V53.16.4Z V53.16.4Z V53.17.1Z V54.16.1Z V61.15.6Z, —

V56.15.6Z

internal_wired.ip.dhcp.lease.server V60.16.4Z V53.16.4Z V53.16.4Z V53.17.1Z V54.16.1Z V61.15.6Z, —

V56.15.6Z

* On these printers with ZebraNet™ 10/100 Internal Print Server.

** On these printers with ZebraNet™ 10/100 External Print Server, firmware version 1.1.5

6/8/10 Zebra Programming Guide P1012728-004

1024 SGD Command Support
Printer and Firmware Compatibility

Table 47 • SGD Standard Printer and Firmware Compatibility (Continued)

XiIIIPlus,
105SL,
ZM400,
PAX4, S4M Xi4 HC100 G-Series KR403
ZM600
SGD Commands Z4MPlus,
Z6MPlus

internal_wired.ip.dhcp.lease.time_left V60.16.4Z V53.16.4Z V53.16.4Z V53.17.1Z V54.16.1Z V61.15.6Z, —

V56.15.6Z

internal_wired.ip.dhcp.option12 V60.16.4Z V53.16.4Z V53.16.4Z V53.17.1Z V54.16.1Z V61.15.6Z, —

V56.15.6Z

internal_wired.ip.dhcp.option12_format V60.16.4Z V53.16.4Z V53.16.4Z V53.17.1Z V54.16.1Z V61.15.6Z, —

V56.15.6Z

internal_wired.ip.dhcp.option12_value V60.16.4Z V53.16.4Z V53.16.4Z V53.17.1Z V54.16.1Z V61.15.6Z, —

V56.15.6Z

internal_wired.ip.dhcp.request_timeout V60.16.4Z V53.16.4Z V53.16.4Z V53.17.1Z V54.16.1Z V61.15.6Z, —

V56.15.6Z

internal_wired.ip.dhcp.requests_per_session V60.16.4Z V53.16.4Z V53.16.4Z V53.17.1Z V54.16.1Z V61.15.6Z, —

V56.15.6Z

internal_wired.ip.dhcp.session_interval V60.16.4Z V53.16.4Z V53.16.4Z V53.17.1Z V54.16.1Z V61.15.6Z, —

V56.15.6Z

internal_wired.ip.gateway — — * V53.15.5Z V53.17.1Z V54.16.1Z V61.15.6Z, —

V56.15.6Z

internal_wired.ip.netmask — — * V53.15.5Z V53.17.1Z V54.16.1Z V61.15.6Z, —

V56.15.6Z

internal_wired.ip.port — — V53.15.5Z V53.17.1Z V54.16.1Z V61.15.6Z, —

V56.15.6Z

internal_wired.ip.protocol — — * V53.15.5Z V53.17.1Z V54.16.1Z V61.15.6Z, —

V56.15.6Z

internal_wired.ip.timeout.enable — — * V53.15.5Z V53.17.1Z V54.16.1Z V61.15.6Z, —

V56.15.6Z

internal_wired.ip.timeout.value — — * V53.15.5Z V53.17.1Z V54.16.1Z V61.15.6Z, —

V56.15.6Z

internal_wired.mac_addr — — * V53.15.5Z V53.17.1Z V54.16.1Z V61.15.6Z, —

V56.15.6Z

internal_wired.mac_raw V60.16.4Z V53.16.4Z V53.16.4Z V53.17.1Z V54.16.1Z V61.15.6Z, —

V56.15.6Z

ip.active_network V60.15.8Z V53.15.5Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

ip.addr V60.15.2Z V50.15.2Z V53.15.5Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

ip.arp_interval V60.15.2Z V50.15.2Z V53.15.5Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

ip.bootp.enable V60.15.2Z V53.15.5Z , V53.15.5Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V50.15.2Z V56.16.5Z

ip.dhcp.cache_ip V60.16.4Z V53.16.4Z V53.16.4Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

ip.dhcp.cid_all V60.15.2Z V50.15.2Z V53.15.5Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

ip.dhcp.cid_enable V60.15.2Z V50.15.2Z V53.15.5Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

ip.dhcp.cid_prefix V60.15.2Z V50.15.2Z V53.15.5Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

ip.dhcp.cid_suffix V60.15.2Z V50.15.2Z V53.15.5Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

ip.dhcp.cid_type V60.15.2Z V50.15.2Z V53.15.5Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

* On these printers with ZebraNet™ 10/100 Internal Print Server.

** On these printers with ZebraNet™ 10/100 External Print Server, firmware version 1.1.5

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Command Support 1025
Printer and Firmware Compatibility

Table 47 • SGD Standard Printer and Firmware Compatibility (Continued)

XiIIIPlus,
105SL,
ZM400,
PAX4, S4M Xi4 HC100 G-Series KR403
ZM600
SGD Commands Z4MPlus,
Z6MPlus

ip.dhcp.enable V60.15.2Z V53.15.5Z, V53.15.5Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V50.15.2Z V56.16.5Z

ip.dhcp.lease.last_attempt V60.16.4Z V53.16.4Z V53.16.4Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

ip.dhcp.lease.length V60.16.4Z V53.16.4Z V53.16.4Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

ip.dhcp.lease.server V60.16.4Z V53.16.4Z V53.16.4Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

ip.dhcp.lease.time_left V60.16.4Z V53.16.4Z V53.16.4Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

ip.dhcp.option12 V60.16.4Z V53.16.4Z V53.16.4Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

ip.dhcp.option12_format V60.16.4Z V53.16.4Z V53.16.4Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

ip.dhcp.option12_value V60.16.4Z V53.16.4Z V53.16.4Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

ip.dhcp.request_timeout V60.16.4Z V53.16.4Z V53.16.4Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

ip.dhcp.requests_per_session V60.16.4Z V53.16.4Z V53.16.4Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

ip.dhcp.session_interval V60.16.4Z V53.16.4Z V53.16.4Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

ip.dns.domain V60.16.4Z V53.16.4Z V53.16.4Z V53.17.1Z V54.16.1ZC — —

ip.dns.servers V60.16.4Z V53.16.4Z V53.16.4Z V53.17.1Z V54.16.1ZC — —

ip.ftp.enable V60.15.2Z V50.15.2Z V53.15.5Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

ip.ftp.execute_file V60.15.2Z V50.15.2Z V53.15.5Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

ip.gateway V60.15.2Z V50.15.2Z V53.15.5Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

ip.http.enable V60.15.2Z V50.15.2Z V53.15.5Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

ip.lpd.enable V60.15.2Z V50.15.2Z V53.15.5Z V53.17.1Z V54.16.1Z V61.15.6Z, —

V56.15.6Z

ip.mac_raw V60.16.4Z V53.16.4Z V53.16.4Z V53.17.1Z V54.16.1ZC — —

ip.mirror.auto V60.16.4Z V53.17.2Z V53.17.2Z V53.17.2Z — V61.17.3Z, —

V56.17.3Z

ip.mirror.error_retry V60.17.2Z V53.17.2Z V53.17.2Z V53.17.2Z — V61.17.3Z, —

V56.17.3Z

ip.mirror.feedback.auto V60.17.2Z V53.17.2Z V53.17.2Z V53.17.2Z — V61.17.3Z, —

V56.17.3Z

ip.mirror.feedback.freq V60.17.2Z V53.17.2Z V53.17.2Z V53.17.2Z — V61.17.3Z, —

V56.17.3Z

ip.mirror.feedback.odometer V60.17.2Z V53.17.2Z V53.17.2Z V53.17.2Z — V61.17.3Z, —

V56.17.3Z

ip.mirror.feedback.path V60.17.2Z V53.17.2Z V53.17.2Z V53.17.2Z — V61.17.3Z, —

V56.17.3Z

ip.mirror.fetch V60.17.2Z V53.17.2Z V53.17.2Z V53.17.2Z — V61.17.3Z, —

V56.17.3Z

* On these printers with ZebraNet™ 10/100 Internal Print Server.

** On these printers with ZebraNet™ 10/100 External Print Server, firmware version 1.1.5

6/8/10 Zebra Programming Guide P1012728-004

1026 SGD Command Support
Printer and Firmware Compatibility

Table 47 • SGD Standard Printer and Firmware Compatibility (Continued)

XiIIIPlus,
105SL,
ZM400,
PAX4, S4M Xi4 HC100 G-Series KR403
ZM600
SGD Commands Z4MPlus,
Z6MPlus

ip.mirror.freq V60.17.2Z V53.17.2Z V53.17.2Z V53.17.2Z — V61.17.3Z, —

V56.17.3Z

ip.mirror.freq_hours V60.17.2Z V53.17.2Z V53.17.2Z V53.17.2Z — V61.17.3Z, —

V56.17.3Z

ip.mirror.last_error V60.17.2Z V53.17.2Z V53.17.2Z V53.17.2Z — V61.17.3Z, —

V56.17.3Z

ip.mirror.last_time V60.17.2Z V53.17.2Z V53.17.2Z V53.17.2Z — V61.17.3Z, —

V56.17.3Z

ip.mirror.password V60.17.2Z V53.17.2Z V53.17.2Z V53.17.2Z — V61.17.3Z, —

V56.17.3Z

ip.mirror.path V60.17.2Z V53.17.2Z V53.17.2Z V53.17.2Z — V61.17.3Z, —

V56.17.3Z

ip.mirror.reset_delay V60.17.2ZA V53.17.2ZA V53.17.2ZA V53.17.2ZA — V61.17.3ZA, —

V56.17.3ZA

ip.mirror.server V60.17.2Z V53.17.2Z V53.17.2Z V53.17.2Z — V61.17.3Z, —

V56.17.3Z

ip.mirror.success V60.17.2Z V53.17.2Z V53.17.2Z V53.17.2Z — V61.17.3Z, —

V56.17.3Z

ip.mirror.success_time V60.17.2Z V53.17.2Z V53.17.2Z V53.17.2Z — V61.17.3Z, —

V56.17.3Z

ip.mirror.username V60.17.2Z V53.17.2Z V53.17.2Z V53.17.2Z — V61.17.3Z, —

V56.17.3Z

ip.mirror.version V60.17.2Z V53.17.2Z V53.17.2Z V53.17.2Z — V61.17.3Z, —

V56.17.3Z

ip.netmask V60.15.2Z V50.15.2Z V53.15.5Z V53.17.1Z V54.16.1Z V61.15.6Z, —

V56.15.6Z

ip.pop3.enable V60.15.2Z V50.15.2Z V53.15.5Z V53.17.1Z V54.16.1Z V61.15.6Z, —

V56.15.6Z

ip.pop3.password V60.15.2Z V50.15.2Z V53.15.5Z V53.17.1Z V54.16.1Z V61.15.6Z, —

V56.15.6Z

ip.pop3.poll V60.15.2Z V50.15.2Z V53.15.5Z V53.17.1Z V54.16.1Z V61.15.6Z, —

V56.15.6Z

ip.pop3.server_addr V60.15.2Z V50.15.2Z V53.15.5Z V53.17.1Z V54.16.1Z V61.15.6Z, —

V56.15.6Z

ip.pop3.username V60.15.2Z V50.15.2Z V53.15.5Z V53.17.1Z V54.16.1Z V61.15.6Z, —

V56.15.6Z

ip.port V60.15.2Z V50.15.2Z V53.15.5Z V53.17.1Z V54.16.1Z V61.15.6Z, —

V56.15.6Z

ip.primary_network V53.15.5Z V53.15.5Z V53.15.5Z V53.17.1Z V54.16.1Z V61.15.6Z, —

V56.15.6Z

ip.smtp.domain V60.15.2Z V53.15.5Z, V53.15.5Z V53.17.1Z V54.16.1Z V61.15.6Z, —

V50.15.2Z V56.15.6Z

ip.smtp.enable V60.15.2Z V50.15.2Z V53.15.5Z V53.17.1Z V54.16.1Z V61.15.6Z, —

V56.15.6Z

ip.smtp.server_addr V60.15.2Z V53.15.5Z, V53.15.5Z V53.17.1Z V54.16.1Z V61.15.6Z, —

V50.15.2Z V56.15.6Z

ip.snmp.enable V60.15.2Z V50.15.2Z V53.15.5Z V53.17.1Z V54.16.1Z V61.15.6Z, —

V56.15.6Z

ip.snmp.get_community_name V60.15.2Z V53.15.5Z, V53.15.5Z V53.17.1Z V54.16.1Z V61.15.6Z, —

V50.15.2Z V56.15.6Z

* On these printers with ZebraNet™ 10/100 Internal Print Server.

** On these printers with ZebraNet™ 10/100 External Print Server, firmware version 1.1.5

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Command Support 1027
Printer and Firmware Compatibility

Table 47 • SGD Standard Printer and Firmware Compatibility (Continued)

XiIIIPlus,
105SL,
ZM400,
PAX4, S4M Xi4 HC100 G-Series KR403
ZM600
SGD Commands Z4MPlus,
Z6MPlus

ip.snmp.set_community_name V60.15.2Z V53.15.5Z, V53.15.5Z V53.17.1Z V54.16.1Z V61.15.6Z, —

V50.15.2Z V56.15.6Z

ip.tcp.enable V60.15.2Z V50.15.2Z V53.15.5Z V53.17.1Z V54.16.1Z V61.15.6Z, —

V56.15.6Z

ip.telnet.enable V60.15.2Z V50.15.2Z V53.15.5Z V53.17.1Z V54.16.1Z V61.15.6Z, —

V56.15.6Z

ip.udp.enable V60.15.2Z V50.15.2Z V53.15.5Z V53.17.1Z V54.16.1Z V61.15.6Z, —

V56.15.6Z

media.cartridge.part_number — — — — V54.16.5Z — —

media.cut_now — — — — — — V66.17.2Z

media.darkness_mode — — — — V54.16.1Z — —

media.media_low.external — — — — — — V66.17.2Z

media.media_low.warning — — — V53.17.1Z — — —

media.present.cut_amount — — — — — — V66.17.2Z

media.present.cut_margin — — — — — — V66.17.2Z

media.present.eject — — — — — — V66.17.2Z

media.present.length_addition — — — — — — V66.17.2Z

media.present.loop_length — — — — — — V66.17.2Z

media.present.loop_length_max — — — — — — V66.17.2Z

media.present.present_timeout — — — — — — V66.17.2Z

media.present.present_type — — — — — — V66.17.2Z

media.printmode V60.15.8Z V53.15.5Z V53.15.5Z V53.17.1Z V54.16.1Z V61.15.6Z, —

V56.15.6Z

media.speed V60.16.4Z V53.16.4Z V53.16.4Z V53.17.1Z V54.16.1Z V61.16.6Z, —

V56.16.6Z

odometer.headclean V60.15.8Z V53.15.5Z V53.15.5Z V53.17.1Z V54.16.1Z V61.15.6Z, —

V56.15.6Z

odometer.headnew V60.15.8Z V53.15.5Z V53.15.5Z V53.17.1Z V54.16.1Z V61.15.6Z, —

V56.15.6Z

odometer.label_dot_length V60.15.8Z V53.15.5Z V53.15.5Z V53.17.1Z V54.16.1Z V61.15.6Z, —

V56.15.6Z

odometer.media_marker_count1 V60.15.8Z V53.15.5Z V53.15.5Z V53.17.1Z V54.16.1Z V61.15.6Z, —

V56.15.6Z

odometer.media_marker_count2 V60.15.8Z V53.15.5Z V53.15.5Z V53.17.1Z V54.16.1Z V61.15.6Z, —

V56.15.6Z

odometer.retracts_count — — — — — — V66.17.2Z

odometer.total_print_length V60.15.8Z V53.15.5Z V53.15.5Z V53.17.1Z V54.16.1Z V61.15.6Z, —

V56.15.6Z

print.tone V60.16.4Z V53.16.4Z V53.16.4Z V53.17.1Z V54.16.1Z V61.16.6Z, —

V56.16.6Z

wlan.adhocautomode V60.15.2Z V50.15.2Z V53.15.5Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

wlan.adhocchannel V60.15.2Z V50.15.2Z V53.15.5Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

wlan.associated V60.15.2Z V50.15.2Z V53.15.5Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

* On these printers with ZebraNet™ 10/100 Internal Print Server.

** On these printers with ZebraNet™ 10/100 External Print Server, firmware version 1.1.5

6/8/10 Zebra Programming Guide P1012728-004

1028 SGD Command Support
Printer and Firmware Compatibility

Table 47 • SGD Standard Printer and Firmware Compatibility (Continued)

XiIIIPlus,
105SL,
ZM400,
PAX4, S4M Xi4 HC100 G-Series KR403
ZM600
SGD Commands Z4MPlus,
Z6MPlus

wlan.bssid V60.16.4Z V53.16.4Z V53.16.4Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

wlan.channel V60.16.4Z V53.16.4Z V53.16.4Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

wlan.channel_mask V60.15.2Z V50.15.2Z V53.15.5Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

wlan.current_tx_rate V60.16.4Z V53.16.4Z V53.16.4Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

wlan.essid V60.15.2Z V50.15.2Z V53.15.5Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

wlan.firmware_version V60.15.2Z V50.15.2Z V53.15.5Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

wlan.ip.addr V60.15.8Z V53.15.5Z V53.15.5Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

wlan.ip.arp_interval V60.15.8Z V53.15.5Z V53.15.5Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

wlan.ip.default_addr_enable V60.15.8Z V53.15.5Z V53.15.5Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

wlan.ip.dhcp.cache_ip V60.16.4Z V53.16.4Z V53.16.4Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

wlan.ip.dhcp.cid_all V60.15.8Z V53.15.5Z V53.15.5Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

wlan.ip.dhcp.cid_enable V60.15.8Z V53.15.5Z V53.15.5Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

wlan.ip.dhcp.cid_prefix V60.15.8Z V53.15.5Z V53.15.5Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

wlan.ip.dhcp.cid_suffix V60.15.8Z V53.15.5Z V53.15.5Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

wlan.ip.dhcp.cid_type V60.15.8Z V53.15.5Z V53.15.5Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

wlan.ip.dhcp.lease.last_attempt V60.16.4Z V53.16.4Z V53.16.4Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

wlan.ip.dhcp.lease.length V60.16.4Z V53.16.4Z V53.16.4Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

wlan.ip.dhcp.lease.server V60.16.4Z V53.16.4Z V53.16.4Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

wlan.ip.dhcp.lease.time_left V60.16.4Z V53.16.4Z V53.16.4Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

wlan.ip.dhcp.option12 V60.16.4Z V53.16.4Z V53.16.4Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

wlan.ip.dhcp.option12_format V60.16.4Z V53.16.4Z V53.16.4Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

wlan.ip.dhcp.option12_value V60.16.4Z V53.16.4Z V53.16.4Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

wlan.ip.dhcp.request_timeout V60.16.4Z V53.16.4Z V53.16.4Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

wlan.ip.dhcp.requests_per_session V60.16.4Z V53.16.4Z V53.16.4Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

wlan.ip.dhcp.session_interval V60.16.4Z V53.16.4Z V53.16.4Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

* On these printers with ZebraNet™ 10/100 Internal Print Server.

** On these printers with ZebraNet™ 10/100 External Print Server, firmware version 1.1.5

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Command Support 1029
Printer and Firmware Compatibility

Table 47 • SGD Standard Printer and Firmware Compatibility (Continued)

XiIIIPlus,
105SL,
ZM400,
PAX4, S4M Xi4 HC100 G-Series KR403
ZM600
SGD Commands Z4MPlus,
Z6MPlus

wlan.ip.gateway V60.15.8Z V53.15.5Z V53.15.5Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

wlan.ip.netmask V60.15.8Z V53.15.5Z V53.15.5Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

wlan.ip.port V60.15.8Z V53.15.5Z V53.15.5Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

wlan.ip.protocol V60.15.8Z V53.15.5Z V53.15.5Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

wlan.ip.timeout.enable V60.15.8Z V53.15.5Z V53.15.5Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

wlan.ip.timeout.value V60.15.8Z V53.15.5Z V53.15.5Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

wlan.keep_alive.enable V60.15.2Z V50.15.2Z V53.15.5Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

wlan.keep_alive.timeout V60.15.2Z V50.15.2Z V53.15.5Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

wlan.kerberos.kdc V60.15.2Z V50.15.2Z V53.15.5Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

wlan.kerberos.password V60.15.2Z V50.15.2Z V53.15.5Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

wlan.kerberos.realm V60.15.2Z V50.15.2Z V53.15.5Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

wlan.kerberos.username V60.15.2Z V50.15.2Z V53.15.5Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

wlan.mac_addr V60.15.8Z V53.15.5Z V53.15.5Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

wlan.mac_raw V60.16.4Z V53.16.4Z V53.16.4Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

wlan.operating_mode V60.15.2Z V50.15.2Z V53.15.5Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

wlan.password V60.15.2Z V50.15.2Z V53.15.5Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

wlan.preamble V60.15.2Z V50.15.2Z V53.15.5Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

wlan.private_key_password V60.15.2Z V50.15.2Z V53.15.5Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

wlan.roam.interchannel_delay V60.16.4Z V53.16.4Z V53.16.4Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

wlan.roam.interval V60.15.2Z V50.15.2Z V53.15.5Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

wlan.roam.max_chan_scan_time V60.16.4Z V53.16.4Z V53.16.4Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

wlan.roam.signal V60.15.2Z V50.15.2Z V53.15.5Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

wlan.security V60.15.2Z V50.15.2Z V53.15.5Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

wlan.signal_noise V60.15.2Z V50.15.2Z V53.15.5Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

wlan.signal_quality V60.15.2Z V50.15.2Z V53.15.5Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

* On these printers with ZebraNet™ 10/100 Internal Print Server.

** On these printers with ZebraNet™ 10/100 External Print Server, firmware version 1.1.5

6/8/10 Zebra Programming Guide P1012728-004

1030 SGD Command Support
Printer and Firmware Compatibility

Table 47 • SGD Standard Printer and Firmware Compatibility (Continued)

XiIIIPlus,
105SL,
ZM400,
PAX4, S4M Xi4 HC100 G-Series KR403
ZM600
SGD Commands Z4MPlus,
Z6MPlus

wlan.signal_strength V60.15.2Z V50.15.2Z V53.15.5Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

wlan.station_name V60.15.2Z V50.15.2Z V53.15.5Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

wlan.tx_power V60.15.2Z V50.15.2Z V53.15.5Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

wlan.tx_rate V60.15.2Z V50.15.2Z V53.15.5Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

wlan.username V60.15.2Z V50.15.2Z V53.15.5Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

wlan.wep.auth_type V60.15.2Z V50.15.2Z V53.15.5Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

wlan.wep.index V60.15.2Z V50.15.2Z V53.15.5Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

wlan.wep.key_format V60.15.2Z V50.15.2Z V53.15.5Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

wlan.wep.key1 V60.15.2Z V50.15.2Z V53.15.5Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

wlan.wep.key2 V60.15.2Z V50.15.2Z V53.15.5Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

wlan.wep.key3 V60.15.2Z V50.15.2Z V53.15.5Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

wlan.wep.key4 V60.15.2Z V50.15.2Z V53.15.5Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

wlan.wpa.psk V60.15.2Z V50.15.2Z V53.15.5Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

zbi.control.add_breakpoint V60.16.2Z V53.16.2Z V53.16.2Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

zbi.control.break V60.16.2Z V53.16.2Z V53.16.2Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

zbi.control.clear_breakpoints V60.16.2Z V53.16.2Z V53.16.2Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

zbi.control.delete_breakpoint V60.16.2Z V53.16.2Z V53.16.2Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

zbi.control.line_number V60.16.2Z V53.16.2Z V53.16.2Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

zbi.control.restart V60.16.2Z V53.16.2Z V53.16.2Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

zbi.control.run V60.16.2Z V53.16.2Z V53.16.2Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

zbi.control.step V60.16.2Z V53.16.2Z V53.16.2Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

zbi.control.terminate V60.16.2Z V53.16.2Z V53.16.2Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

zbi.control.variable_name V60.16.2Z V53.16.2Z V53.16.2Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

zbi.control.variable_value V60.16.2Z V53.16.2Z V53.16.2Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

zbi.key V60.16.2Z V53.16.2Z V53.16.2Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

* On these printers with ZebraNet™ 10/100 Internal Print Server.

** On these printers with ZebraNet™ 10/100 External Print Server, firmware version 1.1.5

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Command Support 1031
Printer and Firmware Compatibility

Table 47 • SGD Standard Printer and Firmware Compatibility (Continued)

XiIIIPlus,
105SL,
ZM400,
PAX4, S4M Xi4 HC100 G-Series KR403
ZM600
SGD Commands Z4MPlus,
Z6MPlus

zbi.last_error V60.16.2Z V53.16.2Z V53.16.2Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

zbi.reseller_key V60.16.2Z V53.16.2Z V53.16.2Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

zbi.revision V60.16.2Z V53.16.2Z V53.16.2Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

zbi.running_program_name V60.16.2Z V53.16.2Z V53.16.2Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

zbi.start_info.execute V60.16.2Z V53.16.2Z V53.16.2Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

zbi.start_info.file_name V60.16.2Z V53.16.2Z V53.16.2Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

zbi.start_info.memory_alloc V60.16.2Z V53.16.2Z V53.16.2Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

zbi.state V60.16.2Z V53.16.2Z V53.16.2Z V53.17.1Z V54.16.1Z V61.16.5Z, —

V56.16.5Z

* On these printers with ZebraNet™ 10/100 Internal Print Server.

** On these printers with ZebraNet™ 10/100 External Print Server, firmware version 1.1.5

6/8/10 Zebra Programming Guide P1012728-004

1032 SGD Command Support
Printer and Firmware Compatibility

RFID Printers

Important • All the firmware versions noted in Table 48 refer to minimum firmware version
required. For non-RFID printers, see Table 47. Once an RFID Ready printer has been
reconfigured as a RFID Printer, Table 48 should be used.
For commands not listed in Table 48, refer to Table 47 and compare your firmware version to
the Vxx.xx.xx firmware to which it most closely corresponds.

Table 48 • SGD RFID Printer and Firmware Compatibility

R110Xi (UHF) RZ400/

RXi4
SGD Commands and R170Xi R110PAX4 R4Mplus R110Xi HF RZ600

card.inserted R60.15.8Z R62.15.8Z SP994P R65.15.8Z V53.17.7Z R53.16.3Z

R63.15.8Z SP999F V53.17.7Z
SP1027F
SP1056E
SP1082F

card.mac_addr R60.15.8Z R62.15.8Z SP994P R65.15.8Z V53.17.7Z R53.16.3Z

R63.15.8Z SP999F V53.17.7Z
SP1027F
SP1056E
SP1082F

ip.addr R60.15.8Z R62.15.8Z SP994P R65.15.8Z V53.17.7Z R53.16.3Z

R63.15.8Z SP999F V53.17.7Z
SP1027F
SP1056E
SP1082F

ip.arp_interval R60.15.8Z R62.15.8Z SP994P R65.15.8Z V53.17.7Z R53.16.3Z

R63.15.8Z SP999F V53.17.7Z
SP1027F
SP1056E
SP1082F

ip.bootp.enable R60.15.8Z R62.15.8Z SP994P R65.15.8Z V53.17.7Z R53.16.3Z

R63.15.8Z SP999F V53.17.7Z
SP1027F
SP1056E
SP1082F

ip.dhcp.cid_all R60.15.8Z R62.15.8Z SP994P R65.15.8Z V53.17.7Z R53.16.3Z

R63.15.8Z SP999F V53.17.7Z
SP1027F
SP1056E
SP1082F

ip.dhcp.cid_enable R60.15.8Z R62.15.8Z SP994P R65.15.8Z V53.17.7Z R53.16.3Z

R63.15.8Z SP999F V53.17.7Z
SP1027F
SP1056E
SP1082F

ip.dhcp.cid_prefix R60.15.8Z R62.15.8Z SP994P R65.15.8Z V53.17.7Z R53.16.3Z

R63.15.8Z SP999F V53.17.7Z
SP1027F
SP1056E
SP1082F

ip.dhcp.cid_suffix R60.15.8Z R62.15.8Z SP994P R65.15.8Z V53.17.7Z R53.16.3Z

R63.15.8Z SP999F V53.17.7Z
SP1027F
SP1056E
SP1082F

ip.dhcp.cid_type R60.15.8Z R62.15.8Z SP994P R65.15.8Z V53.17.7Z R53.16.3Z

R63.15.8Z SP999F V53.17.7Z
SP1027F
SP1056E
SP1082F

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Command Support 1033
Printer and Firmware Compatibility

Table 48 • SGD RFID Printer and Firmware Compatibility

R110Xi (UHF) RZ400/

RXi4
SGD Commands and R170Xi R110PAX4 R4Mplus R110Xi HF RZ600

ip.dhcp.enable R60.15.8Z R62.15.8Z SP994P R65.15.8Z V53.17.7Z R53.16.3Z

R63.15.8Z SP999F V53.17.7Z
SP1027F
SP1056E
SP1082F

ip.ftp.enable R60.15.8Z R62.15.8Z SP994P R65.15.8Z V53.17.7Z R53.16.3Z

R63.15.8Z SP999F V53.17.7Z
SP1027F
SP1056E
SP1082F

ip.gateway R60.15.8Z R62.15.8Z SP994P R65.15.8Z V53.17.7Z R53.16.3Z

R63.15.8Z SP999F V53.17.7Z
SP1027F
SP1056E
SP1082F

ip.http.enable R60.15.8Z R62.15.8Z SP994P R65.15.8Z V53.17.7Z R53.16.3Z

R63.15.8Z SP999F V53.17.7Z
SP1027F
SP1056E
SP1082F

ip.lpd.enable R60.15.8Z R62.15.8Z SP994P R65.15.8Z V53.17.7Z R53.16.3Z

R63.15.8Z SP999F V53.17.7Z
SP1027F
SP1056E
SP1082F

ip.netmask R60.15.8Z R62.15.8Z SP994P R65.15.8Z V53.17.7Z R53.16.3Z

R63.15.8Z SP999F V53.17.7Z
SP1027F
SP1056E
SP1082F

ip.pop3.enable R60.15.8Z R62.15.8Z SP994P R65.15.8Z V53.17.7Z R53.16.3Z

R63.15.8Z SP999F V53.17.7Z
SP1027F
SP1056E
SP1082F

ip.pop3.password R60.15.8Z R62.15.8Z SP994P R65.15.8Z V53.17.7Z R53.16.3Z

R63.15.8Z SP999F V53.17.7Z
SP1027F
SP1056E
SP1082F

ip.pop3.poll R60.15.8Z R62.15.8Z SP994P R65.15.8Z V53.17.7Z R53.16.3Z

R63.15.8Z SP999F V53.17.7Z
SP1027F
SP1056E
SP1082F

ip.pop3.server_addr R60.15.8Z R62.15.8Z SP994P R65.15.8Z V53.17.7Z R53.16.3Z

R63.15.8Z SP999F V53.17.7Z
SP1027F
SP1056E
SP1082F

ip.pop3.username R60.15.8Z R62.15.8Z SP994P R65.15.8Z V53.17.7Z R53.16.3Z

R63.15.8Z SP999F V53.17.7Z
SP1027F
SP1056E
SP1082F

ip.port R60.15.8Z R62.15.8Z SP994P R65.15.8Z V53.17.7Z R53.16.3Z

R63.15.8Z SP999F V53.17.7Z
SP1027F
SP1056E
SP1082F

ip.primary_network R60.15.8Z R62.15.8Z SP994P R65.15.8Z V53.17.7Z R53.16.3Z

R63.15.8Z SP999F V53.17.7Z
SP1027F
SP1056E
SP1082F

6/8/10 Zebra Programming Guide P1012728-004

1034 SGD Command Support
Printer and Firmware Compatibility

Table 48 • SGD RFID Printer and Firmware Compatibility

R110Xi (UHF) RZ400/

RXi4
SGD Commands and R170Xi R110PAX4 R4Mplus R110Xi HF RZ600

ip.smtp.domain R60.15.8Z R62.15.8Z SP994P R65.15.8Z V53.17.7Z R53.16.3Z

R63.15.8Z SP999F V53.17.7Z
SP1027F
SP1056E
SP1082F

ip.smtp.enable R60.15.8Z R62.15.8Z SP994P R65.15.8Z V53.17.7Z R53.16.3Z

R63.15.8Z SP999F V53.17.7Z
SP1027F
SP1056E
SP1082F

ip.smtp.server_addr R60.15.8Z R62.15.8Z SP994P R65.15.8Z V53.17.7Z R53.16.3Z

R63.15.8Z SP999F V53.17.7Z
SP1027F
SP1056E
SP1082F

ip.snmp.enable R60.15.8Z R62.15.8Z SP994P R65.15.8Z V53.17.7Z R53.16.3Z

R63.15.8Z SP999F V53.17.7Z
SP1027F
SP1056E
SP1082F

ip.snmp.get_community_name R60.15.8Z R62.15.8Z SP994P R65.15.8Z V53.17.7Z R53.16.3Z

R63.15.8Z SP999F V53.17.7Z
SP1027F
SP1056E
SP1082F

ip.snmp.set_community_name R60.15.8Z R62.15.8Z SP994P R65.15.8Z V53.17.7Z R53.16.3Z

R63.15.8Z SP999F V53.17.7Z
SP1027F
SP1056E
SP1082F

ip.tcp.enable R60.15.8Z R62.15.8Z SP994P R65.15.8Z V53.17.7Z R53.16.3Z

R63.15.8Z SP999F V53.17.7Z
SP1027F
SP1056E
SP1082F

ip.telnet.enable R60.15.8Z R62.15.8Z SP994P R65.15.8Z V53.17.7Z R53.16.3Z

R63.15.8Z SP999F V53.17.7Z
SP1027F
SP1056E
SP1082F

ip.udp.enable R60.15.8Z R62.15.8Z SP994P R65.15.8Z V53.17.7Z R53.16.3Z

R63.15.8Z SP999F V53.17.7Z
SP1027F
SP1056E
SP1082F

media.printmode — — — — V53.17.7Z R53.16.3Z

V53.17.7Z

odometer.rfid.valid_resettable — — — — V53.17.7Z R53.16.3Z

V53.17.7Z

odometer.rfid.void_resettable — — — — V53.17.7Z R53.16.3Z

V53.17.7Z

rfid.error.response R60.15.8Z R62.15.8Z SP994P R65.15.8Z V53.17.7Z R53.16.3Z

R63.15.8Z SP999F V53.17.7Z
SP1027F
SP1056E
SP1082F

rfid.position.program R60.15.8Z R62.15.8Z SP994P R65.15.8Z V53.17.7Z R53.16.3Z

R63.15.8Z SP999F V53.17.7Z
SP1027F
SP1056E
SP1082F

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Command Support 1035
Printer and Firmware Compatibility

Table 48 • SGD RFID Printer and Firmware Compatibility

R110Xi (UHF) RZ400/

RXi4
SGD Commands and R170Xi R110PAX4 R4Mplus R110Xi HF RZ600

rfid.reader_1.antenna_port R60.15.8Z R62.15.8Z SP994P R65.15.8Z V53.17.7Z R53.16.3Z

R63.15.8Z SP999F V53.17.7Z
SP1027F
SP1056E
SP1082F

rfid.reader_1.power.read R60.15.8Z R62.15.8Z SP994P R65.15.8Z V53.17.7Z R53.16.3Z

R63.15.8Z SP999F V53.17.7Z
SP1027F
SP1056E
SP1082F

rfid.reader_1.power.single_power R60.15.8Z R62.15.8Z SP994P R65.15.8Z V53.17.7Z R53.16.3Z

R63.15.8Z SP999F V53.17.7Z
SP1027F
SP1056E
SP1082F

rfid.reader_1.power.write R60.15.8Z R62.15.8Z SP994P R65.15.8Z V53.17.7Z R53.16.3Z

R63.15.8Z SP999F V53.17.7Z
SP1027F
SP1056E
SP1082F

rfid.tag.calibrate R60.15.8Z R62.15.8Z SP994P R65.15.8Z V53.17.7Z R53.16.3Z

R63.15.8Z SP999F V53.17.7Z
SP1027F
SP1056E
SP1082F

rfid.tag.data R60.15.8Z R62.15.8Z SP994P R65.15.8Z V53.17.7Z R53.16.3Z

R63.15.8Z SP999F V53.17.7Z
SP1027F
SP1056E
SP1082F

rfid.tag.test R60.15.8Z R62.15.8Z SP994P R65.15.8Z V53.17.7Z R53.16.3Z

R63.15.8Z SP999F V53.17.7Z
SP1027F
SP1056E
SP1082F

rfid.tag.type R60.15.8Z R62.15.8Z SP994P R65.15.8Z V53.17.7Z R53.16.3Z

R63.15.8Z SP999F V53.17.7Z
SP1027F
SP1056E
SP1082F

wlan.adhocautomode R60.15.8Z R62.15.8Z SP994P R65.15.8Z V53.17.7Z R53.16.3Z

R63.15.8Z SP999F V53.17.7Z
SP1027F
SP1056E
SP1082F

wlan.adhocchannel R60.15.8Z R62.15.8Z SP994P R65.15.8Z V53.17.7Z R53.16.3Z

R63.15.8Z SP999F V53.17.7Z
SP1027F
SP1056E
SP1082F

wlan.associated R60.15.8Z R62.15.8Z SP994P R65.15.8Z V53.17.7Z R53.16.3Z

R63.15.8Z SP999F V53.17.7Z
SP1027F
SP1056E
SP1082F

wlan.channel_mask R60.15.8Z R62.15.8Z SP994P R65.15.8Z V53.17.7Z R53.16.3Z

R63.15.8Z SP999F V53.17.7Z
SP1027F
SP1056E
SP1082F

wlan.essid R60.15.8Z R62.15.8Z SP994P R65.15.8Z V53.17.7Z R53.16.3Z

R63.15.8Z SP999F V53.17.7Z
SP1027F
SP1056E
SP1082F

6/8/10 Zebra Programming Guide P1012728-004

1036 SGD Command Support
Printer and Firmware Compatibility

Table 48 • SGD RFID Printer and Firmware Compatibility

R110Xi (UHF) RZ400/

RXi4
SGD Commands and R170Xi R110PAX4 R4Mplus R110Xi HF RZ600

wlan.firmware_version R60.15.8Z R62.15.8Z SP994P R65.15.8Z V53.17.7Z R53.16.3Z

R63.15.8Z SP999F V53.17.7Z
SP1027F
SP1056E
SP1082F

wlan.keep_alive.enable R60.15.8Z R62.15.8Z SP994P R65.15.8Z V53.17.7Z R53.16.3Z

R63.15.8Z SP999F V53.17.7Z
SP1027F
SP1056E
SP1082F

wlan.keep_alive.timeout R60.15.8Z R62.15.8Z SP994P R65.15.8Z V53.17.7Z R53.16.3Z

R63.15.8Z SP999F V53.17.7Z
SP1027F
SP1056E
SP1082F

wlan.kerberos.kdc R60.15.8Z R62.15.8Z SP994P R65.15.8Z V53.17.7Z R53.16.3Z

R63.15.8Z SP999F V53.17.7Z
SP1027F
SP1056E
SP1082F

wlan.kerberos.password R60.15.8Z R62.15.8Z SP994P R65.15.8Z V53.17.7Z R53.16.3Z

R63.15.8Z SP999F V53.17.7Z
SP1027F
SP1056E
SP1082F

wlan.kerberos.realm R60.15.8Z R62.15.8Z SP994P R65.15.8Z V53.17.7Z R53.16.3Z

R63.15.8Z SP999F V53.17.7Z
SP1027F
SP1056E
SP1082F

wlan.kerberos.username R60.15.8Z R62.15.8Z SP994P R65.15.8Z V53.17.7Z R53.16.3Z

R63.15.8Z SP999F V53.17.7Z
SP1027F
SP1056E
SP1082F

wlan.operating_mode R60.15.8Z R62.15.8Z SP994P R65.15.8Z V53.17.7Z R53.16.3Z

R63.15.8Z SP999F V53.17.7Z
SP1027F
SP1056E
SP1082F

wlan.password R60.15.8Z R62.15.8Z SP994P R65.15.8Z V53.17.7Z R53.16.3Z

R63.15.8Z SP999F V53.17.7Z
SP1027F
SP1056E
SP1082F

wlan.preamble R60.15.8Z R62.15.8Z SP994P R65.15.8Z V53.17.7Z R53.16.3Z

R63.15.8Z SP999F V53.17.7Z
SP1027F
SP1056E
SP1082F

wlan.private_key_password R60.15.8Z R62.15.8Z SP994P R65.15.8Z V53.17.7Z R53.16.3Z

R63.15.8Z SP999F V53.17.7Z
SP1027F
SP1056E
SP1082F

wlan.roam.interval R60.15.8Z R62.15.8Z SP994P R65.15.8Z V53.17.7Z R53.16.3Z

R63.15.8Z SP999F V53.17.7Z
SP1027F
SP1056E
SP1082F

wlan.roam.signal R60.15.8Z R62.15.8Z SP994P R65.15.8Z V53.17.7Z R53.16.3Z

R63.15.8Z SP999F V53.17.7Z
SP1027F
SP1056E
SP1082F

P1012728-004 Zebra Programming Guide 6/8/10

 SGD Command Support 1037
Printer and Firmware Compatibility

Table 48 • SGD RFID Printer and Firmware Compatibility

R110Xi (UHF) RZ400/

RXi4
SGD Commands and R170Xi R110PAX4 R4Mplus R110Xi HF RZ600

wlan.security R60.15.8Z R62.15.8Z SP994P R65.15.8Z V53.17.7Z R53.16.3Z

R63.15.8Z SP999F V53.17.7Z
SP1027F
SP1056E
SP1082F

wlan.signal_noise R60.15.8Z R62.15.8Z SP994P R65.15.8Z V53.17.7Z R53.16.3Z

R63.15.8Z SP999F V53.17.7Z
SP1027F
SP1056E
SP1082F

wlan.signal_quality R60.15.8Z R62.15.8Z SP994P R65.15.8Z V53.17.7Z R53.16.3Z

R63.15.8Z SP999F V53.17.7Z
SP1027F
SP1056E
SP1082F

wlan.signal_strength R60.15.8Z R62.15.8Z SP994P R65.15.8Z V53.17.7Z R53.16.3Z

R63.15.8Z SP999F V53.17.7Z
SP1027F
SP1056E
SP1082F

wlan.station_name R60.15.8Z R62.15.8Z SP994P R65.15.8Z V53.17.7Z R53.16.3Z

R63.15.8Z SP999F V53.17.7Z
SP1027F
SP1056E
SP1082F

wlan.tx_power R60.15.8Z R62.15.8Z SP994P R65.15.8Z V53.17.7Z R53.16.3Z

R63.15.8Z SP999F V53.17.7Z
SP1027F
SP1056E
SP1082F

wlan.tx_rate R60.15.8Z R62.15.8Z SP994P R65.15.8Z V53.17.7Z R53.16.3Z

R63.15.8Z SP999F V53.17.7Z
SP1027F
SP1056E
SP1082F

wlan.username R60.15.8Z R62.15.8Z SP994P R65.15.8Z V53.17.7Z R53.16.3Z

R63.15.8Z SP999F V53.17.7Z
SP1027F
SP1056E
SP1082F

wlan.wep.auth_type R60.15.8Z R62.15.8Z SP994P R65.15.8Z V53.17.7Z R53.16.3Z

R63.15.8Z SP999F V53.17.7Z
SP1027F
SP1056E
SP1082F

wlan.wep.index R60.15.8Z R62.15.8Z SP994P R65.15.8Z V53.17.7Z R53.16.3Z

R63.15.8Z SP999F V53.17.7Z
SP1027F
SP1056E
SP1082F

wlan.wep.key_format R60.15.8Z R62.15.8Z SP994P R65.15.8Z V53.17.7Z R53.16.3Z

R63.15.8Z SP999F V53.17.7Z
SP1027F
SP1056E
SP1082F

wlan.wep.key1 R60.15.8Z R62.15.8Z SP994P R65.15.8Z V53.17.7Z R53.16.3Z

R63.15.8Z SP999F V53.17.7Z
SP1027F
SP1056E
SP1082F

wlan.wep.key2 R60.15.8Z R62.15.8Z SP994P R65.15.8Z V53.17.7Z R53.16.3Z

R63.15.8Z SP999F V53.17.7Z
SP1027F
SP1056E
SP1082F

6/8/10 Zebra Programming Guide P1012728-004

1038 SGD Command Support
Printer and Firmware Compatibility

Table 48 • SGD RFID Printer and Firmware Compatibility

R110Xi (UHF) RZ400/

RXi4
SGD Commands and R170Xi R110PAX4 R4Mplus R110Xi HF RZ600

wlan.wep.key3 R60.15.8Z R62.15.8Z SP994P R65.15.8Z V53.17.7Z R53.16.3Z

R63.15.8Z SP999F V53.17.7Z
SP1027F
SP1056E
SP1082F

wlan.wep.key4 R60.15.8Z R62.15.8Z SP994P R65.15.8Z V53.17.7Z R53.16.3Z

R63.15.8Z SP999F V53.17.7Z
SP1027F
SP1056E
SP1082F

wlan.wpa.psk R60.15.8Z R62.15.8Z SP994P R65.15.8Z V53.17.7Z R53.16.3Z

R63.15.8Z SP999F V53.17.7Z
SP1027F
SP1056E
SP1082F

P1012728-004 Zebra Programming Guide 6/8/10

 K
Firmware Features

This appendix covers features added to major firmware releases.

6/8/10 Zebra Programming Guide P1012728-004

1040 Features
Firmware x.17

Firmware x.17
Identifies features that are available in printers with firmware version Vx.17.x or later.

The following is an overview of the new and enhanced features available in firmware version
V53.17.x, V56.17.xZ, V60.17.x, V61.17.xZ, and later.

Mirror
Mirror is a feature that gives you the ability to:
• Centrally manage and monitor the deployment of your Zebra printers
• Centrally configure and maintain your Zebra printers through remote updates
• Remotely monitor printer updates – via the “Feedback” feature
• There are several Set/Get/Do (SGD) commands that can initiate Mirror. For details see
Mirror Printer Configuration on page 1061.

Benefits
• When using Mirror, updating the configuration and firmware on the printer is remotely
managed from a centralized FTP server. Configurations can be uniformly deployed to
individual printers or to groups of printers. Unique configurations can also be targeted to
printers as needed. Through the “Feedback” feature, Administrators can easily log and
monitor configuration updates on a printer-by-printer basis. Typical uses of Mirror include:
• Configuring printers as they are first received.
• Performing scheduled maintenance updates, sending firmware, fonts, graphics and other
objects to the printer as needed.
• Changing printer configurations in order to move printers from one role to another.
• Supported printers and print servers:

Printer Print Servers

Xi4™ -series • Internal, Integrated 10/100 IPV4 wired
• Internal Wireless Plus
ZM400™ • Internal, Integrated 10/100 IPV4 wired
• Internal Wireless Plus
ZM600™ • Internal, Integrated 10/100 IPV4 wired
• Internal Wireless Plus
S4M™ • Internal Wireless Plus
Print Servers connected to the parallel port, either externally or internally, are not
supported for Mirror use.

P1012728-004 Zebra Programming Guide 6/8/10

 Features 1041
Firmware x.16

Wireless Markup Language (WML)

WML offers a text-based method of designing customized menus on the LCD front panel of
selected printers. By leveraging Set-Get-Do (SGD) and Zebra Programming Language (ZPL)
commands, menus that feature both display and command features can be created. The WML
“card” structure makes it possible to link from one menu screen to another, creating menus that
are as many levels “deep” as desired or reduced to only those options needed by the printer
operator.

Firmware x.16
Identifies features that are available in printers with firmware version V60.16.x, V53.16.x, or
later.

The following is an overview of the new and enhanced features available in firmware version
V53.16.x and V60.16.x, and later; it is ZBI 2.0-Ready. These include:
• ZBI 2.0 can be enabled by placing a ZBI 2.0 key on the printer via the ZBI Key Manager
& Downloader utility. Printers can be ordered from the factory with the ZBI 2.0 option
enabled. Printers can be ZBI-Enabled in the field by purchasing and using a ZBI Key Kit.
Printers can be ZBI-Enabled in the field by purchasing a key at www.zebrasoftware.com.
• Printers which have been ZBI-Enabled will not display a “Z” at the end of the firmware
version string. For example, a printer which has been ZBI-Enabled will display the
firmware version as “V53.16.1”, while a printer which has not been ZBI-Enabled will
display the firmware version as “V53.16.1Z”
• The printer configuration label will display the ZBI status for the printer:
• ZBI-Enabled

• Not ZBI-Enabled

• The printer configuration label will list which ZBI program is running.

• ZBI 2.0 is backwards compatible with previous versions of ZBI. Any code which was
specifically written to handle a maximum string length of 255 characters will need to be
reviewed to ensure it works with unlimited string lengths.
• Other ZBI 2.0 Features:
• List ZBI programs from the front panel
• Start/Stop ZBI programs from the front panel

6/8/10 Zebra Programming Guide P1012728-004

1042 Features
Firmware x.16

• Button presses on front panel can be registered as events in ZBI programs.

• Applicator port control
• Support for longer strings, the length of the string dependent on available memory.
• Support for NULL values in Strings and String operations
• SNMP & Set/Get/Do (SGD) Control of ZBI
• On-printer Debugging (via ZBI-Developer)
• ZBI 2.0 Program Encryption
• ZBI 2.0 programs can be made hidden and/or persistent
• New ZBI 2.0 Commands:

ACCEPT INTTOHEX$
ADDBREAK READ
AUXPORT_GETPIN REGISTEREVENTS
AUXPORT_RELEASEPIN SERVERSOCKET
AUXPORT_SETPIN SPLIT
AUXPORT_STEALPIN SPLITCOUNT
CLIENTSOCKET SUB
CLOSE ALL TCPX
DELBREAK TRIGGEREVENT
HANDLEEVENT UNREGISTEREVENTS
HEXTOINT WRITE

P1012728-004 Zebra Programming Guide 6/8/10

 Features 1043
Firmware x.15

Firmware x.15
Identifies features that are available in printers with firmware version V60.15.x, V50.15.x, or
later.

The following is an overview of the new and enhanced features available in firmware version
V60.15.x, V50.15.x, or later. These include:
• Additional wireless securities
• New and updated ZPL commands (including wireless commands)
• Extended SNMP features, providing SNMP based control over commonly-needed printer
settings.
• Support for Set / Get / Do (SGD) commands

Wireless Securities
Firmware V60.15.x and V50.15.x offer support for a wider range of wireless securities. These
are the supported wireless securities:
• WEP-40-BIT
• WEP-128-BIT
• EAP-TLS
• EAP-TTLS
• EAP-FAST
• PEAP
• LEAP
• WPA-PSK
• WPA EAP-TLS
• WPA EAP-TTLS
• WPA EAP-FAST
• WPA PEAP
• WPA LEAP
• KERBEROS*

* Use of any given wireless security is dependent on the RF card being used.

6/8/10 Zebra Programming Guide P1012728-004

1044 Features
Firmware x.15

ZPL and SGD Commands

Table 49 identifies the new commands and updates to existing commands in firmware version
V60.15.x, V50.15.x, or later. The bolded items are either new commands or new
enhancements to existing commands.

Table 49 • x.15 Features in Detail

Command Details
^KC The ^KC command is a new command with firmware version V60.15.x,
V50.15.x, or later. It allows wireless print servers to have their own client
identifier (CID). When the print server is active is uses the CID on the
printer. When both print servers are active they have the option to use the
CID on the printer, or their own CID.
~DY Firmware version V60.15.x, V50.15.x, or later supports .NRD (non readable
file) files and .PAC files (protected access credential).
~WS Firmware version V60.15.x, V50.15.x, or later added these new parameters:
• wireless pulse—adds a pulse to the network traffic generated by the
printer. To keep the printer online, a pulse is necessary with some
network configurations.
• wireless pulse interval—when the wireless pulse feature is enabled
this sets the interval at which the wireless pulse is sent.
• channel mask—for commonly used channel masks.
• international mode—disables or enables International mode
^WX The ^WX command configures the wireless security settings for printers
using the wireless print server.

SNMP
Firmware V60.15.x, V50.15.x, or later feature support for an extended Management
Information Base (MIB) file. The extended support now covers many of the printer settings,
such as darkness, media type, and other printer specific settings. The MIB file can be
downloaded from www.zebra.com for use with SNMP management systems.

Set / Get / Do Support

Printers with firmware V60.15.x and V50.15.x support a new set of commands known as
Set / Get / Do (SGD) commands. These commands allow you to configure and get status on
the wireless settings in the printer. For details on the supported commands, see SGD Printer
Commands on page 627.

XML-Enabled Printing
Printers with firmware V60.15.8Z, V53.15.8Z, or later support XML-Enabled printing. For
details, go to http://www.zebra.com/xml. This new feature does not alter the ZPL capabilities
of the printer.

P1012728-004 Zebra Programming Guide 6/8/10

 Features 1045
Firmware x.14

Firmware x.14
Identifies features that are available in printers with firmware version V60.14.x, V50.14.x, or
later.

Table 50 identifies the new commands and enhancements to existing commands in firmware
V60.14.x, V50.14.x, or later. The bolded items are either new commands or new
enhancements to existing commands.

Table 50 • x.14 Features in Detail

Command Details
^CI The ^CI command selects the encoding and character set. To identify the
encoding, include a ^CI in the ZPL script. These encodings are now
supported with the ^CI command:

These are new variables that were added to the desired character set or
a parameter of the existing ^CI command:
• Big 5 HKSCS (^CI26) with BIGHK.DAT. This supports the Hong
Kong supplementary character set of the Big 5 character set and
encoding. You can download the Big 5 HKSCS DAT table from
www.zebra.com.
• Code Page 1252 (^CI27). The ^CI27 command supports code page
1252.
• GB 18030 (^CI26) with GB18030.DAT. This supports the GB 18030
character set and encoding standard.
• Unicode Support. These new values were added to the ^CI command:
28 = Unicode (UTF-8 encoding)
29 = Unicode (UTF-16 Big-Endian encoding)
30 = Unicode (UTF-16 Little-Endian encoding)
~DY The ~DY command downloads fonts to the printer. Firmware version
V60.14.x, V50.14.x, or later improves support for TrueType fonts and adds
support for TrueType Extension fonts. When OpenType fonts can be
downloaded as a TrueType font they are supported.
^FH The ^FH command allows you to enter the hexadecimal value for any
character directly into the ^FD statement. It has been updated to function
with Unicode encodings.
^FL The ^FL command provides the ability to link any TrueType font, including
private character fonts to associated fonts, such that if the base font does not
have a glyph for the required character, the printer looks to the linked fonts
for the glyph. The font links are user-definable.
^FO, ^FT, In firmware version earlier than V60.15.x, V50.15.x or later, the ^FO and
^FW ^FT commands were left-justified. In firmware version V60.14.x, V50.14.x,
or later, a new parameter supports right- and auto-justification. Using the
^FW command allows you to set justification options.
^HT Over a communication port, the ^HT command receives the complete list of
the font links.

6/8/10 Zebra Programming Guide P1012728-004

1046 Features
Firmware x.14

Table 50 • x.14 Features in Detail

Command Details
^LF The ^LF command prints out a list of the linked fonts.
^PA The Advanced Text Layout Options command (^PA) is new in firmware
version V60.14.x, V50.14.x, or later.
Advanced text layout, such as bidirectional text layout, character shaping,
and OpenType support, can be activated with the ^PA command. The glyph
displayed when the character is missing from a font (default glyph) can be
changed from a space character to the default glyph of a font, which is often
a square box.
^SL A new parameter was added to the ^SL command to support the Japanese
language in the Real Time Clock feature set.
^TB The text block (^TB) command is a new command in firmware version
V60.14.x, V50.14.x, or later. The ^FB command allows you to print text into
a defined block type format; it does not support complex text layout. In
contrast, the ^TB command supports a text block with complex text.

Global Printing Solution

The Global Printing solution greatly simplifies international character label printing by
supporting Unicode compatible fonts and encoding (UTF-8, UTF-16BE and UTF-16LE)
directly in its printers.

These are new and enhanced features available in firmware version V60.14.x, v50,14.x, or
later:
• Advanced text layout options
• Big 5 HKSCS
• GB 18030
• Unicode support (UTF-8 and UTF-16)
• Code Page 1252
• Field hexadecimal
• Field origin justification
• Font linking
• Improved font support
• Real-time clock – Japanese support
• Text block

For details on these new features, see Table 49 on page 1044.

P1012728-004 Zebra Programming Guide 6/8/10

 Features 1047
Firmware x.14

Zebra firware V60.14.x, V50.14.x, or later continues to support locale-specific encoding

formats. These formats include:
• Code Page 850
• Shift JIS
• GB
• Unified Hangul Code
• Big 5

What Is Unicode?
Unicode is a universal code page (which converts numeric codes into characters) that can be
used with many computer platforms and software applications. While ASCII and other
traditional code page encoding systems support 256 characters or less, Unicode can support
almost 100,000 characters for all major languages. The languages include complex non-
Western languages that can be difficult to print.

Unicode encoding and supporting fonts allow the printer to seamlessly output in any language.
As a result, you do not have to select the language, font, code page, or configure or adjust the
printer. Zebra’s printer-resident capabilities provide fast label output and seamless multi-
language printing.

You can create private libraries of logos and special characters and include them in labels. The
ability to create custom characters is valuable for creating shipping labels for Asia, as many
Asian fonts don’t support characters for names, street names, and other proper nouns.
Firmware V60.14.x, V50.14.x, or later offers features that support bidirectional printing or
complex text layout, including:
• Arabic
• Hindi
• Thai
• Vietnamese
• Other languages

6/8/10 Zebra Programming Guide P1012728-004

1048 Features
Firmware x.14

Notes • ___________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

P1012728-004 Zebra Programming Guide 6/8/10

 L
Mirror

This section provides an overview of Mirror, details on how to use it, and configuration
examples.

Contents
Mirror Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1050
Professional Services for Mirror Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1051
Requirements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1052
How Mirror Works . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1054
Creating ZPL Files for Use in the "<update-root>/files" Directory . . . . . . . . . . . . . . . . 1057
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1061
The Feedback.get File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1062
How to Set Up and Use Mirror . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1065
Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1067

6/8/10 Zebra Programming Guide P1012728-004

1050 Mirror
Mirror Overview

Mirror Overview
Mirror is a feature that gives you the ability to:
• Centrally manage and monitor the deployment of your Zebra printers
• Centrally configure and maintain your Zebra printers through remote updates
• Remotely monitor printer updates - via the "Feedback" feature

There are several Set/Get/Do (SGD) commands that are used to configure and initiate Mirror.
For details see, Mirror Printer Configuration on page 1061.

Benefits
When using Mirror, updating the configuration and firmware on the printer is remotely
managed from a centralized FTP server. Configurations can be uniformly deployed to
individual printers or to groups of printers. Unique Configurations can also be targeted to
printers as needed.

Through the "Feedback" feature, Administrators can easily log and monitor configuration
updates on a printer-by-printer basis.

Typical uses of Mirror include:

• configuring printers as they are first received
• performing scheduled maintenance updates, sending firmware, fonts, graphics and other
objects to the printer as needed
• changing printer Configurations in order to move printers from one role to another

P1012728-004 Zebra Programming Guide 6/8/10

 Mirror 1051
Professional Services for Mirror Configuration

Figure 13 provides an illustration of Mirroring.

Figure 13 • Mirror Illustration

1 Workstation — sends SGD commands to the printer to configure it for Mirror use.
2 FTP Server — Stores configuration files and responds to Mirror requests from the
printer. Receives and stores “Feedback” content.
3 Access Point — wireless network infrastructure
4 Hub — wired network infrastructure
5 Zebra Printer(s) — Configured using SGD commands. Sends Mirror requests to
the FTP server to receive files. Transmits “Feedback” content to the FTP server to
log Mirror event transactions and resulting printer settings.

Professional Services for Mirror Configuration

Zebra offers a Professional Services group that can help with the configuring the Mirror
feature. To inquire about Zebra's Professional Services, please contact your Zebra account
representative.

6/8/10 Zebra Programming Guide P1012728-004

1052 Mirror
Requirements

Requirements
These are the requirements for Mirror:
• Zebra printer loaded with Mirror capable firmware and Print Server. For details, see
Table 51, Printers and Print Servers that Support Mirror on page 1053.
• FTP server (with UNIX-style directory listings), configured with the following
directories:
• "<update-root>"/appl - This directory is used for printer firmware updates.
During an update operation, the printer will first check the "<update-
root>/appl" directory for new printer firmware
• "<update-root>"/files - This directory is used for printer-resident files.
Files in this directory will be stored locally on the printer's file system. Files are not
processed by the printer; they are only stored.
• "<update-root>"/commands - This directory is used for a limited number of
printer executable commands. The contents of files in this directory will be sent to the
printer's command interpreter for execution.
• "<feedback-root>" - This optional directory is used to receive Mirror feedback
content from the printer. The content sent to this directory is defined by the
"feedback.get" template file stored on the printer.
• A client account (user name and password) on the FTP server for the printer to use.
• A Terminal Emulation program, used to send SGD commands to the printer to configure
Mirror.

P1012728-004 Zebra Programming Guide 6/8/10

 Mirror 1053
Requirements

Supported Printers and Print Server Types

These are the Zebra printers, firmware versions, and Zebra print servers that support Mirror.

Table 51 • Printers and Print Servers that Support Mirror

Printer Firmware Print Servers

Xi4™ series V53.17.5Z • Internal, Integrated 10/100 IPV4 wired
(or later) • Internal Wireless Plus
XiIIIPlus™ series V60.17.5Z • Internal Wireless Plus
(or later) • Wireless Plus
105SL™ V60.17.5Z • Internal Wireless Plus
(or later) • Wireless Plus
PAX4™ V60.17.5Z • Internal Wireless Plus
(or later) • Wireless Plus
ZM400™ V53.17.5Z • Internal 10/100 wired
(or later) • Internal Wireless Plus
• Wireless Plus
ZM600™ V53.17.5Z • Internal 10/100 wired
(or later) • Internal Wireless Plus
• Wireless Plus
S4M™ V53.17.5Z • Internal Wireless Plus
(or later) • Wireless Plus
G™ -series V56.17.5Z • Internal 10/100 wired
V61.17.5Z • Internal Wireless Plus
(or later) • Wireless Plus

Note • Print Servers connected to the parallel port, either externally or internally, are not
supported for Mirror use.

6/8/10 Zebra Programming Guide P1012728-004

1054 Mirror
How Mirror Works

How Mirror Works

Mirror utilizes a network connection and FTP communications to perform remote updates and
feedback operations. At printer startup and/or at regular intervals, the printer will establish a
FTP connection back to a central FTP server and check for updates. During an update
operation, the printer will check for updated files in specific directories at the FTP server.

These are the specific FTP server directories that will be checked:
• "<update-root>"/appl - This directory is used for printer firmware updates.
During an update operation, the printer will first check the ''<update-root>/appl'' directory
for new printer firmware
• "<update-root>"/files - This directory is used for printer-resident files. Files in
this directory will be stored locally on the printer's file system. Files are not processed by
the printer; they are only stored.
• "<update-root>"/commands - This directory is used for a limited number of
printer executable commands. The contents of files in this directory will be sent to the
printer's command interpreter for execution.
• "<feedback-root>" - This optional directory is used to receive Mirror feedback
content from the printer. The content sent to this directory is defined by the "feedback.get"
template file stored on the printer.

Note • ''<update-root>'' refers to the value of the ''ip.mirror.path'' configuration

parameter.

Files in the <update-root>/files directory should not have download headers in

them. They should be in the exact format they will be in when stored on the printer's file
system. Examples of download headers are: ~DY, ~DG, ! CISDFCRC16 or ~DF.

Important • When the printer is in the Mirror process:

• It is unavailable for other tasks.
• The LCD will indicate that it is performing a Mirror function, showing when the printer is
downloading firmware and the names of the object files as they are transferred to the
printer.

P1012728-004 Zebra Programming Guide 6/8/10

 Mirror 1055
How Mirror Works

Mirror Process Summary

The Mirror process follows a specific series of steps:

1. After power-up, the printer will first check the <update-root>/appl directory on the
FTP server for new printer firmware and update the printer if necessary

2. If the printer did not find new firmware to download, it will then check in the <update-
root>\files and <update-root>/commands directories for updated files - and
download them as needed.

3. As a final Mirror step, the printer can perform an optional Feedback operation,
transmitting a file of user-defined printer configuration information to <feedback-
root> directory on the FTP server.

4. Finally, if any files or commands were downloaded during Step 2:, the printer will
automatically reset itself.

Mirror Process Details

The following items are important to be aware of when configuring the FTP server to support
Firmware updated via Mirror.
• Firmware files must be named using the following format:
<firmware version>.zpl, where <firmware version> is the exact Firmware
revision contained in the file. For example, for Firmware version “V53.17.5Z”, the
filename stored on the FTP server must be “V53.17.5Z.ZPL”. If the file name and
Firmware version do not match, the update will not succeed.
• The firmware filename stored on the FTP server is not case sensitive. This means that
“V53.17.5Z.ZPL” and “v53.17.5Z.zpl” will be processed in the exact same way.
• The /appl directory can contain only one (1) file at a time. If there is more than 1 file in
this directory, the printer will not download anything and will skip the firmware update.

During a Mirror event, the printer will use <firmware version> part of the filename
contained in the /appl directory on the FTP server to check if the Firmware stored on the
FTP server is different than the firmware the printer is currently using. If the <firmware
version> part of the Firmware file name in the /appl directory on the FTP server does not
exactly match the printer's Firmware version, the file on the FTP server will be downloaded
and used to update the printer. Once the printer is updated with the new Firmware, the printer
will reset and being using the new Firmware.

Note • Performing the Firmware update first is important because it is possible that the files
or commands to be downloaded via Mirror will be dependent on the new firmware.

After the printer has completed the Firmware portion of an update operation, it will check the
''<update-root>/files'' directory and ''<update-root>/commands'' directory (in
that order) for updated files that need to be retrieved. If a file exists on the FTP server and the
server timestamp for the file does not match the printer's archived timestamp for the file, the
printer will re-download the file and update its timestamp info. Files that are on the Mirror
FTP server but not currently present on the printer will be sent to the printer. The supported
file types are the standard files supported on ZPL printers.

6/8/10 Zebra Programming Guide P1012728-004

1056 Mirror
How Mirror Works

If any files are downloaded during this portion of an update operation, the printer will reboot
after the file downloads have completed. At this point, the update operation is complete.

Important • Files in the <update-root>/files directory should not have download

headers in them. They should be in the exact format they will be in when stored on the
printer's file system. Examples of download headers are: ~DY, ~DG, ! CISDFCRC16 or
~DF.

Important • ZPL files in the <update-root>/files directory must use the printers
internal characters for the Format Command Prefix (^), Delimiter Character (,) and Control
Command Character (~). This means that the caret (^) should be replaced with a HEX 1E, the
comma ( ,) should be replaced with a HEX 1F and the tilde (~) should be replaced with a
HEX 10.

After an update operation is complete, a printer will perform a feedback operation, if

configured to do so. During a feedback operation, the printer will open its feedback template
file (named feedback.get), populate it based on its contents, and upload the resulting
contents file to the FTP server, in the ''<feedback-root>'' directory.

Note • "<feedback-root>" refers to the value of the

"ip.mirror.feedback.path" configuration parameter

P1012728-004 Zebra Programming Guide 6/8/10

 Mirror 1057
Creating ZPL Files for Use in the "<update-root>/files" Directory

Creating ZPL Files for Use in the

"<update-root>/files" Directory
When creating ZPL formats that will be stored in the ''<update-root>/files'' directory it is
necessary to edit the files using the following guidelines:

1. Files must contain only one format. This means that if a file contains multiple ^XA and
^XZ commands, those sections of the file must be split into separate formats, or combined
as one format.

2. The characters used for the Format Command Prefix (^), Delimiter Character (,) and
Control Command Characters (~) must be substituted for their Hexadecimal equivalents.

3. The ^XA and ^XZ commands must be removed from the formats.

4. The ^DF command should be removed.

One Format per File

Files must contain only one format. This means that if a file contains multiple ^XA and ^XZ
commands, those sections of the file must be split into separate formats, or combined as one
format. For example, if a ZPL file contains both an initialization string and a format, the two
sections must be either split into two files, or combined into one format.

For example, given the following formats:

^XA
^LT0^MNW^MTT^PON^PMN^LH0,0^JMA^PR2,2^LRN^CI0
^XZ
^XA
^FO20,100^IME:ZEBRA.BMP^FS
^A@N,75,75,TT0003M_.TTF
^FO20,400^FDZebra Technologies^FS
^XZ
The following file should be created, which includes all of the command in one file:
^XA
^LT0^MNW^MTT^PON^PMN^LH0,0^JMA^PR2,2^LRN^CI0
^FO20,100^IME:ZEBRA.BMP^FS
^A@N,75,75,TT0003M_.TTF
^FO20,400^FDZebra Technologies^FS
^XZ

6/8/10 Zebra Programming Guide P1012728-004

1058 Mirror
Creating ZPL Files for Use in the "<update-root>/files" Directory

Character Substitution
The characters used for the Format Command Prefix (^), Delimiter Character (,) and Control
Command Characters (~) must be substituted for their Hexadecimal equivalents. During
normal operation, this is how the printer works with ZPL formats. For example, when a ZPL
format is sent to the printer via a telnet, RS-232 or Ethernet connection and stored for later use,
it automatically processes the file and makes these character substitutions.

When ZPL formats are sent to the printer from the "<update-root>/files" directory
they are stored on the printers memory, but not processed. For this reason, it is necessary to
preprocess the files so that they are ready for use.

The following character substitutions must be made to files sent from the
"<update-root>/files" directory:

Original Character Substitute Character

Command Prefix HEX 1E
The default is the Caret (^)
Delimeter Prefix HEX 1F
The default is the comma ( , )
Control Prefix HEX 10
The default is the tilde (~)

For example, given the following format:

^XA
^FO20,100^IME:ZEBRA.BMP^FS
^A@N,75,75,TT0003M_.TTF
^FO20,400^FDZebra Technologies^FS
^XZ
It would be necessary to replace the ^ characters with a HEX 1E and the , characters with a
HEX 1F. This can be done using a Text Editor. See Example Files on page 1060 for more
information.

Removing the ^XA and ^XZ commands

Additionally, the ^XA and ^XZ commands should be removed from the format. The printer
will automatically add these commands back in to process the file. See Example Files
on page 1060 for more information.

P1012728-004 Zebra Programming Guide 6/8/10

 Mirror 1059
Creating ZPL Files for Use in the "<update-root>/files" Directory

Removing the ^DF command

In some cases, you might have been using files that contain the ^DF command. The purpose of
the ^DF command is to instruct the printer to store everything that comes after it in a ZPL file.
For example, you might have a file that contains the following:
^XA
^DFE:STOREFMT.ZPL^FS
^FO25,25^AD,36,20^FN1^FS
^FO165,25^AD,36,20^FN2^FS
^FO25,75^AB,22,14^FDBUILT BY^FS
^FO25,125^AE,28,15^FN1
^XZ
The purpose of the above format - when sent to a printer - would be to store a file called
"STOREFMT" to the E memory location on the printer. In production, the goal would be to
recall and print the "STOREFMT" file using the following ZPL commands:
^XA
^XFE:STOREFMT.ZPL^FS
^FN1^FDZEBRA^FS
^FN2^FDPRINTER^FS
^XZ
When this is done using Mirror, the format being sent to the printer must be altered. The line
with the ^DF command must be removed - this is because the Mirror process is taking care of
storing the format to the E memory location. In this scenario, the original format would be
edited to look like this:
^FO25,25^AD,36,20^FN1^FS
^FO165,25^AD,36,20^FN2^FS
^FO25,75^AB,22,14^FDBUILT BY^FS
^FO25,125^AE,28,15^FN1
The character substitution described above must also be done on the file before it is stored in
the ''<update-root>/files'' directory.

The "recall" format - using the ^XFE:STOREFMT.ZPL command - does not need to be
altered or edited. It can be used as it was previously.

6/8/10 Zebra Programming Guide P1012728-004

1060 Mirror
Creating ZPL Files for Use in the "<update-root>/files" Directory

Example Files
Example of files that have already been altered in the manner described above are available as
"Mirror File Examples" at www.zebra.com.

To see an example file, right-click the paper-clip icon and select Open File or
Save Embedded File to Disk.

File Naming Recommendations

• Files in the "<update-root>/files" directory and
"<update-root>/commands" directory should not have the same name.
• Files in the "<update-root>/files" should not contain multiple label formats. If
you need to Mirror multiple formats, the recommended method is to split the formats into
separate files.

Command Use Recommendations

• Files in the "<update-root>/commands" directory should use only SGD
commands or the following ZPL commands:
• ~CC
• ~CD
• ~CT
• ~JA
• ~JL
• ~JS
• ~JX
• ~RO
• Do not add a device.reset SGD command to the end of a file in the
"<update-root>/commands" directory. Mirror will reset itself automatically after
performing an update, so there is no need for this command.

P1012728-004 Zebra Programming Guide 6/8/10

 Mirror 1061
Configuration

Configuration
This section provides detail on the configuring the printer and FTP server for Mirror.

Mirror FTP Server Configuration

For a Zebra printer to successfully use Mirror, the Mirror FTP server must have the following:
• A client account (user name and password) for the printer to use
• A root (base) directory for Mirror updates. This root directory must have the following
subdirectories:
/appl
/files
/commands
• A Mirror feedback folder (optional)

Important • The printer's FTP user account must have the necessary permissions to
read/write files in the update and feedback root directories. The /appl, /files, and
/commands subdirectories are read only; the Mirror feedback folder is read/write. If these
permissions are not properly set, the Mirror update and feedback processes will be
unsuccessful.

Mirror Printer Configuration

The following SGD commands are used to configure Mirror on the printer:

• ip.mirror.auto on page 833 • ip.mirror.last_error on page 842

• ip.mirror.error_retry on page 834 • ip.mirror.last_time on page 843
• ip.mirror.feedback.auto on page 835 • ip.mirror.password on page 844
• ip.mirror.feedback.freq on page 836 • ip.mirror.path on page 845
• ip.mirror.feedback.odometer on page 837 • ip.mirror.reset_delay on page 846
• ip.mirror.feedback.path on page 838 • ip.mirror.server on page 847
• ip.mirror.fetch on page 839 • ip.mirror.success on page 848
• ip.mirror.freq on page 840 • ip.mirror.success_time on page 849
• ip.mirror.freq_hours on page 841 • ip.mirror.username on page 850
• ip.mirror.version on page 851

6/8/10 Zebra Programming Guide P1012728-004

1062 Mirror
The Feedback.get File

The Feedback.get File

The Feedback feature is one of the key benefits of the Mirror process. During a Mirror
operation, the printer can upload a file to the FTP Server that contains information about the
configuration of the printer. This information can then be leveraged by the Administrator to
monitor the printer's setup. Using the Feedback feature is optional.

The "feedback.get" file is a template file stored on the printer. It controls what content is
uploaded to the"<feedback-root>"directory on the FTP server. The directory on the FTP
server where the printer will send Feedback content to is controlled by the
"ip.mirror.feedback.path" command.

Within the feedback.get file it is possible to leverage SGD commands to insert current printer
status and configuration strings into the file. This feature can help make the Feedback file on
the FTP server more unique and useful to the Administrator.

Additionally, the first line of the feedback.get file is used to control the name of the file that
will be uploaded and stored on the FTP server.

For example, if first line of the "feedback.get" file was:

"zebra.<wlan.mac_raw>.<ip.mirror.feedback.odometer>"
That line would be evaluated by the printer and used as the Feedback destination file name to
create on the FTP server.

Using the example above, if the MAC address of the wireless print server was
"00a0f8ae56d7"and the Feedback odometer was currently at "33", the Feedback file created
the FTP server would be named:
"zebra.00a0f8ae56d7.33.txt"
The "feedback.get" file can be sent to the printer using the !CISDFCRC16 command. For
additional information, see CISDFCRC16 on page 634.

Note • The first line of the feedback.get file is not included when the Feedback data is
written to FTP server.

P1012728-004 Zebra Programming Guide 6/8/10

 Mirror 1063
The Feedback.get File

Example Feedback.get file

Here is an example of a "feedback.get" file and its resulting uploaded file:
zebra.<wlan.mac_raw>.<ip.mirror.feedback.odometer>

Application Name = <appl.name>

Serial Number = <device.friendly_name>

Mirror Success = <ip.mirror.success>

Mirror Auto = <ip.mirror.auto>
Mirror Path = <ip.mirror.path>
Mirror Last Update = <ip.mirror.success_time>

Bootp Enable = <ip.bootp.enable>

DHCP Enable = <ip.dhcp.enable>
Data Port = <ip.port>
Associated AP = <wlan.bssid>
RF ESSID = <wlan.essid>
RF Firmware = <wlan.firmware_version>
RF Signal Strength = <wlan.signal_strength>
RF Channel Mask = <wlan.channel_mask>

Label Length = <odometer.total_print_length>

Print Length = <odometer.label_dot_length>

6/8/10 Zebra Programming Guide P1012728-004

1064 Mirror
The Feedback.get File

When this file is processed by the printer and uploaded to the FTP server, the resulting upload
file on the FTP server would contain data similar to this:
Application Name = V53.17.2Z
Serial Number = ZBR123456

Mirror Success = Yes

Mirror Auto = on
Mirror Path = /update-root/ZM400/
Mirror Last Update = 12345678

Bootp Enable = on
DHCP Enable = on
Data Port = 9100
Associated AP = 124
RF ESSID = MyEssid
RF Firmware = 5.2.1
RF Signal Strength = 98
RF Channel Mask = FF

Label Length = 100

Print Length = 200

P1012728-004 Zebra Programming Guide 6/8/10

 Mirror 1065
How to Set Up and Use Mirror

How to Set Up and Use Mirror

This section provides multiple scenarios which include specific examples that demonstrate
how to set up and use Mirror.

Scenario One
In this scenario, the printer is configured to perform a Mirror update operation
("ip.mirror.auto = on") and feedback operation ("ip.mirror.feedback.auto
= on") every time the printer restarts. On startup, after a network connection has been
established, the printer will attempt to make a FTP connection to the server address
10.14.5.133, using the “user name” and “password” of the printer.

If the connection is successful, the printer will attempt to perform an update operation using
the root directory "/all_printers/s4m/role1". After the update operation is
complete, the printer will attempt a Feedback operation, uploading the resulting Feedback file
to the "/all_feedback" directory on the server.

Using the command set in the example below, the printer will not attempt any periodic Mirror
Update or Feedback operations. It will only perform Mirror operations on startup or when
explicitly instructed to using the "ip.mirror.fetch" command.

Note • If a file starts with "/" it signifies the base directory of that file system. If a file is
contained in the user’s account, they do not start with a "/".

Example • This example shows a Mirror configuration command set. Each line item of the
command set is identified with a number. For details on each line item, see the table below.

1 ! U1 SETVAR "ip.mirror.auto" "on"

2 ! U1 SETVAR "ip.mirror.username" "printer"
3 ! U1 SETVAR "ip.mirror.password" "printer"
4 ! U1 SETVAR "ip.mirror.server" "10.14.5.133"
5 ! U1 SETVAR "ip.mirror.path" "/all_printers/s4m/role1"
6 ! U1 SETVAR "ip.mirror.feedback.auto" "on"
7 ! U1 SETVAR "ip.mirror.feedback.path" "/all_feedback"
8 ! U1 SETVAR "ip.mirror.feedback.freq" "0"

1 Configures the printer to perform a Mirror Update operation at power-up.

2 Configures the FTP Server "user name" for the printer to use
3 Configures the FTP Server "password" for the printer to use
4 Configures the FTP server address the printer should make a FTP connection to.
5 If the FTP connection is successful, the printer should attempt to perform an
Update operation using this root directory.
6 Configures a printer to automatically perform a Mirror Feedback operation
at start-up.
7 Configures the printer to upload the resulting Feedback file to the designated
directory on the server.
8 Configures a printer to repeat the Feedback operation zero times.

6/8/10 Zebra Programming Guide P1012728-004

1066 Mirror
How to Set Up and Use Mirror

Scenario Two
In this scenario, the printer is configured to not perform a Mirror Update function at start-up. It
is configured to perform a Mirror Feedback operation at start-up and thereafter at every 60
minutes.

When the 60 minutes elapses, the printer will attempt to make a FTP connection to the server
address 10.14.5.133. If the FTP connection is successful, the printer will attempt a Feedback
operation, uploading the resulting Feedback file to the "/all_feedback" directory on the server.
After the initial Feedback operation, subsequent Feedback operations will occur at an interval
of 60 minutes.

Important • Using the command set in the example below, for the printer to attempt any
Mirror Update operation unless the "ip.mirror.fetch" command is sent to the printer.

Example • This example shows a Mirror configuration command set. Each line item of the
command set is identified with a number. For details on each line item, see the table below.

1 ! U1 SETVAR "ip.mirror.auto" "off"

2 ! U1 SETVAR "ip.mirror.username" "printer"
3 ! U1 SETVAR "ip.mirror.password" "printer"
4 ! U1 SETVAR "ip.mirror.server" "10.14.5.133"
5 ! U1 SETVAR "ip.mirror.path" "/all_printers/s4m/role1"
6 ! U1 SETVAR "ip.mirror.feedback.auto" "on"
7 ! U1 SETVAR "ip.mirror.feedback.path" "/all feedback"

1 Configures the printer to not perform a Mirror Update operation at start-up

2 Configures the FTP Server "user name" for the printer to use
3 Configures the FTP Server "password" for the printer to use
4 Configures the FTP server address the printer should make a FTP connection to.
5 If the FTP connection is successful, the printer should attempt to perform an
Update operation using this root directory.
6 Configures a printer to automatically perform a Mirror Feedback operation
at start-up.
7 Configures the printer to upload the resulting Feedback file to the designated
directory on the server.
8 Configures the printer to attempt a Feedback operation every 60 minutes.

P1012728-004 Zebra Programming Guide 6/8/10

 Mirror 1067
Troubleshooting

Troubleshooting
If a Mirror process completes unsuccessfully, troubleshooting information can be retrieved by
sending this command to the printer:
! U1 GETVAR "ip.mirror.last_error"
Table 52 lists possible printer responses, an explanation of each, and resolutions. Table 53
provides problem scenarios and solutions.

Important • A mirror path can have up to 50 characters.

Table 52 • Printer Response Troubleshooting

Printer Response Explanation Resolution

"connection failed" The network connection to the • Check the user name, password, and
Mirror FTP server failed while server address for the Mirror FTP
attempting to perform a printer server and ensure that these values
update. are set correctly in the printer.
• Ensure that the user name assigned
to the printer has the proper
permission to log into the Mirror
FTP server.
• Check that the printer has a
successful network connection and
is able to send and receive network
data.
"Failed to get File: During an update operation, the • Ensure that the printer's network
[filename]" printer's attempt to retrieve the connection has not been interrupted.
file [filename] failed. If it has, re-establish network
connectivity and retry the update.
• Check the server's access
permissions for the user name
assigned to the printer. Make sure
the user name is granted access to
read [filename] from the server.

6/8/10 Zebra Programming Guide P1012728-004

1068 Mirror
Troubleshooting

Table 52 • Printer Response Troubleshooting (Continued)

Printer Response Explanation Resolution

"feedback connection The network connection to the • Check the user name, password, and
failed" Mirror FTP server failed while server address for the Mirror FTP
attempting to send printer server and ensure that these values
feedback. are set correctly in the printer.
• Ensure that the user name assigned
to the printer have the proper
permission to log into the Mirror
FTP server.
• Check that the printer has a
successful network connection and
is able to send and receive network
data.
"Failed getting file During an update operation, the • Ensure that the printer’s network
to parser : printer’s attempt to retrieve a connection has not been interrupted.
[filename]" file [filename] in the If it has, re-establish network
<mirror_path>/appl connectivity and retry the update.
directory failed.
• Check the server’s access
permissions for the user name
assigned to the printer. Make sure
the user name is granted access to
read [filename] from the server.
"Failed to send During a feedback operation, • Ensure that the printer’s network
feedback file: the printer’s attempt to store the connection has not been interrupted.
<feedback_path>/<feed feedback file in the If it has, re-establish network
back_filename>" <feedback_path> connectivity and retry the update.
directory failed.
• Check the server’s access
permissions for the user name
assigned to the printer. Make sure
the user name is granted access to
write to the <feedback_path>
directory.
• Ensure that the
<feedback_path> directory
exists on the remote server.
"Too many files in The Mirror FTP server has Ensure that there is only one (1)
the firmware download more than one file in the firmware file in the
directory" <mirror_path>/appl <mirror_path>/appl directory.
directory.

P1012728-004 Zebra Programming Guide 6/8/10

 Mirror 1069
Troubleshooting

Table 53 • Problem Scenario Troubleshooting

Problem Scenario Solution

I performed a Mirror Update and now Ensure that the name of the firmware file in
my printer is continuously <mirror_path>/appl matches the version of firmware
reprogramming. contained in that file.
Example • For firmware version V53.17.2Z, the name of the file in
the <mirror_path>/appl directory must be V53.17.2Z.ZPL
to prevent the continuous reprogramming cycle.
Every time a Mirror Update is run, a • Check the names of the files in the <mirror_path>/files
file is fetched even though no and <mirror_path>/commands directories. If the names
changes have been made to the files are longer than 16 characters (minus extensions), then the printer
on the server. will truncate them to 16 characters when downloading. If two
filenames truncate to the same 16 characters, the printer will not
be able to tell the difference between them and will re-download
one of the two files during every update operation.
• Check the names of the files in the <mirror_path>/files
and <mirror_path>/commands directories. If any of the
names are the same, then the printer will not be able to tell the
difference. Therefore it will get the one in the files directory,
update the timestamp file, and then it will get the one in the
commands directory and update the timestamp file. Then, the
next time through the one in the files directory will have a
different timestamp, so it will get that file again and then check
the commands directory, and so on.
• Check the server's access permissions for the user name
assigned to the printer. Make sure the user name is granted
access to read all files in the <mirror_path>/files and
<mirror_path>/commands directories.
The printer is continually rebooting. • Check the /commands directory. If a file.delete
command resides, then you need to remove file.delete or
modify your script.

6/8/10 Zebra Programming Guide P1012728-004

1070 Mirror
Troubleshooting

Notes • ___________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

P1012728-004 Zebra Programming Guide 6/8/10

 M
Wireless Markup Language
(WML)

Wireless Markup Language (WML) offers a text-based method of designing a menu structure
for the display screen of selected printers. By leveraging Set/Get/Do (SGD) and files
containing Zebra Programming Language (ZPL) commands, customized menus can be
created.

Contents
WML Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1072
WML Details. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1072
Supported Printers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1073
Professional Services for WML Content Creation . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1073
WML Tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1074
Using WML. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1074
WML Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1078
Troubleshooting Scenarios . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1087

6/8/10 Zebra Programming Guide P1012728-004

1072 Wireless Markup Language (WML)
WML Overview

WML Overview
Wireless Markup Language (WML) offers a text-based method of designing customized
menus on the LCD front panel of selected printers. By leveraging Set-Get-Do (SGD) and
Zebra Programming Language (ZPL) commands, menus that feature both display and com-
mand features can be created. The WML “card” structure makes it possible to link from one
menu screen to another, creating menus that are as many levels “deep” as desired or reduced to
only those options needed by the printer operator.

For details on SGD commands, see SGD Printer Commands on page 627. For details on ZPL
commands, see ZPL Commands on page 37.

WML Details
A WML file is made up of tags, which are similar to HTML tags. For a list of the supported
WML tags, see WML Tags on page 1074.

Using WML on the printer is dependent on the presence of a single index.wml file, stored in
the printer's E: memory. The index.wml file can contain one or more “cards”, with each card
defining the content of a single menu. Everything within the card tag (<card> </card>)
constitutes one complete front panel menu. Cards can also contain hyperlinks to other menus.
If the index.wml has three cards, with links between the cards, that means there are three front
panel menus. It is also possible to create multiple .wml files, with links between them and the
index.wml file. In cases where multiple .wml files are used, it is recommended that each file
should be structured to provide a link back to the main menu as described in the index.wml
card.

Note • Only one index.wml file can reside on a printer at any time

WML defined menus can use Set-Get-Do (SGD) commands to retrieve or set printer settings.
For example, a menu might display the printer’s current baud rate, while also offering other
potential baud rate settings for the printer selection. In more advanced uses, WML defined
menus can cause ZPL command files, stored in the printer E: memory, to be injected into the
printers command engine – where they will be read in and acted upon. In this use, the ZPL
command file files are known as .nrd files.

For example, a WML defined menu could call an .nrd file that contains a customized set of
printer configuration commands. In this way, different profiles can be created for the printer -
making it possible for the printer operator to select the appropriate configuration profile
needed for the task the printer is being used in.

P1012728-004 Zebra Programming Guide 6/8/10

 Wireless Markup Language (WML) 1073
Supported Printers

An important concept to consider is that the WML menu completely defines what is displayed
on the printers screen. If an item is not included in the WML menu definition it will not be
displayed to the user.
3

Note • The index.wml file must reside on the printer’s E: drive for the WML menu to
display. If the index.wml file is on a drive other than E:, then the standard front panel
menus display.
3

Note • When a WML menu is resident on the printer, the standard menu system can be easily
be accessed by holding down the Cancel and Setup/Exit buttons (on the ZM400) or the
Cancel and Setup/Exit buttons (on Xi4) or the Select button (on GX) on the front panel while
the printer powers up. Hold the buttons down until the PRINT READY message displays on
the front panel. To return to the WML defined menu, reset the printer again.

Supported Printers
WML is supported on the following printers, using the indicated firmware. The buttons on the
printers' front panel that are used for Navigating WML defined menus are noted.

Note • When a WML defined menu is in use, the stripes pattern found at the top of selected
printers is not displayed.

Table 54 • WML-Supported Printers

Number Menu
Keys to Access
Printer Firmware of “lines” Navigation
Standard Menu System
available Buttons
Xi4™ series V53.17.5Z 5 Select Hold down CANCEL &
(or later) + (PLUS) SETUP/EXIT during power-up
- (MINUS)
ZM400™ V53.17.5Z 5 Select Hold down CANCEL &
(or later) + (PLUS) SETUP/EXIT during power-up
- (MINUS)
ZM600™ V53.17.5Z 5 NEXT/SAVE Hold down
(or later) + (PLUS) CANCEL & SETUP/EXIT
- (MINUS) during power-up
G™ -series V56.17.5Z 4 SELECT Hold down SELECT
(or later) SCROLL during power-up

Professional Services for WML Content Creation

Zebra offers a Professional Services group that can help with the creation of WML content. To
inquire about Zebra’s Professional Services, please contact your Zebra account representative.

6/8/10 Zebra Programming Guide P1012728-004

1074 Wireless Markup Language (WML)
WML Tags

WML Tags
Table 1 shows the WML tags and tag parameters that can be used to create a menu system. As
with other tag-based languages, such as HTML and XML, ending tags should be used to indi-
cate the end of a structure. An example of an ending tag would be </wml>, which indicates
the end of a WML script.

Using WML
Important • Using end tags is required to create well formed and functional WML scripts.

Table 55 • WML Tag Descriptions

<wml> </wml> indicates the beginning/end of the WML script
<display> </display> indicates the beginning/end of the content to display on-
screen
<card> </card> indicates the beginning/end of a card
<p> </p> indicates the beginning/end of a Paragraph
<br/> Line break
<a href="#menu">Menu</a> Hyperlink to another card
<timer value="xx"> </timer> Controls display timer in 10th of a second increments
" ontimer="#main" Controls action to take at timer end
alerts="on" Controls display of on-screen alerts
$(command.command) $ executes a SGD “get”command
<do .....><setvar .......></do> Controls execution of do and setvar commands

This section provides you with the necessary steps to prepare and transmit WML content to the
printer. There are two methods to send WML content to the printer - via the FTP protocol or
using the “CISDFCRC16” command. Both methods are detailed below.

Create a Sample index.wml File:

1. Open a text editor.

P1012728-004 Zebra Programming Guide 6/8/10

 Wireless Markup Language (WML) 1075
Using WML

2. Type (or copy/paste) the following text:

<wml>
<display>
<card>
<p>Hello World!!</p>
</card>
</display>
</wml>
3. Save this file with this name: index.wml.

Prepare the Printer to Receive WML Content via FTP:

WML files – and any .nrd files used by a WML menu structure – must be stored in the printers
E: memory location. While the files are first being transmitted to the printer, they should not
be processed by the printers ZPL formatting engine. This can be done by configuring the SGD
settings "ip.ftp.enable" and "ip.ftp.execute_file".

The “ip.ftp.enable” setting allows the printer to receive content via the FTP protocol.
The “ip.ftp.execute_file” setting controls the printers’ ability to process or not
process commands received via the FTP protocol using the printers ZPL engine. By default,
both settings are enabled.

1. Set "ip.ftp.enable" to "on" and the "ip.ftp.execute_file" to "off".

To do this, send these commands to the printer:
! U1 setvar "ip.ftp.enable" "on"
! U1 setvar "ip.ftp.execute_file" "off"
2. To confirm these commands are correctly set, send the getvar command to check the
settings. To do this, send these commands to the printer:
! U1 getvar "ip.ftp.enable"
! U1 getvar "ip.ftp.execute_file"
If a terminal emulation program is being used, the following response should be returned
from the printer.
"on""off"
Note • Only printers using the Internal 10/100 wired or Internal Wireless Plus & Wireless
Plus print server can use the ! U1 setvar "ip.ftp.execute_file" "off"
command. For other print servers, use the “CISDFCRC16” command method detailed below.

Send WML Content to the Printer via FTP

1. Go to a command prompt.

2. At the command line prompt, type "ftp xxx.xxx.xxx.xxx", where

xxx.xxx.xxx.xxx is the IP Address of the printer. For example, if the IP Address of
the printer is 10.3.5.34, the command would be:
ftp 10.3.5.34

6/8/10 Zebra Programming Guide P1012728-004

1076 Wireless Markup Language (WML)
Using WML

3. Press Enter to connect to the printer.

4. Press Enter to log in to the printer.

5. At the FTP prompt, type "put index.wml" and press Enter. The index.wml file
will be transferred to the printer’s E: memory.

6. Type "quit" to disconnect from the printer and exit FTP.

7. Power cycle the printer.

Once the printer completes the power cycle the display should look similar to this:

Hello World!!

For additional index.wml examples, see WML Examples on page 1078.

Note • When a WML menu is resident on the printer, the standard menu system can be easily
be accessed by holding down the Cancel and Setup/Exit buttons (on the ZM400) or the
Cancel and Setup/Exit buttons (on Xi4) or the Select button (on GX) on the front panel while
the printer powers up. Hold the buttons down until the PRINT READY message displays on
the front panel. To return to the WML defined menu, reset the printer again.

Important • When using the “ip.ftp.execute_file” command, be sure to reset the command
back to “on” for use in production processes. If the setting is left in the “off” configuration,
when label formats or firmware are sent to the printer via FTP they will not be processed as
intended – and the E: memory location can quickly become full.

Resetting the "ip.ftp.execute_file setting

1. To reset the "ip.ftp.execute_file" setting to the default state, send the
following command to the printer.
! U1 setvar "ip.ftp.execute_file" "on"

P1012728-004 Zebra Programming Guide 6/8/10

 Wireless Markup Language (WML) 1077
Using WML

Sending WML Content to the Printer via the CISDFCRC16

Command:
WML files – and any .nrd files used by a WML menu structure – must be stored in the printers
E: memory location. While the files are first being transmitted to the printer, they should not
be processed by the printers ZPL formatting engine. This can be done by using the
CISDFCRC16 command. This command allows content to be written directly to the E:
memory location, without being processed by the printers ZPL formatting engine. By using the
CISDFCRC16 command, WML content can be transmitted to the printer via the Serial, USB
or Parallel ports.

For additional information on the CISDFCRC16 command, see page XX.

1. To send the sample index.wml shown earlier, send the following commands to the printer:
! CISDFCRC16
0000
INDEX.WML
0000004E
0000
<wml>
<display>
<card>
<p>Hello World!!</p>
</card>
</display>
</wml>
2. Power cycle the printer.
Once the printer completes the power cycle the display should look similar to this:

Hello World!!

For additional index.wml examples, see WML Examples on page 1078.

Note • When a WML menu is resident on the printer, the standard menu system can be easily
be accessed by holding down the Cancel and Setup/Exit buttons (on the ZM400) or Cancel
and Setup/Exit buttons (on Xi4) on the front panel while the printer powers up. Hold the
buttons down until the PRINT READY message displays on the front panel. To return to the
WML defined menu, reset the printer again.

6/8/10 Zebra Programming Guide P1012728-004

1078 Wireless Markup Language (WML)
WML Examples

Retrieving WML Content from the Printer using the file.type

Command:
It is possible to retrieve .wml file content from the printer using the "file.type" SGD
command. To do this, open a terminal emulation connection to the printer and issue the
command. For example, to retrieve the contents of the INDEX.WML file, use the following
command:
! U1 setvar "file.type" "E:INDEX.WML"

Note • The file.type command is case sensitive – if the file is stored on the printer as
INDEX.WML, the command must use that same case. Additionally, please note that .nrd files
are treated as confidential – they cannot be retrieved from the printer.

Using .nrd Files from WML Menus

It is possible to have a WML menu send the contents of a ZPL or SGD file to the printer to be
processed. In this way, the WML menu can leverage complex command scripts in response to
the user pressing a single button on the printer. One possible use for this capability would be to
create a series of “profile” files that contain all the settings necessary to reconfigure the printer
for different uses.

The command files are known as “.nrd” files and are stored directly on the printers E: memory
location. The .nrd files can be created using a standard text editor and sent to the printer via
FTP or using the CISDFCRC16 command. Files should have an “.nrd” extension.

Removing WML or .nrd Files from the Printer using the file.delete
Command:
It is possible to remove .wml files from the printer using the file.delete SGD command. To do
this, open a terminal emulation connection to the printer and issue the command. For example,
to remove the INDEX.WML file, use the following command:
! U1 do "file.delete" "E:INDEX.WML"

WML Examples
The examples shown below “build” from a simple, display-only, WML menu to a more
complex interactive example that uses .nrd files containing ZPL commands. In the initial
examples, all lines are explained in detail, in the later examples only the new concepts are
covered in detail.

Indenting is used in the examples below to improve readability, it is not necessary in actual
use.

P1012728-004 Zebra Programming Guide 6/8/10

 Wireless Markup Language (WML) 1079
WML Examples

Example 1
This example shows a basic WML menu structure that uses only fixed text. The content below
shows the WML script plus numbered callouts and a table that identify the function of each of
the WML tags.

1 <wml>
2 <display>
3 <card>
4 <p>Hello World!!</p>
5 </card>
6 </display>
7 </wml>

1 Beginning of the WML file.

2 Beginning of the content to be displayed.
3 The <card> tag begins the definition of this menu.
4 The <p> beings a paragraph, here displaying Hello World!
The </p> ends the paragraph
5 The </card> tag ends the definition of this menu.
6 End of the content to be displayed.
7 End of the WML file.

In use, this WML menu looks similar to this:

Hello World!!

6/8/10 Zebra Programming Guide P1012728-004

1080 Wireless Markup Language (WML)
WML Examples

Example 2
This example demonstrates a WML menu structure that uses fixed text, plus two SGD
commands to display the current printer settings for the Baud rate and ESSID settings on the
printer.

1 <wml>
2 <display>
3 <card>
4 <p>Baud: $(comm.baud)</p>
5 <br/>
6 <p>AP: $(wlan.essid)</p>
7 </card>
8 </display>
9 </wml>

1 Beginning of the WML file.

2 Beginning of the content to be displayed.
3 The <card> tag begins the definition of this menu.
4 The <p> begins a paragraph.
‘Baud:’ displays the text Baud:
$(comm.baud) retrieves and displays the printers’ current baud rate.
The </p> ends the paragraph.
5 A line break
6 The <p> begins a paragraph.
“AP:” displays the text AP:
$(wlan.essid) retrieves and displays the printers’ current ESSID setting.
The </p> ends the paragraph.
7 The </card> tag ends the definition of this menu.
8 End of the content to be displayed.
9 End of the WML file

In use, this WML menu looks similar to this:

Baud: 9600
AP:  125

P1012728-004 Zebra Programming Guide 6/8/10

 Wireless Markup Language (WML) 1081
WML Examples

Example 3
This example demonstrates a WML menu structure with two menus. Fixed text and SGD
commands are used to display the current printer settings for the Baud rate and ESSID settings
on menu one and the Firmware version and ZBI State on menu two. Through use of the ‘timer’
setting, the menu will automatically return to a defined WML card if no buttons are pressed
after a set time period. The menu is configured to allow printer alerts (such as HEAD OPEN)
to be displayed.
1 <wml>
2 <display>
3 <card id="main" title="" ontimer="#main" alerts="on">
4 <timer value="50"></timer>
5 <p>Baud: $(comm.baud)</p>
6 <br/>
7 <p>AP: $(wlan.essid)</p>
8 <p> </p><br/>
9 <p> </p><br/>
10 <p> <a href="#system">Firmware</a></p>
11 </card>
12 <card id="system" title="" ontimer="#main" alerts="on">
13 <timer value="50"></timer>
14 <p>Firmware:</p><br/>
15 <p>$(appl.name)</p><br/>
16 <p>ZBI State:</p><br/>
17 <p>$(zbi.key)</p><br/>
18 <p> <a href="#main">Main</a></p>
19 </card>
20 </display>
21 </wml>

3 <card id="main" – defines the card’s id – "main".

title="" – defines the title (not displayed on screen).
ontimer="#main" – defines the WML card to display when the timer runs out.
alerts="on"> – enables the alerts display feature.
4 <timer value="50"></timer> – sets the timer to 50 (in 10th of a second increments).
10 <p> <a href="#system">Firmware</a></p> – defines a link to the “system”
card.
12 <card id="system" – defines the card’s id – "system".
title="" – defines the title (not displayed on screen).
ontimer="#main" – defines the WML card to display when the timer runs out.
alerts="on"> – enables the alerts display feature.
13 <timer value="50"></timer> – sets the timer to 50 (in 10th of a second increments).
18 <p> <a href="#main">Main</a></p> – defines a link to the “main” card.

6/8/10 Zebra Programming Guide P1012728-004

1082 Wireless Markup Language (WML)
WML Examples

In use, these two WML menus look similar to this:

Baud: 9600 Firmware: 
V53.17.2
AP:  125 ZBI State:
Enabled

Firmware Main

Note • GX series printers can display four lines of text. If you are using a GX series printer,
remove one line of text from each “card” to use this example.

P1012728-004 Zebra Programming Guide 6/8/10

 Wireless Markup Language (WML) 1083
WML Examples

Example 4
This example demonstrates a WML menu structure that creates two menu screens and a link to
a command file – “config.nrd” – that contains a ZPL command that will cause the unit to
print a configuration label.
1 <wml>
2 <display>
3 <card id="main" title="" ontimer="#main" alerts="on">
4 <timer value="50"></timer>
5 <p>Baud: $(comm.baud)</p>
6 <br/>
7 <p>AP: $(wlan.essid)</p>
8 <p> </p><br/>
9 <p> </p><br/>
10 <p> <a href="#system">Firmware</a></p>
11 </card>
12 <card id="system" title="" ontimer="#main" alerts="on">
13 <timer value="50"></timer>
14 <p>Firmware:</p><br/>
15 <p>$(appl.name)</p><br/>
16 <p>ZBI State:</p><br/>
17 <p>$(zbi.key)</p><br/>
18 <p><a href="#main">Main</a>
1
<a href="#config">Config</a></p>
9

19


</card>
20 <card id="config" title="" ontimer="#main" alerts="on">
21 <timer value="50"></timer>
22 <p>Printing </p><br/>
23 <p> Config Label...</p><br/>
24 <p></p><br/>
25 <p>Please wait...</p><br/>
26 <setvar name="file.run" value="e:config.nrd"/>
27 </card>
28 </display>
29 </wml>

18 <p><a href="#main">Main</a> <a href="#config">Config</a></p>

• Defines two links, positioned next to each other - to the "main" and "config" WML cards
26 <setvar name="file.run" value="e:config.nrd"/>
• Defines that the SGD command "file.run" should be used on the "e:config.nrd" file.
• In this instance, the "e:config.nrd" file contains a single ZPL command - "~wc"

6/8/10 Zebra Programming Guide P1012728-004

1084 Wireless Markup Language (WML)
WML Examples

In use, these WML menus look similar to this:

Baud: 9600 Firmware: 
V53.17.2
AP:  125 ZBI State:
Enabled

Firmware Main Config

Printing
Config Label…
Printing
Please wait…
1 of 1…

Note • GX series printers can display four lines of text. If you are using a GX series printer,
remove one line of text from each “card” to use this example.

Example 5
This example demonstrates a WML menu structure with three cards. The "darkness" card
leverages WML and the SGD "print.tone" command to allow the user to both view and
configure a setting.

P1012728-004 Zebra Programming Guide 6/8/10

 Wireless Markup Language (WML) 1085
WML Examples

1 <wml>
2 <display>
3 <card id="main" title="" ontimer="#main" alerts="on">
4 <timer value="50"></timer>
5 <p>Baud: $(comm.baud)</p>
6 <br/>
7 <p>AP: $(wlan.essid)</p>
8 <p> </p><br/>
9 <p> </p><br/>
10 <p> <a href="#system">Firmware</a></p>
11 </card>
12 <card id="system" title="" ontimer="#main" alerts="on">
13 <timer value="50"></timer>
14 <p>Firmware:</p><br/>
15 <p>$(appl.name)</p><br/>
16 <p>ZBI State:</p><br/>
17 <p>$(zbi.key)</p><br/>
18 <p><a href="#main">Main</a> <a href="#darkness">Darkness</a></p>
19 </card>
20 <card id="darkness" title="" ontimer="#main" alerts="on">
21 <timer value="50"></timer>
22 <p>Current: $(print.tone)</p><br/>
23 <p>Change: </p><do type="accept" label="Up"><setvar name="print.tone"
value="+1.0"/></do><br/>
24 <p>Change: </p><do type="accept" label="Down"><setvar name="print.tone"
value="-1.0"/></do><br/>
25 <p> </p><br/>
26 <p><a href="#main">Main</a> <a href="#config">Config</a></p>
27 <card id="config" title="" ontimer="#main" alerts="on">
28 <timer value="50"></timer>
29 <p>Printing </p><br/>
30 <p> Config Label...</p><br/>
31 <p></p><br/>
32 <p>Please wait...</p><br/>
33 <setvar name="file.run" value="e:config.nrd"/>
34 </card>
35 </display>
36 </wml>

23 <p>Change: </p>

• Defines the fixed text "Change: "
<do type="accept" label="Up"><setvar name="print.tone"
value="+1.0"/></do><br/>
• Defines selecting the word "Up" as equal to sending the value "+1.0" for the SGD command
"print.tone". In this case, this increases the setting by 1.0.
24 <p>Change: </p>
• Defines the fixed text "Change: "
do type="accept" label="Down"><setvar name="print.tone"
value="-1.0"/></do><br/>
• Defines selecting the word "Down" as equal to sending the value "-1.0" for the SGD
command "print.tone". In this case, this decreases the setting by 1.0.

6/8/10 Zebra Programming Guide P1012728-004

1086 Wireless Markup Language (WML)
WML Examples

In use, these WML menus look similar to this:

Baud: 9600 Firmware: 
V53.17.2
AP:  125 ZBI State:
Enabled

Firmware Main Darkness

Printing
Config Label…
Printing
Please wait…
1 of 1…

Note • GX series printers can display four lines of text. If you are using a GX series printer,
remove one line of text from each “card” to use this example.

P1012728-004 Zebra Programming Guide 6/8/10

 Wireless Markup Language (WML) 1087
Troubleshooting Scenarios

Troubleshooting Scenarios

Problem Scenario Corrective Actions

I loaded a WML menu structure on • "The WML files may have syntax errors. Reconfirm that the
the printer, but the Factory menu correct syntax has been used. When creating WML files it is
structure is displaying. recommended to start with a simple structure, validate that it's
functional and build additional content onto the "known good"
example
• "Power cycle the printer and watch the start-up sequence - if a
"WML ERROR" message displays during the start-up, the
index.wml file has a syntax error that needs to be corrected.
• "The index.wml file may not have been successfully transferred
to the printer. Use a terminal emulation program and the
following command to retrieve the index.wml file to the PC for
examination:
! U1 setvar "file.type" "E:INDEX.WML"
• "The index.wml file may not be present in the E: memory
location. Validate that the file is present and correctly named.
• "Confirm that straight quotes were used in all instances where
the quote character was used (use the " character - not " or ?).
SGD commands require the use of the straight quote.
• "Confirm that the "WML Menu Cancel" buttons, (Setup and
Cancel or Cancel and Setup/Exit or Select) were not held down
during start up. These actions will cause the standard menu to
display
Some characters in the menu are cut • Characters that extend past the width of the display are
off or some lines are not displaying at truncated, reposition the field as needed.
all. • Check that you have not exceeded that maximum number of
lines the display allows (5 lines on ZM and Xi4 series units, 4
lines on the GX series).
My WML menu structure is • The missing "card" may not have been linked to from any of the
displaying, but one of the “cards” is visible "cards". Review you WML content to ensure that the
not displaying or is unreachable. correct links exist.
• The WML files may have syntax errors, reconfirm that the
correct syntax has been used. When creating WML files it is
recommended to start with a simple structure, validate that it’s
functional and build additional content onto a known good
example.
• If the missing card content is contained in a separate .wml file,
confirm that the necessary .wml files have been transferred to
the printer.

6/8/10 Zebra Programming Guide P1012728-004

1088 Wireless Markup Language (WML)
Troubleshooting Scenarios

Problem Scenario Corrective Actions

My WML menu structure uses SGD • Validate that the correct syntax was used for the SGD command.
commands to display current • Check the manual page for the command being used. Confirm
settings, but the settings are not that the command is supported by the printer & firmware. Use a
displaying. terminal emulation program to send just the command being
used to validate it functions outside the WML menu structure.
• Confirm that straight quotes were used in all instances where the
quote character was used (use the " character – not “ or ? ).
SGD commands require the use of the straight quote.
• Characters that extend past the width of the display are
truncated, reposition the field as needed.
• Check that you have not exceeded that maximum number of
lines the display allows (5 on ZM and Xi4 series units).
My WML menu structure used SGD • Validate that the value being used in the value= parameter of
commands to allow the user to alter the <do> tag is supported by the SGD command.
printer settings, but the settings are • Validate that the correct syntax was used for the SGD command.
not getting changed as expected. • Check the manual page for the command being used. Confirm
that the command is supported by the printer & firmware. Use a
terminal emulation program to send just the command being
used to validate it functions outside the WML menu structure.
• Confirm that straight quotes were used in all instances where the
quote character was used (use the " character – not “ or ̋ ). SGD
commands require the use of the straight quote.
My WML menu structure uses .nrd • Confirm that the .nrd files are present in E: memory and named
files to send commands to the as expected. Resend or rename the files if necessary.
printers ZPL or SGD engine, but the • Confirm that the WML menu structure is using the correct file
commands don’t seem to be getting name(s).
sent when the user selects the on- • Confirm that the commands in the files work as expected,
screen link for the action. independently of the WML menu or .nrd file.
• Validate that ZPL and SGD commands have not been interlaced.
I am using the CISDFCRC16 • Confirm that the Hexadecimal value used for the File Size
command to transfer files, but the parameter is correct. This value must be an eight digit file size
files are either not being transferred specified in hexadecimal which indicates the number of bytes in
to the printer or are showing up with the <data> section of the command. See the full manual page on
a zero (0) byte size. the CISDFCRC16 command for additional details.
• Validate that the CRC and Checksum parameters are correct
(using the "0000" value for these parameters is recommended).
• Confirm that the WML file name and extension are in upper case
characters.
• Confirm that the exclamation mark (!) was included before the
command name ("! CISDFCRC16").

P1012728-004 Zebra Programming Guide 6/8/10

 Glossary

ASCII American Standard Code for Information Interchange. A 7-bit character set that
includes Latin characters, as well as control and punctuation characters.

bidirectional text layout The arrangement of characters with mixed directionality on a

single line. For example, English and Arabic.

big-endian In the encoding, the most significant byte is stored first.

byte order mark BOM; indicates big-endian (BE) or little-endian (LE).

character The smallest component of a writing system that has understanding, refers to the
abstract meaning not the specific shape.

character code Another term for code point.

character set A collection of characters.

character shaping Characters assume different glyphic forms depending on the

context.They can be used with a script-based language.

code point An integral reference number assigned to a character.

coded character set An ordered collection of characters that are assigned an integral
reference number.

combining semantic cluster Consists of an atomic character, a combining character

sequence consisting of a base character plus one or more nonspacing marks, enclosing marks,
combining word joiner, such as an Indic virama, or a sequence of Hangul jamos equivalent to a
Hangual syllable.

diacritic A mark that is added to a letter or other character to change its value or meaning.

encoding The mapping of a characters code points to a sequence of bytes used to represent
the data.

6/8/10 Zebra Programming Guide P1012728-004

1090 Glossary

font An electronic collection of glyphs used for the visual representation of characters.

GB18030 A standard required by the People’s Republic of China for operating systems of
non-handheld computers.

GB 2312 A Chinese character set and encoding.

glyph The visual representation of a character, such as a shape or image. A default glyph
character is typically used when the requested glyph is not available in the font.

grapheme cluster Consists of an atomic character, a combining character sequence

consisting of a base character plus one or more nonspacing marks or enclosing marks, or a
sequence of Hangul jamos equivalent to a Hangul syllable.

ISO 10646 An international standard that defines the Universal Character Set (UCS) and a
character encoding. The UCS matches Unicode.

ISO 8859-1 An encoding standard for representing Western European languages using the
Latin Alphabet.

language A system of sounds and scripts used to represent and communicate concepts,
ideas, meanings, and thoughts.

ligature A glyph representing a combination of two or more characters.

little-endian In the encoding, the least significant byte is stored first.

open type A file format for scalable font files that extends the existing TrueType font file
format used by Microsoft Windows and Apple Macintosh operating systems.OpenType tables
support advanced layout features.

presentation form A pre-combined character, ligature or variant glyph that has a separate
code point; used for compatibility.

script A collection of symbols used to represent textual information in one or more writing
systems.

Shift-JIS A shifted encoding of the Japanese character encoding standard, JIS X 0208,
heavily deployed in PCs.

True type An outline font format that is scalable without quality loss.

Unicode The universal character set and encoding maintained by the Unicode Consortium.

UTF-8 The Unicode encoding that assigns each character code point to a sequence of one to
four bytes.

UTF-16 A Unicode encoding form that represents Unicode code point values in the BMP
with 16-bit code units and Unicode code point values in the supplementary planes with pairs of
16-bit code units.

P1012728-004 Zebra Programming Guide 6/8/10

 Glossary 1091

UTF-16BE A Unicode encoding scheme based on UTF-16 that serializes the bytes in each
code unit in big-endian order.

UTF-16LE A Unicode encoding scheme based on UTF-16 that serializes the bytes in each
code unit in little-endian order.

6/8/10 Zebra Programming Guide P1012728-004

1092 Glossary

Notes • ___________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

__________________________________________________________________________

P1012728-004 Zebra Programming Guide 6/8/10

 Index

Symbols AFI byte

^KC, set client identifier (CID) 424 read command (^RA) 387
^MW 303 write command (^WF) 418
^NB, network boot 425 alphanumeric default font
^NN, set SNMP parameters 426 change 144
^NP, set primary/secondary device 427 antenna parameter setting via ZPL 430
^NT, set SMTP 428 antenna port
^NW, set web authentication timeout value 429 select using ZPL 415
^WA, set antenna parameters 430 appl.bootblock 632
^WE, set wireless encryption values 431 appl.name 633
^WI, change wireless network settings 433 appl.option_board_version 631
^WL, set LEAP parameters 435 applicator functions (ZBI)
^WP, set wireless password 437 AUXPORT_GETPIN 561
^WR, set transmit rate 438 AUXPORT_RELEASEPIN 562
^WS, set wireless radio card values 440 AUXPORT_SETPIN 560
! (EXCLAMATION MARK) ZBI command 460 AUXPORT_STEALPIN 558
~WR, reset wireless radio card and print server 439 description 557
applicator reprint 324
ARP
A setting using external_wired.ip.arp_interval 735
abort download graphic 168 setting using internal_wired.ip.arp_interval 755
absolute mode for RFID 403 ARP interval or cache time out 735, 755, 806, 879
ACCEPT ZBI command 508 array functions
access password description 588
set via ^RQ 398 array functions (ZBI)
set via ^RZ 416 COLUMNSIZE 594
access point DELROW 592
associated 871 FIND 595
MAC address 872 INSERTROW 591
adaptive antenna element selection 400 REDIM 589
ADDBREAK ZBI command 475 ROWSIZE 593
adhoc auto mode 869 authentication
adhoc channel 870 timeout for printer home page 429
advanced counter reset 327 AUTONUM ZBI command 462

6/8/10 Zebra Programming Guide P1012728-004 Rev. A

1094 Index

auxiliary port C
set 253, 256 cache on 152
AUXPORT_GETPIN ZBI command 561 calibration
AUXPORT_RELEASEPIN ZBI command 562 using SGD 703
AUXPORT_SETPIN ZBI command 560 using ZPL (^HR) 381
AUXPORT_STEALPIN ZBI command 558 calibration, setting dynamic media 371
cancel all 242
B cancel format 262
backfeed sequence card.inserted 802
change 265, 266, 335 card.mac_addr 801, 909
bar code field default 138 caret
base types & expressions (ZBI) change 140
LET 484 change alphanumeric default font 144
base types and expressions change backfeed sequence 265, 266, 335
variable names 480 change caret 140
base types and expressions (ZBI) 479 change delimiter 143
arrays 481 change international font 145
assignment 483 change memory letter designation 149
boolean expressions 489 change tilde 155
combined boolean expressions 491 channel mask
constants 481 setting via ^WS 440
numeric expressions 485 CHR$ ZBI command 565
string concatenation 487 circle 203
sub-strings 487 CISDFCRC16
variable declarations 481 download files 634
variable names 481 client identifier 741, 762, 814, 886
battery client identifier (CID) 424
set condition 248 CLIENTSOCKET ZBI command 507
battery status 209 CLOSE ZBI command 503
bitmap font CLRERR ZBI command 555
download 160 CODABLOCK 80
bitmapped fonts 960 considerations for ^FD character set 83
bluetooth.address 786 considerations for the ^BY 82
bluetooth.afh_map 787 code 11 55
bluetooth.afh_map_curr 788 code 128
bluetooth.afh_mode 789 subsets 86
bluetooth.authentication 790 subsets A and C 89
bluetooth.bluetooth_pin 791 subsets a, b, and c 84
bluetooth.date 792 code 39 59
bluetooth.discoverable 793 code 49 63
bluetooth.enable 794 automatic mode 66
bluetooth.friendly_name 795 field data character set 66
bluetooth.local_name 796 code 93 76
bluetooth.radio_auto_baud 797 full ASCII mode 77
bluetooth.radio_version 798 code validation 156
bluetooth.short_address 799 COLUMNSIZE ZBI command 594
bluetooth.version 800 comm.type 803
bootp comma separated values (CSV) ZBI commands
enable or disable 807 CSVLOAD 534
box 201 CSVSTORE 536
BREAK ZBI command 474 description 533
TXTLOAD 537

P1012728-004 Rev. A Zebra Programming Guide 6/8/10

 Index 1095

TXTSTORE 538 delimiter

command structure 630, 732, 785 change 143
Command/Function NAME 452 DELROW ZBI command 592
comment 200 description information
communications diagnostics 246 display 234
enable 246 detect multiple RFID tags (^RN) 397
concantination 195 device.download_connection_timeout 637
configuation device.epl_legacy_mode 638
update 269 device.friendly_name 640
configuration device.frontpanel.key_press 641
using ZPL commands 423, 943, 993 device.frontpanel.line1 642
configuration label device.frontpanel.line2 643
print 357 device.frontpanel.xml 644
Contacts 34 device.jobs_print 645
technical support 34 device.languages 646
control and flow commands (ZBI) device.orientation 647
description 492 device.pnp_option 648
DO loops 494 device.reset 649
END 499 device.restore_defaults 650
EXIT 498 device.unique_id 651
FOR loops 495 device.uptime 652
GOTO/GOSUB 496 device.user_p1 653
IF statements 493 device.user_p2 654
SUB 497 device.xml.enable 655
CSVLOAD ZBI command 534, 538 DHCP
CSVSTORE ZBI command 536 CID prefix 739, 760
CTRL-C ZBI command 468 enable 738, 759
current partially input format diagnostics
cancel 271 disable 247
currently connected printer diagonal line 204
set transparent 312 directory label
Customer service 34 print 358
cutter.clean_cutter 636 disable diagnostics 247
discharge mode
D battery 273
display description information 234
darkness
display RFID tag data
set 330
SGD 704
data log for RFID 380
display.text 656
data matrix 134
do
DATAREADY ZBI command 504
device.restore_defaults 650
date for real time clock
file.dir 658
set 349
media.cut_now 669
DATE ZBI command 600
media.present.eject 674
DATE$ ZBI command 598
do command 629, 731, 784
DEBUG ZBI command 472
DO loops ZBI command 494
define EPC data structure (^RB) 389
double signal mode
define kiosk values 278
setting 404
define language 275
download bitmap font 160
define password 277
download encoding 162
define printer name 276
download files 634
DELBREAK ZBI command 476
download format 164
delete object 236

6/8/10 Zebra Programming Guide P1012728-004 Rev. A

1096 Index

download graphic external wired subnet mask address

abort 168 enable or disable 743
download graphics 165, 172 external_wired.check 733
download Intellifont 169 external_wired.ip.addr 734
download true type font 170 external_wired.ip.arp_interval 735
download unbounded true type font 171 external_wired.ip.default_addr.enable 736
dynamic media calibration, setting 371 external_wired.ip.dhcp.cid_all 737, 758
external_wired.ip.dhcp.cid_enable 738
E external_wired.ip.dhcp.cid_prefix 739
external_wired.ip.dhcp.cid_suffix 740
E.A.S. bit enable/disable command (^RE) 391
external_wired.ip.dhcp.cid_type 741
EAN-13 99
external_wired.ip.gateway 742
EAN-8 72
external_wired.ip.netmask 743
ECHO ZBI command 464
external_wired.ip.port 744
editing commands (ZBI)
external_wired.ip.timeout value 747, 778
! (EXCLAMATION MARK) 460
external_wired.ip.timeout.value 747, 778
AUTONUM ZBI command 462
external_wired.ip.v6.addr 748
description 457
external_wired.ip.v6.gateway 749
ECHO ZBI command 464
external_wired.ip.v6.prefix_length 750
LIST ZBI command 461
external_wired.mac_addr 751
NEW 458
external_wired.mac_raw 752
REM 459
EXTRACT$ ZBI command 574
RENUM ZBI command 463
Electronic Product Code (EPC)
define EPC data structure (^RB) 389 F
write EPC data via ^RQ 398 feedback
write EPC data via ^RZ 416 suppress 368
ellipse 205 field
enable RFID motion (^RM) 396 field reverse 193
encoding orientation 198
download 162 parameter 192
select 331 separator 194
encoding results 412 typeset 195
encryption variable 197
set LEAP parameters 435 field block 176, 177
set values via ZPL 431 field data 181
end format 372 field hexadecimal indicator 182
END ZBI command 499 field number 190
erase download graphics 176 field orientation 198
ESSID field origin 191
printer 876 field parameter 192
setting via ^WS 440 field reverse print 193
events (ZBI) field separator 194
available events 540 field typeset 195
description 539 field variable 197
HANDLEEVENT 547 file system commands (ZBI)
REGISTEREVENT 544 DELETE ZBI command 532
TRIGGEREVENT 549 descripiton 526
UNREGISTEREVENT 546 DIR ZBI command 531
ZBI Key Names 542 LOAD ZBI command 530
EXIT ZBI command 498 STORE ZBI command 529
external wired gateway address file.delete 657
change 742 file.dir 658

P1012728-004 Rev. A Zebra Programming Guide 6/8/10

 Index 1097

file.run 660 bluetooth.friendly_name 795

file.type 659 bluetooth.local_name 796
files bluetooth.radio_auto_baud 797
download 634 bluetooth.radio_version 798
FIND ZBI command 595 bluetooth.short_address 799
firmware bluetooth.version 800
supported RFID tag types for each version 405, card.inserted 802
707 card.mac_addr 801, 909
ZPL command compatibility 376 comm.type 803
flash memory cutter.clean_cutter 636
initialize 243 device.download_connection_timeout 637
font identifier 158 device.epl_legacy_mode 638
font linking 184 device.friendly_name 640
font name device.jobs_print 645
to call font 51 device.languages 646
fonts device.orientation 647
font matrices 966 device.pnp_option 648
standard printer fonts 960 device.uptime 652
FOR loops device.user_p1 653
ZBI command 495 device.user_p2 654
format device.xml.enable 655
cancel 262 display.text 656
download 164 external_wired..ip.arp_interval 735
end 372 external_wired.check 733
pause 262 external_wired.ip.addr 734
recall 369 external_wired.ip.default_addr.enable address
set 367 printer 736
FTP protocol setting 827 external_wired.ip.dhcp.cid_all 737, 758
function rules 453 external_wired.ip.dhcp.cid_enable 738
external_wired.ip.dhcp.cid_prefix 739
G external_wired.ip.dhcp.cid_suffix 740
external_wired.ip.dhcp.cid_type 741
gateway address
external_wired.ip.gateway 742
change 829
external_wired.ip.netmask 743
Gen 2
external_wired.ip.port 744
printers and firmware that support Gen 2 405, 707
external_wired.ip.timeout.value 747, 778
setting password or locking tag 416
external_wired.ip.v6.addr 748
write EPC data to tag via ^RQ 398
external_wired.ip.v6.gateway 749
write EPC data to tag via ^RZ 416
external_wired.ip.v6.prefix_length 750
getvar
external_wired.mac_addr 751
appl.bootblock 632
external_wired.mac_raw 752
appl.name 633
file.dir 658
appl.option_board_version 631
file.type 659
arp_interval 806
head.latch 661
bluetooth.address 786
iip.dhcp.lease.last_attempt 816, 887
bluetooth.afh_map 787
interface.network.active.gateway 662
bluetooth.afh_map_curr 788
interface.network.active.ip_addr 663
bluetooth.afh_mode 789
interface.network.active.mac_addr 664
bluetooth.authentication 790
interface.network.active.mac_raw 665
bluetooth.bluetooth_pin 791
interface.network.active.netmask 666
bluetooth.date 792
interface.network.active.protocol 667
bluetooth.discoverable 793
internal_wired..ip.arp_interval 755
bluetooth.enable 794

6/8/10 Zebra Programming Guide P1012728-004 Rev. A

1098 Index

internal_wired.auto_switchover 753 ip.mac_raw 832

internal_wired.ip.addr 754 ip.mirror.auto 833
internal_wired.ip.default_addr.enable address ip.mirror.error_retry 834
printer 756 ip.mirror.feedback.auto 835
internal_wired.ip.dhcp.cache_ip 757 ip.mirror.feedback.freq 836
internal_wired.ip.dhcp.cid_enable 759 ip.mirror.feedback.odometer 837
internal_wired.ip.dhcp.cid_prefix 760 ip.mirror.feedback.path 838
internal_wired.ip.dhcp.cid_suffix 761 ip.mirror.fetch 839
internal_wired.ip.dhcp.cid_type 762 ip.mirror.freq 840
internal_wired.ip.dhcp.lease.last_attempt 763 ip.mirror.freq_hours 841
internal_wired.ip.dhcp.lease.length 764 ip.mirror.last_error 842
internal_wired.ip.dhcp.lease.server 765 ip.mirror.last_time 843
internal_wired.ip.dhcp.lease.time_left 766 ip.mirror.password 844
internal_wired.ip.dhcp.option12 767 ip.mirror.reset_delay 846
internal_wired.ip.dhcp.option12_format 768 ip.mirror.server 847
internal_wired.ip.dhcp.option12_value 769 ip.mirror.success 848
internal_wired.ip.dhcp.requests_per_session 771 ip.mirror.success_time 849
internal_wired.ip.dhcp.request_timeout 770 ip.mirror.username 850
internal_wired.ip.dhcp.session_interval 772 ip.mirror.version 851
internal_wired.ip.gateway 773 ip.netmask 852
internal_wired.ip.netmask 774 ip.pop3.enable 853
internal_wired.ip.port 775, 899 ip.pop3.password 854
internal_wired.ip.protocol 776 ip.pop3.poll 855
internal_wired.ip.timeout.enable 746, 777 ip.pop3.server_addr 856
internal_wired.mac_addr 779 ip.pop3.username 857
internal_wired.mac_raw 780 ip.port 858
ip.active_network 804 ip.primary_network 859
ip.addr 805 ip.smtp.domain 860
ip.bootp.enable 807 ip.smtp.enable 861
ip.dhcp.cache_ip 808 ip.smtp.server_addr 862
ip.dhcp.cid_all 809 ip.snmp.enable 865
ip.dhcp.cid_enable 810 ip.snmp.get_community_name 863
ip.dhcp.cid_prefix 811 ip.snmp.set_community_name 864
ip.dhcp.cid_suffix 812 ip.tcp.enable 684, 867
ip.dhcp.cid_type 814 ip.telnet.enable 866
ip.dhcp.enable 815 ip.udp.enable 868
ip.dhcp.lease.length 813 media.cartridge.part_number 668
ip.dhcp.lease.server 817 media.media_low.external 671
ip.dhcp.lease.time_left 818 media.media_low.warning 672
ip.dhcp.option12 819 media.present.cut_amount 673
ip.dhcp.option12_format 820 media.present.cut_margin 678
ip.dhcp.option12_value 821 media.present.length_addition 675
ip.dhcp.requests_per_session 823 media.present.loop_length 676
ip.dhcp.request_timeout 822 media.present.loop_length_max 677
ip.dhcp.session_interval 824 media.present.present_timeout 679
ip.dns.domain 825 media.present.present_type 680
ip.dns.servers 826 media.printmode 681
ip.ftp.enable 827 media.speed 683
ip.ftp.execute_file 828 odometer.headclean 684
ip.gateway 829 odometer.headnew 685
ip.http.enable 830 odometer.media_marker_count 687
ip.lpd.enable 831 odometer.media_marker_count1 687

P1012728-004 Rev. A Zebra Programming Guide 6/8/10

 Index 1099

odometer.media_marker_count2 688 wlan.signal_noise 927

odometer.retracts_count 689 wlan.signal_quality 928
odometer.total_print_length 692 wlan.signal_strength 929
print.tone 693 wlan.station_name 930
wlan.adhocautomode 869 wlan.tx_power 931
wlan.adhocchannel 870 wlan.tx_rate 932
wlan.associated 871 wlan.username 933
wlan.bssid 872 wlan.wep.auth_type 934
wlan.channel 873 wlan.wep.index 935
wlan.channel_mask 874 wlan.wep.key1 936
wlan.current_tx.rate 875 wlan.wep.key2 937
wlan.essid 876 wlan.wep.key3 938
wlan.firmware_version 877 wlan.wep.key4 939
wlan.ip.addr 878 wlan.wep.key_format 941
wlan.ip.arp_interval 879 wlan.wpa.psk 940
wlan.ip.default_addr.enable address wlanroam.max_chan_scan_time 917
printer 880 getvar command 628, 730, 783
wlan.ip.dhcp.cache_ip 881 GETVAR ZBI command 604
wlan.ip.dhcp.cid_all 882 GOTO/GOSUB ZBI command 496
wlan.ip.dhcp.cid_enable 883 graphic
wlan.ip.dhcp.cid_prefix 884 box 201
wlan.ip.dhcp.cid_suffix 885 circle 203
wlan.ip.dhcp.cid_type 886 diagonal line 204
wlan.ip.dhcp.lease.length 888 ellipse 205
wlan.ip.dhcp.lease.server 889 field 206
wlan.ip.dhcp.lease.time_left 890 recall 370
wlan.ip.dhcp.option12 891 symbol 208
wlan.ip.dhcp.option12_format 892 graphic field 206
wlan.ip.dhcp.option12_value 893 graphics
wlan.ip.dhcp.requests_per_session 895 download 165, 172
wlan.ip.dhcp.request_timeout 894 erase download 176
wlan.ip.dhcp.session_interval 896 upload 233
wlan.ip.gateway 897 graphing sensor calibration 249
wlan.ip.netmask 898
wlan.ip.protocol 900 H
wlan.ip.timeout.enable 901
HANDLEEVENT ZBI command 547
wlan.ip.timeout.value 902
head test
wlan.keep_alive.enable 903
fatal 260
wlan.keep_alive.timeout 904
interval 268
wlan.kerberos.kdc 905
non-fatal 261
wlan.kerberos.password 906
head test fatal 260
wlan.kerberos.realm 907
head test interval 268
wlan.kerberos.username 908
head test non-fatal 261
wlan.mac_raw 910
head.latch 661
wlan.operating_mode 911
HEXTOINT ZBI command 587
wlan.password 912
host
wlan.preamble 913
directory list 231
wlan.private_key_password 914
graphic 212
wlan.roam.interchannel_delay 915
identification 214
wlan.roam.interval 916
RAM status 215
wlan.roam.signal 918
status return 224
wlan.security 919
host directory list 231

6/8/10 Zebra Programming Guide P1012728-004 Rev. A

1100 Index

host graphic 212 internal wired timeout enable 746, 777

host identification 214 internal wired.ip.timeout enable 746, 777
host linked font list 228 internal.wired.mac_addr 779
host query 216, 360 internal_wired.auto_switchover 753
host RAM status 215 internal_wired.ip.addr 754
host status return 224 internal_wired.ip.arp_interval 755
host verification command (^HV) 230 internal_wired.ip.default_addr.enable 756
~HQ Host Query 360 internal_wired.ip.dhcp.cache_ip 757
HTTP protocol 830 internal_wired.ip.dhcp.cid_enable 759
internal_wired.ip.dhcp.cid_prefix 760
I internal_wired.ip.dhcp.cid_suffix 761
internal_wired.ip.dhcp.cid_type 762
IF statements (ZBI) 493
internal_wired.ip.dhcp.lease.last_attempt 763
image
internal_wired.ip.dhcp.lease.length 764
load 238
internal_wired.ip.dhcp.lease.server 765
move 239
internal_wired.ip.dhcp.lease.time_left 766
save 240
internal_wired.ip.dhcp.option12 767
image load 238
internal_wired.ip.dhcp.option12_format 768
image move 239
internal_wired.ip.dhcp.option12_value 769
image save 240
internal_wired.ip.dhcp.requests_per_session 771
INBYTE ZBI command 514
internal_wired.ip.dhcp.request_timeout 770
industrial 2 of 5 103
internal_wired.ip.dhcp.session_interval 772
initialize Flash memory 243
internal_wired.ip.gateway 773
input and output commands (ZBI)
internal_wired.ip.netmask 774
ACCEPT 508
internal_wired.ip.port 775
CLIENTSOCKET 507
internal_wired.ip.protocol 776
CLOSE 503
internal_wired.ip.timeout.enable 746, 777
DATAREADY 504
internal_wired.mac_addr 779
description 500
internal_wired.mac_raw 780
INBYTE 514
international font
INPUT 510
change 145
OPEN 502
international mode
OUTBYTE 513
setting via ^WS 440
PRINT 512
Introduction to Zebra Basic Interpreter (ZBI) 453
READ 515
INTTOHEX$ ZBI command 586
SEARCHTO$ 517
IP address
SERVERCLOSE 506
printer 734, 754, 805, 878
SERVERSOCKET 505
setting via ip.addr 859
WRITE 516
ip.active_network 804
INPUT ZBI command 510
ip.addr 805
INSERTROW ZBI command 591
ip.arp_interval 806
interface.network.active.gateway 662
ip.bootp.enable 807
interface.network.active.ip_addr 663
ip.dhcp.cache_ip 808
interface.network.active.mac_addr 664
ip.dhcp.cid_all 737, 758, 809
interface.network.active.mac_raw 665
ip.dhcp.cid_enable 810
interface.network.active.netmask 666
ip.dhcp.cid_prefix 811
interface.network.active.protocol 667
ip.dhcp.cid_suffix 812
interleaved
ip.dhcp.cid_type 814
2 of 5 57
ip.dhcp.enable 815
internal wired gateway address
ip.dhcp.lease.last_attempt 816, 887
change 773
ip.dhcp.lease.length 813
internal wired subnet mask address
ip.dhcp.lease.server 817
enable or disable 774

P1012728-004 Rev. A Zebra Programming Guide 6/8/10

 Index 1101

ip.dhcp.lease.time_left 818 K
ip.dhcp.option12 819 Kerberos
ip.dhcp.option12_format 820 password 906
ip.dhcp.option12_value 821 realm 907
ip.dhcp.requests_per_session 823 username 908
ip.dhcp.request_timeout 822 key distribution center (KDC) 905
ip.dhcp.session_interval 824 key rotation
ip.dns.domain 825 firmware version required 448, 923
ip.dns.servers 826 kill battery 273
ip.ftp.enable 827 kill password
ip.ftp.execute_file 828 set via ^RQ 398
ip.gateway 742, 829 set via ^RZ 416
ip.http.enable 830 kiosk values 278
ip.lpd.enable 831
ip.mac_raw 832
ip.mirror.auto 833 L
ip.mirror.error_retry 834 label
ip.mirror.feedback.auto 835 maximum length 294
ip.mirror.feedback.freq 836 reverse print 285
ip.mirror.feedback.odometer 837 shift 286
ip.mirror.feedback.path 838 top 287
ip.mirror.fetch 839 label home 282, 283
ip.mirror.freq 840 label length 284
ip.mirror.freq_hours 841 set 258
ip.mirror.last_error 842 language
ip.mirror.last_time 843 define 275
ip.mirror.password 844 LCASE$ ZBI command 564
ip.mirror.reset_delay 846 LEAP mode
ip.mirror.server 847 setting using ZPL 435
ip.mirror.success 848 LEN ZBI command 578
ip.mirror.success_time 849 LET
ip.mirror.username 850 ZBI command 484
ip.mirror.version 851 Liability 2
ip.netmask 852 linked font
ip.pop3.enable 853 host list 228
ip.pop3.password 854 LIST ZBI command 461
ip.pop3.poll 855 lock RFID tag
ip.pop3.server_addr 856 Gen 2 416
ip.pop3.username 857 not Gen 2 392
ip.port 744, 775, 858, 899 log file for RFID 380
ip.primary_network 859 LOGMARS 109
ip.smtp.domain 860 LPD protocol setting 831
ip.smtp.enable 861 LTRIM$ ZBI command 566
ip.smtp.server_addr 862
ip.snmp.get_community_name 863 M
ip.snmp.server_addr 865
^MA Set Maintenance Alerts 288
ip.snmp.set_community_name 863, 864
MAC address
ip.tcp.enable 867
access point 872
ip.telnet.enable 866
retrieve via external_wired.mac_addr 751
ip.udp.enable 868
retrieve via internal_wired.mac_addr 779
ISERRORd ZBI command 551
maintenance alerts, setting 288
map clear 290

6/8/10 Zebra Programming Guide P1012728-004 Rev. A

1102 Index

math functions modify head warning 303

description 579 motion in RFID label 396
math functions (ZBI) MSI 111
HEXTOINT 587 multiple field origin locations 187
INTTOHEX$ 586
MAX 581 N
MAXNUM 583
network
MIN 582
connect 305
MOD 584
ID number 308
STR$ 580
network boot command 425
VAL 585
network configuration label
MAX ZBI command 581
print 436
maximum label length 294
network connect 305
MAXNUM ZBI command 583
network ID number 308
Media
network operating mode 911
ordering 34
network printers
media
set all transparent 309
darkness 291
network settings
feed 292
setting via ZPL 433
tracking 297
NEW ZBI command 458
type 300
number of retries for block (^RR) 400
media calibration, setting dynamic 371
media darkness 291
media sensor O
set 347 object delete 236
media sensor calibration 245 odometer
set 245 ~WQ 360
media tracking 297 odometer related commands
media type 300 ^JH 250
media.cartridge.part_number 668 ^MA 288
media.cut_now 669 ^MI 293
media.darkness_mode 670 ~HQ 216
media.media_low.external 671 odometer.headclean 684
media.media_low.warning 672 odometer.headnew 685
media.present.cut_amount 673 odometer.label_dot_length 686
media.present.cut_margin 678 odometer.media_marker_count1 687
media.present.eject 674 odometer.media_marker_count2 688
media.present.length_addition 675 odometer.total_print_length 692
media.present.loop_length 676 odometer.headclean 684
media.present.loop_length_max 677 odometer.headnew 685
media.present.present_timeout 679 odometer.label_dot_length 686
media.present.present_type 680 odometer.media_marker_count 687, 688
media.printmode 681 odometer.media_marker_count1 687
media.speed 683 odometer.media_marker_count2 688
memory letter designation odometer.retracts_count 689
change 149 odometer.total_print_length 692
^MI Set Maintenance Information Message 293 offset for real time clock
MIN ZBI command 582 set 341
mirror image ON ERROR ZBI command 556
printing 317 OPEN ZBI command 502
MOD ZBI command 584 option 61 741, 762, 814, 886
mode protection 298 CID prefix 739, 760

P1012728-004 Rev. A Zebra Programming Guide 6/8/10

 Index 1103

enable 738, 759 printer

external_wired.ip.dhcp.cid_enable 738 sleep 373
internal_wired.ip.dhcp.cid_enable 759 printer IP address 734, 754, 805, 878
ip.dhcp.cid_enable 810 printer name
ip.dhcp.cid_prefix 739, 760, 811, 884 define 276
wlan.ip.dhcp.cid_enable 883 printer sleep 373
optional memory Printers, ZBI Keys, & ZBI Versions 454
reset 244 printhead resistance
Ordering ribbon and media 34 set 346
OUTBYTE ZBI command 513 printing mirror image of label 317
private key password 914
P programmable pause 320
programming position
password
setting using SGD 703
define 277
setting using ZPL (^HR) 381
set wireless password via ^WP 437
password for RFID tag 416
pause Q
programmable 320 QR code
pause format 262 normal mode 120
PDF417 68 quantity
consideration for ^FD 71 print 321
permanently lock Gen 2 tag data 416
POP3 R
mailbox 853
read power
mailbox password 854
change using ZPL 413
poll interval 855
read RFID tag
username 857
read or write RFID format (^RF) 392
POP3 server
read RFID tag (^RT) 410
IP address 856
READ ZBI command 515
POS ZBI command 577
real time clock
POSTNET 141
set language 336
power on
set mode 336
reset 264
real time clock date format
preamble length
select 274
radio 913
real time clock time format
pre-shared key value 940
select 274
primary network device
recall format 369
selection by ^NC 304
recall graphic 370
primary/secondary device
REDIM ZBI command 589
setting via ZPL 427
REGISTEREVENT ZBI command 544
print
relative mode for RFID 403
start 325
REM ZBI command 459
width 326
RENUM ZBI command 463
print mode 295
REPEAT$ ZBI command 567
selection via ZPL 295
report RFID encoding results 412
print orientation 319
reprint
print quantity 321
after error 272
print rate 322
applicator 324
print start 325
reset
print width 326
power on 264
PRINT ZBI command 512
reset advanced counter 327
print.tone 693

6/8/10 Zebra Programming Guide P1012728-004 Rev. A

1104 Index

reset optional memory 244 select encoding 331

reset wireless radio card and print server 439 sensor calibration
RESTART ZBI command 469 graphing 249
return data to host computer (^HV) 230 serial communications
return RFID data log to host 380 set 329
RFID serialization data 338
change read power using ZPL 413 serialization field
change write power using ZPL 413 standard ^FD string 332
detect multiple tags (^RN) 397 SERVERCLOSE ZBI command 506
display tag data SERVERSOCKET ZBI command 505
SGD 704 set all network printers transparent 309
enable motion (^RM) 396 set auxiliary port 256
number of retries for block (^RR) 400 set battery condition 248
RFID setup command (^RS) 402 set darkness 330
RFID test set dots
SGD command 705 millimeter 259
verify write operation (^WV) 422 set dots per millimeter 259
RFID counters set dynamic media calibration 371
reset valid label counter by SGD 690 set label length 258
reset void counter by SGD 691 set maintenance alerts 288
resetting by ZPL 327 set maintenance information message 293
RFID mode set RFID tag or kill password (^RZ) 416
selection via ZPL 295 set serial communications 329
RFID programming position set units of measurements 301
setting via ZPL 403 set up RFID information (^RS) 402
RFID tag ID command (^RI) 395 Set/Get/Do interactions
RFID tag types 405, 707 description 602
Ribbon Set/Get/Do interactions (ZBI)
ordering 34 GETVAR 604
ribbon tension SETVAR 603
set 270 SETERR ZBI command 554
ROWSIZE ZBI command 593 setvar
RTRIM$ ZBI command 568 bluetooth.afh_map 787
RUN ZBI command 467 bluetooth.afh_mode 789
running and debugging commands (ZBI) bluetooth.authentication 790
ADDBREAK ZBI command 475 bluetooth.bluetooth_pin 791
BREAK ZBI command 474 bluetooth.discoverable 793
CTRL-C ZBI command 468 bluetooth.enable 794
DEBUG ZBI command 472 bluetooth.friendly_name 795
DELBREAK ZBI command 476 bluetooth.radio_auto_baud 797
description 465 comm.type 803
RESTART ZBI command 469 cutter.clean_cutter 636
RUN ZBI command 467 device.download_connection_timeout 637
STEP ZBI command 471 device.epl_legacy_mode 638
TRACE ZBI command 473 device.friendly_name 640
ZPL ZBI command 478 device.languages 646
device.orientation 647
S device.pnp_option 648
device.reset 649
Sales 34
device.uptime 652
scalable font 49, 960
device.user_p1 653
download Intellifont 169
device.user_p2 654
SEARCHTO$ ZBI command 517

P1012728-004 Rev. A Zebra Programming Guide 6/8/10

 Index 1105

device.xml.enable 655 ip.dns.servers 826

external_wired.check 733 ip.ftp.enable 827
external_wired.ip.addr 734, 736 ip.ftp.execute_file 828
external_wired.ip.arp_interval 735 ip.gateway 829
external_wired.ip.dhcp.cid_all 737, 758 ip.http.enable 830
external_wired.ip.dhcp.cid_enable 738 ip.lpd.enable 831
external_wired.ip.dhcp.cid_prefix 739 ip.mirror.auto 833
external_wired.ip.dhcp.cid_suffix 740 ip.mirror.error_retry 834
external_wired.ip.dhcp.cid_type 741 ip.mirror.feedback.auto 835
external_wired.ip.gateway 742 ip.mirror.feedback.freq 836
external_wired.ip.netmask 743 ip.mirror.feedback.odometer 837
external_wired.ip.port 744 ip.mirror.feedback.path 838
external_wired.ip.timeout value 747, 778 ip.mirror.fetch 839
file.dir 658 ip.mirror.freq 840
file.run 660 ip.mirror.freq_hours 841
file.type 659 ip.mirror.password 844
head.latch 661 ip.mirror.reset_delay 846
internal_wired.auto_switchover 753 ip.mirror.server 847
internal_wired.ip.addr 754, 756 ip.mirror.success 848
internal_wired.ip.arp_interval 755 ip.mirror.success_time 849
internal_wired.ip.dhcp.cid_enable 759 ip.mirror.username 850
internal_wired.ip.dhcp.cid_prefix 760 ip.netmask 852
internal_wired.ip.dhcp.cid_suffix 761 ip.pop3.enable 853
internal_wired.ip.dhcp.cid_type 762 ip.pop3.password 854
internal_wired.ip.dhcp.option12 767 ip.pop3.poll 855
internal_wired.ip.dhcp.option12_format 768 ip.pop3.server_addr 856
internal_wired.ip.dhcp.option12_value 769 ip.pop3.username 857
internal_wired.ip.dhcp.requests_per_session 771 ip.port 858
internal_wired.ip.dhcp.request_timeout 770 ip.primary_network 859
internal_wired.ip.dhcp.session_interval 772 ip.smtp.domain 860
internal_wired.ip.gateway 773 ip.smtp.enable 861
internal_wired.ip.netmask 774 ip.smtp.server_addr 862
internal_wired.ip.port 775, 899 ip.snmp.enable 865
internal_wired.ip.protocol 776 ip.snmp.get_community_name 863
internal_wired.ip.timeout enable 746, 777 ip.snmp.set_community_name 864
ip.active_network 804 ip.tcp.enable 867
ip.addr 805 ip.telnet.enable 866
ip.arp_interval 806 ip.udp.enable 868
ip.bootp.enable 807 media.cut_now 669
ip.dhcp.cid_all 809 media.darkness_mode 670
ip.dhcp.cid_enable 810 media.media_low.warning 672
ip.dhcp.cid_prefix 811 media.present.cut_amount 673
ip.dhcp.cid_suffix 812 media.present.cut_margin 678
ip.dhcp.cid_type 814 media.present.eject 674
ip.dhcp.enable 815 media.present.length_addition 675
ip.dhcp.option12 819 media.present.loop_length 676
ip.dhcp.option12_format 820 media.present.loop_length_max 677
ip.dhcp.option12_value 821 media.present.present_timeout 679
ip.dhcp.requests_per_session 823 media.present.present_type 680
ip.dhcp.request_timeout 822 media.printmode 681
ip.dhcp.session_interval 824 media.speed 683
ip.dns.domain 825 odometer.headclean 684

6/8/10 Zebra Programming Guide P1012728-004 Rev. A

1106 Index

odometer.headnew 685 wlan.wep.key4 939

odometer.media_marker_count 687 wlan.wep.key_format 941
odometer.media_marker_count1 687 wlan.wpa.psk 940
odometer.media_marker_count2 688 setvar command 628, 730, 783
odometer.retracts_count 689 SETVAR ZBI command 603
print.tone 693 SGD command structure 630, 732, 785
wlan.adhocautomode 869 SGTIN-64 standard programming example 390
wlan.adhocchannel 870 single signal mode
wlan.channel_mask 874 setting 404
wlan.essid 876 SLEEP ZBI command 553
wlan.ip.addr 878, 880 slew
wlan.ip.arp_interval 879 home position 315
wlan.ip.dhcp.cid_all 882 slew given number
wlan.ip.dhcp.cid_enable 883 dot rows 314
wlan.ip.dhcp.cid_prefix 884 slew to home position 315
wlan.ip.dhcp.cid_suffix 885 SMTP IP address 862
wlan.ip.dhcp.cid_type 886 SMTP parameters
wlan.ip.dhcp.option12 891 setting via ZPL 428
wlan.ip.dhcp.option12_format 892 SMTP protocol 860, 861
wlan.ip.dhcp.option12_value 893 SNMP
wlan.ip.dhcp.requests_per_session 895 get community 863
wlan.ip.dhcp.request_timeout 894 set community 864
wlan.ip.dhcp.session_interval 896 SNMP parameters
wlan.ip.gateway 897 setting via ZPL 426
wlan.ip.netmask 898 SNMP protocol 865
wlan.ip.protocol 900 SNMP query 863
wlan.ip.timeout enable 901 specify number of retries for block (^RR) 400
wlan.ip.timeout value 902 SPLIT ZBI command 569
wlan.keep_alive.enable 903 SPLITCOUNT ZBI command 572
wlan.keep_alive.timeout 904 standard printer fonts 960
wlan.kerberos.kdc 905 start print 342
wlan.kerberos.password 906 start ZBI 253
wlan.kerberos.realm 907 STEP ZBI command 471
wlan.kerberos.username 908 STR$ ZBI command 580
wlan.operating_mode 911 string functions (ZBI)
wlan.password 912 CHR$ 565
wlan.preamble 913 description 563
wlan.private_key_password 914 EXTRACT$ 574
wlan.roam.interchannel_delay 915 LCASE$ 564
wlan.roam.interval 916 LEN 578
wlan.roam.max_chan_scan_time 917 LTRIM$ 566
wlan.roam.signal 918 POS 577
wlan.security 919 REPEAT$ 567
wlan.station_name 930 RTRIM$ 568
wlan.tx_power 931 SPLIT 569
wlan.tx_rate 932 SPLITCOUNT 572
wlan.username 933 UCASE$ 573
wlan.wep.auth_type 934 SUB ZBI command 497
wlan.wep.index 935 subnet mask
wlan.wep.key1 936 change 743, 774
wlan.wep.key2 937 subnet mask address
wlan.wep.key3 938 enable or disable 852

P1012728-004 Rev. A Zebra Programming Guide 6/8/10

 Index 1107

supported download 170

printers 454 TXTLOAD ZBI command 537
symbol 208, 211
systems (ZBI) U
CLRERR 555
UCASE$ ZBI command 573
description 550
UDP communication 744, 775, 858, 899
ISERRORd 551
UDP socket protocol 868
ON ERROR 556
unbounded true type font
SETERR 554
download 171
SLEEP 553
units of measurement
TRIGGEREVENT 552
set 301
UNREGISTEREVENT ZBI command 546
T UPC/EAN extensions 127
tag type UPC-A 132
specify using SGD 706 UPC-E 74
specify using ZPL 402 update configuration 269
TCP communication 744, 775, 858, 899 upload graphics 233
TCP socket protocol 867 UPS maxicode 96
tear-off adjust position 353 considerations for ^FD 97
Technical support 34 use font name to call font 51
TELNET protocol 866
terminate ZBI 263 V
text blocks 354
VAL ZBI command 585
text properties
valid RFID label counter
advanced 313
reset by SGD 690
tilde
reset by ZPL 327
change 155
verify RFID write operation (^WV) 422
time and date functions
void RFID label counter
description 597
reset by SGD 691
time and date functions (ZBI)
reset by ZPL 327
DATE 600
DATE$ 598
TIME 601 W
TIME$ 599 web authentication timeout value 429
time for real time clock web pages
set 349 set timeout value 429
TIME ZBI command 601 web server setting 830
TIME$ ZBI command 599 WEP key format 941
timeout value 747, 778 WEP mode
timeout value for printer home page 429 setting encryption index via ^WX 443
TRACE ZBI command 473 width
transfer object 355 print 326
transmit rate wired equivalent privacy 935
setting via ^WR 438 wired print server
transponder calibration ^NB to set check for 425
using SGD 703 wireless password
using ZPL (^HR) 381 setting via ^WP 437
TRIGGEREVENT ZBI command 549, 552 Wireless Print Server
troubleshooting ZPL commands 943, 993
RFID test wireless print server
SGD command 705 change network settings 433
true type font wireless pulse and interval

6/8/10 Zebra Programming Guide P1012728-004 Rev. A

1108 Index

setting via ^WS 440 wlan.private_key_password 914

wireless radio card wlan.roam.interchannel_delay 915
reset via ZPL 439 wlan.roam.interval 916
setting values via ^WS 440 wlan.roam.max_chan_scan_time 917
wireless timeout enable 901 wlan.roam.signal 918
wlan gateway address wlan.security 919
change 897 wlan.signal_noise 927
wlan subnet mask address wlan.signal_quality 928
enable or disable 898 wlan.signal_strength 929
wlan.adhocautomode 869 wlan.station_name 930
wlan.adhocchannel 870 wlan.tx_power 931
wlan.associated 871 wlan.tx_rate 932
wlan.bssid 872 wlan.username 933
wlan.channel 873 wlan.wep.auth_type 934
wlan.channel_mask 874 wlan.wep.index 935
wlan.current_tx_rate 875 wlan.wep.key1 936
wlan.essid 876 wlan.wep.key2 937
wlan.firmware_version 877 wlan.wep.key3 938
wlan.ip.addr 878 wlan.wep.key4 939
wlan.ip.arp_interval 879 wlan.wep.key_format 941
wlan.ip.default_addr.enable 880 wlan.wpa.psk 940
wlan.ip.dhcp.cache_ip 881 write AFI byte command (^WF) 418
wlan.ip.dhcp.cid_all 882 write data to tag
wlan.ip.dhcp.cid_enable 883 via ^RQ 398
wlan.ip.dhcp.cid_prefix 884 via ^RZ 416
wlan.ip.dhcp.cid_suffix 885 write power
wlan.ip.dhcp.cid_type 886 change using ZPL 413
wlan.ip.dhcp.lease.length 888 write RFID format (^RF) 392
wlan.ip.dhcp.lease.server 889 write RFID tag (^WT) 420
wlan.ip.dhcp.lease.time_left 890 WRITE ZBI command 516
wlan.ip.dhcp.option12 891 Writing ZBI Programs 456
wlan.ip.dhcp.option12_format 892
wlan.ip.dhcp.option12_value 893 X
wlan.ip.dhcp.requests_per_session 895
^XS Set Dynamic Calibration Defaults 371
wlan.ip.dhcp.request_timeout 894
wlan.ip.dhcp.session_interval 896
wlan.ip.gateway 897 Z
wlan.ip.netmask 898 ZBI
wlan.ip.protocol 900 Command/Function Name description 452
wlan.ip.timeout enable 901 function rules 453
wlan.ip.timeout value 902 start 253
wlan.ip.timeout.enable 901 terminate 263
wlan.keep_alive.enable 903 ZBI character set 1015
wlan.keep_alive.timeout 904 ZBI commands
wlan.kerberos.kdc 905 ! (EXCLAMATION MARK) 460
wlan.kerberos.password 906 ACCEPT 508
wlan.kerberos.realm 907 ADDBREAK 475
wlan.kerberos.username 908 AUTONUM 462
wlan.mac_raw 910 AUXPORT_GETPIN 561
wlan.operating_mode 911 AUXPORT_RELEASEPIN 562
wlan.password 912 AUXPORT_SETPIN 560
wlan.preamble 913 AUXPORT_STEALPIN 558

P1012728-004 Rev. A Zebra Programming Guide 6/8/10

 Index 1109

BREAK 474 REGISTEREVENT 544

CHR$ 565 REM 459
CLIENTSOCKET 507 RENUM 463
CLOSE 503 REPEAT$ 567
CLRERR 555 RESTART 469
COLUMNSIZE 594 ROWSIZE 593
CSVLOAD 534 RTRIM$ 568
CSVSTORE 536 RUN 467
CTRL-C 468 SEARCHTO$ 517
DATAREADY 504 SERVERCLOSE 506
DATE 600 SERVERSOCKET 505
DATE$ 598 SETERR 554
DEBUG 472 SETVAR 603
DELBREAK 476 SLEEP 553
DELETE 532 SPLIT 569
DELROW 592 SPLITCOUNT 572
DIR 531 STEP 471
DO loops 494 STORE 529
ECHO 464 STR$ 580
END 499 SUB 497
EXIT 498 TIME 601
EXTRACT$ 574 TIME$ 599
FIND 595 TRACE 473
FOR loops 495 TRIGGEREVENT 549, 552
GETVAR 604 TXTLOAD 537
GOTO/GOSUB 496 TXTSTORE 538
HANDLEEVENT 547 UCASE$ 573
HEXTOINT 587 UNREGISTEREVENT 546
IF statements 493 VAL 585
INBYTE 514 WRITE 516
INPUT 510 ZBI Key Names 542
INSERTROW 591 ZPL 478
INTTOHEX$ 586 ZBI keys 454
ISERRORd 551 ZBI printers 454
LCASE$ 564 ZBI versions 454
LEN 578 1.0 through 1.5 454
LET 484 2.0 and higher 454
LIST 461 zbi.control.add_breakpoint 709
LOAD 530 zbi.control.break 710
LTRIM$ 566 zbi.control.clear_breakpoints 711
MAX 581 zbi.control.delete_breakpoint 712
MAXNUM 583 zbi.control.line_number 713
MIN 582 zbi.control.restart 714
MOD 584 zbi.control.run 715
NEW 458 zbi.control.step 716
ON ERROR 556 zbi.control.terminate 717
OPEN 502 zbi.control.variable_name 718
OUTBYTE 513 zbi.control.variable_value 719
POS 577 zbi.key 720
PRINT 512 zbi.last_error 721
READ 515 zbi.reseller_key 722
REDIM 589 zbi.revision 723

6/8/10 Zebra Programming Guide P1012728-004 Rev. A

1110 Index

zbi.running_program_name 724
zbi.start_info.execute 725
zbi.start_info.file_name 726
zbi.start_info.memory_alloc 727
zbi.state 728
Zebra Programming Language (ZPL II)
^HL or ~HL, Return RFID Data Log to Host (^HL
or ~HL) 380
^HR, Calibrate RFID Transponder 381
^RA, Read AFI Byte 387
^RB, Define EPC Data Structure 389
^RE, Enable/Disable E.A.S. Bit 391
^RF, Read or Write RFID Format 392
^RI, Get RFID Tag ID 395
^RM, Enable RFID Motion 396
^RN, Detect Multiple RFID Tags 397
^RQ, Quick Write EPC Data and Passwords 398
^RR, Specify RFID Retries for a Block 400
^RS, RFID Setup 402
^RT, Read RFID Tag 410
^RW, Set RFID Read and Write Power 413
^RZ, Set RFID Tag Password and Lock Tag 416
^WF, Write AFI Byte 418
^WT, Write Tag 420
^WV, Verify RFID Write Operation 422
~RV, Report RFID Encoding Results 412
command compatibility with printers and firmware
376
ZebraNet Alert
halt 344
set 350
ZPL
set 352
ZPL commands 423
^B7 68
~HQ 250, 360
^MA 288
^MI 293
Wireless Print Server commands 943, 993
^XS 371
ZPL ZBI command 478

P1012728-004 Rev. A Zebra Programming Guide 6/8/10

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

http://www.zebra.com

© 2010 ZIH Corp.

P1012728-004 Rev. A