Brother TD-2130N, TD-2020 Raster Command Reference

Download

Page 1

Software Developer's Manual

Raster Command Reference TD-2020/2120N/2130N

Version 1.0

Page 2

Microsoft and Windows are registered trademarks of Microsoft Corporation in the United States and other countries.

Each owner whose software title is mentioned in this document has a Software License Agreement specific to its proprietary programs. Any trade names and product names of companies appearing on Brother products, related documents and any other materials are all trademarks or registered trademarks of those respective companies.

Page 3

IMPORTANT - PLEASE READ CAREFULLY

Note

This documentation (“Documentation”) provides information that will assist you in controlling your Printer TD-XXXX (where “XXXX” 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”). Unless expressly permitted in the Documentation, you may not; (i) copy or reproduce the Documentation for any purpose other than the Purpose,

(ii) modify, translate or adapt the Documentation, and/or redistribute it to any third party, (iii) rent or lease the Documentation to any third party, or, (iv) remove or alter any copyright notices or proprietary rights legends included within the Documentation.

No Warranty

a. Any updates, upgrades or alteration of the Documentation or Printer Model will be performed at the sole

discretion of Brother. Brother may not respond to any request or inquiry about the Documentation.

b. THIS DOCUMENTATION IS PROVIDED TO YOU "AS IS" WITHOUT WARRANTY OF ANY KIND,

WHETHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTY OF FITNESS FOR A PARTICULAR PURPOSE. BROTHER DOES NOT REPRESENT OR WARRANT THAT THIS DOCUMENTATION IS FREE FROM ERRORS OR DEFECTS.

c. IN NO EVENT SHALL BROTHER BE LIABLE FOR ANY DIRECT, INDIRECT, PUNITIVE, INCIDENTAL,

SPECIAL OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER, ARISING OUT OF THE USE, INABILITY TO USE, OR THE RESULTS OF USE OF THE DOCUMENTATION OR ANY SOFTWARE PROGRAM OR APPLICATION YOU DEVELOPED IN ACCORDANCE WITH THE DOCUMENTATION.

Page 4

Raster Command Reference

Contents

Introduction ······························································································ 1 About Raster Commands ············································································ 2

1. Printing Using Raster Commands ································ ····························· 3

2. Print Data ······························································································ 5

2.1 Print data overview ························································································ 5

2.2 Sample (analyzing the print data of the test page) ················································ 7

2.2.1 Preparation ........................................................................................................... 7

2.2.2 Checking the print data ......................................................................................... 7

2.2.3 Explanation of print data for the test page .......................................................... 10

2.3 Page data details·························································································· 12

2.3.1 Resolution .......................................................................................................... 12

2.3.2 Page size ............................................................................................................ 13

2.3.3 Feed amount ...................................................................................................... 15

2.3.4 Maximum and minimum lengths ......................................................................... 16

2.3.5 Raster line .......................................................................................................... 17

3. Print Command List ··············································································· 20

4. Printing Command Details ······································································ 21

NULL Invalidate ................................................................................................... 21

ESC @ Initialize ...................................................................................................... 21

ESC i S Status information request ......................................................................... 21

ESC i a Switch dynamic command mode ............................................................... 27

ESC i U Additional media information command ..................................................... 27

ESC i z Print information command ........................................................................ 29

ESC i M Various mode settings ............................................................................... 30

ESC i d Specify margin amount (feed amount) ....................................................... 30

M Select compression mode ......................................................................... 31

g Raster graphics transfer ............................................................................ 33

Z Zero raster graphics ................................................................................... 33

FF Print command........................................................................................... 33

Control-Z Print command with feeding ...................................................................... 33

5. Flow Charts··························································································· 34

5.1 Concurrent printing normal flow for USB connection ············································ 35

5.2 Concurrent printing error flow for USB connection (when feeding at the end of the page)36

5.3 Concurrent printing error flow for USB connection (with a concurrent printing error such as end of tape) ·································································································· 37

5.4 Concurrent printing cooling flow for USB connection ············································ 38

5.5 Concurrent printing waiting for peeling/resumed flow for USB connection ················· 39

5.6 Buffered printing normal flow for serial/USB connection ········································ 40

5.7 Buffered printing error flow for serial/USB connection ··········································· 41

5.8 Buffered printing cooling flow for serial/USB connection ······································· 42

5.9 Buffered printing waiting for peeling/resumed flow for serial/USB connection ············ 43

5.10 Buffered printing normal flow for network (standard TCP/IP port) connection ··········· 44

Appendix A: USB Specifications ································································· 45 Appendix B: Introducing the Brother Developer Center ·································· 46

- i -

Page 5

Raster Command Reference

Introduction

This material provides the necessary information for directly controlling the Brother printer TD-XXXX (where “XXXX” is the model name). This information is provided assuming that the user has full understanding of the operating system being used and basic mastery of USB and networks in a developer's environment. Details concerning the USB interface are not described in this material. If a USB interface is being used, refer to “Appendix A: USB Specifications” to prepare the interface.

Read the model names that appear in the screens in this manual as the name of your printer.

- 1 Introduction

Page 6

Raster Command Reference

About Raster Commands

Using raster commands an TD-XXXX printer (where “XXXX” is the model name) can be used to print without using our printer driver. This operation is useful in the following situations.  When printing from an operating system other than Windows

(Example: When printing from a Linux computer or mobile terminal)  When adding print functions to an existing system In addition, printing can be performed with advanced settings.

In this material, “raster” refers to binary bitmap data (collection of dots). Refer to this material to print by sending initialization commands and control codes together with raster data to the TD-XXXX printer (hereafter, referred to as “printer”). This manual describes the procedure for adding these codes and sending the data.

- 2 About Raster Commands

Page 7

Raster Command Reference

(2) Send the status

(Confirm the printer status.)

(1) Open the port

(5) Send the status

(Confirm that printing is completed.)

(6) Close the port

Port

(4) Print

At your side

(3) Send the print data

Your printer

Computer, mobile terminal, etc.

1. Printing Using Raster Commands

The printing procedure is described below. For detailed flow charts, refer to “5. Flow Charts”. For details on each command, refer to “4. Printing Command Details”.

- 3 -

1. Printing Using Raster Commands

Page 8

Raster Command Reference

(1) Open the USB/serial/network port

