Crate escpos 

escpos - A ESCPOS implementation in Rust

This crate implements a subset of Epson’s ESC/POS protocol for thermal receipt printers. It allows you to generate and print documents with basic text formatting, cutting, barcodes, QR codes and raster images on a compatible printer.

Examples

The examples folder contains various examples of how to use escpos. The docs (will) also provide lots of code snippets and examples. The list of all the examples can be found here.

Simple text formatting

use escpos::printer::Printer;
use escpos::printer_options::PrinterOptions;
use escpos::utils::*;
use escpos::{driver::*, errors::Result};

fn main() -> Result<()> {
    // env_logger::init();

    // let driver = NetworkDriver::open("192.168.1.248", 9100, None)?;
    let driver = ConsoleDriver::open(true);
    Printer::new(driver, Protocol::default(), Some(PrinterOptions::default()))
        .debug_mode(Some(DebugMode::Dec))
        .init()?
        .smoothing(true)?
        .bold(true)?
        .underline(UnderlineMode::Single)?
        .writeln("Bold underline")?
        .justify(JustifyMode::CENTER)?
        .reverse(true)?
        .bold(false)?
        .writeln("Hello world - Reverse")?
        .feed()?
        .justify(JustifyMode::RIGHT)?
        .reverse(false)?
        .underline(UnderlineMode::None)?
        .size(2, 3)?
        .writeln("Hello world - Normal")?
        .print_cut()?;  // print() or print_cut() is mandatory to send the data to the printer

    Ok(())
}

EAN13 (with barcode feature enabled)

use escpos::printer::Printer;
use escpos::utils::*;
use escpos::{driver::*, errors::Result};

fn main() -> Result<()> {
    // env_logger::init();

    // let driver = NetworkDriver::open("192.168.1.248", 9100, None)?;
    let driver = ConsoleDriver::open(true);
    Printer::new(driver, Protocol::default(), None)
        .debug_mode(Some(DebugMode::Hex))
        .init()?
        .ean13_option(
            "1234567890265",
            BarcodeOption::new(
                BarcodeWidth::M,
                BarcodeHeight::S,
                BarcodeFont::A,
                BarcodePosition::Below,
            )
        )?
        .feed()?
        .print()?;  // print() or print_cut() is mandatory to send the data to the printer

    Ok(())
}

QR Code (with codes_2d feature enabled)

use escpos::printer::Printer;
use escpos::utils::*;
use escpos::{driver::*, errors::Result};

fn main() -> Result<()> {
    // env_logger::init();

    // let driver = NetworkDriver::open("192.168.1.248", 9100, None)?;
    let driver = ConsoleDriver::open(true);
    Printer::new(driver, Protocol::default(), None)
        .debug_mode(Some(DebugMode::Hex))
        .init()?
        .qrcode_option(
            "https://www.google.com",
            QRCodeOption::new(QRCodeModel::Model1, 6, QRCodeCorrectionLevel::M),
        )?
        .feed()?
        .print_cut()?;  // print() or print_cut() is mandatory to send the data to the printer

    Ok(())
}

Bit image (with graphics feature enabled)

use escpos::printer::Printer;
use escpos::utils::*;
use escpos::{driver::*, errors::Result};

fn main() -> Result<()> {
    // env_logger::init();

    // let driver = NetworkDriver::open("192.168.1.248", 9100, None)?;
    let driver = ConsoleDriver::open(true);
    let mut printer = Printer::new(driver, Protocol::default(), None);
    printer.debug_mode(Some(DebugMode::Hex))
        .init()?
        .bit_image_option(
            "./resources/images/rust-logo-small.png",
            BitImageOption::new(Some(128), None, BitImageSize::Normal)?,
        )?
        .feed()?
        .print_cut()?;  // print() or print_cut() is mandatory to send the data to the printer

    Ok(())
}

Check printer status

use escpos::printer::Printer;
use escpos::utils::*;
use escpos::{driver::*, errors::Result};

fn main() -> Result<()> {
    // env_logger::init();

    // let driver = NetworkDriver::open("192.168.1.248", 9100, None)?;
    let driver = ConsoleDriver::open(true);
    Printer::new(driver.clone(), Protocol::default(), None)
        .debug_mode(Some(DebugMode::Dec))
        .real_time_status(RealTimeStatusRequest::Printer)?
        .real_time_status(RealTimeStatusRequest::RollPaperSensor)?
        .send_status()?;

    let mut buf = [0; 1];
    driver.read(&mut buf)?;

    let status = RealTimeStatusResponse::parse(RealTimeStatusRequest::Printer, buf[0])?;
    println!(
        "Printer online: {}",
        status.get(&RealTimeStatusResponse::Online).unwrap_or(&false)
    );

    Ok(())
}

Features list

Name	Description	Default
std	Enable std support (disable for no_std + alloc environments)	✅
barcodes	Print barcodes (UPC-A, UPC-E, EAN8, EAN13, CODE39, ITF or CODABAR)	✅
codes_2d	Print 2D codes (QR Code, PDF417, GS1 DataBar, DataMatrix, Aztec, etc.)	✅
graphics	Print raster images (requires std)	❌
usb	Enable USB feature (requires std)	❌
native_usb	Enable native USB feature (requires std)	❌
hidapi	Enable HidApi feature (requires std)	❌
serial_port	Enable Serial port feature (requires std)	❌
usbprint	Enable Windows USB print driver (usbprint.sys via Win32 API)	❌
ui	Enable ui feature (UI components)	❌
full	Enable all features	❌

no_std support

The crate can be used on bare-metal targets (microcontrollers, kernels…) by disabling default features. Only alloc is required:

escpos = { version = "0.18", default-features = false, features = ["barcodes", "codes_2d"] }

The built-in Console, Network and File drivers as well as the graphics feature require std. In no_std mode you implement the Driver trait for your peripheral (UART, SPI, USB endpoint, …) and pass it to Printer::new. Printer::driver lets you recover the driver from a Printer (useful to read back status responses).

All protocol-level APIs (barcodes, QR Code, PDF417, DataMatrix, Aztec, MaxiCode, page codes, status…) work in no_std because the actual code rendering is done by the printer’s firmware — this crate only serializes the ESC/POS command bytes.

See examples/no_std_codes.rs for a minimal end-to-end example with a custom in-memory driver.

External resources

• Epson documentation

Modules

driver

Drivers used to send data to the printer (Network or USB) Drivers used to send data to the printer (Network or USB)

errors

Error module Custom error

printer

Print document Printer

printer_options

Printer options Printer options

uiui

UI components like lines, tables, etc.

utils

Utils module contains protocol and all needed constants and enums