Flutter打印机控制插件nyx_printer_v2的使用

Flutter打印机控制插件nyx_printer_v2的使用

《NyxPrinter Flutter 插件》

NyxPrinter 包是一个 Flutter 插件，允许你与打印机进行交互，实现文本、条形码、二维码和图像的打印功能。它通过平台特定的代码与打印机通信并执行各种任务。

功能

• 打印文本：允许打印格式化的文本。
• 打印条形码：能够打印可自定义尺寸的条形码。
• 打印二维码：能够打印可自定义尺寸的二维码。
• 打印图像：允许打印 PNG 图像。

安装

要在你的 Flutter 项目中使用 NyxPrinter，请在 pubspec.yaml 文件中添加以下依赖项：

dependencies:
  nyx_printer: ^latest_version

然后，在终端中运行以下命令以安装该包：

flutter pub get

导入包

在 Dart 文件中导入必要的类：

import 'package:nyx_printer/nyx_printer.dart';

使用

以下是使用 NyxPrinter 包的概述：

1. 获取打印机版本

使用 getVersion 方法来获取打印机的版本号。如果操作成功，将返回 0。

int? version = await NyxPrinter().getVersion();

2. 打印文本

要以特定格式打印文本，可以使用 printText 方法。你可以选择性地提供一个 NyxTextFormat 对象来定义文本样式、对齐方式、大小等。

int? result = await NyxPrinter().printText(
  "Hello, World!", 
  textFormat: NyxTextFormat(
    textSize: 20, 
    style: NyxFontStyle.bold, 
    align: NyxAlign.center
  )
);

3. 打印条形码

要打印条形码，可以使用 printBarcode 方法。你可以设置条形码的宽度和高度。

int? result = await NyxPrinter().printBarcode(
  "1234567890", 
  width: 400, 
  height: 200
);

4. 打印二维码

要打印二维码，可以使用 printQrCode 方法。与条形码类似，你可以调整二维码的宽度和高度。

int? result = await NyxPrinter().printQrCode(
  "https://flutter.dev", 
  width: 300, 
  height: 300
);

5. 打印图像

要打印图像，你需要将图像转换为 Uint8List（PNG 格式），然后传递给 printImage 方法。

Uint8List imageBytes = await getImageBytes();  // 获取你的 PNG 图像作为字节
int? result = await NyxPrinter().printImage(imageBytes);

NyxTextFormat

NyxTextFormat 类提供了打印文本时的格式选项。

属性

• textSize: 定义字体大小（默认值为 24）。
• underline: 指定文本是否应下划线（默认为 false）。
• textScaleX: 水平文本缩放（默认为 1.0）。
• textScaleY: 垂直文本缩放（默认为 1.0）。
• letterSpacing: 定义字母之间的间距（默认为 0）。
• lineSpacing: 定义行之间的间距（默认为 0）。
• topPadding: 顶部填充（默认为 0）。
• leftPadding: 左边填充（默认为 0）。
• align: 文本对齐方式，可以是左对齐、居中或右对齐（默认为左对齐）。
• style: 字体样式，可以是常规、粗体、斜体或粗斜体（默认为常规）。
• font: 字体族，可以是默认字体、默认粗体、无衬线字体、衬线字体或等宽字体（默认为默认字体）。

示例

NyxTextFormat(
  textSize: 30, 
  underline: true, 
  textScaleX: 1.5, 
  textScaleY: 1.5, 
  align: NyxAlign.center
);

方法

NyxTextFormat 类提供了 toMap 方法，将格式化选项转换为 Map<String, dynamic>，可以传递给平台特定的代码。

Map<String, dynamic> formatMap = textFormat.toMap();

枚举

NyxFontStyle

定义字体样式：

• normal: 常规文本。
• bold: 粗体文本。
• italic: 斜体文本。
• boldItalic: 粗斜体文本。

NyxFont

定义字体族：

• defaultFont: 默认字体。
• defaultBold: 默认粗体字体。
• sansSerif: 无衬线字体。
• serif: 衬线字体。
• monospace: 等宽字体。

NyxAlign

定义文本对齐方式：

• left: 左对齐文本。
• center: 居中对齐文本。
• right: 右对齐文本。

错误处理

如果任何操作失败，Future<int?> 将返回非零错误代码。确保适当处理错误。

示例错误处理

int? result = await NyxPrinter().printText("Sample Text");
if (result != 0) {
  print("Failed to print text, error code: $result");
} else {
  print("Text printed successfully");
}

贡献

欢迎你 Fork 仓库、提交问题或拉取请求。贡献是受欢迎的！

许可证

此包是开源的，并且根据 MIT 许可证可用。

示例代码

以下是完整的示例代码，展示了如何在应用中使用 NyxPrinter。

import 'package:example/extension.dart';
import 'package:flutter/material.dart';
import 'package:nyx_printer/nyx_printer.dart';

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

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

  [@override](/user/override)
  Widget build(BuildContext context) {
    return const MaterialApp(
      title: 'NyxPrinter Demo',
      home: MyHomePage(),
    );
  }
}

class MyHomePage extends StatefulWidget {
  const MyHomePage({super.key});

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

class _MyHomePageState extends State<MyHomePage> {
  final NyxPrinter nyxPrinter = NyxPrinter();

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        backgroundColor: Theme.of(context).colorScheme.inversePrimary,
        title: const Text("Nyx Printer Sample"),
      ),
      body: Column(
        mainAxisAlignment: MainAxisAlignment.center,
        children: [
          const Text('Sample Text').onTap(
            () => nyxPrinter.printText("Sample Text"),
          ),
          const SizedBox(height: 12),
          const Text('Sample Text with Styling').onTap(
            () => nyxPrinter.printText(
              "Sample Text",
              textFormat: NyxTextFormat(
                align: NyxAlign.center,
                style: NyxFontStyle.bold,
                textSize: 18,
                underline: true,
              ),
            ),
          ),
          const SizedBox(height: 12),
          const Text('Print QR Code').onTap(
            () {
              nyxPrinter.printQrCode('Sample QR Code');
            },
          ),
          const SizedBox(height: 12),
          const Text('Print BarCode').onTap(
            () {
              nyxPrinter.printBarcode('Sample Print Code');
            },
          ),
        ],
      ),
    );
  }
}