Open the USB/serial/network port in the operating environment. The procedure for opening the USB/serial/network port is not described in this material. The network port can only be used with the TD-2120N/2130N.

(2) Confirm the printer status sent from the printer

The “status information request” command is sent to the printer, the status information received from the printer is analyzed, and then the status of the printer is determined.

For details on the “status information request” command and on the definitions of “status”, refer to “Status information request” in “4. Printing Command Details”.

(3) Send the print data

If the status analysis confirms that media compatible with the print data is loaded into the printer and that no error has occurred, the print data is sent. The structure of the print data is explained in the next section, “2. Print Data”.

Note: No command can be sent to the printer after the print data is transmitted and until the completion of printing is confirmed. Even the “status information request” command cannot be sent during printing.

(4) Print the data

(5) Confirm that printing is completed

When printing is completed, the status is received from the printer. If this status is analyzed to confirm that printing is completed, printing one page is considered finished. If the print job has multiple pages, (2) through (4) are repeated.

(6) Close the USB/serial/network port

After all printing is finished, close the USB/serial/network port.

Note: In order to print at high speed when a USB port is used to send uncompressed raster data, the Brother TD-XXXX starts printing when it starts to receive print data, instead of waiting for a print command (concurrent printing). For the processing flow, for example when managing errors, refer to “5. Flow Charts”.

- 4 -

1. Printing Using Raster Commands

Page 9

Raster Command Reference

Sequence

Command Name

Description/Example

Invalidate

Sends a 200-byte invalidate command, and then resets the printer to the receiving state.

Initialize

Initializes for printing. 1Bh, 40h (Fixed)

Sequence

Command Name

Description/Example

Switch dynamic command mode

Switches the printer to raster mode. 1Bh, 69h, 61h, 01h

Additional media information command

Updates the media information for the printer. 1Bh, 69h, 55h, 77h, 01h, 127 bytes of media information

Note If the media information is the same as when printing was last performed, it is unnecessary to send the additional media information command.

Print information command

Sets the print information for the printer. For 58-mm-wide continuous length tape on the 300 dpi model: 1Bh, 69h, 7Ah, C6h, 0Ah, 3Ah, 00h, 0Ah, 01h, 00h, 00h, 00h, 00h

Various mode settings

When the peeler function is enabled: 1Bh,69h,4Dh,10h

Specify margin amount

Specifies the amount of the margins. For 3 mm margins on the 300 dpi model: 1Bh, 69h , 64h, 23h, 00h

Select compression mode

Selects the compression mode for raster graphics. To send the data compressed to TIFF format: 4Dh, 02h

2. Print Data

2.1 Print data overview

The print data is constructed of the following: (1) initialization commands, (2) control codes, (3) raster data, and (4) print commands. If the print job consists of multiple pages, (2) through (4) are repeated.

(1) Initialization commands

Specified only once at the beginning of the job.

(2) Control codes

Added at the beginning of each page and sent for each page.

- 5 -

2. Print Data

Page 10

Sequence

Command Name

Description/Example

Raster graphics transfer

Sends a raster line that contains data with pixels set to “ON”.

Zero raster graphics

Sends a raster line with all pixels set to “0”.（Valid only when TIFF is selected as the compression mode） 5Ah (Fixed)

Sequence

Command Name

Description/Example

Print command

Specifies at the end of a page that is not the last page. 0Ch（Fixed）

Print command with feeding

Specifies at the end of the last page. 1Ah (Fixed)

(3) Raster data

Repeated for each page in the print job.

(4) Print commands

Specified at the end of the page.

Raster Command Reference

- 6 -

2. Print Data

Page 11

Raster Command Reference

Test page

Printer Properties

2.2 Sample (analyzing the print data of the test page)

The print data created by the printer driver is described here. As an example, we will check the print data created when the [Print Test Page] button in the printer Properties dialog box is clicked to print the test page. Since the print data differs depending on the print settings of the printer, refer to this procedure and try creating print data with various print settings. Furthermore, this procedure is for the Windows® 7 operating environment. A similar procedure can be performed if you are using a different operating system.

2.2.1 Preparation

Install the two listed below.

・ Printer driver of the Brother TD-XXXX ・ Binary file editor

The data that we will analyze in this sample is a binary file. Therefore, use a binary file editor to display and check the contents of the binary file.

2.2.2 Checking the print data

The procedure for checking the print data is provided below.

Step 1: Change the port of the printer to “FILE:”. Step 2: Print the desired item (in this case, the test page), and then specify the file name. Step 3: Open the created file in the binary file editor to check it.

- 7 -

2. Print Data

Page 12

Raster Command Reference

Step 1: Change the port of the printer to “FILE:”.

Open the Printers and Faxes folder, and then right-click the printer (in this case, RJ-4030) to display the Properties dialog box. In the Properties dialog box, click the [Ports] tab, select the “FILE:” check box, and then click the [Apply] button.

[Ports] tab of the printer Properties dialog box

Step 2: Print the item (in this case, the test page), and then specify the file name.

For this sample, print the test page with the “Use Peeler Function” check box selected in the “Option” group box.

Default settings immediately after installation of the printer driver

- 8 -

2. Print Data

Page 13

Raster Command Reference

(1) Initialization commands

(2) Control codes

(4) Print commands

(3) Raster data

When the test page is printed with the printer, a dialog box appears so that the file name can be specified. (Refer to the illustration below.) After a file name is typed in and the [OK] button is clicked, the printer driver creates the print data and saves it in a file with the specified name.

Dialog box for specifying the file name

Step 3: Open the print data in the binary file editor.

Open the saved file in the binary file editor. The rows of numbers that appear are the print data. (Refer to the illustration below.) The print data is constructed of the following: (1) initialization commands, (2) control codes, (3) raster data and (4) print commands, which were described in “2.1 Print data overview”. For details on the print data, refer to “2.2.3 Explanation of print data for the test page”.

Print data

- 9 -

2. Print Data

Page 14

Raster Command Reference

2.2.3 Explanation of print data for the test page

The print data for the test page outputted in the previous section is described below. The following illustration shows the print data created in section “2.2.1 Preparation” opened in the binary file editor.

Print data

- 10 -

2. Print Data

Page 15

Raster Command Reference

No.

Command Name

Description

１

Invalidate

