Skip to content

Latest commit

 

History

History
123 lines (87 loc) · 3.4 KB

README.md

File metadata and controls

123 lines (87 loc) · 3.4 KB
Raw

capacitor-thermal-printer

High-speed, reliable bluetooth ESC thermal printer and encoder Capacitor plugin. Both on Android and iOS!

  • Using the official RTPrinter SDK by Rongta Technology <3
  • Cross-platform compatibility (Android & iOS)
  • Swift speeds on iOS of BLE (known for it's pain-in-the-ass speed)

Install

npm install capacitor-thermal-printer --save
npx cap sync

Additional iOS Setup

Open your iOS project in Xcode, then:

  1. In the left sidebar, select your project (usually named "App").
  2. Select your main target (usually also named "App").
  3. Navigate to "Build Phases" tab.
  4. Under "Copy Bundle Resources", click the "+" button and choose "Add Other..."
  5. Navigate to the node_modules/capacitor-thermal-printer/ios/Plugin/Resources/ble_serial.plist file and select it

And voilà! You're all set!

Example

Make sure to check the Ionic Angular example in the example folder.

1. Import the plugin

import { CapacitorThermalPrinter } from 'capacitor-thermal-printer';

2. Connect to printer

CapacitorThermalPrinter.addListener('connected', () => {
  console.log('Connected!');
});
await CapacitorThermalPrinter.connect({
  address: 'XX:XX:XX:XX:XX:XX',
});

You can also use the startScan method to discover nearby devices.

  • On Android, only printers will be discovered.
  • On iOS, all bluetooth devices will be discovered.
CapacitorThermalPrinter.addListener('discoverDevices', (devices) => {
  console.log('Discovered devices list:', devices);
});

await CapacitorThermalPrinter.startScan();

3. Print sample receipt

await CapacitorThermalPrinter.begin()
  .align('center')

  .image('https://raw.githubusercontent.com/Malik12tree/capacitor-thermal-printer/main/assets/Logo-Black.png')

  .bold()
  .underline()
  .text('The amazing store\n')

  .doubleWidth()
  .text('RECEIPT\n')
  .clearFormatting()

  .text('Item 1: $10.00\n')
  .text('Item 2: $15.00\n')

  .align('right')
  .text('Total: $25.00\n')

  .align('center')
  .qr('https://example.com')
  .barcode('UPC_A', '123456789012')

  .cutPaper()

  .write()
  .then(() => console.log('Printed!'))
  .catch((e) => console.error('Failed to print!', e));

Documentation

Check out the Docs!

Issues

If you encounter any issues with this plugin, please report them at Issues

Contributing

We're open to, and grateful for, any contributions made! Make sure to check Contribution Guidelines