Select your printer model
connect method
Starts communication with the printer.
Syntax
connect(ipAddress, port, callback); |
connect(ipAddress, port, callback, options); |
Parameter
ipAddress
Value |
Description |
---|---|
ipAddress |
Specifies the IP address of the printer. |
port
Specifies the communication method.
Value |
Description |
---|---|
8008 |
HTTP communication |
8043 |
SSL/TLS communication |
callback
Specifies a callback function to receive the execution result. One of the following strings is passed to the first parameter to indicate the result.
String |
Description |
---|---|
"OK" |
Connection via HTTP communication has been successful when the ePOS-Print option is enabled or not enabled. |
"SSL_CONNECT_OK" |
Connection via SSL/TLS communication has been successful when the ePOS-Print option is not enabled. |
"ERROR_TIMEOUT" |
Timeout occurred. |
"ERROR_PARAMETER" |
A parameter error occurred. |
options
Specifies properties using object literals.
Property |
Description |
true/false |
---|---|---|
eposprint |
Specifies whether or not to enable the ePOS-Print option. |
true: Enables the option. false: Disables the option. |
Enable the ePOS-Print option in the system configuration of the TM printer model and customer display model.
Disable the ePOS-Print option in the system configuration of TM Printer + DM-D + barcode scanner model and POS terminal model. When the ePOS-Print option is enabled, the peripheral devices other than the slave printers and customer display can no longer be controlled.
Example
connect("192.168.192.168", "8008", callback, {"eposprint" : true}); |
Supplementary explanation
- For the syntax to specify the options, refer to Epson ePOS SDK for JavaScript User's Manual.
- This API will succeed regardless of the connection status of the TM printer (master) and peripheral devices.
- For continuous processing, or for controlling the printer from a single terminal, it is recommended to keep the application connected with the devices.
- If the options parameter is omitted, "false: disabled" will be specified.
- When connection has failed while the ePOS-Print option is not enabled, enable the
ePOS-Print option and make the connection.
When this connection is successful, "OK" is passed to the callback parameter regardless of the communication method specified in the port parameter. - When the eposprint option is enabled by specifying 8043 in the port parameter and true in the options parameter, "OK" is returned to the callback parameter.
- When the eposprint option is enabled by specifying true in the options parameter, the methods that can be used in the ePOSDevice object are as follows.
-
Method
Availability
✔
✔
✔
✔
✔
✔
-
-
-
-
-
-
✔
- When using the Automatic certificate update feature, set the host name to the ipAddress.
The host name should be the product serial number hashed with SHA-256 and encoded with Base32, plus ".omnilinkcert.epson.biz" at the end of the string.
See the "connectHostName" method in the sample program "printer_sample.html" for an example of a program to generate a host name.
Select "8043" as the port.
The Automatic certificate update feature is only supported by some TM printers. To find out if this function is available for the TM printer you are using, refer to the "Application Development Information" chapter of the Technical Reference Guide for that TM printer.
Quick Access
- [Name]
- [Format]
- [Range]
- [Description]
- [Notes]
- Introduction
- help
- ePOSDevice object
- Common to device objects
- OtherPeripheral object
- Display object
- createWindow method
- destroyWindow method
- setCurrentWindow method
- clearWindow method
- addCreateScreen method
- addCreateScreenCustom method
- createTextArea method
- destroyTextArea method
- setCurrentTextArea method
- clearTextArea method
- setCursorPosition method
- moveCursorPosition method
- setCursorType method
- addText method
- addReverseText method
- addMarquee method
- setBlink method
- setBrightness method
- addBackgroundColor method
- addStartSlideShow method
- addStopSlideShow method
- addDownloadImage method
- addRegisterDownloadImage method
- addNVImage method
- addClearImage method
- addSymbol method
- addClearSymbol method
- showClock method
- addCommand method
- send method
- reset method
- onreceive event
- Keyboard object
- POSKeyboard object
- MSR object
- Printer object
- addTextAlign method
- addTextLineSpace method
- addTextRotate method
- addText method
- addTextLang method
- addTextFont method
- addTextSmooth method
- addTextDouble method
- addTextSize method
- addTextStyle method
- addTextPosition method
- addTextVPosition method
- addFeedUnit method
- addFeedLine method
- addFeedPosition method
- addFeed method
- addImage method
- addLogo method
- addBarcode method
- addSymbol method
- addHLine method
- addVLineBegin method
- addVLineEnd method
- addPageBegin method
- addPageEnd method
- addPageArea method
- addPageDirection method
- addPagePosition method
- addPageLine method
- addPageRectangle method
- addRotateBegin method
- addRotateEnd method
- addCut method
- addPulse method
- addSound method
- addLayout method
- recover method
- addRecovery method
- reset method
- addReset method
- addCommand method
- send method
- print method
- getPrintJobStatus method
- startMonitor method
- stopMonitor method
- halftone property
- brightness property
- force property
- timeout property
- interval property
- drawerOpenLevel property
- message property
- onreceive event
- onstatuschange event
- onbatterystatuschange event
- ononline event
- onoffline event
- onpoweroff event
- oncoverok event
- oncoveropen event
- onpaperok event
- onpapernearend event
- onpaperend event
- ondrawerclosed event
- ondraweropen event
- onbatteryok event
- onbatterylow event
- HybridPrinter2 object
- lock method
- unlock method
- selectPaperType method
- waitInsertion method
- cancelInsertion method
- ejectPaper method
- sendData method
- print method
- readMicrData method
- cleanMicrReader method
- recover method
- reset method
- startMonitor method
- stopMonitor method
- setMessage method
- getMessage method
- halftone property
- brightness property
- force property
- paperType property
- interval property
- waitTime property
- enable40cplMode property
- onreceive event
- Scanner object
- SimpleSerial object
- GermanyFiscalElement object
- DeviceHubTerminal object
- CommBoxManager object
- CommBox object
- ePosDeviceConfiguration object
- Appendix
- Error Code List
- Key code list
- List of Supported Objects
- 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-T20II
- TM-T20III
- TM-T82III
- TM-T88VI
- TM-T88VII
- TM-L100
- TM-T70
- TM-T70II
- TM-T88IV
- TM-T88V
- TM-U220
- TM-U220II
- TM-U330
- TM-P20
- TM-P20II
- 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-U220IIB-i
- TM-T70II-DT
- TM-T70II-DT2
- TM-T88V-DT
- TM-T88VI-DT2
- TM-H6000IV-DT
- TM-T20
- TM-T82II
- TM-T83II
- TM-T90
- TM-L90
- TM-H6000IV
- Usage restriction by firmware version