@ticketplushq/capacitor-pos-pax-printer-utility v2.0.3

@ticketplushq/capacitor-pos-pax-printer-utility

Printer integration for PAX payment POS, Android support.

In web context it behaves like a mock that returns successful execution results.

When executed in the emulator or on a device other than the POS, it will generate an error that will stop the application. This is due to the lack of installation of the NeptuneService app. At the moment, it has not been possible to install NeptuneService on a device other than POS but work is being done to achieve it.

Permissions

Adding permissions in the AndroidManifest.xml file

<uses-permission android:name="com.pax.permission.PRINTER"/>
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />

Install

npm install @ticketplushq/capacitor-pos-pax-printer-utility
npx cap sync

API

• init()
• start()
• printStr(...)
• printBase64Image(...)
• printReceipt(...)
• printReceiptWithQr(...)
• printQR(...)
• cutPaper(...)
• getCutMode()
• getStatus()
• fontSet(...)
• doubleHeight(...)
• doubleWidth(...)
• Interfaces
• Type Aliases
• Enums

init()

init() => Promise<{ ok: boolean; }>

Get printer and init instance

Returns: Promise<{ ok: boolean; }>

start()

start() => Promise<StatusResp>

Run printer commands

Returns: Promise<StatusResp>

printStr(...)

printStr({ text }: PrintStrArgs) => Promise<void>

Print text string

printBase64Image(...)

printBase64Image({ image }: PrintBase64ImageArgs) => Promise<StatusResp>

Print base64 image (jpg) (in development)

Returns: Promise<StatusResp>

printReceipt(...)

printReceipt({ text }: PrintReceiptArgs) => Promise<StatusResp>

Print receipt only

Returns: Promise<StatusResp>

printReceiptWithQr(...)

printReceiptWithQr({ text, qrString, }: PrintReceiptWithQrArgs) => Promise<StatusResp>

Print receipt and QR code content

Returns: Promise<StatusResp>

printQR(...)

printQR({ text, qrString, startText, endText, }: PrintQrArgs) => Promise<StatusResp>

Print QR code content, optionally you can pass a text to print before (startText) and after (endText) the QR code, the content of the text argument is printed before startText and with the size of endText

Returns: Promise<StatusResp>

cutPaper(...)

cutPaper({ mode }: CutPaperMode) => Promise<{ ok: boolean; }>

Set printer cut mode, remember that to use this method you must before started the printer instance,

Returns: Promise<{ ok: boolean; }>

getCutMode()

getCutMode() => Promise<CutPaperMode>

Get printer cut mode, remember that to use this method you must before started the printer instance,

Returns: Promise<CutPaperMode>

getStatus()

getStatus() => Promise<StatusResp>

Get printer status, remember that to use this method you must before started the printer instance,

Returns: Promise<StatusResp>

fontSet(...)

fontSet(asciiFontType: EFontTypeAscii, cFontType: EFontTypeExtCode) => Promise<void>

Set print font

doubleHeight(...)

doubleHeight(isAscDouble: boolean, isLocalDouble: boolean) => Promise<void>

Set printing font which is based on base font to double height.

doubleWidth(...)

doubleWidth(isAscDouble: boolean, isLocalDouble: boolean) => Promise<void>

Set printing font which is based on base font to double width.

Interfaces

StatusResp

PrintStrArgs

PrintBase64ImageArgs

PrintReceiptArgs

PrintReceiptWithQrArgs

PrintQrArgs

CutPaperMode

Type Aliases

StatusCodes

0 | 1 | 2 | 3 | 4 | 8 | 9 | -16 | -6 | -5 | -4 | -2

CutMode

0 | 1 | 2 | -1

Enums

EFontTypeAscii

EFontTypeExtCode