Introduction - Epson ePOS SDK for Universal Windows apps - Tech.Reference - POS

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	Printer	Initializes the Printer class.	-	-
Communication path	ConnectAsync	Connects to the printer.	-	-
Communication path	DisconnectAsync	Disconnects from the printer.	-	-
Status monitor	StartMonitor	Enables status event notification.	✔	✔
Status monitor	StopMonitor	Disables status event notification.	✔	✔
Status acquisition	GetStatusAsync	Acquires status of the connected printer.	✔	✔
Transmission	SendDataAsync	Sends a command to the printer.	✔	✔
Transaction	BeginTransactionAsync	Starts a transaction.	✔	✔
Transaction	EndTransactionAsync	Ends a transaction.	✔	✔
Print job	RequestPrintJobStatusAsync	Acquires the print result.	✔	✔
Buffer clear	ClearCommandBuffer	Clears the command buffer.	✔	✔
Text	AddTextAlign	Adds text alignment setting to the command buffer.	✔	-
	AddLineSpace	Adds line spacing setting to the command buffer.	✔	✔
	AddTextRotate	Adds text rotation setting to the command buffer.	✔	-
	AddText	Adds text to print to the command buffer.	✔	✔
	AddTextLang	Adds language setting to the command buffer.	✔	✔
	AddTextFont	Adds character font setting to the command buffer.	✔	✔
	AddTextSmooth	Adds character smoothing setting to the command buffer.	✔	✔
	AddTextSize	Adds character scaling factor setting to the command buffer.	✔	✔
	AddTextStyle	Adds character style setting to the command buffer.	✔	✔
	AddHPosition	Adds character print position setting to the command buffer.	✔	✔
Paper feed	AddFeedUnit	Adds paper-feed setting in dots to the command buffer.	✔	✔
Paper feed	AddFeedLine	Adds paper-feed setting in lines to the command buffer.	✔	✔
Graphics	AddImageAsync	Adds a raster image print command to the command buffer.	✔	✔
Graphics	AddLogo	Adds a NV logo print command to the command buffer.	✔	✔
Barcode	AddBarcode	Adds a barcode print command to the command buffer.	✔	✔
Barcode	AddSymbol	Adds a 2D symbol print command to the command buffer.	✔	✔
Ruled line	AddHLine	Adds a horizontal ruled line print command to the command buffer.	✔	-
	AddVLineBegin	Adds a vertical ruled line start command to the command buffer.	✔	-
	AddVLineEnd	Adds a vertical ruled line end command to the command buffer.	✔	-
Page mode	AddPageBegin	Adds a page mode start command to the command buffer.	✔	-
	AddPageEnd	Adds a page mode end command to the command buffer.	-	✔
	AddPageArea	Adds page mode print area setting to the command buffer.	-	✔
	AddPageDirection	Adds page mode print direction setting to the command buffer.	-	✔
	AddPagePosition	Adds page mode print position setting to the command buffer.	-	✔
	AddPageLine	Adds a page mode line draw command to the command buffer.	-	✔
	AddPageRectangle	Adds a page mode rectangle draw command to the command buffer.	-	✔
Cut	AddCut	Adds a sheet cut command to the command buffer.	✔	-
Drawer	AddPulse	Adds a drawer kick command to the command buffer.	✔	-
Buzzer	AddSound	Adds a buzzer sound command to the command buffer.	✔	-
Label sheet/black mark sheet	AddFeedPosition	Adds a paper feed command to the command buffer.	✔	-
Label sheet/black mark sheet	AddLayout	Adds sheet layout setting to the command buffer.	✔	-
Command	AddCommand	Adds a command to the command buffer.	✔	✔

API		Description
Forced transmission	ForceRecoverAsync	Forced transmission function
	ForcePulseAsync
	ForceStopSoundAsync
	ForceCommandAsync
	ForceResetAsync
Reception of result	StatusChanged	Registers the event handler.
Reception of result	Received	Registers the event handler.
Monitor interval	Interval	Status monitor interval

