https://github.com/malik12tree/capacitor-thermal-printer
High-speed, reliable bluetooth ESC thermal printer and encoder Capacitor plugin. 🖨️⚡
https://github.com/malik12tree/capacitor-thermal-printer
android bluetooth capacitor capacitor-plugin encoder esc ios native plugin printer thermal
Last synced: about 1 year ago
JSON representation
High-speed, reliable bluetooth ESC thermal printer and encoder Capacitor plugin. 🖨️⚡
- Host: GitHub
- URL: https://github.com/malik12tree/capacitor-thermal-printer
- Owner: Malik12tree
- License: mit
- Created: 2024-10-15T12:05:07.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-05T16:33:38.000Z (over 1 year ago)
- Last Synced: 2025-04-15T05:47:15.421Z (about 1 year ago)
- Topics: android, bluetooth, capacitor, capacitor-plugin, encoder, esc, ios, native, plugin, printer, thermal
- Language: Objective-C
- Homepage:
- Size: 8.37 MB
- Stars: 10
- Watchers: 1
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
capacitor-thermal-printer
High-speed, reliable bluetooth ESC thermal printer and encoder Capacitor plugin. Both on Android and iOS!
- [x] Using the official RTPrinter SDK by [Rongta Technology](https://www.rongtatech.com/) <3
- [x] Cross-platform compatibility (Android & iOS)
- [x] **_Swift_** speeds on iOS of [BLE](https://en.wikipedia.org/wiki/Bluetooth_Low_Energy) **(known for it's pain-in-the-ass speed)**
## Install
```bash
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](./example) folder.
### 1. Import the plugin
```ts
import { CapacitorThermalPrinter } from 'capacitor-thermal-printer';
```
### 2. Connect to printer
```ts
const device = await CapacitorThermalPrinter.connect({
address: 'XX:XX:XX:XX:XX:XX',
});
if (device === null) {
console.log('Woops, failed to connect!');
} else {
console.log('Connected!', device.name, device.address);
}
```
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.
```ts
CapacitorThermalPrinter.addListener('discoverDevices', (devices) => {
console.log('Discovered devices list:', devices);
});
await CapacitorThermalPrinter.startScan();
```
### 3. Print sample receipt
```ts
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](./docs/README.md)!
## Issues
If you encounter any issues with this plugin, please report them at [Issues](https://github.com/Malik12tree/capacitor-thermal-printer/issues)
## Contributing
We're open to, and grateful for, any contributions made! Make sure to check [Contribution Guidelines](./CONTRIBUTING.md)