CG Times (based upon Times New Roman), CG Triumvirate, MicroType, and TrueType are trademarks
of the AGFA Monotype Corporation.
PCL, Intellifont, and HP Laser JetII are trademarks of the Hewlett Packard Corporation.
Macintosh is a trademark of the Apple Corporation.
Windows is a trademark of the Microsoft Corporation.
All other brand and product names are trademarks, service marks, registered trademarks, or registered
service marks of their respective companies.
Information in this manual is subject to change without notice and does not represent a commitment on
the part of Datamax Corporation. No part of this manual may be reproduced or transmitted in any form or
by any means, for any purpose other than the purchaser’s personal use, without the expressed written
permission of Datamax Corporation.
This manual is intended for programmers who wish to create their own label production software.
The Scope of this Manual
This manual, arranged alphabetically by command, explains Datamax Programming Language (DPL) and
its related uses in the writing, loading and storing of programs for the control and production of label
formats (designs) for the following printers at the listed firmware versions:
Printers (all models, unless where otherwise noted)Applicable Firmware Version*
A-Class10.065
E-Class**4.21
EX210.065
I-Class***8.03M2
H-Class10.065
M-Class (M-4206, only)5.08E
M1 & M211.00
M-Class (M-4206, only)5.08E
M-Class8.03M2
W-Class***8.03M2
*Firmware in RFID-equipped printers must be at version 08.043 or greater; see Note 1, below.
**For information regarding the E-3202 printer, see Note 2, below.
***Standard firmware version shown, while option-specific version numbers may differ.
Model distinctions, including configurations (i.e., Display-Equipped or Non-Display Models) and
equipped types (e.g., GPIO-1, graphics display, RFID, etc.), will be indicated in this text to differentiate
command compatibility. The appendices of this manual also contain details that cannot be ignored. The
use of any command will require checking for possible exclusionary conditions.
Notes: (1) See the <STX>KC command for information regarding attainment of the printer’s firmware version;
and then, if necessary, upgrade that firmware. Upgrades are available at ftp://ftp.datamaxcorp.com/.
(2) Programming information for the S-Class and the Datamax legacy printers (Prodigy, DMX400, etc.)
can be found in the DPL Programmer’s Manual (part number 88-2051-01). Programming information for
the E-3202 can be found in E-3202 Programmer’s Manual (part number 88-2257-01). Both manuals can
be downloaded from our web site at http://www.datamaxcorp.com/.
(3) References to “Menu Settings” refer either to the printer’s internal set-up menu, or to the printer’s
menu driven display system; please consult to the appropriate printer Operator’s Manual for details.
(4) For backward compatibility purposes, the Class Series printers covered in this manual will ignore
commands that are no longer processed; Appendix N lists these commands.
(5) When updating firmware for E-Class version 4.10 and higher the printer must be in DPL Mode, not
LINE mode, prior to sending the *.dlf file. See Appendix S for details.
(6) Where applicable, printer responses to a host device will depend upon the communication port, port
settings, and cabling.
Class Series Programmer’s Manual1
Overview
This manual contains the following chapters and appendices:
OVERVIEW on page 1
Contents, organization, and conventions used in this manual; also includes a typical data flow
sequence for the printer.
CONTROL CODE COMMAND FUNCTIONS on page 7
Description of the attention-getter characters necessary for the printer to receive a command
sequence, and available alternate characters and line terminators.
IMMEDIATE COMMAND FUNCTIONS on page 9
Description of the commands, listed alphabetically, that perform status queries and printer control
commands.
SYSTEM-LEVEL COMMAND FUNCTIONS on page 15
Description of the commands, listed alphabetically, that control the printer and allow scalable font
and image downloads.
EXTENDED SYSTEM-LEVEL COMMAND FUNCTIONS on page 37
Description of the commands (listed alphabetically) that control the printer.
LABEL FORMATTING COMMAND FUNCTIONS on page 109
Description of commands, listed alphabetically, that control the position of text and images on the
media, print or store, and end the formatting process.
FONT LOADING COMMAND FUNCTIONS on page 129
Description of commands, listed alphabetically, used when downloading font data in PCL-4
compatible bit-maps.
GENERATING LABEL FORMATS on page 131
Description of the structure of records, the different types, and their use in generating label formats.
APPENDICES A THROUGH V on pages 147 through 281
These contain details that cannot be ignored including various tables, programming examples,
printer default values, and bar code symbology details. See the Table of Contents for specific
content information.
GLOSSARY on page 283
Definitions of words, abbreviations, and acronyms used in this manual.
2Class Series Programmer’s Manual
Overview
General Conventions
These are some of the conventions followed in this manual:
On the header of each page, the name of the chapter.
On the footer of each page, the page number and the title of the manual.
Names of other manuals referenced are in Italics.
Notes are added to bring your attention to important considerations, tips or helpful suggestions.
Boldface is also used to bring your attention to important information.
This manual refers to IBM-PC based keyboard command characters for access to the ASCII
character set. Systems based on different formats (e.g., Apple’s Macintosh) should use the
appropriate keyboard command to access the desired ASCII character. See Appendix A for the
ASCII character set.
Computer Entry and Display Conventions
Command syntax and samples are formatted as follows:
The Courier font in boldface indicates the DPL command syntax, and Italics are used to indicate
the command syntax parameters.
Regular Courier font indicates sample commands, files and printer responses.
Square brackets ([ ]) indicate that the item is optional.
<CR>is used to identify the line termination character. Other strings placed between < > in this
manual represent the character of the same ASCII name, and are single-byte hexadecimal values
(e.g., <STX>, <CR>, and <0x0D> equal 02, 0D, and 0D, respectively).
Hexadecimal values are often displayed in ‘C’ programming language conventions (e.g., 0x02 =
02 hex, 0x41 = 41 hex, etc.)
Class Series Programmer’s Manual3
Overview
Typical Data Flow Sequence
The typical data flow sequence is summarized in the following bullets and detailed in the table below.
Printer Commands data is transmitted to the printer as shown in the table from left to right, top to bottom.
“Status” commands: Get
Status, Request Memory
Module Storage
Information…
“Configuration”
commands, download
image…
“Download” commands,
image, fonts…
Begin label
Label Header record
Label Formatting Data
record –
Object type, orientation,
position, data
Label Quantity
Label Terminate record
Status command
Reprint with New Data
Records
Optional, bi-directional
communication required
for these commands.
See <STX>Kc to reduce
configuration commands
transferred
RAM (temporary) or
Flash (semi-permanent)
memory
Existing label formats
may be recalled. Label
header records are not
required
Optional, bi-directional
communication required
for these commands.
Used for fast re-prints
<STX>xImagename<CR>
<STX>zA
4Class Series Programmer’s Manual
Memory cleanup
Typically used for
temporary storage
Overview
Commands are available for retrieving stored label formats, updating data, and adding new data. These
techniques are used for increasing throughput. See <STX>G, Label Recall Command ‘r’, and Label Save
Command ‘s’.
Typical commands used in the various stages shown above are listed in the tables that follow.
Configuration Commands
The following table lists some commands useful in controlling printer configuration. These
commands are generally effective only for the current power-up session; toggling power restores the
default configuration. See <STX>Kc for changes to the default power-up configuration. Changing the
default power-up configuration and saving objects in printer Flash memory can reduce the data
transmitted for each label and therefore improve throughput.
Configuration
Command
<STX>A
<STX>d
<STX>c
<STX>e
<STX>Kf
<STX>Kc
<STX>F
<STX>M
<STX>m
NameFunction
Set Date and TimeSet Date and Time
Set Double Buffer Mode
Set Continuous Paper Length
Set Edge SensorSetup for gap or registration hole type stock
Subsequent measurements interpreted in inches, most units
in/100, Label equivalent command can be used
Effect is not on label immediately following command since
media position is at Start of Print between labels; <STX>K
default position relative 64 in/100 maximum deviation
Download Commands
Overview
Download
Command
<STX>I
<STX>i
<ESC>
Download ImageDownload Image to selected memory module
Download Scalable FontDownload Scalable Font to selected memory module
Download Bitmapped FontDownload Bitmapped Font to selected memory module
NameFunction
Label Header Commands
These commands determine how the label formatting occurs, effect print quality and quantity. They
are typically issued immediately following the <STX>L start of the label format. The Format
Attribute (A) and the Offset (C, R) commands can be changed at any point between format records to
achieve desired effects.
Label Header
Command
A
Set Format Attribute
Name
C
D
H
M
P
P
Q
R
S
Column Offset
Set Width and Dot Size
Set Heat Setting
Set Mirror Mode
Set Print Speed
Set Backup Speed
Set Quantity
Set Row Offset
Set Feed Speed
6Class Series Programmer’s Manual
Control Code Command Functions
Introduction
The printer requires a special “attention-getter” character in order to receive a command sequence,
informing the printer that it is about to receive a command and the type of command it will be. Control
Commands, System-Level Commands, and Font Loading Commands have their own unique attentiongetter, followed by a command character that directs printer action.
Attention-Getters
The attention-getters (e.g., “SOH”) are standard ASCII control labels that represent a one character control
code (i.e., ^A or Ctrl A). Appendix A contains the entire ASCII Control Code Chart.
Attention-GetterASCII CharacterDecimal ValueHEX Value
Immediate Commands
System-Level Commands
Font Loading Commands
SOH101
STX202
ESC271B
Table 2-1: Control Code Listings
Alternate Control Code Modes
For systems unable to transmit certain control codes, Alternate Control Code Modes are available.
Configuring the printer to operate in an Alternate Control Code Mode (selected via the Setup Menu, the
<STX>Kc command or, where applicable, the <STX>KD command) requires the substitution of Standard
Control Characters with Alternate Control Characters in what is otherwise a normal data stream.
Control CharacterStandardAlternateAlternate 2CustomCommand Type
SOH0x010x5E0x5E
STX0x020x7E0x7E
CR0x0D0x0D0x7C
ESC0x1B0x1B0x1B
“Count By”
[1]
See Label Formatting Commands, ^ set count by amount.
[1]
0x5E0x400x40
Table 2-2: Alternate Control Code Listings
User DefinedControl
User DefinedSystem
User DefinedLine Termination
User DefinedFont Loading
User DefinedLabel Formatting
Note: Throughout this manual <SOH>, <STX>, <CR>, <ESC>, and ^, will be used to indicate the control codes.
The actual values will depend on whether standard or alternate control codes are enabled for the
particular application.
Class Series Programmer’s Manual7
Control Code Command Functions
Alternate Line Terminator Example
Alternate Control Codes provide for substitution of the line terminator, as well as the control characters
listed above. For example using Alternate 2, the line terminator <CR> (0x0D) is replaced by | (0x7C).
The following is a sample label format data stream for a printer configured for Alternate-2 Control Codes:
~L|1911A10001000101234560|X|~UT01ABCDE|~G|
8Class Series Programmer’s Manual
Immediate Command Functions
Introduction
When the printer receives an Immediate Command, its current operation will be momentarily interrupted
to respond to the command. Immediate Commands may be issued before or after System-Level
commands; however, they may not be issued among Label Formatting Commands or during font or
image downloading. Immediate Commands consist of:
1. Attention-Getter, 0x01 or 0x5E, see Control Codes.
2. Command Character
SOH #Reset
This command resets the printer. Resetting the printer returns all settings to default and clears both
the communications and printing buffers. The command also clears DRAM memory.
Syntax:
Printer Response:The printer will reset.
<SOH>#
<XON> T (The T may come before the <XON>)
SOH *Reset
(Display-Equipped Models only)
This command forces a soft reset of the microprocessor, resetting the printer, returning all factory
default values, and clearing the communication and print buffers.
Syntax:
Printer Response:The printer will reset.
<SOH>*
<XON> R (The R may come before the <XON>)
Class Series Programmer’s Manual9
Immediate Command Functions
SOH ASend ASCII Status String
This command allows the host computer to check the current printer status. The printer returns a
string of eight characters, followed by a carriage return. Each character (see below) indicates an
associated condition, either true (Y) or false (N). Byte 1 is transmitted first. See <SOH>F.
Syntax:
Sample:
Printer Response:
<SOH>A
<SOH>A
abcdefgh<CR>
Where:
Possible ValuesInterpretationByte Transmit Sequence
a-Y/NY=Interpreter busy (imaging)1
b-Y/NY=Paper out or fault2
c-Y/NY=Ribbon out or fault3
d-Y/NY=Printing batch4
e-Y/NY=Busy printing5
This command allows the host computer to check an extended current printer status. The printer
returns a string of seventeen characters, followed by a carriage return. Most characters (see below)
indicate an associated condition, either true (Y) or false (N). Byte 1 is transmitted first. See <SOH>F.
Syntax:
Sample:
Printer Response:
10Class Series Programmer’s Manual
<SOH>a
<SOH>a
abcdefgh:ijklmnop<CR>
Immediate Command Functions
Where:
Possible ValuesInterpretationByte Transmit Sequence
a-Y/NY=Interpreter busy (imaging)1
b-Y/NY=Paper out or fault2
c-Y/NY=Ribbon out or fault3
d-Y/NY=Printing batch4
e-Y/NY=Busy printing5
n-Y/NY=Ribbon Low15
o-Y/NY=N (reserved for future)16
p-Y/NY=N (reserved for future)17
Table 3-1: ASCII Status Bytes
SOH BToggle Pause
This command toggles the printer’s paused state between on and off. (This is the same function
achieved by pressing the PAUSE Key on the printer.)
Syntax:
Sample:
Printer Response:This command will illuminate the Paused/Stop Indicator and/or indicate
<SOH>B
<SOH>B
PAUSED on the LCD or graphics display panel, suspend printing, and wait
until one of the following occurs:
The <SOH>B command is sent to the printer.
The PAUSE Key is pressed.
Upon which the printer will turn the Paused/Stop Indicator ‘Off’ and/or
remove PAUSED from the LCD or graphics display panel, then resume
operation from the point of interruption. (If the Receive Buffer is not full,
an <XON> character will be transmitted from the printer.)
Class Series Programmer’s Manual11
Immediate Command Functions
SOH CStop/Cancel
This command performs the same function as pressing the STOP/CANCEL Key on the printer. This
function clears the current format from the print buffer, pauses the printer, and illuminates the
Paused/Stop Indicator. (The pause condition is terminated as described under <SOH>B.)
Syntax:
Sample:
<SOH>C
<SOH>C
Printer Response:This command will clear the print buffer, pause the printer, illuminate the
Paused/Stop Indicator and/or indicate PAUSED on the LCD or graphics
display panel, suspend printing, and wait until one of the following occurs:
The <SOH>B command is sent to the printer; or
The PAUSE Key is pressed.
Upon which the printer will turn the Paused/Stop Indicator ‘Off’ and/or
remove PAUSED from the LCD or graphics display panel. (If the Receive
Buffer is not full, an <XON> character will be transmitted from the printer.)
SOH DSOH Shutdown
(Non-Display Models only)
This commands the printer to ignore Immediate Commands (^A). The SOH shutdown command is
required before loading images or fonts because some may contain data sequences that could be
interpreted as Immediate Commands. After the SOH shutdown command is sent, Immediate
Commands can be turned back on by sending a valid SOH command three times, separated by a one
second delay between each command, or by manually resetting the printer. It is good practice to
check batch quantities (<SOH>E) to verify that the SOH commands are working.
Syntax:
Sample:
Printer Response:
<SOH>D
<SOH>D
This printer will ignore Immediate Commands (^A) until a valid SOH
command is received three times, separated by a one second delay between
each command; or, until the printer is manually reset.
12Class Series Programmer’s Manual
Immediate Command Functions
SOH ESend Batch Remaining Quantity
This command causes the printer to return a four-digit number indicating the quantity of labels that
remain to be printed in the current batch, followed by a carriage return. Communications latency may
cause this value to be higher than actual on some printers.
Syntax:
Printer response:
Where:
<SOH>E
nnnn<CR>
nnnn
- Are four decimal digits, 0-9999.
SOH eSend Batch Printed Quantity
This command causes the printer to return a four-digit number indicating the quantity of labels that
have been printed in the current batch, followed by a carriage return. Communications latency may
cause this value to be lower than actual on some printers.
Syntax:
Printer response:
Where:
<SOH>e
nnnn<CR>
nnnn
- Are four decimal digits, 0-9999.
SOH F Send Status Byte
This command instructs the printer to send a single status byte where each bit (1 or 0) represents one
of the printer’s status flags, followed by a carriage return (see below). If an option is unavailable for
the printer, the single bit will always be zero. See <SOH>A.
Syntax:
Printer response format:
<SOH>F
X<CR>
Where ‘X’ is 0 through 0xef with bits as indicated in the ‘Condition’ column below:
[1]
Bit
ValueCondition
80Always zero
71 or 0Label presented
61 or 0Printer paused
51 or 0Busy printing
41 or 0Printing batch
31 or 0Ribbon out or Fault
21 or 0Paper out or Fault
11 or 0Command interpreter busy (imaging)
[1]
One is the least significant bit.
Class Series Programmer’s Manual13
Immediate Command Functions
14Class Series Programmer’s Manual
System-Level Command Functions
Introduction
The most commonly used commands are the System-Level Commands. These are used to load and store
graphics information, in addition to printer control. System-Level Commands are used to override default
parameter values (fixed and selectable) and may be used before or after Immediate Commands but cannot
be issued among Label Formatting Commands. System-Level Commands consist of:
1. Attention-Getter, 0x02 or 0x7E, see Control Codes.
2. Command Character
3. Parameters (if any).
STX ASet Time and Date
This command sets the time and date. The initial setting of the date will be stored in the printer’s
internal inch counter. This date can be verified by printing a Configuration Label.
Syntax:
<STX>AwmmddyyyyhhMMjjj
Where:
w
mm
dd
yyyy
hh
MM
jjj
Sample:
Printed response:
Notes: (1) When set to 000, the Julian date is automatically calculated; otherwise, the Julian date will print
as that entered number, without daily increments. If factory defaults are restored the actual Julian
date will also be restored.
(2) Printers without the Real Time Clock option lose the set time/date when power is removed.
(3) Response format is variable; see the Special Label Formatting Command <STX>T.
1 digit for day of week; 1 = Monday; 7 = Sunday
2 digits for month
2 digits for day
4 digits for year
2 digits for hour in 24 hour format
2 digits for minutes
3 digits for Julian date (numerical day of the year) / constant; see notes below.
<STX>A1020319960855034
Mon. Feb 3, 1996, 8:55AM, 034
Class Series Programmer’s Manual15
System-Level Command Functions
STX aEnable Feedback Characters
This command enables the feedback ASCII hex characters to be returned from the printer following
specific events after each completed batch of labels when using serial communications. The default
value is ‘Off’.
Syntax:
<STX>a
Printer response:Event dependent. (Also, see Appendix D for error codes.)
Where:
EventReturn Characters
Invalid character
Label printed
0x07 ( BEL )
0x1E ( RS )
End of batch0x1F ( US )
STX BGet Printer Time and Date Information
This command instructs the printer to retrieve its internal time and date information.
Syntax:
<STX>B
Sample:
Printer response format:
<STX>B
wmmddyyyyhhMMjjj<CR>
Where:
w
mm
dd
yyyy
hh
MM
jjj
* See <STX>A for details and restrictions.
Printer response sample:
1 digit for day of week; 1 = Monday
2 digits for month
2 digits for day
4 digits for year
2 digits for hour in 24 hour format
2 digits for minutes
3 digits for Julian date / constant*
1020319960855034<CR>
16Class Series Programmer’s Manual
System-Level Command Functions
STX cSet Continuous Paper Length
This command sets the label size for applications using continuous media. It disables the top-of-form
function performed by the Media Sensor. The sensor, however, continues to monitor paper-out
conditions. See <STX>M.
Syntax:
Where:
<STX>cnnnn
nnnn
-Specifies the length of the media feed for each label format, in
inches/100 or millimeters/10 (see <STX>m).
Sample:
<STX>c0100
This sample sets a label length of 100, which equals 1.00 inch (assuming Imperial Mode is selected).
Note: This command must be reset to zero for edge or reflective sensing operation.
STX dSet Double Buffer Mode
(Non-Display Models only)
This command, available for backward compatibility, enables double buffer mode. When printing
labels with incrementing, decrementing and replacement fields (see note below) the printer will only
erase and format those fields, leaving the rest of the label format untouched, and thus increasing
throughput. This command is only active if the labels being printed are less than half the maximum
size of the print buffer (see <STX>S).
Syntax:
Notes: (1) This command is generally not used because fast formatting is the normal operating mode when
the number of variable print fields (Label Formatting commands +, -, <, >, u) is less than or equal to
1/3 of the print field count total. In this case, the command will force fast formatting even when the
proportion of variable print fields is greater than 1/3 the total.
(2) The maximum label size is unaffected by this command.
(3) The <STX>s command restores normal (fast) formatting.
<STX>d
Class Series Programmer’s Manual17
System-Level Command Functions
STX ESet Quantity For Stored Label
This command sets the number of labels for printing using the format currently in the print buffer.
(The printer automatically stores the most recent format received in the buffer until the printer is reset
or power is removed.) When used in conjunction with the <STX>G command, this will print the
labels.
Syntax:
Where:
Sample:
<STX>Ennnn
nnnn
- A four-digit quantity, including leading zeros.
<STX>E0025
<STX>G
Printer response:25 labels of the current format in memory will be printed.
Notes:(1) This command may be issued prior to a label format without a specified quantity, Qnnnnn.
Also, if a <CR> terminates the command, a five-digit quantity (nnnnn) can be entered.
(2) All models, except E-Class – Specifying 9999 as the four-digit quantity causes continuous
printing.
STX eSelect Edge Sensor
This command enables transmissive (see-through) sensing for top-of-form detection of die-cut, and
holed (or notched) media. This Media Sensor will detect a minimum gap of 0.1 inches (2.5 mm)
between labels (see the Operator’s Manual for media requirements). Use the <STX>O command to
adjust the print position. This is the printer default setting at power-up or reset.
Syntax:
Note:This command is ignored when <STX>cnnnn is issued with a non-zero value for nnnn.
<STX>e
STX FForm Feed
This commands the printer to form feed to the next start of print.
Syntax:
Printer response:The printer will form feed.
Note:Following a reset, if the length of the first label fed is less than the label offset value (defined by
the <STX>O command) the printer will advance past that label until a top-of-form is detected, or
until the offset is reached.
18Class Series Programmer’s Manual
<STX>F
System-Level Command Functions
STX fSet Form Stop Position (Backfeed Command)
This sets the stop position of the printed label, allowing the label to stop at a point past the start-ofprint position. When the next label format is sent, the printer motor reverses direction to retract the
media to the start-of-print position. If quantities of more than one label are requested, the printer will
operate without backfeeding. A backfeed will then only occur when printing has stopped for a few
seconds.
Non-Display Models: The printer Option Control must be set (via the menu) to ‘Host’ for this
command to have effect.
Display-Equipped Models: This command is not honored, see <STX>Kf and <STX>Kc.
Syntax:
Where:
<STX>fnnn
nnn
- Is a three-digit distance from the Media Sensor, in inches/100 or
mm/10. This distance is independent of the start-of-print position
(<STX>O), yet it must be greater than the start-of-print position to
take effect.
Sample:
<STX>f230
The sample sets a stop position distance of 230 (2.3 inches from the Media Sensor’s eye).
STX GPrint Last Label Format
This command prints a previously formatted label and restarts a canceled batch job following the last
processed label. This is used when there is a label format in the buffer. The <STX>E command is
used to enter the quantity. (If the <STX>E command is not used only one label will print.)
Syntax:
Class Series Programmer’s Manual19
<STX>G
System-Level Command Functions
STX IInput Image Data
This command must precede image downloading from a host computer to the printer. The data that
immediately follows the command string will be image data. If any of the 8-bit input formats are to
be used, it is necessary to disable the Immediate Command interpreter by executing an <SOH>D
command before issuing the <STX>I command. See Appendix O for more information. To print an
image, see Generating Label Formats.
A-Class (and H–Class models with a large display): A “ready mode” logo image can be input
using this command. The image must be stored on a Flash module. The image name must be
“logolab” (lowercase only) in the following DPL command. Also, printer power must be cycled
for the new image to appear. The available display area is 312 pixels wide by 94 pixels high. Images
larger than this specified width or height will be clipped along the right and/or bottom edges.
Note: The native format for storing downloaded PCX and BMP images is RLE-2, which results in a better
compression ratio for less module space usage when downloading gray-scale images and images
with large black or white areas.
Syntax:
Where:
<STX>Iabfnn…n<CR>data
a
b
- Memory Module Bank Select (see Appendix K).
- Data Type (optional), A or omit.
b Value:
A
omitted00-FF, (8 bit)
f
nn…n
- Format Designator
f Designator:Format Type:
F
B
b
I
i
P
p
- Up to 16 characters used as an image name.
Image Data Value Range:
ASCII Characters 0-9, A-F, (7 bit)
7-bit Datamax image load file
.BMP 8-bit format (image flipped), black and
white (B&W)
.BMP 8-bit format (image as received), B&W
.IMG 8-bit format (image flipped), B&W
.IMG 8-bit format (image as received), B&W
.PCX 8-bit format (image flipped), B&W
.PCX 8-bit format (image as received), B&W
<CR>
data
Sample:
<SOH>D
<STX>IDpTest <CR>
data...data <CR>
The sample instructs the printer to (1) receive an 8-bit PCX image sent by the host in an 8-bit data
format, (2) name the image ‘Test’, and (3) store it in memory module D (with a .dim file extension).
20Class Series Programmer’s Manual
-0x0d terminates the name.
- Image data
System-Level Command Functions
STX iScalable Font Downloading
The command structure for downloading TrueType (.TTF) scalable fonts (font files may be singlebyte or double-byte character systems) is as follows
:
Syntax:
Where:
Sample:
This sample downloads a TrueType font to module ‘D,’ and assigns it the Font ID of 52 with the
name “Tree Frog” and file extension .dtt. The size of the font data is 0x87C2 bytes long.
<STX>imtnnName<CR>xx…xdata…
m
t
nn
Name
<CR>
xx…x
data
<STX>iDT52Tree Frog<CR>000087C2data...
-Memory Module Designator to save this font to; see Appendix
K.
Type of scalable font being downloaded:
-
T = TrueType
Two-digit font reference ID. Valid range is 50-99, 9A-9Z, 9a-9z,
-
(base 62 numbers).
The title, up to 16 characters, for this font.
-
0x0d terminates the Name.
-
Eight-digit size of the font data, number of bytes, hexadecimal,
-
padded with leading zeros.
The scalable font data.
-
STX JSet Pause for Each Label
This command causes the printer to pause after printing each label. It is intended for use with the peel
mechanism or tear bar when the Present Sensor option is not installed. After removing the printed
label, the PAUSE Key must be pushed in order to print the next label. (The printer must be reset to
clear the <STX>J command.)
Syntax:
<STX>J
STX K Extended System-Level Commands
This is an expansion of the System-Level Command structure. See Extended System-Level
Commands for more information.
Class Series Programmer’s Manual21
System-Level Command Functions
STX kTest RS-232 Port
This command instructs the printer to transmit the Y character from the printer’s RS-232 port.
(Failure to receive Y could indicate an interfacing problem.)
Syntax:
Printer response:
<STX>k
Y
STX LEnter Label Formatting Command Mode
This command switches the printer to the Label Formatting Command Mode. Once in this mode, the
printer expects to receive Record Structures and Label Formatting Commands. Immediate, SystemLevel, and Font Loading commands will be ignored until the label formatting mode is terminated
with E, s, or X, (see Label Formatting Commands for additional information).
Syntax:
<STX>L
STX MSet Maximum Label Length
This command instructs the printer move media this distance in search of the top-of-form (label edge,
notch, black mark, etc.) before declaring a paper fault. A paper fault condition can occur if this setting
is too close (within 0.1 inch [2.54 mm]) to the physical length of the label. Therefore, it is a good
practice to set this command to 2.5 to 3 times the actual label length used. The minimum value should
be at least 5” (127 mm).
Syntax:
Where:
Sample:
The sample sets a maximum travel distance of 5 inches (unless the printer is in metric mode, see
<STX>m).
<STX>Mnnnn
nnnn
<STX>M0500
- Is a four-digit length, 0000-9999, in/100 or mm/10. Maximum
setting is 9999 (99.99 inches or 2540 mm). The default setting is
16 inches/ 406.4 mm
STX mSet Printer to Metric Mode
This command sets the printer to interpret measurements as metric values (e.g., <STX>c0100 will
equal 10.0 mm). The default is Imperial (see <STX>n).
Syntax:
22Class Series Programmer’s Manual
<STX>m
System-Level Command Functions
STX nSet Printer to Imperial Mode
This command sets the printer to interpret measurements as inch values (e.g., <STX>c0100 will
equal 1.00 inch). The printer defaults to this mode.
Syntax:
<STX>n
STX OSet Start of Print (SOP) Position
This command sets the point to begin printing relative to the top-of-form (the label’s edge as detected
by the Media Sensor). The printer will feed from the top-of-form to the value specified in this
command to begin printing.
This value operates independently of the <STX>f command.
Non-Display Models: The printer Options Control must be set (via the menu) to ‘Host’ for this
command to have effect.
Display-Equipped Models: If SOP Emulation is set to ‘enabled’ (via the menu), this command sets
the point where printing starts, emulating the selected legacy printer’s distance, as measured between
the media sensor and the print head burn line. In addition, regardless of the SOP Emulation setting,
the start of print position can be fine-tuned via the menu: Menu Mode / Print Control / Custom
Adjustments / Row Adjust.
Syntax:
<STX>Onnnn
Where:
nnnn
-Is a four-digit offset value in inches/100 or mm/10. The
“zero” setting is the default value, and settings below 50 are
adjusted back to the default value.
Non-Display Models: the default setting is 0220 in Imperial
Mode (0559 in Metric Mode).
Display-Equipped Models: the default setting is ‘Off’ and
the printer assumes the natural start of print position.
Sample (non-display
<STX>O0300
models):
The above sample sets a start of print position of 3.0 inches (unless in Metric Mode, see <STX>m).
Sample (display-
<STX>O0210
equipped models):
The above sample will begin printing 0.1 inch closer to the leading edge of the label if the 220
(Allegro) SOP Emulation was selected, or 1.0 inch farther away from the leading edge if 110
(ProdPlus) SOP Emulation was selected.
Class Series Programmer’s Manual23
System-Level Command Functions
STX oCycle Cutter
This command will cause the optional cutter mechanism to immediately perform a cut after all
previously received commands are executed. The cutter must be installed, enabled and the
interlock(s) closed for operation.
Syntax:
<STX>o
STX PSet Hex Dump Mode
This command instructs the printer to assume Hex Dump Mode. Instead of a formatted product, data
sent to the printer following this command will be printed in the raw ASCII format. To capture this
data, labels must be at least four inches (102 mm) long and as wide as the maximum print width. This
command has the same effect as turning the printer ‘On’ while pressing the FEED Key; however, no
Configuration/Test Pattern label will be printed. To return to normal operation the printer must be
manually reset.
Syntax:
<STX>P
STX pControlled Pause
The controlled pause command will cause the printer to pause only after all previously received
commands are executed. This is often useful between label batches. (This command will not clear the
pause condition, see <SOH>B).
Syntax:
<STX>p
STX QClear All Modules
This command instructs the printer to clear all of the Flash and DRAM modules (see the Operator’s
Manual of the corresponding printer for applicable module options). All stored data will be
destroyed.
Syntax:
<STX>Q
24Class Series Programmer’s Manual
System-Level Command Functions
STX q Clear Module
This command clears the selected Flash or DRAM module. If a module is corrupted during normal
operations (identifiable when the printer responds with a ‘No Modules Available’ message to a
<STX>W command), it must be cleared. All stored data will be destroyed.
Syntax:
Where:
Sample:
<STX>qa
a
<STX>qA
-Memory module designator, see Appendix K.
The sample clears memory module A.
Notes:(1) If a module directory intermittently returns the message ‘No Modules Available’ or if data
continuously becomes corrupt with the write protect switch on, the module may be at the end of its
service life. Before, however, concluding that a module is defective, cycle the printer’s power and
test the module.
(2) E-Class models: Some Flash Memory Expansion options must have Write Enable jumpers
installed to perform this command.
STX RRibbon Saver On/Off
(Display-Equipped Models only)
This command enables the operation of the optional Ribbon Saver. It is the only command used to
control the Ribbon Saver. Its operation is continuous when enabled. The printer must be set to
thermal transfer (ribbon) printing mode then, during operation, the Ribbon Saver engages
automatically, lifting when the minimum amount of label white space is exceeded.
Syntax:
Where:
Sample:
The sample will turn the ribbon saver on.
Note: This command is ignored on units not equipped with the ribbon saver option.
<STX>Rx
x
<STX>RY
-Y - Enabled (Default = Menu selection.)
N - Disabled
Class Series Programmer’s Manual25
System-Level Command Functions
STX rSelect Reflective Sensor
This command enables reflective (black mark) sensing for top-of-form detection of rolled butt-cut,
and fan-fold or tag stocks with reflective marks on the underside. This Media Sensor will detect a
minimum mark of 0.1 inches (2.54 mm) between labels (see the Operator’s Manual for media
requirements). The end of the black mark determines the top of form. Use the <STX>O command to
adjust the print position.
Syntax:
Default setting:Edge sensing
<STX>r
STX SSet Feed Speed
This command controls the output rate of the media when the FEED Key is pressed.
Syntax:
Where:
<STX>Sn
n
-Is a letter value (see Appendix L).
STX s Set Single Buffer Mode
(Non-Display Models only)
This command, available for backward compatibility, instructs the printer to use single buffer
operation. In single buffer mode, the printer will erase and format all fields. This, in turn, decreases
printer throughput when incrementing, decrementing, or replacement fields are used (see Label
Formatting Commands). See <STX>d.
Syntax:
26Class Series Programmer’s Manual
<STX>s
System-Level Command Functions
STX TPrint Quality Label
This command instructs the printer to produce a Print Quality label, a format comprised of different
patterns and bar codes useful in printer setup. (On display-equipped models, this is also one of the
Quick Test formats.) To capture all printed information, use the labels as wide as the maximum print
width (see Appendix K) and at least four inches (102 mm) long.
Syntax:
<STX>T
Printer response (dot
patterns may vary):
STX tTest DRAM Memory Module
This command tests the DRAM module. The printer returns a one-line message stating the module
condition (no message is returned if a module is unavailable).
Syntax:
<STX>t
results
- Test results given as ‘Good’ or ‘Bad’.
Non-Display Models: The printer must be in Test Mode for the command to function. To enable the
Test Mode see the <STX>KD command.
Printer response format:
Where:
axxxK results<CR>
a
xxx
-2 = Slot B
- Module size in Kbytes
Display-Equipped Models: The printer must have Feedback Characters enabled for this command to
function. Feedback Characters can be enabled via the menu (see the Operator’s Manual for additional
information).
Printer response format:
Where:
Class Series Programmer’s Manual27
Module A: xxxxK
Module B: xxxxK
Module D: xxxxK
xxxx
- Module size in Kbytes.
DRAM Testedresults<CR>
DRAM Testedresults<CR>
DRAM Tested results<CR>
System-Level Command Functions
STX ULabel Format String Replacement Field
This command places new label data into format fields to build a label. Two options are available:
Exact Length and Truncated Length.
To easily keep track of fields, place all of the fields to be updated with the command at the beginning
of the label format. A maximum of 99 format fields can be updated. Fields are numbered
consecutively 01 to 99 in the order received.
Exact Length Replacement Field Functions – The new data string must equal the original string
length and contain valid data. When the dynamic data is shorter than the length of the originally
defined data field, then field will be padded with blanks (or zero when the Format Record header
specifies a numeric bar code).
Syntax:
Where:
Exact Length Sample:
<STX>Unnss…s<CR>
nn
ss…s
- Is the format field number, 2 digits.
-
Is the new string data, followed by a <CR>
<STX>L
1A1100001000100DATA FIELD 1<CR>
161100001100110data field 2<CR>
161100001200120data field 3<CR>
Q0001
E
<STX>U01123<CR>
<STX>U02New data F2<CR>
<STX>E0002
<STX>G
The sample produces three labels. The first is formatted with the commands between <STX>L and
E. The next two labels print with the replacement data contained in the <STX>U commands (see
<STX>E and <STX>G). The bar code is the same length: 3 digits and nine spaces.
Truncated Length Replacement Field Functions – A variant of the <STX>U command includes the
truncate option ‘T’, where dynamic data shorter than the originally defined field length will not be
padded and the original maximum field length is maintained for subsequent replacements.
Syntax:
Where:
<STX>UTnnss…s<CR>
nn
T
ss…s
28Class Series Programmer’s Manual
- Is the format field number, 2 digits.
- Truncate option
-
Is the new string data, followed by a <CR>
System-Level Command Functions
Truncated Sample:
<STX>L
1A1100001000100data field 1<CR>
161100001100110data field 2<CR>
161100001200120data field 3<CR>
Q0001
E
<STX>UT01123<CR>
<STX>U02New data F2<CR>
<STX>E0002
<STX>G
The sample produces three labels. The first is formatted with the commands between <STX>L and
E. The next two labels print with the replacement data contained in the <STX>U commands (see
<STX>E and <STX>G). The bar code is shortened; it only has three digits (and no spaces).
STX VSoftware Switch Settings
This command controls the printer options, where the appropriate value allows the option(s) to be
‘On’ or ‘Off.’ Each option has a corresponding bit whose value is ‘1’ when enabled. The tables below
indicate the bit assignments and corresponding command value needed to enable the desired
option(s).
Display-Equipped Models: Printer options are set by entering selections through the menu. The
software setting command allows two of these option settings to be modified without returning to the
menu.
Syntax:
Where:
<STX>Vn
n
-Is a single digit ASCII numeric value from 0-F. The value of
n is used to override the power-up option settings. Reset or
power-up returns the printer to the original settings.
Sample:
<STX>V5
The sample corresponds to setting Bits 0 and 2, creating a command value of 5. When applied, this
enables the Present Sensor and Cutter options.
Bit AssignmentPrinter Option
0Cutter
1N/A
2Present Sensor
3N/A
Table 4-1: Software Switch Bit Assignment
Use the bit assignment table above to determine the command value n in the binary table below (e.g.,
the command value 5 sets the bits 0 and 2 to ‘1’).
Class Series Programmer’s Manual29
System-Level Command Functions
Command Values for Bits Assigned
Bit
n Value
3210
00000
10001
40100
50101
Table 4-2: Software Switch Binary
STX vRequest Firmware Version
This command causes the printer to send its version string (this data is the same as that printed on the
configuration label). The version may be different from printer to printer.
Syntax:
Printer Response:
<STX>v
VER: 4308 – 06.06 07/09/2001 <CR>
30Class Series Programmer’s Manual
System-Level Command Functions
STX WRequest Memory Module Information
This command requests a memory module directory listing. Results may vary depending on printer
class, model, or firmware version.
Syntax:
Where:
Sample:
<STX>W[b][c]a
b
c
a
optional – list file size also
s
optional – list file extension also
e
Data type:
-
F
=
G
=
L
=
C
=
X
=
N
=
M
=
f
=
*
=
<STX>WF
Downloaded font
Graphic (Image)
Label format
Configuration file
Language file
Plug-in
Miscellaneous type file
Resident fonts
All types
Printer response (taken from an H-Class with a downloaded true type font on Module D):
MODULE: D<CR>
S50 92244ttf50<CR>
AVAILABLE BYTES: 945152<CR>
MODULE: G<CR>
AVAILABLE BYTES: 852480<CR>
MODULE: X<CR>
AVAILABLE BYTES: 852480<CR>
MODULE: Y<CR>
AVAILABLE BYTES: 852480<CR>
Class Series Programmer’s Manual31
System-Level Command Functions
STX wTest Flash Memory Module
This command tests the Flash memory module. The time for each test will vary from 20 to 120
seconds, depending upon the size of the module. All stored data will be destroyed. If no module is
present, there will be no printer response.
Syntax:
Where:
Printer response format:
Where:
Note: E-Class models: Some Flash Memory Expansion options must have Write Enable jumpers installed
to perform this command.
<STX>wa
a
- Module designator; see Appendix K.
Module A: xxxxK results
A
xxxx
results
- Module tested.
- Module size in kilobytes.
- Test results given as ‘Good’ or ‘Bad’.
STX XSet Default Module
This command, typically used prior to the loading of PCL-4 bit-mapped fonts (see Font Loading
Commands), is designed to allow the user to select between modules when downloading information.
The default module is one of the following:
1. The first alpha designator of the existing modules if item 2 has not occurred.
2. The module selected by this command.
Syntax:
Where:
Sample:
The sample sets ‘B’ as the default module.
32Class Series Programmer’s Manual
<STX>Xa
a
<STX>XB
-Module designator; See Appendix K.
System-Level Command Functions
STX xDelete File from Module
This command removes a specific file from the specified module. The file name is removed from the
module directory and thus the file cannot be accessed. The actual storage space occupied by the file is
not released. To reclaim deleted file storage space use <STX>z to pack module.
Syntax:
Where:
Sample:
<STX>xmtnn…n<CR>
m
t
nn…n
- Module designator; see Appendix K.
- The file type identification code:
G
=
=
L
=
F
=
S
=
C
=
X
=
N
=
M
=
u
-The file to delete, where:
Font (bitmapped), the three character font identifier;
Font (scalable), the two character font identifier;
Graphic name, up to sixteen alphanumeric characters; and,
Label format name, up to sixteen alphanumeric characters.
<STX>xDS50<CR>
Image file
Label format file
Downloaded bit-mapped font file
Downloaded scalable font file
Configuration file
Language file
Plug-in file
Miscellaneous file type
Unknown type – must use extension if applicable
This sample deletes a downloaded scalable font with ID 50 from module D.
Class Series Programmer’s Manual33
System-Level Command Functions
STX YOutput Sensor Values
This command causes a sensor value response. When <STX>Y is received, the printer will respond
with the digitally converted values of the internal analog sensors (see below). To repeat the display of
values, send the printer a ‘SPACE’ character (20 hexadecimal); or, send <ESC> to terminate this
function.
Non-Display Models: The printer must be in Test Mode for the command to function. To enable the
Test Mode see the <STX>KD command.
Display-Equipped Models: The printer must have Feedback Characters enabled for this command to
function. (Feedback Mode [Characters] can be enabled via command or menu setting; see the
<STX>KcFM command or the Operator’s Manual for additional information).
Syntax:
Printer response:
Where:
Notes: • Equipped sensors may vary with printer, model, and options.
• Some readings require printer-controlled paper movement to produce a meaningful value.
• Media Sensor readings require the appropriate sensor selection, transmissive (
Battery level: Good indicates a sufficient battery charge;
Low indicates an insufficient charge.
<STX>e) or
<STX>r), and label stock in the Media Sensor.
STX ySelect Font Symbol Set
This command selects the scalable font symbol set. The selected symbol set remains active until
another symbol set is selected. See the <STX>KS command and Appendices E, I, and H for more
information. Option dependant, and not all symbol sets can be used with all fonts.
Syntax:
Where:
<STX>ySxx
S
xx
Sample:
<STX>ySPM
The sample selects the PC-850 multilingual set.
34Class Series Programmer’s Manual
-Byte-size designation; see Appendix H:
S = Single byte symbol sets.
U = Double byte symbol sets.
-Symbol set selection.
System-Level Command Functions
STX ZPrint Configuration Label
This command causes the printer to produce a Database Configuration Label. To capture all printed
information, use the labels as wide as the maximum print width (see Appendix K) and at least four
inches (102 mm) long.
Syntax:
Printer response:
FRI SEPTEMBER 026, 1997 19:29 244
Note: Printed information will vary according to printer, model, firmware version, and options.
This command causes the printer to reclaim all storage space associated with all deleted files on the
specified module (see <STX>X and <STX>x).
Syntax:
Where:
Class Series Programmer’s Manual35
<STX>zm
m
-The module identification character, see Appendix K.
System-Level Command Functions
36Class Series Programmer’s Manual
Extended System-Level Command Functions
Introduction
Issued in the same context as System-Level Commands, the Extended System-Level Commands expand
certain System-Level Commands to provide extra degree of printer control.
This command configures the available DRAM (including any installed optional DRAM) as a method
for managing printer memory. Memory can be assigned to specific entities or functions in units of
4KB blocks. The allocation(s) set by this command, draw from the same memory pool, affecting
maximum print length and label throughput (see note below). The printer executes the memory
configuration specified by the command during the next idle period following its receipt, and is stored
in Flash memory then reinstated upon a power-up or reset. If the total requested memory allocation
exceeds the configurable memory available, contains no fields, or for configurations not specified, the
command will be rejected and the printer will assume its previous configuration. Any of the three
fields are optional, and are separated by the colon. Brackets indicate optional fields.
Syntax:
Sample:
In the sample, memory is allocated 20*4*1024 bytes for module space and 15*4*1024 bytes for the
scalable cache.
Where: i, j, k are M, S, or W; x, y, z are four-digit maximum numbers of 4K byte blocks or
inches/100 or (mm/10) as described below.
MRepresents the start of a sequence (up to five characters) that assigns memory to the Internal
Module. If this field does not appear, then the Internal Module is not affected. If no Internal
Module exists, it will be created and formatted. Existing Internal Modules will be erased, resized and formatted. The number that follows the M is a decimal number (up to four digits) that
specifies the size in 4KB blocks of memory to assign to the Internal Module. A value of “0000”
will delete the Internal Module (see Appendix J for additional information).
SRepresents the start of a sequence (up to five characters) that assigns the amount of internal
memory allocated to the smooth scalable font processor. This field is optional; if it does not
appear, the current amount of memory assigned to the smooth scalable font processor will
remain unchanged. The allocation must be at least 15 (60KB) to print scalable fonts, and at least
30 for double-byte fonts. The number that follows the S is a decimal number (up to four digits)
that specifies the size in 4 KB blocks to assign to the smooth scalable font processor. Any value
less than the minimum requirement results in the amount assigned to be zero (0), thereby
disabling the printing of smooth scalable fonts. The recommended value is 0025 (100KB).
<STX>Kix[:jy][:kz]<CR>
<STX>KM0020:S0015<CR>
Class Series Programmer’s Manual37
Extended System-Level Command Functions
WRepresents the start of a sequence (up to five characters) that sets the printable label width.
Setting a width smaller than the natural (maximum) width of the printer effectively extends
printable label length. This field is optional; if it does not appear, the current printable label
width is left unchanged. The number that follows the W is a decimal number (up to four digits)
that specifies the printable label width in either 100
ths
of an inch or in millimeters, depending on
the current units setting of the printer (imperial or metric). If the value specified exceeds the
printable width of the printer, the printable label width is set to the maximum. If the value
specified is less than the minimum value allowed (200) then the printable label width is set to the
minimum allowed value.
Notes: (1) Label printing requirements may be computed as bytes (label print length * width allocation *
print head resolution / 8). For maximum throughput, the memory allocated should allow for a
minimum of three times the computed requirement, or the available label length (as determined by
<STX>KQ command) should be three times the label print length.
(2) These commands will result in a system reset for the EX2.
This command causes the printer to determine and save the calibration value for an empty media
sensor condition. This calibration function should be performed when no material is installed in
the media sensor. Depending upon the printer model, different front panel LED flash sequences
and printer responses (below) will indicate calibration progress and outcome; see the
corresponding printer operator manual for LED flash sequences details.
Printer ResponseAlternate
REMOVE STOCK[CR ]N/A
ENTER TO CONTINUE[CR]N/A
PASSED CALIBRATION[CR]FAILED CALIBRATION[CR]
STX K}MManual Media Calibration (Non-Display Models only)
This command causes the printer to save the sampled calibration values as an operator places
different portions of label stock within the media sensor. Depending upon the printer model,
different front panel LED flash sequences and printer responses (below) will indicate calibration
progress and outcome; see the corresponding printer operator manual for LED flash sequences
details. Sending <ESC> to the printer instead of <CR> will terminate the process and leave the
TOF Sensor values unchanged.
Printer ResponseAlternate
LOAD STOCK[CR ]
ENTER TO CONTINUE[CR ]
LOAD MARK[CR ]
ENTER TO CONTINUE[CR ]
REMOVE STOCK[CR ]
ENTER TO CONTINUE[CR ]
LOAD GAP[CR ]
N/A
N/A
PASSED CALIBRATION[CR ]FAILED CALIBRATION[CR ]
38Class Series Programmer’s Manual
Extended System-Level Command Functions
STX K}Q Quick Media Calibration (Non-Display Models only)
This command causes the printer to move media, sample, and then save sensor samples as
calibration values. This calibration function should be performed with media installed in the
printer. Depending upon the printer model, different front panel LED flash sequences and printer
responses (below) will indicate calibration progress and outcome; see the corresponding printer
operator manual for LED flash sequences details.
Printer ResponseAlternate
FAILED CALIBRATION[CR ]
ADJUST GAIN SETTING[CR ]
PASSED CALIBRATION[CR ]FAILED CALIBRATION[CR ]
N/A
STX KaRRead Data from RFID Tag
(Direct Mode – Generic Read/Write Interface)
This command instructs the RFID device to read data from the tag and then place that data into a
replaceable field. It is expected that the tag transponder will be within the read / write distance of the
RFID programming device; otherwise, “Void” will be printed in the text or bar code label field.
Syntax:
Where:
Sample:
<STX>KaRAaaabbbcdee<CR>
A
aaa
bbb
-Optional – for data in the ASCII format.
-The number of bytes to read.
-HF - Starting block number (000 maximum block number).*
UHF – Should be 000.
c
d
ee
-Command 1. Reserved. Should be 0.
-Command 2. Reserved. Should be 0.
-Field number in which to place the data (must be 01, 02, 03, etc.)
matching the order of Label Formatting command U.
Note: The 00 value will send read data to the host with no printing.
<STX>L
1911A1802000010TEXT
U
X
<STX>KaR0000010001
<STX>G
The sample creates a replaceable text field (01), recalls data from the RFID tag block zero (reading
only one block), and prints the data in the location specified by the replaceable field. Since there are
two digits per each hex value, replaceable fields should be twice as long than if using ASCII data
(e.g., the character “A” would be returned as “41”).
* Dependent upon transponder manufacturer.
Class Series Programmer’s Manual39
Extended System-Level Command Functions
STX KaWWrite Data to RFID Tag
(Direct Mode – Generic Read/Write Interface)
This command instructs the RFID device to write data to the tag. It is expected that the tag
transponder will be within the read / write distance of the RFID programming device; otherwise, a
warning will occur and a warning message (Read / Write Fail) will be displayed.
Syntax:
Where:
<STX>KaWAaaabbbcdee…e<CR>
Aaaa
- Optional – for data in the ASCII format, followed by the byte
count (000-999).
bbb
- HF – Starting block number (000 maximum block number).*
UHF – Should be 000.
c
d
ee…e
- Command 1. Reserved for Future (should be 0)
- Command 2. Reserved for Future (should be 0)
- Data to be encoded on RFID tag (HF – the last used block will be
null-padded, if necessary).
Note: UHF ASCII formats must be 8 or 12 characters; and, UHF
Hexadecimal formats must be 16 or 24 character pairs.
Sample:
<STX>KaW0000054455354[CR]
The sample writes the data “TEST” at block zero.
* Dependent on transponder manufacturer.
STX KbBackfeed Time Delay
(Non-Display Models only)
The backfeed time delay command controls the time a printed label is allowed to remain “presented”
before being retracted to the start of print position.
Syntax:
Where:
40Class Series Programmer’s Manual
<STX>Kbnnn<CR>
nnn
- Seconds/10
Extended System-Level Command Functions
STX KCGet Configuration
This command returns the configuration of the printer. The form of the returned data is similar to that
of a printed Configuration Label. This command should be parsed by KEYWORDS, not by
Character POSITIONS. Each line is terminated by a CR (0x0d) & LF (0x0a). Datamax will
make every effort to keep Keyword consistent.
06.06 07/09/2001
BOOT LOADER:
83-2269-03D 03.04
10/30/2000
SYSTEM INFORMATION
PRINT BUFFER SIZE:
280 in.
FLASH SIZE:
4 MB
RAM TEST:
PASS
OPTIONAL
LANGUAGES:
FRANCAIS
ITALIANO
DEUTSCH
ESPAÑOL
CONFIGURATION
FILE:
NONE
MEDIA SETTINGS
MEDIA TYPE
THERMAL TRANSFER
SENSOR TYPE
GAP
LABEL LENGTH
04.00 in.
MAXIMUM LABEL
LENGTH
•30.00 in.
PAPER OUT DISTANCE
00.25 in.
LABEL WIDTH
4.16 in.
SENSOR CALIBRATION
PAPER SENSOR LEVEL
144
GAP SENSOR LEVEL
30
EMPTY SENSOR LEVEL
0
<STX>KC<CR>
SENSOR GAIN
10
PRINT CONTROL
HEAT
10
PRINT SPEED
6.0in/sec
FEED SPEED
6.0in/sec
REVERSE SPEED
4.0in/sec
ROW OFFSET
00.00 in.
COLUMN OFFSET
00.00 in.
PRESENT DISTANCE
0.00 in.
CUSTOM
ADJUSTMENTS:
DARKNESS
32
ROW ADJUST
64 DOTS
COLUMN ADJUST
0 DOTS
PRESENT ADJUST
64 DOTS
PRINTER OPTIONS
MODULES
A: NOT INSTALLED
B: NOT INSTALLED
D: FORMATTED
F: NOT INSTALLED
G: FORMATTED
X: FORMATTED
Y: 83-2296-01C
Z: NOT INSTALLED
PRESENT SENSOR
NOT INSTALLED
CUTTER
NOT INSTALLED
GPIO PORT:
NOT INSTALLED
SYSTEM SETTINGS
FACTORY SETTING
FILE
NONE
INTERNAL MODULE
1024 KB
DEFAULT MODULE
D
SCALEABLE FONT
CACHE
312 KB
SINGLE BYTE
SYMBOLS
PC-850
MULTILINGUAL
DOUBLE BYTE
SYMBOLS
UNICODE
ABSOLUTE COUNTER
3782 in.
27MAR2001
RESETTABLE COUNTER
205 in.
27MAR2001
FORMAT ATTRIBUTES
XOR
IMAGING MODE
MULTIPLE LABEL
PAUSE MODE
DISABLED
SELECT SECURITY
DISABLED
PEEL MODE
DISABLED
UNITS OF MEASURE
IMPERIAL
SOP EMULATION
DISABLED
BACK AFTER PRINT
DISABLED
MENU LANGUAGE
ENGLISH
COMMUNICATIONS
SERIAL PORT A:
BAUD RATE
9600 BPS
PROTOCOL
BOTH
PARITY
NONE
DATA BITS
8
STOP BITS
1
SERIAL PORT B:
NOT INSTALLED
PARALLEL PORT A:
PORT DIRECTION
UNI-DIRECTIONAL
PORT STATUS
DISABLED
PARALLEL PORT B:
PORT DIRECTION
BI-DIRECTIONAL
PORT STATUS
DISABLED
NIC ADAPTER:
DMXNET INACTIVE
HOST SETTINGS:
HOST TIMEOUT
10 SEC
CONTROL CODES
STANDARD CODES
FEEDBACK
CHARACTERS
DISABLED
ESC SEQUENCES
ENABLED
HEAT COMMAND
ENABLED
SPEED COMMANDS
ENABLED
DIAGNOSTICS
HEX DUMP MODE
DISABLED
PRINT TEST
RATE(min)
0
SENSOR READINGS
THR TRAN RIBM 24V
132 141 159 178
PS HD RANK
000 254 000
RIBBON SENSOR
LIMITS
RIBBON ADC LOW
105
RIBBON ADC HIGH
182
END OF LIST
Note: Formatted form of displayed information will vary with printer, model, firmware version, and equipped
options.
Class Series Programmer’s Manual41
Extended System-Level Command Functions
STX Kc Configuration Set
This command specifies the Power-up Configuration parameter values for the printer and is
equivalent to using other system commands followed by the <SOH>U. This command is intended
for easily configuring a custom setup, but NOT for dynamic configuration changes.
Configuration commands are examined for differences relative to the current configuration; the
command has no impact when there are no differences. Display-equipped models will reset upon
completion of a command stream containing parameter value changes; non-display models perform
this reset only for certain functions, such as memory allocation. In any case, no commands should be
sent to the printer until this reset is complete. These are some highlights of the command:
These parameter values are equivalent to changing the respective menu settings and do not affect
the factory default settings of the printer.
If separated by a semi-colon (;), multiple parameter values may be sent in a single command
stream; see sample below.
All values are stored in Flash memory and remain in effect until new values are received or until
factory defaults are restored.
If system commands are sent that override the Power-up Configuration value(s), the Power-up
Configuration value(s) will be restored the next time the printer is powered ‘On’ or reset.
These parameters are the same as those found in the Setup Menu (non-display models), or as
those found in the Menu System (display-equipped models). The respective functions are
documented in the appropriate Operator’s or Maintenance Manual. Not all commands are
effective on all Class printers.
Note: Illegal or out of range parameter values may have unpredictable results. In addition, Media sensing
scaling values, TOF Bias, etc. may not be effective on other printers of the same type due to
hardware tolerances.
Syntax:
Where:
<STX>Kcaa
aaI, aa
aa
1,
val
1,
val
val1[;aaIvalI][;aanvaln]<CR>
1
- Are two letter parameter names.
n
I,
val
- Are parameter values, with ranges appropriate for
n
the associated parameter.
Sample:
<STX>KcPA120;CL600;STC<CR>
The sample sets the Present Adjust to 120 dots, the Continuous Label Length to 6 inches, and the
Sensor Type to Continuous.
The following table (constructed alphabetically by parameter name) summarizes the different
Configuration Set command parameters, value ranges, valid printer models, and menu item and
command equivalents (where applicable). If no command equivalent is given, or where general
clarification is necessary for the command, descriptions (listed alphabetically by parameter
pneumonic) immediately follow this table.
N, Y, TSee Table 5-9.Display-EquippedSystem SettingsN/A
Display-Equipped
Sensor Gain Value
SG
0 – 32N/A
EX2
Media SettingsN/A
Display-EquippedMedia Settings
M1 & M2
Non-Display
<STX>e,
<STX>r,
<STX>c
Sensor Type
ST
G, C, R
G = Gap (edge),
C = Continuous,
R = Reflective
Non-Display
2
<STX>KD
Display-EquippedCommunications
M1 & M2
Non-Display
9 & 10
N/A
Serial Port
SP
xyzSee Table 5-12.
Non-Display7 & 8
<STX>KD
Display-EquippedSystem Settings
Single Byte Symbol Set
AS
2-Byte alpha
character
AA – ZZ, printer
resident symbol set
Non-DisplayN/A
<STX>y,
ySxx
Slew Speed
FS
Alpha
character
Model specific ranges;
see Appendix L.
GPIO-EquippedPrint Control
<STX>KZSx
Table 5-1: Configuration Set Commands (continued)
Extended System-Level Command Functions
Class Series Programmer’s Manual59
<STX>Kc
Parameter Name
Parameter
Pneumonic
Value /
Range
Units /
Interpretation
Applicable
Printer Type
Menu Item Equivalent
or Menu Item Number
Command
Equivalent
Software Switch
SV
Y, N
Y = Processed
N = Ignored
Display-EquippedCommunicationsN/A
Start of Print
EQ
3, 4
3 = Active Low,
4 = Active High
Display-EquippedPrinter OptionsN/A
Non-Display20
Stop Location
SL
A, H, P,
C, T, N
See Table 5-10.
M1 & M2
Non-Display
16
N/A
Tear Position
PT
Y, N
Y = Enabled,
N = Disabled
Non-Display (except
M1, M2, and EX2)
20N/A
TOF Bias
[2]
TB
0 – 50.1 Volt DC
Non-Display (except
M1 & M2)
14N/A
TOF Delta
[2]
TD
0 – 50.1 Volt DC
Non-Display (except
M1 & M2)
13N/A
TOF Gain
[2]
TG
0 – 15.1 Volt DC
Non-Display (except
M1 & M2)
12N/A
Table 5-1: Configuration Set Commands (continued)
Extended System-Level Command Functions
60Class Series Programmer’s Manual
<STX>Kc
Parameter Name
Parameter
Pneumonic
Value /
Range
Units /
Interpretation
Applicable
Printer Type
Menu Item Equivalent
or Menu Item Number
Command
Equivalent
Display-Equipped
TOF Precedence
TP
Y, N
Y = Enabled,
N = Disabled
EX2
N/AN/A
Display-Equipped
EX2
System Settings
Unit of Measure
UM
M, I
M = Metric,
I = Imperial
M1 & M2
Non-Display
5
<STX>m,
<STX>n
Display-Equipped
User Terminator
UT
ONN/A
EX2
N/AN/A
Verifier Equipped
VE
A/Y, E, N/D
A or Y = Auto,
E = Enabled,
N or D = Disabled
Display-EquippedPrinter Options
<STX>KV
Verifier Type
VT
A, B, C, DReserved for future useDisplay-EquippedN/AN/A
Table 5-1: Configuration Set Commands (continued)
Extended System-Level Command Functions
Class Series Programmer’s Manual61
<STX>Kc
Parameter Name
Parameter
Pneumonic
Value /
Range
Units /
Interpretation
Applicable
Printer Type
Menu Item Equivalent
or Menu Item Number
Command
Equivalent
Display-Equipped
WiFi Setup
WE
A, C, F, I, L,
M, N, P, R,
T, V, X
See Table 5-13.
EX2
N/AN/A
Display-Equipped
WiFi Security
WS
A, K, S, L,
P, U
See Table 5-14.
EX2
N/AN/A
1. Commands are provided for backward compatibility on EX2. The KcQQQ command will respond with the new command equivalent; see associated new commands.
2. The EX2 uses the same Sensor Calibration value setup commands as display model printers.
3. The EX2 will accept Display-Equipped module IDs (D & G) as command parameters for upward compatibility; however, query commands will result in printer responses with
module IDs that are non-display compatible, providing backward compatibility.
4. Present distance changes for EX2 will only be accepted if the Stop Location (SL) is set to “Host.”
Table 5-1: Configuration Set Commands
Extended System-Level Command Functions
<STX>Kc Parameter Overviews
(AL) Alignment Length – This command, critical for small labels when ‘Label Alignment’ is set
to ‘Yes,’ allows a length (measured from leading edge to leading edge of two successive labels)
to be entered. The measured length must be provided to the nearest hundredth of an inch. For
very small labels, errors of 0.01” can result in noticeable print variations on the labels between
the media sensor and the print head. The number of labels that can be fit between the Media
Sensor and the print head will magnify any error in label alignment length. Errors in measurement
are more favorable on the low side rather than the high side.
Non-Display printers only: The printer will verify the label position using the provided
Alignment Length before printing the first label after power-up.
(AS) Single Byte Symbol Set – This command allows for a default single-byte symbol set. See
<STX>y or ySxx for command details.
(BA) Backup After Print – This command determines the timing of the label back up positioning
when the present distance is set and the GPIO option or Present Sensor option (including Peel and
Present) is enabled. When enabled, the printer immediately backs up the label after the applicatorissued start of print signal is received or the label is removed, resulting in faster throughput. If
disabled, the printer will not initiate repositioning until the next label is ready to print (may help
prevent the curling of the label edge).
(BD) Backup Delay – This command sets a time delay for the retraction of a presented label in
one-fiftieth (1/50) of a second increments.
(BL) Backup Label – This command determines the timing of reverse label motion when the I &
W-Class GPIO option is installed and enabled; see Appendix J for signal details.
(BP) British Pound – This command, when enabled, will automatically switch from the Number
symbol (#) found at 0x23 (default PC-850 Multilingual Symbol Set) to the British Pound symbol
(£) at 0x9C.
(BS or bS) Backup Speed – This command controls the rate of label movement during backup
positioning for start of print, cutting or present distance; see Appendix C for available speed
ranges.
62Class Series Programmer’s Manual
Extended System-Level Command Functions
(BZ) Buzzer Enable – This command controls the audible signaling device that acknowledges
User Interface entries and, if enabled, sounds printer warning and fault conditions.
(CA) Column Adjust – This command fine-tunes the Column Offset setting by shifting both the
horizontal start of print position and the Label Width termination point to the right in dots (see
Appendix K) to compensate for slight mechanical differences sometimes evident when multiple
printers share label formats. Note that the
EX2 accepts this command for backward compatibility
only, limited in range (28-228). The <STX>KcQQQ response will show the Column Adjust Fine
Tune (CF) equivalent value.
(CB) Cut Behind – This command allows the printer to queue a specified number of small labels
before a cut is performed to increase throughput.
(CC)Control Codes – This command, depending upon printer type, allows a change to the prefix
of the software commands interpreted by the printer:
(CE) Cutter Equipped – This command allows the printer to sense the cutter option. ‘A’ automatically senses device presence; if undetected, no error is generated. ‘E’ - enables the device,
where its presence must be detected; otherwise, a fault is generated. ‘N’ - disables device
detection. One of these values is returned in response to <STX>KcQQQ. Note that alternate
values are accepted for backward compatibility as follows: For Display-Equipped models ‘Y’ is
equivalent to ‘A’; and, for Non-Display models ‘Y’ is equivalent to ‘E’.
(CF) Column Adjust Fine Tune – This command fine-tunes the Column Offset setting by
shifting both the horizontal start of print position and the Label Width termination point to the
right in dots (see Appendix K) to compensate for slight mechanical differences sometimes
evident when multiple printers share label formats.
Class Series Programmer’s Manual63
Extended System-Level Command Functions
(CH) Communicated Heat Commands – This command causes the printer to ignore DPL Heat
commands; instead, the Heat value is controlled via the menu setting.
(CL) Continuous Label Length – See <STX>c for command details.
(CO) Column Offset – See Cnnnn for command details.
(CS) Communicated Speed Commands – This command causes the printer to ignore DPL speed
commands; instead, speed values are controlled via the menu setting.
(CT) Communicated TOF Commands – This command causes the printer to ignore DPL TOF
(Gap, Continuous, and Reflective) commands; instead, the sensor type is controlled via the menu
setting.
(DE) DPI Emulation – This command allows printers with higher resolutions to emulate lower
print resolutions, as follows:
• 600 DPI can emulate 300 and 203 DPI resolutions
• 400 DPI can emulate a 203 DPI resolution
(DK) Darkness – This command controls the print head strobe timing to fine-tune the HEAT
setting.
(DM) Default Module – See <STX>X for command details.
(DR) Delay Rate – This command sets the number of minutes to delay between multiple batch
printings of Quick Test Labels.
(DS) Double Byte Symbol Set – See <STX>y or ySxx for command details.
64Class Series Programmer’s Manual
Extended System-Level Command Functions
(EM) Input Mode – This command determines the printer’s mode of data processing: Standard
DPL, or Line Mode. In Line Mode the printer will not parse character strings; instead, it will
behave as a line printer, where each carriage return terminated line of data will be printed on the
label according to a stored template. See Appendix S for details.
(EN) End Character – This command terminates a <STX>Kc string.
(EP) End of Print – This command defines the programmable signal output that signifies the End
of Print (EOP) process:
Value
3Active Low Outputs a logic low (zero) following printing.
4Active High Outputs a logic high (one) following printing.
1Low PulseOutputs a low pulse (approximately 30 milliseconds long) following printing.
2High Pulse
UnitsEnd of Print Interpretation
Outputs a high pulse (approximately 30 milliseconds long) following
printing.
(EQ) Start of Print – This command defines the type of programmable signal input required to
control the Start of Print (SOP) process:
ValueUnitsStart of Print Interpretation
3Active Low SOP signal must go low for at least 50 milliseconds to initiate printing.
4Active High SOP signal must go high for at least 50 milliseconds to initiate printing.
(ES) ESC Sequences – This command allows data containing invalid ESC control code
sequences to be processed (helpful because some systems send a “banner” to the printer). When
set to ‘Disabled,’ ESC sequences are ignored and the data is processed. Bitmapped font
downloads are disabled in this mode.
Class Series Programmer’s Manual65
Extended System-Level Command Functions
(ET) Exact Time – This command set the printer to wait until the system is idle before the next
label’s data and time fields are formatted to eliminate any discrepancy between the buffered and
printed times.
(EV) Empty Sensor Level – This command sets threshold value for the ‘Empty’ media sensor
parameter.
(FA) Format Attribute – See the “An” (in Label Formatting Command Functions) command for
details.
(FE) Font Emulation –This command allows font substitution for all Datamax internal fonts,
allowing a new default font to be defined without changing the host DPL data streams. Selecting
a default font that supports a desired character set could match with third party software to print
native characters without modifying the PC drivers. In other words, match the PC font with the
Printer Font then no interpretation would be required by driver or printer. Depending on host
drivers, the user may have to disable Symbol Set commands and modify the Default Symbol set.
66Class Series Programmer’s Manual
Extended System-Level Command Functions
(FH) Fault Handling – This command determines the level of user intervention and the
disposition of the label being printed when a fault condition (ribbon out, media out, etc.) occurs.
ValueUnits / InterpretationSelection / Definition
Interaction Level,
where:
0 = No Reprint;
1 = Standard;
and,
In No Reprint Mode (0), printing stops and a fault message is
displayed. After the problem is corrected, the FEED Key must be
pressed to clear the fault. The label in process is not reprinted.
In Standard Mode (1), printing stops and a fault message is
displayed. After the problem is corrected, the FEED Key must be
pressed to clear the fault. The label in process is reprinted.
In Void and Retry Mode (2), depending upon the RETRY COUNT,
one of the following actions when faulted:
If the Retry Count has not been exceeded, ‘VOID’ is printed on
the label in process and reprinting occurs automatically;
L
If the Retry Count has been exceeded, printing stops and a fault
message is displayed. After the problem is corrected, the FEED
Key must be pressed to clear the fault. The label in process is
reprinted; or,
2 = Void and Retry
If the CANCEL Key is pressed, the operator now has the option
of canceling the reprint:
To allow the reprint, press the ESCAPE Key or to cancel the
reprint, press the ENTER Key (the operator now has the option
of canceling the entire label batch by pressing the ENTER Key
again.)
Note: VOID will not be printed when insufficient text space exists (see
VOID DISTANCE, below) or if the fault occurs after the label reaches its
Present Distance at, or above, the TOF).
D
Void Distance
(.10 - 2.00)
Sets the distance (.10 - 2.00) to backup the faulted label to print
‘VOID’ on its trailing edge, which also indirectly establishes the
font size of the void message.
Only used with the RFIF or Scanner option installed and operating.
R
Retry Count
(0 – 3)
Establishes the number of times (0 – 3) the printer will attempt to
reprint a label. If the last label printed in this count has been
voided, the printer will stop and display a fault message.
B
Enable / disable
Y,N
Retract from presented distance prior to feed-clear motion. This
option is intended for use with applicator equipment that may
require certain GPIO signals for proper operation.
Table 5-2: Fault Handling Command
Example:
<STX>KcFHD112<CR>
(The example configures the printer to back up and print a one-inch “VOID” message on a
label when a fault is detected; if two successive faults occur during the printing of that label
then the FEED Key must be pressed to clear the fault.)
Class Series Programmer’s Manual67
Extended System-Level Command Functions
(FM) Feedback Mode – See <STX>a for command details.
(FS) Slew Speed – This command controls the rate of label movement between printing areas
when the GPIO port is used; see Appendix L for ranges.
(GE) GPIO Equipped – This command is used to interface the printer to external controlling
devices (see Appendix J):
ValueUnits / InterpretationGPIO Enable Definition
AApplicatorEnables the GPIO for a label applicator.
VVerifierEnables the GPIO for a bar code verifier.
NDisabledDisables the GPIO Port.
(GM) Gap / Mark Value – This command sets threshold value for the media sensor’s ‘gap /
mark’ parameter.
(GR) Gain Reflective Value – This command sets the sensitivity of the reflective media sensor.
(GS) GPIO Slew – This command sets the GPIO slew function and control:
ValueSlew Interpretation
0Standard (Active Low)
1Low Pulse *
2High Pulse *
3Slews while low (Active Low)
4Slews while high (Active High)
* Pulse must be at least 60 milliseconds in length. Functions as if pressing the Feed Key, clearing
alarms and advancing media.
68Class Series Programmer’s Manual
Extended System-Level Command Functions
(HB) Head Bias – This command instructs the printer to switch the dot zero position: as viewed
from the printer’s front panel (or label output side) – when dot zero occupies the left-most
location on the print head then printing is left justified; when dot zero occupies the right-most
location, printing is right justified.
(HC) Head Cleaning – This command controls the print head cleaning routine. The entered value
specifies the inch (or centimeter) count to reach before prompting a print head cleaning. If the
number specified is exceeded three times, the printer will fault until cleaning is initiated.
Note: The number specified is multiplied by one thousand. Zero disables this function.
(HE) Heat – See Hnn for command details.
(HT) Host Timeout – This command controls the number of seconds a communications port must
be idle before the printer may process data from a different port. The value is also used to
“timeout” an image / label format download (i.e., if, at any time, data flow stops before a
complete label format is received, the data will be ignored).
(IC) Ignore Control Codes – This command allows the user to remove control codes (< 20 Hex)
in the data field. The selected line terminator is processed. When enabled, DPL Control Code
(SOH, STX, CR, ESC, and ^) characters are removed from the data string. (Note that some fonts
do have printable characters in this range and they will not be printed when enabled.)
(IE) Ignore Distances – This command, when enabled, prevents <STX>O processing that will
change the start of print position.
(IL) Imaging Mode – This command instructs the printer whether to pre-image the label format:
Value
MMultiple Label
SSingle Label
Units / InterpretationImaging Mode Definition
The printer images multiple labels as memory permits,
achieving the fastest throughput; however, if timestamping, the time will reflect the moment the label is
imaged rather than when actually printed.
The printer images the next label only after the previous
label has been successfully printed. Single processing
provides time-stamps that are more accurate, but it slows
label throughput time.
Note: This selection can affect the accuracy of time-stamped labels and label throughput.
Class Series Programmer’s Manual69
Extended System-Level Command Functions
(IM) Internal Module – This command sets the number of 1K blocks (or 4K blocks for nondisplay models, see the <STX>KM command) allocated for the internal RAM ‘D’ module.
(LA) Label Alignment – This command prevents labels with lengths that are less than the
distance between the print head and the Media Sensor from being wasted at power-up. See the
appropriate Operator’s Manual for specific information. Unless otherwise noted, the following
information pertains to all non-display models:
Value /
Mode
N =
Disabled
A =
Auto
Y =
Enabled
Media TypeDescription / Operation
6.5-inch and greater (≥
16.51 cm) die-cut,
notched, reflective,
continuous, and multiple
form lengths.
When disabled, non-display printers begin printing at the
current location, unless equipped with RTC (Real Time
Clock); see note below.
The EX2 assumes the label position has not moved while
power was off and that no system changes have occurred.
In auto mode, the printer will verify the label position
using the provided Alignment Length before printing the
first label after power-up.
Press and hold the FEED Key four seconds so the printer
will measure the length of the label.
6.5-inch or less (≤16.51
cm) die-cut, notched, and
The EX2 will only measure the label length when new
label stock is loaded.
reflective.
When enabled, the printer will verify the label position
using the provided Alignment Length before printing the
first label after power-up.
Specify the Label Alignment Length using the
<STX>KcAL command, or the Setup Menu.
Note: The Real Time Clock (RTC) option allows the position-state of the label to be stored, thus
eliminating the need for an alignment prior to the printing of the first label (assuming the
label position has not moved while AC power was removed). If the label stock has been
changed then a Forced Alignment (press and hold the FEED Key 4 seconds) is
recommended.
70Class Series Programmer’s Manual
Table 5-3: Label Alignment Command
Extended System-Level Command Functions
(LE) Legacy Emulation – This command enables the <STX>O and <STX>f print positioning
commands to allow backward compatibility with label formats that were designed for the
Allegro
®
Prodigy®, and Prodigy Plus® (If the printer is display-equipped, also Prodigy Max
emulation).
(LR) Label Rotation – This command sets label rotation, allowing formats to be flipped 180
degrees.
(LS) Language Select – This command selects the language for the menu system messages and
configuration label. Only languages that are resident will be available.
®
(LM) Label Store – This command selects the level of stored format recall to include the labelformatting command fields, or the label-formatting command fields and the printer state.
(LW) Label Width – This command sets the maximum limit for the printable width. Objects
extending beyond this limit will NOT print; see Appendix K. (For non-display models also see
the <STX>KW command.)
Note: The EX2 requires this command prior to the start of a label format command (<STX>L).
Class Series Programmer’s Manual71
Extended System-Level Command Functions
(MCC) Module Command – This command adjusts the size of Flash module on the optional
Expansion Card according to the table below (see Appendix K for appropriate module details):
ValueModule Command Units / Interpretation
Zxxxx
Gxxxx
Size: 1 – 7 Mbytes. This is the amount to be allocated to Module
=
memory will be allocated to Module
Size: 1 – 56, in 128 Kbytes blocks. This is the amount to be allocated to Module
=
any remaining memory will be allocated to Module
F.
X.
Z; any remaining
G;
Table 5-4: Module Command
(ML) Maximum (Label) Length – See <STX>M for command details.
(MM) Menu Mode – This command sets the menu access level of the printer – where User is a
basic listing of menu settings and controls, and Advanced is a full menu listing.
(MT) Media Type – This command selects the printing method: Direct Thermal for use with heat
sensitive media or Thermal Transfer for use with media requiring a ribbon to create an image.
(For non-display models also see the <STX>KD command.)
(MV) Mark Value – This command sets threshold value for the reflective media sensor’s ‘mark’
parameter.
72Class Series Programmer’s Manual
Extended System-Level Command Functions
(NT) Network Setup – This command configures the printer for an Ethernet connection. Each
octet must be zero-filled to be properly interpreted (e.g., an IP Address of 10.12.0.243 must be
sent to the printer as 010.012.000.243).
ValueParameterInterpretationDefault Value
Is Discovery (DHCP or Bootp), where a:
Da
Gyyy.yyy.yyy.yyy
Ixxx.xxx.xxx.xxx
Nxxx.xxx.xxx.xxx
Pxxxx
Syyy.yyy.yyy.yyy
Ta
Y = Enable
N = Disable
Is the Gateway Address, where:
y = 0 to 9
Is the IP Address, where:
x = 0 to 9
Is the SNMP Trap Address, where:
x = 0 to 9
Is the Port number, where:
x = 0 to 9
Is the Subnet Mask, where:
y = 0 to 9
Is SNMP enable,
where a:
Y = Enable
N = Disable
000.000.000.000
192.168.010.026
000.000.000.000
255.255.255.000
Y
9100
Y
*
Uxxx.xxx.xxx.xxx
wa
Wxxx.xxx.xxx.xxx
Yxxx.xxx.xxx.xxx
Zxxx.xxx.xxx.xxx
* Prior to the introduction of WiFi, 192.0.0.192 was the IP default value and the Subnet Mask was 0.0.0.0.
The command string above is typical of a network setup string (where the values meanings are
shown in the following table). This configuration setup command string may be included with
any other Kc sub-commands.
Sub-commands and ValuesInterpretation
NTI010.012.000.243
NTS255.255.000.000
NTG010.012.254.254
NTDN
IP Address: 10.12.0.243
Subnet Mask: 255.255.0.0
Gateway Address: 10.12.254.254
DHCP is disabled
(NR) No Reprint – This command controls the label reprint function following the correction of a
fault condition. Upon detection of a fault (ribbon out, paper out, etc.), printing stops and a fault
indicator is illuminated. After the problem is corrected, the FEED Key must be pressed to clear
the fault and resume normal operation. When enabled, the label in process is not reprinted.
(NS) Disable Symbol Set Selection – This command prevents the <STX>y and y commands
from changing the default single-byte symbol set. When enabled, DPL Symbol Set commands are
ignored.
Note: When enabled, the only way to change the current symbol set is with the <STX>KcAS
command.
74Class Series Programmer’s Manual
Extended System-Level Command Functions
(OF) Option Feedback Mode – This command configures the printer to output the status of the
RFID or Scanner option to the active port, as follows.
Note: 10.xx firmware is required; and, not supported on the I-4208 printer.
ValueOption Feedback Mode Units / Interpretation
D
=Disable
D, Rx, S
Rx
S
RFID Enable, where x is the response format, as follows:
=
=Scanner Enable
A = ASCII
H = Hexadecimal
Table 5-6: Option Feedback Command
Once enabled, the printer will report information about the results of the last label printed. One
response per label is returned to the host (this includes each voided and retried label). The
format and contents of the returned information is as follows:
Printer response format:
Where:
<A;B;C;D;E;F>[CR]
A
- Device type:
R = RFID
S = Scanner
B
- Resulting status:
C = entire label complete
F = faulted (failed) label
U = unknown
C
- The number of expected reads for bar codes or tags, given in
two characters.
D
- The number of good reads for bar codes or tags, given in two
characters.
E
- The printer’s internal Job Identifier and Sub Job Identifier,
given in four characters each.
F
- The data read, delimited with semicolons (;) if multiple reads.
RFID response sample differences: Since RFID commands vary in operation, the data returned
also differs. Write commands return entire tag data; Write/Verify commands return the data
written; and, Read commands return data and length requested in the specified format. (See
Appendix T for a listing of commands.)
(PA) Present Adjust – This command fine-tunes the Present Distance setting in dots to
compensate for slight mechanical differences sometimes evident if multiple printers share label
formats. The
228). <STX>KcQQQ response shows the
EX2 accepts this command for backward compatibility only, limited in range (28-
Present Adjust Fine Tune (PJ) equivalent value.
(PC) Print Contrast – This command adjusts the relative print edge (gray) component of the print
quality, which allows fine-tuning for specific media/ribbon mix.
(PD) Present Distance – This command sets the label stop position past the start of print. When
the next label format is received, the printer will automatically backfeed to the start position. If
the present distance is set to zero, the printer will operate without reversing. (See Stop Location,
below).
(PE) Peel Mode – This command, when enabled, specifies that a Feed operation be prevented
when the label is presented and not removed, or if the printer is to wait for the GPIO start of print
signal.
76Class Series Programmer’s Manual
Extended System-Level Command Functions
(PJ) Present Adjust Fine Tune – This command fine-tunes the Present Distance setting in dots to
compensate for slight mechanical differences sometimes evident if multiple printers share label
formats.
(PL) Printer Level – This command is used to upgrade the software feature level of the printer.
(PM) Pause Mode – See <STX>J for command details.
(PO) Paper Empty – This command sets the length of travel before an out of stock condition is
declared.
(PP) Parallel Direction – This command controls the parallel port communications settings:
ValueParallel Direction Units / Interpretation
x = Port ID: A or B
xz
z = Direction: U (unidirectional – one-way communication); or,
B (bi-directional – IEEE 1284 back-channel operation).
(PS) Present Sensor Equipped – This command allows the printer to sense the present sensor
option. A or Y - automatically senses device presence; if undetected, no error will be generated. E
- enables the device, where its presence must be detected; otherwise, a fault is generated. N or D disables device detection. See <STX>V for command details. (Note that the value range for nondisplay printers is only Y, or N. Also see the <STX>KD command.)
(pS) Print Speed – See P (in Label Formatting Command Functions) for command details.
Class Series Programmer’s Manual77
Extended System-Level Command Functions
(PT) Tear Position – This command sets the label stopping location at the tear plate on the
printer’s cover.
Note: Not recommended for use with non-display printers, instead see Stop Location (SL).
(PV) Paper Value – This command sets threshold value for the media sensor’s ‘paper’ parameter.
(PW) Password – This command modifies the numeric password required to access the menu
system when security is enabled. If security is enabled, enter the new password followed by the
old password (with no spaces) in this form: XXXXXXXX
(QQ) Configuration Query – This command requires a parameter of either K or Q. K causes the
printer to respond with the Printer Key, used for generating Upgrade Codes. A parameter value
of Q causes the printer to respond with the current configuration settings. The <STX>Kc
response command stream format is sent to the host computer via the same port as the query
containing all parameters controlled by the <STX>Kc command, and may be used for restoring
the printer’s configuration or for configuring other printers.
(RA) Row Adjust – This command shifts the vertical start of print position (in dots) to fine-tune
the Row Offset setting to compensate for slight mechanical differences sometimes evident if
multiple printers share label formats. Note that the
EX2 accepts this command for backward
compatibility only, limited in range (28-228). <STX>KcQQQ response shows the Row Adjust
Fine Tune (RF) equivalent value.
(RB) Reflective TOF Bias – This command allows the manual entry for the control voltage level
to recognize a label “gap” or “mark.”
78Class Series Programmer’s Manual
Extended System-Level Command Functions
(RD) Reflective TOF Delta – This command allows the manual entry for the control of the low-
level voltage difference level to recognize a label “gap” or “mark.”
(RE) Ribbon Saver Equipped – This command allows the printer to sense the ribbon saver
option. A or Y - automatically senses device presence; if undetected, no error is generated. E enables the device, where its presence must be detected; otherwise, a fault is generated. N or D disables device detection. See <STX>R for command details.
(RF) Row Adjust Fine Tune – This command shifts the vertical start of print position in dots (see
Appendix K) upward or downward to fine-tune the Row Offset setting to compensate for slight
mechanical differences sometimes evident if multiple printers share label formats.
(RG) Reflective TOF Gain – This command allows the manual entry for the control of the
voltage to the LED emitter of the Media Sensor.
Class Series Programmer’s Manual79
Extended System-Level Command Functions
80Class Series Programmer’s Manual
(RI) RFID Configuration– This command configures the optional RFID interface module, as follows:
Table 5-8: RFID Configuration Set Commands
ValueUnits / InterpretationRFID Configuration Definition / Function
D = DisableDisables the RFID module. (“N” is also a valid disabler.)
H = HFEnables the RFID module for HF (Securakey).
U = UHFEnables the RFID module for UHF Class 1 (Alien).
Mn
where n:
M = UHFEnables the RFID module for UHF Multi-Protocol (Samsys).
AIhh
where hh:2-Chararacter Hex ID Sets the Application Family Identifier (AFI), (HF only)
ALn
and where n:
E = Enable,
D = Disable
Allows locking the AFI after writing (HF only)
DIhh
where hh:2-Chararacter Hex ID Sets the Data Storage Format Identifier (DSFID), (HF only)
DLn
and where n:
E = Enable,
D = Disable
Allows locking the DSFID after writing (HF only)
Shh
where hh:2-Chararacter Hex ID Sets the Electronic Article Surveillance (EAS) set, representing the manufacturer’s code. (HF only)
Lhh
where hh:2-Chararacter Hex ID Sets the Lock Code (Alien UHF only)
Rn
where n:0 – 9Sets the number of retries for RFID functions
Wn
where n:
E = Enable,
D = Disable
Allows locking the tag after writing.
En
where n:
E = Enable,
D = Disable
Allows erasures of the tag on error (HF only)
Pxxx
where xxx:3-digit value
Sets the tag encoding position: A value of 0.00 causes the print position to be used; or, a value
greater than 0 causes the presented position to be used. (Subject to change.)
Extended System-Level Command Functions
Class Series Programmer’s Manual81
ValueUnits / InterpretationRFID Configuration Definition / Function
Tnwhere n:
0 = ISO 15693
1 = Texas Instruments
2 = Philips
3 = ST Micro LRI 512
4 = ST Micro LRI 64
Establishes the tag type (HF only).
Nnwhere n:
64 = 64-bit
96 = 96-bit
Sets the UHF tag data size (Samsys UHF only).
Unwhere n:
0 = EPC 0
1 = EPC 0+ Matrics
2 = EPC 0+ Impinj
3 = EPC 1
4 = ISO 18000-6A
5 = ISO 18000-6B
6 = UCODE EPC 1.19
7 = EM 4022/4222
8 = Gen 2
Sets the UHF tag type (Samsys UHF only).
Vnwhere n:= a value from -4 to +4 Adjusts the power, in dBmn (Samsys UHF only).
Table 5-8: RFID Configuration Set Commands (continued)
The above example sets the printer to HF, protect after write AFI 11, protect after write DFSID 22, set EAS Bit (Mfg. Code 0x04), allow 3 tries
for each read or write attempt, lock after writing, erase the tag if there is an error, and use a position of 0.00.
Extended System-Level Command Functions
(RL) Ribbon Low Diameter – This command sets the threshold for a low ribbon indication,
where nnnn is the diameter in hundredths of inches.
(RM) Rewinder Equipped – This command allows the printer to sense the powered internal
rewind option. A or Y - automatically senses device presence; if undetected, no error is generated.
E - enables the device, where its presence must be detected; otherwise, a fault is generated. N or
D - disables device detection.
(RN) ReflectiveNo Paper Minimum – This command sets the media sensor’s reading for the Out
Of Stock (OOS) condition.
(RO) Row Offset – See Rnnnn (in Label Formatting Command Functions) for command details.
(RP) Ribbon Low Pause – This command (when enabled) pauses the printer when a Ribbon Low
Diameter warning is declared; the PAUSE Button must be pressed to continue printing.
(RR) Rewinder Adjust – This command changes the torque applied by the powered rewinder, in
percentage points of the nominal force, to minimize TOF registration drift (sometimes evident
when using small or narrow media).
(RS) Ribbon Low Signal – This command sets the signal output type for the Ribbon Low
Diameter condition when using the optional GPIO (see Appendix J).
(RV) Reflective Paper Value – This command sets the threshold value for the reflective media
sensor’s paper parameter.
(RW) Retract Delay – This command sets a time delay for the retraction of a presented label,
where the time specified is multiplied by ten milliseconds.
82Class Series Programmer’s Manual
Extended System-Level Command Functions
(SA) SOP Adjust – This command sets the start of print (SOP) location, relative to the top of
form. See <STX>O for command details. The
EX2 accepts this command for backward
compatibility only, limited in range (28-228). The <STX>KcQQQ response shows the Row
Adjust Fine Tune (RF) equivalent value.
(SC) Scalable Cache – This command sets the number of 1K blocks allocated for the scaleable
font engine. Available memory dependent upon model; see Appendix K. (For non-display models
see the <STX>KS command.)
(SE) SOP Emulation – This command enables the <STX>O and <STX>f print positioning
commands to allow backward compatibility with label formats designed for other printers.
(SF) Save As Filename – This command, which may be sent separately or included as the last
command in an <STX>Kc command string, saves the effective printer configuration to a file in
Flash memory with a .dcm file extension.
(SG) Sensor Gain Value – This command sets the control of the voltage to the LED emitter of
the Media Sensor.
(SH) Scalable Heap – This command sets a working “scratch pad space” in DRAM for scalable
font construction.
(Sl) Security Lock – This command provides the ability to password-protect all printer settings
made through the User Interface, as follows:
ValueSecurity Function
Nxxxx
Yxxxx
Txxxx
Where xxxx is the current password, this disables Menu protection.
Where xxxx is a new password, this enables Menu protection and sets a new password.
Where xxxx is a new password, this enables Menu protection, disables the User
Interface Test Button functions, and sets a new password.
Table 5-9: Security Lock Command
Class Series Programmer’s Manual83
Extended System-Level Command Functions
(SL) Stop Location – This command sets the label stopping (and in certain cases the starting)
location, as follows:
ValueStop Location
A
H
P
C
T
N
Automatically sets the stop location. Installed options will be ‘auto-sensed’ and the
appropriate stop position will automatically be set. Host commands are ignored.
Sets stop position according to options installed. If no options are installed the printer
sets stop location to the next label’s start of print. Host commands will override. The
stop location (present distance) may be controlled dynamically by the host using the
<STX>f or <STX>Kf commands. This selection has the same effect as <STX>KD
Ignore Host Distance bit value 0.
Sets the stop location to approximately 2 mm behind the peel bar edge, a nominal peel
position. The Present Sensor status and this setting are independent.
Sets the stop location to a nominal cut position. For die-cut media, the position is just
following the end of the label. The cutter status and this setting are independent.
Sets the stop location to that of the tear bar on the printer cover.
Sets the stop location to the start of the next label, equivalent to setting the <STX>KD
Ignore Host Distance bit value 1.
Table 5-10: Stop Location Command
(SM) Maximum (Label) Length Ignore – This command controls recognition of the <STX>M
command.
84Class Series Programmer’s Manual
Loading...
+ hidden pages
You need points to download manuals.
1 point = 1 manual.
You can buy points or you can get point for every manual you upload.