This plugin provides thermal printer functionality for Tauri applications, allowing you to print documents, test printers, and list available printers.

For mobile applications, this plugin is currently working on this...

• How it Works
• Installation
  • Rust
  • Bun / NPM / PNPM
  • lib.rs
  • Permission
• Functions
  • List Printers
  • Test Printer
  • Print Document
• Section Types
  • Title
  • Subtitle
  • Text
  • Feed
  • Cut
  • Beep
  • Drawer
  • Qr
  • Barcode
  • Table
  • DataMatrix
  • Pdf417
  • Image
  • Logo
  • Line
  • GlobalStyles
• Examples

This plugin acts as a translator between a user-friendly JavaScript/TypeScript API and the low-level ESC/POS binary commands that thermal printers understand.

• PrintJobRequest: Main structure defining a print job
• PrintSections: Enum with all printable content types (Title, Text, Table, QR, etc.)
• GlobalStyles: Formatting styles (bold, alignment, size, etc.)

Three main functions exposed to the frontend:

• list_thermal_printers(): Lists available printers
• print_thermal_printer(): Prints a document
• test_thermal_printer(): Runs functionality tests

Converts data structures into ESC/POS binary commands:

• Linux/macOS: Uses CUPS system (lpstat, lp commands)
• Windows: Uses WinAPI (Windows API) to directly access system printers via functions such as EnumPrintersW for listing printers, OpenPrinterW for opening printer handles, and WritePrinter for sending raw data
• Android: Basic structure present, not yet implemented

1. Frontend sends PrintJobRequest with sections and configuration
2. Tauri receives the command and processes it in Rust
3. ProcessPrint converts each section into ESC/POS commands
4. Operating System sends binary data to the printer
5. Thermal Printer interprets ESC/POS commands and prints

The plugin translates all sections into ESC/POS (Escape Sequence for Point of Sale) commands, the de facto standard for thermal printers:

• \x1B\x40 - Initialize printer
• \x1B\x61\x01 - Center text
• \x1B\x45\x01 - Enable bold
• etc.

• Text: Title, Subtitle, Text with optional styles
• Codes: QR, Barcode, DataMatrix, PDF417
• Media: Images, Logos
• Control: Feed, Cut, Beep, Cash Drawer
• Tables: Configurable columns
• Lines: Horizontal separators

• Linux: Fully functional (CUPS)
• macOS: Fully functional (CUPS)
• Windows: Fully functional (WinAPI)
• Android: Basic structure present, not implemented
• iOS: Not implemented

• USB: Direct USB port connection
• Network: TCP/IP (port 9100 typical)
• Serial: RS-232 (less common)
• Bluetooth: For Android (when implemented)

This library not only contains the connector to the backend. Also adds the types for the print structure...

Don't forget to add this line

Modify the file in /file/to/project/capabilities/default.json, and add:

on src-tauri project file

on package.json

Get all printers available in the system. It just lists the configured printers...

• name (string): Name of the printer
• interface_type (string): Interface type (e.g., "USB", "NETWORK")
• identifier (string): Unique identifier (e.g., USB path or IP:PORT)
• status (string): Current status (e.g., "IDLE", "BUSY")

Send a print test to a specific printer to verify functionality.

Returns boolean:

• true: Test completed successfully
• false: Test failed

Print a personalized document with the specified sections.

Returns boolean:

• true: Print completed successfully
• false: Print failed

Sections are defined as objects in the sections array. Each section is an enum variant with its data. Below are all supported section types:

Prints a title with forced double size and center alignment.

Or simply:

• text (string, required): Title text
• styles (GlobalStyles, optional): Applied styles

Prints a subtitle with forced bold and increased height.

Or simply:

• text (string, required): Subtitle text
• styles (GlobalStyles, optional): Applied styles

Prints simple text with optional styles.

Or

Or simple version

You can pick the style that you need, it's not necessary to declared all of them.

• text (string, required): Text to print
• styles (GlobalStyles, optional): Applied styles (defaults to current global styles)

Advances the paper by a specific number of lines.

• feed_type (string, required): Feed type ("lines")
• value (number, required): Number of lines to advance

Cuts the paper.

• mode (string, required): Cut mode ("full", "partial")
• feed (number, required): Lines to advance before cutting

Emits a beep.

• times (number, required): Number of beeps
• duration (number, required): Duration in milliseconds

Opens the cash drawer.

• pin (number, required): Drawer pin (2 or 5)
• pulse_time (number, required): Pulse time in milliseconds

Prints a QR code.

• data (string, required): QR data
• size (number, required): Module size (1-16)
• error_correction (string, required): Error correction level ("L", "M", "Q", "H")
• model (number, required): QR model (1 or 2)
• align (string, optional): Alignment ("left", "center", "right")

Prints a barcode.

• data (string, required): Barcode data
• barcode_type (string, required): Type ("UPC-A", "UPC-E", "EAN13", "EAN8", "CODE39", "ITF", "CODABAR", "CODE93", "CODE128")
• width (number, required): Module width
• height (number, required): Height in dots
• text_position (string, required): Text position ("not_printed", "above", "below", "both")

Prints a table.

Or simply:

• columns (number, required): Number of columns
• column_widths (array, optional): Widths of each column. If not provided, columns will be evenly distributed across the paper width
• header (array, optional): Column headers (array of Text objects)
• body (array, required): Data rows (array of arrays of Text objects)
• truncate (boolean, optional): Truncate long text (default: false)

