Select your printer model

Parameters are refined by the selected printer.

Epos2Printer class


Controls printing by the printer.

API

Description

Initialization

initWithPrinterSeries

Initializes the Epos2Printer class.

Communication path

connect

Connects to the printer.

disconnect

Disconnects from the printer.

Status monitor

startMonitor

Enables status event notification.

stopMonitor

Disables status event notification.

Status acquisition

getStatus

Acquires status of the connected printer.

Transmission

sendData

Sends a command to the printer.

Transaction

beginTransaction

Starts a transaction.

endTransaction

Ends a transaction.

Print job

requestPrintJobStatus

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.

addFeedLine

Adds paper-feed setting in lines to the command buffer.

Graphics

addImage

Adds a raster image print command to the command buffer.

addLogo

Adds a NV logo print command to the command buffer.

Barcode

addBarcode

Adds a barcode print command to the command buffer.

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.

Batch rotate print

addRotateBegin

Adds the start batch rotate print mode to the command buffer.

addRotateEnd

Adds the end batch rotate print mode 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.

addLayout

Adds sheet layout setting to the command buffer.

Command

addCommand

Adds a command to the command buffer.

Maintenance counter

getMaintenanceCounter

Acquires the counter value.

resetMaintenanceCounter

Resets the counter value.

Printer setting

getPrinterSetting

Acquires the set value of the printer setting.

setPrinterSetting

Changes the printer setting.

getPrinterSettingEx

Acquires the set value of the printer setting in JSON.

setPrinterSettingEx

Specifies the printer setting in JSON.

setPrinterSettingEx[Obsolete]

verifyPassword

Check the printer administrator password.

Information acquisition

getPrinterInformation

Acquires the printer information.

Firmware update

downloadFirmwareList

Acquires the list of the firmware.

getPrinterFirmwareInfo

Acquires the information of the printer firmware.

verifyUpdate

Acquires the result of the firmware update.

updateFirmware

Instructs the printer to write the firmware image.

Forced transmission

forceRecover

Forced transmission function

forcePulse

forceStopSound

forceCommand

forceReset

Reception of result

setStatusChangeEventDelegate

Registers the callback method for an event.

setReceiveEventDelegate

setGetPrinterSettingExDelegate

setSetPrinterSettingExDelegate

setVerifyPasswordDelegate

Monitor interval

interval

<Obsolete> Status monitor interval

The print mode includes the standard mode, page mode, and the batch rotate print mode.

  • 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.
    To print in the page mode, use addPageBegin and addPageEnd to start and end the page mode process, respectively.

  • Batch rotate print mode
  • This is a print mode in which the range of the print data (such as characters, images, barcodes, etc.) is set, the print data in the set range is compiled, inverted, and then printed.
    When performing the processing in the batch rotate print mode, start the batch rotate print processing with addRotateBegin, and end the batch rotate print processing with addRotateEnd.

The APIs that can be used in each mode are described in the table below.

API

Standard mode

Page mode

Batch rotate
print mode

initWithPrinterSeries

-

-

-

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

 

Quick Access

  • [Name]
  • [Format]
  • [Range]
  • [Description]
  • [Notes]

Epson ePOS SDK includes patented or patent pending functions. The contents must not be disclosed to third parties.


Epson ePOS SDK for iOS

Jump to the top