1. TOP»
  2. ePOS-Print XML »
  3. XML for Controlling Printer »
  4. <response>

Select your printer model

Parameters are refined by the selected printer.

<response>

This is an XML document that is sent back from a printer to an application.

Attribute

Attribute

Description

success

Print result

code

Error code

status

Status

battery

Battery status

success

Attribute value

Description

"true" / "1"
  • Print succeeded
  • Process succeeded (when the spooler function is enabled)

"false" / "0"
  • Failed to print
  • Process failed (when the spooler function is enabled)

code

Attribute value

Description

"EPTR_AUTOMATICAL"

Automatic recovery error occurred

"EPTR_BATTERY_LOW"

Battery has run out

"EPTR_COVER_OPEN"

Cover open error occurred

"EPTR_CUTTER"

Auto cutter error occurred

"EPTR_MECHANICAL"

Mechanical error occurred

"EPTR_REC_EMPTY"

No paper is left in the roll paper end detector

"EPTR_UNRECOVERABLE"

Unrecoverable error occurred

"SchemaError"

Error exists in the requested document syntax

"DeviceNotFound"

Printer specified by the device ID does not exist

"PrintSystemError"

Error occurred with the printing system

"EX_BADPORT"

An error occurred with the communication port

"EX_TIMEOUT"

Print timeout occurred

"EX_SPOOLER"

Print queue is full

"EX_DEVICE_BUSY"

The specified device is in process and the process cannot be executed.

"EX_ENPC_TIMEOUT"

Status check failed.

"JobNotFound"

Specified job ID does not exist

"Printing"

Printing in progress

"TooManyRequests"

The number of print jobs sent to the printer has exceeded the allowable limit.

"RequestEntityTooLarge"

The size of the print job data exceeds the capacity of the printer.

"ERROR_WAIT_EJECT"

Waiting for paper removal.

status

One or more of the following values that represent the printer status are combined using bitwise OR operator, and expressed in decimal notation.

Attribute value

Description

"0x00000001"

No response from TM printer

"0x00000002"

Printing completed

"0x00000004"
  • Drawer kick connector pin No.3 status (Cash drawer open/close status) = "H"
  • Offline status due to the battery level*

"0x00000008"

Offline status

"0x00000020"

Cover is open

"0x00000040"

Paper is being fed by the paper feed switch

"0x00000200"

Paper feed switch is held depressed

"0x00000400"

Mechanical error occurred*

"0x00000800"

Auto cutter error occurred

"0x00002000"

Unrecoverable error occurred*

"0x00004000"

Automatic recovery error occurred*

"0x00010000"

Waiting for insertion of a slip sheet for slip printing

"0x00020000"

Roll paper has almost run out

"0x00040000"

Waiting for ejection of a slip sheet for slip printing

"0x00080000"

Roll paper has run out

"0x01000000"

Buzzer is sounding (supported model only)

"0x01000000"
  • Waiting for labels to be removed (supported model only)
  • Waiting for paper removal (supported model only)

"0x04000000"
  • No paper is detected with the label peeler sensor (supported model only)
  • No paper is detected with the paper removal detector (supported model only)

"0x80000000"

Spooler stopped

* For more information on the printer status, see the Technical Reference Guide for the TM printer.

battery

One or more of the following values that represent the battery status are combined using bitwise OR operator, and expressed in decimal notation.

  • AC adapter connection status

  • Attribute value

    Description

    "0x30XX"

    AC adapter is connected

    "0x31XX"

    AC adapter is not connected
  • Remaining battery capacity

  • Attribute value

    Description

    "0xXX36"

    Remaining battery capacity 6

    "0xXX35"

    Remaining battery capacity 5

    "0xXX34"

    Remaining battery capacity 4

    "0xXX33"

    Remaining battery capacity 3

    "0xXX32"

    Remaining battery capacity 2

    "0xXX31"

    Remaining battery capacity 1 (almost run out)

    "0xXX30"

    Remaining battery capacity 0 (run out)

Sample program

  • When the printer runs out of paper during printing and failed to print
  •  
    		 
    <response xmlns="http://www.epson-pos.com/schemas/2011/03/epos-print" success="false" code="EPTR_REC_EMPTY" status="252641308" battery="0" />
  • When the printer runs out of battery during printing and failed to print
  •  
    		 
    <response xmlns="http://www.epson-pos.com/schemas/2011/03/epos-print" success="false" code="EPTR_BATTERY_LOW" status="251658268" battery="12592" />

Supplementary explanation

  • Timing of the printer response differs by printer status.

  • Printer status

    Description

    The power is on

    The timing set on the printer

    The power is off

    The timing when a client timeout occurs

    Printing: an error occurs

    Before printing

    Printing: print succeeded

    After printing completed
  • A value other than those listed above may be returned as the value of Status. In such cases, ignore the value.
  • For a model without battery, 0xXX30 is set to the battery constant.
 

Quick Access

  • [Name]
  • [Format]
  • [Range]
  • [Description]
  • [Notes]
ePOS-Print XML includes patented or patent pending functions. The contents must not be disclosed to third parties.


  1. TOP»
  2. ePOS-Print XML »
  3. XML for Controlling Printer »
  4. <response>

Jump to the top