A Python support for Epson© ESC/POS® compatible printers. Read more at Epson ESCPOS FAQ (PDF document).
This project is inspired on Manuel F. Martinez work for python-escpos implementation, among other projects, whose specific bits of work (available here on Github and many other open-source repositories) has helped so much.
The ESC/POS® is a standard that every manufacturer tend to modify to suit their (even already implemented) needs. Indeed, there is no standard but something awkward, an illusion of a standard. On the surface, one can say that it's pretty much the same, but when you look just a little bit more deeper, you quickly realize that they are almost completely different, even between models belonging to the same manufacturer.
This project aims to make viable the use, at the point-of-sale (POS), of different printers (the most common ones, at least) that are minimally based on ESC/POS® standard, without need to modify the client application code. To achieve this, it is necessary to draw a lowest common denominator between features and provide implementations that seek to meet this minimum.
Current implementations was tested against following hardware:
| Manufacturer | Models | Firmware Versions | Notes |
|---|---|---|---|
| Bematech S/A | MP-4200 TH | 1.3, 1.6 | |
| Epson | TM-T20 | 1.14 | |
| Elgin | Elgin i9 | CV1.03.20 | |
| Elgin | Elgin i7 | CV1.00.08 | |
| Nitere | NPDV-1020 | Multifunction Terminal model TMF-101/IG (an alias for CB55-C model) | |
| Unknown OEM | CB55-C | 1.3.5 | Embedded in Nitere NPDV-1020 (model TMF-101/IG) |
| Urmet Daruma | DR700 L/H/M and DR700 L-e/H-e | 02.51.00, 01.20.00, 01.21.00 |
You can get a list of all available implementations with the following snippet:
from escpos import helpers
for impl in helpers.find_implementations(sort_by='model.name'):
print('{:.<25} {}'.format(impl.model.name, impl.fqname))Which produces an output similar to:
Bematech MP-4200 TH...... escpos.impl.bematech.MP4200TH CB55-C................... escpos.impl.unknown.CB55C Daruma DR700............. escpos.impl.daruma.DR700 Elgin I7................. escpos.impl.elgin.ElginI7 Elgin I9................. escpos.impl.elgin.ElginI9 Epson TM-T20............. escpos.impl.epson.TMT20 Generic Daruma........... escpos.impl.daruma.DarumaGeneric Generic ESC/POS.......... escpos.impl.epson.GenericESCPOS Generic Elgin............ escpos.impl.elgin.ElginGeneric Nitere NPDV-1020......... escpos.impl.nitere.NitereNPDV1020
Serial communications support requires PySerial version 2.7 or later.
from escpos.serial import SerialConnection
from escpos.impl.epson import GenericESCPOS
# assumes RTS/CTS for 'ttyS5' and infers an instance of RTSCTSConnection
conn = SerialConnection.create('/dev/ttyS5:9600,8,1,N')
printer = GenericESCPOS(conn)
printer.init()
printer.text('Hello World!')You can connect to your printer through network TCP/IP interface.
from escpos.network import NetworkConnection
from escpos.impl.epson import GenericESCPOS
conn = NetworkConnection.create('10.0.0.101:9100')
printer = GenericESCPOS(conn)
printer.init()
printer.text('Hello World!')There is a default set of parameters for printing barcodes. Each ESC/POS implementation will take care of the details and try their best to print your barcode as you asked.
from escpos import barcode
from escpos.serial import SerialConnection
from escpos.impl.epson import GenericESCPOS
conn = SerialConnection.create('COM1:9600,8,1,N')
printer = GenericESCPOS(conn)
printer.init()
printer.code128('0123456789',
barcode_height=96, # ~12mm (~1/2")
barcode_width=barcode.BARCODE_DOUBLE_WIDTH,
barcode_hri=barcode.BARCODE_HRI_BOTTOM)
printer.lf()
printer.ean13('4007817525074',
barcode_height=120, # ~15mm (~9/16"),
barcode_width=barcode.BARCODE_NORMAL_WIDTH,
barcode_hri=barcode.BARCODE_HRI_TOP)
printer.cut()The barcode data should be complete, that is, an EAN-13 barcode is formed from
twelve digits plus check-digit. Most of the ESC/POS command implementations
require only twelve digits and automaticaly calculate the check-digit.
If you are dealing with, say, EAN-13 codes without the thirteenth-digit (the
check-digit) just append zero (0) to the barcode class (or method) argument,
so they can pass RE validation.
printer.ean13('4007817525074') # is OK
printer.ean13('400781752507') # raises ValueError
printer.ean13('4007817525070') # is OK and prints 4007817525074 as expected
Eventually you may find more examples in the PyESCPOS wiki pages.
It is important that you read this disclaimer.
None of the vendors cited in this project agree or endorse any of the patterns or implementations. Its names are used only to maintain context.