A 200-byte invalidate command is sent.

Initialize

The “initialize” command is sent.

Switch dynamic command mode

The printer is switched to raster mode. Send this command before sending raster data to the printer.

Job ID setting commands

Internal specification commands Since this is a command for outputting with the commercial version driver, it is unnecessary for the user to send this command.

Additional media information command

Additional media information on the media size is sent. This is the command for “2.0" × 1.0" (51 mm × 26 mm)”.

Print information command

Media size information for the print data is sent. This is the command for “2.0" × 1.0" (51 mm × 26 mm)” die-cut labels.

Various mode settings

(1Bh+69h+4Dh+00H)

This is a command for specifying a mode. In this case, the peeler function is enabled.

Specify margin amount

Since a margin amount cannot be specified with die-cut labels, this command is sent with a margin amount of 0.

Select compression mode

TIFF compression mode is selected.

Raster data

Raster data continues.

Print command with feeding

Since one page will be printed, this is sent at the end of the first page.

Descriptions for the numbers in the print data on the previous page are provided in the following table. For details on each command, refer to “4. Printing Command Details”.

- 11 -

2. Print Data

Page 16

Resolution

Height-to-Width Proportion

Priority on print speed

203 dpi high, 203 dpi wide

1:1

Priority on print quality

203 dpi high, 203 dpi wide

1:1

Resolution

Height-to-Width Proportion

Priority on print speed

300 dpi high, 300 dpi wide

1:1

Priority on print quality

300 dpi high, 300 dpi wide

1:1

2.3 Page data details

2.3.1 Resolution

TD-2020,2120N

TD-2130N

Raster Command Reference

- 12 -

2. Print Data

Page 17

Feeding direction

Landscape

1 4 2

Print area

1 4 2

Portrait

Feeding direction

Print area

Tape Size

Designation

1 2 3 4 5

438

57 mm

2.25"

57.2 mm 457 dots

--> 2.3.4.

54.1 mm 432 dots

-->2.3.4.

1.5 mm 12 dots

--> 2.3.3.

426

58 mm

2.28”

58.0 mm 464 dots

--> 2.3.4.

55.1 mm 440 dots

-->2.3.4.

1.5 mm 12 dots

--> 2.3.3.

Tape Size

Designation

1 2 3 4 5

438

57 mm

2.25"

57.2 mm 675 dots

--> 2.3.4.

54.0 mm 638 dots

-->2.3.4.

1.5 mm 18 dots

--> 2.3.3.

426

58 mm

2.28”

58.0 mm 685 dots

--> 2.3.4.

54.9 mm 648 dots

-->2.3.4.

1.5 mm 18 dots

--> 2.3.3.

2.3.2 Page size

(a) Continuous length tape

Raster Command Reference

Number 1 Width 2 Length 3 Print area width (maximum printing width) 4 Print area length 5 Width offset 6 Length offset

203dpi×203dpi

300dpi×300dpi

- 13 -

2. Print Data

Page 18

Print area

Label Size

1 2 3 4 5

422

RD 51 mm x 26 mm RD 2.0" x 1.0"

50.8 mm 406 dots

25.6 mm 205 dots

47.8 mm 382 dots

19.6 mm 157 dots

1.5 mm 12 dots

3.0 mm 24 dots

431

RD 30 mm x 30 mm RD 1.1" x 1.1"

30.0 mm 240 dots

27.0 mm 216 dots

24.0 mm 192 dots

1.5 mm 12 dots

3.0 mm 24 dots

432

RD 40 mm x 40 mm RD 1.5" x 1.5"

40.0 mm 320 dots

37.0 mm 296 dots

34.0 mm 272 dots

1.5 mm 12 dots

3.0 mm 24 dots

433

RD 40 mm x 50 mm RD 1.5" x 1.9"

40.0 mm 320 dots

50.0 mm 400 dots

37.0 mm 296 dots

44.0 mm 352 dots

1.5 mm 12 dots

3.0 mm 24 dots

434

RD 40 mm x 60 mm RD 1.5" x 2.3"

40.0 mm 320 dots

60.0 mm

480dots

37.0 mm 296 dots

54.1 mm 432 dots

1.5 mm 12 dots

3.0 mm 24 dots

435

RD 50 mm ×30 mm RD 1.9” × 1.1”

50.0 mm 400 dots

30.0mm

240 dots

47.0 mm 376 dots

24.0mm

192 dots

1.5 mm 12dots

3.0 mm

24 dots

437

RD 60 mm ×60 mm RD 2.3” × 2.3”

60.0mm

480 dots

60.0mm

480 dots

56.1 mm 448 dots

54.1mm

432 dots

2.0 mm

16 dots

3.0 mm

24 dots

(b) Die-cut labels

Raster Command Reference

Number 1 Width 2 Length 3 Print area width (maximum printing width) 4 Print area length 5 Width offset 6 Length offset

203dpi×203dpi

- 14 -

2. Print Data

Page 19

Label Size

1 2 3 4 5

422

RD 51 mm x 26 mm RD 2.0" x 1.0"

50.8 mm 600 dots

25.6 mm 302 dots

47.8 mm 564 dots

19.6 mm 231 dots

1.5 mm

18 dots

3.0 mm

35 dots

431

RD 30 mm x 30 mm RD 1.1" x 1.1"

30.0 mm 354 dots

26.9 mm 318 dots

24.0 mm 283 dots

1.5 mm

18 dots

3.0 mm

35 dots

432

RD 40 mm x 40 mm RD 1.5" x 1.5"

40.0 mm 472 dots

36.9 mm 436 dots

34.0 mm 401 dots

1.5 mm

18 dots

3.0 mm

35 dots

433

RD 40 mm x 50 mm RD 1.5" x 1.9"

40.0 mm 472 dots

50.0 mm 591 dots

36.9 mm 436 dots

43.9 mm 519 dots

1.5 mm

18 dots

3.0 mm

35 dots

434

RD 40 mm x 60 mm RD 1.5" x 2.3"

40.0 mm 472 dots

60.0 mm

709dots

36.9 mm 436 dots

54.0 mm 638 dots

1.5 mm

18 dots

3.0 mm

35 dots

435

RD 50 mm ×30 mm RD 1.9” × 1.1”

50.0 mm 591 dots

30.0mm

354 dots

46.9 mm 554 dots

24.0mm

283 dots

1.5 mm 18dots

3.0 mm

35 dots

437

RD 60 mm ×60 mm RD 2.3” × 2.3”

60.0mm

709 dots

60.0mm

709 dots

55.9 mm 660 dots

54.0mm

638 dots

2.0 mm

24 dots

3.0 mm

35 dots

Type

Minimum Margin Setting

Maximum Margin Setting

Continuous length tape

3 mm

0.12" 24 dots

127 mm 5" 1015 dots

Die-cut labels

The length offset indicated in “(b) Die-cut labels” of “2.3.2 Page size” is used. However, set “0” as the value of the “specify margin amount” command.

Type

Minimum Margin Setting

Maximum Margin Setting

Continuous length tape

3 mm

0.12" 35 dots

127 mm 5" 1500 dots

Die-cut labels

The length offset indicated in “(b) Die-cut labels” of “2.3.2 Page size” is used. However, set “0” as the value of the “specify margin amount” command.

300dpi×300dpi

Raster Command Reference

2.3.3 Feed amount

The feed amount (left and right margins) is defined below.

203dpi×203dpi

300dpi×300dpi

- 15 -

2. Print Data

Page 20

Type

Minimum Length

Maximum Length

Continuous length tape

12 mm

0.47” 96 dots

1000 mm

39.37” 7992 dots

Die-cut labels

Fixed

Type

Minimum Length

Maximum Length

Continuous length tape

12 mm

0.47” 142 dots

1000 mm

39.37” 11811 dots

Die-cut labels

Fixed

2.3.4 Maximum and minimum lengths

The maximum and minimum lengths are defined below. 203dpi×203dpi

300dpi×300dpi

Raster Command Reference

- 16 -

2. Print Data

Page 21

Raster Command Reference

Feeding direction

Print area

Rasterized

Feeding direction

Print area Print head

Expansion direction

RasterLine 3

RasterLine 2

RasterLine 1

Zero Raster 1

RasterLine 4

MSB LSB

1stB

MSB LSB

2ndB

3rdB

4thB ...

2.3.5 Raster line

As shown below, the parts with data to be printed are converted with “raster graphics transfer”, and the parts with no data are converted with “zero raster graphics”. On the actual tape, margins (feed) are added specified with “various mode settings” at the beginning and the end.

The following shows the relationship between the raster graphics parameters and the pixels.

- 17 -

2. Print Data

Page 22

0 pin

First byte

Left and right margins

Last byte

Raster line

Feeding direction

Print area

Pins on print head

Number of print area pins

Number of pins for right margin

Total number of pins

Number of pins for left margin

Tape Size

Number of Pins

for Left Margin

Number of Print

Area Pins

Number of Pins

for Right Margin

Number of Bytes for

Raster Graphics Transfer

57 mm

432 8 56

58 mm

440 4 56

Tape Size

Number of Pins

for Left Margin

Number of Print

Area Pins

Number of Pins

for Right Margin

Number of Bytes for

Raster Graphics Transfer

57 mm

638

58 mm

648

Total number of pins: TD-2020/2120N 448 pins / TD-2130N 672 pins

Raster Command Reference

Continuous length tape: TD-2020/2120N

TD-2130N

- 18 -

2. Print Data

Page 23

Label Size

Number of Pins

for Left Margin

Number of Print

Area Pins

Number of Pins

for Right Margin

Number of Bytes for

Raster Graphics Transfer

51 mm x 26 mm

382

30 mm x 30 mm

116

216

116

40 mm x 40 mm

296

40 mm x 50 mm

296

40 mm x 60 mm

296

50 mm x 30mm

376

60mm x 60mm

448 0 56

Label Size

Number of Pins

for Left Margin

Number of Print

Area Pins

Number of Pins

for Right Margin

Number of Bytes for

Raster Graphics Transfer

51 mm x 26 mm

564

30 mm x 30 mm

177

318

177

40 mm x 40 mm

118

436

118

40 mm x 50 mm

118

436

118

40 mm x 60 mm

118

436

118

50 mm x 30mm

554

60 mm x 60mm

660 6 84

Die-cut labels: TD-2020/2120N

TD-2130N

Raster Command Reference

- 19 -

2. Print Data

Page 24

ASCII Code

Binary Code

Description

NULL

Invalidate

ESC @

1B 40

Initialize

ESC i S

1B 69 53

Status information request

ESC i a

1B 69 61

Switch dynamic command mode

ESC i U w 1

1B 69 55 77 01

Additional media information command

ESC i z

1B 69 7A

Print information command

ESC i M

1B 69 4D

Various mode settings

ESC i d

1B 69 64

Specify margin amount (feed amount)

Select compression mode

Raster graphics transfer

Zero raster graphics

Print command

Control-Z

Print command with feeding

3. Print Command List

Raster Command Reference

- 20 -

3. Print Command List

Page 25

Raster Command Reference

4. Printing Command Details

NULL Invalidate

ASCII: NULL Hexadecimal: 00

Description

 Skipped  If data transmission is to be stopped midway, send the “initialize” command after sending the “invalidate”

command for the appropriate number of bytes to return to the receiving state, where the print buffer is cleared.

ESC @ Initialize

ASCII: ESC @ Hexadecimal: 1B 40

Description

 Initializes mode settings.  Also used to cancel printing.

ESC i S Status information request

ASCII: ESC i S Hexadecimal: 1B 69 53

Description

 Send a request to the printer for status information. For details on the status, refer to the previous section.  The size is fixed at 32 bytes.

Note Before sending print data to the printer, this command should be sent once. Since error information is automatically sent by the printer during printing, do not send this command while printing.

For details on transmission of the status, refer to “5. Flow Charts”.

- 21 -

4. Printing Command Details

Page 26

Raster Command Reference

Number

Offset

Size

Name

Value/Reference

1 0 1

Print head mark

Fixed at 80h

2 1 1

Size

Fixed at 20h

3 2 1

Reserved

Fixed at “B” (42h)

4 3 1

Series code

Fixed at “5” (35h)

5 4 1

Model code

TD-2020: Fixed at “3” (33h) TD-2120N: Fixed at “5”(35h) TD-2130N: Fixed at “6” (36h)

6 5 1

Reserved

Fixed at “0” (30h)

7 6 1