HybridPrinter class

Controls the hybrid model printers.

API		Description
Initialization	HybridPrinter	Initializes the HybridPrinter class.
Communication path	ConnectAsync	Connects to the printer.
Communication path	DisconnectAsync	Disconnects from the printer.
Status monitor	StartMonitor	Enables status event notification.
Status monitor	StopMonitor	Disables status event notification.
Status acquisition	GetStatusAsync	Acquires status of the connected printer.
Transmission	SendDataAsync	Sends a print document.
Transaction	BeginTransactionAsync	Starts a transaction.
Transaction	EndTransactionAsync	Ends a transaction.
Buffer clear	ClearCommandBuffer	Clears the command buffer.
Print method	SelectPaperTypeAsync	Specifies a print method.
Paper feed	WaitInsertionAsync	Waiting for paper insertion.
Paper feed	CancelInsertionAsync	Cancels waiting for paper insertion.
Paper eject	EjectPaperAsync	Ejects paper.
MICR	ReadMicrDataAsync	MICR reading
MICR	CleanMicrReaderAsync	Cleans the MICR mechanism.
Forced transmission	ForceRecoverAsync	Forced transmission function
	ForcePulseAsync
	ForceCommandAsync
	ForceResetAsync
Print method acquisition	PaperType	Acquires the print method setting information.
Monitor interval	Interval	Printer status update interval
On standby	WaitTime	Time from insertion of a paper to start of operation
40cpl mode	Mode40Cpl	Sets the 40 cpl mode.
Reception of result	StatusChanged	Registers the event listener registration method.
Reception of result	Received	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
API	Receipt	Slip sheet	Endorsement	Validation	MICR
HybridPrinter	✔	✔	✔	✔	✔
ConnectAsync	✔	✔	✔	✔	✔
DisconnectAsync	✔	✔	✔	✔	✔
StartMonitor	✔	✔	✔	✔	✔
StopMonitor	✔	✔	✔	✔	✔
GetStatusAsync	✔	✔	✔	✔	✔
SendDataAsync	✔	✔	✔	✔	-
BeginTransactionAsync	✔	✔	✔	✔	✔
EndTransactionAsync	✔	✔	✔	✔	✔
ClearCommandBuffer	✔	✔	✔	✔	-
SelectPaperTypeAsync	✔	✔	✔	✔	-
WaitInsertionAsync	-	✔	✔	✔	-
CancelInsertionAsync	-	✔	✔	✔	✔
EjectPaperAsync	-	✔	✔	✔	✔
ReadMicrDataAsync	-	-	-	-	✔
CleanMicrReaderAsync	-	-	-	-	✔
StatusChanged	✔	✔	✔	✔	✔
Received	✔	✔	✔	✔	✔

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
API		Receipt	Slip sheet	Endorsement	Endorsement (40cpl)	Validation
Text	AddTextAlign	✔	✔	✔	-	✔
	AddLineSpace	✔	✔	✔	-	✔
	AddTextRotate	✔	✔	✔	✔	✔
	AddText	✔	✔	✔	✔	✔
	AddTextLang	✔	✔	-	-	✔
	AddTextFont	✔	✔	✔	-	✔
	AddTextSmooth	✔	-	-	-	-
	AddTextSize	✔	✔	✔	-	✔
	AddTextStyle	✔	✔^*	✔^*	-	✔^*
	AddHPosition	✔	✔	✔	✔	✔
Paper feed	AddFeedUnit	✔	✔	✔	✔	✔
Paper feed	AddFeedLine	✔	✔	✔	✔	✔
Graphics	AddImageAsync	✔	-	-	-	-
Graphics	AddLogo	✔	-	-	-	-
Barcode	AddBarcode	✔	-	-	-	-
Barcode	AddSymbol	✔	-	-	-	-
Page mode	AddPageBegin	✔	✔	-	-	✔
	AddPageEnd	✔	✔	-	-	✔
	AddPageArea	✔	✔	-	-	✔
	AddPageDirection	✔	✔	-	-	✔
	AddPagePosition	✔	✔	-	-	✔
	AddPageLine	✔	✔	-	-	-
	AddPageRectangle	✔	✔	-	-	-
