@simplymobile/capacitor-bixolon-printer

Capacitor Bixolon Bluetooth printer plugin

Port of the legacy cordova-bixolon-plugin (Bluetooth ESC/POS printing) to a Capacitor 8 plugin. Android is fully implemented; iOS is a stub.

Install

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

API

• checkPermissions()
• requestPermissions()
• list()
• getStatus()
• connect(...)
• disconnect()
• printText(...)
• printBase64(...)
• printImageUrl(...)
• printPOSCommand(...)
• printQRCode(...)
• cutPaper()
• setBrand(...)
• 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>

list()

list() => Promise<{ devices: BixolonDevice[]; }>

List the Bluetooth devices that are already paired with the system.

Returns: Promise<{ devices: BixolonDevice[]; }>

getStatus()

getStatus() => Promise<BixolonStatus>

Return the current adapter / connection status.

Returns: Promise<BixolonStatus>

connect(...)

connect(options: { name: string; }) => Promise<{ message: string; }>

Connect to a paired printer by its Bluetooth friendly name.

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

Returns: Promise<{ message: string; }>

disconnect()

disconnect() => Promise<void>

Close the connection to the currently connected printer.

printText(...)

printText(options: { text: string; }) => Promise<void>

Send raw text to the printer.

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

printBase64(...)

printBase64(options: { data: string; align?: number; }) => Promise<void>

Print an image provided as a Base64 string.

| Param | Type | | ------------- | ---------------------------------------------- | | options | { data: string; align?: number; } |

printImageUrl(...)

printImageUrl(options: { url: string; align?: number; }) => Promise<void>

Print an image loaded from a local file path.

| Param | Type | | ------------- | --------------------------------------------- | | options | { url: string; align?: number; } |

printPOSCommand(...)

printPOSCommand(options: { command: string; }) => Promise<void>

Send a raw ESC/POS command encoded as a hex string.

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

printQRCode(...)

printQRCode(options: { text: string; }) => Promise<void>

Print a QR code (currently sends the raw string to the printer).

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

cutPaper()

cutPaper() => Promise<void>

Send the paper-cut command to the printer.

setBrand(...)

setBrand(options: { brand: string; }) => Promise<void>

Set the printer brand. Use bixolon to skip alignment commands that some Bixolon models reject.

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

Interfaces

PermissionStatus

| Prop | Type | Description | | --------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | | bluetooth | BluetoothPermissionState | Permission state for Bluetooth (BLUETOOTH_CONNECT / BLUETOOTH_SCAN on Android 12+). |

BixolonDevice

| Prop | Type | Description | | ------------- | ------------------- | ------------------------------------------------------------------- | | name | string | Bluetooth friendly name of the paired device. | | address | string | Bluetooth MAC address of the paired device. | | type | number | Bluetooth device type (see BluetoothDevice.getType() on Android). |

BixolonStatus

| Prop | Type | Description | | --------------- | -------------------- | ------------------------------------------------------------------ | | enabled | boolean | Whether the Bluetooth adapter is enabled. | | connected | boolean | Whether there is an active connection to a printer. | | name | string | Name of the connected device (only when connected is true). | | address | string | Address of the connected device (only when connected is true). |

Type Aliases

BluetoothPermissionState

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