ESC/POS Thermal Printer

About

Automatic summary of the README and code of cognitivegears/ha-escpos-thermal-printer. Something wrong, or are you the maintainer and want your own text here? Get in touch

Supports

• Works locally Talks to your devices on your own network. No vendor cloud in between.

• Found by itself Home Assistant spots it on the network and offers to add it.

• From the Marketplace Installed through the Marketplace, formerly HACS.

• Actively maintained Its author released or pushed a change in the last six months.

Provides

• Sensors

Setting it up

Install it from the Marketplace and restart Home Assistant, then add it under Settings, Devices and services.

Texts from the code of cognitivegears/ha-escpos-thermal-printer.

Entities

• Binary sensorsOnline, Cover open
• ButtonsFeed paper, Cut paper, Beep, Sample test print
• SensorsLast image print, Last print, Battery, Paper status

Actions

• BeepTrigger the printer buzzer (if supported). Select a target — printer device, entity, area, floor, or label. If no target is selected, prints to every configured printer (deprecated fallback).Fields: Broadcast, Duration, Times
• Print dither test sheetPrint a calibration sheet — a pixel ruler plus a threshold sweep strip — for tuning image dither/threshold settings (not the printer calibration wizard — see the Calibration docs page). Burns ~10 cm of paper. If no target is selected, prints to every configured printer (deprecated fallback).Fields: Broadcast, Cut, Feed Lines
• Cut PaperCut the paper. Select a target — printer device, entity, area, floor, or label. If no target is selected, prints to every configured printer (deprecated fallback).Fields: Broadcast, Feed Before Cut, Mode
• Feed PaperFeed the paper a number of lines. Select a target — printer device, entity, area, floor, or label. If no target is selected, prints to every configured printer (deprecated fallback).Fields: Broadcast, Lines
• Preview Box (no paper)Run the print_box layout pipeline and write the rendered text to a .txt file WITHOUT printing it. Lets you iterate on borders, padding, and width without burning paper. The cut/feed fields are deliberately omitted — a text file has no paper. Returns path, width, line_count, and codepage as service response data — enable "Return response data" in Developer Tools to see the values.Fields: Alignment, Device, Output Path, Padding, Border Style, Text, Total Width
• Preview Image (no paper)Run the full image pipeline (dither, resize, etc) and write the 1-bit PNG to disk WITHOUT printing it. Returns the output path so automations can chain a notification. Printer-communication options (high density, impl, fragment height, chunk delay, center, cut, feed) are not exposed here because they have no effect on the file written to disk — they only matter when streaming to a real printer.Fields: Alignment, Auto-Resize Large Sources, Autocontrast, Device, Dither Mode, Fallback Image, Image, Width (pixels), Invert Colors, Mirror Horizontally
• Preview Table (no paper)Run the print_table layout pipeline and write the rendered text to a .txt file WITHOUT printing it. Lets you iterate on column widths, alignment, and borders without burning paper. The cut/feed fields are deliberately omitted — a text file has no paper. Returns path, width, line_count, and codepage as service response data — enable "Return response data" in Developer Tools to see the values.Fields: Column Alignments, Column Widths, Device, Header Row, Output Path, Row Separators, Rows, Border Style, Total Width
• Print BarcodePrint a barcode. Select a target — printer device, entity, area, floor, or label. If no target is selected, prints to every configured printer (deprecated fallback).Fields: Alignment, Barcode Type, Broadcast, Checksum, Code, Cut, Feed Lines, Font, Rendering Mode, Height
• Print BoxPrint text wrapped in a printable border (single/double/ASCII glyphs). If no target is selected, prints to every configured printer (deprecated fallback).Fields: Alignment, Broadcast, Cut, Feed Lines, Padding, Border Style, Text, Total Width
• Print Camera SnapshotPrint a live snapshot from a camera entity. Convenience wrapper around print_image with a camera-entity selector for a friendlier UI. If no target is selected, prints to every configured printer (deprecated fallback).Fields: Alignment, Auto-Resize Large Sources, Autocontrast, Broadcast, Camera, Chunk Delay (ms), Cut, Dither Mode, Fallback Image, Feed Lines
• Print Image (mixed source)Print an image from a URL, file path, camera.[id], image.[id], or base64 data URI. Automations can still use a Jinja template for this field — HA renders it before the service call is dispatched — but the field itself is a plain string, not evaluated server-side. For a friendlier UI, prefer the focused services (Print Image from URL, from Path, Camera Snapshot, Image Entity) — see docs/images.md. If no target is selected, prints to every configured printer (deprecated fallback).Fields: Alignment, Auto-Resize Large Sources, Autocontrast, Broadcast, Chunk Delay (ms), Cut, Dither Mode, Fallback Image, Feed Lines, Fragment Height
• Print Image EntityPrint the current frame from an HA image entity (weather radar, ML overlay, generated chart, etc). If no target is selected, prints to every configured printer (deprecated fallback).Fields: Alignment, Auto-Resize Large Sources, Autocontrast, Broadcast, Chunk Delay (ms), Cut, Dither Mode, Fallback Image, Feed Lines, Fragment Height
• Print Image from PathPrint an image from a local file path. The path must lie inside one of Home Assistant's allowlist_external_dirs (typically /config or /media — add directories under homeassistant -> allowlist_external_dirs in configuration.yaml if needed). If no target is selected, prints to every configured printer (deprecated fallback).Fields: Alignment, Auto-Resize Large Sources, Autocontrast, Broadcast, Chunk Delay (ms), Cut, Dither Mode, Fallback Image, Feed Lines, Fragment Height
• Print Image from URLPrint an image fetched from an HTTP(S) URL. SSRF-aware — private, loopback, and link-local addresses are refused. If no target is selected, prints to every configured printer (deprecated fallback).Fields: Alignment, Auto-Resize Large Sources, Autocontrast, Broadcast, Chunk Delay (ms), Cut, Dither Mode, Fallback Image, Feed Lines, Fragment Height
• Print Key/Value TablePrint a two-column label/value table — receipt totals, sensor readings, ingredient lists. Labels left-aligned, values per "value_align" (default right). If no target is selected, prints to every configured printer (deprecated fallback).Fields: Broadcast, Cut, Feed Lines, Items, Label Width, Border Style, Total Width, Value Alignment
• Print Formatted MessagePrint a message with full text formatting (bold, underline, size, alignment) plus an optional image attachment that prints as a single uninterrupted receipt. Targets an ESC/POS notify entity. See docs/images.md.Fields: Alignment, Bold, Cut, Density, Encoding, Feed Lines, Font, Height, Image, Image Alignment
• Print QR CodePrint a QR code. Select a target — printer device, entity, area, floor, or label. If no target is selected, prints to every configured printer (deprecated fallback).Fields: Alignment, Broadcast, Cut, Data, Error Correction, Feed Lines, Size
• Print SeparatorPrint a single decorative rule built by repeating one character to fill the printer's line width. Examples — "-" for a single rule, "=" for a heavy rule, "*" or "_" for decorative bars. If no target is selected, prints to every configured printer (deprecated fallback).Fields: Broadcast, Character, Cut, Feed Lines, Repeat, Width
• Print TablePrint a multi-column table (receipt-style) with optional borders and header. If no target is selected, prints to every configured printer (deprecated fallback).Fields: Broadcast, Column Alignments, Column Widths, Cut, Feed Lines, Header Row, Row Separators, Rows, Border Style, Total Width
• Print Text (Raw Encoding)Print text to the ESC/POS printer using raw encoding. Select a target — printer device, entity, area, floor, or label. If no target is selected, prints to every configured printer (deprecated fallback).Fields: Alignment, Bold, Broadcast, Cut, Density, Encoding, Feed Lines, Font, Height, Invert

Troubleshooting

• DiagnosticsDownloads a diagnostics file to attach to a bug report.

From the README