Select your printer model
getPrinterInformation
Acquires the printer serial number and the missing dot information of the thermal head.
The value acquired by this API is notified to the listener method specified in the listener parameter.
Syntax
public void getPrinterInformation(int timeout, PrinterInformationListener listener) throws Epos2Exception |
Parameter
timeout
Specifies the timeout period before completion of command transmission in milliseconds.
Value |
Description |
---|---|
Integer from 5000 to 60000 |
Timeout period (in milliseconds) |
Printer.PARAM_DEFAULT |
Specifies the default value (10000). |
listener
Registers the listener method that returns the processing result of this API.
- (void) onGetPrinterInformation(int code, String jsonString); |
- code
The processing result is stored. -
Error status
Description
CODE_SUCCESS
Successful
CODE_ERR_PARAM
An invalid parameter was passed.
CODE_ERR_MEMORY
Sufficient memory required for processing could not be allocated.
CODE_ERR_TIMEOUT
Failed to communicate with the devices within the specified time.
CODE_ERR_PROCESSING
Could not run the process.
CODE_ERR_ILLEGAL
This API was called while no communication had been started.
CODE_ERR_DEVICE_BUSY
Could not run the process because the printer is operating.
CODE_ERR_FAILURE
An unknown error occurred.
- jsonString
The acquired printer information is stored in the JSON format.
Exception
When the process fails, Epos2Exception with one of the following error status occurs.
Error status |
Description |
---|---|
ERR_PARAM |
An invalid parameter was passed. |
ERR_FAILURE |
An unknown error occurred. |
ERR_ILLEGAL |
This API was called while no communication had been started. |
jsonString
Example of acquisition execution result
{ "PrinterSpec": { "Product": { "SerialNo": "ABC1234567" } }, "Maintenance": { "ThermalHead": { "NumberOfWarningDot": "0", "PositionOfWarningDot": "", "NumberOfBrokenDot": "0", "PositionOfBrokenDot": "" } } } |
SerialNo
Value |
Description |
---|---|
String |
Printer serial number |
NumberOfWarningDot
The number of dots exceeding the Warning threshold value of the thermal head is stored.
Value |
Description |
---|---|
-1 |
Failed to detect missing dots. |
0 |
No dots exceeding the Warning threshold value. |
Integer from 1 to 512 |
Number of dots exceeding the Warning threshold value. |
PositionOfWarningDot
If there are dots exceeding the Warning threshold value of the thermal head, a 128-byte hexadecimal string is stored.
In this hexadecimal string, the position of the left-end dots on the print surface is treated as the most significant bit, and the position of the dots exceeding the Warning threshold value is treated as bit 1.
Value |
Description |
---|---|
"" (Blank character) |
Failed to detect missing dots. Alternatively, there are no dots exceeding the Warning threshold value. |
Hexadecimal string |
Most significant bit: Position of the left-end dots on the print surface bit 1: Position of the dots exceeding the Warning threshold value. |
NumberOfBrokenDot
The number of dots exceeding the Fault threshold value of the thermal head is stored.
Value |
Description |
---|---|
-1 |
Failed to detect missing dots. |
0 |
No dots exceeding the Fault threshold value. |
Integer from 1 to 512 |
Number of dots exceeding the Fault threshold value. |
PositionOfBrokenDot
If there are dots exceeding the Fault threshold value of the thermal head, a 128-byte hexadecimal string is stored.
In this hexadecimal string, the position of the left-end dots on the print surface is treated as the most significant bit, and the position of the dots exceeding the Fault threshold value is treated as bit 1.
Value |
Description |
---|---|
"" (Blank character) |
Failed to detect missing dots. Alternatively, there are no dots exceeding the Fault threshold value. |
Hexadecimal string |
Most significant bit: Position of the left-end dots on the print surface bit 1: Position of the dots exceeding the Fault threshold value. |
Supplementary explanation
- This API cannot be used simultaneously with other APIs.
After executing this API, do not execute any other API until the callback is returned. - This API can be used in the system configuration of the TM printer model and customer
display model.
With the system configuration of the TM printer + DM-D + barcode scanner model, this API can be used when connecting via Bluetooth and USB. - This API cannot be used with SSL/TLS communication.
- When this API is used with the system configuration of a POS terminal model and TM printer + DM-D + barcode scanner model (Wi-Fi/Ethernet connection), Epos2Exception including ERR_FAILURE occurs.
- If this API is executed in a non-supported printer, "" (Blank character) is stored in jsonString.
- It may take some time to acquire printer information depending on the printer used or the connection method with the printer.
Quick Access
- [Name]
- [Format]
- [Range]
- [Description]
- [Notes]
- Introduction
- help
- Printer class
- Printer
- connect
- disconnect
- startMonitor
- stopMonitor
- getStatus
- sendData
- beginTransaction
- endTransaction
- requestPrintJobStatus
- clearCommandBuffer
- addTextAlign
- addLineSpace
- addTextRotate
- addText
- addTextLang
- addTextFont
- addTextSmooth
- addTextSize
- addTextStyle
- addHPosition
- addFeedUnit
- addFeedLine
- addImage
- addLogo
- addBarcode
- addSymbol
- addHLine
- addVLineBegin
- addVLineEnd
- addPageBegin
- addPageEnd
- addPageArea
- addPageDirection
- addPagePosition
- addPageLine
- addPageRectangle
- addRotateBegin
- addRotateEnd
- addCut
- addPulse
- addSound
- addFeedPosition
- addLayout
- addCommand
- getMaintenanceCounter
- resetMaintenanceCounter
- getPrinterSetting
- setPrinterSetting
- getPrinterSettingEx
- setPrinterSettingEx
- setPrinterSettingEx[Obsolete]
- verifyPassword
- getPrinterInformation
- downloadFirmwareList
- getPrinterFirmwareInfo
- verifyUpdate
- updateFirmware
- forceRecover
- forcePulse
- forceStopSound
- forceCommand
- forceReset
- setStatusChangeEventListener
- setReceiveEventListener
- setGetPrinterSettingExListener
- setSetPrinterSettingExListener
- setVerifyPasswordListener
- interval
- LFCPrinter class
- HybridPrinter class
- HybridPrinter
- connect
- disconnect
- startMonitor
- stopMonitor
- getStatus
- sendData
- beginTransaction
- endTransaction
- clearCommandBuffer
- selectPaperType
- waitInsertion
- cancelInsertion
- ejectPaper
- readMicrData
- cleanMicrReader
- forceRecover
- forcePulse
- forceCommand
- forceReset
- paperType
- interval
- waitTime
- mode40Cpl
- setStatusChangeEventListener
- setReceiveEventListener
- LineDisplay class
- LineDisplay
- connect
- disconnect
- getStatus
- sendData
- clearCommandBuffer
- addInitialize
- addCreateWindow
- addDestroyWindow
- addSetCurrentWindow
- addClearCurrentWindow
- addCreateScreen
- addCreateScreenCustom
- addCreateTextArea
- addDestroyTextArea
- addSetCurrentTextArea
- addClearCurrentTextArea
- addSetCursorPosition
- addMoveCursorPosition
- addSetCursorType
- addText
- addReverseText
- addMarqueeText
- addSetBlink
- addSetBrightness
- addBackgroundColor
- addStartSlideShow
- addStopSlideShow
- addDownloadImage
- addRegisterDownloadImage
- addNVImage
- addClearImage
- addSymbol
- addClearSymbol
- addShowClock
- addCommand
- setReceiveEventListener
- Keyboard class
- POSKeyboard class
- BarcodeScanner class
- MSR class
- SimpleSerial class
- GermanyFiscalElement class
- OtherPeripheral class
- CommBox class
- Common to all classes
- Discovery class
- Epos2Exception class
- Log class
- EasySelect class
- EasySelectInfo class
- Appendix
- Status list
- Key code list
- List of Supported Classes
- List of Supported APIs
- Printer-specific Support Information
- TM-m10
- TM-m30
- TM-m30II
- TM-m30II-H
- TM-m30II-NT
- TM-m30II-S
- TM-m30II-SL
- TM-m30III
- TM-m30III-H
- TM-m50
- TM-m50II
- TM-m50II-H
- TM-T20
- TM-T20II
- TM-T20III
- TM-T20IIIL
- TM-T20IV-L
- TM-T20X
- TM-T20X-II
- TM-T60
- TM-T70
- TM-T70II
- TM-T81II
- TM-T81III
- TM-T82
- TM-T82II
- TM-T82III
- TM-T82IIIL
- TM-T82IV-L
- TM-T82X
- TM-T82X-II
- TM-T83II
- TM-T83III
- TM-T83IV
- TM-T88V
- TM-T88VI
- TM-T88VII
- TM-T100
- TM-L90 Liner-Free Label Printer Model
- TM-L100
- TM-U220
- TM-U330
- EU-m30
- TM-P20
- TM-P20II
- TM-P60 (Receipt)
- TM-P60 (Peeler)
- TM-P60II (Receipt)
- TM-P60II (Peeler)
- TM-P80
- TM-P80II
- TM-H6000V
- TM-T20II-i
- TM-T70-i
- TM-T82II-i
- TM-T83II-i
- TM-T88V-i
- TM-T88VI-iHUB
- TM-U220-i
- TM-T70II-DT
- TM-T70II-DT2
- TM-T88V-DT
- TM-T88VI-DT2
- TM-H6000IV-DT
- TM-T88IV
- TM-T90
- TM-L90
- TM-H6000IV