ESC/POS command-line tools

This repository provides command-line utilities for extracting information from binary ESC/POS data. ESC/POS is a page description language that is commonly used for receipt printing.

Currently we have a prototype ESC/POS parser, which can extract the commands contained in printable ESC/POS binary data, and render them to various formats.

Quick start

This project is requires:

• PHP 5.6 or better
• The mbstring and imagick extensions
• composer

To install from source:

git clone https://github.com/receipt-print-hq/escpos-tools
cd escpos-tools
composer install

Included utilities

esc2text

esc2text extracts text and line breaks from binary ESC/POS files.

• esc2text documentation

esc2html

esc2html converts binary ESC/POS files to HTML.

• esc2html documentation

escimages

escimages extracts graphics from binary ESC/POS files in PBM and PNG format.

• escimages documentation

Run with Docker

docker build . -t escpos-tools
docker run -v $PWD:/data escpos-tools /bin/bash -c "php esc2html.php /data/receipt-with-logo.bin > /data/output.html"

Contribute

• CONTRIBUTING.md

Licensing

• LICENSE.md