Skip to content

E
esc_pos_print_plus
Commit 7e4d35ef authored by Andrey's avatar Andrey
Browse files
Options

Removed basic ESC/POS classes (moved to esc_pos_utils library). Removed… 

Removed basic ESC/POS classes (moved to esc_pos_utils library). Removed bluetooth support (moved to esc_pos_bluetooth library).
parent a9b90937
Expand all Show whitespace changes
Inline Side-by-side
Showing with 21 additions and 1137 deletions
CHANGELOG.md
View file @ 7e4d35ef
## [3.0.0]
* Basic ESC/POS classes moved to esc_pos_utils library
* Bluetooth printing moved to esc_pos_bluetooth library
* This library is used to print using a WiFi/Ethernet printer
## [2.1.2]
* Bluetooth printing support for Android
......
example/example.dart
View file @ 7e4d35ef
import 'dart:io';
import 'dart:typed_data';
import 'package:flutter/services.dart';
import 'package:image/image.dart';
// import 'dart:io';
// import 'dart:typed_data';
// import 'package:flutter/services.dart';
// import 'package:image/image.dart';
import 'package:esc_pos_printer/esc_pos_printer.dart';
import 'package:esc_pos_utils/esc_pos_utils.dart';
void main() async {
final PrinterNetworkManager printerManager = PrinterNetworkManager();
......@@ -60,10 +61,10 @@ Future<Ticket> testTicket() async {
));
// Print image
final ByteData data = await rootBundle.load('assets/logo.png');
final Uint8List bytes = data.buffer.asUint8List();
final Image image = decodeImage(bytes);
ticket.image(image);
// final ByteData data = await rootBundle.load('assets/logo.png');
// final Uint8List bytes = data.buffer.asUint8List();
// final Image image = decodeImage(bytes);
// ticket.image(image);
// Print image using an alternative (obsolette) command
// ticket.imageRaster(image);
......
lib/esc_pos_printer.dart
View file @ 7e4d35ef
......@@ -7,10 +7,5 @@
*/
library esc_pos_printer;
export './src/barcode.dart';
export './src/enums.dart';
export './src/pos_column.dart';
export './src/pos_styles.dart';
export './src/printer_bluetooth_manager.dart';
export './src/printer_network_manager.dart';
export './src/ticket.dart';
lib/src/barcode.dart deleted 100644 → 0
View file @ a9b90937
/*
* esc_pos_printer
* Created by Andrey Ushakov
*
* Copyright (c) 2019-2020. All rights reserved.
* See LICENSE for distribution and usage details.
*/
class BarcodeType {
const BarcodeType._internal(this.value);
final int value;
/// UPC-A
static const upcA = BarcodeType._internal(0);
/// UPC-E
static const upcE = BarcodeType._internal(1);
/// JAN13 (EAN13)
static const ean13 = BarcodeType._internal(2);
/// JAN8 (EAN8)
static const ean8 = BarcodeType._internal(3);
/// CODE39
static const code39 = BarcodeType._internal(4);
/// ITF (Interleaved 2 of 5)
static const itf = BarcodeType._internal(5);
/// CODABAR (NW-7)
static const codabar = BarcodeType._internal(6);
}
class BarcodeText {
const BarcodeText._internal(this.value);
final int value;
/// Not printed
static const none = BarcodeText._internal(0);
/// Above the barcode
static const above = BarcodeText._internal(1);
/// Below the barcode
static const below = BarcodeText._internal(2);
/// Both above and below the barcode
static const both = BarcodeText._internal(3);
}
class BarcodeFont {
const BarcodeFont._internal(this.value);
final int value;
static const fontA = BarcodeFont._internal(0);
static const fontB = BarcodeFont._internal(1);
static const fontC = BarcodeFont._internal(2);
static const fontD = BarcodeFont._internal(3);
static const fontE = BarcodeFont._internal(4);
static const specialA = BarcodeFont._internal(97);
static const specialB = BarcodeFont._internal(98);
}
class Barcode {
/// UPC-A
///
/// k = 11, 12
/// d = '0' – '9'
Barcode.upcA(List<dynamic> barcodeData) {
final k = barcodeData.length;
if (![11, 12].contains(k)) {
throw Exception('Barcode: Wrong data range');
}
final numeric = RegExp(r'^[0-9]$');
final bool isDataValid =
barcodeData.every((dynamic d) => numeric.hasMatch(d.toString()));
if (!isDataValid) {
throw Exception('Barcode: Data is not valid');
}
_type = BarcodeType.upcA;
_data = _convertData(barcodeData);
}
/// UPC-E
///
/// k = 6 – 8, 11, 12
/// d = '0' – '9' (However, d0 = '0' when k = 7, 8, 11, 12)
Barcode.upcE(List<dynamic> barcodeData) {
final k = barcodeData.length;
if (![6, 7, 8, 11, 12].contains(k)) {
throw Exception('Barcode: Wrong data range');
}
if ([7, 8, 11, 12].contains(k) && barcodeData[0].toString() != '0') {
throw Exception('Barcode: Data is not valid');
}
final numeric = RegExp(r'^[0-9]$');
final bool isDataValid =
barcodeData.every((dynamic d) => numeric.hasMatch(d.toString()));
if (!isDataValid) {
throw Exception('Barcode: Data is not valid');
}
_type = BarcodeType.upcE;
_data = _convertData(barcodeData);
}
/// JAN13 (EAN13)
///
/// k = 12, 13
/// d = '0' – '9'
Barcode.ean13(List<dynamic> barcodeData) {
final k = barcodeData.length;
if (![12, 13].contains(k)) {
throw Exception('Barcode: Wrong data range');
}
final numeric = RegExp(r'^[0-9]$');
final bool isDataValid =
barcodeData.every((dynamic d) => numeric.hasMatch(d.toString()));
if (!isDataValid) {
throw Exception('Barcode: Data is not valid');
}
_type = BarcodeType.ean13;
_data = _convertData(barcodeData);
}
/// JAN8 (EAN8)
///
/// k = 7, 8
/// d = '0' – '9'
Barcode.ean8(List<dynamic> barcodeData) {
final k = barcodeData.length;
if (![7, 8].contains(k)) {
throw Exception('Barcode: Wrong data range');
}
final numeric = RegExp(r'^[0-9]$');
final bool isDataValid =
barcodeData.every((dynamic d) => numeric.hasMatch(d.toString()));
if (!isDataValid) {
throw Exception('Barcode: Data is not valid');
}
_type = BarcodeType.ean8;
_data = _convertData(barcodeData);
}
/// CODE39
///
/// k >= 1
/// d: '0'–'9', A–Z, SP, $, %, *, +, -, ., /
Barcode.code39(List<dynamic> barcodeData) {
final k = barcodeData.length;
if (k < 1) {
throw Exception('Barcode: Wrong data range');
}
final regex = RegExp(r'^[0-9A-Z \$\%\*\+\-\.\/]$');
final bool isDataValid =
barcodeData.every((dynamic d) => regex.hasMatch(d.toString()));
if (!isDataValid) {
throw Exception('Barcode: Data is not valid');
}
_type = BarcodeType.code39;
_data = _convertData(barcodeData);
}
/// ITF (Interleaved 2 of 5)
///
/// k >= 2 (even number)
/// d = '0'–'9'
Barcode.itf(List<dynamic> barcodeData) {
final k = barcodeData.length;
if (k < 2 || !k.isEven) {
throw Exception('Barcode: Wrong data range');
}
final numeric = RegExp(r'^[0-9]$');
final bool isDataValid =
barcodeData.every((dynamic d) => numeric.hasMatch(d.toString()));
if (!isDataValid) {
throw Exception('Barcode: Data is not valid');
}
_type = BarcodeType.itf;
_data = _convertData(barcodeData);
}
/// CODABAR (NW-7)
///
/// k >= 2
/// d: '0'–'9', A–D, a–d, $, +, −, ., /, :
/// However, d0 = A–D, dk = A–D (65-68)
/// d0 = a-d, dk = a-d (97-100)
Barcode.codabar(List<dynamic> barcodeData) {
final k = barcodeData.length;
if (k < 2) {
throw Exception('Barcode: Wrong data range');
}
final regex = RegExp(r'^[0-9A-Da-d\$\+\-\.\/\:]$');
final bool isDataValid =
barcodeData.every((dynamic d) => regex.hasMatch(d.toString()));
if (!isDataValid) {
throw Exception('Barcode: Data is not valid');
}
if ((_charcode(barcodeData[0]) >= 65 && _charcode(barcodeData[0]) <= 68) &&
!(_charcode(barcodeData[k - 1]) >= 65 &&
_charcode(barcodeData[k - 1]) <= 68)) {
throw Exception('Barcode: Wrong data range');
}
if ((_charcode(barcodeData[0]) >= 97 && _charcode(barcodeData[0]) <= 100) &&
!(_charcode(barcodeData[k - 1]) >= 97 &&
_charcode(barcodeData[k - 1]) <= 100)) {
throw Exception('Barcode: Wrong data range');
}
_type = BarcodeType.codabar;
_data = _convertData(barcodeData);
}
BarcodeType _type;
List<int> _data;
List<int> _convertData(List<dynamic> list) =>
list.map((dynamic d) => d.toString().codeUnitAt(0)).toList();
int _charcode(dynamic ch) => ch.toString().codeUnitAt(0);
BarcodeType get type => _type;
List<int> get data => _data;
}
lib/src/commands.dart deleted 100644 → 0
View file @ a9b90937
/*
* esc_pos_printer
* Created by Andrey Ushakov
*
* Copyright (c) 2019-2020. All rights reserved.
* See LICENSE for distribution and usage details.
*/
const esc = '\x1B';
const gs = '\x1D';
const fs = '\x1C';
// Miscellaneous
const cInit = '$esc@'; // Initialize printer
const cBeep = '${esc}B'; // Beeper [count] [duration]
// Mech. Control
const cCutFull = '${gs}V0'; // Full cut
const cCutPart = '${gs}V1'; // Partial cut
// Character
const cReverseOn = '${gs}B1'; // Turn white/black reverse print mode on
const cReverseOff = '${gs}B0'; // Turn white/black reverse print mode off
const cSizeGSn = '$gs!'; // Select character size [N]
const cSizeESCn = '$esc!'; // Select character size [N]
const cUnderlineOff = '$esc-0'; // Turns off underline mode
const cUnderline1dot = '$esc-1'; // Turns on underline mode (1-dot thick)
const cUnderline2dots = '$esc-2'; // Turns on underline mode (2-dots thick)
const cBoldOn = '${esc}E1'; // Turn emphasized mode on
const cBoldOff = '${esc}E0'; // Turn emphasized mode off
const cFontA = '${esc}M0'; // Font A
const cFontB = '${esc}M1'; // Font B
const cTurn90On = '${esc}V1'; // Turn 90° clockwise rotation mode on
const cTurn90Off = '${esc}V0'; // Turn 90° clockwise rotation mode off
const cCodeTable = '${esc}t'; // Select character code table [N]
const cKanjiOn = '$fs&'; // Select Kanji character mode
const cKanjiOff = '$fs.'; // Cancel Kanji character mode
// Print Position
const cAlignLeft = '${esc}a0'; // Left justification
const cAlignCenter = '${esc}a1'; // Centered
const cAlignRight = '${esc}a2'; // Right justification
const cPos = '$esc\$'; // Set absolute print position [nL] [nH]
// Print
const cFeedN = '${esc}d'; // Print and feed n lines [N]
const cReverseFeedN = '${esc}e'; // Print and reverse feed n lines [N]
// Bit Image
const cRasterImg = '${gs}v0'; // Print raster bit image [obsolete command]
const cBitImg = '$esc*'; // Set bit image mode
// Barcode
const cBarcodeSelectPos =
'${gs}H'; // Select print position of HRI characters [N]
const cBarcodeSelectFont = '${gs}f'; // Select font for HRI characters [N]
const cBarcodeSetH = '${gs}h'; // Set barcode height [N]
const cBarcodeSetW = '${gs}w'; // Set barcode width [N]
const cBarcodePrint = '${gs}k'; // Print barcode
lib/src/enums.dart
View file @ 7e4d35ef
......@@ -6,10 +6,6 @@
* See LICENSE for distribution and usage details.
*/
enum PosTextAlign { left, center, right }
enum PosCutMode { full, partial }
enum PosFontType { fontA, fontB }
class PosPrintResult {
const PosPrintResult._internal(this.value);
final int value;
......@@ -38,95 +34,3 @@ class PosPrintResult {
}
}
}
class PosTextSize {
const PosTextSize._internal(this.value);
final int value;
static const size1 = PosTextSize._internal(1);
static const size2 = PosTextSize._internal(2);
static const size3 = PosTextSize._internal(3);
static const size4 = PosTextSize._internal(4);
static const size5 = PosTextSize._internal(5);
static const size6 = PosTextSize._internal(6);
static const size7 = PosTextSize._internal(7);
static const size8 = PosTextSize._internal(8);
static int decSize(PosTextSize height, PosTextSize width) =>
16 * (width.value - 1) + (height.value - 1);
}
class PaperSize {
const PaperSize._internal(this.value);
final int value;
static const mm58 = PaperSize._internal(1);
static const mm80 = PaperSize._internal(2);
int get width => value == PaperSize.mm58.value ? 350 : 512;
}
class PosBeepDuration {
const PosBeepDuration._internal(this.value);
final int value;
static const beep50ms = PosBeepDuration._internal(1);
static const beep100ms = PosBeepDuration._internal(2);
static const beep150ms = PosBeepDuration._internal(3);
static const beep200ms = PosBeepDuration._internal(4);
static const beep250ms = PosBeepDuration._internal(5);
static const beep300ms = PosBeepDuration._internal(6);
static const beep350ms = PosBeepDuration._internal(7);
static const beep400ms = PosBeepDuration._internal(8);
static const beep450ms = PosBeepDuration._internal(9);
}
class PosCodeTable {
const PosCodeTable._internal(this.value);
final int value;
/// PC437 - U.S.A., Standard Europe
static const pc437 = PosCodeTable._internal(0);
/// Katakana
static const katakana = PosCodeTable._internal(1);
/// PC850 Multilingual
static const pc850 = PosCodeTable._internal(2);
/// PC860 - Portuguese
static const pc860 = PosCodeTable._internal(3);
/// PC863 - Canadian-French
static const pc863 = PosCodeTable._internal(4);
/// PC865 - Nordic
static const pc865 = PosCodeTable._internal(5);
/// Western Europe
static const westEur = PosCodeTable._internal(6);
/// Greek
static const greek = PosCodeTable._internal(7);
/// PC737 - Greek
static const pc737 = PosCodeTable._internal(64);
/// PC851 - Greek
static const pc851 = PosCodeTable._internal(65);
/// PC869 - Greek
static const pc869 = PosCodeTable._internal(66);
/// PC928 - Greek
static const pc928 = PosCodeTable._internal(67);
/// PC866 - Cyrillic #2
static const pc866 = PosCodeTable._internal(17);
/// PC852 - Latin2
static const pc852 = PosCodeTable._internal(18);
/// WPC1252 - Latin1
static const wpc1252 = PosCodeTable._internal(71);
/// Space page
static const spacePage = PosCodeTable._internal(255);
}
lib/src/pos_column.dart deleted 100644 → 0
View file @ a9b90937
/*
* esc_pos_printer
* Created by Andrey Ushakov
*
* Copyright (c) 2019-2020. All rights reserved.
* See LICENSE for distribution and usage details.
*/
import 'pos_styles.dart';
/// Column contains text, styles and width (an integer in 1..12 range)
class PosColumn {
PosColumn({
this.text = '',
this.containsChinese = false,
this.width = 2,
this.styles = const PosStyles(),
}) {
if (width < 1 || width > 12) {
throw Exception('Column width must be between 1..12');
}
}
String text;
bool containsChinese;
int width;
PosStyles styles;
}
lib/src/pos_styles.dart deleted 100644 → 0
View file @ a9b90937
/*
* esc_pos_printer
* Created by Andrey Ushakov
*
* Copyright (c) 2019-2020. All rights reserved.
* See LICENSE for distribution and usage details.
*/
import 'enums.dart';
/// Text styles
class PosStyles {
const PosStyles({
this.bold = false,
this.reverse = false,
this.underline = false,
this.turn90 = false,
this.align = PosTextAlign.left,
this.height = PosTextSize.size1,
this.width = PosTextSize.size1,
this.fontType = PosFontType.fontA,
this.codeTable,
});
final bool bold;
final bool reverse;
final bool underline;
final bool turn90;
final PosTextAlign align;
final PosTextSize height;
final PosTextSize width;
final PosFontType fontType;
final PosCodeTable codeTable;
}
lib/src/printer_bluetooth_manager.dart deleted 100644 → 0
View file @ a9b90937
/*
* esc_pos_printer
* Created by Andrey Ushakov
*
* Copyright (c) 2019-2020. All rights reserved.
* See LICENSE for distribution and usage details.
*/
import 'dart:async';
import 'package:esc_pos_printer/esc_pos_printer.dart';
import 'package:rxdart/rxdart.dart';
import 'package:flutter_bluetooth_basic/flutter_bluetooth_basic.dart';
/// Bluetooth printer
class PrinterBluetooth {
PrinterBluetooth(this._device);
final BluetoothDevice _device;
String get name => _device.name;
String get address => _device.address;
int get type => _device.type;
}
/// Printer Bluetooth Manager
class PrinterBluetoothManager {
final BluetoothManager _bluetoothManager = BluetoothManager.instance;
bool _isPrinting = false;
bool _isConnected = false;
StreamSubscription _scanResultsSubscription;
StreamSubscription _isScanningSubscription;
PrinterBluetooth _selectedPrinter;
final BehaviorSubject<bool> _isScanning = BehaviorSubject.seeded(false);
Stream<bool> get isScanningStream => _isScanning.stream;
final BehaviorSubject<List<PrinterBluetooth>> _scanResults =
BehaviorSubject.seeded([]);
Stream<List<PrinterBluetooth>> get scanResults => _scanResults.stream;
Future _runDelayed(int seconds) {
return Future<dynamic>.delayed(Duration(seconds: seconds));
}
void startScan(Duration timeout) async {
_scanResults.add(<PrinterBluetooth>[]);
_bluetoothManager.startScan(timeout: Duration(seconds: 4));
_scanResultsSubscription = _bluetoothManager.scanResults.listen((devices) {
_scanResults.add(devices.map((d) => PrinterBluetooth(d)).toList());
});
_isScanningSubscription =
_bluetoothManager.isScanning.listen((isScanningCurrent) async {
// If isScanning value changed (scan just stopped)
if (_isScanning.value && !isScanningCurrent) {
_scanResultsSubscription.cancel();
_isScanningSubscription.cancel();
}
_isScanning.add(isScanningCurrent);
});
}
void stopScan() async {
await _bluetoothManager.stopScan();
}
void selectPrinter(PrinterBluetooth printer) {
_selectedPrinter = printer;
}
Future<PosPrintResult> writeBytes(List<int> bytes) async {
final Completer<PosPrintResult> completer = Completer();
const int timeout = 5;
if (_selectedPrinter == null) {
return Future<PosPrintResult>.value(PosPrintResult.printerNotSelected);
} else if (_isScanning.value) {
return Future<PosPrintResult>.value(PosPrintResult.scanInProgress);
} else if (_isPrinting) {
return Future<PosPrintResult>.value(PosPrintResult.printInProgress);
}
_isPrinting = true;
// We have to rescan before connecting, otherwise we can connect only once
await _bluetoothManager.startScan(timeout: Duration(seconds: 1));
await _bluetoothManager.stopScan();
// Connect
await _bluetoothManager.connect(_selectedPrinter._device);
// Subscribe to the events
_bluetoothManager.state.listen((state) async {
switch (state) {
case BluetoothManager.CONNECTED:
// To avoid double call
if (!_isConnected) {
await _bluetoothManager.writeData(bytes);
completer.complete(PosPrintResult.success);
}
// TODO sending disconnect signal should be event-based
_runDelayed(3).then((dynamic v) async {
await _bluetoothManager.disconnect();
_isPrinting = false;
});
_isConnected = true;
break;
case BluetoothManager.DISCONNECTED:
_isConnected = false;
break;
default:
break;
}
});
// Printing timeout
_runDelayed(timeout).then((dynamic v) async {
if (_isPrinting) {
_isPrinting = false;
completer.complete(PosPrintResult.timeout);
}
});
return completer.future;
}
Future<PosPrintResult> printTicket(Ticket ticket) async {
if (ticket == null || ticket.bytes.isEmpty) {
return Future<PosPrintResult>.value(PosPrintResult.ticketEmpty);
}
return writeBytes(ticket.bytes);
}
}
lib/src/printer_network_manager.dart
View file @ 7e4d35ef
......@@ -7,8 +7,8 @@
*/
import 'dart:io';
import 'package:esc_pos_utils/esc_pos_utils.dart';
import './enums.dart';
import './ticket.dart';
/// Printer Network Manager
class PrinterNetworkManager {
......
lib/src/ticket.dart deleted 100644 → 0
View file @ a9b90937
This diff is collapsed.
pubspec.yaml
View file @ 7e4d35ef
name: esc_pos_printer
description: The library allows to print receipts using an ESC/POS thermal WiFi/Bluetooth printer.
version: 2.1.2
description: The library allows to print receipts using an ESC/POS thermal WiFi printer.
version: 3.0.0
homepage: https://github.com/andrey-ushakov/esc_pos_printer
environment:
......@@ -9,14 +9,11 @@ environment:
dependencies:
flutter:
sdk: flutter
hex: ^0.1.2
image: ^2.1.4
gbk_codec: ^0.3.1+3
rxdart: ^0.23.1
flutter_bluetooth_basic: ^0.1.2
# flutter_bluetooth_basic:
esc_pos_utils: ^0.1.1
# esc_pos_utils:
# git:
# url: git://github.com/andrey-ushakov/flutter_bluetooth_basic
# url: git://github.com/andrey-ushakov/esc_pos_utils
# ref: master
dev_dependencies:
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment