Flutter热敏打印机控制插件esc_pos_utils_refactor的使用

插件简介

esc_pos_utils_refactor 是一个用于生成 ESC/POS 打印命令的 Flutter/Dart 库。它提供了通用的类来生成可以发送到热敏打印机的 ESC/POS 命令。

该库是以下两个库的基础：

• esc_pos_printer: 用于通过 Wi-Fi 或以太网打印。
• esc_pos_bluetooth: 用于通过蓝牙打印。

主要特性

• 支持连接 Wi-Fi/以太网打印机。
• 简单的文本打印功能。
• 支持表格打印。
• 文本样式支持（如大小、对齐方式、加粗、反转、下划线等）。
• 支持打印图像。
• 支持打印条形码（包括 UPC-A、UPC-E、JAN13、JAN8、CODE39、ITF、CODABAR、CODE128）。
• 支持纸张切割（部分切割和完全切割）。
• 支持蜂鸣器功能。
• 支持纸张进纸和反向进纸。

注意：您的打印机可能不支持所有列出的功能。

示例代码

以下是一个完整的示例代码，展示了如何使用 esc_pos_utils_refactor 插件生成打印任务。

依赖配置

在 pubspec.yaml 文件中添加以下依赖：

dependencies:
  esc_pos_utils_refactor: ^1.0.0

然后运行 flutter pub get 安装依赖。

示例代码

import 'dart:typed_data';
import 'package:flutter/services.dart';
import 'package:esc_pos_utils_refactor/esc_pos_utils_refactor.dart';
import 'package:image/image.dart' as img;

Future<void> main() async {
  // 加载默认配置文件
  final profile = await CapabilityProfile.load();
  final generator = Generator(PaperSize.mm80, profile);

  List<int> bytes = [];

  // 打印普通文本
  bytes += generator.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',
  );

  // 打印特殊字符
  bytes += generator.text(
    'Special 1: àÀ èÈ éÉ ûÛ üÜ çÇ ôÔ',
    styles: PosStyles(codeTable: PosCodeTable.westEur),
  );
  bytes += generator.text(
    'Special 2: blåbærgrød',
    styles: PosStyles(codeTable: PosCodeTable.westEur),
  );

  // 添加加粗文本
  bytes += generator.text(
    'Bold text',
    styles: PosStyles(bold: true),
  );

  // 添加反转文本
  bytes += generator.text(
    'Reverse text',
    styles: PosStyles(reverse: true),
  );

  // 添加下划线文本
  bytes += generator.text(
    'Underlined text',
    styles: PosStyles(underline: true),
    linesAfter: 1,
  );

  // 对齐方式测试
  bytes += generator.text(
    'Align left',
    styles: PosStyles(align: PosAlign.left),
  );
  bytes += generator.text(
    'Align center',
    styles: PosStyles(align: PosAlign.center),
  );
  bytes += generator.text(
    'Align right',
    styles: PosStyles(align: PosAlign.right),
    linesAfter: 1,
  );

  // 设置文本大小为 200%
  bytes += generator.text(
    'Text size 200%',
    styles: PosStyles(
      height: PosTextSize.size2,
      width: PosTextSize.size2,
    ),
  );

  // 打印表格行
  bytes += generator.row([
    PosColumn(
      text: 'col3',
      width: 3,
      styles: PosStyles(align: PosAlign.center, underline: true),
    ),
    PosColumn(
      text: 'col6',
      width: 6,
      styles: PosStyles(align: PosAlign.center, underline: true),
    ),
    PosColumn(
      text: 'col3',
      width: 3,
      styles: PosStyles(align: PosAlign.center, underline: true),
    ),
  ]);

  // 打印图像
  final ByteData data = await rootBundle.load('assets/logo.png');
  final Uint8List imgBytes = data.buffer.asUint8List();
  final img.Image image = img.decodeImage(imgBytes)!;
  bytes += generator.image(image);

  // 打印条形码
  final List<int> barData = [1, 2, 3, 4, 5, 6, 7, 8, 9, 0, 4];
  bytes += generator.barcode(Barcode.upcA(barData));

  // 打印二维码
  String qrData = "google.com";
  const double qrSize = 200;
  try {
    final uiImg = await QrPainter(
      data: qrData,
      version: QrVersions.auto,
      gapless: false,
    ).toImageData(qrSize);
    final dir = await getTemporaryDirectory();
    final pathName = '${dir.path}/qr_tmp.png';
    final qrFile = File(pathName);
    final imgFile = await qrFile.writeAsBytes(uiImg!.buffer.asUint8List());
    final img.Image qrImage = img.decodeImage(imgFile.readAsBytesSync())!;
    bytes += generator.image(qrImage);
  } catch (e) {
    print(e);
  }

  // 进纸并切纸
  bytes += generator.feed(2);
  bytes += generator.cut();

  // 打印完成
  print(bytes);
}

功能详解

1. 打印文本

通过 generator.text() 方法可以打印普通文本，并支持多种样式，例如加粗、反转、下划线、对齐方式等。

bytes += generator.text(
  'Hello World',
  styles: PosStyles(bold: true, underline: true),
  linesAfter: 2,
);

2. 打印表格

通过 generator.row() 方法可以打印表格行，每个单元格可以设置宽度和样式。

bytes += generator.row([
  PosColumn(text: 'Header1', width: 4),
  PosColumn(text: 'Header2', width: 4),
  PosColumn(text: 'Header3', width: 4),
]);

3. 打印图像

支持三种打印图像的方式：

• 使用 ESC * 命令（推荐）
• 使用 GS v 0 命令（已过时）
• 使用 GS ( L 命令

final ByteData data = await rootBundle.load('assets/logo.png');
final Uint8List imgBytes = data.buffer.asUint8List();
final img.Image image = img.decodeImage(imgBytes)!;
bytes += generator.image(image);

4. 打印条形码

支持多种条形码类型，例如 UPC-A、UPC-E、JAN13 等。

final List<int> barData = [1, 2, 3, 4, 5, 6, 7, 8, 9, 0, 4];
bytes += generator.barcode(Barcode.upcA(barData));

5. 打印二维码

可以通过 ESC/POS 原生命令或将其转换为图像后打印。

原生命令

generator.qrcode('example.com');

转换为图像

final uiImg = await QrPainter(data: 'google.com').toImageData(200);
final img.Image qrImage = img.decodeImage(uiImg!.buffer.asUint8List())!;
bytes += generator.image(qrImage);

使用打印机配置文件

不同的打印机支持不同的代码表。可以通过 CapabilityProfile 类加载打印机配置文件。

final profile = await CapabilityProfile.load('XP-N160I');
final generator = Generator(PaperSize.mm80, profile);
bytes += generator.setGlobalCodeTable('CP1252');

所有可用的配置文件可以通过以下方法获取：

final profiles = await CapabilityProfile.getAvailableProfiles();