escpos - v1.1.0

escpos

A low-level imperative API for building ESC/POS printer commands.

This module provides a builder-style interface where each function takes a CommandBuffer and returns a modified buffer. For a declarative alternative, see escpos/document.

Example

import escpos.{Center, Left}
import escpos/printer

escpos.new()
|> escpos.reset()
|> escpos.align(Center)
|> escpos.bold(True)
|> escpos.writeln("Receipt")
|> escpos.bold(False)
|> escpos.align(Left)
|> escpos.writeln("Item 1 ... $5.00")
|> escpos.cut()
|> printer.print(my_printer)

Types

Font

</>

Printer font. Re-exported from escpos/protocol.

pub type Font =
  protocol.Font

Justify

</>

Text justification. Re-exported from escpos/protocol.

pub type Justify =
  protocol.Justify

Values

align

</> 
pub fn align(
  cb: printer.CommandBuffer,
  justify: protocol.Justify,
) -> printer.CommandBuffer

Sets text alignment (Left, Center, or Right).

bold

</> 
pub fn bold(
  cb: printer.CommandBuffer,
  b: Bool,
) -> printer.CommandBuffer

Enables or disables bold text.

cut

</> 
pub fn cut(cb: printer.CommandBuffer) -> printer.CommandBuffer

Performs a full paper cut.

double_strike

</> 
pub fn double_strike(
  cb: printer.CommandBuffer,
  b: Bool,
) -> printer.CommandBuffer

Enables or disables double-strike text.

flip

</> 
pub fn flip(
  cb: printer.CommandBuffer,
  b: Bool,
) -> printer.CommandBuffer

Enables or disables 180-degree rotation.

font

</> 
pub fn font(
  cb: printer.CommandBuffer,
  font: protocol.Font,
) -> printer.CommandBuffer

Sets the printer font.

image

</> 
pub fn image(
  cb: printer.CommandBuffer,
  image: image.PrintableImage,
) -> printer.CommandBuffer

Prints a monochrome image prepared by the image module.

Example

let assert Ok(pgm) = simplifile.read_bits(from: "./lucy.pgm")
let assert Ok(img) = image.from_pgm(raw_pgm)
let img = image.dither_bayer4x4(img, 0)

escpos.new()
|> escpos.image(img)
|> printer.print(printer)

image_raster

</> 
pub fn image_raster(
  cb: printer.CommandBuffer,
  image: image.PrintableImage,
) -> printer.CommandBuffer

Prints a monochrome image prepared by the image module. This is using an older method to print images, useful for some printers that do not understand graphic buffer commands.

Example

let assert Ok(pgm) = simplifile.read_bits(from: "./lucy.pgm")
let assert Ok(img) = image.from_pgm(raw_pgm)
let img = image.dither_bayer4x4(img, 0)

escpos.new()
|> escpos.image_raster(img)
|> printer.print(printer)

line_feed

</> 
pub fn line_feed(
  cb: printer.CommandBuffer,
  lines: Int,
) -> printer.CommandBuffer

Feeds the specified number of lines.

new

</> 
pub fn new() -> printer.CommandBuffer

Creates a new empty command buffer.

new_line

</> 
pub fn new_line(
  cb: printer.CommandBuffer,
) -> printer.CommandBuffer

Appends a single newline.

partial_cut

</> 
pub fn partial_cut(
  cb: printer.CommandBuffer,
) -> printer.CommandBuffer

Performs a partial paper cut, leaving a small portion connected.

raw

</> 
pub fn raw(
  cb: printer.CommandBuffer,
  data: BitArray,
) -> printer.CommandBuffer

Appends raw bytes to the buffer.

reset

</> 
pub fn reset(cb: printer.CommandBuffer) -> printer.CommandBuffer

Resets the printer to its initial state.

reset_font

</> 
pub fn reset_font(
  cb: printer.CommandBuffer,
) -> printer.CommandBuffer

Resets the font to the default (FontA).

reset_text_size

</> 
pub fn reset_text_size(
  cb: printer.CommandBuffer,
) -> printer.CommandBuffer

Resets text size to normal (1x1).

reverse

</> 
pub fn reverse(
  cb: printer.CommandBuffer,
  b: Bool,
) -> printer.CommandBuffer

Enables or disables reverse (white on black) text.

smooth

</> 
pub fn smooth(
  cb: printer.CommandBuffer,
  b: Bool,
) -> printer.CommandBuffer

Enables or disables character smoothing.

text_size

</> 
pub fn text_size(
  cb: printer.CommandBuffer,
  width: Int,
  height: Int,
) -> printer.CommandBuffer

Sets text size multiplier (1-8 for width and height).

underline

</> 
pub fn underline(
  cb: printer.CommandBuffer,
  b: Bool,
) -> printer.CommandBuffer

Enables or disables underlined text.

upside_down

</> 
pub fn upside_down(
  cb: printer.CommandBuffer,
  b: Bool,
) -> printer.CommandBuffer

Enables or disables upside-down text.

write

</> 
pub fn write(
  cb: printer.CommandBuffer,
  text: String,
) -> printer.CommandBuffer

Writes text to the buffer.

writeln

</> 
pub fn writeln(
  cb: printer.CommandBuffer,
  text: String,
) -> printer.CommandBuffer

Writes text to the buffer followed by a newline.

✨ Search Document