Labelary ZPL Reference Manual
^A font, height, width
Sets the font for the current field, using a font name.
Parameters:
- font: The font name and font orientation to use. Font names are either a capital letter (A-Z) or a number (0-9). Valid orientation values are N (no rotation), R (rotate 90° clockwise), I (rotate 180° clockwise), and B (rotate 270° clockwise). The default orientation is the orientation configured via the ^FW command, which itself defaults to N (no rotation).
- height: The font height to use, in dots. Any number between 1 and 32,000 may be used. The default value depends on the font selected.
- width: The font width to use, in dots. Any number between 1 and 32,000 may be used. The default value depends on the font selected.
Example (common usage): ^A0,30
Example (full usage): ^A0N,30,30
^A@ orientation, height, width, path
Sets the font for the current field, using a font file path.
Parameters:
- orientation: The font orientation to use. Valid values are N (no rotation), R (rotate 90° clockwise), I (rotate 180° clockwise), and B (rotate 270° clockwise). The default value is the orientation configured via the ^FW command, which itself defaults to N (no rotation).
- height: The font height to use, in dots. The default value depends on the font selected.
- width: The font width to use, in dots. The default value depends on the font selected.
- path: The path to the font file.
Example (common usage): ^A@,30,,Z:0.FNT
Example (full usage): ^A@N,30,30,Z:0.FNT
^B0 orientation, magnification, eci, size, readerInit, symbols, id
Configures the current field as an Aztec bar code.
Parameters:
- orientation: The bar code orientation to use. Valid values are N (no rotation), R (rotate 90° clockwise), I (rotate 180° clockwise), and B (rotate 270° clockwise). The default value is the orientation configured via the ^FW command, which itself defaults to N (no rotation).
- magnification: The bar code magnification to use. Any number between 1 and 10 may be used. The default value depends on the print density being used.
- eci: Whether or not the bar code data uses ECI (extended channel interpretation) to switch character sets. Valid values are Y and N. The default value is N (no ECI).
- size: The Aztec bar code size to use. Valid values are 101-104 (compact Aztec code sizes), 201-232 (full-range Aztec code sizes), 300 (Aztec runes), and 1-99 (dynamic sizing for a specific minimum error correction percentage). By default, the bar code is sized dynamically to fit the encoded data.
- readerInit: Whether or not the bar code is a reader initialization bar code. Valid values are Y and N. The default value is N (no reader initialization).
- symbols: If using structured append to split data across multiple bar codes, this parameter indicates the total number of bar codes being used. Any number between 1 and 26 may be used. The default value is 1, indicating that structured append is not being used.
- id: If using structured append to split data across multiple bar codes, this parameter indicates the message ID, which is used to correlate linked bar codes and reduce the likelihood of scanning issues. By default, no message ID is used.
Example (common usage): ^B0,3,,210
Example (full usage): ^B0N,3,N,210,N,3,777
^B1 orientation, checkDigit, height, line, lineAbove
Configures the current field as a Code 11 bar code. Note that Code 11 is not recommended for use in new applications.
Parameters:
- orientation: The bar code orientation to use. Valid values are N (no rotation), R (rotate 90° clockwise), I (rotate 180° clockwise), and B (rotate 270° clockwise). The default value is the orientation configured via the ^FW command, which itself defaults to N (no rotation).
- checkDigit: Whether or not to add an extra check digit to the bar code. Valid values are Y and N. The default value is N (no extra check digit).
- height: The bar code height, in dots. Any number between 1 and 32,000 may be used. The default value is the bar code height configured via the ^BY command, which itself defaults to 10.
- line: Whether or not to include human-readable text with the bar code. Valid values are Y and N. The default value is Y (include human-readable text).
- lineAbove: Whether or not to place the human-readable text above the bar code. Valid values are Y and N. The default value is N (if printed, text is placed below the bar code).
Example (common usage): ^B1,,50
Example (full usage): ^B1N,Y,50,Y,N
^B2 orientation, height, line, lineAbove, checkDigit
Configures the current field as an Interleaved 2 of 5 bar code.
Parameters:
- orientation: The bar code orientation to use. Valid values are N (no rotation), R (rotate 90° clockwise), I (rotate 180° clockwise), and B (rotate 270° clockwise). The default value is the orientation configured via the ^FW command, which itself defaults to N (no rotation).
- height: The bar code height, in dots. Any number between 1 and 32,000 may be used. The default value is the bar code height configured via the ^BY command, which itself defaults to 10.
- line: Whether or not to include human-readable text with the bar code. Valid values are Y and N. The default value is Y (include human-readable text).
- lineAbove: Whether or not to place the human-readable text above the bar code. Valid values are Y and N. The default value is N (if printed, text is placed below the bar code).
- checkDigit: Whether or not to add a check digit to the bar code. Valid values are Y and N. The default value is N (no check digit).
Example (common usage): ^B2,50
Example (full usage): ^B2N,50,Y,N,N
^B3 orientation, checkDigit, height, line, lineAbove
Configures the current field as a Code 39 bar code.
Parameters:
- orientation: The bar code orientation to use. Valid values are N (no rotation), R (rotate 90° clockwise), I (rotate 180° clockwise), and B (rotate 270° clockwise). The default value is the orientation configured via the ^FW command, which itself defaults to N (no rotation).
- checkDigit: Whether or not to add a check digit to the bar code. Valid values are Y and N. The default value is N (no check digit).
- height: The bar code height, in dots. Any number between 1 and 32,000 may be used. The default value is the bar code height configured via the ^BY command, which itself defaults to 10.
- line: Whether or not to include human-readable text with the bar code. Valid values are Y and N. The default value is Y (include human-readable text).
- lineAbove: Whether or not to place the human-readable text above the bar code. Valid values are Y and N. The default value is N (if printed, text is placed below the bar code).
Example (common usage): ^B3,,50
Example (full usage): ^B3N,N,50,Y,N
^B4 orientation, heightMultiplier, line, mode
Configures the current field as a Code 49 bar code. Note that Code 49 is not recommended for use in new applications.
Parameters:
- orientation: The bar code orientation to use. Valid values are N (no rotation), R (rotate 90° clockwise), I (rotate 180° clockwise), and B (rotate 270° clockwise). The default value is the orientation configured via the ^FW command, which itself defaults to N (no rotation).
- heightMultiplier: The bar code row height multiplier. This number is multiplied by the module width specified in the ^BY command to determine the row height. Any number between 1 and the label height may be used. The default value is 1.
- line: The location of the human-readable text. Valid values are N (no human-readable text), A (above the bar code), and B (below the bar code). The default value is N (no human-readable text).
- mode: The encoding mode to use to encode the data. Valid values are 0 (regular alphanumeric mode), 1 (append mode), 2 (numeric mode), 3 (group alphanumeric mode), 4 (alphanumeric shift 1), 5 (alphanumeric shift 2), and A (automatic optimization). The default value is A (automatic optimization).
Example (common usage): ^B4,50
Example (full usage): ^B4N,50,N,A
^B5 orientation, height, line, lineAbove
Configures the current field as a USPS PLANET bar code. Note that USPS PLANET is not recommended for use in new applications.
Parameters:
- orientation: The bar code orientation to use. Valid values are N (no rotation), R (rotate 90° clockwise), I (rotate 180° clockwise), and B (rotate 270° clockwise). The default value is the orientation configured via the ^FW command, which itself defaults to N (no rotation).
- height: The bar code height, in dots. Any number between 1 and 9,999 may be used. The default value is the bar code height configured via the ^BY command, which itself defaults to 10.
- line: Whether or not to include human-readable text with the bar code. Valid values are Y and N. The default value is N (no human-readable text).
- lineAbove: Whether or not to place the human-readable text above the bar code. Valid values are Y and N. The default value is N (if printed, text is placed below the bar code).
Example (common usage): ^B5,50
Example (full usage): ^B5N,50,Y,N
^B7 orientation, rowHeight, security, columns, rows, truncate
Configures the current field as a PDF417 bar code.
Parameters:
- orientation: The bar code orientation to use. Valid values are N (no rotation), R (rotate 90° clockwise), I (rotate 180° clockwise), and B (rotate 270° clockwise). The default value is the orientation configured via the ^FW command, which itself defaults to N (no rotation).
- rowHeight: The bar code row height, in dots. Any number between 1 and the label height may be used. The default value is the row height necessary for the total bar code height to match the bar code height configured via the ^BY command.
- security: The level of error correction to apply. Any number between 0 and 8 may be used. The higher the number, the larger the generated bar code and the more resilient it is to scan errors. The default value is 0 (scan errors are detected but not corrected).
- columns: The number of data columns to encode. Any number between 1 and 30 may be used. This parameter can be used to control the bar code width. The default value depends on the amount of data encoded.
- rows: The number of rows to encode. Any number between 3 and 90 may be used. This parameter can be used to control the bar code height. The default value depends on the amount of data encoded.
- truncate: Whether or not to generate a truncated PDF417 bar code, also known as compact PDF417. Truncated PDF417 bar codes are narrower because they do not include right row indicators, but should only be used when label damage is unlikely. Valid values are Y and N. The default value is N (do not truncate).
Example (common usage): ^B7,5,,5
Example (full usage): ^B7N,5,4,5,,N
^B8 orientation, height, line, lineAbove
Configures the current field as an EAN-8 bar code.
Parameters:
- orientation: The bar code orientation to use. Valid values are N (no rotation), R (rotate 90° clockwise), I (rotate 180° clockwise), and B (rotate 270° clockwise). The default value is the orientation configured via the ^FW command, which itself defaults to N (no rotation).
- height: The bar code height, in dots. Any number between 1 and 32,000 may be used. The default value is the bar code height configured via the ^BY command, which itself defaults to 10.
- line: Whether or not to include human-readable text with the bar code. Valid values are Y and N. The default value is Y (include human-readable text).
- lineAbove: Whether or not to place the human-readable text above the bar code. Valid values are Y and N. The default value is N (if printed, text is placed below the bar code).
Example (common usage): ^B8,50
Example (full usage): ^B8N,50,Y,N
^B9 orientation, height, line, lineAbove, checkDigit
Configures the current field as a UPC-E bar code.
Parameters:
- orientation: The bar code orientation to use. Valid values are N (no rotation), R (rotate 90° clockwise), I (rotate 180° clockwise), and B (rotate 270° clockwise). The default value is the orientation configured via the ^FW command, which itself defaults to N (no rotation).
- height: The bar code height, in dots. Any number between 1 and 32,000 may be used. The default value is the bar code height configured via the ^BY command, which itself defaults to 10.
- line: Whether or not to include human-readable text with the bar code. Valid values are Y and N. The default value is Y (include human-readable text).
- lineAbove: Whether or not to place the human-readable text above the bar code. Valid values are Y and N. The default value is N (if printed, text is placed below the bar code).
- checkDigit: Whether or not to show the check digit in the human-readable text. Valid values are Y and N. The default value is Y (show check digit).
Example (common usage): ^B9,50
Example (full usage): ^B9N,50,Y,N,Y
^BA orientation, height, line, lineAbove, checkDigit
Configures the current field as a Code 93 bar code.
Parameters:
- orientation: The bar code orientation to use. Valid values are N (no rotation), R (rotate 90° clockwise), I (rotate 180° clockwise), and B (rotate 270° clockwise). The default value is the orientation configured via the ^FW command, which itself defaults to N (no rotation).
- height: The bar code height, in dots. Any number between 1 and 32,000 may be used. The default value is the bar code height configured via the ^BY command, which itself defaults to 10.
- line: Whether or not to include human-readable text with the bar code. Valid values are Y and N. The default value is Y (include human-readable text).
- lineAbove: Whether or not to place the human-readable text above the bar code. Valid values are Y and N. The default value is N (if printed, text is placed below the bar code).
- checkDigit: Whether or not to show the check digits in the human-readable text. Valid values are Y and N. The default value is N (check digits are not shown).
Example (common usage): ^BA,50
Example (full usage): ^BAN,50,Y,N,N
^BB orientation, height, checkDigit, columns, rows, mode
Configures the current field as a Codablock bar code. Note that Codablock is not recommended for use in new applications.
Parameters:
- orientation: The bar code orientation to use. Valid values are N (no rotation), R (rotate 90° clockwise), I (rotate 180° clockwise), and B (rotate 270° clockwise). The default value is the orientation configured via the ^FW command, which itself defaults to N (no rotation).
- height: The bar code row height, in dots. Any number between 2 and 32,000 may be used. The default value is 8.
- checkDigit: Whether or not to calculate check digits. Valid values are Y and N. The default value is Y (check digits are calculated). Can only be set to N if Codablock A is used.
- columns: The number of columns (characters) per row. Any number between 2 and 62 may be used.
- rows: The number of rows to generate. For Codablock A, any number between 1 and 22 may be used. For Codablock E and Codablock F, any number between 2 and 4 may be used.
- mode: The Codablock variant to use. Valid values are A (Codablock A), F (Codablock F) and E (Codablock E). The default value is F (Codablock F).
Example (common usage): ^BB,10
Example (full usage): ^BBN,10,Y,16,2,F
^BC orientation, height, line, lineAbove, checkDigit, mode
Configures the current field as a Code 128 bar code.
Parameters:
- orientation: The bar code orientation to use. Valid values are N (no rotation), R (rotate 90° clockwise), I (rotate 180° clockwise), and B (rotate 270° clockwise). The default value is the orientation configured via the ^FW command, which itself defaults to N (no rotation).
- height: The bar code height, in dots. Any number between 1 and 32,000 may be used. The default value is the bar code height configured via the ^BY command, which itself defaults to 10.
- line: Whether or not to include human-readable text with the bar code. Valid values are Y and N. The default value is Y (include human-readable text).
- lineAbove: Whether or not to place the human-readable text above the bar code. Valid values are Y and N. The default value is N (if printed, text is placed below the bar code), except for mode U where the default is Y (if printed, text is placed above the bar code).
- checkDigit: Whether or not to calculate a GS1 (UCC) Mod 10 check digit. Valid values are Y and N. The default value is N (GS1 check digit is not calculated).
- mode: The mode to use to encode the bar code data. Valid values are N (no mode, subsets are specified explicitly as part of the field data), U (UCC case mode, field data must contain 19 digits), A (automatic mode, the ZPL engine automatically determines the subsets that are used to encode the data), and D (UCC/EAN mode, field data must contain GS1 numbers). The default value is N (no mode, subsets are specified explicitly as part of the field data).
Example (common usage): ^BC,50
Example (full usage): ^BCN,50,Y,N,N,A
^BD mode, position, total
Configures the current field as a UPS MaxiCode bar code.
Parameters:
- mode: The mode to use to encode the bar code data. Valid values are 2 (numeric postal code), 3 (alphanumeric postal code), 4 (standard), 5 (full EEC), and 6 (reader programming). The default value is 2 (numeric postal code).
- position: If using structured append to split data across multiple bar codes, this parameter indicates the position of this bar code in the overall bar code sequence. The default value is 1 (assumes that structured append is not being used).
- total: If using structured append to split data across multiple bar codes, this parameter indicates the total number of bar codes which are in the bar code sequence. The default value is 1 (assumes that structured append is not being used).
Example (common usage): ^BD4
Example (full usage): ^BD4,1,1
^BE orientation, height, line, lineAbove
Configures the current field as an EAN-13 bar code.
Parameters:
- orientation: The bar code orientation to use. Valid values are N (no rotation), R (rotate 90° clockwise), I (rotate 180° clockwise), and B (rotate 270° clockwise). The default value is the orientation configured via the ^FW command, which itself defaults to N (no rotation).
- height: The bar code height, in dots. Any number between 1 and 32,000 may be used. The default value is the bar code height configured via the ^BY command, which itself defaults to 10.
- line: Whether or not to include human-readable text with the bar code. Valid values are Y and N. The default value is Y (include human-readable text).
- lineAbove: Whether or not to place the human-readable text above the bar code. Valid values are Y and N. The default value is N (if printed, text is placed below the bar code).
Example (common usage): ^BE,50
Example (full usage): ^BEN,50,Y,N
^BF orientation, rowHeight, mode
Configures the current field as a MicroPDF417 bar code.
Parameters:
- orientation: The bar code orientation to use. Valid values are N (no rotation), R (rotate 90° clockwise), I (rotate 180° clockwise), and B (rotate 270° clockwise). The default value is the orientation configured via the ^FW command, which itself defaults to N (no rotation).
- rowHeight: The bar code row height, in dots. Any number between 1 and 9,999 may be used. The default value is the row height necessary for the total bar code height to match the bar code height configured via the ^BY command.
- mode: The MicroPDF417 mode (or variant) to use. Any number between 0 and 33 may be used. Modes 0-5 use 1 data column, modes 6-12 use 2 data columns, modes 13-22 use 3 data columns, and modes 23-33 use 4 data columns. The default value is mode 0 (1 data column and 11 data rows).
Example (common usage): ^BF,5,7
Example (full usage): ^BFN,5,7
^BI orientation, height, line, lineAbove
Configures the current field as an Industrial 2 of 5 bar code. Note that Industrial 2 of 5 is not recommended for use in new applications.
Parameters:
- orientation: The bar code orientation to use. Valid values are N (no rotation), R (rotate 90° clockwise), I (rotate 180° clockwise), and B (rotate 270° clockwise). The default value is the orientation configured via the ^FW command, which itself defaults to N (no rotation).
- height: The bar code height, in dots. Any number between 1 and 32,000 may be used. The default value is the bar code height configured via the ^BY command, which itself defaults to 10.
- line: Whether or not to include human-readable text with the bar code. Valid values are Y and N. The default value is Y (include human-readable text).
- lineAbove: Whether or not to place the human-readable text above the bar code. Valid values are Y and N. The default value is N (if printed, text is placed below the bar code).
Example (common usage): ^BI,50
Example (full usage): ^BIN,50,Y,N
~BI x, y, magnification, image
Simulates colored label stock by drawing a color image on the label background. A ~BI command without any parameters clears any previously registered background images. This is a Labelary-specific ZPL extension.
Parameters:
- x: The image position x-coordinate, in dots. Any number between 0 and the label width may be used. The default value is 0.
- y: The image position y-coordinate, in dots. Any number between 0 and the label height may be used. The default value is 0.
- magnification: The magnification factor to apply when drawing the image. Any number between 0.1 and 10 may be used. The default value is 1.
- image: The image file to draw (usually a PNG file), encoded using the Base64 encoding scheme. There is no default value.
Example (common usage): ~BI50,50,1,iVBORw0KGg...
Example (full usage): ~BI50,50,1,iVBORw0KGg...
^BJ orientation, height, line, lineAbove
Configures the current field as a Standard 2 of 5 bar code. Note that Standard 2 of 5 is not recommended for use in new applications.
Parameters:
- orientation: The bar code orientation to use. Valid values are N (no rotation), R (rotate 90° clockwise), I (rotate 180° clockwise), and B (rotate 270° clockwise). The default value is the orientation configured via the ^FW command, which itself defaults to N (no rotation).
- height: The bar code height, in dots. Any number between 1 and 32,000 may be used. The default value is the bar code height configured via the ^BY command, which itself defaults to 10.
- line: Whether or not to include human-readable text with the bar code. Valid values are Y and N. The default value is Y (include human-readable text).
- lineAbove: Whether or not to place the human-readable text above the bar code. Valid values are Y and N. The default value is N (if printed, text is placed below the bar code).
Example (common usage): ^BJ,50
Example (full usage): ^BJN,50,Y,N
^BK orientation, checkDigit, height, line, lineAbove, startChar, stopChar
Configures the current field as an ANSI Codabar bar code. Note that Codabar is not recommended for use in new applications.
Parameters:
- orientation: The bar code orientation to use. Valid values are N (no rotation), R (rotate 90° clockwise), I (rotate 180° clockwise), and B (rotate 270° clockwise). The default value is the orientation configured via the ^FW command, which itself defaults to N (no rotation).
- checkDigit: Whether or not to add a check digit. This parameter is only available for backward compatibility purposes and can only be set to N (no check digit).
- height: The bar code height, in dots. Any number between 1 and 32,000 may be used. The default value is the bar code height configured via the ^BY command, which itself defaults to 10.
- line: Whether or not to include human-readable text with the bar code. Valid values are Y and N. The default value is Y (include human-readable text).
- lineAbove: Whether or not to place the human-readable text above the bar code. Valid values are Y and N. The default value is N (if printed, text is placed below the bar code).
- startChar: The Codabar start character to use. Valid values are A, B, C and D. The default value is A.
- stopChar: The Codabar stop character to use. Valid values are A, B, C and D. The default value is A.
Example (common usage): ^BK,,50,,,C,D
Example (full usage): ^BKN,N,50,Y,N,C,D
^BL orientation, height, lineAbove
Configures the current field as a LOGMARS bar code. Note that LOGMARS is not recommended for use in new applications, with the possible exception of some US Department of Defense systems.
Parameters:
- orientation: The bar code orientation to use. Valid values are N (no rotation), R (rotate 90° clockwise), I (rotate 180° clockwise), and B (rotate 270° clockwise). The default value is the orientation configured via the ^FW command, which itself defaults to N (no rotation).
- height: The bar code height, in dots. Any number between 1 and 32,000 may be used. The default value is the bar code height configured via the ^BY command, which itself defaults to 10.
- lineAbove: Whether or not to place the human-readable text above the bar code. Valid values are Y and N. The default value is N (text is placed below the bar code).
Example (common usage): ^BL,50
Example (full usage): ^BLN,50,N
^BM orientation, checkDigitType, height, line, lineAbove, checkDigit
Configures the current field as a MSI bar code. Note that MSI is not recommended for use in new applications.
Parameters:
- orientation: The bar code orientation to use. Valid values are N (no rotation), R (rotate 90° clockwise), I (rotate 180° clockwise), and B (rotate 270° clockwise). The default value is the orientation configured via the ^FW command, which itself defaults to N (no rotation).
- checkDigitType: The type of check digit to use. Valid values are A (no check digit), B (Mod 10), C (Mod 1010) and D (Mod 1110). The default value is B (Mod 10).
- height: The bar code height, in dots. Any number between 1 and 32,000 may be used. The default value is the bar code height configured via the ^BY command, which itself defaults to 10.
- line: Whether or not to include human-readable text with the bar code. Valid values are Y and N. The default value is Y (include human-readable text).
- lineAbove: Whether or not to place the human-readable text above the bar code. Valid values are Y and N. The default value is N (if printed, text is placed below the bar code).
- checkDigit: Whether or not to show the check digit in the human-readable text. Valid values are Y and N. The default value is N (do not show check digit).
Example (common usage): ^BM,,60
Example (full usage): ^BMN,B,60,Y,N,N
^BO orientation, magnification, eci, size, readerInit, symbols, id
Configures the current field as an Aztec bar code.
Parameters:
- orientation: The bar code orientation to use. Valid values are N (no rotation), R (rotate 90° clockwise), I (rotate 180° clockwise), and B (rotate 270° clockwise). The default value is the orientation configured via the ^FW command, which itself defaults to N (no rotation).
- magnification: The bar code magnification to use. Any number between 1 and 10 may be used. The default value depends on the print density being used.
- eci: Whether or not the bar code data uses ECI (extended channel interpretation) to switch character sets. Valid values are Y and N. The default value is N (no ECI).
- size: The Aztec bar code size to use. Valid values are 101-104 (compact Aztec code sizes), 201-232 (full-range Aztec code sizes), 300 (Aztec runes), and 1-99 (dynamic sizing for a specific minimum error correction percentage). By default, the bar code is sized dynamically to fit the encoded data.
- readerInit: Whether or not the bar code is a reader initialization bar code. Valid values are Y and N. The default value is N (no reader initialization).
- symbols: If using structured append to split data across multiple bar codes, this parameter indicates the total number of bar codes being used. Any number between 1 and 26 may be used. The default value is 1, indicating that structured append is not being used.
- id: If using structured append to split data across multiple bar codes, this parameter indicates the message ID, which is used to correlate linked bar codes and reduce the likelihood of scanning issues. By default, no message ID is used.
Example (common usage): ^BO,3,,210
Example (full usage): ^BON,3,N,210,N,3,777
^BP orientation, checkDigit, height, line, lineAbove
Configures the current field as a Plessey bar code. Note that Plessey is not recommended for use in new applications.
Parameters:
- orientation: The bar code orientation to use. Valid values are N (no rotation), R (rotate 90° clockwise), I (rotate 180° clockwise), and B (rotate 270° clockwise). The default value is the orientation configured via the ^FW command, which itself defaults to N (no rotation).
- checkDigit: Whether or not to show the check digit in the human-readable text. Valid values are Y and N. The default value is N (do not show check digit).
- height: The bar code height, in dots. Any number between 1 and 32,000 may be used. The default value is the bar code height configured via the ^BY command, which itself defaults to 10.
- line: Whether or not to include human-readable text with the bar code. Valid values are Y and N. The default value is Y (include human-readable text).
- lineAbove: Whether or not to place the human-readable text above the bar code. Valid values are Y and N. The default value is N (if printed, text is placed below the bar code).
Example (common usage): ^BP,,50
Example (full usage): ^BPN,N,50,Y,N
^BQ orientation, model, magnification, errorCorrection, mask
Configures the current field as a QR Code bar code. Note that the data string in the corresponding ^FD command is expected to start with a bar code configuration prefix. For example, "^FDQA,12345" sets the error correction level to Q (high reliability), selects input mode A (automated encode mode switching) and encodes the data "12345" in the bar code.
Parameters:
- orientation: The bar code orientation to use. This parameter is only available for backward compatibility purposes and can only be set to N (no rotation).
- model: The QR Code model to use. Valid values are 1 (original) and 2 (enhanced). The default value is model 2 (enhanced). Always use model 2.
- magnification: The bar code magnification to use. Any number between 1 and 100 may be used. The default value depends on the print density being used.
- errorCorrection: The level of error correction to apply. Valid values are H (highest reliability), Q (high reliability), M (medium reliability), and L (lower reliability). The default value is Q (high reliability).
- mask: The mask pattern to apply to the bar code. Any number between 0 and 7 may be used. The default value is 7.
Example (common usage): ^BQ,,5
Example (full usage): ^BQN,2,5,Q,7
^BR orientation, type, magnification, sepHeight, height, segWidth
Configures the current field as a GS1 DataBar (RSS) bar code.
Parameters:
- orientation: The bar code orientation to use. Valid values are N (no rotation), R (rotate 90° clockwise), I (rotate 180° clockwise), and B (rotate 270° clockwise). The default value is the orientation configured via the ^FW command, which itself defaults to N (no rotation).
- type: The type of GS1 DataBar bar code to generate. Valid values are 1 (GS1 DataBar Omnidirectional), 2 (GS1 DataBar Truncated), 3 (GS1 DataBar Stacked), 4 (GS1 DataBar Stacked Omnidirectional), 5 (GS1 DataBar Limited), 6 (GS1 DataBar Expanded), 7 (UPC-A), 8 (UPC-E), 9 (EAN-13), 10 (EAN-8), 11 (GS1-128 + CC-A/CC-B) and 12 (GS1-128 + CC-C). The default value is 1 (GS1 DataBar Omnidirectional).
- magnification: The bar code magnification to use. Any number between 1 and 10 may be used. The default value depends on the print density being used.
- sepHeight: The height of the separator between the linear component and the 2D component. May be 1 or 2. The default value is 1.
- height: The bar code height of the linear component, in dots. Any number between 1 and 32,000 may be used. The default value is 25.
- segWidth: The segment width, for GS1 DataBar Expanded Stacked Omnidirectional bar codes (a type 6 variant). Any number between 2 and 20 may be used. There is no default value.
Example (common usage): ^BR,1
Example (full usage): ^BRN,1,4,1,40,20
~BR x, y, width, height, r, g, b
Simulates colored label stock by drawing a colored rectangle on the label background. A ~BR command without any parameters clears any previously registered background rectangles. This is a Labelary-specific ZPL extension.
Parameters:
- x: The rectangle position x-coordinate, in dots. Any number between 0 and the label width may be used. The default value is 0.
- y: The rectangle position y-coordinate, in dots. Any number between 0 and the label height may be used. The default value is 0.
- width: The width of the rectangle, in dots. Any number between 1 and the label width may be used. The default value is 1.
- height: The height of the rectangle, in dots. Any number between 1 and the label height may be used. The default value is 1.
- r: The R (red) component of the rectangle color. Any number between 0 and 255 may be used. The default value is 0.
- g: The G (green) component of the rectangle color. Any number between 0 and 255 may be used. The default value is 0.
- b: The B (blue) component of the rectangle color. Any number between 0 and 255 may be used. The default value is 0.
Example (common usage): ~BR50,50,300,200,252,252,121
Example (full usage): ~BR50,50,300,200,252,252,121
^BS orientation, height, line, lineAbove
Configures the current field as a UPC/EAN extension.
Parameters:
- orientation: The bar code orientation to use. Valid values are N (no rotation), R (rotate 90° clockwise), I (rotate 180° clockwise), and B (rotate 270° clockwise). The default value is the orientation configured via the ^FW command, which itself defaults to N (no rotation).
- height: The bar code height, in dots. Any number between 1 and 32,000 may be used. The default value is the bar code height configured via the ^BY command, which itself defaults to 10.
- line: Whether or not to include human-readable text with the bar code. Valid values are Y and N. The default value is Y (include human-readable text).
- lineAbove: Whether or not to place the human-readable text above the bar code. Valid values are Y and N. The default value is Y (if printed, text is placed above the bar code).
Example (common usage): ^BS,50
Example (full usage): ^BSN,50,Y,Y
^BT orientation, width, widthRatio, height, pdfWidth, pdfHeight
Configures the current field as a TLC 39 bar code. Note that TLC 39 is not recommended for use in new applications.
Parameters:
- orientation: The bar code orientation to use. Valid values are N (no rotation), R (rotate 90° clockwise), I (rotate 180° clockwise), and B (rotate 270° clockwise). The default value is the orientation configured via the ^FW command, which itself defaults to N (no rotation).
- width: The Code 39 module width, in dots. Any number between 1 and 10 may be used. The default value depends on the print density of the printer.
- widthRatio: The Code 39 ratio between wide bars and narrow bars. Any decimal number between 2 and 3 may be used. The number must be a multiple of 0.1 (i.e. 2.0, 2.1, 2.2, 2.3, ... , 2.9, 3.0). The default value is 2.
- height: The Code 39 bar code height, in dots. Any number between 1 and 9,999 may be used. The default value depends on the print density of the printer.
- pdfWidth: The MicroPDF417 module width, in dots. Any number between 1 and 10 may be used. The default value depends on the print density of the printer.
- pdfHeight: The MicroPDF417 row height, in dots. Any number between 1 and 255 may be used. The default value depends on the print density of the printer.
Example (common usage): ^BT
Example (full usage): ^BTN,3,2,70,3,6
^BU orientation, height, line, lineAbove, checkDigit
Configures the current field as a UPC-A bar code.
Parameters:
- orientation: The bar code orientation to use. Valid values are N (no rotation), R (rotate 90° clockwise), I (rotate 180° clockwise), and B (rotate 270° clockwise). The default value is the orientation configured via the ^FW command, which itself defaults to N (no rotation).
- height: The bar code height, in dots. Any number between 1 and 9,999 may be used. The default value is the bar code height configured via the ^BY command, which itself defaults to 10.
- line: Whether or not to include human-readable text with the bar code. Valid values are Y and N. The default value is Y (include human-readable text).
- lineAbove: Whether or not to place the human-readable text above the bar code. Valid values are Y and N. The default value is N (if printed, text is placed below the bar code).
- checkDigit: Whether or not to show the check digit in the human-readable text. Valid values are Y and N. The default value is Y (show check digit).
Example (common usage): ^BU,50
Example (full usage): ^BUN,50,Y,N,Y
^BX orientation, height, quality, columns, rows, format, escape, ratio
Configures the current field as a Data Matrix bar code.
Parameters:
- orientation: The bar code orientation to use. Valid values are N (no rotation), R (rotate 90° clockwise), I (rotate 180° clockwise), and B (rotate 270° clockwise). The default value is the orientation configured via the ^FW command, which itself defaults to N (no rotation).
- height: The bar code element height, in dots. The individual elements are square, so the element height and width will be the same. Any number between 1 and the label width may be used. The default value is the element height necessary for the total bar code height to match the bar code height configured via the ^BY command.
- quality: The level of error correction to apply. Valid values are 0 (ECC 0), 50 (ECC 50), 80 (ECC 80), 100 (ECC 100), 140 (ECC 140) and 200 (ECC 200). The default value is 0 (scan errors are detected but not corrected). Always use quality level 200 (ECC 200).
- columns: The number of columns to encode. For ECC 200 bar codes, even numbers between 1 and 144 may be used. This parameter can be used to control the bar code width. The default value depends on the amount of data encoded.
- rows: The number of rows to encode. For ECC 200 bar codes, even numbers between 1 and 144 may be used. This parameter can be used to control the bar code height. The default value depends on the amount of data encoded.
- format: The type of data that needs to be encoded. Valid values are 1, 2, 3, 4, 5 and 6. The default value is 6. This parameter is ignored for ECC 200 bar codes (the recommended quality level).
- escape: The escape character used to escape control sequences in the field data. The default value is "~" (tilde).
- ratio: The desired aspect ratio, if any. Valid values are 1 (square) and 2 (rectangular).
Example (common usage): ^BX,5,200
Example (full usage): ^BXN,5,200,22,22,,~,1
^BY width, widthRatio, height
Configures the global bar code defaults.
Parameters:
- width: The default bar code module width, in dots. Any number between 1 and 100 may be used. The default value is the previously configured value, or 2 if no value has been set.
- widthRatio: The default ratio between wide bars and narrow bars. Any decimal number between 2 and 3 may be used. The number must be a multiple of 0.1 (i.e. 2.0, 2.1, 2.2, 2.3, ... , 2.9, 3.0). Larger numbers generally result in fewer bar code scan failures. The default value is the previously configured value, or 3 if no value has been set.
- height: The default bar code height, in dots. Any positive number may be used. The default value is the previously configured value, or 10 if no value has been set.
Example (common usage): ^BY2,3,10
Example (full usage): ^BY2,3,10
^BZ orientation, height, line, lineAbove, type
Configures the current field as a USPS postal bar code. Note that USPS POSTNET and USPS PLANET are not recommended for use in new applications.
Parameters:
- orientation: The bar code orientation to use. Valid values are N (no rotation), R (rotate 90° clockwise), I (rotate 180° clockwise), and B (rotate 270° clockwise). The default value is the orientation configured via the ^FW command, which itself defaults to N (no rotation).
- height: The bar code height, in dots. Any number between 1 and 32,000 may be used. The default value is the bar code height configured via the ^BY command, which itself defaults to 10.
- line: Whether or not to include human-readable text with the bar code. Valid values are Y and N. The default value is N (do not include human-readable text).
- lineAbove: Whether or not to place the human-readable text above the bar code. Valid values are Y and N. The default value is N (if printed, text is placed below the bar code).
- type: The type of postal bar code to generate. Valid values are 0 (POSTNET bar code), 1 (PLANET bar code) and 3 (USPS Intelligent Mail bar code).
Example (common usage): ^BZ,50,,,3
Example (full usage): ^BZN,50,N,N,3
^CC caret
Changes the caret character, which is used to start most commands.
Parameters:
- caret: The new caret character. Any ASCII character may be used. The default value is '^' (caret).
Example (common usage): ^CC+
Example (full usage): ^CC+
~CC caret
Changes the caret character, which is used to start most commands.
Parameters:
- caret: The new caret character. Any ASCII character may be used. The default value is '^' (caret).
Example (common usage): ~CC+
Example (full usage): ~CC+
^CD delim
Changes the parameter delimiter character.
Parameters:
- delim: The new parameter delimiter. Any ASCII character may be used. The default value is ',' (comma).
Example (common usage): ^CD;
Example (full usage): ^CD;
~CD delim
Changes the parameter delimiter character.
Parameters:
- delim: The new parameter delimiter. Any ASCII character may be used. The default value is ',' (comma).
Example (common usage): ~CD;
Example (full usage): ~CD;
^CF fontName, height, width
Sets the default font. The default font is used by all subsequent text fields which do not specify a font using the ^A or ^A@ commands.
Parameters:
- fontName: The name of the new default font. Font names are either a capital letter (A-Z) or a number (0-9). The default value is the previously configured value, or A if no value has been set.
- height: The height of the new default font, in dots. The default value depends on the font selected.
- width: The width of the new default font, in dots. The default value depends on the font selected.
Example (common usage): ^CF0,50
Example (full usage): ^CF0,50,50
^CI charset, customMappings
Sets the current character set.
Parameters:
- charset: The character set to use. Any number between 0 and 36 may be used. The default value is 0 (Code Page 850). It is recommended that you always use value 28 (UTF-8).
- customMappings: Optional custom character mappings, specified as pairs of integers. Any numbers between 0 and 255 may be used. This parameter only affects Code Page 850 variants (charset values 0 - 13).
Example (common usage): ^CI28
Example (full usage): ^CI0,34,67,89,61,129,232
^CM bAlias, eAlias, rAlias, aAlias, multiple
Changes the memory device letter designations.
Parameters:
- bAlias: The new alias for the B: device. Valid values are B, E, R and A. The default value is B.
- eAlias: The new alias for the E: device. Valid values are B, E, R and A. The default value is E.
- rAlias: The new alias for the R: device. Valid values are B, E, R and A. The default value is R.
- aAlias: The new alias for the A: device. Valid values are B, E, R and A. The default value is A.
- multiple: Flag which, when set to the value M, allows E to be mapped to more than one device.
Example (common usage): ^CMB,E,A,R
Example (full usage): ^CMA,R,E,B,M
^CN override
Cycles the media cutter when in kiosk mode.
Parameters:
- override: Whether to use the default kiosk cut amount (from the ^KV command), or perform a full cut. Valid values are 0 (use the default cut amount) and 1 (perform a full cut). There is no default value.
Example (common usage): ^CN1
Example (full usage): ^CN1
^CO on, kilobytes, type
Configures the glyph cache, which is used internally to improve print speed when the same scalable font glyphs are used repeatedly. Note that this command is not needed in new applications, because printers manage the glyph cache automatically.
Parameters:
- on: Whether or not the glyph cache is enabled. Valid values are Y (cache on) and N (cache off). The default value is Y (cache on).
- kilobytes: The amount of extra memory to allocate to the glyph cache, in kilobytes. Any number between 1 and 9,999 may be used. The default value is 40 kilobytes.
- type: The type of glyph cache being configured. Valid values are 0 (external cache for regular fonts) and 1 (internal cache for Asian fonts).
Example (common usage): ^COY,100
Example (full usage): ^COY,100,0
^CP mode
Removes a printed label from the presenter area.
Parameters:
- mode: The label removal mode. Valid values are 0 (eject label), 1 (retract label), and 2 (use the mode specified via the ^KV command). There is no default value.
Example (common usage): ^CP0
Example (full usage): ^CP0
^CT tilde
Changes the tilde character, which is used to start control commands.
Parameters:
- tilde: The new tilde character. Any ASCII character may be used. The default value is '~' (tilde).
Example (common usage): ^CT+
Example (full usage): ^CT+
~CT tilde
Changes the tilde character, which is used to start control commands.
Parameters:
- tilde: The new tilde character. Any ASCII character may be used. The default value is '~' (tilde).
Example (common usage): ~CT+
Example (full usage): ~CT+
^CV validate
Configures bar code data validation. By default ZPL is very lenient about bar code data errors, but this command can be used to enable stricter checks.
Parameters:
- validate: Whether or not to more strictly validate bar code data. Valid values are Y and N. The default value is N (no strict validation).
Example (common usage): ^CVY
Example (full usage): ^CVY
^CW fontName, path
Configures a font name alias, so that a particular font file can later be used by font name via the ^A and ^CF commands.
Parameters:
- fontName: The font name to use for the specified font file. Font names are either a capital letter (A-Z) or a number (0-9). If no value is specified, the command is ignored.
- path: The font file path that the specified font name should alias to. Any valid font path may be used. If the specified font file does not exist, the command is ignored.
Example (common usage): ^CWK,R:ARIAL.TTF
Example (full usage): ^CWK,R:ARIAL.TTF
~DB path, x, height, width, ascent, space, glyphs, copyright, data
Uploads an embedded bitmap font, storing it at the specified file path. Note that bitmap fonts are not recommended for use in new applications.
Parameters:
- path: The file path to save the bitmap font to. The default value is R:UNKNOWN.FNT.
- x: An ignored parameter.
- height: The maximum glyph height, in dots. Any number between 1 and 32,000 may be used. There is no default value.
- width: The maximum glyph width, in dots. Any number between 1 and 32,000 may be used. There is no default value.
- ascent: The maximum glyph ascent, in dots. Any number between 1 and 32,000 may be used. There is no default value.
- space: The space character width, in dots. Any number between 1 and 32,000 may be used. There is no default value.
- glyphs: The number of glyphs in the font. Any number between 1 and 256 may be used. There is no default value.
- copyright: The font copyright holder. The maximum length is 63 characters. There is no default value.
- data: The font glyph data, as a series of (character code + height + width + x-offset + y-offset + advance + bitmap data) sequences. There is no default value.
Example (common usage): ~DBR:X.FNT,,10,8,7,8,47,BOB,#0044.9.7.2.6.3.00FF...
Example (full usage): ~DBR:X.FNT,,10,8,7,8,47,BOB,#0044.9.7.2.6.3.00FF...
~DE path, size, data
Uploads a custom encoding table, storing it at the specified file path. Note that custom encoding tables are not recommended for use in new applications.
Parameters:
- path: The file path to save the encoding table to. The default value is R:UNKNOWN.DAT.
- size: The size of the encoding table, in bytes. There is no default value.
- data: The encoding table data, as a string of hexadecimal values. There is no default value.
Example (common usage): ~DER:TABLE.DAT,1024,A798FE02...
Example (full usage): ~DER:TABLE.DAT,1024,A798FE02...
^DF path
Saves the remainder of the label definition to a file for later use via ^XF.
Parameters:
- path: The file path to save the label definition to. The ^XF command can later be used to load the label definition from this path. The default value is R:UNKNOWN.ZPL.
Example (common usage): ^DFR:LABEL.ZPL
Example (full usage): ^DFR:LABEL.ZPL
~DG path, totalBytes, rowBytes, data
Uploads an embedded image, storing it at the specified file path.
Parameters:
- path: The file path to save the image to. The ^XG command can later be used to load the image from this path. The default value is R:UNKNOWN.GRF.
- totalBytes: The total number of bytes in the image. Because each pixel in the image uses 1 bit, this value should be the total number of pixels in the image, divided by 8 (since there are 8 bits per byte). There is no default value.
- rowBytes: The number of bytes per pixel row in the image. Because each pixel in the image uses 1 bit, this value should be the pixel width of the image, divided by 8 (since there are 8 bits per byte). The default value is 1, which is almost always incorrect.
- data: The image data, in hexadecimal format. There is no default value.
Example (common usage): ~DGR:IMAGE.GRF,999000,999,ABCDEF01234...
Example (full usage): ~DGR:IMAGE.GRF,999000,999,ABCDEF01234...
~DN
Aborts an image upload (~DG) command.
Example (common usage): ~DN
Example (full usage): ~DN
~DS path, size, data
Uploads an embedded scalable font, storing it at the specified file path. Note that most modern fonts should be uploaded using the ~DU command, rather than the ~DS command.
Parameters:
- path: The file path to save the font to. The default value is R:UNKNOWN.FNT.
- size: The total number of bytes in the font file. There is no default value.
- data: The font data, in hexadecimal format. There is no default value.
Example (common usage): ~DSR:FONT.FNT,999000,ABCDEF01234...
Example (full usage): ~DSR:FONT.FNT,999000,ABCDEF01234...
~DT path, size, data
Uploads an embedded TrueType font, storing it at the specified file path. Note that most modern fonts should be uploaded using the ~DU command, rather than the ~DT command.
Parameters:
- path: The file path to save the font to. The default value is R:UNKNOWN.FNT.
- size: The total number of bytes in the font file. There is no default value.
- data: The font data, in hexadecimal format. There is no default value.
Example (common usage): ~DTR:FONT.FNT,999000,ABCDEF01234...
Example (full usage): ~DTR:FONT.FNT,999000,ABCDEF01234...
~DU path, size, data
Uploads an embedded TrueType font, storing it at the specified file path.
Parameters:
- path: The file path to save the font to. The default value is R:UNKNOWN.FNT.
- size: The total number of bytes in the font file. There is no default value.
- data: The font data, in hexadecimal format. There is no default value.
Example (common usage): ~DUR:FONT.TTF,999000,ABCDEF01234...
Example (full usage): ~DUR:FONT.TTF,999000,ABCDEF01234...
~DY path, format, extension, totalBytes, rowBytes, data
Uploads an embedded file, storing it at the specified file path. This command is most commonly used to upload images and fonts, although other file types can be uploaded as well. Because of the variety of supported file types, this command is fairly complex. It is recommended that the ~DU command be used instead when uploading fonts, and that the ~DG command be used instead when uploading images.
Parameters:
- path: The file path to save the file to. The file extension should be omitted, since it is determined based on the third (extension) parameter. The default value is R:UNKNOWN.
- format: The format of the data contained in the sixth parameter. Valid values are A (hexadecimal format), B (raw binary format), C (AR compressed), and P (hexadecimal format PNG data). There is no default value.
- extension: The file type to expect and the file name extension to use. There are many possible values, but some of the most common are G (GRF file), T (TTF file), and P (PNG file). The default value is G (GRF file).
- totalBytes: The total number of bytes in the file. There is no default value.
- rowBytes: The number of bytes per pixel row in the image, if the file is an image. This parameter is ignored if the extension parameter is not G (the file is not a GRF file). There is no default value.
- data: The file data, in the format specified in the second parameter. There is no default value.
Example (common usage): ~DYR:IMAGE,A,G,999000,999,ABCDEF01234...
Example (full usage): ~DYR:IMAGE,A,G,999000,999,ABCDEF01234...
^EG
Erases all GRF image files from all writeable devices. Note that the ^ID command should be used instead, if possible.
Example (common usage): ^EG
Example (full usage): ^EG
~EG
Erases all GRF image files from all writeable devices. Note that the ^ID command should be used instead, if possible.
Example (common usage): ~EG
Example (full usage): ~EG
^FB maxWidth, maxLines, lineSpacing, alignment, hangingIndent
Formats the current field as a text block which wraps text across multiple lines.
Parameters:
- maxWidth: The maximum text block width, in dots. Text longer than this width is wrapped to another line. Any number between 0 and 9,999 may be used. The default value is 0, which is rarely useful.
- maxLines: The maximum number of text lines to allow. If the text does not fit on the specified number of lines, any remaining text is drawn over the previous text on the last line. Any number between 1 and 9,999 may be used. The default value is 1.
- lineSpacing: Extra spacing to add between lines, in dots. Positive numbers increase the distance between lines, negative numbers decrease the distance between lines. Any number between -9,999 and 9,999 may be used. The default value is 0.
- alignment: The text alignment to apply to the text block. Valid values are L (left), R (right), C (center) and J (justified). The default value is L (left).
- hangingIndent: The hanging indent to apply to all lines except the first line, in dots. Any number between 0 and 9,999 may be used. The default value is 0.
Example (common usage): ^FB500,5
Example (full usage): ^FB500,5,0,L,0
^FC indicator1, indicator2, indicator3
Configures the clock value escape character(s), allowing the current field to embed dynamic time values in the field data. Note that this command requires that the printer or print engine have access to real-time clock hardware, which not all physical printers include.
Parameters:
- indicator1: The escape character to use for primary clock time values. Any ASCII character may be used. The default value is '%' (percent).
- indicator2: The escape character to use for secondary clock time values. Any ASCII character may be used, except for the values used for the other two parameters. There is no default value.
- indicator3: The escape character to use for tertiary clock time values. Any ASCII character may be used, except for the values used for the other two parameters. There is no default value.
Example (common usage): ^FC%
Example (full usage): ^FC%,&,+
^FD data
Sets the current field's data string. This data is usually printed to the label as text or encoded as a bar code, depending on the field type.
Parameters:
- data: The data string. There is no default value.
Example (common usage): ^FDhello world
Example (full usage): ^FDhello world
^FE embedChar
Configures the field data embed character, which allows the current field to embed field data from other fields which are numbered using the ^FN command. For example, if the embed character is set to #, then the text #3# can be used as a placeholder for the field data from field number 3, or the text #2,F,1,5# can be used as a placeholder for the first 5 characters of the field data from field 2, or the text #4,B,3,3# can be used as a placeholder for the last 3 characters of the field data from field 4.
Parameters:
- embedChar: The field data embed character. Any ASCII character may be used, except the ZPL command and parameter delimiters.
Example (common usage): ^FE#
Example (full usage): ^FE#
^FH hexIndicator
Configures the hexadecimal escape character, allowing the current field to embed character codes in the field data. This can be particularly useful when field data values may contain characters which would otherwise be interpreted as ZPL command or parameter delimiters.
Parameters:
- hexIndicator: The hexadecimal escape character. Any ASCII character may be used, except the lowercase letters a-z and the ZPL command and parameter delimiters. The default value is "_" (underscore).
Example (common usage): ^FH_
Example (full usage): ^FH_
^FL extensionPath, basePath, link
Links (or unlinks) one font to another, allowing the font engine to fall back from one font to another when a font is missing the glyph needed to render a character.
Parameters:
- extensionPath: The extension font file path. The font engine will fall back to this font if it encounters a missing glyph in the base font. There is no default value.
- basePath: The base font file path. If the font engine encounters a missing glyph in this font, it will fall back to the extension font. There is no default value.
- link: Whether to link or unlink the fonts. Valid values are 0 (unlink) and 1 (link). The default value is 0 (unlink).
Example (common usage): ^FLR:NOTOCJK.TTF,R:NOTO.TTF,1
Example (full usage): ^FLR:NOTOCJK.TTF,R:NOTO.TTF,1
^FM positions
When used in conjunction with ^B7 or ^BF, this command configures multiple bar code positions for the current field, allowing the field data to be split across multiple bar codes using structured append.
Parameters:
- positions: Bar code positions, in dots, specified as pairs of integers (x and y values). Any numbers between 0 and 32,000 may be used. There are no default values.
Example (common usage): ^FM50,50,250,50,450,50,...
Example (full usage): ^FM50,50,250,50,450,50,...
^FN fieldNumber
Sets the current field's field number. When using the ^DF command to save label definitions for later use, the ^FN command is used to define the field numbers available for later reference. When using the ^XF command to load previously saved label definitions, the ^FN command is used to reference the field numbers previously defined.
Parameters:
- fieldNumber: The current field's field number. Any number between 0 and 9,999 may be used. The default value is 0.
Example (common usage): ^FN1
Example (full usage): ^FN1
^FO x, y, alignment
Sets the position of the top left corner of the current field.
Parameters:
- x: The field position x-coordinate, in dots. Any number between 0 and 32,000 may be used. The default value is 0.
- y: The field position y-coordinate, in dots. Any number between 0 and 32,000 may be used. The default value is 0.
- alignment: The origin alignment to use. Valid values are 0 (left alignment), 1 (right alignment), and 2 (automatic alignment based on the direction of the field data text). The default value is the value previously configured via the ^FW command, if any.
Example (common usage): ^FO50,50
Example (full usage): ^FO50,50,0
^FP direction, characterSpacing
Configures the current field's print direction.
Parameters:
- direction: The print direction. Valid values are H (horizontal / left to right), V (vertical / top to bottom), and R (reverse / right to left). The default value is H (horizontal / left to right).
- characterSpacing: Extra spacing to add between characters, in dots. Positive numbers increase the distance between characters, negative numbers decrease the distance between characters. Any number between -10 and 9,999 may be used. The default value is 0.
Example (common usage): ^FPV
Example (full usage): ^FPV,10
^FR
Configures the current field to reverse the background color, drawing black over white and white over black. This is also known as XOR mode drawing.
Example (common usage): ^FR
Example (full usage): ^FR
^FS
Ends the current field and starts the next field.
Example (common usage): ^FS
Example (full usage): ^FS
^FT x, y, alignment
Sets the position of the bottom left corner of the current field.
Parameters:
- x: The field position x-coordinate, in dots. Any number between 0 and 32,000 may be used. The default value is the right edge of the previous field.
- y: The field position y-coordinate, in dots. Any number between 0 and 32,000 may be used. The default value is the bottom edge of the previous field.
- alignment: The origin alignment to use. Valid values are 0 (left alignment), 1 (right alignment), and 2 (automatic alignment based on the direction of the field data text). The default value is the value previously configured via the ^FW command, if any.
Example (common usage): ^FT50,50
Example (full usage): ^FT50,50,0
^FV data
Sets the current field's data string. This command is an alternative to the ^FD command, and allows the use of variable data when the ^MC command is used to retain rendered content across multiple labels.
Parameters:
- data: The data string. There is no default value.
Example (common usage): ^FVhello world
Example (full usage): ^FVhello world
^FW orientation, alignment
Sets the default field orientation and alignment.
Parameters:
- orientation: The default field orientation. Valid values are N (no rotation), R (rotate 90° clockwise), I (rotate 180° clockwise), and B (rotate 270° clockwise). The default value is N (no rotation).
- alignment: The default field origin alignment. Valid values are 0 (left alignment), 1 (right alignment), and 2 (automatic alignment based on the direction of the field data text). The default value is 0 (left alignment).
Example (common usage): ^FWR
Example (full usage): ^FWR,0
^FX comment
Adds a comment to the ZPL code. Comments do not affect the rendering of the label, and can be used to document assumptions, concepts or questions.
Parameters:
- comment: The informational comment.
Example (common usage): ^FXthis is my comment
Example (full usage): ^FXthis is my comment
^GB width, height, thickness, color, rounding
Configures the current field as a graphical box.
Parameters:
- width: The width of the box, in dots. Any number between the box line thickness and 32,000 may be used. The default value is the box line thickness.
- height: The height of the box, in dots. Any number between the box line thickness and 32,000 may be used. The default value is the box line thickness.
- thickness: The line thickness to use to draw the box, in dots. Any number between 1 and 32,000 may be used. The default value is 1.
- color: The line color to use to draw the box. Valid values are B (black) and W (white). The default value is B (black).
- rounding: The amount of rounding to apply to the box corners. Any number between 0 (no rounding) and 8 (maximum rounding) may be used. The default value is 0 (no rounding).
Example (common usage): ^GB100,50,3
Example (full usage): ^GB100,50,3,B,0
^GC diameter, thickness, color
Configures the current field as a graphical circle.
Parameters:
- diameter: The diameter of the circle, in dots. Any number between 3 and 4,095 may be used. The default value is 3.
- thickness: The line thickness to use to draw the circle, in dots. Any number between 1 and 4,095 may be used. The default value is 1.
- color: The line color to use to draw the circle. Valid values are B (black) and W (white). The default value is B (black).
Example (common usage): ^GC100,3
Example (full usage): ^GC100,3,B
^GD width, height, thickness, color, orientation
Configures the current field as a graphical diagonal line.
Parameters:
- width: The width of the rectangle which defines the diagonal line, in dots. Any number between 3 and 32,000 may be used. The default value is the line thickness.
- height: The height of the rectangle which defines the diagonal line, in dots. Any number between 3 and 32,000 may be used. The default value is the line thickness.
- thickness: The line thickness to use to draw the diagonal line, in dots. Any number between 1 and 32,000 may be used. The default value is 1.
- color: The line color to use to draw the diagonal line. Valid values are B (black) and W (white). The default value is B (black).
- orientation: The direction of the diagonal line. Valid values are R (bottom to top) and L (top to bottom). The default value is R (bottom to top).
Example (common usage): ^GD100,50,3
Example (full usage): ^GD100,50,3,B,R
^GE width, height, thickness, color
Configures the current field as a graphical ellipse.
Parameters:
- width: The width of the ellipse, in dots. Any number between 3 and 4,095 may be used. The default value is 3.
- height: The height of the ellipse, in dots. Any number between 3 and 4,095 may be used. The default value is 3.
- thickness: The line thickness to use to draw the ellipse, in dots. Any number between 1 and 4,095 may be used. The default value is 1.
- color: The line color to use to draw the ellipse. Valid values are B (black) and W (white). The default value is B (black).
Example (common usage): ^GE100,50,3
Example (full usage): ^GE100,50,3,B
^GF format, dataBytes, totalBytes, rowBytes, data
Configures the current field as an embedded image field.
Parameters:
- format: The format of the image data contained in the fifth parameter. Valid values are A (hexadecimal format), B (raw binary format), and C (AR compressed). There is no default value.
- dataBytes: The total number of data bytes in the fifth parameter. The value of this parameter is always the same as totalBytes, except in the case of format C (AR compressed) which is very rarely used.
- totalBytes: The total number of bytes in the image. Because each pixel in the image uses 1 bit, this value should be the total number of pixels in the image, divided by 8 (since there are 8 bits per byte). There is no default value.
- rowBytes: The number of bytes per pixel row in the image. Because each pixel in the image uses 1 bit, this value should be the pixel width of the image, divided by 8 (since there are 8 bits per byte). There is no default value.
- data: The image data, in the format specified in the first parameter. There is no default value.
Example (common usage): ^GFA,999000,999000,999,ABCDEF01234...
Example (full usage): ^GFA,999000,999000,999,ABCDEF01234...
^GS orientation, height, width
Configures the current field as a graphical symbol, mapping ASCII values in the field data to non-ASCII symbols (A = ®, B = ©, C = ™, D = Underwriter Labs approval symbol, E = Canadian Standards Association approval symbol).
Parameters:
- orientation: The symbol orientation to use. Valid values are N (no rotation), R (rotate 90° clockwise), I (rotate 180° clockwise), and B (rotate 270° clockwise). The default value is the orientation configured via the ^FW command, which itself defaults to N (no rotation).
- height: The symbol height to use, in dots. Any number between 1 and 32,000 may be used. The default value is the value previously configured via the ^CF command, if any.
- width: The symbol width to use, in dots. Any number between 1 and 32,000 may be used. The default value is the value previously configured via the ^CF command, if any.
Example (common usage): ^GS,50
Example (full usage): ^GSN,50,50
~HB
Requests a battery status report via the terminal.
Example (common usage): ~HB
Example (full usage): ~HB
~HD
Requests a head diagnostic report via the terminal.
Example (common usage): ~HD
Example (full usage): ~HD
^HF path
Requests a label definition file via the terminal.
Parameters:
- path: The file path to read the label definition from. The default value is R:UNKNOWN.ZPL.
Example (common usage): ^HFR:LABEL.ZPL
Example (full usage): ^HFR:LABEL.ZPL
^HG path
Requests an image graphics file via the terminal.
Parameters:
- path: The file path to read the image graphics from. The default value is R:UNKNOWN.GRF.
Example (common usage): ^HGR:IMAGE.GRF
Example (full usage): ^HGR:IMAGE.GRF
^HH
Requests a full configuration report via the terminal.
Example (common usage): ^HH
Example (full usage): ^HH
~HI
Requests a basic configuration report via the terminal.
Example (common usage): ~HI
Example (full usage): ~HI
^HL
Requests the RFID data log via the terminal.
Example (common usage): ^HL
Example (full usage): ^HL
~HL
Requests the RFID data log via the terminal.
Example (common usage): ~HL
Example (full usage): ~HL
~HM
Requests a RAM status report via the terminal.
Example (common usage): ~HM
Example (full usage): ~HM
~HQ query
Requests information via the terminal.
Parameters:
- query: The type of information being requested. Valid values are ES (error status), HA (hardware address), JT (printhead test results), MA (maintenance alert settings), MI (maintenance information), OD (odometer), PH (printhead life history), PP (plug and play string), SN (serial number), and UI (USB information). There is no default value.
Example (common usage): ~HQES
Example (full usage): ~HQES
^HR prefix, suffix, start, end, antennaSelection
Calibrates the RFID tag position and sends the results via the terminal.
Parameters:
- prefix: Prefix text to send via the terminal before sending the calibration results. The default value is 'start'.
- suffix: Suffix text to send via the terminal after sending the calibration results. The default value is 'end'.
- start: The initial calibration position, in millimeters, relative to the leading print edge. Valid values are F0 - F999 and B0 - B30, where the letters represent the direction (F = forwards, B = backwards). The default value is hardware-dependent.
- end: The final calibration position, in millimeters, relative to the leading print edge. Valid values are F0 - F999 and B0 - B30, where the letters represent the direction (F = forwards, B = backwards). The default value is hardware-dependent.
- antennaSelection: Whether the RFID antenna selection should be manual or automatic. Valid values are M (manual) and A (automatic). The default value is A (automatic).
Example (common usage): ^HR
Example (full usage): ^HRstart,end,F0,F200,A
~HS
Requests a hardware status report via the terminal.
Example (common usage): ~HS
Example (full usage): ~HS
^HT
Requests a list of font links via the terminal.
Example (common usage): ^HT
Example (full usage): ^HT
~HU
Requests an alert configuration report via the terminal.
Example (common usage): ~HU
Example (full usage): ~HU
^HV fieldNumber, bytes, prefix, suffix, mode
Requests the field data associated with a specific field via the terminal.
Parameters:
- fieldNumber: The number identifying the field whose field data is being requested. Any number between 0 and 9,999 may be used. The default value is 0.
- bytes: The number of bytes of data being requested. Any number between 1 and 256 may be specified. The default value is 64.
- prefix: Custom prefix to send via the terminal before sending the field data. There is no default value.
- suffix: Custom suffix to send via the terminal after sending the field data. There is no default value.
- mode: Whether to send field data for each label definition processed, or for for each label generated. Valid values are F (per label definition) and L (per label generated). The default value is F (per label definition).
Example (common usage): ^HV1,8
Example (full usage): ^HV1,8,<,>,F
^HW path, format
Requests a file listing via the terminal.
Parameters:
- path: The file path pattern used to search for files to include in the file listing. Wildcards (*, ?) are accepted. The default value is R:*.* which includes all files on the R drive.
- format: The format to use to send the file listing. Valid values are D (default) and C (columns). The default value is D (default).
Example (common usage): ^HWR:*.*
Example (full usage): ^HWR:*.*,D
^HY path
Requests an image graphics file via the terminal.
Parameters:
- path: The file path to read the image graphics from. The default value is R:UNKNOWN.GRF.
Example (common usage): ^HYR:IMAGE.GRF
Example (full usage): ^HYR:IMAGE.GRF
^HZ selector, path, longFilenames
Requests printer information in XML format via the terminal.
Parameters:
- selector: The type of information to be sent. Valid values are A (all information), F (format configuration), L (directory listing), O (individual object information) and R (printer status). There is no default value.
- path: The file path of the individual object whose information is being requested. The default value is R:UNKNOWN.GRF. Used only when requesting individual object information (selector = O).
- longFilenames: Whether or not to use long (16 character) filenames. Used only when requesting individual object information (selector = O).
Example (common usage): ^HZA
Example (full usage): ^HZO,R:IMAGE.GRF,Y
^ID path
Deletes a file or set of files from printer memory.
Parameters:
- path: The file path pattern used to search for files to delete. Wildcards (*, ?) are accepted. The default value is R:UNKNOWN.GRF.
Example (common usage): ^IDR:IMAGE.GRF
Example (full usage): ^IDR:IMAGE.GRF
^IL path
Configures the current field as a label image field. The label image file is usually previously saved to memory using the ^IS command.
Parameters:
- path: The path to the label image file. The default value is R:UNKNOWN.GRF.
Example (common usage): ^ILR:LABEL.GRF
Example (full usage): ^ILR:LABEL.GRF
^IM path
Configures the current field as an image graphics field.
Parameters:
- path: The path to the image graphics file. The default value is R:UNKNOWN.GRF.
Example (common usage): ^IMR:IMAGE.GRF
Example (full usage): ^IMR:IMAGE.GRF
^IS path, print
Saves the current label definition to an image file for later use via ^IL.
Parameters:
- path: The file path to save the image to. The default value is R:UNKNOWN.GRF.
- print: Whether or not to continue printing the current label definition after saving it as an image file. Valid values are Y (print after saving) and N (do not print after saving). The default value is Y (print after saving).
Example (common usage): ^ISR:LABEL.GRF
Example (full usage): ^ISR:LABEL.GRF,N
~JA
Cancels the current print job, as well as any label definitions currently in the buffer waiting to be printed.
Example (common usage): ~JA
Example (full usage): ~JA
^JB device
Reinitializes a flash memory device installed in the printer.
Parameters:
- device: The device to be reinitialized. Valid values are A (Compact Flash card), B (PCMCIA card) and E (internal flash memory). There is no default value.
Example (common usage): ^JBE
Example (full usage): ^JBE
~JB
Reinitializes the PCMCIA card installed in the printer (i.e. the B: drive). If you need to reinitialize any other flash memory devices, see the ^JB command instead.
Example (common usage): ~JB
Example (full usage): ~JB
~JC
Recalibrates the label length and sensor settings.
Example (common usage): ~JC
Example (full usage): ~JC
~JD
Enables diagnostic mode. While diagnostic mode is enabled, the byte values received by the printer are rendered to diagnostic labels, rather than interpreted as ZPL. Diagnostic mode is useful to debug communications and encoding issues. Diagnostic mode can be disabled with the ~JE command.
Example (common usage): ~JD
Example (full usage): ~JD
~JE
Disables diagnostic mode (previously enabled with the ~JD command).
Example (common usage): ~JE
Example (full usage): ~JE
~JF pause
Configures whether or not the printer pauses printing when the printer battery has very low power, in order to avoid data loss.
Parameters:
- pause: Whether or not to pause when the printer battery has very low power. Valid values are Y (pause on low power) and N (do not pause on low power). The default value is Y (pause on low power).
Example (common usage): ~JFY
Example (full usage): ~JFY
~JG
Prints a sensor calibration graph label. The graph displays the values set by the ~JC or ^SS commands.
Example (common usage): ~JG
Example (full usage): ~JG
^JH warnMedia, mediaLength, mediaReplaced, ribbonLength, ribbonReplaced, warnMaintenance, headCleanInterval, headCleaned, headLifeInterval, headReplaced
Configures the early warning settings for the printer.
Parameters:
- warnMedia: Enable or disable media-related warnings. Valid values are E (enable) and D (disable). The default value is D (disable).
- mediaLength: The number of labels per label roll. Any number between 100 and 9,999 may be used. The default value is 900.
- mediaReplaced: Whether or not the label roll has been replaced. Valid values are Y and N. The default value is N (labels have not been replaced).
- ribbonLength: The length of the ribbon. Valid values vary by printer model, as does the default value.
- ribbonReplaced: Whether or not the ribbon has been replaced. Valid values are Y and N. The default value is N (ribbon has not been replaced).
- warnMaintenance: Enable or disable hardware maintenance-related warnings. Valid values are E (enable) and D (disable). The default value is D (disable).
- headCleanInterval: The expected interval between printhead cleanings. Any number between 0 and 16 may be used, where number N represents an interval of (100+(50*N)) meters.
- headCleaned: Whether or not the printhead has been cleaned. Valid values are Y and N. The default value is N (printhead has not been cleaned).
- headLifeInterval: The expected interval between printhead replacements, in inches. Any number between 100 and 3,500,000 may be used. The default value is 1,000,000.
- headReplaced: Whether or not the printhead has been replaced. Valid values are Y and N. The default value is N (printhead has not been replaced).
Example (common usage): ^JHD,,,,,D
Example (full usage): ^JHE,1000,N,7,N,E,12,N,2000000,N
~JI
Starts a new ZBI (BASIC interpreter) session. The session can be ended with the ~JQ command.
Example (common usage): ~JI
Example (full usage): ~JI
^JI script, console, echo
Starts a new ZBI (BASIC interpreter) session. The session can be ended with the ~JQ command.
Parameters:
- script: The path to the BASIC initialization script to run automatically, if any. There is no default value.
- console: Whether or not to enable the console. Valid values are Y (enable the console) and N (do not enable the console). The default value is Y (enable the console).
- echo: Whether or not to enable echoing. Valid values are Y (enable echoing) and N (do not enable echoing). The default value is Y (enable echoing).
Example (common usage): ^JI
Example (full usage): ^JIR:INIT.BAS,Y,Y
^JJ opMode, appMode, signalMode, errMode, reprintMode, ribbonMode
Configures the auxiliary port, which is used to control verifier and applicator devices.
Parameters:
- opMode: The operational mode. Valid values are 0 (off), 1 (stop on error) and 2 (stop soon after error). The default value is 0 (off).
- appMode: The application mode. Valid values are 0 (off), 1 (signal low while printing), 2 (signal high while printing), 3 (signal low after printing) and 4 (signal high after printing). The default value is 0 (off).
- signalMode: The start print signal mode. Valid values are P (pulse mode) and L (level mode).
- errMode: The label error mode. Valid values are E (error mode) and F (feed mode). The default value is F (feed mode).
- reprintMode: The reprint mode. Valid values are E (enabled) and D (disabled). The default value is D (disabled).
- ribbonMode: The ribbon low warning mode. Valid values are E (enabled) and D (disabled). The default value is E (enabled).
Example (common usage): ^JJ0,0
Example (full usage): ^JJ1,1,L,F,D,E
~JK
Cuts the label when the printer is in "delayed cut" print mode, which can be configured with the ^MM command. The ~JK command should be sent to the printer separately from any other commands.
Example (common usage): ~JK
Example (full usage): ~JK
~JL
Recalibrates the label length.
Example (common usage): ~JL
Example (full usage): ~JL
^JM adjustment
Halves the print density, effectively doubling the physical size of any label content.
Parameters:
- adjustment: Whether to use normal print density or half print density. Valid values are A (normal print density) and B (half print density). The default value is the previously configured value, or A (normal print density) if no value was previously configured.
Example (common usage): ^JMB
Example (full usage): ^JMB
~JN
Starts a printhead test. The printer will halt if the test fails.
Example (common usage): ~JN
Example (full usage): ~JN
~JO
Starts a printhead test. The printer will pause if the test fails.
Example (common usage): ~JO
Example (full usage): ~JO
~JP
Cancels the currently-processing label definition (if any) and pauses printing.
Example (common usage): ~JP
Example (full usage): ~JP
~JQ
Ends the current ZBI (BASIC interpreter) session, if one was previously started with a ^JI or ~JI command.
Example (common usage): ~JQ
Example (full usage): ~JQ
~JR
Resets the printer, simulating a manual power cycle.
Example (common usage): ~JR
Example (full usage): ~JR
^JS sensor
Selects the active media sensor.
Parameters:
- sensor: The active media sensor. Valid values are A (auto-select), R (reflective media sensor) and T (transmissive media sensor). The default value varies by printer model.
Example (common usage): ^JSA
Example (full usage): ^JSA
~JS sequence
Configures the label backfeed actions.
Parameters:
- sequence: The label backfeed actions. Valid values are A (100% backfeed after printing), B (100% backfeed before printing), N (normal, i.e. 90% backfeed after printing), O (off, i.e. no backfeed), or any multiple of 10 between 10 and 90 (percent backfeed after printing). The default value is N (normal, i.e. 90% backfeed after printing).
Example (common usage): ~JSN
Example (full usage): ~JSN
^JT interval, manual, first, last
Configures the printhead test interval.
Parameters:
- interval: The interval, in labels, between each printhead test. Any number between 0 and 9999 may be used. The default value is 0 (no test).
- manual: Whether or not to configure the test element range manually. Valid values are Y (manual configuration) and N (automatic configuration).
- first: The first element to test (if manual is Y). Any number between 0 and 9999 may be used. The default value is 0.
- last: The last element to test (if manual is Y). Any number between 0 and 9999 may be used. The default value is 9999.
Example (common usage): ^JT9999,N
Example (full usage): ^JT9999,Y,0,9999
^JU configuration
Loads or saves the printer configuration.
Parameters:
- configuration: The printer configuration to load or save. Valid values are S (save current settings), R (reload last saved settings), F (reload factory settings) and N (reload factory network settings). There is no default value.
Example (common usage): ^JUS
Example (full usage): ^JUS
^JW tension
Sets the ribbon tension.
Parameters:
- tension: The ribbon tension. Valid values are L (low tension), M (medium tension) and H (high tension). There is no default value.
Example (common usage): ^JWM
Example (full usage): ^JWM
~JX
Cancels the current label definition.
Example (common usage): ~JX
Example (full usage): ~JX
^JZ reprint
Configures whether or not to reprint labels which were interrupted by an error condition as soon as the error is corrected.
Parameters:
- reprint: Whether or not to reprint labels which were interrupted by an error condition. Valid values are Y (reprint) and N (do not reprint). There is no default value.
Example (common usage): ^JZY
Example (full usage): ^JZY
~KB
Completely drains the rechargeable battery, if the printer has one.
Example (common usage): ~KB
Example (full usage): ~KB
^KC enable, device, prefix, identifier
Enables and disables custom network client identifiers.
Parameters:
- enable: Whether or not to enable a custom network client identifier. Valid values are 0 (disable), 1 (enable and use the MAC address), 2 (enable and use the specified ASCII value) and 3 (enable and use the specified hexadecimal value). The default value is 0 (disable).
- device: The network device to configure. Valid values are 0 (all network devices), 1 (the wireless network device), 2 (the external wired network device) and 3 (the internal wired network device). The default value is 1 (the wireless network device).
- prefix: Optional prefix to use. May be up to 11 ASCII characters or 22 hexadecimal characters, depending on the value of the first parameter.
- identifier: The client identifier to use. May be up to 60 ASCII characters or 120 hexadecimal characters, depending on the value of the first parameter.
Example (common usage): ^KC1,1
Example (full usage): ^KC2,1,ABC,DEF
^KD format
Sets the date and time format used on control panels and configuration diagnostic labels.
Parameters:
- format: The date and time format to use. Valid values are 1 (mm/dd/yy with a 24-hour time), 2 (mm/dd/yy with a 12-hour time), 3 (dd/mm/yy with a 24-hour time) and 4 (dd/mm/yy with a 12-hour time). The default value is 1 (mm/dd/yy with a 24-hour time).
Example (common usage): ^KD1
Example (full usage): ^KD1
^KL language
Sets the control panel display language.
Parameters:
- language: The control panel display language. Valid values are 1 (English), 2 (Spanish), 3 (French), 4 (German), 5 (Italian), 6 (Norwegian), 7 (Portuguese), 8 (Swedish), 9 (Danish), 10 (Spanish), 11 (Dutch), 12 (Finnish), 13 (Japanese), 14 (Korean), 15 (Simplified Chinese), 16 (Traditional Chinese), 17 (Russian), 18 (Polish), 19 (Czech) and 20 (Romanian). The default value is 1 (English).
Example (common usage): ^KL1
Example (full usage): ^KL1
^KN name, description
Sets the printer network name.
Parameters:
- name: The printer network name. The maximum length is 16 characters.
- description: The printer description, if any. The maximum length is 35 characters.
Example (common usage): ^KNCALLIOPE
Example (full usage): ^KNCALLIOPE,DESK 42
^KP password, level
Sets the control panel password.
Parameters:
- password: The new control panel password. Must be four digits. The default value is 1234.
- level: The password level. Any number between 1 and 4 may be used. The default value is 3.
Example (common usage): ^KP1234
Example (full usage): ^KP1234,3
^KV cutAmount, cutMargin, presentType, presentTimeout, loopLen
Sets various kiosk mode parameters. Kiosk mode can be enabled with the ^MM command.
Parameters:
- cutAmount: Amount to leave uncut, in millimeters. Any number between 10 and 60 may be used. The value 0 may also be used. The default value is the previously configured value, or 0 if no value was previously configured.
- cutMargin: The cut margin, in millimeters. Any number between 2 and 9 may be used. The default value is the previously configured value, or 9 if no value was previously configured.
- presentType: The present action type. Valid values are 0 (eject after printing), 1 (retract after printing) and 2 (no action). The default value is the previously configured value, or 0 (eject page) if no value was previously configured.
- presentTimeout: The amount of time, in seconds, to wait for a label to be retrieved before retracting it. Any number between 0 and 300 may be used. The default value is the previously configured value, or 0 (no timeout) if no value was previously configured.
- loopLen: The presenter loop length, in millimeters. Any number between 3 and 1023 may be used. The value 0 may also be used to indicate no loop. The default value is the previously configured value, or 400 if no value was previously configured.
Example (common usage): ^KV0,9,0,0,0
Example (full usage): ^KV0,9,0,0,0
^LF
Generates a configuration label containing a list of font links. If the current label already contains content, the configuration label will be generated after the current label.
Example (common usage): ^LF
Example (full usage): ^LF
^LH x, y
Sets the label home position, which serves as the origin (0, 0) of the label coordinate system.
Parameters:
- x: The x-coordinate of the new origin, in dots, relative to the original origin (top left corner of the label). Any number between 0 and 32,000 may be used. The default value is the previously configured value, or 0 if no value was previously configured.
- y: The y-coordinate of the new origin, in dots, relative to the original origin (top left corner of the label). Any number between 0 and 32,000 may be used. The default value is the previously configured value, or 0 if no value was previously configured.
Example (common usage): ^LH10,10
Example (full usage): ^LH10,10
^LL length, allMedia
Sets the label length (most commonly used with continuous media).
Parameters:
- length: The label length, in dots. Any number between 1 and 32,000 may be used. The default value depends on previous configuration.
- allMedia: Whether or not the label length applies to all media (Y) or only to continuous media (N). The default value is N (continuous media only).
Example (common usage): ^LL1218
Example (full usage): ^LL1218,N
^LR reverse
Configures all subsequent fields in the current label to reverse the background color, drawing black over white and white over black. This is also known as XOR mode drawing. This command is the global equivalent of the field-specific ^FR command.
Parameters:
- reverse: Whether or not to enable reverse mode. Valid values are Y (enable reverse mode) and N (disable reverse mode). The default value is N (disable reverse mode).
Example (common usage): ^LRY
Example (full usage): ^LRY
^LS distance
Shifts all label content to the left or the right.
Parameters:
- distance: The distance to shift label content to the left, in dots. Any number between -9,999 and 9,999 may be used. Positive values shift label content to the left, negative values shift label content to the right. The default value is the previously configured value, or 0 if no value was previously configured.
Example (common usage): ^LS20
Example (full usage): ^LS20
^LT distance
Shifts all label content up or down.
Parameters:
- distance: The distance to shift label content down, in dots. Any number between -120 and 120 may be used. Positive values shift label content down, negative values shift label content up. The default value is the previously configured value, or 0 if no value was previously configured.
Example (common usage): ^LT20
Example (full usage): ^LT20
^MA type, print, start, repeat, units
Configures the printing of maintenance alert labels. The alert messages can be configured using the ^MI command.
Parameters:
- type: The type of maintenance alert to configure. Valid values are R (print head replacement alerts) and C (print head cleaning alerts). There is no default value.
- print: Whether or not to print a maintenance alert label for the specified alert type. Valid values are Y (print alert labels) and N (do not print alert labels). The default value is N (do not print alert labels).
- start: The initial label distance after which the first maintenance alert label should be printed. For alert type R, any number between 0 and 150 may be used; units are kilometers. For alert type C, any number between 0 and 2,000 may be used; units are meters. The default value is 50 km for alert type R, and 0 m for alert type C.
- repeat: The label distance after which the maintenance alert label should reprint, in meters. Any number between 0 and 2,000 may be used. The default value is 0.
- units: The units to use when reporting maintenance information. Valid values are C (centimeters), I (inches) and M (meters). The default value is I (inches).
Example (common usage): ^MAC,N
Example (full usage): ^MAR,Y,100,500,I
^MC clear
Allows the previous label output to be kept as part of the next label.
Parameters:
- clear: Whether or not to clear the previous label contents before drawing the next label. Valid values are Y (clear the previous label contents) and N (do not clear the previous label contents). The default value is Y (clear the previous label contents).
Example (common usage): ^MCN
Example (full usage): ^MCN
^MD darknessModifier
Modifies the print darkness level, relative to the base print darkness configured with the ~SD command.
Parameters:
- darknessModifier: The amount to increase or decrease the darkness level. Any number between -30 and 30 may be used. Negative numbers result in lighter print output, while positive numbers result in darker print output. There is no default value.
Example (common usage): ^MD5
Example (full usage): ^MD5
^MF powerupAction, closingAction
Configures the power-up and head-close media feed actions.
Parameters:
- powerupAction: The media feed action to take on power-up. Valid values are F (feed media to first inter-label mark), C (recalibrate media sensor), L (reset the label length), N (do nothing), and S (perform a short calibration). The default value is C (recalibrate media sensor).
- closingAction: The media feed action to take on head-close. Valid values are F (feed media to first inter-label mark), C (recalibrate media sensor), L (reset the label length), N (do nothing), and S (perform a short calibration). The default value is C (recalibrate media sensor).
Example (common usage): ^MFN,C
Example (full usage): ^MFN,C
^MI type, message
Configures the messages used on the maintenance alert labels. The frequency of the maintenance alert labels can be configured using the ^MA command.
Parameters:
- type: The type of maintenance alert to configure. Valid values are R (print head replacement alerts) and C (print head cleaning alerts). The default value is R (print head replacement alerts).
- message: The message to print on the maintenance alert label. The maximum length is 63 characters. The default value is "PLEASE REPLACE PRINT HEAD" for alert type R, and "PLEASE CLEAN PRINT HEAD" for alert type C.
Example (common usage): ^MIR,CALL EXT 1234 FOR REPLACEMENT
Example (full usage): ^MIR,CALL EXT 1234 FOR REPLACEMENT
^ML maxLength
Configures the maximum label length.
Parameters:
- maxLength: The maximum label length, in dots. There is no default value.
Example (common usage): ^ML1421
Example (full usage): ^ML1421
^MM mode, prepeel
Configures the post-print action.
Parameters:
- mode: The post-print action to be taken by the printer after each label is printed. Valid values are T (advance label to tear-off bar for manual tear-off), P (advance label and wait for manual peel-off), R (rewind label on an external rewind device), A (advance label for applicator device), C (advance label for automated cutting), D (wait for delayed cut command), F (encode RFID data without backfeed), and K (present label for removal from kiosk). The default value is T (advance label to tear-off bar for manual tear-off).
- prepeel: Whether or not to pre-peel each label before printing. Valid values are Y (pre-peel labels) and N (do not pre-peel labels). The default value is N (do not pre-peel labels).
Example (common usage): ^MMT
Example (full usage): ^MMT,N
^MN media, offset
Configures the label media type.
Parameters:
- media: The label media type being used. Valid values are N (continuous media), V (variable-length continuous media), W or Y (non-continuous web-sensing media), M (non-continuous mark-sensing media), and A (auto-detect media type during calibration). There is no default value.
- offset: The offset of the media mark relative to the actual label break, in dots. Valid values are hardware-specific, but values between -75 and 283 are usually valid. The default value is 0.
Example (common usage): ^MNW
Example (full usage): ^MNM,50
^MP function
Enables and disables control panel functionality.
Parameters:
- function: The control panel function to be disabled. Valid values are D (disable darkness mode), P (disable position mode), C (disable calibration mode), W (disable pause), F (disable feed), X (disable cancel), M (disable menu adjustments), S (disable mode saves), and E (re-enable all modes). There is no default value.
Example (common usage): ^MPD
Example (full usage): ^MPD
^MT mediaType
Configures the label media type.
Parameters:
- mediaType: The label media type being used. Valid values are D (direct thermal media) and T (thermal transfer media). There is no default value.
Example (common usage): ^MTD
Example (full usage): ^MTD
^MU units, baseDpi, desiredDpi
Customizes the units of the label coordinate system, so that commands which normally accept coordinates and distances in dots may instead use physical units like millimeters and inches. This command also optionally allows DPI conversion of label definitions.
Parameters:
- units: The units to use to specify label coordinates and distances. Valid values are D (dots), I (inches), and M (millimeters). There is no default value.
- baseDpi: The label definition base DPI. This parameter is ignored if units are not D (dots). Valid values are 150, 200, 300 and 600. There is no default value.
- desiredDpi: The label definition desired DPI. This parameter is ignored if units are not D (dots). Valid values are 150, 200, 300 and 600. This value must be a whole integer multiple of the base DPI. There is no default value.
Example (common usage): ^MUM
Example (full usage): ^MUD,200,600
^MW enable
Enables and disables the head cold warning.
Parameters:
- enable: Whether or not to enable the head cold warning. Valid values are Y (enable) and N (disable). There is no default value.
Example (common usage): ^MWY
Example (full usage): ^MWY
^NB wired
Configures whether or not to prefer wired print servers over wireless print servers during network boot. Affects only printers with both wired and wireless print servers.
Parameters:
- wired: Whether or not to prefer wired print servers over wireless print servers during network boot. Valid values are C (check for, and prefer, wired print servers over wireless print servers) and S (skip wired print server check, and prefer wireless print servers). The default value is S (prefer wireless print servers).
Example (common usage): ^NBS
Example (full usage): ^NBS
^NC device
Sets the primary network device.
Parameters:
- device: The primary network device. Valid values are 1 (wired) and 2 (wireless). The default value is 1 (wired).
Example (common usage): ^NC1
Example (full usage): ^NC1
~NC networkId
Connects to a specific network printer, based on the printer's three-digit network ID. The printer's network ID can be set using the ^NI command.
Parameters:
- networkId: The three-digit network ID of the printer to send the label definition to. Any number between 000 and 999 may be used. The default value is 000.
Example (common usage): ~NC001
Example (full usage): ~NC001
^ND device, res, ip, mask, gateway, wins, timeout, secs, arp, port
Configures the network settings for a specific network device.
Parameters:
- device: The network device to configure. Valid values are 1 (external wired), 2 (internal wired) and 3 (wireless). There is no default value.
- res: The IP resolver to use. Valid values are A (all), B (BOOTP), C (DHCP and BOOTP), D (DHCP), G (gleaning), R (RARP) and P (permanent). The default value is A (all).
- ip: The IP address to use. Any valid IP address in dot-decimal notation may be used. There is no default value.
- mask: The subnet mask to use. Any valid subnet mask in dot-decimal notation may be used. There is no default value.
- gateway: The default network gateway. Any valid IP address in dot-decimal notation may be used. There is no default value.
- wins: The WINS server IP address. Any valid IP address in dot-decimal notation may be used. There is no default value.
- timeout: Whether or not to enable a connection timeout. Valid values are Y (enable) and N (disable). The default value is Y (enable).
- secs: The network connection timeout, in seconds. Any number between 0 and 9,999 may be used. The default value is 300.
- arp: The ARP broadcast interval, in minutes. Any number between 0 and 30 may be used. The default value is 0 (no ARP broadcast).
- port: The port number to use for RAW data. Any number between 1 and 65,535 may be used. The default value is 9100.
Example (common usage): ^ND3,,,255.255.255.0,192.168.0.1
Example (full usage): ^ND3,A,192.168.0.100,255.255.255.0,192.168.0.1,192.168.0.10,Y,300,0,9100
^NI networkId
Sets the printer's three-digit network ID.
Parameters:
- networkId: The three-digit network ID to assign to the printer. Any number between 000 and 999 may be used. The default value is 000 (no network ID).
Example (common usage): ^NI001
Example (full usage): ^NI001
^NN name, contact, location, getCommunity, setCommunity, trapCommunity
Configures the printer's SNMP settings.
Parameters:
- name: The SNMP system name. The maximum length is 17 characters. There is no default value.
- contact: The SNMP system contact. The maximum length is 50 characters. There is no default value.
- location: The SNMP system location. The maximum length is 50 characters. There is no default value.
- getCommunity: The SNMP GET community name. The maximum length is 19 characters. The default value is 'public'.
- setCommunity: The SNMP SET community name. The maximum length is 19 characters. The default value is 'public'.
- trapCommunity: The SNMP TRAP community name. The maximum length is 20 characters. The default value is 'public'.
Example (common usage): ^NNPRT102,JOE@IT.COM,ANNEX,4TK9,8QR3,R5IG
Example (full usage): ^NNPRT102,JOE@IT.COM,ANNEX,4TK9,8QR3,R5IG
^NP device
Configures the source of the network settings used at start up.
Parameters:
- device: The device whose network settings are to be used at start up. Valid values are P (printer) and M (print server). The default value is P (printer).
Example (common usage): ^NPP
Example (full usage): ^NPP
~NR
Configures all printers on the network to operate in transparent mode.
Example (common usage): ~NR
Example (full usage): ~NR
^NS res, ip, mask, gateway, wins, timeout, secs, arp, port
Configures the network settings for the wired print server. Note that the ^ND command should be used instead, if possible.
Parameters:
- res: The IP resolver to use. Valid values are A (all), B (BOOTP), C (DHCP and BOOTP), D (DHCP), G (gleaning), R (RARP) and P (permanent). The default value is A (all).
- ip: The IP address to use. Any valid IP address in dot-decimal notation may be used. There is no default value.
- mask: The subnet mask to use. Any valid subnet mask in dot-decimal notation may be used. There is no default value.
- gateway: The default network gateway. Any valid IP address in dot-decimal notation may be used. There is no default value.
- wins: The WINS server IP address. Any valid IP address in dot-decimal notation may be used. There is no default value.
- timeout: Whether or not to enable a connection timeout. Valid values are Y (enable) and N (disable). The default value is Y (enable).
- secs: The network connection timeout, in seconds. Any number between 0 and 9,999 may be used. The default value is 300.
- arp: The ARP broadcast interval, in minutes. Any number between 0 and 30 may be used. The default value is 0 (no ARP broadcast).
- port: The port number to use for RAW data. Any number between 1 and 65,535 may be used. The default value is 9100.
Example (common usage): ^NS,,255.255.255.0,192.168.0.1
Example (full usage): ^NSA,192.168.0.100,255.255.255.0,192.168.0.1,192.168.0.10,Y,300,0,9100
^NT server, domain
Configures the printer's SMTP settings, which are used to send email alerts.
Parameters:
- server: The SMTP server's IP address, in dot-decimal notation. There is no default value.
- domain: The SMTP domain. Any valid domain name may be used. There is no default value.
Example (common usage): ^NT192.168.0.77,printers.mycompany.com
Example (full usage): ^NT192.168.0.77,printers.mycompany.com
~NT
Configures the current printer to operate in network transparent mode.
Example (common usage): ~NT
Example (full usage): ~NT
^NW timeout
Sets the printer homepage authentication timeout, in minutes. This is the time after which the user is prompted again for the printer password.
Parameters:
- timeout: The number of minutes that a user's web authentication is valid. Any number between 0 and 255 may be used. The default value is 5.
Example (common usage): ^NW60
Example (full usage): ^NW60
^PA defaultGlyph, bidi, charShaping, openTypeSupport
Configures advanced text layout and font engine settings.
Parameters:
- defaultGlyph: Whether to use a space character or the .notdef glyph when a font is unable to display a character. The .notdef glyph is usually a blank vertical rectangle. Valid values are 0 (use a space character) and 1 (use the .notdef glyph). The default value is the previously configured value, or 0 (use a space character) if no value was previously configured.
- bidi: Whether or not to enable bidirectional text layout, which is important for Arabic and Hebrew scripts. Valid values are 0 (disable bidi layout) and 1 (enable bidi layout). The default value is the previously configured value, or 0 (disable bidi layout) if no value was previously configured.
- charShaping: Whether or not to enable character shaping, which is important for Arabic and Indic scripts. Valid values are 0 (disable character shaping) and 1 (enable character shaping). The default value is the previously configured value, or 0 (disable character shaping) if no value was previously configured.
- openTypeSupport: Whether or not to enable support for advanced OpenType font features, like ligatures. Valid values are 0 (disable OpenType features) and 1 (enable OpenType features). The default value is the previously configured value, or 0 (disable OpenType features) if no value was previously configured.
Example (common usage): ^PA,,1
Example (full usage): ^PA1,1,1,1
^PF rows
Slews the label the specified number of dot rows, skipping all printing across those rows.
Parameters:
- rows: The number of dot rows (starting at the bottom of the label) to slew. Any number between 0 and 32,000 may be used. There is no default value.
Example (common usage): ^PF100
Example (full usage): ^PF100
^PH
Triggers the generation of one blank label.
Example (common usage): ^PH
Example (full usage): ^PH
~PH
Triggers the generation of one blank label.
Example (common usage): ~PH
Example (full usage): ~PH
~PL length
Increases the length of the label section ejected by the printer during a present cycle.
Parameters:
- length: The length of the extra label section to eject, in millimeters. Any number between 0 and 255 may be used. The default value is 0.
Example (common usage): ~PL10
Example (full usage): ~PL10
^PM mirror
Configures mirror mode, which mirrors label content across a vertical axis.
Parameters:
- mirror: Whether or not to mirror label content. Valid values are Y (mirror label content) and N (do not mirror label content). There is no default value.
Example (common usage): ^PMY
Example (full usage): ^PMY
~PM serialNumber, wipeCount
Triggers decommission mode.
Parameters:
- serialNumber: The printer serial number. The correct serial number must be used. There is no default value.
- wipeCount: The number of times to wipe printer memory. Any number between 0 and 3 may be used. The default value is 0.
Example (common usage): ~PM1234567890
Example (full usage): ~PM1234567890,1
^PN length
Triggers a present cycle, ejecting a section of the current label.
Parameters:
- length: The length of the label section to eject, in millimeters. Any number between 0 and 255 may be used. There is no default value.
Example (common usage): ^PN10
Example (full usage): ^PN10
^PO orientation
Configures inverted mode, which mirrors label content across a horizontal axis.
Parameters:
- orientation: Whether or not to invert label content. Valid values are I (invert label content) and N (do not invert label content). The default value is N (do not invert label content).
Example (common usage): ^POI
Example (full usage): ^POI
^PP
Pauses printing until a ~PS command is received.
Example (common usage): ^PP
Example (full usage): ^PP
~PP
Pauses printing until a ~PS command is received.
Example (common usage): ~PP
Example (full usage): ~PP
^PQ labels, labelsBetweenPauses, replicates, noPause, cutOnError
Configures the number of labels generated by a single label definition.
Parameters:
- labels: The number of labels generated by the current label definition. Any number between 1 and 99,999,999 may be used. The default value is 1.
- labelsBetweenPauses: The number of labels between print pauses. Any number between 0 and 99,999,999 may be used. The default value is 0 (no pauses).
- replicates: The number of label replicates to generate for each serial number. Any number between 0 and 99,999,999 may be used. The default value is 0 (no replicates).
- noPause: Whether or not to prevent printer pauses. Valid values are Y (prevent pauses) and N (do not prevent pauses). The default value is N (do not prevent pauses).
- cutOnError: Whether or not to cut the labels after an error label. Valid values are Y (cut after error label) and N (do not cut after error label). The default value is Y (cut after error label).
Example (common usage): ^PQ10
Example (full usage): ^PQ10,0,0,Y,N
^PR printSpeed, slewSpeed, backfeedSpeed
Configures the media speed during printing, slew and backfeed.
Parameters:
- printSpeed: The print speed, in inches per second. Any number between 1 and 14 may be used. The default value is 2.
- slewSpeed: The slew speed, in inches per second. Any number between 1 and 14 may be used. The default value is 6.
- backfeedSpeed: The backfeed speed, in inches per second. Any number between 1 and 14 may be used. The default value is 2.
Example (common usage): ^PR4
Example (full usage): ^PR4,4,4
~PR
Triggers a reprint of the last label printed.
Example (common usage): ~PR
Example (full usage): ~PR
~PS
Resumes printing after a printer has been paused via the ~PP command.
Example (common usage): ~PS
Example (full usage): ~PS
^PW width
Sets the label print width.
Parameters:
- width: The label print width, in dots. Any number between 2 and the label width may be used. The default value is the previously configured value, or the label width if no value was previously configured.
Example (common usage): ^PW812
Example (full usage): ^PW812
^RA fieldNumber, format, retries, motion, byteType
Reads the AFI or DSFID byte from the label's RFID tag.
Parameters:
- fieldNumber: The field number of the field receiving the read value. Any number between 0 and 9,999 may be used. The default value is 0.
- format: The data format to use. Valid values are 0 (ASCII characters) and 1 (hexadecimal digits). The default value is 0 (ASCII characters).
- retries: The number of times to retry the read operation, if necessary. Any number between 0 and 10 may be used. The default value is 0.
- motion: The post-read label motion. Valid values are 0 (feed label) and 1 (no feed). The default value is 0 (feed label).
- byteType: The type of identifier byte to read. Valid values are A (AFI byte) and D (DSFID byte). The default value is A (AFI byte).
Example (common usage): ^RA1,1,2,1,D
Example (full usage): ^RA1,1,2,1,D
^RB totalBits, partitions
Configures the RFID EPC data format, including the number of partitions and the partition sizes that are read from and/or written to the RFID tag.
Parameters:
- totalBits: The total number of bits across all partitions. Any number between 0 and N may be used, where N is the bit size of the RFID tag. The default value is 96.
- partitions: Comma-separated list containing the bit sizes of each partition. Up to 16 partitions may be specified. The sum of all partition sizes must match the total bit size provided in the first parameter. The maximum size of each individual partition is 64 bits. The default value is 1.
Example (common usage): ^RB64,32,8,16,8
Example (full usage): ^RB64,32,8,16,8
^RE enable, retries
Writes the EAS (Electronic Article Surveillance) bit to the label's RFID tag, if the RFID tag supports EAS. The EAS bit is a theft prevention mechanism used in retail environments.
Parameters:
- enable: Whether to enable or disable the EAS bit. Valid values are Y (enable) and N (disable). The default value is N (disable).
- retries: The number of times to retry the write operation, if necessary. Any number between 0 and 10 may be used. The default value is 0.
Example (common usage): ^REY,2
Example (full usage): ^REY,2
^RF operation, format, passwordOrBlock, bytes, memoryBank
Reads from the label's RFID tag, writes to the label's RFID tag, or sets the access and kill passwords of the label's RFID tag. When writing data or setting passwords, the actual values are provided in a subsequent ^FD command.
Parameters:
- operation: The operation to execute. Valid values are W (write), L (write and lock), R (read), P (read password) and S (set password). The default value is W (write).
- format: The data format to use. Valid values are A (ASCII characters), H (hexadecimal digits) and E (EPC partition value list). The default value is H (hexadecimal digits).
- passwordOrBlock: A byzantine multi-purpose parameter whose utility varies according to the operation used, the RFID tag type, and the tides. See your printer's documentation for more information.
- bytes: The number of bytes to read or write. Any number between 1 and N may be used, where N is the byte size of the RFID tag. The default value is 1.
- memoryBank: The memory bank to read from or write to. Valid values are 1 (EPC), 2 (TID), 3 (user), E (EPC 96-bit) and A (EPC with automatic handling of PC bits). The default value is E (EPC 96-bit).
Example (common usage): ^RFW,H,1,4,1
Example (full usage): ^RFW,H,1,4,1
^RI fieldNumber, order, retries, motion
Reads the 32-bit TID (tag ID) from the label's RFID tag.
Parameters:
- fieldNumber: The field number of the field receiving the read TID value. Any number between 0 and 9,999 may be used. The default value is 0.
- order: The byte order to apply to the data. Valid values are 0 (default byte order) and 1 (reverse byte order). The default value is 1 (reverse byte order). Note that different RFID tag manufacturers may use different default byte orders.
- retries: The number of times to retry the read operation, if necessary. Any number between 0 and 10 may be used. The default value is 0.
- motion: The post-read label motion. Valid values are 0 (feed label) and 1 (no feed). The default value is 0 (feed label).
Example (common usage): ^RI1,,2
Example (full usage): ^RI1,0,2,1
^RL lockAction, p1, p2, epcOp, userOp
Locks and unlocks the label's RFID tag memory.
Parameters:
- lockAction: The lock action to execute. Valid values are B (permanently locks a block of user memory), M (locks or unlocks a password or an entire memory bank, either permanently or temporarily) and P (permanently locks all memory banks and passwords). There is no default value.
- p1: For lock action B, sets the starting section of memory to be locked. For lock action M, specifies the action to execute on the kill password, and may be one of L (lock), U (unlock), P (permanently lock) and O (permanently unlock). There is no default value.
- p2: For lock action B, sets the number of memory sections to be locked. For lock action M, specifies the action to execute on the access password, and may be one of L (lock), U (unlock), P (permanently lock) and O (permanently unlock). There is no default value.
- epcOp: For lock action M, specifies the action to execute on the EPC memory bank, and may be one of L (lock), U (unlock), P (permanently lock) and O (permanently unlock). For other lock actions, this parameter is ignored. There is no default value.
- userOp: For lock action M, specifies the action to execute on the user memory bank, and may be one of L (lock), U (unlock), P (permanently lock) and O (permanently unlock). For other lock actions, this parameter is ignored. There is no default value.
Example (common usage): ^RLP
Example (full usage): ^RLM,L,L,L,L
^RM enable
Enables and disables RFID label motion.
Parameters:
- enable: Whether to enable or disable RFID label motion. Valid values are Y (enable motion) and N (disable motion). The default value is Y (enable motion).
Example (common usage): ^RMY
Example (full usage): ^RMY
^RN enable
Enables and disables detection of multiple RFID tags in the printer's RFID field. When detection is enabled and more than one RFID tag is detected, the label is voided. Disabling detection can speed up the printing process.
Parameters:
- enable: Whether to enable or disable multiple RFID tag detection. Valid values are Y (enable detection) and N (disable detection). The default value varies.
Example (common usage): ^RNY
Example (full usage): ^RNY
~RO counter
Resets the specified label counter.
Parameters:
- counter: The counter to be reset. Valid values are 1 (label counter 1), 2 (label counter 2), 3 (valid RFID label counter), 4 (voided RFID label counter), C (head cleaned counter) and R (head replaced and head cleaned counters). There is no default value.
Example (common usage): ~RO1
Example (full usage): ~RO1
^RQ format, chipType, option
Quickly writes the EPC data, access password and kill password to the label's RFID tag, using a single write operation. The actual data values are provided in a comma-delimited list in a subsequent ^FD command.
Parameters:
- format: The data format to use. Valid values are A (ASCII characters), H (hexadecimal digits) and E (EPC data). The default value is H (hexadecimal digits).
- chipType: The RFID tag chip type. There is only one valid value, which is 0 (Alien Higgs chip). The default value is 0 (Alien Higgs chip).
- option: Data write options. There is only one valid value, which is 0 (write 96-bit EPC). The default value is 0 (write 96-bit EPC).
Example (common usage): ^RQ
Example (full usage): ^RQH,0,0
^RR retries, adaptive
Configures the RFID read/write retry count and read/write failure behavior.
Parameters:
- retries: The number of times to retry the read or write operation, if necessary. Any number between 0 and 10 may be used. The default value is 6.
- adaptive: Whether or not to try to use the RFID antenna elements near the configured antenna elements in case of read or write failure. Valid values are 0 (do not try neighboring RFID antenna elements) and 1 (try neighboring RFID antenna elements). The default value is 0 (do not try neighboring RFID antenna elements).
Example (common usage): ^RR6,1
Example (full usage): ^RR6,1
^RS type, pos, voidLen, labels, onError, signal, deprecated, voidSpeed
Configures a broad variety of RFID settings.
Parameters:
- type: The RFID tag type to expect. Although many different values were supported in the past, the only recommended value today is 8 (EPC Class 1 Gen 2). The default value is 8 (EPC Class 1 Gen 2).
- pos: The position of the RFID tag on the label. Valid values are Fn (where n is a number between 0 and 999, and indicates the distance from the leading edge of the label) and Bn (where n is a number between 0 and 30, and indicates the distance backwards from the leading edge of the next label). All values are in millimeters. The default value is F0 (the leading edge of the label).
- voidLen: The vertical length of the void label to print when an RFID label fails to read or write, in dots. Any number between 0 and the label height may be used. The default value is the label height.
- labels: The maximum number of labels which will be attempted if an RFID read or write operation fails. Any number between 1 and 10 may be used. The default value is 3.
- onError: The error handling action to execute if the specified number of label attempts fail. Valid values are N (no action), P (pause printer) and E (transition printer to error mode). The default value is N (no action).
- signal: The applicator signal mode. Valid values are S (single signal) and D (double signal). The default value is S (single signal).
- deprecated: This parameter has been deprecated and is no longer used.
- voidSpeed: The speed at which to print the RFID void label, if necessary. Valid values depend on the printer being used. The default value is the printer's maximum print speed.
Example (common usage): ^RS,F30
Example (full usage): ^RS8,F0,600,3,N,S,,6
^RT fieldNumber, startBlock, blocks, format, retries, motion, mode
Reads data from the label's RFID tag.
Parameters:
- fieldNumber: The field number of the field receiving the read data. Any number between 0 and 9,999 may be used. The default value is 0.
- startBlock: The first memory block to read. Any number between 0 and N may be used, where N is the number of blocks in the RFID tag. The default value is 0.
- blocks: The number of memory blocks to read. Any number between 1 and N may be used, where N is the number of blocks in the RFID tag. The default value is 1.
- format: The data format to use. Valid values are 0 (ASCII characters) and 1 (hexadecimal digits). The default value is 0 (ASCII characters).
- retries: The number of times to retry the read operation, if necessary. Any number between 0 and 10 may be used. The default value is 0.
- motion: The post-read label motion. Valid values are 0 (feed label) and 1 (no feed). The default value is 0 (feed label).
- mode: A multi-purpose parameter whose utility varies according to the printer and RFID tag type used. Most users can ignore this parameter.
Example (common usage): ^RT1,,,,3
Example (full usage): ^RT1,0,4,0,3,1,0
^RU prefix, escapeChar
Reads the TID (tag ID) and EPC data from the label's RFID tag, making it available to be included in label fields by using the specified escape character. Assuming that the default escape character is used, the following data placeholders are made available to be used in ^FD field data: #S (TID in decimal form), #H (TID in hexadecimal form), #E (EPC data with TID in decimal form), #F (EPC data with TID in hexadecimal form), #P (EPC with SGTIN in decimal form) and #Q (EPC with SGTIN in hexadecimal form).
Parameters:
- prefix: Prefix to add to the TID when it is read. Must be a binary number of up to 38 digits. The default value is manufacturer-specific.
- escapeChar: The escape character to use to include TID or EPC data in field data. Any ASCII character which is not being used as a command delimiter, parameter delimiter or real-time clock (RTC) delimiter may be used. The default value is '#' (hash).
Example (common usage): ^RU
Example (full usage): ^RU1001011011100,#
~RV enable
Enables and disables the sending of RFID encode results to the host computer.
Parameters:
- enable: Whether to enable or disable sending of RFID encode results to the host computer. Valid values are E (enable) and D (disable). The default value is D (disable).
Example (common usage): ~RVE
Example (full usage): ~RVE
^RW readPower, writePower, antennaElement
Sets the RFID read and write power levels. Note that this is usually not necessary, as the power levels are normally selected automatically during calibration.
Parameters:
- readPower: The read power, in dBm. Any number between 0 and 30 may be used. The default value is 16.
- writePower: The write power, in dBm. Any number between 0 and 30 may be used. The default value is 16.
- antennaElement: The RFID antenna element to configure. Valid values, as well as the default value, depend on the specific printer model.
Example (common usage): ^RW20,20,A1
Example (full usage): ^RW20,20,A1
^RZ password, target, action
Sets the label's RFID tag password, and locks or unlocks the RFID tag.
Parameters:
- password: The password to use. Any hexadecimal number between 00000000 and FFFFFFFF may be used. The value must be 8 characters long. There is no default value.
- target: The action target. Valid values are A (the access password), K (the kill password), E (EPC memory), T (TID memory) and U (user memory). There is no default value.
- action: The action to carry out. Valid values are L (lock), U (unlock), P (permanently lock), O (permanently unlock) and W (write). There is no default value.
Example (common usage): ^RZPASSWORD123,E,L
Example (full usage): ^RZPASSWORD123,E,L
^SC baud, wordBits, parity, stopBits, mode, protocol
Configures the serial communication parameters.
Parameters:
- baud: The baud rate to use, in bits per second. Valid values are 110, 300, 600, 1200, 2400, 4800, 9600, 14400, 19200, 28800, 38400, 57600, and 115200. There is no default value.
- wordBits: The number of data bits in each character. Valid values are 7 and 8. There is no default value.
- parity: The type of parity bit to use for error detection. Valid values are N (none), O (odd), and E (even). There is no default value.
- stopBits: The number of stop bits to send after each character. Valid values are 1 and 2. There is no default value.
- mode: The flow control mode to use during handshaking. Valid values are X (XON/XOFF), D (DTR/DSR), R (RTS), and M (DTR/DSR XON/XOFF). There is no default value.
- protocol: The communication protocol to use. Valid values are A (ACK/NAK), N (none), and Z (reserved). There is no default value.
Example (common usage): ^SC19200,8,N,1,X,A
Example (full usage): ^SC19200,8,N,1,X,A
~SD darkness
Configures the print darkness level. The darkness level can also be modified using the ^MD command.
Parameters:
- darkness: The print darkness level. Any number between 0 and 30 may be used. Higher numbers result in darker print output. The default value is the previously configured value.
Example (common usage): ~SD15
Example (full usage): ~SD15
^SE path
Selects a custom encoding table, required by some fonts in order to correctly map characters to glyphs.
Parameters:
- path: The file path to load the encoding table from. The file must use the .DAT extension. There is no default value.
Example (common usage): ^SER:CUSTOM.DAT
Example (full usage): ^SER:CUSTOM.DAT
^SF mask, increment
Configures the current field data to increment automatically. The number of labels (and increments) is controlled by the ^PQ command.
Parameters:
- mask: The mask to apply to the field data when determining how to increment it. Must match the starting value specified in the ^FD command. Valid characters are D (representing decimal numbers), H (representing hexadecimal numbers), O (representing octal numbers), A (representing ASCII letters), N (representing alphanumeric ASCII characters), and % (representing ignored characters). There is no default value.
- increment: The increment to apply to the field data for each additional label. The default value is 1.
Example (common usage): ^SFDDD
Example (full usage): ^SFDDD,1
^SI setting, value
Configures the media sensor intensity.
Parameters:
- setting: The specific setting to configure. Valid values are 1 (brightness) and 2 (baseline). There is no default value.
- value: The intensity value. Any number between 0 and 196 may be used. There is no default value.
Example (common usage): ^SI2,100
Example (full usage): ^SI2,100
^SL mode, language
Configures the real-time clock mode and language.
Parameters:
- mode: The clock mode. Valid values are S (use time at start of ZPL parsing), T (use time at start of print queueing), or any number between 1 and 999 (use time at last clock tick, using the specified clock resolution, in seconds).
- language: The language to use to localize date/time field data. Valid values are 1 (English), 2 (Spanish), 3 (French), 4 (German), 5 (Italian), 6 (Norwegian), 7 (Portuguese), 8 (Swedish), 9 (Danish), 10 (Spanish), 11 (Dutch), 12 (Finnish), 13 (Japanese), 14 (Korean), 15 (Simplified Chinese), 16 (Traditional Chinese), 17 (Russian), 18 (Polish), 19 (Czech), and 20 (Romanian). The default value is the previously configured value, or the control panel language if no value was previously configured.
Example (common usage): ^SLT,2
Example (full usage): ^SLT,2
^SN start, increment, pad
Configures the current field data as a serially-incrementing number. The number of labels (and increments) is controlled by the ^PQ command.
Parameters:
- start: The starting number. The default value is 1.
- increment: The increment (or decrement) to apply to the field data for each additional label. Any number, positive or negative, containing up to 12 digits, may be used. The default value is 1.
- pad: Whether or not to pad the numbers with zeroes to match the original start number width. Valid values are Y (pad with zeroes) and N (do not pad with zeroes. The default value is N (do not pad with zeroes).
Example (common usage): ^SN0001,1,Y
Example (full usage): ^SN0001,1,Y
^SO clock, months, days, years, hours, minutes, seconds
Sets the time offset of the secondary or tertiary clock, if the printer has a clock. To set the primary clock, use the ^ST command instead.
Parameters:
- clock: The clock to modify. Valid values are 2 (secondary) and 3 (tertiary). There is no default value.
- months: The months offset. Any number between -32,000 and 32,000 may be used. The default value is 0.
- days: The days offset. Any number between -32,000 and 32,000 may be used. The default value is 0.
- years: The years offset. Any number between -32,000 and 32,000 may be used. The default value is 0.
- hours: The hours offset. Any number between -32,000 and 32,000 may be used. The default value is 0.
- minutes: The minutes offset. Any number between -32,000 and 32,000 may be used. The default value is 0.
- seconds: The seconds offset. Any number between -32,000 and 32,000 may be used. The default value is 0.
Example (common usage): ^SO2,,1
Example (full usage): ^SO2,1,1,1,1,1,1
^SP row
Starts the printing process for a segment of the label before the full label definition has been processed. This command should only be used on particularly complex labels, and only in particularly time-sensitive scenarios.
Parameters:
- row: The dot row number at which to start printing the current label segment. Any number between 0 and 32,000 may be used. The default value is 0.
Example (common usage): ^SP600
Example (full usage): ^SP600
^SQ condition, destination, stop
Stops and starts error alerts configured previously with the ^SX command.
Parameters:
- condition: The error condition for the alert to stop or start. Valid values are the letters A through W (for individual errors) and * (for all errors).
- destination: The destination of the alert to stop or start. Valid values are A (serial port), B (parallel port), C (email), D (TCP), E (UDP), F (SNMP) and * (all destinations).
- stop: Whether to stop or start the alert. Valid values are Y (stop the alerts) and N (start the alerts). The default value is Y (stop the alerts).
Example (common usage): ^SQ*,*,Y
Example (full usage): ^SQ*,*,Y
^SR resistance
Sets the printhead resistance. This command should be used with care, as safe limits are hardware-specific.
Parameters:
- resistance: The printhead resistance. Any number between 488 and 1175 may be used. The default value is the previously configured value.
Example (common usage): ^SR500
Example (full usage): ^SR500
^SS web, media, ribbon, length, int1, int2, sense, mediaSense, ledSense
Configures the media sensor thresholds.
Parameters:
- web: The web sensor threshold. Any number between 0 and 100 may be used. The default value is the auto-calibrated value.
- media: The media sensor threshold. Any number between 0 and 100 may be used. The default value is the auto-calibrated value.
- ribbon: The ribbon sensor threshold. Any number between 0 and 100 may be used. The default value is the auto-calibrated value.
- length: The label length, in dots. Any number between 1 and 32,000 may be used. The default value is the auto-calibrated value.
- int1: The media LED intensity. Any number between 0 and 255 may be used. The default value is the auto-calibrated value.
- int2: The ribbon LED intensity. Any number between 0 and 255 may be used. The default value is the auto-calibrated value.
- sense: The black mark sensor threshold. Any number between 0 and 100 may be used. The default value is the auto-calibrated value.
- mediaSense: The media black mark sensor threshold. Any number between 0 and 100 may be used. The default value is the auto-calibrated value.
- ledSense: The black mark sensor LED intensity. Any number between 0 and 255 may be used. The default value is the auto-calibrated value.
Example (common usage): ^SS50,80,70
Example (full usage): ^SS50,80,70,1800,150,150,70,30,150
^ST month, day, year, hour, minute, second, format
Sets the primary clock date and time, if the printer has a clock.
Parameters:
- month: The month. Any number between 1 and 12 may be used. The default value is the current month.
- day: The day. Any number between 1 and 31 may be used. The default value is the current day.
- year: The year. Any number between 1998 and 2097 may be used. The default value is the current year.
- hour: The hour. Any number between 0 and 23 may be used. The default value is the current hour.
- minute: The minute. Any number between 0 and 59 may be used. The default value is the current minute.
- second: The second. Any number between 0 and 59 may be used. The default value is the current second.
- format: The hour format that was used in the fourth parameter. Valid values are A (AM), P (PM) and M (military). The default value is M (military).
Example (common usage): ^ST11,12,2023,22,50,00,M
Example (full usage): ^ST11,12,2023,22,50,00,M
^SX condition, destination, set, clear, setting, port
Configures error alerts.
Parameters:
- condition: The error condition for the alert to configure. Valid values are the letters A through W (for individual errors) and * (for all errors).
- destination: The destination of the alert to configure. Valid values are A (serial port), B (parallel port), C (email), D (TCP), E (UDP) and F (SNMP).
- set: Whether or not to alert on set. Valid values are Y (alert on set) and N (do not alert on set). The default value is the previously configured value.
- clear: Whether or not to alert on clear. Valid values are Y (alert on clear) and N (do not alert on clear). The default value is the previously configured value.
- setting: Destination details, depending on the destination type configured: an email address, or an IP address, or an SNMP trap.
- port: Destination port, depending on the destination type configured: a TCP port number, or a UDP port number.
Example (common usage): ^SX*,A,Y,Y
Example (full usage): ^SX*,D,Y,Y,12.34.56.78,8181
^SZ version
Sets the ZPL version.
Parameters:
- version: The ZPL version. Valid values are 1 (ZPL) and 2 (ZPL II). Use of the value 1 (ZPL) is highly discouraged. The default value is 2 (ZPL II).
Example (common usage): ^SZ2
Example (full usage): ^SZ2
~TA adjustment
Adjusts the label tear-off position.
Parameters:
- adjustment: The tear-off position adjustment, in dots. Any number between -120 and 120 may be used. The default value is the previously configured value, or 0 if no value was previously configured.
Example (common usage): ~TA50
Example (full usage): ~TA50
^TB orientation, maxWidth, maxHeight
Formats the current field as a text block which wraps text across multiple lines.
Parameters:
- orientation: The text block orientation to use. Valid values are N (no rotation), R (rotate 90° clockwise), I (rotate 180° clockwise), and B (rotate 270° clockwise). The default value is the orientation configured via the ^A or ^FW command, which itself defaults to N (no rotation).
- maxWidth: The maximum text block width, in dots. Text longer than this width is wrapped to another line. Any number between 1 and the label width may be used. The default value is 1, which is rarely useful.
- maxHeight: The maximum text block height, in dots. Any text which exceeds this limit is truncated. Any number between 1 and the label height may be used. The default value is 1, which is rarely useful.
Example (common usage): ^TB,500,300
Example (full usage): ^TBN,500,300
^TO from, to
Copies one or more files in printer memory from one location to another.
Parameters:
- from: The file path(s) to copy the file(s) from. Wildcards (*, ?) are accepted.
- to: The file path(s) to copy the file(s) to. Wildcards (*, ?) are accepted.
Example (common usage): ^TOR:ORIG.GRF,B:NEW.GRF
Example (full usage): ^TOR:ORIG.GRF,B:NEW.GRF
^WA receive, transmit
Configures the wireless antenna used to receive and transmit data.
Parameters:
- receive: The antenna used to receive data. Valid values are L (left), R (right) and D (dynamic). The default value is D (dynamic).
- transmit: The antenna used to transmit data. Valid values are L (left), R (right) and D (dynamic). The default value is D (dynamic).
Example (common usage): ^WAD,D
Example (full usage): ^WAD,D
~WC
Prints a printer configuration label.
Example (common usage): ~WC
Example (full usage): ~WC
^WD path
Prints a directory label, listing all files matching the specified path.
Parameters:
- path: The file path pattern used to search for files to include in the file listing. Wildcards (*, ?) are accepted. The default value is R:*.* which includes all files on the R drive.
Example (common usage): ^WDR:*.*
Example (full usage): ^WDR:*.*
^WE mode, index, authType, keyType, key1, key2, key3, key4
Configures the WEP wireless network security settings. Note that WEP is no longer considered secure, and the ^WX command is generally preferred over this command.
Parameters:
- mode: The encryption mode. Valid values are 40 (40-bit encryption), 128 (128-bit encryption) and OFF (no encryption). The default value is OFF (no encryption).
- index: The encryption key to use. Any number between 1 and 4 may be used. The default value is 1 (encryption key number 1).
- authType: The authentication type to use. Valid values are O (open system) and S (shared key). The default value is O (open system).
- keyType: They key type used in the following four parameters. Valid values are H (hexadecimal) and S (alphanumeric string). The default value is H (hexadecimal).
- key1: Encryption key number 1. Must be 10 characters if mode is 40, or 26 characters if mode is 128. There is no default value.
- key2: Encryption key number 2. Must be 10 characters if mode is 40, or 26 characters if mode is 128. There is no default value.
- key3: Encryption key number 3. Must be 10 characters if mode is 40, or 26 characters if mode is 128. There is no default value.
- key4: Encryption key number 4. Must be 10 characters if mode is 40, or 26 characters if mode is 128. There is no default value.
Example (common usage): ^WE40,1,O,H,1234567890
Example (full usage): ^WE40,1,O,H,1234567890,1234567890,1234567890,1234567890
^WF retries, motion, protect, format, type
Writes an AFI or DSFID byte to an RFID tag. AFI codes are assigned to specific organizations or functions, and allow for tag selection across the air interface. DSFID codes indicate the expected structure of the data encoded in the RFID tag. The actual byte value encoded is provided in a subsequent ^FD command.
Parameters:
- retries: The number of times to retry the write operation, if necessary. Any number between 0 and 10 may be used. The default value is 0.
- motion: The post-write label motion. Valid values are 0 (feed label) and 1 (no feed). The default value is 0 (feed label).
- protect: Whether or not to write-protect the data. Valid values are 0 (not protected) and 1 (protected). The default value is 0 (not protected).
- format: The data format to expect. Valid values are 0 (one ASCII character) and 1 (two hexadecimal digits). The default value is 0 (one ASCII character).
- type: The type of identifier byte to write. Valid values are A (AFI byte) and D (DSFID byte). The default value is A (AFI byte).
Example (common usage): ^WF2
Example (full usage): ^WF2,1,0,1,D
^WI res, ip, mask, gateway, wins, timeout, secs, arp, port
Configures the wireless network settings. Note that the ^ND command should be used instead, if possible.
Parameters:
- res: The IP resolver to use. Valid values are A (all), B (BOOTP), C (DHCP and BOOTP), D (DHCP), G (gleaning), R (RARP) and P (permanent). The default value is A (all).
- ip: The IP address to use. Any valid IP address in dot-decimal notation may be used. There is no default value.
- mask: The subnet mask to use. Any valid subnet mask in dot-decimal notation may be used. There is no default value.
- gateway: The default network gateway. Any valid IP address in dot-decimal notation may be used. There is no default value.
- wins: The WINS server IP address. Any valid IP address in dot-decimal notation may be used. There is no default value.
- timeout: Whether or not to enable a connection timeout. Valid values are Y (enable) and N (disable). The default value is Y (enable).
- secs: The network connection timeout, in seconds. Any number between 0 and 9,999 may be used. The default value is 300.
- arp: The ARP broadcast interval, in minutes. Any number between 0 and 30 may be used. The default value is 0 (no ARP broadcast).
- port: The port number to use for RAW data. Any number between 1 and 65,535 may be used. The default value is 9100.
Example (common usage): ^WI,,255.255.255.0,192.168.0.1
Example (full usage): ^WIA,192.168.0.100,255.255.255.0,192.168.0.1,192.168.0.10,Y,300,0,9100
^WL mode, username, password
Configures the LEAP wireless network security settings. Note that LEAP is no longer considered secure, and the ^WX command is generally preferred over this command.
Parameters:
- mode: Whether or not to enable LEAP. Valid values are ON (enable) and OFF (disable). The default value is OFF (disable).
- username: The LEAP username. Up to 32 alphanumeric characters may be used. The default value is 'user'.
- password: The LEAP password. Up to 32 alphanumeric characters may be used. The default value is 'password'.
Example (common usage): ^WLON,USER123,4T9UB2AZP2
Example (full usage): ^WLON,USER123,4T9UB2AZP2
~WL
Prints a network configuration label.
Example (common usage): ~WL
Example (full usage): ~WL
^WP oldPassword, newPassword
Sets the four-digit wireless password, which protects wireless settings from being viewed or modified through the control panel. If set to 0000, the protection is disabled.
Parameters:
- oldPassword: The old wireless password. Any number between 0000 and 9999 may be used. The default value is 0000.
- newPassword: The new wireless password. Any number between 0000 and 9999 may be used. The default value is 0000.
Example (common usage): ^WP1234,7890
Example (full usage): ^WP1234,7890
~WQ query
Prints a diagnostic label, the content of which depends on the query provided.
Parameters:
- query: The type of diagnostic label to print. Valid values are ES (error status), HA (internal wired print server hardware address), JT (printhead test results), MA (maintenance alert settings), MI (maintenance information), OD (odometer), PH (printhead history), PP (plug and play string), SN (serial number) and UI (USB product ID). There is no default value.
Example (common usage): ~WQSN
Example (full usage): ~WQSN
^WR rate1, rate2, rate55, rate11, power
Configures the wireless network transmission rate.
Parameters:
- rate1: The 1 Mb/s transmission rate. Valid values are Y (enable) and N (disable). There is no default value.
- rate2: The 2 Mb/s transmission rate. Valid values are Y (enable) and N (disable). There is no default value.
- rate55: The 5.5 Mb/s transmission rate. Valid values are Y (enable) and N (disable). There is no default value.
- rate11: The 11 Mb/s transmission rate. Valid values are Y (enable) and N (disable). There is no default value.
- power: The wireless radio transmit power, in mW. Valid values are 1, 5, 20, 30, 50 and 100. There is no default value.
Example (common usage): ^WRY,Y,Y,Y,50
Example (full usage): ^WRY,Y,Y,Y,50
~WR
Resets the wireless radio card and the print server.
Example (common usage): ~WR
Example (full usage): ~WR
^WS essid, mode, preamble, pulse, interval, mask, international
Configures the wireless radio card.
Parameters:
- essid: The ESSID, or network name. Up to 32 characters may be used. The default value is the previously-configured ESSID.
- mode: The operating mode. Valid values are I (infrastructure, i.e. connect through a central access point) and A (ad hoc, i.e. peer-to-peer connectivity). The default value is I (infrastructure).
- preamble: The preamble size. Valid values are S (short) and L (long). The default value is L (long).
- pulse: Enables or disables a wireless pulse, which can sometimes help to keep the printer connected to the network. Valid values are 0 (disabled) and 1 (enabled). The default value is 1 (enabled).
- interval: The wireless pulse interval in seconds, if the pulse is enabled. Any number between 5 and 300 may be used. The default value is 15.
- mask: The channel mask, in hexadecimal 0xHHHH format. The default value is 0x07FF, which is the standard mask for North America. Other regions use other masks (e.g. 0x3FFF in Japan and 0x1FFF in Europe).
- international: Whether or not to operate in international mode, where the printer allows the access point to set the channel. Valid values are 0 (disabled) and 1 (enabled). The default value is 0 (disabled).
Example (common usage): ^WSBUILDING2
Example (full usage): ^WSBUILDING2,I,L,1,20,0x07FF,0
^WT block, retries, motion, protect, format, verify
Writes data to an RFID tag. The actual value encoded is provided in a subsequent ^FD command. Note that use of this command is not encouraged, and the ^RF command is generally preferred over this command.
Parameters:
- block: The block number. Any number between 0 and N may be used, where N is the number of blocks in the RFID tag. The default value is 0.
- retries: The number of times to retry the write operation, if necessary. Any number between 0 and 10 may be used. The default value is 0.
- motion: The post-write label motion. Valid values are 0 (feed label) and 1 (no feed). The default value is 0 (feed label).
- protect: Whether or not to write-protect the data. Valid values are 0 (not protected) and 1 (protected). The default value is 0 (not protected).
- format: The data format to expect. Valid values are 0 (ASCII characters) and 1 (hexadecimal digits). The default value is 0 (ASCII characters).
- verify: Whether or not to verify the RFID tag before writing. Valid values are Y (verify) and N (do not verify). The default value is N (do not verify).
Example (common usage): ^WT,2
Example (full usage): ^WT0,2,1,0,0,N
^WV enable
Configures whether or not to verify the RFID tag before writing to it.
Parameters:
- enable: Whether or not to verify the RFID tag before writing to it. Valid values are Y (verify) and N (do not verify). The default value is N (do not verify).
Example (common usage): ^WVY
Example (full usage): ^WVY
^WX securityType, parameters
Configures the wireless network security. Note that WEP (types 02 and 03) and LEAP (types 08 and 14) are no longer considered secure.
Parameters:
- securityType: The security type to configure. Valid values are 01 (no wireless security), 02 (40-bit WEP), 03 (128-bit WEP), 04 (EAP-TLS), 05 (EAP-TTLS), 06 (EAP-FAST), 07 (PEAP), 08 (LEAP), 09 (WPA PSK), 10 (WPA EAP-TLS), 11 (WPA EAP-TTLS), 12 (WPA EAP-FAST), 13 (WPA PEAP), 14 (WPA LEAP) and 15 (Kerberos). The default value is 01 (no wireless security).
- parameters: A variable number of parameters, depending on the security type chosen. See your printer's documentation for more information.
Example (common usage): ^WX10,4TXB109Y8
Example (full usage): ^WX10,4TXB109Y8
^XA
Begins a label definition. All label definitions must start with this command.
Example (common usage): ^XA
Example (full usage): ^XA
^XB
Disables forward feed / back feed after the current label.
Example (common usage): ^XB
Example (full usage): ^XB
^XF path
Loads a label definition previously saved via the ^DF command. The ^FN command can then be used to add variable data to previously-defined fields, based on their field numbers.
Parameters:
- path: The file path to load the label definition from. The default value is R:UNKNOWN.ZPL.
Example (common usage): ^XFR:LABEL.ZPL
Example (full usage): ^XFR:LABEL.ZPL
^XG path, magnificationX, magnificationY
Configures the current field as an image graphics field.
Parameters:
- path: The path to the image graphics file. The default value is R:UNKNOWN.GRF.
- magnificationX: The horizontal magnification to apply to the image. Any number between 1 and 10 may be used. The default value is 1.
- magnificationY: The vertical magnification to apply to the image. Any number between 1 and 10 may be used. The default value is 1.
Example (common usage): ^XGR:IMAGE.GRF
Example (full usage): ^XGR:IMAGE.GRF,2,2
^XS length, threshold, gain
Enables and disables dynamic media calibration.
Parameters:
- length: Whether or not to dynamically calibrate label length. Valid values are Y (enable dynamic label length calibration) and N (disable dynamic label length calibration). The default value is Y (enable dynamic label length calibration).
- threshold: Whether or not to dynamically calibrate label threshold. Valid values are Y (enable dynamic label threshold calibration) and N (disable dynamic label threshold calibration). The default value is Y (enable dynamic label threshold calibration).
- gain: Whether or not to dynamically calibrate label gain. Valid values are Y (enable dynamic label gain calibration) and N (disable dynamic label gain calibration). The default value is Y (enable dynamic label gain calibration).
Example (common usage): ^XS
Example (full usage): ^XSY,Y,Y
^XZ
Ends a label definition. All label definitions must end with this command.
Example (common usage): ^XZ
Example (full usage): ^XZ
^ZZ seconds, immediate
Places the printer in sleep mode.
Parameters:
- seconds: The number of seconds to wait until shutdown. Any number between 0 and 999,999 may be used. The default value is the previously configured value, or 0 if no value was previously configured.
- immediate: Whether or not to sleep immediately. Valid values are Y (sleep immediately, even if labels are still queued for printing) and N (wait until all pending labels have been printed before sleeping). The default value is N (wait until all pending labels have been printed).
Example (common usage): ^ZZ60
Example (full usage): ^ZZ60,N