Software Developer's Manual P-touch Template Command Reference QL-810W/820NWB Version 1.
The Brother logo is a registered trademark of Brother Industries, Ltd. Brother is a registered trademark of Brother Industries, Ltd. © 2017 Brother Industries, Ltd. All rights reserved. The Bluetooth word mark and logos are owned by the Bluetooth SIG, Inc. and, any use of such marks by Brother Industries, Ltd. is under license. BarStar Pro Encode Library (DataMatrix, MaxiCode, PDF417, RSS, CODE93, POSTNET, MSI/Plessey, AZTEC, GS1 DataBar Composite) Copyright (c) 2007 AINIX Corporation. All rights reserved.
IMPORTANT - PLEASE READ CAREFULLY Note This documentation (“Documentation”) gives you information that will assist you in controlling your Printer QL-8XX (where “8XX” is the model name). You may use the Documentation only if you first agree to the following conditions. If you do not agree to the following conditions, you may not use the Documentation. Condition of Use You may use and reproduce the Documentation to the extent necessary for your own use of your Printer Model (“Purpose”).
P-touch Template Command Reference Contents Introduction ······························································································· 1 What is P-touch Template? ········································································· 2 1. Using P-touch Template ·········································································· 3 2. P-touch Template Settings Tool User’s Guide ··········································· 4 3.
P-touch Template Command Reference ^II ^OP ^SR ^VR ^CR ^OS ^ON ^DI ESC i a ESC iXT2 ESC iXP2 ESC iXr2 ESC iXD2 ESC iXa2 ESC iXi2 ESC iXn2 ESC iXf2 ESC iXc2 ESC iXy2 ESC iXm2 ESC iXj2 ESC iXR2 ESC iXC2 ESC iXN2 ESC iXF2 ESC iXq2 ESC iXT1 ESC iXP1 ESC iXr1 ESC iXD1 ESC iXa1 ESC iXi1 ESC iXn1 ESC iXc1 ESC iXy1 ESC iXm1 ESC iXj1 ESC iXf1 ESC iXR1 ESC iXC1 ESC iXN1 ESC iXF1 ESC iXq1 Initialize ..................................................................................................
P-touch Template Command Reference Introduction This material provides the necessary information for directly controlling the templates transferred to QL-8XX. This information is provided assuming that the user has full understanding of the operating system being used and basic mastery of programming in a developer's environment. Read the model names that appear in the screens in this manual as the name of your printer.
P-touch Template Command Reference What is P-touch Template? P-touch Template helps the user develop a printing system that connects directly from the host and has following functions: transfers the template data from P-touch Editor to the printer (2) transfers the ASCII text and binary data from a host to the template in the printer (3) (“Host” includes medias such as barcode readers, scales or medical devices.) prints the transferred data (3) (See the figure shown below.) 1.
P-touch Template Command Reference 1. Using P-touch Template (1) Specify the printer settings. Using the P-touch Template Settings tool, specify the initial printer settings according to the host system environment or the host that the printer is connected to. (Please refer to “2. P-touch Template Settings Tool User’s Guide” on page 4.) The printer driver must first be installed via a USB connection. (2) Design the template. Using P-touch Editor, design the template to be transferred to the printer.
P-touch Template Command Reference 2.
P-touch Template Command Reference (1) Command mode setting - P-touch Template mode (fixed) To use P-touch Template, select the P-touch Template mode. (2) Template number setting Specify the template number selected as the default when the printer is turned on. However, if any template has been set to not be transferred to the printer, the number of that template cannot be specified.
P-touch Template Command Reference (8) International character set setting Select one of the following countries for the character set. - USA - France - Germany - Britain - Denmark I - Sweden - Italy - Spain I - Japan - Norway - Denmark II - Spain II - Latin America - South Korea - Legal The following 12 codes are switched depending on the country selected from those listed above.
P-touch Template Command Reference (12) FNC1 replacement setting This setting selects whether or not GS codes, which are included in barcode protocols such as GS1-128 (UCC/EAN-128), are replaced with FNC1 codes. If the check box is selected, a received GS code is replaced with the FNC1 code. If the check box is cleared, a received GS code is outputted as is. (13) Number of copies setting Specify the number of copies. A number between 1 and 99 can be specified.
P-touch Template Command Reference Others · ini file After the [Set] button (in the main dialog box or the Communications Settings dialog box) is clicked, the settings are saved when the dialog box is closed. C:\Documents and Settings\(user_account_name)\Application Data\Brother \Printer Settings\PtsXX34.ini Note: A name of file “ptsXX24.ini” varies depending on printers like below. - QL-810 pts3934.ini - QL-820 pts4134.ini Note: A file path above might be different depending on OS.
P-touch Template Command Reference 3. Examples for Using Commands 3.1 Example for using P-touch Template Here is the label that will be made. 2.4 inches width continuous label is to be used. Steps 1. Make a template with P-touch Editor. 2. Transfer the template to Transfer Manager. 3. Transfer the template from Transfer Manager to the printer. 4. Use P-touch Template commands for printing. Step 1: Make a template with P-touch Editor. Start the P-touch Editor and make a label. -9- 3.
P-touch Template Command Reference Step 2: Transfer the template to Transfer Manager. The template sent in step 2 is stored in Transfer Manager, as shown below. Assigned number Stored template Step 3: Transfer the template from Transfer Manager to the printer. Click [Transfer] button. - 10 - 3.
P-touch Template Command Reference Note Make sure that the printer is turned on and hooked up to the PC with a USB cable before using Transfer Manager. Also, make sure that the printer communication setting is always bidirectional communication when Transfer Manager is used. When the template is transferred to the printer, the following message appears. Step 4: Use P-touch Template commands for printing. When using P-touch Template commands, at least these four commands are required.
P-touch Template Command Reference (3) Initialize P-touch Template Entered command ^II (4) Print Start Entered command ^FF When the printer receives the command above, the label below is printed. - 12 - 3.
P-touch Template Command Reference 3.2 Example for printing logo/external characters in P-touch Template Here is the label to be printed. Steps 1. Make a template and transfer it to the printer. 2. Store the logo/external characters as a bitmap file. 3. Transfer the bitmap file from Transfer Manager to the printer. 4. In the P-touch Template Settings tool, select the assigned number for the stored template. 5. With the P-touch Template commands, select the assigned number for the bitmap file.
P-touch Template Command Reference Step 2: Store the loge/external characters as a bitmap file. The file name should be started from “_ext_”,, and drag & drop it to Transfer Manager. Example file name is “_ext_logo.bmp” Step 3: Transfer the bitmap file from Transfer Manager to the printer. Please assign a number between 1 and 99 for the [Key Assign] column, as the "bitmap file selection" described in step 5 only supports values up to 99. Assigned number Click[Transfer] button. - 14 - 3.
P-touch Template Command Reference Step 4: In the P-touch Template Settings tool, select the assigned number for the stored template. (1) Select the P-touch Template mode. (2) Choose the assigned number. - 15 - 3.
P-touch Template Command Reference Step 5: With the P-touch Template commands, select the assigned number for the bitmap file. After using the P-touch Template Settings tool in Step 4, the remaining three commands must be sent to the printer. (1) Initialize P-touch Template Entered command ^II (2) Select the bitmap file to be printed. In order to select the bitmap file, enter a specific character “\” and the value one less than the assigned number for the Entered command bitmap file that is shown in Ste
P-touch Template Command Reference 4. P-touch Template Limitations 4.1 Relating to text objects 4.1.1 Font, size, etc. Please also refer to “5.1 Relationship between the P-touch Editor settings and the printer image” on page 25. Fonts specified in P-touch Editor are converted to Helsinki, Letter Gothic or Brussels, depending on the font shape, when the data is sent to the printer. The font is converted according to the following rules: fixed pitch: Letter Gothic; serif: Brussels; san serif: Helsinki.
P-touch Template Command Reference 4.1.2 Character alignment Horizontal alignment settings (“Justify” or “Equal Length”) specified in P-touch Editor are changed to the left alignment setting. The setting for line feed with a line feed specified with the P-touch Editor can be set between 0 and 255 dots. A negative line spacing setting cannot be used in P-touch Editor.
P-touch Template Command Reference 4.1.3 Text Layout settings Character styles specified in P-touch Editor all become the same style within an object. If the “Long Text” setting is selected under “Text Layout” in P-touch Editor, the vertical alignment setting is normally set for top alignment. If continuous length tape is used, the print length is increased to fit the text depending on the setting. (Refer to “5.
P-touch Template Command Reference 4.2 Relating to barcodes 4.2.1 Barcodes When trying to transfer a template containing a barcode that is not compatible with the printer, an error will occur while transferring and the template cannot be transferred to the printer. The following barcodes are compatible with the QL-8XX.
P-touch Template Command Reference 4.2.2 1D barcodes The ratio setting for 1D barcodes specified in P-touch Editor is invalid. Normally, this is fixed at 3:1. A barcode wider than 22.5 cm will not be printed. A 1D barcode taller than 99 mm is converted to 99 mm. The number of characters that can be entered for each protocol is shown below. CODE39 ITF I-2/5 1 to 50 characters (not including “*” on both sides) When feeding data, the asterisks (*) at the beginning and end of the data are skipped.
P-touch Template Command Reference 4.2.3 2D barcodes QR Code The version setting for a QR Code specified in P-touch Editor is invalid. The version setting must be turned off. The Structured Append settings specified in P-touch Editor are invalid. If the value specified with the QR Code version command is outside of the allowable range, it is changed to AUTO.
P-touch Template Command Reference 4.3 Relating to images If a template containing overlapping images is transferred with P-touch Editor, all image data will be overlapping. (P-touch Editor displays the image created last on top.) 4.4 Relating to Numbering A single template can contain a maximum of 9 valid Numbering objects. Numbering will not be performed for Numbering objects that exceed the maximum of 9. A single object contains a single Numbering field.
P-touch Template Command Reference 4.6 Others 4.6.1 Transferring templates Up to 99 (for QL-810W), up to 255 (for QL-820NWB) templates can be transferred. The transfer cannot be completed if the amount of data being transferred exceeds 6MB. A single template can contain a maximum of 50 objects. If trying 51 or more objects, an error will occur and the transfer cannot be completed. When print data is fed, the command mode should be the P-touch Template mode.
P-touch Template Command Reference 5. Precautions 5.1 Relationship between the P-touch Editor settings and the printer image P-touch Editor setting Text options (Text Layout settings) Text Layout DetailsOptions Wrap Text Printer image Width Frame Size Text Size Fixed If the text is too long, the overflow Clip Text Height Frame Size Fixed Frame Size (Wrap) Long Text Text Size Fixed Fixed If the text is too long, the overflow text is not printed. Fixed 1 (See below.
P-touch Template Command Reference 5.2 Making a template in order to save time before starting to print Perform the following operation to convert permanent objects into images. - In the Text Properties dialog box, select the Expanded tab, and then select the “Text Cannot Be Edited” check box. - If the Expanded tab of the Text Properties dialog box is not displayed, click [Options] on the Tools menu, and then select the “Display Expanded Tabs of Object Properties” check box on the General tab.
P-touch Template Command Reference 6. Control Code Lists 6.
P-touch Template Command Reference 6.
P-touch Template Command Reference (continued from the previous page) ASCII Code Binary Code Static/Dynamic Description ESC iXC1 1B 69 58 43 31 Retrieve number of copies setting ESC iXN1 1B 69 58 4E 31 Retrieve number of Numbering copies setting ESC iXF1 1B 69 58 46 31 Retrieve FNC1 replacement setting ESC iXq1 1B 69 58 71 31 Retrieve print options Note * The commands listed above must be used in raster mode.
P-touch Template Command Reference 7. Control Command Details ^PT Select print start trigger ASCII: ^ P T n Decimal: 94 80 84 n Hexadecimal: 5E 50 54 n Parameters 1≤n≤3 Description Selects the type of print start trigger. n=1: When the specified text string is received (default) n=2: When all objects are filled (Prints with the delimiter at the end of the data.) n=3: When the specified number of characters is received (not including delimiters) This command is a dynamic command.
P-touch Template Command Reference ^FF Start printing ASCII: ^ F F Decimal: 94 70 70 Hexadecimal: 5E 46 46 Parameters None Description Starts printing. However, the print start trigger must be “when the specified text string is received”. (Refer to “^PT” and “ESC iXT2”.) The text string for the print start command can be changed. (Refer to “^PS” and “ESC iXP2”.) Example To print template number 3: ^TS003^FF (5Eh 54h 53h 30h 30h 33h 5Eh 46h 46h) - 31 - 7.
P-touch Template Command Reference ^PS Specify print start command text string ASCII: ^ P S n1 n2 data Decimal: 94 80 83 n1 n2 data Hexadecimal: 5E 50 53 n1 n2 data Parameters 0≤n1≤2 0≤n2≤9 00h≤data≤FFh Description Specifies the text string for the print start command. (n1*10)+n2: Length of the text string (can be set between 1 and 20) data: Text string (The maximum number of characters that can be set is 20 characters (bytes).
P-touch Template Command Reference ^PC Specify print start received character count ASCII: ^ P C n1 n2 n3 Decimal: 94 80 67 n1 n2 n3 Hexadecimal: 5E 50 43 n1 n2 n3 Parameters 0≤n1≤9 0≤n2≤9 0≤n3≤9 Description Specifies the number of characters to be received in order to start printing. (n1*100)+(n2*10)+n3: Print start received character count (bytes) (1 to 999) The default print start received character count is 10. This command is a dynamic command.
P-touch Template Command Reference ^SS Specify delimiter ASCII: ^ S S n1 n2 data Decimal: 94 83 83 n1 n2 data Hexadecimal: 5E 53 53 n1 n2 data Parameters 0≤n1≤2 0≤n2≤9 00h≤data≤FFh Description The delimiter is used to indicate when to move to the next object in data that is being sent. Specifies the text string for the delimiter. (n1*10)+n2: Length of the text string (between 1 and 20) data: Text string (The maximum number of characters that can be set is 20 characters (bytes).
P-touch Template Command Reference ^TS Select template ASCII: ^ T S n1 n2 n3 Decimal: 94 84 83 n1 n2 n3 Hexadecimal: 5E 54 53 n1 n2 n3 Parameters n1: 0 (Fixed) 0≤n2≤9 0≤n3≤9 Description Specifies the number of the template selected from the printer. (n2*10)+n3: Template number (1 to 99) The default selection number is 1. This command is a dynamic command. Remarks The template numbers that can be set are between 1 and 99.
P-touch Template Command Reference ^CO Select printer settings (cut options) ASCII: ^ C O n1 n2 n3 n4 Decimal: 94 67 79 n1 n2 n3 n4 Hexadecimal: 5E 43 4F n1 n2 n3 n4 Parameters 0≤n1≤1 0≤n2≤9 0≤n3≤9 0≤n4≤1 Description Specifies the various cut options. n1: Auto cut setting (ON: 1 (default); OFF: 0) (n2*10)+n3: Auto cut label number setting (1 to 99) (Default value: 1) n4: Cut at end setting (ON: 1 (default); OFF: 0) This command is a dynamic command.
P-touch Template Command Reference ^LS Specify line spacing with line feed ASCII: ^ L S n1 n2 n3 Decimal: 94 76 83 n1 n2 n3 Hexadecimal: 5E 4C 53 n1 n2 n3 Parameters 0≤n1≤2 0≤n2≤9 0≤n3≤9 Description Specifies the number of dots for the line spacing when a line feed is entered.
P-touch Template Command Reference ^CC Change the prefix character ASCII: ^ C C n Decimal: 94 67 67 n Hexadecimal: 5E 43 43 n Parameters 00h≤n≤FFh Description Changes the prefix character code. n: Character code The default text string for the prefix character is “^”. This command is a dynamic command.
P-touch Template Command Reference ^RC Specify line feed command text string ASCII: ^ R C n1 n2 data Decimal: 94 82 67 n1 n2 data Hexadecimal: 5E 52 43 n1 n2 data Parameters 0≤n1≤2 0≤n2≤9 00h≤data≤FFh Description Specifies the text string for the line feed command. (n1*10)+n2: Length of the text string (can be set between 1 and 20) data: Text string (The maximum number of characters that can be set is 20 characters (bytes).) The default text string for the line feed command is “^CR”.
P-touch Template Command Reference ^CN Specify number of copies ASCII: ^ C N n1 n2 n3 Decimal: 94 67 78 n1 n2 n3 Hexadecimal: 5E 43 4E n1 n2 n3 Parameters 0≤n1≤9 0≤n2≤9 0≤n3≤9 Description Specifies the number of copies to be printed. (n1*100)+(n2*10)+n3: Number of copies (bytes) (1 to 999) The default number of copies is 1. This command is a dynamic command.
P-touch Template Command Reference ^NN Specify number of Numbering copies ASCII: ^ N N n1 n2 n3 Decimal: 94 78 78 n1 n2 n3 Hexadecimal: 5E 4E 4E n1 n2 n3 Parameters 0≤n1≤9 0≤n2≤9 0≤n3≤9 Description Specifies the number of copies to be printed with Numbering. (n1*100)+(n2*10)+n3: Number of Numbering copies (bytes) (1 to 999) The default number of copies printed with Numbering is 1.
P-touch Template Command Reference ^QS Select print options ASCII: ^ Q S n Decimal: 94 81 83 n Hexadecimal: 5E 51 53 n Parameters n: 0, 1 Description Selects the print options. n=0: Priority given to print speed n=1: Priority given to print quality The default value for the print options is “0” (priority given to print speed). This command is a dynamic command. Example To set the print options to give priority to print quality: Since n=1, the command will be as follows.
P-touch Template Command Reference ^QV Specify QR Code version ASCII: ^ Q V n1 n2 Decimal: 94 81 86 n1 n2 Hexadecimal: 5E 51 56 n1 n2 Parameters 0≤n1≤9 0≤n2≤9 Description Specifies the QR Code version. (n1*10)+n2: Version number (between 0 and 40) The default QR Code version is 0. This command becomes invalid if a value other than those that can be set (between 0 and 40) has been specified. This command is a dynamic command.
P-touch Template Command Reference ^FC FNC1 replacement setting ASCII: ^ F C n Decimal: 94 70 67 n Hexadecimal: 5E 46 43 n Parameters 0≤n≤1 Description Selects whether or not GS codes, which are included in barcode protocols such as GS1-128 (UCC/EAN-128), are replaced with FNC1 codes. n: FNC1 replacement setting (ON: 1; OFF: 0 (default)) This command is a dynamic command.
P-touch Template Command Reference ^II Initialize ASCII: ^ I I Decimal: 94 73 73 Hexadecimal: 5E 49 49 Parameters None Description Reverts all dynamic settings to the printer settings.
P-touch Template Command Reference ^OP Perform printer operation (feed) ASCII: ^ O P n Decimal: 94 79 80 n Hexadecimal: 5E 4F 50 n Parameters 1≤n≤3 Description Causes the printer to perform a feed operation.
P-touch Template Command Reference ^SR Status request ASCII: ^ S R Decimal: 94 83 82 Hexadecimal: 5E 53 52 Parameters None Description Returns the printer status. The printer status consists of 32 bytes.
P-touch Template Command Reference (1) Error information 1 Flag Mask Definition Bit 0 01h “No media” error Bit 1 02h “End of media” error Bit 2 04h “Cutter jam” error Bit 3 08h Not used Bit 4 10h Printer in use Bit 5 20h Printer turned off Bit 6 40h Not used Bit 7 80h Not used (2) Error information 2 Flag Mask Definition Bit 0 01h “Replace media” error Bit 1 02h “Expansion buffer is full.
P-touch Template Command Reference (5) Battery level information Flag Mask Meaning Bit 0 00h Full battery Bit 1 01h Half battery Bit 2 02h Low battery Bit 3 03h Changing required Bit 4 04h AC adapter in use ^VR Retrieve version information ASCII: ^ V R Decimal: 94 86 82 Hexadecimal: 5E 56 52 Parameters None Description Retrieves the version information for the printer as a 16-character text string. - 49 - 7.
P-touch Template Command Reference ^CR Line feed in object ASCII: ^ C R Decimal: 94 67 82 Hexadecimal: 5E 43 52 Parameters None Description Adds a line feed to the next line in the text object. Valid even if the text string for the line feed command has been changed Example To print three lines: Code: 1 ^ C R 2 ^ C R 3 ^ F F (31h 5Eh 43h 52h 32h 5Eh 43h 52h 33h 5Eh 46h 46h) 1 Print result: 2 3 - 50 - 7.
P-touch Template Command Reference ^OS Select object (object number) ASCII: ^ O S n1 n2 Decimal: 94 79 83 n1 n2 Hexadecimal: 5E 4F 53 n1 n2 Parameters 0≤n1≤5 0≤n2≤9 Description Selects an object by its object number. (n1*10)+n2: Object number (1 to 50) Remarks The object number can be set between 1 and 50. This command becomes invalid if any other value has been specified. Use this command to insert data starting with an intermediary object.
P-touch Template Command Reference ^ON Select object (object name) ASCII: ^ O N data 00 Decimal: 94 79 78 data 00 Hexadecimal: 5E 4F 4E data 00 Parameters None Description Selects an object by its object name. data: Text string (object name) Remarks The maximum length of text that can be set is 20 characters. If text longer than this has been specified, the command becomes invalid. In addition, the command becomes invalid if no text has been specified.
P-touch Template Command Reference ^DI Directly insert object ASCII: ^ D I n1 n2 data Decimal: 94 68 73 n1 n2 data Hexadecimal: 5E 44 49 n1 n2 data Parameters 00h≤n1≤FFh 00h≤n2≤FEh Description Inserts a text string for the specified number of characters into the object selected in the selected template. (Even if a print command or delimiter is within the specified number of characters, they are treated as data.
P-touch Template Command Reference ESC i a Select command mode ASCII: ESC Decimal: 27 Hexadecimal: 1B i a n 105 97 n 69 61 n Parameters n=00h 01h 03h 30h 31h 33h Description Switches the mode. n=00h or 30h: ESC/P mode (default) n=01h or 31h: Raster mode n=03h or 33h: P-touch Template mode This command is a dynamic command. Remarks If the specified value is one other than those that can be set, raster mode will be entered. - 54 - 7.
P-touch Template Command Reference ESC iXT2 Select print start trigger ASCII: ESC Decimal: 27 Hexadecimal: 1B i X T 2 n1 n2 n3 105 88 84 50 n1 n2 n3 69 54 32 n1 n2 n3 58 Parameters n1=01h (Fixed) n2=00h (Fixed) 00h≤n3≤02h Description Selects the type of print start trigger. n3=00h: When the specified text string is received (default) n3=01h: When all objects are filled (Prints with the delimiter at the end of the data.
P-touch Template Command Reference ESC iXP2 Specify print start command text string ASCII: ESC Decimal: 27 Hexadecimal: 1B i X n1 n2 data 105 88 80 50 n1 n2 data 69 50 32 n1 n2 data 58 P 2 Parameters 01h≤n1≤14h n2: 00h (Fixed) 00h≤data≤FFh Description Specifies the text string for the print start command. n1+(n2*256): Length of the text string (can be set between 1 and 20) data: Text string (The maximum number of characters that can be set is 20 characters (bytes).
P-touch Template Command Reference ESC iXr2 Specify print start received character count ASCII: ESC Decimal: 27 Hexadecimal: 1B i X n1 n2 n3 n4 105 88 114 50 n1 n2 n3 n4 69 72 n2 n3 n4 58 r 2 32 n1 Parameters n1: 02h (Fixed) n2: 00h (Fixed) 00h≤n3≤FFh 00h≤n4≤03h Description Specifies the number of characters to be received in order to start printing. n3+(n4*256): Print start received character count (bytes) (1 to 999) The default print start received character count is 10.
P-touch Template Command Reference ESC iXD2 Specify delimiter ASCII: ESC Decimal: 27 Hexadecimal: 1B i X D 2 n1 n2 data 105 88 68 50 n1 n2 data 69 44 32 n1 n2 data 58 Parameters 01h≤n1≤14h n2: 00h (Fixed) 00h≤data≤FFh Description The delimiter is used to indicate when to move to the next object in data that is being sent. Specifies the text string for the delimiter.
P-touch Template Command Reference ESC iXa2 Specify non-printed text strings ASCII: ESC Decimal: 27 Hexadecimal: 1B i X a 2 n1 n2 n3 data 105 88 97 50 n1 n2 n3 data 69 61 32 n1 n2 n3 data 58 Parameters 01h≤n1≤15h n2: 00h (Fixed) n3: 01h (Fixed) 00h≤data≤FFh Description Specifies the non-printed text string. n1+(n2*256): Length of the text string (0 to 20) + 1 data: Text string (The maximum number of characters that can be set is 20 characters (bytes).
P-touch Template Command Reference ESC iXi2 Select command mode ASCII: ESC Decimal: 27 Hexadecimal: 1B i X n1 n2 n3 105 88 105 50 n1 n2 n3 69 69 n2 n3 58 i 2 32 n1 Parameters n1: 01h (Fixed) n2: 00h (Fixed) n3: 00h 01h 03h Description Switches the mode. n3=00h: ESC/P mode (default) n3=01h: Raster mode n3=03h: P-touch Template mode This command is a static command. Remarks Invalid if a value other than those that can be set has been specified - 60 - 7.
P-touch Template Command Reference ESC iXn2 Select template ASCII: ESC Decimal: 27 Hexadecimal: 1B i X n1 n2 n3 105 88 110 50 n1 n2 n3 69 6E n2 n3 58 n 2 32 n1 Parameters n1: 01h (Fixed) n2: 00h (Fixed) 01h≤n3≤63h Description Selects the number of the template selected from the printer. n3: Template number (1 to 99) The default selection number is 1. This command is a static command. Remarks The template numbers that can be set are between 1 and 99.
P-touch Template Command Reference ESC iXf2 Change the prefix character ASCII: ESC Decimal: 27 Hexadecimal: 1B i X n1 n2 n3 105 88 102 50 n1 n2 n3 69 66 n2 n3 58 f 2 32 n1 Parameters n1: 01h (Fixed) n2: 00h (Fixed) 00h≤n3≤FFh Description Changes the prefix character code. n3: Character code The default text string for the prefix character is “^”. This command is a static command.
P-touch Template Command Reference ESC iXc2 Select printer settings (cut options) ASCII: ESC Decimal: 27 Hexadecimal: 1B i X c 2 n1 n2 n3 105 88 99 50 n1 n2 n3 69 63 32 n1 n2 n3 58 Parameters n1: 01h (Fixed) n2: 00h (Fixed) n3: 00h 01h 08h 09h Description Selects the various cut options. n3=00h: No cutting n3=01h: Automatically cuts n3=08h: Cut at end of printing n3=09h: Automatically cuts, and cuts at end of printing This command is a static command.
P-touch Template Command Reference ESC iXy2 Specify printer settings (cut options–specifying number of labels) ASCII: ESC Decimal: 27 Hexadecimal: 1B i X n1 n2 n3 105 88 121 50 n1 n2 n3 69 79 n2 n3 58 y 2 32 n1 Parameters n1: 01h (Fixed) n2: 00h (Fixed) 01h≤n3≤63h Description Specifies that the tape will be cut after the specified number of labels. (If the auto cut setting is ON, the tape will be cut after the number of labels specified with this setting.
P-touch Template Command Reference ESC iXm2 Select character code set ASCII: ESC Decimal: 27 Hexadecimal: 1B i X n1 n2 n3 105 88 109 50 n1 n2 n3 69 6D n2 n3 58 m 2 32 n1 Parameters n1: 01h (Fixed) n2: 00h (Fixed) n3: 00h 01h 02h Description Selects the character code set. (For details on the character code sets, refer to the character code tables in “Appendix B: Character Code Tables”.
P-touch Template Command Reference ESC iXj2 Select international character set ASCII: ESC i Decimal: 27 Hexadecimal: 1B X n1 n2 n3 105 88 106 50 n1 n2 n3 69 6A n2 n3 58 j 2 32 n1 Parameters n1: 01h (Fixed) n2: 00h (Fixed) 00h≤n3≤0Dh, 40h Description Selects the character set according to the country selected, and switches some character codes in the code table according to the value for n3.
P-touch Template Command Reference ESC iXR2 Specify line feed command text string ASCII: ESC Decimal: 27 Hexadecimal: 1B i X R 2 n1 n2 data 105 88 82 50 n1 n2 data 69 52 32 n1 n2 data 58 Parameters 01h≤n1≤14h n2: 00h (Fixed) 00h≤data≤FFh Description Specifies the text string for the line feed command. n1+(n2*256): Length of the text string (can be set between 1 and 20) data: Text string (The maximum number of characters that can be set is 20 characters (bytes).
P-touch Template Command Reference ESC iXC2 Specify number of copies ASCII: ESC Decimal: 27 Hexadecimal: 1B i X C 2 n1 n2 n3 n4 105 88 67 50 n1 n2 n3 n4 69 43 32 n1 n2 n3 n4 58 Parameters n1: 02h (Fixed) n2: 00h (Fixed) 00h≤n3≤FFh 00h≤n4≤03h Description Specifies the number of copies to be printed. n3+(n4*256): Number of copies (bytes) (1 to 999) The default number of copies is 1. This command is a static command.
P-touch Template Command Reference ESC iXN2 Specify number of Numbering copies ASCII: ESC Decimal: 27 Hexadecimal: 1B i X N 2 n1 n2 n3 n4 105 88 78 50 n1 n2 n3 n4 69 4E 32 n1 n2 n3 n4 58 Parameters n1: 02h (Fixed) n2: 00h (Fixed) 00h≤n3≤FFh 00h≤n4≤03h Description Specifies the number of copies to be printed with Numbering. n3+(n4*256): Number of Numbering copies (bytes) (1 to 999) The default number of copies printed with Numbering is 1. This command is a static command.
P-touch Template Command Reference ESC iXF2 FNC1 replacement setting ASCII: ESC Decimal: 27 Hexadecimal: 1B i X F 2 n1 n2 n3 105 88 70 50 n1 n2 n3 69 46 32 n1 n2 n3 58 Parameters n1: 01h (Fixed) n2: 00h (Fixed) n3: 00h 01h Description Selects whether or not GS codes, which are included in barcode protocols such as GS1-128 (UCC/EAN-128), are replaced with FNC1 codes. n3=00h: FNC1 replacement setting OFF n3=01h: FNC1 replacement setting ON This command is a static command.
P-touch Template Command Reference ESC iXq2 Select print options ASCII: ESC Decimal: 27 Hexadecimal: 1B i X n1 n2 n3 105 88 113 50 n1 n2 n3 69 71 n2 n3 58 q 2 32 n1 Parameters n1: 01h (Fixed) n2: 00h (Fixed) n3: 00h, 01h Description Selects the print options. n3=00h: Priority given to print speed n3=01h: Priority given to print quality The default value for the print options is “00h” (priority given to print speed). This command is a static command.
P-touch Template Command Reference ESC iXT1 Retrieve print start trigger setting ASCII: ESC Decimal: 27 Hexadecimal: 1B i X T 1 n1 n2 105 88 84 49 n1 n2 69 54 31 n1 n2 58 Parameters n1=00h (Fixed) n2=00h (Fixed) Description The print start trigger is returned as 3-byte data.
P-touch Template Command Reference ESC iXP1 Retrieve print start command setting text string ASCII: ESC Decimal: 27 Hexadecimal: 1B i X P 1 n1 n2 105 88 80 49 n1 n2 69 50 31 n1 n2 58 Parameters n1: 00h (Fixed) n2: 00h (Fixed) Description Retrieves the text string specified for the print start command. 3- to 22-byte data is returned from the printer.
P-touch Template Command Reference ESC iXr1 Retrieve print start received character count ASCII: ESC Decimal: 27 Hexadecimal: 1B i X n1 n2 105 88 114 49 n1 n2 69 72 n2 58 r 1 31 n1 Parameters n1: 00h (Fixed) n2: 00h (Fixed) Description Retrieves the number of characters specified to be received in order to start printing. 4-byte data is returned from the printer.
P-touch Template Command Reference ESC iXD1 Retrieve delimiter ASCII: ESC Decimal: 27 Hexadecimal: 1B i X D 1 n1 n2 105 88 68 49 n1 n2 69 44 31 n1 n2 58 Parameters n1: 00h (Fixed) n2: 00h (Fixed) Description Retrieves the text string specified for the delimiter. 3- to 22-byte data is returned from the printer.
P-touch Template Command Reference ESC iXa1 Retrieve non-printed text strings ASCII: ESC Decimal: 27 Hexadecimal: 1B i X a 1 n1 n2 n3 105 88 97 49 n1 n2 n3 69 61 31 n1 n2 n3 58 Parameters n1: 01h (Fixed) n2: 00h (Fixed) n3: 01h (Fixed) Description Retrieves the specified non-printed text string. 2- to 22-byte data is returned from the printer.
P-touch Template Command Reference ESC iXi1 Retrieve command mode setting ASCII: ESC Decimal: 27 Hexadecimal: 1B i X n1 n2 105 88 105 49 n1 n2 69 69 n2 58 i 1 31 n1 Parameters n1: 00h (Fixed) n2: 00h (Fixed) Description Retrieves the setting for the command mode. 3-byte data is returned from the printer. [1]: 01h (Fixed) [2]: 00h (Fixed) [3]: Setting 00h: ESC/P mode 01h: Raster mode 03h: P-touch Template mode The retrieved value is a value specified by a static command.
P-touch Template Command Reference ESC iXn1 Retrieve number of selected template ASCII: ESC Decimal: 27 Hexadecimal: 1B i X n1 n2 105 88 110 49 n1 n2 69 6E n2 58 n 1 31 n1 Parameters n1: 00h (Fixed) n2: 00h (Fixed) Description Retrieves the template number selected from the printer. 3-byte data is returned from the printer. [1]: 01h (Fixed) [2]: 00h (Fixed) [3]: Setting The retrieved value is a value specified by a static command.
P-touch Template Command Reference ESC iXc1 Retrieve printer settings (cut options) ASCII: ESC Decimal: 27 Hexadecimal: 1B i X c 1 n1 n2 105 88 99 49 n1 n2 69 63 31 n1 n2 58 Parameters n1: 00h (Fixed) n2: 00h (Fixed) Description Retrieves the various cut settings. 3-byte data is returned from the printer. [1]: 01h (Fixed) [2]: 00h (Fixed) [3]: Setting 00h: No cutting 01h: Automatically cuts The retrieved value is a value specified by a static command.
P-touch Template Command Reference ESC iXy1 Retrieve printer settings (cut options–specifying number of labels) ASCII: ESC Decimal: 27 Hexadecimal: 1B i X n1 n2 105 88 121 49 n1 n2 69 79 n2 58 y 1 31 n1 Parameters n1: 00h (Fixed) n2: 00h (Fixed) Description Retrieves the setting for cutting after a specified number of labels. 3-byte data is returned from the printer. [1]: 01h (Fixed) [2]: 00h (Fixed) [3]: Setting The retrieved value is a value specified by a static command.
P-touch Template Command Reference ESC iXm1 Retrieve character code set setting ASCII: ESC Decimal: 27 Hexadecimal: 1B i X n1 n2 105 88 109 49 n1 n2 69 6D n2 58 m 1 31 n1 Parameters n1: 00h (Fixed) n2: 00h (Fixed) Description Retrieves the specified character code set. (For details on the character code sets, refer to “Appendix B: Character Code Tables”.) 3-byte data is returned from the printer.
P-touch Template Command Reference ESC iXj1 Retrieve international character set setting ASCII: ESC Decimal: 27 Hexadecimal: 1B i X n1 n2 105 88 106 49 n1 n2 69 6A n2 58 j 1 31 n1 Parameters n1: 00h (Fixed) n2: 00h (Fixed) Description Retrieves the international character set setting. 3-byte data is returned from the printer.
P-touch Template Command Reference ESC iXf1 Retrieve prefix character ASCII: ESC Decimal: 27 Hexadecimal: 1B i X n1 n2 105 88 102 49 n1 n2 69 66 n2 58 f 1 31 n1 Parameters n1: 00h (Fixed) n2: 00h (Fixed) Description Retrieves the prefix character code. 3-byte data is returned from the printer. [1]: 01h (Fixed) [2]: 00h (Fixed) [3]: Specified character The retrieved value is a value specified by a static command.
P-touch Template Command Reference ESC iXR1 Retrieve line feed command setting text string ASCII: ESC Decimal: 27 Hexadecimal: 1B i X R 1 n1 n2 105 88 82 49 n1 n2 69 52 31 n1 n2 58 Parameters n1: 00h (Fixed) n2: 00h (Fixed) Description Retrieves the text string specified for the line feed command. 2- to 22-byte data is returned from the printer.
P-touch Template Command Reference ESC iXC1 Retrieve number of copies setting ASCII: ESC Decimal: 27 Hexadecimal: 1B i X C 1 n1 n2 105 88 67 49 n1 n2 69 43 31 n1 n2 58 Parameters n1: 00h (Fixed) n2: 00h (Fixed) Description Retrieves the number of copies specified to be printed. 4-byte data is returned from the printer.
P-touch Template Command Reference ESC iXN1 Retrieve number of Numbering copies setting ASCII: ESC Decimal: 27 Hexadecimal: 1B i X N 1 n1 n2 105 88 78 49 n1 n2 69 4E 31 n1 n2 58 Parameters n1: 00h (Fixed) n2: 00h (Fixed) Description Retrieves the number of copies specified to be printed with Numbering. 4-byte data is returned from the printer.
P-touch Template Command Reference ESC iXF1 Retrieve FNC1 replacement setting ASCII: ESC Decimal: 27 Hexadecimal: 1B i X F 1 n1 n2 105 88 70 49 n1 n2 69 46 31 n1 n2 58 Parameters n1: 00h (Fixed) n2: 00h (Fixed) Description Retrieves the FNC1 replacement setting. 3-byte data is returned from the printer. [1]: 01h (Fixed) [2]: 00h (Fixed) [3]: Setting 00h: FNC1 replacement setting OFF 01h: FNC1 replacement setting ON The retrieved value is a value specified by a static command.
P-touch Template Command Reference ESC iXq1 Retrieve print options ASCII: ESC Decimal: 27 Hexadecimal: 1B i X n1 n2 105 88 113 49 n1 n2 69 71 n2 58 q 1 31 n1 Parameters n1: 00h (Fixed) n2: 00h (Fixed) Description Retrieves the print options setting. 3-byte data is returned from the printer. [1]: 01h (Fixed) [2]: 00h (Fixed) [3]: n3 Settings The retrieved value is a value specified by a static command.
P-touch Template Command Reference Appendix A: Specifications Printing BROTHER QL-810W/820NW P-touch Template specifications Printing method Raster printing (PTCBP mode) ESC/P printing P-touch Template printing Maximum print length 1m Resolution (dpi) 300 dpi × 300 dpi Text Transmission Barcode RS Font Bitmap fonts: Helsinki, Brussels, Letter Gothic Bold Outline fonts: Helsinki, Brussels, Letter Gothic Size (dots) Bitmap fonts: 24 x 24, 32 x 32, 48 x 48 (dots) Outline fonts: 33 - 400 dots (2
P-touch Template Command Reference Appendix B: Character Code Tables Character code tables (1) Windows1252 (Western Europe) 0 1 2 3 4 5 6 7 8 B C D E F 0 SP 0 @ P ` p € ° À Ð à ð 1 ! 1 A Q a q ~ ‘ ¡ ± Á Ñ á ñ 2 ” 2 B R b r , ’ ¢ ² Â Ò â ò 3 # 3 C S c s ƒ “ £ ³ Ã Ó ã ó 4 $ 4 D T d t „ ” ¤ ´ Ä Ô ä ô 5 % 5 E U e u … • ¥ µ Å Õ å õ 6 & 6 F V f v † - | ¶ Æ Ö æ ö 7 ’ 7 G W g w ‡ — § · Ç
P-touch Template Command Reference (2) Windows1250 (Eastern Europe) 0 1 2 3 4 5 6 7 8 9 0 SP 0 @ P ` p € tˇ 1 ! 1 A Q a q À ‘ 2 " 2 B R b r , 3 # 3 C S c s B C D E F ° Ŕ Đ ŕ đ ˇ ± Á Ń á ń ’ ˘ ˛ Â Ň â ň ˇ “ Ł ł Ă Ó ă ó 4 $ 4 D T d t „ ” ¤ ´ Ä Ô ä ô 5 % 5 E U e u … • Ą µ Ĺ Ő ĺ ő 6 & 6 F V f v † – | ¶ Ć Ö ć ö 7 ’ 7 G W g w ‡ — § · Ç × ç ÷ 8 ( 8 H X h x ľ ¨ ¸ Č Ř č
P-touch Template Command Reference (3) Brother standard 0 1 2 3 4 5 6 7 8 9 A B C D E 0 SP 0 @ P ` p Ç É á ░ └ α 1 ! 1 A Q a q ü æ í ▒ ┴ β 2 ” 2 B R b r é Æ ó ▓ ┬ 3 # 3 C S c s â ô ú │ ├ 4 $ 4 D T d t ä ö ñ ┤ ─ 5 % 5 E U e u à ò Ñ 6 & 6 F V f v å û a ¯ 7 ’ 7 G W g w ç ù o ¯ 8 ( 8 H X h x ê ÿ ¿ © ╚ 9 ) 9 I Y i y ë Ö ® ╣ ╔ ┘ A * : J Z j z è Ü € ║ ╩ ┌ Ω B + ; K
P-touch Template Command Reference International character set table Corresponding characters that switch in each language when the international character set is changed n 23 24 40 5B 5C 5D 5E 60 7B 7C 7D 7E 0 United States (U.S.A) # $ @ [ \ ] ^ ` { ¦ } ˜ 1 France # $ à ° ç § ^ ` é ù è ¨ 2 Germany # $ § Ä Ö Ü ^ ` ä ö ü ß 3 Britain (U.K.) £ $ @ [ \ ] ^ ` { ¦ } ˜ 4 Denmark I # $ @ Æ Ø Å ^ ` æ ø å ˜ 5 Sweden # ¤ É Ä Ö Å Ü é
P-touch Template Command Reference Appendix C: Troubleshooting If printing does not begin (main most frequent cause) (1) The communication settings are incorrect. (2) The command mode is not in the P-touch Template mode. (3) The conditions for the print start trigger are not met. The following three types of print start triggers exists, but the current selection is incorrect.
P-touch Template Command Reference Appendix D: Introducing the Brother Developer Center Useful information for developers, such as applications, tools, SDKs as well as FAQs, are provided in the Brother Developer Center. http://www.brother.com/product/dev/index.
