Select your printer model
<response>
This is an XML returned from the printer to the application.
Attribute
Attribute |
Description |
---|---|
success |
Print result |
code |
Error code |
status |
Status |
battery |
Battery status |
success
Attribute value |
Description |
---|---|
"true" / "1” |
|
“false” / “0” |
|
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' |
Error detected with the communication port. |
'EX_TIMEOUT' |
Print timeout occurred. |
‘EX_SPOOLER' |
Print queue is full. |
‘JobNotFound' |
Specified job ID does not exist. |
‘Printing' |
Printing |
“JobSpooling” |
Spooling |
“TooManyRequests” |
The number of print jobs sent to the printer has exceeded the allowable limit. |
“RequestEntityTooLarge” |
The data size of the print job is larger than the allowable limit of the printer. |
“ERROR_WAIT_EJECT” |
Waiting for paper removal. |
status
Acquires the logical OR of the values listed below in decimal value depending on the printer status.
Attribute value |
Description |
---|---|
“0x00000001” |
TM printer does not respond. |
“0x00000002” |
Printing completed. |
“0x00000004” |
|
“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” |
Automatically recoverable 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. |
“0x00200000” |
Paper is not inserted deep enough. |
“0x00400000” |
Paper is not correctly aligned with the right edge of the paper guide. |
“0x01000000” |
|
“0x02000000” |
Cannot print on the paper. |
“0x04000000” |
|
“0x80000000” |
Spooler stopped |
* For more information on the printer status, see the Technical Reference Guide for the TM printer.
battery
Acquires the logical OR of the values listed below in decimal value depending on the battery status.
- 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 printing succeeded
-
<response success=”true” code=”” status=””/>
- When printing failed because the printer has run out of paper
-
<response xmlns="http://www.epson-pos.com/schemas/2011/03/epos-print" success="false" code="EPTR_REC_EMPTY" status="252641308" />
Supplementary explanation
- 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]
- Introduction
- help
- Message
- CommunicationBox Messages
- Device Messages
- DeviceHubTerminal
- BarcodeScanner
- Printer
- <type>print</type>
- <type>onxmlresult</type>
- <epos-print>
- <response>
- <text>
- <feed>
- <image>
- <logo>
- <barcode>
- <symbol>
- <hline>
- <vline-begin>
- <vline-end>
- <page>
- <area>
- <direction>
- <position>
- <line>
- <rectangle>
- <cut>
- <pulse>
- <sound>
- <command>
- <layout>
- <recovery>
- <reset>
- <batch-begin>
- <batch-end>
- <rotate-begin>
- <rotate-end>
- HybridPrinter
- <type>lock</type>
- <type>unlock</type>
- <type>print</type>
- <type>onxmlresult</type>
- <type>slipwaitinsertion</type>
- <type>slipprint2</type>
- <type>slipcancel</type>
- <type>endorsewaitinsertion</type>
- <type>endorseprint2</type>
- <type>endorsecancel</type>
- <type>validationwaitinsertion</type>
- <type>validationprint2</type>
- <type>validationcancel</type>
- <type>micrread</type>
- <type>micrcleaning</type>
- <type>micrcancel</type>
- <type>eject</type>
- <type>onreceive</type>
- CustomerDisplay
- Keyboard
- POSKeyboard
- MSR
- SerialDevice
- Storage
- OtherPeripheral
- Appendix