Cut	AddCut	✔	-	-	-	-
Drawer	AddPulse	✔	✔	✔	✔	✔
Command	AddCommand	✔	✔	✔	✔	✔

^* The reverse parameter is not supported.

LineDisplay class

Controls character display on the customer display.

API		Description
Initialization	LineDisplay	Initializes the LineDisplay class.
Communication path	ConnectAsync	Connects to the customer display.
Communication path	DisconnectAsync	Disconnects from the customer display.
Status acquisition	GetStatusAsync	Acquires status of the connected device.
Transmission	SendDataAsync	Sends a command to the customer display.
Buffer clear	ClearCommandBuffer	Clears the command buffer.
Reset	AddInitialize	Initializes the customer display.
Window	AddCreateWindow	Adds a process to execute to the command buffer.
	AddDestroyWindow
	AddSetCurrentWindow
	AddClearCurrentWindow
Cursor	AddSetCursorPosition
	AddMoveCursorPosition
	AddSetCursorType
Text display	AddText
	AddReverseText
	AddMarqueeText
Display setting	AddSetBlink
Display setting	AddSetBrightness
Clock	AddShowClock
Command transfer	AddCommand
Reception of result	Received	Registers the event handler.

Keyboard class

Controls character entry from the keyboard.

API		Description
Initialization	Keyboard	Initializes the Keyboard class.
Communication path	ConnectAsync	Connects to the keyboard.
Communication path	DisconnectAsync	Disconnects from the keyboard.
Status acquisition	GetStatusAsync	Acquires status of the connected device.
String setting	SetPrefixAsync	Sets the condition to handle as a continuous string.
String setting acquisition	GetPrefix	Acquires the set prefix.
Key detection	KeyPressed	Registers the event handler.
String detection	ReadString	Registers the event handler.

BarcodeScanner class

Controls barcode reading by the barcode scanner.

API		Description
Initialization	BarcodeScanner	Initializes the BarcodeScanner class.
Communication path	ConnectAsync	Connects to the barcode scanner.
Communication path	DisconnectAsync	Disconnects from the barcode scanner.
Status acquisition	GetStatusAsync	Acquires status of the connected device.
Input data reception	Scanned	Registers the event handler.

SimpleSerial class

Controls serial communication between the printer and device.

API		Description
Initialization	SimpleSerial	Initializes the SimpleSerial class.
Communication path	ConnectAsync	Connects to the serial communication device.
Communication path	DisconnectAsync	Disconnects from the serial communication device.
Status acquisition	GetStatusAsync	Acquires status of the connected device.
Command transfer	SendCommandAsync	Transfers a command.
Input data reception	Received	Registers the event handler.

CommBox class

Controls data transmission and reception using the communication box.

API		Description
Initialization	CommBox	Initialize the CommBox class.
Communication path	ConnectAsync	Connects to the communication box.
Communication path	DisconnectAsync	Disconnects from the communication box.
Status acquisition	GetStatusAsync	Acquires status of the connected device.
Transmission history	GetCommHistoryAsync	Acquires the message transmission history.
Transmission	SendMessageAsync	Sends a message to the communication box.
Reception	Received	Registers the event handler.

Common to all classes

These APIs can be used with all classes.

API		Description
Administration information	Admin	Acquires the administration information.
Administration information	Location	Acquires the installation location information.
Reconnection	ConnectionChanged	Registers the event handler.

Discovery class

Controls the device discovery function.

API		Description
Start	StartAsync	Starts device search.
Stop	StopAsync	Stops device search.
Reception of result	Discovered	Registers the event handler.

Log class

Controls the log output function.

API		Description
Output setting	SetLogSettings	Sets the log output function.
Version acquisition	SdkVersion	Acquires the Epson ePOS SDK version.

List of ePOS SDK API