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

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

本README描述了该插件。如果您将此插件发布到pub.dev，此README的内容将出现在您的插件页面上。

对于如何编写一个好的插件README的指南，请参阅编写插件页面。

对于开发插件的一般信息，请参阅Dart关于创建插件的指南和Flutter关于开发插件的指南。

插件描述

该插件允许您在Flutter Web中通过USB连接到热敏打印机并进行打印。

它从<a href="https://pub.dev/packages/usb_thermal_printer_web">usb_printer_thermal_web</a>派生，并对其进行了改进，提供了更多的配置选项。

特性

• printFlex: 此函数接受一个字符串列表、一个整数的flex大小列表和一个对齐方式列表。使用此功能，您可以以表格形式打印任何数据。它会处理任何超出其flex大小的长文本。

• printText: 它允许您打印任何文本。配置选项包括使文本加粗、更改对齐方式或将其大小翻倍（使其成为标题）。

• printEmptyLine: 它打印一个空行，以便在两个打印语句之间添加空间。

• printDottedLine: 它打印一条虚线，或者可以用作分隔符。

• printKeyValue: 它接受两个输入，并将它们作为行中的单独列打印。

• printBarcode: 它打印条形码并在条形码下方打印给定的条形码字符串。

开始使用

您应该有一个web项目，因为此插件目前仅支持Flutter Web。在开始打印之前，您需要调用pairDevice()函数。 您可选地可以提供vendorId、productId、interfaceNumber和endpointNumber。如果您不传递这些变量，您可以从所有连接的USB设备列表中选择一个设备，并且它将自动尝试确定这些变量。

使用示例

以下函数打印一个示例收据。完整的示例位于example目录中。只需克隆该包，进入示例目录并运行flutter run -d chrome即可本地测试。

// 创建打印机实例
WebThermalPrinter _printer = WebThermalPrinter();

printReceipt() async {
  await _printer.pairDevice();

  // 打印文本，加粗、居中并设置为标题
  await _printer.printText('Sebastien Brocard', bold: true, align: 'center', title: true);
  await _printer.printEmptyLine();

  // 打印键值对
  await _printer.printKeyValue("Products", "Sale");
  await _printer.printEmptyLine();

  // 循环打印多个条目
  for (int i = 0; i < 2; i++) {
    await _printer.printKeyValue(
      'A big title very big title ${i + 1}', 
      '${(i + 1) * 510}.00 AED'
    );
    await _printer.printEmptyLine();
  }

  // 打印表格
  await _printer.printFlex(
    ['Chocolate Truffle Cake Small', '1', '550.85', '550.85'],
    [4, 1, 2, 2],
    ['left', 'right', 'right', 'right']
  );

  // 打印虚线
  await _printer.printDottedLine();

  // 打印条形码
  await _printer.printBarcode('123456');

  // 打印空行并关闭打印机
  await _printer.printEmptyLine();
  await _printer.closePrinter();
}

示例代码

import 'package:flutter/material.dart';
import 'package:usb_thermal_printer_web_pro/usb_thermal_printer_web_pro.dart';

void main() {
  runApp(const MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        colorScheme: ColorScheme.fromSeed(seedColor: Colors.deepPurple),
        useMaterial3: true,
      ),
      home: const MyHomePage(title: 'Flutter Demo Home Page'),
    );
  }
}

class MyHomePage extends StatefulWidget {
  const MyHomePage({super.key, required this.title});

  final String title;

  [@override](/user/override)
  State<MyHomePage> createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  int _counter = 0;

  void _incrementCounter() {
    setState(() {
      _counter++;
    });
  }

  printReceipt() async {
    WebThermalPrinter _printer = WebThermalPrinter();

    // 配对设备是必需的
    // await _printer.pairDevice(
    //     vendorId: 0x0fe6, productId: 0x811e, interfaceNo: 0, endpointNo: 2);

    await _printer.pairDevice();

    // 打印文本，加粗、居中并设置为标题
    await _printer.printText('Sebastien Brocard', bold: true, align: 'center', title: true);
    await _printer.printEmptyLine();

    // 打印键值对
    await _printer.printKeyValue("Products", "Sale");
    await _printer.printEmptyLine();

    // 循环打印多个条目
    for (int i = 0; i < 2; i++) {
      await _printer.printKeyValue(
        'A big title very big title ${i + 1}', 
        '${(i + 1) * 510}.00 AED'
      );
      await _printer.printEmptyLine();
    }

    // 打印表格
    await _printer.printFlex(
      ['Chocolate Truffle Cake Small', '1', '550.85', '550.85'],
      [4, 1, 2, 2],
      ['left', 'right', 'right', 'right']
    );

    // 打印虚线
    await _printer.printDottedLine();

    // 打印条形码
    await _printer.printBarcode('123456');

    // 打印空行并关闭打印机
    await _printer.printEmptyLine();
    await _printer.closePrinter();
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        backgroundColor: Theme.of(context).colorScheme.inversePrimary,
        title: Text(widget.title),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: [
            const Text(
              'Test USB Thermal Printer Web Pro Package',
            ),
            ElevatedButton(
              onPressed: () {
                printReceipt();
              },
              child: const Text('Test Print'),
            ),
            Text(
              '$_counter',
              style: Theme.of(context).textTheme.headlineMedium,
            ),
          ],
        ),
      ),
      floatingActionButton: FloatingActionButton(
        onPressed: _incrementCounter,
        tooltip: 'Increment',
        child: const Icon(Icons.add),
      ),
    );
  }
}