Prints a DataMatrix code.

• data (string, required): DataMatrix data
• size (number, required): Module size (1-16)

Prints a PDF417 code.

• data (string, required): PDF417 data
• columns (number, required): Number of data columns
• rows (number, required): Number of data rows
• width (number, required): Module width
• height (number, required): Module height
• error_correction (number, required): Error correction level (0-8)

Prints an image.

• data (string, required): Base64 encoded image
• max_width (number, required): Maximum width in pixels
• align (string, required): Alignment ("left", "center", "right")
• dithering (boolean, required): Apply dithering
• size (string, required): Size ("normal", "double_width", "double_height", "quadruple")

Prints a logo stored in the printer.

• key_code (number, required): Logo key code (1-255)
• mode (string, required): Print mode ("normal", "double_width", "double_height", "quadruple")

Prints a separator line.

• character (string, required): Character for the line (e.g., "=", "-", "_")

Changes the current global styles that will be applied to subsequent text sections. This allows you to set default styles without specifying them for each text element.

• bold (boolean, optional): Bold text (default: false)
• underline (boolean, optional): Underlined text (default: false)
• align (string, optional): Alignment ("left", "center", "right") (default: "left")
• italic (boolean, optional): Italic text (default: false)
• invert (boolean, optional): Inverted text (black background) (default: false)
• font (string, optional): Font ("A", "B", "C") (default: "A")
• rotate (boolean, optional): Text rotated 90 degrees (default: false)
• upside_down (boolean, optional): Upside down text (default: false)
• size (string, optional): Size ("normal", "height", "width", "double") (default: "normal")

This section contains practical examples for different use cases. Each example demonstrates how to structure print jobs for various business scenarios.

NOTE: Paper is automatically cut at the end of printing with a full cut. You don't need to add a Cut section manually unless you want a specific partial cut.

const restaurantTicket: PrintJobRequest = {
 "printer": "TM-T20II",
 "paper_size": "Mm80",
 "options": {
 "cut_paper": true,
 "beep": false,
 "open_cash_drawer": false
 },
 "sections": [
 {"Title": {"text": "RESTAURANTE EL BUEN SABOR", "styles": {"bold": true, "underline": false, "align": "center", "italic": false, "invert": false, "font": "A", "rotate": false, "upside_down": false, "size": "Double"}}},
 {"Text": {"text": "Comida Mexicana", "styles": {"bold": false, "underline": false, "align": "center", "italic": false, "invert": false, "font": "A", "rotate": false, "upside_down": false, "size": "normal"}}},
 {"Text": {"text": "Tel: (555) 987-6543", "styles": {"bold": false, "underline": false, "align": "center", "italic": false, "invert": false, "font": "A", "rotate": false, "upside_down": false, "size": "normal"}}},
 {"Line": {"character": "="}},
 {"Text": {"text": "ORDEN #145", "styles": {"bold": true, "underline": false, "align": "left", "italic": false, "invert": false, "font": "A", "rotate": false, "upside_down": false, "size": "normal"}}},
 {"Text": {"text": "Mesa: 12", "styles": {"bold": false, "underline": false, "align": "left", "italic": false, "invert": false, "font": "A", "rotate": false, "upside_down": false, "size": "normal"}}},
 {"Text": {"text": "Mesero: Carlos Ruiz", "styles": {"bold": false, "underline": false, "align": "left", "italic": false, "invert": false, "font": "A", "rotate": false, "upside_down": false, "size": "normal"}}},
 {"Text": {"text": "Fecha: 14/10/2025 14:30", "styles": {"bold": false, "underline": false, "align": "left", "italic": false, "invert": false, "font": "A", "rotate": false, "upside_down": false, "size": "normal"}}},
 {"Line": {"character": "="}},
 {"Table": {
 "columns": 3,
 "column_widths": [5, 28, 15],
 "header": [
 {"text": "CANT", "styles": {"bold": true, "underline": false, "align": "left", "italic": false, "invert": false, "font": "A", "rotate": false, "upside_down": false, "size": "normal"}},
 {"text": "PLATILLO", "styles": {"bold": true, "underline": false, "align": "left", "italic": false, "invert": false, "font": "A", "rotate": false, "upside_down": false, "size": "normal"}},
 {"text": "PRECIO", "styles": {"bold": true, "underline": false, "align": "right", "italic": false, "invert": false, "font": "A", "rotate": false, "upside_down": false, "size": "normal"}}
 ],
 "body": [
 [
 {"text": "2", "styles": null},
 {"text": "Tacos al Pastor", "styles": null},
 {"text": "$45.00", "styles": {"bold": false, "underline": false, "align": "right", "italic": false, "invert": false, "font": "A", "rotate": false, "upside_down": false, "size": "normal"}}
 ],
 [
 {"text": "1", "styles": null},
 {"text": "Enchiladas Verdes", "styles": null},
 {"text": "$85.00", "styles": {"bold": false, "underline": false, "align": "right", "italic": false, "invert": false, "font": "A", "rotate": false, "upside_down": false, "size": "normal"}}
 ],
 [
 {"text": "1", "styles": null},
 {"text": "Pozole Grande", "styles": null},
 {"text": "$95.00", "styles": {"bold": false, "underline": false,