7.2 KiB
7.2 KiB
capacitor-pozo-printer
Capacitor plugin for Pozo Retail thermal printer integration (USB / ESC POS)
Install
To use npm
npm install capacitor-pozo-printer
To use yarn
yarn add capacitor-pozo-printer
Sync native files
npx cap sync
API
requestPermissions()scanBluetooth()scanUsb()connectUsb()scanNetwork()printBluetooth(...)printNetwork(...)printUsb(...)printIntent(...)checkPrinterStatus(...)- Interfaces
requestPermissions()
requestPermissions() => Promise<PermissionResult>
Returns: Promise<PermissionResult>
scanBluetooth()
scanBluetooth() => Promise<{ devices: PrinterDevice[]; }>
Scan paired Bluetooth devices
Returns: Promise<{ devices: PrinterDevice[]; }>
scanUsb()
scanUsb() => Promise<{ devices: PrinterDevice[]; }>
Scan connected USB devices
Returns: Promise<{ devices: PrinterDevice[]; }>
connectUsb()
connectUsb() => Promise<UsbConnectionResult>
Connect to USB printer
Returns: Promise<UsbConnectionResult>
scanNetwork()
scanNetwork() => Promise<{ devices: NetworkPrinter[]; }>
Scan Wi-Fi / LAN printers
Returns: Promise<{ devices: NetworkPrinter[]; }>
printBluetooth(...)
printBluetooth(options: BluetoothPrintOptions) => Promise<{ success: boolean; }>
Print via Bluetooth SPP
| Param | Type |
|---|---|
options |
BluetoothPrintOptions |
Returns: Promise<{ success: boolean; }>
printNetwork(...)
printNetwork(options: NetworkPrintOptions) => Promise<{ success: boolean; }>
Print via Network/LAN/WiFi (TCP port 9100)
| Param | Type |
|---|---|
options |
NetworkPrintOptions |
Returns: Promise<{ success: boolean; }>
printUsb(...)
printUsb(options: UsbPrintOptions) => Promise<{ success: boolean; }>
Print via USB OTG
| Param | Type |
|---|---|
options |
UsbPrintOptions |
Returns: Promise<{ success: boolean; }>
printIntent(...)
printIntent(options: PrintIntentOptions) => Promise<void>
| Param | Type |
|---|---|
options |
PrintIntentOptions |
checkPrinterStatus(...)
checkPrinterStatus(options: PrinterStatusOptions) => Promise<PrinterStatusResult>
Check printer online/offline status
| Param | Type |
|---|---|
options |
PrinterStatusOptions |
Returns: Promise<PrinterStatusResult>
Interfaces
PermissionResult
| Prop | Type |
|---|---|
bluetooth |
'granted' | 'denied' | 'prompt' |
network |
'granted' | 'denied' | 'prompt' |
PrinterDevice
| Prop | Type |
|---|---|
name |
string |
address |
string |
UsbConnectionResult
| Prop | Type |
|---|---|
name |
string |
address |
string |
connected |
boolean |
NetworkPrinter
| Prop | Type |
|---|---|
name |
string |
address |
string |
port |
number |
BluetoothPrintOptions
| Prop | Type |
|---|---|
address |
string |
data |
number[] |
NetworkPrintOptions
| Prop | Type |
|---|---|
host |
string |
port |
number |
data |
number[] |
UsbPrintOptions
| Prop | Type |
|---|---|
data |
number[] |
deviceId |
string |
PrintIntentOptions
| Prop | Type |
|---|---|
receiptText |
string |
estimateText |
string |
logoImage |
string |
tokenDataSales |
any[] |
tokenDataEstimate |
any[] |
orderId |
string |
estimateOrderId |
string |
footerPrint |
string |
upiId |
string |
totalAmount |
string |
estimateAmount |
string |
PrinterStatusResult
| Prop | Type |
|---|---|
connected |
boolean |
status |
'online' | 'offline' |
type |
string |
address |
string |
name |
string |
message |
string |
PrinterStatusOptions
| Prop | Type |
|---|---|
type |
'USB' | 'Bluetooth' | 'Wi-Fi' |
address |
string |