capacitor-printer-bridge

A Capacitor Plugin For Printing Help

Install

npm install capacitor-printer-bridge
npx cap sync

API

• print(...)
• printQRCode(...)
• checkPermissions()
• requestPermissions()
• getDeviceIdFromPairedDevices(...)
• getPairedDevices()
• getAvailableDevices()
• pairDevice(...)
• getDeviceInfo(...)
• Interfaces

print(...)

print(options: { deviceName: string; deviceId: string; data: string; }) => Promise<{ success: boolean; }>

Send text data to the printer.

| Param | Type | | ------------- | -------------------------------------------------------------------- | | options | { deviceName: string; deviceId: string; data: string; } |

Returns: Promise<{ success: boolean; }>

printQRCode(...)

printQRCode(options: { deviceName: string; deviceId: string; qrData: string; }) => Promise<{ success: boolean; }>

Prints a QR Code containing the provided data.

| Param | Type | | ------------- | ---------------------------------------------------------------------- | | options | { deviceName: string; deviceId: string; qrData: string; } |

Returns: Promise<{ success: boolean; }>

checkPermissions()

checkPermissions() => Promise<{ bluetooth: 'granted' | 'denied'; bluetooth_connect: 'granted' | 'denied'; }>

Checks if the necessary Bluetooth permissions are granted.

Returns: Promise<{ bluetooth: 'granted' | 'denied'; bluetooth_connect: 'granted' | 'denied'; }>

requestPermissions()

requestPermissions() => Promise<{ permission: { bluetooth: 'granted' | 'denied'; bluetooth_connect: 'granted' | 'denied'; }; }>

Requests the necessary Bluetooth permissions.

Returns: Promise<{ permission: { bluetooth: 'granted' | 'denied'; bluetooth_connect: 'granted' | 'denied'; }; }>

getDeviceIdFromPairedDevices(...)

getDeviceIdFromPairedDevices(options: { printerName: string; }) => Promise<{ deviceId: string; deviceName: string; success: boolean; }>

Gets the device ID (MAC address) of a paired Bluetooth device by its name.

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

Returns: Promise<{ deviceId: string; deviceName: string; success: boolean; }>

getPairedDevices()

getPairedDevices() => Promise<{ devices: BluetoothDevice[]; count: number; }>

Gets a list of all paired Bluetooth devices.

Returns: Promise<{ devices: BluetoothDevice[]; count: number; }>

getAvailableDevices()

getAvailableDevices() => Promise<{ devices: BluetoothDevice[]; count: number; }>

Gets a list of all available Bluetooth devices (both paired and unpaired). This method will start device discovery and may take up to 30 seconds.

Returns: Promise<{ devices: BluetoothDevice[]; count: number; }>

pairDevice(...)

pairDevice(options: { deviceAddress: string; }) => Promise<{ success: boolean; message: string; }>

Pairs with a Bluetooth device using its MAC address.

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

Returns: Promise<{ success: boolean; message: string; }>

getDeviceInfo(...)

getDeviceInfo(options: { deviceAddress: string; }) => Promise<BluetoothDevice>

Gets detailed information about a specific Bluetooth device.

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

Returns: Promise<BluetoothDevice>

Interfaces

BluetoothDevice

| Prop | Type | Description | | ---------------------- | -------------------- | ----------------------------------------------------------- | | name | string | The display name of the device | | deviceId | string | The Bluetooth MAC address | | isPaired | boolean | Whether the device is currently paired | | bondState | string | The bond state as a string (BONDED, BONDING, NONE, UNKNOWN) | | deviceClass | number | The device class code (optional) | | majorDeviceClass | number | The major device class code (optional) | | type | number | Device type for backward compatibility |