Battery level

Refer to table (8) below.

8 7 1

Reserved

Fixed at “00h”

9 8 1

Error information 1

Refer to table (1) below.

10 9 1

Error information 2

Refer to table (2) below.

Media width

Refer to table (3) below.

Media type

Refer to table (4) below.

Reserved

Fixed at 00h

Reserved

Fixed at 00h

Reserved

Fixed at 3Fh

Mode

Value specified where the “various mode settings” command 00h if not specified

Reserved

Fixed at 00h

Media length

Refer to table (3) below.

Status type

Refer to table (5) below.

Phase type

Refer to table (6) below.

Phase number (higher order bytes)

Phase number (lower order bytes)

Notification number

Refer to table (7) below.

Reserved

Fixed at 00h

Reserved

Fixed at 00h

- 22 -

4. Printing Command Details

Page 27

Flag

Mask

Definition

Bit 0

01h

“No media” error

Bit 1

02h

“End of media” error (only for die-cut labels)

Bit 2

04h

(Not used)

Bit 3

08h

(Not used)

Bit 4

10h

Printer in use

Bit 5

20h

(Not used)

Bit 6

40h

(Not used)

Bit 7

80h

(Not used)

Flag

Mask

Definition

Bit 0

01h

“Replace media” error (with a serial connecting) Wrong media

Bit 1

02h

(Not used)

Bit 2

04h

Communication error

Bit 3

08h

(Not used)

Bit 4

10h

“Cover open” error

Bit 5

20h

(Not used)

Bit 6

40h

Media cannot be fed (also when the media end is detected)

Bit 7

80h

System error

(1) Error information 1

(2) Error information 2

Raster Command Reference

- 23 -

4. Printing Command Details

Page 28

Media

Media Width

Media Length

57 mm

58 mm

Media

Media Width

Media Length

51 mm x 26 mm

30 mm x 30 mm

40 mm x 40 mm

40 mm x 50 mm

40 mm x 60 mm

50 mm x 30 mm

60 mm x 60 mm

Media Type

Value

Description

No media

00h

Used as print information when the media type is not indicated.

Continuous length tape

4Ah

Used for both paper and film.

Die-cut labels

4Bh

Used for both paper and film.

(3) Media width and length

The media width and length is described in millimeters. 0～255 (0 to FFh) (a) Continuous length tape * Media Width: The tape width is indicated in millimeters. * Media Length: Fixed at 00h

(b) Die-cut labels * Media Width: The width of the die-cut section is indicated. * Media Length: The length of the die-cut section is indicated.

Raster Command Reference

(4) Media type

- 24 -

4. Printing Command Details

Page 29

Status Type

Value

Description

Reply to status request

00h

Printing completed

01h

Error occurred

02h

Exit IF mode

03h (not used)

Turned off

04h

Notification

05h

Phase change

06h

(Not used)

08h to 20h

(Reserved)

21h to FFh

Phase State

Phase Type

Receiving state

00h

Printing state

01h

Phase

Value (Dec.)

Higher Order Bytes

Lower Order Bytes

Waiting to receive

00h

Phase

Value (Dec.)

Higher Order Bytes

Lower Order Bytes

Printing

00h

(5) Status type

If an error occurred during printing, the printer returns the error status.

Raster Command Reference

(6) Phase type and phase number

If the phase number is not used, both are fixed at 00h.

Receiving state

Printing state

 When the printer is turned on, it is in the receiving state. When printing begins, it changes to the “printing”

phase (phase type: printing state; phase number: printing), and the printer sends that phase status to the

computer. When printing has finished, the printer sends the “receiving state” phase status (phase type:

receiving state; phase number: waiting to receive) to the computer. Unless an error occurs during printing, the printer sends the “printing completed” status.

 With concurrent printing, printing starts even if a print command has not been sent from the computer in

order to print at high speed. At this time, care should be taken since the “printing” and “waiting to receive” phase statuses will be sent. (Refer to “5. Flow Charts”.)

- 25 -

4. Printing Command Details

Page 30

Notification

Value

Not available

00h

Cooling (started)

03h

Cooling (finished)

04h

Waiting for peeling

05h

Finished waiting for peeling

（Not used：Reserved）

06h

Printer paused

07h

Finished printer pause

（Not used：Reserved）

08h

Battery Level

Value

Full

00h

Half

01h

Low

02h

Charging required

03h

AC adaptor in use

04h

(7) Notification number

(8) Battery level

Raster Command Reference

- 26 -

4. Printing Command Details

Page 31

Raster Command Reference

ESC i a Switch dynamic command mode

ASCII: ESC i a {n1} Hexadecimal: 1B 69 61 {n1}

Parameters

Definitions of {n}: 0: ESC/P mode (default) 1: Raster mode (Be sure to switch to this mode.) 3: P-touch Template mode

Description  Dynamically switches between the printer's command modes. A printer that receives this command

operates in the specified command mode until the printer is turned off.

 The printer must be switched to raster mode before raster data is sent to it. Therefore, send this command

to switch the printer to raster mode.

ESC i U Additional media information command

ASCII: ESC i U w 1 {d1...d127} Hexadecimal: 1B 69 55 77 01 {d1...d127}

Description

 Updates the media information for the printer.  Send to the printer the commands outputted with the “Save Paper Size Commands” function of Paper Size

Setup.

Note If the media information is the same as when printing was last performed, it is unnecessary to send the additional media information command.

“Save Paper Size Commands” function of Paper Size Setup

1. Preparation Install the two listed below.

・Printer driver of the Brother TD-XXXX ・Binary file editor.

The data outputted with the “Save Paper Size Commands” function of Paper Size Setup will be a

binary file. Therefore, use a binary file editor to display and check the contents of the binary file.

- 27 -

4. Printing Command Details

Page 32

Raster Command Reference

Open the [Devices and Printers] window, right-click the printer, and then display the Printing Preferences dialog box. Click the [Paper Size Setup] button on the [Basic] tab to display the Paper Size Setup dialog box. （Refer to the illustration below.） Click [Save Paper Size Commands] from the [Option] button to display a dialog box for creating a file for saving the paper size commands, and then save them in a file with the specified name.

2. Open the saved file in the binary file editor. The rows of numbers that appear are the command data.(Refer to the illustration below.)

