Select your printer model
<type>onreceive</type>
Acquires the result of the request given by the following elements and notifies the application of the result.
- <type>lock</type> element
- <type>unlock</type> element
- <type>slipwaitinsertion</type> element
- <type>slipprint2</type> element
- <type>slipcancel</type> element
- <type>endorsewaitinsertion</type> element
- <type>endorseprint2</type> element
- <type>endorsecancel</type> element
- <type>validationwaitinsertion</type> element
- <type>validationprint2</type> element
- <type>validationcancel</type> element
- <type>micrread</type> element
- <type>micrcleaning</type> element
- <type>micrcancel</type> element
- <type>eject</type> element
Response
Child element |
Data type |
Description |
---|---|---|
eventtype |
string |
Name of the element to return the event |
success |
string |
Processing result of the element to return the event |
code |
string |
Execution result of the element to return the event |
status |
string |
Status of the printer |
data |
string |
MICR read result |
success
Attribute value |
Description |
---|---|
"true" / "1” |
Enabled |
“false” / “0” |
Disabled |
code
Attribute value |
Description |
---|---|
'SUCCESS' |
Success |
'CANCEL' |
Cancels the paper insertion wait status. |
'ERROR_CANCEL_FAILED' |
Failed to cancel the paper insertion wait status. |
'ERROR_PARAMETER' |
A parameter error occurred. |
'ERROR_COMMAND' |
The paper type in the paper insertion wait unlock command does not match with the type of paper that the printer is waiting to be inserted. |
'ERROR_DEVICE_NOT_FOUND' |
The device was not found. |
'ERROR_DEVICE_BUSY' |
|
'ERROR_NOT_SUPPORTED' |
The printer does not support the requested function. |
'ERROR_COVER_OPEN' |
Cover open error occurred. |
'ERROR_TIMEOUT' |
Paper insertion wait timeout. |
'ERROR_AUTOMATICAL' |
Automatic recovery error occurred. |
'ERROR_UNRECOVERABLE' |
Unrecoverable error occurred. |
'ERROR_WAIT_EJECT' |
Paper eject error occurred. |
'SYSTEM_ERROR' |
A system error occurred. |
'EPTR_MECHANICAL' |
Mechanical error occurred. |
'EPTR_SCHEMAERROR' |
Error occurred in the requested document syntax. |
'EPTR_PAPER_PULLED_OUT' |
|
'EPTR_CUTTER' |
Auto cutter error occurred. |
'EPTR_REC_EMPTY' |
Roll paper has run out. |
'EMICR_ILLEGAL_LENGTH' |
Inserted paper is not of an appropriate length. |
'EMICR_NO_MICR' |
Cannot detect MICR data. |
'EMICR_RECOGNITION' |
Illegible MICR text was detected. |
'EMICR_READ' |
Error occurred during MICR read operation. |
'EMICR_NOISE_DETECTED' |
Noise error was detected. |
'EMICR_COVER_OPEN' |
Cover was opened during MICR read operation. |
'EMICR_PAPER_JAM' |
Paper jam error occurred. |
'EMICR_PAPER_PULLED_OUT' |
Paper was removed during MICR read operation. |
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” |
Drawer kick connector pin No.3 status = "H" |
“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” |
Slip sheet is not inserted deep enough. |
“0x00400000” |
Slip sheet is not correctly aligned with the right edge of the paper guide. |
“0x01000000” |
Slip printing is not selected. |
“0x02000000” |
Cannot print on the slip sheet. |
“0x04000000” |
Validation printing is not selected. |
“0x08000000” |
Cannot print on the validation sheet. |
“0x20000000” |
Validation sheet is not inserted deep enough. |
“0x40000000” |
Validation sheet is not correctly aligned with the right edge of the paper guide. |
“0x80000000” |
Spooler is stopped (not used). |
Supplementary explanation
- A null string (" ") is set to the child element data if an element other than the <type>micrread</type> is executed.
- No <type>onxmlresult</type> is notified if a communication error occurs.
To notify the disconnection event, implement the <reconnect>. - If a communication error occurs and it is deemed that no recovery will take place,
notify <disconnect>.
Since no <type>onxmlresult</type> is notified in this case, detect print failures in <disconnect>.
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