https://github.com/andrey-ushakov/esc_pos_printer
ESC/POS (thermal, receipt) printing for Flutter & Dart
https://github.com/andrey-ushakov/esc_pos_printer
dart esc flutter pos printer receipt receipt-printer thermal-printer wifi
Last synced: about 1 month ago
JSON representation
ESC/POS (thermal, receipt) printing for Flutter & Dart
- Host: GitHub
- URL: https://github.com/andrey-ushakov/esc_pos_printer
- Owner: andrey-ushakov
- License: bsd-3-clause
- Created: 2019-06-11T20:43:04.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-08-19T14:37:31.000Z (9 months ago)
- Last Synced: 2025-04-02T03:17:30.146Z (about 1 month ago)
- Topics: dart, esc, flutter, pos, printer, receipt, receipt-printer, thermal-printer, wifi
- Language: Dart
- Homepage:
- Size: 594 KB
- Stars: 373
- Watchers: 23
- Forks: 321
- Open Issues: 106
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# esc_pos_printer
[](https://pub.dev/packages/esc_pos_printer)
The library allows to print receipts using an ESC/POS thermal WiFi/Ethernet printer. For Bluetooth printers, use [esc_pos_bluetooth](https://github.com/andrey-ushakov/esc_pos_bluetooth) library.
It can be used in [Flutter](https://flutter.dev/) or pure [Dart](https://dart.dev/) projects. For Flutter projects, both Android and iOS are supported.
To scan for printers in your network, consider using [ping_discover_network](https://pub.dev/packages/ping_discover_network) package. Note that most of the ESC/POS printers by default listen on port 9100.
## TODO (PRs are welcomed!)
- Print QR Codes using the `GS ( k` command (printing QR code from an image already supported)
- PDF-417 Barcodes using the `GS ( k` command
- Line spacing using the `ESC 3 ` command
## How to Help
- Test your printer and add it in the table: [Wifi/Network printer](https://github.com/andrey-ushakov/esc_pos_printer/blob/master/printers.md) or [Bluetooth printer](https://github.com/andrey-ushakov/esc_pos_bluetooth/blob/master/printers.md)
- Test and report bugs
- Share your ideas about what could be improved (code optimization, new features...)
- PRs are welcomed!
## Tested Printers
Here are some [printers tested with this library](printers.md). Please add the models you have tested to maintain and improve this library and help others to choose the right printer.
## Generate a Receipt
### Simple Receipt with Styles:
```dart
void testReceipt(NetworkPrinter printer) {
printer.text(
'Regular: aA bB cC dD eE fF gG hH iI jJ kK lL mM nN oO pP qQ rR sS tT uU vV wW xX yY zZ');
printer.text('Special 1: àÀ èÈ éÉ ûÛ üÜ çÇ ôÔ',
styles: PosStyles(codeTable: 'CP1252'));
printer.text('Special 2: blåbærgrød',
styles: PosStyles(codeTable: 'CP1252'));
printer.text('Bold text', styles: PosStyles(bold: true));
printer.text('Reverse text', styles: PosStyles(reverse: true));
printer.text('Underlined text',
styles: PosStyles(underline: true), linesAfter: 1);
printer.text('Align left', styles: PosStyles(align: PosAlign.left));
printer.text('Align center', styles: PosStyles(align: PosAlign.center));
printer.text('Align right',
styles: PosStyles(align: PosAlign.right), linesAfter: 1);
printer.text('Text size 200%',
styles: PosStyles(
height: PosTextSize.size2,
width: PosTextSize.size2,
));
printer.feed(2);
printer.cut();
}
```
You can find more examples here: [esc_pos_utils](https://github.com/andrey-ushakov/esc_pos_utils).
## Print a Receipt
```dart
import 'package:esc_pos_printer/esc_pos_printer.dart';
const PaperSize paper = PaperSize.mm80;
final profile = await CapabilityProfile.load();
final printer = NetworkPrinter(paper, profile);
final PosPrintResult res = await printer.connect('192.168.0.123', port: 9100);
if (res == PosPrintResult.success) {
testReceipt(printer);
printer.disconnect();
}
print('Print result: ${res.msg}');
```
For a complete example, check `example/example.dart` and `example/discover_printers`.
## Test Print