In the command data that appeared, the part marked with the red box is the additional media information command.

Of this, the 127 bytes underlined in orange are the media information. Use this when adding media information.

- 28 -

4. Printing Command Details

Page 33

Raster Command Reference

{n1}:

Valid flag; Specifies which values are valid #define PI_KIND 0x02 // Media type #define PI_WIDTH 0x04 // Media width #define PI_LENGTH 0x08 // Media length #define PI_QUALITY 0x40 // Priority given to print quality #define PI_RECOVER 0x80 // Printer recovery always on

{n2}:

Media type Continuous length tape: 0Ah Die-cut labels: 0Bh

{n3}:

{n3}: Media width (mm) {n4}: Media length (mm) For the media of width 51 mm × length 26 mm, specify as n3=33h and n4=1Ah.

{n4}:

{n5-n8}:

Raster number = n8*256*256*256 + n7*256*256 + n6*256 + n5 If the media is not correctly loaded into the printer when the valid flag for PI_KIND,

PI_WIDTH and PI_LENGTH are set to “ON”, an error status is returned (Bit 0 of “(2)

Error information 2” is set to “ON”.)

{n9}:

Starting page: 0 Other pages: 1

{n10}:

Fixed at 0

ESC i z Print information command

ASCII: ESC i z {n1} {n2} {n3} {n4} {n5} {n6} {n7} {n8} {n9} {n10} Hexadecimal: 1B 69 7A {n1} {n2} {n3} {n4} {n5} {n6} {n7} {n8} {n9} {n10}

Description

 Specifies the print information.  Definitions of {n1} through {n10}

- 29 -

4. Printing Command Details

Page 34

Print area

Margin amount

Tape

Paper

Cut line

Margin amount (only “0” is available)

Print area

Label

Paper

Cut line

ESC i M Various mode settings

ASCII: ESC i M {n1} Hexadecimal: 1B 69 4D {n1}

Parameters

Definitions of {n1} The meaning of each bit in a 1-byte parameter is described below.

0 ～ 2bit：Not used 3bit：Inverted 180 Degrees 1. Rotates 180 degrees 0. Does not rotate 180 degrees 4bit：Peeler Function 1. Uses the peeler function 0. Does not use the peeler function 5 ～ 7bit：Not used

Raster Command Reference

ESC i d Specify margin amount (feed amount)

ASCII: ESC i d {n1} {n2} Hexadecimal: 1B 69 64 {n1} {n2}

Description

 Specifies the amount of the margins.  Margin amount (dots)=n1+n2*256  With die-cut labels, the margin amount at the ends of the printed area is 0.

(a) Continuous length tape

(b) Die-cut labels

- 30 -

4. Printing Command Details

Page 35

Raster Command Reference

No-compression mode (Enabled)

Reserved (Disabled)

TIFF (Enabled) Normally TIFF compression with a serial connection

Without compression:

00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 22 22 23 BA BF A2 22 2B……

With compression:

ED 00 FF 22 05 23 BA BF A2 22 2B … a b c

Since “00h” is repeated for 20 bytes, 20d -> 19d -> 13h changed into a negative number is EDh. Therefore: ED 00

Since “22h” is repeated for 2 bytes, 2d -> 1d -> 1h changed into a negative number is FFh. Therefore: FF 22

The following 6 bytes remain unchanged. 6d -> 5d -> 5h Therefore: 05 23 BA BF A2 22 2B

Continue for the remaining number of bytes for the uncompressed data. Even if 00h continues until the end, it cannot be omitted.

M Select compression mode

ASCII: M {n} Hexadecimal: 4D {n}

Parameters

Definitions of {n}

Description  Selects the compression mode. Data compression is available only for data in raster graphic transfer.

[TIFF(Pack Bits)]

 1-byte units  If the same data is repeated, the number of data units and that 1 byte of data are specified.

If different data is in a series, the number of data items and all of the different data are specified.

 If the same data is repeated, the number of data units is specified as the actual number minus 1,

expressed as a negative number. If different data is in a series, the number of data units is specified as the number of bytes minus 1, expressed as a positive number.

 If the above process results in more than 56 bytes (TD-2020/2120N) or 85 bytes (TD-2130N) of

compressed data, the data is treated as being all different. As a result, the data will be 57 bytes (TD-2020/2120N) or 86 bytes (TD-2130N), including the 1 byte that specifies the data length.

Example 1 raster of raster graphics transfer:

- 31 -

4. Printing Command Details

Page 36

Raster Command Reference

0 pin

Last byte

First byte

Tape margin

Raster line with compression

Feeding direction

Print area

Pins on print head

Number of print area pins

Number of offset pins

Total number of pins

Number of unused pins

Raster line with no compression

Explanation of “TIFF compression mode”

With compression, the data for the “raster graphics transfer” command is based on 56 bytes

(TD-2020/2120N) or 84 bytes (TD-2130N) of the total number of pins (TD-2020/2120N: 448 and TD-2130N:

672). As shown below, with no compression, the sum of the number of offset pins and the number of pins

within the print area is the byte data. However, with compression, the number of unused pins is also added to the data. In other words, with compression, this becomes 104 bytes when it is expanded by the printer, regardless of the tape width.

- 32 -

4. Printing Command Details

Page 37

g Raster graphics transfer

ASCII: g {s} {n} {d1} ... {dn} Hexadecimal: 67 {s} {n} {d1} ... {dn}

Parameters

{s} 00h {n} Number of bytes of raster data (d1 to dh)

However, use the following value if no compression is specified as the compression mode. TD-2020/2120N：n=56 TD-2130N：n=84 {d1~dn} Raster data.

Z Zero raster graphics

ASCII: Z

Raster Command Reference

Hexadecimal: 5A

Description  Fills raster line with 0 data.

FF Print command

ASCII: FF Hexadecimal: 0C

Description  Used as a print command at the end of pages other than the last page when multiple pages are printed.

Control-Z Print command with feeding

ASCII: Control-Z Hexadecimal: 1A

Description  Used as a print command at the end of the last page.

- 33 -

4. Printing Command Details

Page 38

Raster Command Reference

5. Flow Charts

Normally, printing is performed as buffered printing. However, if the printer is connected via USB and uncompressed data is received, concurrent printing is performed.

Note: Concurrent printing：Printing starts immediately after the printer receives print data. Buffered printing：Printing starts after one page of print data is received.

