Printer Status Codes

Printer status codes are similar to http status codes, but not directly compatible.
They are a 3 or 4 digit error code, which can be followed by a space, and then an error description.
Note that error descriptions are intended for logging, and may vary between clients.
Error codes will be added to this document as required, but follow a pattern meaning that a server need not recognise all specific error codes.
For example, all codes beginning “2” (200, 211, etc.) mean that the printer is online, all codes beginning with a “4” represent a printer error, etc.
Printer status codes are used in the following places.

Polling the server (POST)

MQTT messages published by printers

2xx

Code

Description

2xx

Printer is online.

20x

Printer is online and able to print.

200

OK. Printer is online and able to print.

201 (*1)

Output paper has been taken and printer is able to print.

211

Paper low.

22x (*1)

Printer for a model of presenter style is online, but printer is busy based on a paper is printing in progress or an output paper is waiting to be taken.

220 (*1)

Printing is progress.

221 (*1)

Output paper is present.

23x (*2)

Notifications of when parts need to be cleaned or replaced.

230 (*2)

Cleaning Notification

231 (*2)

Parts Replacement Notification
(*1) This statusCode is supported by TSP650IISK printer with IFBD-HI01X, mC-Label3, and TSP100IV SK.
(*2) This statusCode is supported by mC-Label3.

4xx

Code

Description

4xx

Printer error : all codes beginning with 4 indicate a failure due to printer error.

41x

Paper error.

410

Out of paper.

411 (*1)

Paper jam.

412 (*2)

Roll Position Error.

42x

Cover open error.

420

Cover open.
(*1) This statusCode is supported by mC-Label3 and TSP100IV SK.
(*2) This statusCode is supported by mC-Label3.

5xx

Code

Description

5xx

Client error : all codes beginning with 5 indicate a client issue.

51x

Media compatibility error.

510

Incompatible media type, client does not support the data issued by the server.

511
Media decoding error. Client supports the media type, but failed to decode it.
May indicate a data corruption, or differing versions of the media format.

512
Unsupported media version. Means that the media type is supported, but the version issued by the server is not compatible.
E.g. client may support PDF up to 1.4, but not 1.5.

52x

Job download error.

520

Timeout, client could not download the job within an internal timeout limit.

521
Job too large.
The job data is too large for the client’s download buffer or exceeds a specified size limit.
The MQTT message size is too large for the printer’s buffer.
The value of the printData key in the MQTT message print-job is too large for the buffer (when the value of jobType key is "raw").

1xxx

Code

Description

1xxx

Relates to errors resulting from information received from a CloudPRNT server

10xx

Error caused by server response of Server setting information request (GET)

1000

There is an error in the JSON format of the received response Body.

1001

There is no required key in the JSON of the received response Body, or the value of the required key is invalid.

11xx

Server MQTT message error.

1100

The topic of the received MQTT message is an undefined method name.

1101

There is an error in the payload JSON format of the received MQTT message.

1102

Missing required key or incorrect value for required key in payload JSON of received MQTT message.

12xx

Server MQTT message, print-job related errors

1200

The received print-job cannot be printed because the printer is currently printing.

1201

jobToken key is not specified.

1202

The specified jobToken value has already been used recently. The printer remembers the last 10 job tokens.