Select your printer model
connect
Starts communication with the POS keyboard.
Syntax
public void connect(String target, int timeout) throws Epos2Exception |
Parameter
target
Specifies the method of connecting to the printer by a character string.
Specify the connection method using the following syntax.
<connection type>:<identifier>[<device ID>]
I/F |
Connection type |
Identifier |
Description |
||
---|---|---|---|---|---|
Wi-Fi/Ethernet |
|
|
|
To connect to the printer via SSL/TLS communication, specify TCPS in the connection type.
timeout
Specifies the maximum time (in milliseconds) to wait for communication with the printer to be established.
Value |
Description |
---|---|
Integer from 1000 to 300000 |
Maximum wait time before an error is returned (in milliseconds). |
Poskeyboard.PARAM_DEFAULT |
Specifies the default value (15000). |
Exception
When the process fails, Epos2Exception with one of the following error value occurs.
Error status |
Description |
---|---|
ERR_PARAM |
An invalid parameter was passed. |
ERR_CONNECT |
Failed to open the device. |
ERR_TIMEOUT |
Failed to communicate with the devices within the specified time. |
ERR_ILLEGAL |
Tried to start communication with a printer with which communication had been already established. Tried to start communication with a printer during reconnection process. |
ERR_MEMORY |
Necessary memory could not be allocated. |
ERR_FAILURE |
An unknown error occurred. |
ERR_PROCESSING |
Could not run the process. |
ERR_NOT_FOUND |
The printer could not be found. |
ERR_IN_USE |
The device was in use. |
ERR_TYPE_INVALID |
The device type is different. |
ERR_RECOVERY_FAILURE |
Failed to recover the printer. |
Supplementary explanation
- The device ID is a logical device name that is set when the POS keyboard is registered to the TM printer (master). For details, refer to the TM-DT Series Peripheral Device Control Guide.
- When using multi-threading to connect to multiple printers or peripheral devices, this API and disconnect cannot be started for other printers or peripheral devices until this API finishes processing. Start the next process after this API finishes processing.
- Devices other than printers are exclusively locked.
- If Epos2Exception including ERR_RECOVERY_FAILURE occurs, restart 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