Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/receipt-print-hq/escpos-tools

Utilities to read ESC/POS print data
https://github.com/receipt-print-hq/escpos-tools

escpos format-converter hacktoberfest pos printing receipt

Last synced: 3 months ago
JSON representation

Utilities to read ESC/POS print data

Host: GitHub
URL: https://github.com/receipt-print-hq/escpos-tools
Owner: receipt-print-hq
License: mit
Created: 2017-03-12T13:29:51.000Z (over 7 years ago)
Default Branch: master
Last Pushed: 2023-08-21T18:22:22.000Z (about 1 year ago)
Last Synced: 2024-06-30T08:04:59.439Z (5 months ago)
Topics: escpos, format-converter, hacktoberfest, pos, printing, receipt
Language: PHP
Homepage:
Size: 126 KB
Stars: 192
Watchers: 15
Forks: 66
Open Issues: 29
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md

Awesome Lists containing this project

README

ESC/POS command-line tools [![Build Status](https://travis-ci.org/receipt-print-hq/escpos-tools.svg?branch=master)](https://travis-ci.org/receipt-print-hq/escpos-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](https://getcomposer.org/)

To install from source:

```bash
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](doc/esc2text.md)

### esc2html

`esc2html` converts binary ESC/POS files to HTML.

- [esc2html documentation](doc/esc2html.md)

### escimages

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

- [escimages documentation](doc/escimages.md)

## Contribute

- [CONTRIBUTING.md](CONTRIBUTING.md)

## Licensing

- [LICENSE.md](LICENSE.md)