@simplymobile/capacitor-zebra-printer

Capacitor Zebra Bluetooth printer plugin. Android-only driver for Zebra Bluetooth printers, built on top of the Zebra Android SDK (ZSDK_ANDROID_API.jar). On iOS and web every method is unimplemented.

Install

npm install @simplymobile/capacitor-zebra-printer
npx cap sync

API

• checkPermissions()
• requestPermissions()
• discoverPrinters()
• print(...)
• printImage(...)
• getPrinterName(...)
• getStatus(...)
• getZPLfromImage(...)
• Interfaces
• Type Aliases

checkPermissions()

checkPermissions() => Promise<PermissionStatus>

Check the current Bluetooth permission status.

Returns: Promise<PermissionStatus>

requestPermissions()

requestPermissions() => Promise<PermissionStatus>

Request the Bluetooth permissions required to discover and connect to printers.

Returns: Promise<PermissionStatus>

discoverPrinters()

discoverPrinters() => Promise<{ address: string; }>

Discover the first available Zebra printer over Bluetooth and return its MAC address.

Returns: Promise<{ address: string; }>

print(...)

print(options: { address: string; data: string; }) => Promise<{ message: string; }>

Send raw ZPL code to the printer identified by its Bluetooth MAC address.

| Param | Type | | ------------- | ----------------------------------------------- | | options | { address: string; data: string; } |

Returns: Promise<{ message: string; }>

printImage(...)

printImage(options: { address: string; images: string[]; }) => Promise<void>

Print one or more Base64-encoded images on the printer.

| Param | Type | | ------------- | --------------------------------------------------- | | options | { address: string; images: string[]; } |

getPrinterName(...)

getPrinterName(options: { address: string; }) => Promise<{ name: string; }>

Return the Bluetooth friendly name of a paired printer for a given MAC address.

| Param | Type | | ------------- | --------------------------------- | | options | { address: string; } |

Returns: Promise<{ name: string; }>

getStatus(...)

getStatus(options: { address: string; }) => Promise<{ status: string; }>

Return the current status of the printer (e.g. "Printer is ready for use").

| Param | Type | | ------------- | --------------------------------- | | options | { address: string; } |

Returns: Promise<{ status: string; }>

getZPLfromImage(...)

getZPLfromImage(options: { data: string; addHeaderFooter: boolean; blacknessPercentage: number; }) => Promise<{ zpl: string; }>

Convert a Base64-encoded image into ZPL code without printing it.

| Param | Type | | ------------- | ------------------------------------------------------------------------------------- | | options | { data: string; addHeaderFooter: boolean; blacknessPercentage: number; } |

Returns: Promise<{ zpl: string; }>

Interfaces

PermissionStatus

| Prop | Type | Description | | --------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | | bluetooth | BluetoothPermissionState | Permission state for Bluetooth (BLUETOOTH_CONNECT / BLUETOOTH_SCAN on Android 12+) and location (ACCESS_FINE_LOCATION) required to discover printers. |

Type Aliases

BluetoothPermissionState

'granted' | 'denied' | 'prompt' | 'prompt-with-rationale'