forked from andrey-ushakov/esc_pos_bluetooth
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 48b91c2
Showing
8 changed files
with
292 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,75 @@ | ||
# Miscellaneous | ||
*.class | ||
*.log | ||
*.pyc | ||
*.swp | ||
.DS_Store | ||
.atom/ | ||
.buildlog/ | ||
.history | ||
.svn/ | ||
|
||
# IntelliJ related | ||
*.iml | ||
*.ipr | ||
*.iws | ||
.idea/ | ||
|
||
# The .vscode folder contains launch configuration and tasks you configure in | ||
# VS Code which you may wish to be included in version control, so this line | ||
# is commented out by default. | ||
#.vscode/ | ||
|
||
# Flutter/Dart/Pub related | ||
**/doc/api/ | ||
.dart_tool/ | ||
.flutter-plugins | ||
.flutter-plugins-dependencies | ||
.packages | ||
.pub-cache/ | ||
.pub/ | ||
build/ | ||
|
||
# Android related | ||
**/android/**/gradle-wrapper.jar | ||
**/android/.gradle | ||
**/android/captures/ | ||
**/android/gradlew | ||
**/android/gradlew.bat | ||
**/android/local.properties | ||
**/android/**/GeneratedPluginRegistrant.java | ||
|
||
# iOS/XCode related | ||
**/ios/**/*.mode1v3 | ||
**/ios/**/*.mode2v3 | ||
**/ios/**/*.moved-aside | ||
**/ios/**/*.pbxuser | ||
**/ios/**/*.perspectivev3 | ||
**/ios/**/*sync/ | ||
**/ios/**/.sconsign.dblite | ||
**/ios/**/.tags* | ||
**/ios/**/.vagrant/ | ||
**/ios/**/DerivedData/ | ||
**/ios/**/Icon? | ||
**/ios/**/Pods/ | ||
**/ios/**/.symlinks/ | ||
**/ios/**/profile | ||
**/ios/**/xcuserdata | ||
**/ios/.generated/ | ||
**/ios/Flutter/App.framework | ||
**/ios/Flutter/Flutter.framework | ||
**/ios/Flutter/Flutter.podspec | ||
**/ios/Flutter/Generated.xcconfig | ||
**/ios/Flutter/app.flx | ||
**/ios/Flutter/app.zip | ||
**/ios/Flutter/flutter_assets/ | ||
**/ios/Flutter/flutter_export_environment.sh | ||
**/ios/ServiceDefinitions.json | ||
**/ios/Runner/GeneratedPluginRegistrant.* | ||
|
||
# Exceptions to above rules. | ||
!**/ios/**/default.mode1v3 | ||
!**/ios/**/default.mode2v3 | ||
!**/ios/**/default.pbxuser | ||
!**/ios/**/default.perspectivev3 | ||
!/packages/flutter_tools/test/data/dart_dependencies_test/**/.packages |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
# This file tracks properties of this Flutter project. | ||
# Used by Flutter tool to assess capabilities and perform upgrades etc. | ||
# | ||
# This file should be version controlled and should not be manually edited. | ||
|
||
version: | ||
revision: 0b8abb4724aa590dd0f429683339b1e045a1594d | ||
channel: stable | ||
|
||
project_type: package |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
## [0.0.1] - TODO: Add release date. | ||
|
||
* TODO: Describe initial release. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
TODO: Add your license here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,130 @@ | ||
# esc_pos_bluetooth | ||
|
||
The library allows to print receipts using an ESC/POS thermal WiFi/Ethernet printer. | ||
|
||
[[pub.dev page]](https://pub.dev/packages/esc_pos_printer) | ||
| [[Documentation]](https://pub.dev/documentation/esc_pos_printer/latest/) | ||
|
||
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. | ||
|
||
**Here are some [printers tested with this library](printers.md). Please add your models you have tested to maintain and improve this library and help others to choose the right printer.** | ||
|
||
## Main Features | ||
|
||
* Connect to Wi-Fi / Ethernet printers | ||
* Simple text printing using *text* method | ||
* Tables printing using *row* method | ||
* Text styling: | ||
* size, align, bold, reverse, underline, different fonts, turn 90° | ||
* Print images | ||
* Print barcodes | ||
* UPC-A, UPC-E, JAN13 (EAN13), JAN8 (EAN8), CODE39, ITF (Interleaved 2 of 5), CODABAR (NW-7) | ||
* Paper cut (partial, full) | ||
* Beeping (with different duration) | ||
* Paper feed, reverse feed | ||
|
||
**Note**: Your printer may not support some of the presented features (especially for underline styles, partial/full paper cutting, reverse feed, ...). | ||
|
||
## Getting started (Generate a ticket) | ||
```dart | ||
Ticket testTicket() { | ||
final Ticket ticket = Ticket(PaperSize.mm80); | ||
ticket.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'); | ||
ticket.text('Special 1: àÀ èÈ éÉ ûÛ üÜ çÇ ôÔ', | ||
styles: PosStyles(codeTable: PosCodeTable.westEur)); | ||
ticket.text('Special 2: blåbærgrød', | ||
styles: PosStyles(codeTable: PosCodeTable.westEur)); | ||
ticket.text('Bold text', styles: PosStyles(bold: true)); | ||
ticket.text('Reverse text', styles: PosStyles(reverse: true)); | ||
ticket.text('Underlined text', | ||
styles: PosStyles(underline: true), linesAfter: 1); | ||
ticket.text('Align left', styles: PosStyles(align: PosTextAlign.left)); | ||
ticket.text('Align center', styles: PosStyles(align: PosTextAlign.center)); | ||
ticket.text('Align right', | ||
styles: PosStyles(align: PosTextAlign.right), linesAfter: 1); | ||
ticket.text('Text size 200%', | ||
styles: PosStyles( | ||
height: PosTextSize.size2, | ||
width: PosTextSize.size2, | ||
)); | ||
ticket.feed(2); | ||
ticket.cut(); | ||
return ticket; | ||
} | ||
``` | ||
Print a table row: | ||
|
||
```dart | ||
ticket.row([ | ||
PosColumn( | ||
text: 'col3', | ||
width: 3, | ||
styles: PosStyles(align: PosTextAlign.center, underline: true), | ||
), | ||
PosColumn( | ||
text: 'col6', | ||
width: 6, | ||
styles: PosStyles(align: PosTextAlign.center, underline: true), | ||
), | ||
PosColumn( | ||
text: 'col3', | ||
width: 3, | ||
styles: PosStyles(align: PosTextAlign.center, underline: true), | ||
), | ||
]); | ||
``` | ||
|
||
Print an image: | ||
|
||
```dart | ||
import 'dart:io'; | ||
import 'package:image/image.dart'; | ||
const String filename = './logo.png'; | ||
final Image image = decodeImage(File(filename).readAsBytesSync()); | ||
// Using (ESC *) command | ||
ticket.image(image); | ||
// Using an alternative obsolette (GS v 0) command | ||
ticket.imageRaster(image); | ||
``` | ||
|
||
Print a barcode: | ||
```dart | ||
final List<int> barData = [1, 2, 3, 4, 5, 6, 7, 8, 9, 0, 4]; | ||
ticket.barcode(Barcode.upcA(barData)); | ||
``` | ||
|
||
## Getting Started (Bluetooth printer) | ||
|
||
```dart | ||
PrinterBluetoothManager printerManager = PrinterBluetoothManager(); | ||
printerManager.scanResults.listen((printers) async { | ||
// store found printers | ||
}); | ||
printerManager.startScan(Duration(seconds: 4)); | ||
// ... | ||
printerManager.selectPrinter(printer); | ||
final PosPrintResult res = await printerManager.printTicket(testTicket()); | ||
print('Print result: ${res.msg}'); | ||
``` | ||
|
||
For more details, check the demo project *example/blue*. | ||
|
||
## Test print | ||
<img src="https://github.com/andrey-ushakov/esc_pos_printer/blob/master/example/receipt.jpg?raw=true" alt="test receipt" height="500"/> | ||
|
||
## Support | ||
If this package was helpful, a cup of coffee would be highly appreciated :) | ||
|
||
[<img src="https://az743702.vo.msecnd.net/cdn/kofi2.png?v=2" width="200">](https://ko-fi.com/andreydev) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
library esc_pos_bluetooth; | ||
|
||
/// A Calculator. | ||
class Calculator { | ||
/// Returns [value] plus 1. | ||
int addOne(int value) => value + 1; | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
name: esc_pos_bluetooth | ||
description: A new Flutter package project. | ||
version: 0.0.1 | ||
author: | ||
homepage: | ||
|
||
environment: | ||
sdk: ">=2.1.0 <3.0.0" | ||
|
||
dependencies: | ||
flutter: | ||
sdk: flutter | ||
|
||
dev_dependencies: | ||
flutter_test: | ||
sdk: flutter | ||
|
||
# For information on the generic Dart part of this file, see the | ||
# following page: https://dart.dev/tools/pub/pubspec | ||
|
||
# The following section is specific to Flutter. | ||
flutter: | ||
|
||
# To add assets to your package, add an assets section, like this: | ||
# assets: | ||
# - images/a_dot_burr.jpeg | ||
# - images/a_dot_ham.jpeg | ||
# | ||
# For details regarding assets in packages, see | ||
# https://flutter.dev/assets-and-images/#from-packages | ||
# | ||
# An image asset can refer to one or more resolution-specific "variants", see | ||
# https://flutter.dev/assets-and-images/#resolution-aware. | ||
|
||
# To add custom fonts to your package, add a fonts section here, | ||
# in this "flutter" section. Each entry in this list should have a | ||
# "family" key with the font family name, and a "fonts" key with a | ||
# list giving the asset and other descriptors for the font. For | ||
# example: | ||
# fonts: | ||
# - family: Schyler | ||
# fonts: | ||
# - asset: fonts/Schyler-Regular.ttf | ||
# - asset: fonts/Schyler-Italic.ttf | ||
# style: italic | ||
# - family: Trajan Pro | ||
# fonts: | ||
# - asset: fonts/TrajanPro.ttf | ||
# - asset: fonts/TrajanPro_Bold.ttf | ||
# weight: 700 | ||
# | ||
# For details regarding fonts in packages, see | ||
# https://flutter.dev/custom-fonts/#from-packages |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
import 'package:flutter_test/flutter_test.dart'; | ||
|
||
import 'package:esc_pos_bluetooth/esc_pos_bluetooth.dart'; | ||
|
||
void main() { | ||
test('adds one to input values', () { | ||
final calculator = Calculator(); | ||
expect(calculator.addOne(2), 3); | ||
expect(calculator.addOne(-7), -6); | ||
expect(calculator.addOne(0), 1); | ||
expect(() => calculator.addOne(null), throwsNoSuchMethodError); | ||
}); | ||
} |