- DOWNLOAD
- TECH.REFERENCE
- ESC/POS Command for TM Printer
- Character Code Tables for TM Printer
- ESC/POS Command for Customer Displays
- Character Code Tables for Customer Displays
- Epson ePOS SDK for Android
- Epson ePOS SDK for iOS
- Epson ePOS SDK for JavaScript
- Epson ePOS SDK for Universal Windows apps
- ePOS-Device XML
- ePOS-Print XML
- TM-INTELLIGENT
List of ePOS SDK API
Epson ePOS SDK for Universal Windows apps provides the following classes:
Note:
- Available APIs and parameters vary by printer model and peripheral device.
Refer to Supported printers for each class. - APIs included in the Printer class and APIs supported by each printer model are listed in List of Supported APIs.
- Printer class
- HybridPrinter class
- LineDisplay class
- Keyboard class
- BarcodeScanner class
- SimpleSerial class
- CommBox class
- Common to all classes
- Discovery class
- Log class
Printer class
Controls printing by the printer.
Two print modes are available; standard and page modes.
- Standard mode
-
Prints line by line. Line spacing is automatically adjusted according to character size, image size, and barcode height. Suitable for printing receipts whose print length varies by print content.
- Page mode
-
Prints page by page. Prints characters, images, and/or barcodes on a single page that is defined as a print area.
When processing in the page mode, use AddPageBegin to start and AddPageEnd to end the page mode process, respectively.
API |
Description |
Standard mode |
Page mode |
|
---|---|---|---|---|
Initialization |
Initializes the Printer class. |
- |
- |
|
Communication path |
Connects to the printer. |
- |
- |
|
Disconnects from the printer. |
- |
- |
||
Status monitor |
Enables status event notification. |
✔ |
✔ |
|
Disables status event notification. |
✔ |
✔ |
||
Status acquisition |
Acquires status of the connected printer. |
✔ |
✔ |
|
Transmission |
Sends a command to the printer. |
✔ |
✔ |
|
Transaction |
Starts a transaction. |
✔ |
✔ |
|
Ends a transaction. |
✔ |
✔ |
||
Print job |
Acquires the print result. |
✔ |
✔ |
|
Buffer clear |
Clears the command buffer. |
✔ |
✔ |
|
Text |
Adds text alignment setting to the command buffer. |
✔ |
- |
|
Adds line spacing setting to the command buffer. |
✔ |
✔ |
||
Adds text rotation setting to the command buffer. |
✔ |
- |
||
Adds text to print to the command buffer. |
✔ |
✔ |
||
Adds language setting to the command buffer. |
✔ |
✔ |
||
Adds character font setting to the command buffer. |
✔ |
✔ |
||
Adds character smoothing setting to the command buffer. |
✔ |
✔ |
||
Adds character scaling factor setting to the command buffer. |
✔ |
✔ |
||
Adds character style setting to the command buffer. |
✔ |
✔ |
||
Adds character print position setting to the command buffer. |
✔ |
✔ |
||
Paper feed |
Adds paper-feed setting in dots to the command buffer. |
✔ |
✔ |
|
Adds paper-feed setting in lines to the command buffer. |
✔ |
✔ |
||
Graphics |
Adds a raster image print command to the command buffer. |
✔ |
✔ |
|
Adds a NV logo print command to the command buffer. |
✔ |
✔ |
||
Barcode |
Adds a barcode print command to the command buffer. |
✔ |
✔ |
|
Adds a 2D symbol print command to the command buffer. |
✔ |
✔ |
||
Ruled line |
Adds a horizontal ruled line print command to the command buffer. |
✔ |
- |
|
Adds a vertical ruled line start command to the command buffer. |
✔ |
- |
||
Adds a vertical ruled line end command to the command buffer. |
✔ |
- |
||
Page mode |
Adds a page mode start command to the command buffer. |
✔ |
- |
|
Adds a page mode end command to the command buffer. |
- |
✔ |
||
Adds page mode print area setting to the command buffer. |
- |
✔ |
||
Adds page mode print direction setting to the command buffer. |
- |
✔ |
||
Adds page mode print position setting to the command buffer. |
- |
✔ |
||
Adds a page mode line draw command to the command buffer. |
- |
✔ |
||
Adds a page mode rectangle draw command to the command buffer. |
- |
✔ |
||
Cut |
Adds a sheet cut command to the command buffer. |
✔ |
- |
|
Drawer |
Adds a drawer kick command to the command buffer. |
✔ |
- |
|
Buzzer |
Adds a buzzer sound command to the command buffer. |
✔ |
- |
|
Label sheet/black mark sheet |
Adds a paper feed command to the command buffer. |
✔ |
- |
|
Adds sheet layout setting to the command buffer. |
✔ |
- |
||
Command |
Adds a command to the command buffer. |
✔ |
✔ |
API |
Description |
|
---|---|---|
Forced transmission |
Forced transmission function |
|
Reception of result |
Registers the event handler. |
|
Monitor interval |
Status monitor interval |
HybridPrinter class
Controls the hybrid model printers.
API |
Description |
|
---|---|---|
Initialization |
Initializes the HybridPrinter class. |
|
Communication path |
Connects to the printer. |
|
Disconnects from the printer. |
||
Status monitor |
Enables status event notification. |
|
Disables status event notification. |
||
Status acquisition |
Acquires status of the connected printer. |
|
Transmission |
Sends a print document. |
|
Transaction |
Starts a transaction. |
|
Ends a transaction. |
||
Buffer clear |
Clears the command buffer. |
|
Print method |
Specifies a print method. |
|
Paper feed |
Waiting for paper insertion. |
|
Cancels waiting for paper insertion. |
||
Paper eject |
Ejects paper. |
|
MICR |
MICR reading |
|
Cleans the MICR mechanism. |
||
Forced transmission |
Forced transmission function |
|
Print method acquisition |
Acquires the print method setting information. |
|
Monitor interval |
Printer status update interval |
|
On standby |
Time from insertion of a paper to start of operation |
|
40cpl mode |
Sets the 40 cpl mode. |
|
Reception of result |
Registers the event listener registration method. |
|
List of supported control operations for HybridPrinter class
APIs available for the HybridPrinter class depend on the type of control operation.
The following lists control operation types and available APIs.
API |
Control operation |
||||
---|---|---|---|---|---|
Receipt |
Slip sheet |
Endorsement |
Validation |
MICR |
|
✔ |
✔ |
✔ |
✔ |
✔ |
|
✔ |
✔ |
✔ |
✔ |
✔ |
|
✔ |
✔ |
✔ |
✔ |
✔ |
|
✔ |
✔ |
✔ |
✔ |
✔ |
|
✔ |
✔ |
✔ |
✔ |
✔ |
|
✔ |
✔ |
✔ |
✔ |
✔ |
|
✔ |
✔ |
✔ |
✔ |
- |
|
✔ |
✔ |
✔ |
✔ |
✔ |
|
✔ |
✔ |
✔ |
✔ |
✔ |
|
✔ |
✔ |
✔ |
✔ |
- |
|
✔ |
✔ |
✔ |
✔ |
- |
|
- |
✔ |
✔ |
✔ |
- |
|
- |
✔ |
✔ |
✔ |
✔ |
|
- |
✔ |
✔ |
✔ |
✔ |
|
- |
- |
- |
- |
✔ |
|
- |
- |
- |
- |
✔ |
|
✔ |
✔ |
✔ |
✔ |
✔ |
|
✔ |
✔ |
✔ |
✔ |
✔ |
Creating print document by the HybridPrinter class
The HybridPrinter class creates a print document using the same API as the Printer class.
The APIs and corresponding print methods are listed below.
API |
Print method |
|||||
---|---|---|---|---|---|---|
Receipt |
Slip sheet |
Endorsement |
Endorsement (40cpl) |
Validation |
||
Text |
✔ |
✔ |
✔ |
- |
✔ |
|
✔ |
✔ |
✔ |
- |
✔ |
||
✔ |
✔ |
✔ |
✔ |
✔ |
||
✔ |
✔ |
✔ |
✔ |
✔ |
||
✔ |
✔ |
- |
- |
✔ |
||
✔ |
✔ |
✔ |
- |
✔ |
||
✔ |
- |
- |
- |
- |
||
✔ |
✔ |
✔ |
- |
✔ |
||
✔ |
✔* |
✔* |
- |
✔* |
||
✔ |
✔ |
✔ |
✔ |
✔ |
||
Paper feed |
✔ |
✔ |
✔ |
✔ |
✔ |
|
✔ |
✔ |
✔ |
✔ |
✔ |
||
Graphics |
✔ |
- |
- |
- |
- |
|
✔ |
- |
- |
- |
- |
||
Barcode |
✔ |
- |
- |
- |
- |
|
✔ |
- |
- |
- |
- |
||
Page mode |
✔ |
✔ |
- |
- |
✔ |
|
✔ |
✔ |
- |
- |
✔ |
||
✔ |
✔ |
- |
- |
✔ |
||
✔ |
✔ |
- |
- |
✔ |
||
✔ |
✔ |
- |
- |
✔ |
||
✔ |
✔ |
- |
- |
- |
||
✔ |
✔ |
- |
- |
- |
||
Cut |
✔ |
- |
- |
- |
- |
|
Drawer |
✔ |
✔ |
✔ |
✔ |
✔ |
|
Command |
✔ |
✔ |
✔ |
✔ |
✔ |
* The reverse parameter is not supported.
LineDisplay class
Controls character display on the customer display.
API |
Description |
|
---|---|---|
Initialization |
Initializes the LineDisplay class. |
|
Communication path |
Connects to the customer display. |
|
Disconnects from the customer display. |
||
Status acquisition |
Acquires status of the connected device. |
|
Transmission |
Sends a command to the customer display. |
|
Buffer clear |
Clears the command buffer. |
|
Reset |
Initializes the customer display. |
|
Window |
Adds a process to execute to the command buffer. |
|
Cursor |
||
Text display |
||
Display setting |
||
Clock |
||
Command transfer |
||
Reception of result |
Registers the event handler. |
Keyboard class
Controls character entry from the keyboard.
API |
Description |
|
---|---|---|
Initialization |
Initializes the Keyboard class. |
|
Communication path |
Connects to the keyboard. |
|
Disconnects from the keyboard. |
||
Status acquisition |
Acquires status of the connected device. |
|
String setting |
Sets the condition to handle as a continuous string. |
|
String setting acquisition |
Acquires the set prefix. |
|
Key detection |
Registers the event handler. |
|
String detection |
BarcodeScanner class
Controls barcode reading by the barcode scanner.
API |
Description |
|
---|---|---|
Initialization |
Initializes the BarcodeScanner class. |
|
Communication path |
Connects to the barcode scanner. |
|
Disconnects from the barcode scanner. |
||
Status acquisition |
Acquires status of the connected device. |
|
Input data reception |
Registers the event handler. |
SimpleSerial class
Controls serial communication between the printer and device.
API |
Description |
|
---|---|---|
Initialization |
Initializes the SimpleSerial class. |
|
Communication path |
Connects to the serial communication device. |
|
Disconnects from the serial communication device. |
||
Status acquisition |
Acquires status of the connected device. |
|
Command transfer |
Transfers a command. |
|
Input data reception |
Registers the event handler. |
CommBox class
Controls data transmission and reception using the communication box.
API |
Description |
|
---|---|---|
Initialization |
Initialize the CommBox class. |
|
Communication path |
Connects to the communication box. |
|
Disconnects from the communication box. |
||
Status acquisition |
Acquires status of the connected device. |
|
Transmission history |
Acquires the message transmission history. |
|
Transmission |
Sends a message to the communication box. |
|
Reception |
Registers the event handler. |
Common to all classes
These APIs can be used with all classes.
API |
Description |
|
---|---|---|
Administration information |
Acquires the administration information. |
|
Acquires the installation location information. |
||
Reconnection |
Registers the event handler. |
Discovery class
Controls the device discovery function.
API |
Description |
|
---|---|---|
Start |
Starts device search. |
|
Stop |
Stops device search. |
|
Reception of result |
Registers the event handler. |
Log class
Controls the log output function.
API |
Description |
|
---|---|---|
Output setting |
Sets the log output function. |
|
Version acquisition |
Acquires the Epson ePOS SDK version. |
Epson ePOS SDK includes patented or patent pending functions.
The contents must not be disclosed to third parties.