Command Reference Guide
M00097706
Rev. G
1.No part of this document may be reproduced, stored in a retrieval system, or transmitted in any form or by any means, electronic, mechanical, photocopying, recording, or otherwise, without the prior written permission of Seiko Epson Corporation.
2.The contents of this document are subject to change without notice. Please contact us for the latest information.
3.While every precaution has been taken in the preparation of this document, Seiko Epson Corporation assumes no responsibility for errors or omissions.
4.Neither is any liability assumed for damages resulting from the use of the information contained herein.
5.Neither Seiko Epson Corporation nor its affiliates shall be liable to the purchaser of this product or third parties for damages, losses, costs, or expenses incurred by the purchaser or third parties as a result of: accident, misuse, or abuse of the product(s) to which this document relates or unauthorized modifications, repairs, or alterations to the product(s) to which this document relates, or (excluding the U.S.) failure to strictly comply with Seiko Epson Corporation's operating and maintenance instructions.
6.Seiko Epson Corporation shall not be liable against any damages or problems arising from the use of any options or any consumable products other than those designated as Original EPSON Products or EPSON Approved Products by Seiko Epson Corporation
EPSON is a registered trademark of Seiko Epson Corporation.
Exceed Your Vision and ESC/Label are registered trademarks or trademarks of Seiko Epson Corporation.
Zebra Technologies Corporation and ZPL II are the registered trademarks or trademarks of Zebra Technologies Corporation. General Notice: Other product and company names used herein are for identification purposes only and may be trademarks of their respective companies.
All other trademarks are the property of their respective owners and used for identification purpose only. ©Seiko Epson Corporation 2016-2020. All rights reserved.
ESC/Label Command Reference Guide |
|
Rev. G |
Page 2 |
(1)Scope of this document
This document describes ESC/Label commands. ESC/Label commands are used to control Epson’s label printers.
This document is designed for those who use ESC/Label commands to develop programs to control printers. Please refer to the ESC/Label Application Development Guide when developing programs. Refer to the attached Command List for commands used and definition ranges for each model.
(2)Content of the specification
The content of this document is outlined below.
|
Content of the specification |
|
|
Item |
Description |
About this Document |
Positioning and content of this document, definitions (terminology, |
|
expressions) |
1 Commands Outline |
Characteristics, configuration, basic specifications, and usage |
|
examples of ESC/Label commands |
2 Primary Functions |
Key features of the ESC/Label command |
3 Detailed Command |
Detailed specifications of the ESC/Label command |
Specifications |
|
Appendix |
The list of the mode and the setting |
Command List (Attachment) |
Indicates commands used by model and their corresponding |
|
parameter definition ranges in the commands included in the |
|
ESC/Label commands. |
(3)Definitions
(a)Hexadecimal values are expressed with numbers 0 – 9 and letters A – F, along with the letter H (first letter of HEX).
Example: 1AH
(b)Outside of command code descriptions, commands are enclosed within double quotation marks and command codes are enclosed in parentheses.
Example: "^F(C" (field color settings)
(c)Units are expressed by the unit name enclosed in square brackets. Examples: [dot], [mm]
(d)The following are enclosed in angle brackets.
Control codes |
Examples: |
<CR>, <STX> |
Uniquely defined terms |
Example: |
<prefix character> |
Non-alphanumeric characters |
Example: |
Comma <,> |
ESC/Label Command Reference Guide |
|
Rev. G |
Page 3 |
1. Commands Outline ......................................................................................................................................................... |
8 |
|
1.1. |
Characteristics.......................................................................................................................................................... |
8 |
1.2. |
Structure ................................................................................................................................................................... |
9 |
1.3. |
Command Basic Specifications........................................................................................................................... |
10 |
|
1.3.1 Format Commands and Control Commands .............................................................................................. |
10 |
|
|
1.3.2 Basic Data Format for the Command............................................................................................................ |
10 |
|
|
1.3.3 |
Command Syntax ............................................................................................................................................. |
12 |
|
1.3.4 About Saving the Graphics and Label Formats in the Printer.................................................................. |
12 |
|
|
1.4. Example of Command Use.................................................................................................................................. |
13 |
|
|
1.4.1 |
Basic Label Printing .......................................................................................................................................... |
13 |
|
1.4.2 |
Color Label Printing.......................................................................................................................................... |
14 |
|
1.4.3 |
Serialized Printing............................................................................................................................................. |
15 |
|
1.4.4 Saving a File for a Label Format ..................................................................................................................... |
16 |
|
|
1.4.5 Printing Using the Label Format File ............................................................................................................ |
17 |
|
|
1.4.6 |
Getting Status.................................................................................................................................................... |
18 |
2. |
Primary Functions.......................................................................................................................................................... |
19 |
|
|
2.1. |
Fonts........................................................................................................................................................................ |
19 |
|
2.1.1 |
Font type ............................................................................................................................................................ |
20 |
|
2.1.2 |
Special symbols................................................................................................................................................. |
21 |
|
2.2. |
Media settings ....................................................................................................................................................... |
21 |
|
2.2.1 |
Media coating type........................................................................................................................................... |
21 |
|
2.2.2 |
Media form......................................................................................................................................................... |
22 |
|
2.2.3 |
Label edge detection ....................................................................................................................................... |
22 |
|
2.2.4 |
Media source ..................................................................................................................................................... |
22 |
|
2.2.5 |
Media shape....................................................................................................................................................... |
22 |
|
2.3. |
Errors........................................................................................................................................................................ |
23 |
|
2.4. |
Print area................................................................................................................................................................. |
24 |
|
2.4.1 Leading edge and direction definitions ....................................................................................................... |
25 |
|
|
2.4.2 |
Reference position definitions ....................................................................................................................... |
26 |
|
2.4.3 |
Maximum printable area................................................................................................................................. |
27 |
|
2.4.4 Printable area and mount settings................................................................................................................ |
28 |
|
|
2.4.5 Print area and margin settings....................................................................................................................... |
29 |
|
|
2.4.6 Print requests outside the print area ............................................................................................................ |
30 |
|
|
2.4.7 Print area settings using ZPL II commands.................................................................................................. |
31 |
|
|
2.5. Getting and Setting Printer Information .......................................................................................................... |
32 |
|
|
2.5.1 Method for Setting Printer Information ....................................................................................................... |
33 |
|
|
2.5.2 Method for Getting Printer Information....................................................................................................... |
34 |
|
|
2.6. |
Designating Color ................................................................................................................................................. |
36 |
|
2.7. |
Field color reversal................................................................................................................................................ |
38 |
|
2.8. |
Printing Graphics................................................................................................................................................... |
40 |
|
2.8.1 Registering a Graphic in a Printer and Printing It ....................................................................................... |
40 |
|
|
2.8.2 Embedding a Graphic in the Field and Printing It ...................................................................................... |
41 |
|
3. |
Detailed Command Specifications ............................................................................................................................. |
42 |
|
|
^A...................................................................................................................................................................................... |
|
43 |
|
^A@ |
.................................................................................................................................................................................. |
44 |
|
^B(Q.................................................................................................................................................................................. |
45 |
|
|
^B(R |
.................................................................................................................................................................................. |
48 |
|
^B(V |
.................................................................................................................................................................................. |
50 |
|
^B0 ^BO........................................................................................................................................................................... |
51 |
|
|
|
||
ESC/Label Command Reference Guide |
|
||
Rev. G |
|
Page 4 |
^B2.................................................................................................................................................................................... |
|
53 |
^B3.................................................................................................................................................................................... |
|
54 |
^B7.................................................................................................................................................................................... |
|
55 |
^B8.................................................................................................................................................................................... |
|
57 |
^B9.................................................................................................................................................................................... |
|
58 |
^BA ................................................................................................................................................................................... |
|
60 |
^BC ................................................................................................................................................................................... |
|
63 |
^BD................................................................................................................................................................................... |
|
68 |
^BE.................................................................................................................................................................................... |
|
70 |
^BF.................................................................................................................................................................................... |
|
71 |
^BK.................................................................................................................................................................................... |
|
73 |
^BQ................................................................................................................................................................................... |
|
74 |
^BR.................................................................................................................................................................................... |
|
78 |
^BU ................................................................................................................................................................................... |
|
80 |
^BX ................................................................................................................................................................................... |
|
81 |
^BY.................................................................................................................................................................................... |
|
85 |
^C(D.................................................................................................................................................................................. |
|
86 |
^C(L .................................................................................................................................................................................. |
|
87 |
^C(S .................................................................................................................................................................................. |
|
88 |
^CC |
~CC ....................................................................................................................................................................... |
89 |
^CD |
~CD ...................................................................................................................................................................... |
90 |
^CF.................................................................................................................................................................................... |
|
91 |
^CI..................................................................................................................................................................................... |
|
92 |
^CM .................................................................................................................................................................................. |
|
94 |
^CT |
~CT........................................................................................................................................................................ |
95 |
^CV ................................................................................................................................................................................... |
|
96 |
^CW .................................................................................................................................................................................. |
|
97 |
~DE ................................................................................................................................................................................... |
|
98 |
^DF ................................................................................................................................................................................... |
|
99 |
~DG................................................................................................................................................................................. |
|
100 |
~DN................................................................................................................................................................................. |
|
102 |
~DU................................................................................................................................................................................. |
|
103 |
~DY ................................................................................................................................................................................. |
|
104 |
^F(C ................................................................................................................................................................................ |
|
107 |
^FB.................................................................................................................................................................................. |
|
109 |
^FC.................................................................................................................................................................................. |
|
110 |
^FD ................................................................................................................................................................................. |
|
111 |
^FH ................................................................................................................................................................................. |
|
112 |
^FM................................................................................................................................................................................. |
|
113 |
^FN ................................................................................................................................................................................. |
|
114 |
^FO ................................................................................................................................................................................. |
|
115 |
^FP.................................................................................................................................................................................. |
|
117 |
^FR.................................................................................................................................................................................. |
|
118 |
^FS .................................................................................................................................................................................. |
|
119 |
^FT.................................................................................................................................................................................. |
|
120 |
^FV.................................................................................................................................................................................. |
|
123 |
^FW ................................................................................................................................................................................ |
|
124 |
^FX.................................................................................................................................................................................. |
|
126 |
^GB ................................................................................................................................................................................. |
|
127 |
^GC................................................................................................................................................................................. |
|
128 |
ESC/Label Command Reference Guide |
|
|
Rev. G |
|
Page 5 |
^GD................................................................................................................................................................................. |
129 |
^GE ................................................................................................................................................................................. |
130 |
^GF ................................................................................................................................................................................. |
131 |
^GS ................................................................................................................................................................................. |
133 |
~H(C................................................................................................................................................................................ |
134 |
~H(I ................................................................................................................................................................................. |
136 |
~H(Q ............................................................................................................................................................................... |
139 |
~H(S ................................................................................................................................................................................ |
142 |
~H(Y................................................................................................................................................................................ |
144 |
^HF ................................................................................................................................................................................. |
146 |
^HG................................................................................................................................................................................. |
147 |
^HH................................................................................................................................................................................. |
148 |
~HI .................................................................................................................................................................................. |
149 |
~HM................................................................................................................................................................................ |
150 |
~HS ................................................................................................................................................................................. |
151 |
^HW................................................................................................................................................................................ |
153 |
^HY ................................................................................................................................................................................. |
155 |
^ID .................................................................................................................................................................................. |
156 |
^IL ................................................................................................................................................................................... |
157 |
^IM.................................................................................................................................................................................. |
158 |
^IS ................................................................................................................................................................................... |
159 |
~J(C................................................................................................................................................................................. |
160 |
~J(M................................................................................................................................................................................ |
161 |
~JA.................................................................................................................................................................................. |
162 |
^JB .................................................................................................................................................................................. |
163 |
~JC .................................................................................................................................................................................. |
164 |
^JM ................................................................................................................................................................................. |
165 |
~JP .................................................................................................................................................................................. |
166 |
~JR .................................................................................................................................................................................. |
167 |
~JS................................................................................................................................................................................... |
168 |
^JU.................................................................................................................................................................................. |
169 |
~JX .................................................................................................................................................................................. |
170 |
^JZ .................................................................................................................................................................................. |
171 |
^KL.................................................................................................................................................................................. |
172 |
^LH ................................................................................................................................................................................. |
173 |
^LR.................................................................................................................................................................................. |
174 |
^LS .................................................................................................................................................................................. |
175 |
^LT .................................................................................................................................................................................. |
176 |
^MC ................................................................................................................................................................................ |
177 |
^MF................................................................................................................................................................................. |
178 |
^MM ............................................................................................................................................................................... |
179 |
^MN................................................................................................................................................................................ |
180 |
^MP ................................................................................................................................................................................ |
181 |
^MU................................................................................................................................................................................ |
182 |
^PH ................................................................................................................................................................................. |
184 |
~PH ................................................................................................................................................................................. |
186 |
^PM ................................................................................................................................................................................ |
187 |
^PO................................................................................................................................................................................. |
188 |
^PP.................................................................................................................................................................................. |
191 |
~PP.................................................................................................................................................................................. |
192 |
ESC/Label Command Reference Guide |
|
Rev. G |
Page 6 |
^PQ................................................................................................................................................................................. |
|
193 |
~PS.................................................................................................................................................................................. |
|
194 |
~RO................................................................................................................................................................................. |
|
195 |
^S(C ................................................................................................................................................................................ |
|
196 |
^SE.................................................................................................................................................................................. |
|
197 |
^SF .................................................................................................................................................................................. |
|
198 |
^SL .................................................................................................................................................................................. |
|
199 |
^SN ................................................................................................................................................................................. |
|
200 |
^SO ................................................................................................................................................................................. |
|
201 |
^ST.................................................................................................................................................................................. |
|
202 |
~TA ................................................................................................................................................................................. |
|
203 |
^TB.................................................................................................................................................................................. |
|
204 |
^TO ................................................................................................................................................................................. |
|
205 |
~W(P ............................................................................................................................................................................... |
|
206 |
~WC ................................................................................................................................................................................ |
|
207 |
^WD................................................................................................................................................................................ |
|
208 |
^XA ................................................................................................................................................................................. |
|
209 |
^XB ................................................................................................................................................................................. |
|
210 |
^XF.................................................................................................................................................................................. |
|
211 |
^XG................................................................................................................................................................................. |
|
212 |
^XZ ................................................................................................................................................................................. |
|
213 |
Appendix A: |
List of Printer Operation Modes .......................................................................................................... |
214 |
Appendix B: |
List of Printer Operation Statuses ....................................................................................................... |
227 |
Appendix C: |
List of Printer Information .................................................................................................................... |
232 |
REVISION SHEET (Summary) ............................................................................................................................................... |
233 |
|
REVISION SHEET (Detail)...................................................................................................................................................... |
234 |
ESC/Label Command Reference Guide |
|
Rev. G |
Page 7 |
ESC/Label command is a command system that has the following characteristics.
(1)It includes much of the ZPL II command and is highly compatible with your existing system.
(2)The command is primarily in the text data format and is highly compatible with database or Web technology.
(3)It can arrange text, barcodes, or graphics in any position on the label and perform color printing.
(4)It is well-suited for batch printing through the serialized designation function and the print count designation function.
(5)Due to its simple command syntax, it helps prevent printing mistakes from failing to control the printer.
(6)Because you can save the graphic and label format in the printer, you can print labels with a small amount of transmitted data.
(7)You can get the printer operation status or the printer operation mode whenever you like.
ESC/Label Command Reference Guide |
|
Rev. G |
Page 8 |
ESC/Label command consists of the major commands of the ZPL II command and Epson's original extension.
(1)It includes the major commands for ZPL II, which is mainstream in the monochrome thermal label printer market.
(2)Epson's original commands and parameter expansions are included to realize color label printing on an inkjet printer.
ESC/label command
ZPL II
ZPL II
Commands necessary for label printing and inkjet printer control
*Epson parameter expands on some commands.
Commands not included in ESC/label command
Epson additional commands
Epson original expansions
Figure 1.2.1 Structure of ESC/Label command
Table1.2.1 indicates the parts of ZPL II commands not included in ESC/Label command.
Table 1.2.1 Excerpt of Commands Not Included in ESC/Label command
Command type |
Example |
Thermal head device control commands |
Setting the thermal head resistance value |
RFID control commands |
Reading, writing the RFID |
Commands related to wireless |
Wireless LAN settings |
Commands related to battery control |
Transmitting battery status |
ESC/Label Command Reference Guide |
|
Rev. G |
Page 9 |
Commands for ESC/Label command belong to either format commands or control commands, depending on their purpose and execution priority.
Format commands are used for defining and printing labels, and control commands are used for controlling the printer. Format commands and control commands have their own fixed prefix character, so the type can be determined based on the prefix character in the command code.
Format commands are executed FIFO (First In, First Out). A part of control commands are executed with priority over format commands.
Table 1.3.1 Command Type by Purpose
Type |
Main purpose |
Prefix character |
Format Command |
Defining and printing labels |
Caret <^> |
Control Command |
Controlling the printer |
Tilde <~> |
ESC/Label command is defined in a character string of ASCII code (20h to 7Eh). The command format is as follows.
<Prefix character> |
<Command identifier> <Parameter> (,<Parameter>,...) |
<Command code> |
|
<Prefix character>: |
Indicate a format command with a caret <^> and a control |
|
command with a tilde <~>. |
<Command identifier>: Indicate the command type with 1 to 3 characters of ASCII |
|
|
code. |
<Parameters>: |
Designate 1 character or more of ASCII code. This controls |
|
the command functions. Whether there are parameters or not |
|
and their number depend on the command type. |
The <command code> is defined as both the <prefix character> and the <command identifier>.
Commands without a parameter will be a command with just the command code. Commands with 2 or more parameters must be punctuated by a comma <,> when listed. The number of parameters a command can have depends on the command type.
ESC/Label Command Reference Guide |
|
Rev. G |
Page 10 |
(1)ESC/Label command Additional Command Format
In order to differentiate the command added to ESC/Label command from the ZPL II command, use this format, which has added the following limit to the command identifier.
<Command identifier>: 3 characters (1 character ASCII code, an opening parenthesis <(>, and 1 character ASCII code) indicate the command type.
(2)Omitted Designation of Parameters
If 2 commas <,> are input following one another and the parameters are omitted, the printer will assume default parameters are being designated. Whether there are default command parameters depends on the command. If you omit parameter for a command which the parameter cannot be omitted, the command will be invalid.
(3)Parameter Rounding
Parameters must take the format of being a numerical value, a fixed character string, or an undefined length character string. Depending on the format and conditions, the parameter may be invalid or may be rounded.
Table 1.3.2 Parameter Rounding Processing
Format |
Conditions |
Processing |
Numerical va lue |
Value that exceeds the upper limit is |
The printer assumes the upper limit was |
|
designated |
designated. |
|
Value less than the lower limit is |
The printer assumes the lower limit was |
|
designated |
designated. |
Fixed character |
Undefined characters are designated |
Command invalid |
string |
|
|
Undefined length |
Character string that exceeds the |
The printer assumes the character string |
character string |
maximum character string length is |
up until the maximum character string |
|
designated |
length was designated. |
ESC/Label Command Reference Guide |
|
Rev. G |
Page 11 |
Format commands have command syntax rules. Control commands do not have command syntax and are effective with just a single command.
|
Table 1.3.3 Command Syntax Rules |
|
|
Definition |
Syntax rule |
Label format |
Command group that begins with "^XA"(Begin label format) and |
|
ends with "^XZ"(End label format). |
Field |
Command group that begins with "^FO"(Field position setting) and |
|
ends with "^FS"(Field end). |
Format commands not included between "^XA"(Begin label format) and "^XZ"(End label format) are invalid.
"^XA"(Begin label format) |
Field |
"^FO"(Field position setting) "^A"(Font designation) "^FD"(Field data |
|
|
||||
setting) "^FS"(Field end) |
|
|
|
|
|
Label |
|
|
|
|
|
|
|
"^FO"(Field position setting) "^B4"(Barcode designation) "^FD"(Field data |
|
|
format |
|||
setting) "^FS"(Field end) |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
"^XZ"(End label format) |
|
|
|
|
|
|
|
Field |
|
|
|
|
|
|
|
|
|
|
|
|
Figure 1.3.1 Format and Field
With ESC/Label command, you can save graphics and label formats in the printer. The printer has a file system. Data saved in the printer is handled as files and is managed in the following way.
The file system does not have a hierarchy.
The printer has a non-volatile saving device, such as Flash ROM, and a volatile saving device, such as RAM, and different drive letters are allocated for each device.
Files are designated as
"<drive letter> colon <:> <file name> dot <.> <extension>".
ESC/Label Command Reference Guide
Rev. G |
Page 12 |
Perform label printing using ESC/Label command in accordance with the syntax rules shown in Section 1.3.3.
|
|
|
Command |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Printer |
|
||
|
|
|
|
|
|
|
|
|
|
|||
|
|
|
|
|
|
|
|
|
|
|
|
|
|
(1) |
"^XA"(Begin label format) |
|
|
|
|
|
|
|
|
||
|
|
Ex: ABC in the field data setting |
|
|
||||||||
|
|
|
|
|
|
|
|
|||||
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
(2) |
"^FO"(Field position setting) "^A"(Font designation) |
|
|
|
|
|
|
||||
|
"^FD"(Field data setting) "^FS"(Field end) |
|
Render the character string |
|
||||||||
|
|
|
|
|
|
|
|
|
|
|
|
|
Ex: 12345 in the field data setting
(3) "^FO"(Field position setting) "^B1"(Barcode setting) "^FD"(Field data setting) "^FS"(Field end)
Render the barcode
Printed label
(4) "^XZ"(End label format)
ABC |
|||||||||
12345
Figure 1.4.1 Example of a Basic Label Printing
The printer operates as follows.
In (2), the character string "ABC" is rendered in the rendering area.
In (3), the character string "12345" is rendered in the rendering area as a barcode.
In (4), the contents of the rendering area are printed.
ESC/Label Command Reference Guide |
|
Rev. G |
Page 13 |
With ESC/Label command, add a command to set the field color to realize color rendering. When printing a color label, designate the rendering color with "^F(C"(Field color setting).
|
|
Command |
|
|
|
|
|
|
|
Printer |
|
||
|
|
|
|
|
|
|
|||||||
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
(1) "^XA"(Begin label format) |
|
Ex: ABC in the field data setting, |
|
|
||||||||
|
|
|
|
|
|
red as the field color |
|
|
|||||
|
|
|
|
|
|
||||||||
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
(2) "^FO"(Field position setting) "^A"(Font designation) |
|
|
|
|
|
|
|
|||||
|
"^F(C"(Field color setting) "^FD"(Field data setting) "^FS"(Field |
|
Render |
the character |
|||||||||
|
end) |
|
|
||||||||||
|
|
|
string |
|
|
|
|
|
|||||
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Ex: 12345 in the field data setting |
|
||||||
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
(3) "^FO"(Field position setting) "^B1"(Barcode setting) |
|
Render |
the barcode |
|||||||||
|
"^FD"(Field data setting) "^FS"(Field end) |
|
|
||||||||||
|
|
|
|
|
|
|
|
|
|||||
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
(4) "^XZ"(End label format) |
|
|
|
|
|
|
|
|
|
|
||
|
|
|
|
|
|
|
|
|
|
|
ABC |
||
|
|
|
|
|
|
|
|
|
|
|
|||
|
|
|
|
|
|
|
|
|
|
|
|
||
|
|
|
|
|
|
|
||||||||| |
||||||
|
|
|
|
|
|
|
|
12345 |
Figure 1.4.2 Example of a Command to Print a Color Label
The printer operates as follows.
In (2), the character string "ABC" is rendered in red in the rendering area.
In (3), the character string "12345" is rendered in the rendering area as a barcode.
In (4), the contents of the rendering area are printed.
ESC/Label Command Reference Guide |
|
Rev. G |
Page 14 |
If performing serialized printing, designate the field data designation section in sequence, and designate the number of copies to print.
|
|
|
Command |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Printer |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
||
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
(1) |
"^XA"(Begin label format) |
|
|
|
|
|
|
|
|
|
||
|
|
Ex: ABC in the field data setting |
|
|
|
||||||||
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
(2) |
"^FO" (Field position setting) "^A"(Font designation) |
Render the |
character string |
|
|
|
|||||||
|
"^FD"(Field data setting) "^FS"(Field end) |
|
|
|
|
||||||||
|
|
|
|
|
|
|
|
|
|||||
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Ex: Set 001 as the initial number and 1 as the increment value.
(3) |
"^FO"(Field position setting) "^B1"(Barcode designation) |
|
"^SF"(Serialization field) |
Render the sequence |
|
(4) |
"^PQ"(Print quantity) |
Printed label |
|
|
Ex: Print 10 copies |
(5) |
"^XZ"(End label format) |
ABC |
|
|
||||||||| |
|
|
: 010 |
|
|
: 10 copies |
ABC
|||||||||
001
Figure 1.4.3 Example of Command for Serialized Printing
The printer operates as follows.
In (2), the fixed character string "ABC" is rendered in the rendering area.
In (5), the image is render in accordance with the serial setting from (3) and printed the number of times in (4)
When the second label is being printed, the following processing is done in (3).
The character string "001" is rendered in the rendering area as a barcode.
The sequence adds 1, and renders the character string "002" in the rendering area as a barcode.
The content of the rendering area is printed.
This is repeated until the 10th copy, and 001, 002, ... 010 is printed on the sequence of 10 copies.
ESC/Label Command Reference Guide
Rev. G |
Page 15 |
Use "^DF"(Download label format) to save a label format. If designating a different value for each label, designate the "^FN"(Field number) in the field.
|
|
Command |
|
|
|
|
|
|
Printer |
|
|
|
|
|
|
|
|
|
|
||||
|
|
|
|
|
|
|
|
|
|
||
|
|
|
|
|
|
|
|
|
|
|
|
|
(1) "^XA"(Begin label format) |
|
|
Ex: The command group after this |
|
|
|||||
|
|
|
|
|
|
command is saved as "SAMPLE.FMT". |
|
|
|||
|
|
|
|
|
|
||||||
|
|
|
|
|
|
|
(2) |
"^DF"(Download label format) |
|
Ex: ABC in the field data setting |
(3) |
"^FO"(Field position setting) "^A"(Font designation) "^FD"(Field |
data setting) "^FS"(Field end) |
Ex: The field is the barcode specification and number 1 is applied to this field.
(4) "^FO"(Field position setting) "^B1"(Barcode designation) "^FN"(Field number)"^FS"(Field end)
(5) "^XZ"(End label format) |
Save |
SAMPLE.FMT |
|
Figure1.4.4 Example of a Command to Save a Label Format File
The printer operates as follows.
In (2), the host orders the printer to save the label format with the designated file name.
In (5), the command group written between "^XA"(Begin label format) and "^XZ"(End label format) is saved in the memory area of the printer as "SAMPLE.FMT".
ESC/Label Command Reference Guide
Rev. G |
Page 16 |
If printing using the saved label format file, first call the command group in the label format by using <Call the label format file>. Next, set the field data that will be the difference and perform printing.
|
Command |
|
Printer |
(1) |
"^XA"(Begin label format) |
Ex: Call "SAMPLE.FMT" |
|
(2) |
"^XF"(Call label format) |
|
|
|
|
Load the contents of SAMPLE.FMT |
|
|
|
Ex: 001 for the field data setting in number 1 |
|
(3) |
"^FN"(Field number) "^FD"(Field data setting) "^FS"(Field |
|
|
end) |
Render the barcode |
||
(4) |
"^XZ"(End label format) |
SAMPLE.FMT |
|
|
|||
|
|
|
ABC |
|
|
|
||||||||| |
|
|
|
001 |
Figure 1.4.5 Example of Print Command Using the Label Format File
The printer operates as follows.
SAMPLE.FMT is called by the "^XF"(Call the command file) in (2).
"ABC" is rendered.
The barcode is designated in a field and the field number 1 is allocated.
The field for number 1 in (3) is barcode designation, so it is converted into a barcode and rendered. In (4), the contents of the rendering area are printed.
ESC/Label Command Reference Guide
Rev. G |
Page 17 |
For control commands, there are no syntax rules like for format commands. The printer receives a request for each control command.
Command |
Printer |
(1) "~HS"(Status request) |
Status request |
|
|
|
Status response |
Figure 1.4.6 Example of a Command to Request the Status
The printer operates as follows.
In (1), the printer receives the "~HS"(Status request), and returns the status to the host.
ESC/Label Command Reference Guide
Rev. G |
Page 18 |
The primary functions of the ESC/Label command added or modified in comparison with ZPL II command are shown below.
Table 2.1 Primary Functions of the ESC/Label Command
|
Item |
Details |
2.1 |
Font |
Available fonts, and their appearance |
2.2 |
Media settings |
How to set the type and form of media used for printing |
2.3 |
Errors |
Types of error, and printer operation during error status |
2.4 |
Print area |
How to set printer’s print area for a sheet of paper |
2.5 |
Getting and setting printer |
Printer information, and how to get/set it |
information |
|
|
2.6 |
Designating color |
How to specify colors for text and graphics |
2.7 |
Field color reversal |
How to specify reversed colors for fields |
2.8 Printing Graphics |
How to print color and monochrome graphics |
A font is a set of attributes for text, including image and size.
To print text with a certain font, specify the font and then use the field to specify a character code. Only one font can be specified per field.
Figure 2.1.1 shows examples of printed text with fonts specified in multiple fields.
FontP sample
FontC sample
FontA sample
Figure 2.1.1 Examples of Printed Text Images by Specifying Fonts
Multiple fonts are included in the printer when shipped from the factory. The user can also download fonts to the printer at a later time.
Font types include fixed-size fonts, for which the character width and height can be specified as fixed values or integer multiples, and scalable fonts, for which the character width and height can be specified separately in units of [dots].
The fonts included in the printer are both fixed-size fonts and scalable fonts. However, only scalable fonts can be downloaded.
ESC/Label Command Reference Guide |
|
Rev. G |
Page 19 |
Fonts that can be specified by the user are shown in Table 2.1.1.
Table 2.1.1 Font List
|
Font |
Font |
Size |
Scalable |
Character image |
|
|
identifier |
(H × W dot) |
||||
|
|
|
|
|
|
|
|
Font |
Sans serif |
9 |
× 5 |
No |
|
|
"A" |
|
||||
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Font |
Sans serif |
11 × 7 |
No |
|
|
|
"B" |
(All Caps) |
|
|||
|
|
|
|
|
||
|
|
|
|
|
|
|
|
Font |
Sans serif |
18 |
× 10 |
No |
|
|
"C"("D")*1 |
|
||||
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Font |
OCR-B |
42 |
× 20 |
No |
|
|
"E" |
|
||||
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Font |
Sans serif |
26 |
× 13 |
No |
|
|
"F" |
|
||||
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Font |
Sans serif |
60 |
× 40 |
No |
|
|
"G" |
|
||||
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Font |
OCR-A |
34 |
× 19 |
No |
|
|
"H" |
|
||||
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Font |
SYMBOL |
24 |
× 24 |
No |
|
|
"GS" |
|
||||
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Font |
Sans serif |
20 |
× 18 |
No |
|
|
"P" |
|
||||
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Font |
Sans serif |
28 |
× 24 |
No |
|
|
"Q" |
|
||||
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Font |
Sans serif |
35 |
× 31 |
No |
|
|
"R" |
|
||||
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Font |
Sans serif |
40 |
× 35 |
No |
|
|
"S" |
|
||||
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Font |
Sans serif |
48 |
× 42 |
No |
|
|
"T" |
|
||||
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Font |
Sans serif |
59 |
× 53 |
No |
|
|
"U" |
|
||||
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Font |
Sans serif |
80 |
× 71 |
No |
|
|
"V" |
|
||||
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Font |
Sans serif |
15 |
× 12 |
Yes |
|
|
"0"*2 |
(Default) |
|
|||
|
|
|
|
|||
|
|
|
|
|
|
|
*1 Font "C" and "D" are the same font. |
|
|
||||
*2 Zero |
|
|
|
|
|
ESC/Label Command Reference Guide |
|
Rev. G |
Page 20 |
Font GS is a special symbol font. See Table 2.1.2 Special Symbols for details about character code and character image.
Table 2.1.2 Special Symbols
Character code |
Character image |
41h
42h
43h
44h
45h
Media settings instruct the printer about the type and form of media to be used for printing. The printer performs printing control and media control based on these settings. The media setting items are shown in Table 2.2.1.
|
Table 2.2.1 Media Setting Items |
|
|
Setting item type |
Description |
Media coating type |
Sets differences between media material, such as an ink receiving |
|
layer. |
Media form |
Sets differences between media forms, such as gap and adhesive. |
Label edge detection |
Sets differences between methods of detecting leading edge position |
|
of label, such as black mark and gap. |
Media source |
Sets the method for supplying paper to the printer |
Media shape |
Sets differences between media shape, such as roll shape and folded |
|
shape. |
2.2.1Media coating type
Media coating type sets the differences between media material, such as ink receiving layer.
Table 2.2.2 Media Coating Type
Name |
Description |
Command |
|
|
format |
Plain Paper |
Paper without ink receiving layer |
^S(CLM,T,P* |
Matte Paper |
Paper with ink receiving layer |
^S(CLM,T,M* |
Synthetic |
Synthetic with ink receiving layer |
^S(CLM,T,S* |
Glossy Paper |
Paper with ink receiving layer and luster processing |
^S(CLM,T,G* |
Glossy Film |
Glossy synthetic with an ink receiving layer on a film |
^S(CLM,T,GS* |
High Glossy Paper |
Glossy paper that is glossier than regular glossy paper |
^S(CLM,T,PG* |
"*" in the command format indicates a figure.
ESC/Label Command Reference Guide |
|
Rev. G |
Page 21 |
Media form sets the differences between media forms, such as gap and adhesive.
Table 2.2.3 Media Forms
Name |
Description |
Command |
|
|
format |
Continuous paper |
Paper without adhesive |
^S(CLM,F,CP |
Die cut label |
Labels with adhesive and cut to a specific size, with gaps |
^S(CLM,F,DL |
|
between labels |
|
Continuous label |
Continuous label with adhesive, and not cut to a specific |
^S(CLM,F,CL |
|
size like die cut labels |
|
Label edge detection sets the detection methods, such as black mark and gap.
Table 2.2.4 Label edge detection
Name |
Description |
Command |
|
|
format |
Black mark detection |
The black mark attached at the leading edge of the label is |
^S(CLM,D,M |
|
detected. |
|
Gap detection |
The gap between labels is detected. |
^S(CLM,D,W |
No detection |
Printer does not detect the leading edge of the label. |
^S(CLM,D,N |
The media source sets the method for supplying paper to the printer.
Table 2.2.5 Media Source
Name |
Description |
Command |
|
|
format |
Internal roll media |
The printer receives paper from the internal roll paper |
^S(CLM,P,IR |
|
supply mechanism. |
|
External feed |
The printer receives paper from an external paper supply. |
^S(CLM,P,ER |
The media shape sets differences between media shape, such as roll shape and folded shape.
Table 2.2.6 Media Source
Name |
Description |
Command |
|
|
format |
Roll paper |
Paper formed to roll shape. |
^S(CLM,S,RP |
Fanfold paper |
Paper folded |
^S(CLM,S,FP |
ESC/Label Command Reference Guide |
|
Rev. G |
Page 22 |
Errors indicate that something has occurred to prevent the printer from printing or executing other primary functions. Errors are classified as Table 2.3.1 according to their cause and how they are resolved.
Table 2.3.1 Types of Error
Name |
Description |
Example causes |
Recoverable error |
An error condition that can be reset by the |
Open cover, paper out, paper jam, |
|
user. The printer returns to normal status |
|
|
when the user removes the cause of the error. |
|
Unrecoverable error |
An error condition that cannot be reset by |
Detector failure or motor failure |
|
the user because the user cannot remove the |
caused by aging equipment. |
|
cause of the error. |
|
Error status occurs when there is some cause of error in the printer. When the printer recognizes that all causes of the error have been removed, it returns to idling status.
|
|
Power ON |
|
Cause of recoverable error |
Idling |
Cause of unrecoverable error |
|
|
|
|
|
|
|
Error |
|
Recoverable |
All causes of recoverable |
Unrecoverable error |
|
error |
|
||
error removed |
|
|
|
|
|
|
Figure 2.3.1 Error Status Transition Diagram
When the printer is in error status, the printer behaves differently than the normal idling status as described below.
Commands for printer mechanisms, such as print requests, cannot be executed.
Indicators (LEDs/LCDs) indicate errors.
"~H(SMA,S"(Send printer operation status ): ER (error status) is returned.
"~H(SEA,E"(Send error status): the cause of the error is returned.
ESC/Label Command Reference Guide |
|
Rev. G |
Page 23 |
Print area is the area of a full sheet of paper where the printer will print. Print area is a logical rectangular area in the printer, corresponding to one logical label on a sheet of paper. The top left corner of the print area is the initial home position, which is used as the starting point for printing text and graphics.
In the printer specifications, the printing limit area is defined as the maximum printable area.
Within the maximum printable area, the area minus the mount (gap) is defined as the printable area.
Within the printable area, the area minus margins is defined as the print area.
Examples of maximum printable area, printable area, and print area are shown in Figure 2.4.1.
Printer |
Paper |
|
Maximum printable area
Home position
Mount (gap)
Label
Figure 2.4.1 Examples of Maximum printable area, Printable Area, and Print Area
ESC/Label Command Reference Guide |
|
Rev. G |
Page 24 |
The leading edge, top, bottom, left, and right directions, and X and Y directions of the paper are defined as described below.
The edge in the feed direction of the paper is defined as the leading edge.
The direction of the leading edge of the paper is defined as the bottom direction, and its opposite direction is defined as the top direction.
When looking at the print surface of the paper, the left side is defined as the left direction, and the opposite side is defined as the right direction.
The left-right direction is defined as the X axis, with the right direction defined as the positive X direction.
The up-down direction is defined as the Y axis, with the down direction defined as the positive Y direction.
The leading edge, top, bottom, left, and right directions, and the X and Y directions of the paper are shown in Figure 2.4.2.
|
Paper |
|
X direction |
Feed direction |
|
|
|
|
Top direction
Y direction
Left direction Right direction
Bottom direction
Leading edge
Figure 2.4.2 Leading Edge and Directions
ESC/Label Command Reference Guide |
|
Rev. G |
Page 25 |
When the logical area for a sheet of paper in the printer is arranged on a physical sheet of paper, the 1st dot position on the left edge of the paper and the leading edge position of the label on the bottom edge of the paper are used as references. The 1st dot position is the left edge reference position for the maximum printable area. One of the following methods is used to detect the leading edge position of the label.
Table 2.4.1 Methods of Detecting the Leading Edge Position of Labels
Method of detecting leading edge |
Description |
position of label |
|
Black mark detection |
The position where a black mark is detected is the leading |
|
edge position of the label. |
Gap detection |
The position where the leading edge of the label is detected |
|
is the leading edge position of the label. |
Paper with black mark |
Paper consisting of mount and |
|
labels |
|
|
Leading edge position of label |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
||
|
|
Black mark detector |
|
|
|
|
|
|
|
|
|||
|
|
|
|
|
|
|
|
|
Leading edge detector |
||||
|
|
|
|
|
|
|
|
|
|||||
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Leading edge position adjustment |
|
|
|
|
|
|
|
|
|
||
|
|
|
|
|
|
|
|
|
|
|
|||
|
|
|
1st dot position |
||||||||||
1st dot position |
|
|
|
||||||||||
|
|
|
Figure 2.4.3 Methods of Detecting the Leading Edge Position of Labels
The leading edge position of a label can be corrected by making changes to the leading edge position adjustment, to account for detection deviation in the detector (caused by deterioration due to aging).
Table 2.4.2 Setting the Leading Edge Position Adjustment for Labels
Setting item |
Setting command format |
Leading edge position adjustment |
^S(CLE,T,c ¹ |
¹ The unit of the setting value can be selected from dot/mm/inch by ^S(CMP,U or ^MU command.
ESC/Label Command Reference Guide |
|
Rev. G |
Page 26 |
2.4.3Maximum printable area
The maximum printable area is defined as shown below, using the 1st dot position and leading edge position of the label as references.
The width of the maximum printable area is the maximum media width of the printer.
The length of the maximum printable area is the maximum paper length of the printer.
The left bottom edge of the maximum printable area is the point of intersection between the 1st dot position and the leading edge position of the label.
Maximum paper length
Leading edge position of label
Maximum media width 1st dot position
Figure 2.4.4 Maximum printable area
ESC/Label Command Reference Guide |
|
Rev. G |
Page 27 |
Within the maximum printable area, the area minus the mount area (gap) is defined as the printable area. The size of the label area and mount area are set according to the actual paper printed on by the printer.
Table 2.4.3 Mount Settings
Direction |
Setting items |
Setting command format |
X direction |
Left gap |
^S(CLS,G,c ¹ |
|
Label width |
^S(CLS,P,c ¹ |
Y direction |
Label length |
^S(CLS,L,c ¹ |
¹ The unit of the setting value can be selected from dot/mm/inch by ^S(CMP,U or ^MU command.
Paper
Next label
Maximum printable area
|
Printable area |
Label length |
Left gap |
Label width |
|
Media width
Figure 2.4.5 Printable Area and Gap Settings
ESC/Label Command Reference Guide
Rev. G |
Page 28 |
Within the printable area, the area minus margins is defined as the print area. The size of margins is set in the printer according to printer and paper specifications.
If all margins are set to 0, the printable area and print area will be the same.
Table 2.4.4 Margin Settings
Direction |
Setting items |
Setting command format |
X direction |
Left margin |
^S(CLW,L,c ¹ |
|
Right margin |
^S(CLW,R,c ¹ |
Y direction |
Top margin |
^S(CLW,T,c ¹ |
|
Bottom margin |
^S(CLW,B,c ¹ |
¹ The unit of the setting value can be selected from dot/mm/inch by ^S(CMP,U or ^MU command.
|
Paper |
|
Top margin |
Left margin |
Right margin |
|
Bottom margin |
Figure 2.4.6 Printable Area and Mount Settings
ESC/Label Command Reference Guide
Rev. G |
Page 29 |
The user prints text and graphics within the print area set in the printer, with the home position as the starting point. If you attempt to print text or graphics outside the print area, the portion that falls outside the print area will not be printed.
For example, if a portion of the text string "CDE" falls outside of the print area, as shown in Figure 2.4.7, only the portion that falls within the print area will actually be printed on the paper.
Home position
Paper
Print area
CDE
Figure 2.4.7 Example of Printing Outside the Print Area
ESC/Label Command Reference Guide |
|
Rev. G |
Page 30 |