搜尋套件、儲存庫與 APP 分類

套件詳情v2.3.0

flutter_thermal_printer

用於透過 ESC/POS 命令在熱敏列印機上列印的 Flutter 插件。

AndroidiOSmacOSWindows
近 30 天下載
9900
喜歡數
143
Pub 分數
140

安裝套件

flutter pub add flutter_thermal_printer

套件介紹

根據套件公開資料產生的選型評估,僅供參考。

一個 Flutter 插件,使用 ESC/POS 指令實現熱敏列印機列印。支援 Android、iOS、macOS 與 Windows,讓開發者能直接將格式化文字、條碼與影像傳送至相容的熱敏列印機。該套件提供簡單的 API 來發出 ESC/POS 指令,非常適合零售、餐飲及銷售點應用中的收據列印。可無縫整合至 Flutter 應用,並透過平台通道利用原生平台功能。

適用情境

  • POS系統中的收據列印
  • 庫存標籤列印
  • 事件票務產生
  • 訂單確認列印
  • 基於移動設備的自助列印

主要特色

  • 支援 ESC/POS 指令集
  • 跨平台相容性
  • 文字、條碼和圖像列印
  • ESC/POS 命令的簡單 API
  • 透過平台通道的原生整合

適合對象

  • 零售和餐飲POS應用
  • 移動列印解決方案
  • 庫存管理工具
  • 活動和票務應用
  • 自助服務終端和自助服務應用

使用建議

  • 需要相容的熱敏列印機
  • ESC/POS 指令知識,用於進階格式化
  • 僅限支援藍牙或USB列印的裝置
  • 可能需要特定於平台的設定
  • 印表機驅動程式可用性因作業系統而異

原始 README

以下為關聯原始碼儲存庫的 README 原文快照,最新內容請造訪原始碼儲存庫。

flutter_thermal_printer

Buy Me A Coffee

If you find this project helpful and want to support its development, you can buy me a coffee:

Buy Me A Coffee

Getting Started

This plugin is used to print data on thermal printers with ease across multiple platforms.

🎉 New Feature: USB Printing Services

✨ Exciting Update! We now support USB printing services across multiple platforms! Connect your thermal printers directly via USB for faster, more reliable printing without the need for wireless connections.

Supported Platforms for USB:

  • 🤖 Android - Full USB support
  • 🖥️ Windows - Complete USB integration
  • 🍎 macOS - Native USB connectivity

Experience enhanced printing performance with direct USB connections!

Currently Supported

Service Android iOS macOS Windows
Bluetooth ✅ ✅ ✅ ✅
USB ✅ ✅ ✅
BLE ✅ ✅ ✅ ✅
WiFi ✅ ✅ ✅ ✅
final _flutterThermalPrinterPlugin = FlutterThermalPrinter.instance;

// Enum ConnectionType
enum ConnectionType {
  BLE,
  USB,
  NETWORK,
}

// Additional Functions
// Recommended Function for getting printers
getPrinters(
  refreshDuration: Duration,
  connectionTypes: List<ConnectionType>,
) {
  // Supports WINDOWS, ANDROID , Macos for USB
  // MAC, IOS, ANDROID, WINDOWS for BLUETOOTH.
}

// Refer to Example for Complete code 

macOS printer connection types

Installed macOS print queues are classified using their native device URI: usb:// is USB; dnssd://, ipp://, ipps://, http://, https://, socket://, lpd://, and smb:// are NETWORK. Unknown or missing schemes have a null connectionType and display as UNKNOWN.

await FlutterThermalPrinter.instance.getPrinters(
  connectionTypes: [ConnectionType.USB, ConnectionType.BLE, ConnectionType.NETWORK],
);

The default scan includes all three types. An explicit USB-only scan excludes network queues; a NETWORK-only scan returns installed network queues on macOS. Unknown system queues appear when both USB and NETWORK are requested. This does not discover uninstalled LAN printers or identify thermal/ESC/POS compatibility.

Printer.deviceUri preserves the destination URI and Printer.queueName holds the macOS queue ID. System queues continue printing through the native macOS backend, including printWidget; a Bonjour/IPPS URI is not passed to the raw TCP network printer API. The queue's isConnected value still indicates that it is installed, not that the physical printer is reachable. Other platforms retain their existing discovery mechanisms.

Bluetooth Services

Feature Android iOS macOS Windows
Start scanning ✅ ✅ ✅ ✅
Stop scanning ✅ ✅ ✅ ✅
Connect printer ✅ ✅ ✅ ✅
Disconnect printer ✅ ✅ ✅ ✅
Print data ✅ ✅ ✅ ✅
Print widget ✅ ✅ ✅ ✅

USB Services

Feature Android iOS macOS Windows
Start scanning ✅ ✅ ✅
Stop scanning ✅ ✅ ✅
Connect printer ✅ ✅ ✅
Print data ✅ ✅ ✅
Print widget ✅ ✅ ✅

WiFi Services

Feature Android iOS macOS Windows
Connect printer ✅ ✅ ✅ ✅
Disconnect printer ✅ ✅ ✅ ✅
Print data ✅ ✅ ✅ ✅
Print widget ✅ ✅ ✅ ✅

Printer Model Class

String? address;
String? name;
ConnectionType? connectionType;
bool? isConnected;
String? vendorId;
String? productId;

Additional Features

Screenshot to Printer

Easily capture and print widgets as images using the printWidget method.

Image Cropping for Long Prints

Handles long data by cropping images and printing them in chunks to ensure seamless printing on devices with limited buffer capacity.

Connection Type Validation
  • Ensures ConnectionType compatibility and alerts when unsupported combinations are used.
BLE State Monitoring

Provides real-time monitoring for Bluetooth states, ensuring proactive error handling and reconnections.

BLE Connection Configuration

Customize BLE connection behavior to optimize for different printer models:

// Global configuration (applies to all BLE connections)
FlutterThermalPrinter.instance.bleConfig =
    BleConfig(connectionStabilizationDelay: Duration(seconds: 3));

// Per-connection override for specific devices
await FlutterThermalPrinter.instance.connect(
  printer,
  connectionStabilizationDelay: Duration(seconds: 2),
);

// Default behavior (10 seconds) - no configuration needed
await FlutterThermalPrinter.instance.connect(printer);
Configuration Use Case
Global config Set once for consistent behavior across all connections
Per-call override Fine-tune for specific printer models that connect faster/slower
Default (10s) Backwards compatible, works with most printers

Notes and Recommendations

  • Windows & MacOS Users: Make sure you have the XPrinter driver installed on Windows for printer compatibility.
    Download the driver from XPrinter Driver.

  • Cross-Platform Usage: Ensure Bluetooth permissions and configurations are set correctly for Android and iOS.


Contributing Guidelines

We welcome contributions to enhance the plugin's functionality!
To contribute, please fork the repository, make changes, and submit a pull request.
For bug reports or feature requests, feel free to open an issue.


Contributors

Contributors

Feel free to contribute to this project and help make it better for everyone!


所屬分類

依賴

依賴清單 7 項

原始碼儲存庫

使用此套件的專案

暫無相關資料。