- 34 -

5. Flow Charts

Page 39

Raster Command Reference

Computer (host)

Printer

Status information request

Status (response to status information request)

Printing

Display ing printing

Printing of the 1st page is actually not finished, but the

“Printing completed” status and “Waiting to receive” phase are

sent.

Sending control codes

Sending raster data

Initialize

The printer is initialized.

Status

(Phase change:

“Printing”)

Sending a print command (print command with feeding (1A) for the last page or print command (0C) for other pages)

Phase change

“Printing” received.

“Printing completed”

received.

Sending raster data

Status (“Printing completed”)

Status (Phase change:

“Waiting to receive”)

Sending control code/raster data

Sending raster data

Finishing process for printing page 1

Sending data for page 2

Printing 1st page

Printing 2nd page

Sending raster data

READ

The status of the printer (media, etc.) is checked and a response is sent.

If there are no problems with the printer status (media, etc.), the data is transmitted. If there is a problem, an error appears.

Displaying sending

READ

Data received.

Beginning printing without waiting for a print command

Status

(Phase change:

“Printing”)

Invalidate

The printer is reset.

5.1 Concurrent printing normal flow for USB connection

- 35 -

5. Flow Charts

Page 40

Raster Command Reference

Computer (host)

Status information request

Status (response to status information request)

The status of the printer (media, etc.) is checked and a response is sent.

Data received.

Beginning printing without waiting for a print command

Printing

Displaying printing

Displaying sending

Sending control codes

Sending raster data

Initialize

The printer is initialized.

Status

(Phase change:

“Printing”)

Sending a print command (print command with feeding (1A) for the last page or print command (0C) for other page)

“Printing completed” received.

Sending raster data

Status (Phase change: “Waiting to receive”)

Sending control code/raster data

Status

(“Error occurred”)

Sending raster data

Sending a print command (print command with feeding (1A) for the last page or print command (0C) for other pages)

“Error Occured” received.

Initialize

If there are no problems with the printer status (media, etc.), the data is transmitted. If there is a problem, an error appears.

Printing of the 1st page is actually not finished, but the

“Printing completed” status and “Waiting to receive” phase are

sent.

An error appears. When restarted, data is resent starting with the 1st page since “Printing” for the 2nd page is not received.

If an error occurs, all data read from the computer is cleared.

Reprinting 1st page

READ

Printer

Phase change

“Printing” received.

Status (“Printing completed”)

Finishing process for printing page 1

Sending data for page 2

Error occurred

Resending process for data of 1st page

Displaying printing

Invalidate

The printer is reset.

5.2 Concurrent printing error flow for USB connection (when feeding at the end of the page)

- 36 -

5. Flow Charts

Page 41

Raster Command Reference

Computer (host)

If there are no problems with the printer status (media, etc.), the data is transmitted. If there is a problem, an error appears.

The status of the printer (media, etc.) is checked and a response is sent.

Data received.

Beginning printing without waiting for a print command

Printing

Printing of the 1st page is actually not finished,

but the “Printing

completed” status and

“Waiting to receive”

phase are sent.

Finishing process for printing page 1

Sending data for page 2

The printer is initialized.

Sending a print command (print command with feeding (1A) for the last page or print command (0C) for other pages)

If an error occurs, all data read from the computer is cleared.

Displaying printing

Sending a print command (print command with feeding (1A) for the last page or print command (0C) for other pages)

Reprinting 2nd page

An error appears. When restarted, data is resent starting with the 2nd page since “Printing” for the 2nd page is received.

READ

Any jobs with errors remaining in the printer are cleared.

Status information request

Status (response to status information request)

Sending control codes

Sending raster data

Initialize

Status

(Phase change :

“Printing”)

Sending raster data

Status (“Printing completed”)

Status (Phase change: “Waiting to receive”)

Sending control code/raster data

Sending raster data

Status

(Phase change :

“Printing”)

Phase change

“Printing” received.

“Printing completed” received.

Phase change “Waiting to receive” received.

Initialize

Status

(“Error Occurred”)

Phase change “Printing” received.

“Error Occured” received.

Printer

Printing 1st page

Printing 2nd page

Error occurred

Resending process for data of 2nd page

READ

Displaying sending

Displaying printing

Invalidate

5.3 Concurrent printing error flow for USB connection (with a concurrent printing error such as end of tape)

- 37 -

5. Flow Charts

Page 42

Raster Command Reference

Computer (host)

Printer

If there are no problems with the printer status (media, etc.), the data is transmitted. If there is a problem, an error appears.

The status of the printer (media, etc.) is checked and a response is sent.

Data received.

Beginning printing without waiting for a print command

Printing

Displaying sending

The printer is initialized.

Status

(Notification:

“Cooling (started)”)

Returned “NAK” from cooling

Repeating reading of maximum and transmission timeout times. If the transmission timeout is exceeded, reading, and displaying the cooling status if a hightemperature error is returned.

Failed

Status (Notification: “Cooling (finished)”)

Resuming printing

Continuing reading. 0 packets are returned while cooling. However, notifications are made while cooling only if a fan motor error occurs.

0 packet

When cooling is finished, Notification: “Cooling (finished)” is returned.

READ

Any jobs with errors remaining in the printer are cleared.

Status information request

Status (response to status information request)

Sending control codes

Sending raster data

Initialize

Status

(Phase change:

“Printing”)

Sending raster data

0 packet

Sending raster data

Cooling occured

Invalidate

5.4 Concurrent printing cooling flow for USB connection

- 38 -

5. Flow Charts

Page 43

Raster Command Reference

Computer (host)

Printer

Status information request

Status (response to status information request)

Printing

Display ing printing

Printing of the 1st page is actually not finished, but the

“Printing completed” status and “Waiting to receive” phase are

sent.

Sending control codes

Sending raster data

Initialize

The printer is initialized.

Status

(Phase change:

“Printing”)

Sending a print command (print command with feeding (1A) for the last page or print command (0C) for other pages)

Phase change

“Printing” received.

“Printing completed”

received.

Sending raster data

Status (“Printing completed”)

Status (Phase change:

“Waiting to receive”)

Sending control code/print data

Sending raster data

Finishing process for printing page 1

Sending data for page 2

Printing 1st page

Printing 2nd page

Sending raster data

READ

The status of the printer (media, etc.) is checked and a response is sent.

If there are no problems with the printer status (media, etc.), the data is transmitted. If there is a problem, an error appears.

Displaying sending

READ

Data received.

Beginning printing without waiting for a print command

Status

(Phase change:

“Printing”)

Invalidate

The printer is reset.

Paused and waiting for peeling

Canceled waiting for peeling

Notification (“Waiting for peeling”)

5.5 Concurrent printing waiting for peeling/resumed flow for USB connection

- 39 -

5. Flow Charts

Page 44

Raster Command Reference

If there are no problems with the printer status (media, etc.), the data is transmitted. If there is a problem, an error appears.

Data received.

Printing

Displaying printing

Displaying sending

Finishing process for printing 1st page

Sending data for 2nd page

The printer is initialized.

Phase change

“Printing” received.

“Printing completed”

received.

Phase change “Waiting to receive” received.

Printing 1st page

Printing 2nd page

Status information request

Status (response to status information request)

Sending control codes

Sending raster data

Initialize

Sending raster data

Sending a print command (print command with feeding (1A)

for the last page or print command (0C) for other page)

Status

(“Printing completed”)

Status

(Phase change: “Waiting to receive”)

Sending control codes

Sending raster data

Printer

Computer (host)

The status of the printer (media, etc.) is checked and a response is sent.

Sending raster data

READ

Status

(Phase change: “Printing”)

Invalidate

The printer is reset.

5.6 Buffered printing normal flow for serial/USB connection

- 40 -

5. Flow Charts

Page 45

Computer (host)

Status information request

Data received.

Printing Displaying printing

Displaying sending

Sending control codes

Sending raster data

Initialize

The printer is Initialized.

Sending a print command (print command with feeding (1A) for the last page or print command (0C) for other page)

Phase change “Printing” received.

Status (“Error Occurred”)

READ

Printer

If there are no problems with the printer status (media, etc.), the data is transmitted. If there is a problem, an error appears.

READ

Status (response to status information

request) or an error is displayed

Status

(Phase change: “Printing”)

Error occurred

The status of the printer (media, etc.) is checked and a response is sent.

Invalidate

The printer is reset.

5.7 Buffered printing error flow for serial/USB connection

Raster Command Reference

- 41 -

5. Flow Charts

Page 46

Raster Command Reference

Status (response to status request)

Data received.

Printing

Displaying printing

Displaying sending

The printer is initialized.

Phase change “Printing” received.

Phase change “Waiting to receive” received.

Printing 1st page

Printing 2nd page

Status

(Notification: “Cooling (started)”)

Printing

Cooling

* “Cooling (standard)”

and “Cooling (finished)” may be repeated multiple times during one printing operation.

Computer (host)

Status information request

Sending control codes

Sending raster data

Initialize

Sending a print command (print command with feeding (1A) for the last page or print command (0C) for other page)

Status

(Printing completed)

Status

(Phase change: “Waiting to receive”)

Sending control codes

Status

(Phase change :“Printing”)

“Printing completed” received.

Status

(Notification: “Cooling (finished)”)

Sending raster data

Printer

Sending raster data

If there are no problems with the printer status (media, etc.), the data is transmitted. If there is a problem, an error appears.

READ

Status (response to status

information request)

READ

End process for printing 1st page

Sending data for 2nd page

The printer is reset.

Invalidate

5.8 Buffered printing cooling flow for serial/USB connection

- 42 -

5. Flow Charts

Page 47

Raster Command Reference

If there are no problems with the printer status (media, etc.), the data is transmitted. If there is a problem, an error appears.

Data received.

Printing

Displaying printing

Displaying sending

Finishing process for printing 1st page

Sending data for 2nd page

The printer is initialized.

Phase change

“Printing” received.

“Printing completed”

received.

Phase change “Waiting to receive” received.

Printing 1st page

Printing 2nd page

Status information request

Status (response to status information request)

Sending control codes

Sending raster data

Initialize

Sending raster data

Sending a print command (print command with feeding (1A)

for the last page or print command (0C) for other page)

Status

(“Printing completed”)

Status

(Phase change: “Waiting to receive”)

Sending control codes

Sending raster data

Printer

Computer (host)

The status of the printer (media, etc.) is checked and a response is sent.

Sending raster data

READ

Status

(Phase change: “Printing”)

Invalidate

The printer is reset.

Paused and waiting for peeling

Canceled waiting for peeling

Notification

(Phase change: “Waiting for peeling”)

5.9 Buffered printing waiting for peeling/resumed flow for serial/USB connection

- 43 -

5. Flow Charts

Page 48

Raster Command Reference

BUSY

Computer（host）

Printer

The print data is divided into a specific size and sent.

Data received

Printing 1nd page

Data for 1st page to here

Sending data for 2nd page

Sending raster data

Printing 2nd page

Printing begins since the data for the first page was received.

Printing begins since the data for the second page was received.

Since transmission of the print data was completed, the job is erased from the computer. Printing is considered by

Printer buffer is full.

5.10 Buffered printing normal flow for network (standard TCP/IP port) connection

※With a network connection, print data from the operating system’s port monitor is sent as is.

The following example is for printing 2 pages.

- 44 -

5. Flow Charts

Page 49

Item

Description

Vendor ID

0x04F9

Product ID

TD-2020 : 0x2055 TD-2120N : 0x2057 TD-2130N : 0x2058

Class

Printer Mass storage

Character string for

manufacturer

Character string descriptor: 0x01 0x0409: “Brother”

Character string for

serial number

Character string descriptor: 0x03 0x0409: “000000001” Last twelve digits of the printer’s serial number

Device speed

Full speed

Number of interfaces

1 (No alternate interfaces)

Power supply

Self-powered (As a printer class, Bus power is also set to “ON”.)

End point 1

In bulk (Sends the status from the printer to the computer.) Maximum packet size: 64 bytes

End point 2

Out bulk (Sends print commands and data from the computer to the printer.) Maximum packet size: 64 bytes

Appendix A: USB Specifications

USB specifications 1.1

Raster Command Reference

- 45 Appendix A: USB Specifications

Page 50

Raster Command Reference

Appendix B: 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.htm

- 46 -

Appendix B: Introducing the Brother Developer Center

Page 51