From 4daece43e715b11e951cf74657ca32a6106eda0b Mon Sep 17 00:00:00 2001 From: Thomas van den Berg Date: Wed, 27 Feb 2013 04:27:04 -0800 Subject: [PATCH 01/34] Initial commit --- .gitignore | 35 +++++++++++++++++++++++++++++++++++ README.md | 4 ++++ 2 files changed, 39 insertions(+) create mode 100644 .gitignore create mode 100644 README.md diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..d2d6f36 --- /dev/null +++ b/.gitignore @@ -0,0 +1,35 @@ +*.py[cod] + +# C extensions +*.so + +# Packages +*.egg +*.egg-info +dist +build +eggs +parts +bin +var +sdist +develop-eggs +.installed.cfg +lib +lib64 + +# Installer logs +pip-log.txt + +# Unit test / coverage reports +.coverage +.tox +nosetests.xml + +# Translations +*.mo + +# Mr Developer +.mr.developer.cfg +.project +.pydevproject diff --git a/README.md b/README.md new file mode 100644 index 0000000..1f4681e --- /dev/null +++ b/README.md @@ -0,0 +1,4 @@ +python-escpos +============= + +Fork of the python-escpos project for printing to POS printers. \ No newline at end of file From a6c72adc584b69be3c30980989c9f489972a6de8 Mon Sep 17 00:00:00 2001 From: Thomas van den Berg Date: Wed, 27 Feb 2013 13:31:18 +0100 Subject: [PATCH 02/34] copy files from google code repo --- .gitignore | 35 +----- README.md | 91 ++++++++++++++- escpos/__init__.py | 1 + escpos/constants.py | 53 +++++++++ escpos/escpos.py | 255 +++++++++++++++++++++++++++++++++++++++++++ escpos/exceptions.py | 80 ++++++++++++++ escpos/printer.py | 136 +++++++++++++++++++++++ 7 files changed, 614 insertions(+), 37 deletions(-) create mode 100644 escpos/__init__.py create mode 100644 escpos/constants.py create mode 100644 escpos/escpos.py create mode 100644 escpos/exceptions.py create mode 100644 escpos/printer.py diff --git a/.gitignore b/.gitignore index d2d6f36..05ea79d 100644 --- a/.gitignore +++ b/.gitignore @@ -1,35 +1,2 @@ *.py[cod] - -# C extensions -*.so - -# Packages -*.egg -*.egg-info -dist -build -eggs -parts -bin -var -sdist -develop-eggs -.installed.cfg -lib -lib64 - -# Installer logs -pip-log.txt - -# Unit test / coverage reports -.coverage -.tox -nosetests.xml - -# Translations -*.mo - -# Mr Developer -.mr.developer.cfg -.project -.pydevproject +.DS_Store \ No newline at end of file diff --git a/README.md b/README.md index 1f4681e..a60323e 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,89 @@ -python-escpos -============= +ESCPOS +====== + +Python library to manipulate ESC/POS Printers. + +------------------------------------------------------------------ +1. Dependencies + +In order to start getting access to your printer, you must ensure +you have previously installed the following python modules: + + * pyusb (python-usb) + * PIL (Python Image Library) + +------------------------------------------------------------------ +2. Description + +Python ESC/POS is a library which lets the user have access to all +those printers handled by ESC/POS commands, as defined by Epson, +from a Python application. + +The standard usage is send raw text to the printer, but in also +helps the user to enhance the experience with those printers by +facilitating the bar code printing in many different standards, +as well as manipulating images so they can be printed as brand +logo or any other usage images migh have. + +Text can be aligned/justified and fonts can be changed by size, +type and weight. + +Also, this module handles some hardware functionalities like, cut +paper, carrier return, printer reset and others concerned to the +carriage alignment. + +------------------------------------------------------------------ +3. Define your printer + +Before start create your Python ESC/POS printer instance, you must +see at your system for the printer parameters. This is done with +the 'lsusb' command. + +First run the command to look for the "Vendor ID" and "Product ID", +then write down the values, these values are displayed just before +the name of the device with the following format: + + xxxx:xxxx + +Example: + Bus 002 Device 001: ID 1a2b:1a2b Device name + +Write down the the values in question, then issue the following +command so you can get the "Interface" number and "End Point" + + lsusb -vvv -d xxxx:xxxx | grep iInterface + lsusb -vvv -d xxxx:xxxx | grep bEndpointAddress | grep OUT + +The first command will yields the "Interface" number that must +be handy to have and the second yields the "Output Endpoint" +address. + +By default the "Interface" number is "0" and the "Output Endpoint" +address is "0x82", if you have other values then you can define +with your instance. + +------------------------------------------------------------------ +4. Define your instance + +The following example shows how to initialize the Epson TM-TI88IV +*** NOTE: Always finish the sequence with Epson.cut() otherwise + you will endup with weird chars being printed. + + from escpos import * + + """ Seiko Epson Corp. Receipt Printer M129 Definitions (EPSON TM-T88IV) """ + Epson = escpos.Escpos(0x04b8,0x0202,0) + Epson.text("Hello World") + Epson.image("logo.gif") + Epson.barcode + Epson.barcode('1324354657687','EAN13',64,2,'','') + Epson.cut() + +------------------------------------------------------------------ +5. Links + +Please visit project homepage at: +http://repo.bashlinux.com/projects/escpos.html + +Manuel F Martinez -Fork of the python-escpos project for printing to POS printers. \ No newline at end of file diff --git a/escpos/__init__.py b/escpos/__init__.py new file mode 100644 index 0000000..22a5af6 --- /dev/null +++ b/escpos/__init__.py @@ -0,0 +1 @@ +__all__ = ["constants","escpos","exceptions","printer"] diff --git a/escpos/constants.py b/escpos/constants.py new file mode 100644 index 0000000..c39f6ce --- /dev/null +++ b/escpos/constants.py @@ -0,0 +1,53 @@ +""" ESC/POS Commands (Constants) """ + +# Feed control sequences +CTL_LF = '\x0a' # Print and line feed +CTL_FF = '\x0c' # Form feed +CTL_CR = '\x0d' # Carriage return +CTL_HT = '\x09' # Horizontal tab +CTL_VT = '\x0b' # Vertical tab +# Printer hardware +HW_INIT = '\x1b\x40' # Clear data in buffer and reset modes +HW_SELECT = '\x1b\x3d\x01' # Printer select +HW_RESET = '\x1b\x3f\x0a\x00' # Reset printer hardware +# Cash Drawer +CD_KICK_2 = '\x1b\x70\x00' # Sends a pulse to pin 2 [] +CD_KICK_5 = '\x1b\x70\x01' # Sends a pulse to pin 5 [] +# Paper +PAPER_FULL_CUT = '\x1d\x56\x00' # Full cut paper +PAPER_PART_CUT = '\x1d\x56\x01' # Partial cut paper +# Text format +TXT_NORMAL = '\x1b\x21\x00' # Normal text +TXT_2HEIGHT = '\x1b\x21\x10' # Double height text +TXT_2WIDTH = '\x1b\x21\x20' # Double width text +TXT_UNDERL_OFF = '\x1b\x2d\x00' # Underline font OFF +TXT_UNDERL_ON = '\x1b\x2d\x01' # Underline font 1-dot ON +TXT_UNDERL2_ON = '\x1b\x2d\x02' # Underline font 2-dot ON +TXT_BOLD_OFF = '\x1b\x45\x00' # Bold font OFF +TXT_BOLD_ON = '\x1b\x45\x01' # Bold font ON +TXT_FONT_A = '\x1b\x4d\x00' # Font type A +TXT_FONT_B = '\x1b\x4d\x01' # Font type B +TXT_ALIGN_LT = '\x1b\x61\x00' # Left justification +TXT_ALIGN_CT = '\x1b\x61\x01' # Centering +TXT_ALIGN_RT = '\x1b\x61\x02' # Right justification +# Barcode format +BARCODE_TXT_OFF = '\x1d\x48\x00' # HRI barcode chars OFF +BARCODE_TXT_ABV = '\x1d\x48\x01' # HRI barcode chars above +BARCODE_TXT_BLW = '\x1d\x48\x02' # HRI barcode chars below +BARCODE_TXT_BTH = '\x1d\x48\x03' # HRI barcode chars both above and below +BARCODE_FONT_A = '\x1d\x66\x00' # Font type A for HRI barcode chars +BARCODE_FONT_B = '\x1d\x66\x01' # Font type B for HRI barcode chars +BARCODE_HEIGHT = '\x1d\x68\x64' # Barcode Height [1-255] +BARCODE_WIDTH = '\x1d\x77\x03' # Barcode Width [2-6] +BARCODE_UPC_A = '\x1d\x6b\x00' # Barcode type UPC-A +BARCODE_UPC_E = '\x1d\x6b\x01' # Barcode type UPC-E +BARCODE_EAN13 = '\x1d\x6b\x02' # Barcode type EAN13 +BARCODE_EAN8 = '\x1d\x6b\x03' # Barcode type EAN8 +BARCODE_CODE39 = '\x1d\x6b\x04' # Barcode type CODE39 +BARCODE_ITF = '\x1d\x6b\x05' # Barcode type ITF +BARCODE_NW7 = '\x1d\x6b\x06' # Barcode type NW7 +# Image format +S_RASTER_N = '\x1d\x76\x30\x00' # Set raster image normal size +S_RASTER_2W = '\x1d\x76\x30\x01' # Set raster image double width +S_RASTER_2H = '\x1d\x76\x30\x02' # Set raster image double height +S_RASTER_Q = '\x1d\x76\x30\x03' # Set raster image quadruple diff --git a/escpos/escpos.py b/escpos/escpos.py new file mode 100644 index 0000000..3267125 --- /dev/null +++ b/escpos/escpos.py @@ -0,0 +1,255 @@ +#!/usr/bin/python +''' +@author: Manuel F Martinez +@organization: Bashlinux +@copyright: Copyright (c) 2012 Bashlinux +@license: GPL +''' + +import Image +import time + +from constants import * +from exceptions import * + +class Escpos: + """ ESC/POS Printer object """ + device = None + + + def _check_image_size(self, size): + """ Check and fix the size of the image to 32 bits """ + if size % 32 == 0: + return (0, 0) + else: + image_border = 32 - (size % 32) + if (image_border % 2) == 0: + return (image_border / 2, image_border / 2) + else: + return (image_border / 2, (image_border / 2) + 1) + + + def _print_image(self, line, size): + """ Print formatted image """ + i = 0 + cont = 0 + buffer = "" + + self._raw(S_RASTER_N) + buffer = "%02X%02X%02X%02X" % (((size[0]/size[1])/8), 0, size[1], 0) + self._raw(buffer.decode('hex')) + buffer = "" + + while i < len(line): + hex_string = int(line[i:i+8],2) + buffer += "%02X" % hex_string + i += 8 + cont += 1 + if cont % 4 == 0: + self._raw(buffer.decode("hex")) + buffer = "" + cont = 0 + + + def image(self, img): + """ Parse image and prepare it to a printable format """ + pixels = [] + pix_line = "" + im_left = "" + im_right = "" + switch = 0 + img_size = [ 0, 0 ] + + im_open = Image.open(img) + im = im_open.convert("RGB") + + if im.size[0] > 512: + print "WARNING: Image is wider than 512 and could be truncated at print time " + if im.size[1] > 255: + raise ImageSizeError() + + im_border = self._check_image_size(im.size[0]) + for i in range(im_border[0]): + im_left += "0" + for i in range(im_border[1]): + im_right += "0" + + for y in range(im.size[1]): + img_size[1] += 1 + pix_line += im_left + img_size[0] += im_border[0] + for x in range(im.size[0]): + img_size[0] += 1 + RGB = im.getpixel((x, y)) + im_color = (RGB[0] + RGB[1] + RGB[2]) + im_pattern = "1X0" + pattern_len = len(im_pattern) + switch = (switch - 1 ) * (-1) + for x in range(pattern_len): + if im_color <= (255 * 3 / pattern_len * (x+1)): + if im_pattern[x] == "X": + pix_line += "%d" % switch + else: + pix_line += im_pattern[x] + break + elif im_color > (255 * 3 / pattern_len * pattern_len) and im_color <= (255 * 3): + pix_line += im_pattern[-1] + break + pix_line += im_right + img_size[0] += im_border[1] + + self._print_image(pix_line, img_size) + + + def barcode(self, code, bc, width, height, pos, font): + """ Print Barcode """ + # Align Bar Code() + self._raw(TXT_ALIGN_CT) + # Height + if height >=2 or height <=6: + self._raw(BARCODE_HEIGHT) + else: + raise BarcodeSizeError() + # Width + if width >= 1 or width <=255: + self._raw(BARCODE_WIDTH) + else: + raise BarcodeSizeError() + # Font + if font.upper() == "B": + self._raw(BARCODE_FONT_B) + else: # DEFAULT FONT: A + self._raw(BARCODE_FONT_A) + # Position + if pos.upper() == "OFF": + self._raw(BARCODE_TXT_OFF) + elif pos.upper() == "BOTH": + self._raw(BARCODE_TXT_BTH) + elif pos.upper() == "ABOVE": + self._raw(BARCODE_TXT_ABV) + else: # DEFAULT POSITION: BELOW + self._raw(BARCODE_TXT_BLW) + # Type + if bc.upper() == "UPC-A": + self._raw(BARCODE_UPC_A) + elif bc.upper() == "UPC-E": + self._raw(BARCODE_UPC_E) + elif bc.upper() == "EAN13": + self._raw(BARCODE_EAN13) + elif bc.upper() == "EAN8": + self._raw(BARCODE_EAN8) + elif bc.upper() == "CODE39": + self._raw(BARCODE_CODE39) + elif bc.upper() == "ITF": + self._raw(BARCODE_ITF) + elif bc.upper() == "NW7": + self._raw(BARCODE_NW7) + else: + raise BarcodeTypeError() + # Print Code + if code: + self._raw(code) + else: + raise exception.BarcodeCodeError() + + + def text(self, txt): + """ Print alpha-numeric text """ + if txt: + self._raw(txt) + else: + raise TextError() + + + def set(self, align='left', font='a', type='normal', width=1, height=1): + """ Set text properties """ + # Align + if align.upper() == "CENTER": + self._raw(TXT_ALIGN_CT) + elif align.upper() == "RIGHT": + self._raw(TXT_ALIGN_RT) + elif align.upper() == "LEFT": + self._raw(TXT_ALIGN_LT) + # Font + if font.upper() == "B": + self._raw(TXT_FONT_B) + else: # DEFAULT FONT: A + self._raw(TXT_FONT_A) + # Type + if type.upper() == "B": + self._raw(TXT_BOLD_ON) + self._raw(TXT_UNDERL_OFF) + elif type.upper() == "U": + self._raw(TXT_BOLD_OFF) + self._raw(TXT_UNDERL_ON) + elif type.upper() == "U2": + self._raw(TXT_BOLD_OFF) + self._raw(TXT_UNDERL2_ON) + elif type.upper() == "BU": + self._raw(TXT_BOLD_ON) + self._raw(TXT_UNDERL_ON) + elif type.upper() == "BU2": + self._raw(TXT_BOLD_ON) + self._raw(TXT_UNDERL2_ON) + elif type.upper == "NORMAL": + self._raw(TXT_BOLD_OFF) + self._raw(TXT_UNDERL_OFF) + # Width + if width == 2 and height != 2: + self._raw(TXT_NORMAL) + self._raw(TXT_2WIDTH) + elif height == 2 and width != 2: + self._raw(TXT_NORMAL) + self._raw(TXT_2HEIGHT) + elif height == 2 and width == 2: + self._raw(TXT_2WIDTH) + self._raw(TXT_2HEIGHT) + else: # DEFAULT SIZE: NORMAL + self._raw(TXT_NORMAL) + + + def cut(self, mode=''): + """ Cut paper """ + # Fix the size between last line and cut + # TODO: handle this with a line feed + self._raw("\n\n\n\n\n\n") + if mode.upper() == "PART": + self._raw(PAPER_PART_CUT) + else: # DEFAULT MODE: FULL CUT + self._raw(PAPER_FULL_CUT) + + + def cashdraw(self, pin): + """ Send pulse to kick the cash drawer """ + if pin == 2: + self._raw(CD_KICK_2) + elif pin == 5: + self._raw(CD_KICK_5) + else: + raise CashDrawerError() + + + def hw(self, hw): + """ Hardware operations """ + if hw.upper() == "INIT": + self._raw(HW_INIT) + elif hw.upper() == "SELECT": + self._raw(HW_SELECT) + elif hw.upper() == "RESET": + self._raw(HW_RESET) + else: # DEFAULT: DOES NOTHING + pass + + + def control(self, ctl): + """ Feed control sequences """ + if ctl.upper() == "LF": + self._raw(CTL_LF) + elif ctl.upper() == "FF": + self._raw(CTL_FF) + elif ctl.upper() == "CR": + self._raw(CTL_CR) + elif ctl.upper() == "HT": + self._raw(CTL_HT) + elif ctl.upper() == "VT": + self._raw(CTL_VT) diff --git a/escpos/exceptions.py b/escpos/exceptions.py new file mode 100644 index 0000000..adbe648 --- /dev/null +++ b/escpos/exceptions.py @@ -0,0 +1,80 @@ +""" ESC/POS Exceptions classes """ + +import os + +class Error(Exception): + """ Base class for ESC/POS errors """ + def __init__(self, msg, status=None): + Exception.__init__(self) + self.msg = msg + self.resultcode = 1 + if status is not None: + self.resultcode = status + + def __str__(self): + return self.msg + +# Result/Exit codes +# 0 = success +# 10 = No Barcode type defined +# 20 = Barcode size values are out of range +# 30 = Barcode text not supplied +# 40 = Image height is too large +# 50 = No string supplied to be printed +# 60 = Invalid pin to send Cash Drawer pulse + + +class BarcodeTypeError(Error): + def __init__(self, msg=""): + Error.__init__(self, msg) + self.msg = msg + self.resultcode = 10 + + def __str__(self): + return "No Barcode type is defined" + +class BarcodeSizeError(Error): + def __init__(self, msg=""): + Error.__init__(self, msg) + self.msg = msg + self.resultcode = 20 + + def __str__(self): + return "Barcode size is out of range" + +class BarcodeCodeError(Error): + def __init__(self, msg=""): + Error.__init__(self, msg) + self.msg = msg + self.resultcode = 30 + + def __str__(self): + return "Code was not supplied" + +class ImageSizeError(Error): + def __init__(self, msg=""): + Error.__init__(self, msg) + self.msg = msg + self.resultcode = 40 + + def __str__(self): + return "Image height is longer than 255px and can't be printed" + +class TextError(Error): + def __init__(self, msg=""): + Error.__init__(self, msg) + self.msg = msg + self.resultcode = 50 + + def __str__(self): + return "Text string must be supplied to the text() method" + + +class CashDrawerError(Error): + def __init__(self, msg=""): + Error.__init__(self, msg) + self.msg = msg + self.resultcode = 60 + + def __str__(self): + return "Valid pin must be set to send pulse" diff --git a/escpos/printer.py b/escpos/printer.py new file mode 100644 index 0000000..dd5aa93 --- /dev/null +++ b/escpos/printer.py @@ -0,0 +1,136 @@ +#!/usr/bin/python +''' +@author: Manuel F Martinez +@organization: Bashlinux +@copyright: Copyright (c) 2012 Bashlinux +@license: GPL +''' + +import usb.core +import usb.util +import serial +import socket + +from escpos import * +from constants import * +from exceptions import * + +class Usb(Escpos): + """ Define USB printer """ + + def __init__(self, idVendor, idProduct, interface=0, in_ep=0x82, out_ep=0x01): + """ + @param idVendor : Vendor ID + @param idProduct : Product ID + @param interface : USB device interface + @param in_ep : Input end point + @param out_ep : Output end point + """ + self.idVendor = idVendor + self.idProduct = idProduct + self.interface = interface + self.in_ep = in_ep + self.out_ep = out_ep + self.open() + + + def open(self): + """ Search device on USB tree and set is as escpos device """ + self.device = usb.core.find(idVendor=self.idVendor, idProduct=self.idProduct) + if self.device is None: + print "Cable isn't plugged in" + + if self.device.is_kernel_driver_active(0): + try: + self.device.detach_kernel_driver(0) + except usb.core.USBError as e: + print "Could not detatch kernel driver: %s" % str(e) + + try: + self.device.set_configuration() + self.device.reset() + except usb.core.USBError as e: + print "Could not set configuration: %s" % str(e) + + + def _raw(self, msg): + """ Print any command sent in raw format """ + self.device.write(self.out_ep, msg, self.interface) + + + def __del__(self): + """ Release USB interface """ + if self.device: + usb.util.dispose_resources(self.device) + self.device = None + + + +class Serial(Escpos): + """ Define Serial printer """ + + def __init__(self, devfile="/dev/ttyS0", baudrate=9600, bytesize=8, timeout=1): + """ + @param devfile : Device file under dev filesystem + @param baudrate : Baud rate for serial transmission + @param bytesize : Serial buffer size + @param timeout : Read/Write timeout + """ + self.devfile = devfile + self.baudrate = baudrate + self.bytesize = bytesize + self.timeout = timeout + self.open() + + + def open(self): + """ Setup serial port and set is as escpos device """ + self.device = serial.Serial(port=self.devfile, baudrate=self.baudrate, bytesize=self.bytesize, parity=serial.PARITY_NONE, stopbits=serial.STOPBITS_ONE, timeout=self.timeout, dsrdtr=True) + + if self.device is not None: + print "Serial printer enabled" + else: + print "Unable to open serial printer on: %s" % self.devfile + + + def _raw(self, msg): + """ Print any command sent in raw format """ + self.device.write(msg) + + + def __del__(self): + """ Close Serial interface """ + if self.device is not None: + self.device.close() + + + +class Network(Escpos): + """ Define Network printer """ + + def __init__(self,host,port=9100): + """ + @param host : Printer's hostname or IP address + @param port : Port to write to + """ + self.host = host + self.port = port + self.open() + + + def open(self): + """ Open TCP socket and set it as escpos device """ + self.device = socket.socket(socket.AF_INET, socket.SOCK_STREAM) + self.device.connect((self.host, self.port)) + + if self.device is None: + print "Could not open socket for %s" % self.host + + + def _raw(self, msg): + self.device.send(msg) + + + def __del__(self): + """ Close TCP connection """ + self.device.close() From f273b51917bda0d7f4da7af8d125d6f85d807bb4 Mon Sep 17 00:00:00 2001 From: Thomas van den Berg Date: Wed, 27 Feb 2013 13:32:43 +0100 Subject: [PATCH 03/34] markdownify readme --- README.md | 34 +++++++++++++++++----------------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index a60323e..408387b 100644 --- a/README.md +++ b/README.md @@ -3,8 +3,8 @@ ESCPOS Python library to manipulate ESC/POS Printers. ------------------------------------------------------------------- 1. Dependencies +------------------------------------------------------------------ In order to start getting access to your printer, you must ensure you have previously installed the following python modules: @@ -12,8 +12,8 @@ you have previously installed the following python modules: * pyusb (python-usb) * PIL (Python Image Library) ------------------------------------------------------------------- 2. Description +------------------------------------------------------------------ Python ESC/POS is a library which lets the user have access to all those printers handled by ESC/POS commands, as defined by Epson, @@ -32,8 +32,8 @@ Also, this module handles some hardware functionalities like, cut paper, carrier return, printer reset and others concerned to the carriage alignment. ------------------------------------------------------------------- 3. Define your printer +------------------------------------------------------------------ Before start create your Python ESC/POS printer instance, you must see at your system for the printer parameters. This is done with @@ -43,7 +43,7 @@ First run the command to look for the "Vendor ID" and "Product ID", then write down the values, these values are displayed just before the name of the device with the following format: - xxxx:xxxx + xxxx:xxxx Example: Bus 002 Device 001: ID 1a2b:1a2b Device name @@ -51,8 +51,8 @@ Example: Write down the the values in question, then issue the following command so you can get the "Interface" number and "End Point" - lsusb -vvv -d xxxx:xxxx | grep iInterface - lsusb -vvv -d xxxx:xxxx | grep bEndpointAddress | grep OUT + lsusb -vvv -d xxxx:xxxx | grep iInterface + lsusb -vvv -d xxxx:xxxx | grep bEndpointAddress | grep OUT The first command will yields the "Interface" number that must be handy to have and the second yields the "Output Endpoint" @@ -62,25 +62,25 @@ By default the "Interface" number is "0" and the "Output Endpoint" address is "0x82", if you have other values then you can define with your instance. ------------------------------------------------------------------- 4. Define your instance +------------------------------------------------------------------ The following example shows how to initialize the Epson TM-TI88IV *** NOTE: Always finish the sequence with Epson.cut() otherwise you will endup with weird chars being printed. - from escpos import * + from escpos import * + + """ Seiko Epson Corp. Receipt Printer M129 Definitions (EPSON TM-T88IV) """ + Epson = escpos.Escpos(0x04b8,0x0202,0) + Epson.text("Hello World") + Epson.image("logo.gif") + Epson.barcode + Epson.barcode('1324354657687','EAN13',64,2,'','') + Epson.cut() - """ Seiko Epson Corp. Receipt Printer M129 Definitions (EPSON TM-T88IV) """ - Epson = escpos.Escpos(0x04b8,0x0202,0) - Epson.text("Hello World") - Epson.image("logo.gif") - Epson.barcode - Epson.barcode('1324354657687','EAN13',64,2,'','') - Epson.cut() - ------------------------------------------------------------------- 5. Links +------------------------------------------------------------------ Please visit project homepage at: http://repo.bashlinux.com/projects/escpos.html From 126dde8a7e04525df5b6249d37a959d2699ebd99 Mon Sep 17 00:00:00 2001 From: Thomas van den Berg Date: Wed, 27 Feb 2013 13:42:32 +0100 Subject: [PATCH 04/34] add support for printing PIL image objects directly --- escpos/escpos.py | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/escpos/escpos.py b/escpos/escpos.py index 3267125..d7ea18e 100644 --- a/escpos/escpos.py +++ b/escpos/escpos.py @@ -8,6 +8,7 @@ import Image import time +import os from constants import * from exceptions import * @@ -60,8 +61,10 @@ class Escpos: switch = 0 img_size = [ 0, 0 ] - im_open = Image.open(img) - im = im_open.convert("RGB") + if isinstance(img, Image): + im = img.convert("RGB") + else: + im = Image.open(img).convert("RGB") if im.size[0] > 512: print "WARNING: Image is wider than 512 and could be truncated at print time " From b4f8de002ccc8e87c0233378496303514697f40f Mon Sep 17 00:00:00 2001 From: Thomas van den Berg Date: Wed, 27 Feb 2013 15:10:34 +0100 Subject: [PATCH 05/34] add function to print full images including resizing --- escpos/__init__.py | 1 + escpos/escpos.py | 40 +++++++++++++++++++++++++++++++++++++++- escpos/exceptions.py | 3 +++ escpos/printer.py | 2 +- 4 files changed, 44 insertions(+), 2 deletions(-) diff --git a/escpos/__init__.py b/escpos/__init__.py index 22a5af6..956f246 100644 --- a/escpos/__init__.py +++ b/escpos/__init__.py @@ -1 +1,2 @@ +import constants, escpos, exceptions, printer __all__ = ["constants","escpos","exceptions","printer"] diff --git a/escpos/escpos.py b/escpos/escpos.py index d7ea18e..caf4ef3 100644 --- a/escpos/escpos.py +++ b/escpos/escpos.py @@ -7,8 +7,10 @@ ''' import Image +import PIL.Image import time import os +import operator from constants import * from exceptions import * @@ -51,6 +53,42 @@ class Escpos: buffer = "" cont = 0 + def fullimage(self, img, max_height=860, width=512, histeq=True): + """ Resizes and prints an arbitrarily sized image """ + if isinstance(img, (Image.Image, PIL.Image.Image)): + im = img.convert("RGB") + else: + im = Image.open(img).convert("RGB") + + if histeq: + # Histogram equaliztion + h = im.histogram() + lut = [] + for b in range(0, len(h), 256): + # step size + step = reduce(operator.add, h[b:b+256]) / 255 + # create equalization lookup table + n = 0 + for i in range(256): + lut.append(n / step) + n = n + h[i+b] + im = im.point(lut) + + ratio = float(width) / im.size[0] + newheight = int(ratio * im.size[1]) + + # Resize the image + im = im.resize((width, newheight), Image.ANTIALIAS) + if im.size[1] > max_height: + im = im.crop((0, 0, im.size[0], max_height)) + + # Divide into bands + bandsize = 255 + current = 0 + while current < im.size[1]: + self.image(im.crop((0, current, width, current + bandsize))) + current += bandsize + def image(self, img): """ Parse image and prepare it to a printable format """ @@ -61,7 +99,7 @@ class Escpos: switch = 0 img_size = [ 0, 0 ] - if isinstance(img, Image): + if isinstance(img, (Image.Image, PIL.Image.Image)): im = img.convert("RGB") else: im = Image.open(img).convert("RGB") diff --git a/escpos/exceptions.py b/escpos/exceptions.py index adbe648..caad7a8 100644 --- a/escpos/exceptions.py +++ b/escpos/exceptions.py @@ -14,6 +14,9 @@ class Error(Exception): def __str__(self): return self.msg +class NotFoundError(Error): + """ Device wasn't found (not plugged in) """ + # Result/Exit codes # 0 = success # 10 = No Barcode type defined diff --git a/escpos/printer.py b/escpos/printer.py index dd5aa93..7ecd5d0 100644 --- a/escpos/printer.py +++ b/escpos/printer.py @@ -38,7 +38,7 @@ class Usb(Escpos): """ Search device on USB tree and set is as escpos device """ self.device = usb.core.find(idVendor=self.idVendor, idProduct=self.idProduct) if self.device is None: - print "Cable isn't plugged in" + raise NotFoundError("Device not found or cable not plugged in.") if self.device.is_kernel_driver_active(0): try: From 5db192751f5e13b96292aba5219e43764bd01a25 Mon Sep 17 00:00:00 2001 From: Thomas van den Berg Date: Wed, 27 Feb 2013 23:17:56 +0100 Subject: [PATCH 06/34] remove import PIL --- escpos/escpos.py | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/escpos/escpos.py b/escpos/escpos.py index caf4ef3..512a99e 100644 --- a/escpos/escpos.py +++ b/escpos/escpos.py @@ -7,7 +7,6 @@ ''' import Image -import PIL.Image import time import os import operator @@ -55,7 +54,7 @@ class Escpos: def fullimage(self, img, max_height=860, width=512, histeq=True): """ Resizes and prints an arbitrarily sized image """ - if isinstance(img, (Image.Image, PIL.Image.Image)): + if isinstance(img, Image.Image): im = img.convert("RGB") else: im = Image.open(img).convert("RGB") @@ -99,7 +98,7 @@ class Escpos: switch = 0 img_size = [ 0, 0 ] - if isinstance(img, (Image.Image, PIL.Image.Image)): + if isinstance(img, Image.Image): im = img.convert("RGB") else: im = Image.open(img).convert("RGB") From 7d4ef744de5e74cdf4d765aa3ba74120030be600 Mon Sep 17 00:00:00 2001 From: Thomas van den Berg Date: Wed, 27 Feb 2013 23:18:49 +0100 Subject: [PATCH 07/34] fix band printing --- escpos/escpos.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/escpos/escpos.py b/escpos/escpos.py index 512a99e..906c985 100644 --- a/escpos/escpos.py +++ b/escpos/escpos.py @@ -85,7 +85,7 @@ class Escpos: bandsize = 255 current = 0 while current < im.size[1]: - self.image(im.crop((0, current, width, current + bandsize))) + self.image(im.crop((0, current, width, min(im.size[1], current + bandsize)))) current += bandsize From 84e316ac321ac13a3b39c7866de196a40215b0a4 Mon Sep 17 00:00:00 2001 From: Thomas van den Berg Date: Tue, 25 Jun 2013 22:32:14 +0300 Subject: [PATCH 08/34] Update README.md --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 408387b..c912612 100644 --- a/README.md +++ b/README.md @@ -75,6 +75,7 @@ The following example shows how to initialize the Epson TM-TI88IV Epson = escpos.Escpos(0x04b8,0x0202,0) Epson.text("Hello World") Epson.image("logo.gif") + Epson.fullimage("a.really.large.image.png") Epson.barcode Epson.barcode('1324354657687','EAN13',64,2,'','') Epson.cut() From f8c34e8748ec4b5196a604f0a9139964ef4aaef3 Mon Sep 17 00:00:00 2001 From: Davis Goglin Date: Thu, 22 Aug 2013 08:16:57 -0700 Subject: [PATCH 09/34] imported latest google code repo --- .hgignore | 10 + COPYING | 674 +++++++++++++++++++++++++++++++++++++++++++ INSTALL | 23 ++ README | 89 ++++++ escpos/__init__.py | 1 + escpos/constants.py | 53 ++++ escpos/escpos.py | 274 ++++++++++++++++++ escpos/exceptions.py | 80 +++++ escpos/printer.py | 167 +++++++++++ setup.py | 29 ++ 10 files changed, 1400 insertions(+) create mode 100644 .hgignore create mode 100644 COPYING create mode 100644 INSTALL create mode 100644 README create mode 100644 escpos/__init__.py create mode 100644 escpos/constants.py create mode 100644 escpos/escpos.py create mode 100644 escpos/exceptions.py create mode 100644 escpos/printer.py create mode 100755 setup.py diff --git a/.hgignore b/.hgignore new file mode 100644 index 0000000..aa3937a --- /dev/null +++ b/.hgignore @@ -0,0 +1,10 @@ +# python temporary files +syntax: glob +*.pyc + +# editor autosaves +$~ + +# temporary data +syntax: regexp +temp diff --git a/COPYING b/COPYING new file mode 100644 index 0000000..94a9ed0 --- /dev/null +++ b/COPYING @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/INSTALL b/INSTALL new file mode 100644 index 0000000..e800f7f --- /dev/null +++ b/INSTALL @@ -0,0 +1,23 @@ +python-escpos +============= + +Ensure the library is installed on ${lib_arch}/${python_ver}/site-packages/escpos + +On CLi you must run: +# python setup.py build +# sudo python setup.py install + +On Linux, ensure you belongs to the proper group so you can have access to the printer. +This can be done, by adding yourself to 'dialout' group, this might require to re-login +so the changes make effect. + +Then, add the following rule to /etc/udev/rules.d/99-escpos.rules +SUBSYSTEM=="usb", ATTRS{idVendor}=="04b8", ATTRS{idProduct}=="0202", MODE="0664", GROUP="dialout" + +and restar udev rules. +# sudo service udev restart + +Enjoy !!! +And please, don't forget to ALWAYS add Epson.cut() at the end of your printing :) + +Manuel F Martinez diff --git a/README b/README new file mode 100644 index 0000000..a60323e --- /dev/null +++ b/README @@ -0,0 +1,89 @@ +ESCPOS +====== + +Python library to manipulate ESC/POS Printers. + +------------------------------------------------------------------ +1. Dependencies + +In order to start getting access to your printer, you must ensure +you have previously installed the following python modules: + + * pyusb (python-usb) + * PIL (Python Image Library) + +------------------------------------------------------------------ +2. Description + +Python ESC/POS is a library which lets the user have access to all +those printers handled by ESC/POS commands, as defined by Epson, +from a Python application. + +The standard usage is send raw text to the printer, but in also +helps the user to enhance the experience with those printers by +facilitating the bar code printing in many different standards, +as well as manipulating images so they can be printed as brand +logo or any other usage images migh have. + +Text can be aligned/justified and fonts can be changed by size, +type and weight. + +Also, this module handles some hardware functionalities like, cut +paper, carrier return, printer reset and others concerned to the +carriage alignment. + +------------------------------------------------------------------ +3. Define your printer + +Before start create your Python ESC/POS printer instance, you must +see at your system for the printer parameters. This is done with +the 'lsusb' command. + +First run the command to look for the "Vendor ID" and "Product ID", +then write down the values, these values are displayed just before +the name of the device with the following format: + + xxxx:xxxx + +Example: + Bus 002 Device 001: ID 1a2b:1a2b Device name + +Write down the the values in question, then issue the following +command so you can get the "Interface" number and "End Point" + + lsusb -vvv -d xxxx:xxxx | grep iInterface + lsusb -vvv -d xxxx:xxxx | grep bEndpointAddress | grep OUT + +The first command will yields the "Interface" number that must +be handy to have and the second yields the "Output Endpoint" +address. + +By default the "Interface" number is "0" and the "Output Endpoint" +address is "0x82", if you have other values then you can define +with your instance. + +------------------------------------------------------------------ +4. Define your instance + +The following example shows how to initialize the Epson TM-TI88IV +*** NOTE: Always finish the sequence with Epson.cut() otherwise + you will endup with weird chars being printed. + + from escpos import * + + """ Seiko Epson Corp. Receipt Printer M129 Definitions (EPSON TM-T88IV) """ + Epson = escpos.Escpos(0x04b8,0x0202,0) + Epson.text("Hello World") + Epson.image("logo.gif") + Epson.barcode + Epson.barcode('1324354657687','EAN13',64,2,'','') + Epson.cut() + +------------------------------------------------------------------ +5. Links + +Please visit project homepage at: +http://repo.bashlinux.com/projects/escpos.html + +Manuel F Martinez + diff --git a/escpos/__init__.py b/escpos/__init__.py new file mode 100644 index 0000000..22a5af6 --- /dev/null +++ b/escpos/__init__.py @@ -0,0 +1 @@ +__all__ = ["constants","escpos","exceptions","printer"] diff --git a/escpos/constants.py b/escpos/constants.py new file mode 100644 index 0000000..c39f6ce --- /dev/null +++ b/escpos/constants.py @@ -0,0 +1,53 @@ +""" ESC/POS Commands (Constants) """ + +# Feed control sequences +CTL_LF = '\x0a' # Print and line feed +CTL_FF = '\x0c' # Form feed +CTL_CR = '\x0d' # Carriage return +CTL_HT = '\x09' # Horizontal tab +CTL_VT = '\x0b' # Vertical tab +# Printer hardware +HW_INIT = '\x1b\x40' # Clear data in buffer and reset modes +HW_SELECT = '\x1b\x3d\x01' # Printer select +HW_RESET = '\x1b\x3f\x0a\x00' # Reset printer hardware +# Cash Drawer +CD_KICK_2 = '\x1b\x70\x00' # Sends a pulse to pin 2 [] +CD_KICK_5 = '\x1b\x70\x01' # Sends a pulse to pin 5 [] +# Paper +PAPER_FULL_CUT = '\x1d\x56\x00' # Full cut paper +PAPER_PART_CUT = '\x1d\x56\x01' # Partial cut paper +# Text format +TXT_NORMAL = '\x1b\x21\x00' # Normal text +TXT_2HEIGHT = '\x1b\x21\x10' # Double height text +TXT_2WIDTH = '\x1b\x21\x20' # Double width text +TXT_UNDERL_OFF = '\x1b\x2d\x00' # Underline font OFF +TXT_UNDERL_ON = '\x1b\x2d\x01' # Underline font 1-dot ON +TXT_UNDERL2_ON = '\x1b\x2d\x02' # Underline font 2-dot ON +TXT_BOLD_OFF = '\x1b\x45\x00' # Bold font OFF +TXT_BOLD_ON = '\x1b\x45\x01' # Bold font ON +TXT_FONT_A = '\x1b\x4d\x00' # Font type A +TXT_FONT_B = '\x1b\x4d\x01' # Font type B +TXT_ALIGN_LT = '\x1b\x61\x00' # Left justification +TXT_ALIGN_CT = '\x1b\x61\x01' # Centering +TXT_ALIGN_RT = '\x1b\x61\x02' # Right justification +# Barcode format +BARCODE_TXT_OFF = '\x1d\x48\x00' # HRI barcode chars OFF +BARCODE_TXT_ABV = '\x1d\x48\x01' # HRI barcode chars above +BARCODE_TXT_BLW = '\x1d\x48\x02' # HRI barcode chars below +BARCODE_TXT_BTH = '\x1d\x48\x03' # HRI barcode chars both above and below +BARCODE_FONT_A = '\x1d\x66\x00' # Font type A for HRI barcode chars +BARCODE_FONT_B = '\x1d\x66\x01' # Font type B for HRI barcode chars +BARCODE_HEIGHT = '\x1d\x68\x64' # Barcode Height [1-255] +BARCODE_WIDTH = '\x1d\x77\x03' # Barcode Width [2-6] +BARCODE_UPC_A = '\x1d\x6b\x00' # Barcode type UPC-A +BARCODE_UPC_E = '\x1d\x6b\x01' # Barcode type UPC-E +BARCODE_EAN13 = '\x1d\x6b\x02' # Barcode type EAN13 +BARCODE_EAN8 = '\x1d\x6b\x03' # Barcode type EAN8 +BARCODE_CODE39 = '\x1d\x6b\x04' # Barcode type CODE39 +BARCODE_ITF = '\x1d\x6b\x05' # Barcode type ITF +BARCODE_NW7 = '\x1d\x6b\x06' # Barcode type NW7 +# Image format +S_RASTER_N = '\x1d\x76\x30\x00' # Set raster image normal size +S_RASTER_2W = '\x1d\x76\x30\x01' # Set raster image double width +S_RASTER_2H = '\x1d\x76\x30\x02' # Set raster image double height +S_RASTER_Q = '\x1d\x76\x30\x03' # Set raster image quadruple diff --git a/escpos/escpos.py b/escpos/escpos.py new file mode 100644 index 0000000..91d71fc --- /dev/null +++ b/escpos/escpos.py @@ -0,0 +1,274 @@ +#!/usr/bin/python +''' +@author: Manuel F Martinez +@organization: Bashlinux +@copyright: Copyright (c) 2012 Bashlinux +@license: GPL +''' + +import Image +import qrcode +import time + +from constants import * +from exceptions import * + +class Escpos: + """ ESC/POS Printer object """ + device = None + + + def _check_image_size(self, size): + """ Check and fix the size of the image to 32 bits """ + if size % 32 == 0: + return (0, 0) + else: + image_border = 32 - (size % 32) + if (image_border % 2) == 0: + return (image_border / 2, image_border / 2) + else: + return (image_border / 2, (image_border / 2) + 1) + + + def _print_image(self, line, size): + """ Print formatted image """ + i = 0 + cont = 0 + buffer = "" + + self._raw(S_RASTER_N) + buffer = "%02X%02X%02X%02X" % (((size[0]/size[1])/8), 0, size[1], 0) + self._raw(buffer.decode('hex')) + buffer = "" + + while i < len(line): + hex_string = int(line[i:i+8],2) + buffer += "%02X" % hex_string + i += 8 + cont += 1 + if cont % 4 == 0: + self._raw(buffer.decode("hex")) + buffer = "" + cont = 0 + + + def _convert_image(self, im): + """ Parse image and prepare it to a printable format """ + pixels = [] + pix_line = "" + im_left = "" + im_right = "" + switch = 0 + img_size = [ 0, 0 ] + + + if im.size[0] > 512: + print ("WARNING: Image is wider than 512 and could be truncated at print time ") + if im.size[1] > 255: + raise ImageSizeError() + + im_border = self._check_image_size(im.size[0]) + for i in range(im_border[0]): + im_left += "0" + for i in range(im_border[1]): + im_right += "0" + + for y in range(im.size[1]): + img_size[1] += 1 + pix_line += im_left + img_size[0] += im_border[0] + for x in range(im.size[0]): + img_size[0] += 1 + RGB = im.getpixel((x, y)) + im_color = (RGB[0] + RGB[1] + RGB[2]) + im_pattern = "1X0" + pattern_len = len(im_pattern) + switch = (switch - 1 ) * (-1) + for x in range(pattern_len): + if im_color <= (255 * 3 / pattern_len * (x+1)): + if im_pattern[x] == "X": + pix_line += "%d" % switch + else: + pix_line += im_pattern[x] + break + elif im_color > (255 * 3 / pattern_len * pattern_len) and im_color <= (255 * 3): + pix_line += im_pattern[-1] + break + pix_line += im_right + img_size[0] += im_border[1] + + self._print_image(pix_line, img_size) + + + def image(self,path_img): + """ Open image file """ + im_open = Image.open(path_img) + im = im_open.convert("RGB") + # Convert the RGB image in printable image + self._convert_image(im) + + + def qr(self,text): + """ Print QR Code for the provided string """ + qr_code = qrcode.QRCode(version=4, box_size=4, border=1) + qr_code.add_data(text) + qr_code.make(fit=True) + qr_img = qr_code.make_image() + im = qr_img._img.convert("RGB") + # Convert the RGB image in printable image + self._convert_image(im) + + + def barcode(self, code, bc, width, height, pos, font): + """ Print Barcode """ + # Align Bar Code() + self._raw(TXT_ALIGN_CT) + # Height + if height >=2 or height <=6: + self._raw(BARCODE_HEIGHT) + else: + raise BarcodeSizeError() + # Width + if width >= 1 or width <=255: + self._raw(BARCODE_WIDTH) + else: + raise BarcodeSizeError() + # Font + if font.upper() == "B": + self._raw(BARCODE_FONT_B) + else: # DEFAULT FONT: A + self._raw(BARCODE_FONT_A) + # Position + if pos.upper() == "OFF": + self._raw(BARCODE_TXT_OFF) + elif pos.upper() == "BOTH": + self._raw(BARCODE_TXT_BTH) + elif pos.upper() == "ABOVE": + self._raw(BARCODE_TXT_ABV) + else: # DEFAULT POSITION: BELOW + self._raw(BARCODE_TXT_BLW) + # Type + if bc.upper() == "UPC-A": + self._raw(BARCODE_UPC_A) + elif bc.upper() == "UPC-E": + self._raw(BARCODE_UPC_E) + elif bc.upper() == "EAN13": + self._raw(BARCODE_EAN13) + elif bc.upper() == "EAN8": + self._raw(BARCODE_EAN8) + elif bc.upper() == "CODE39": + self._raw(BARCODE_CODE39) + elif bc.upper() == "ITF": + self._raw(BARCODE_ITF) + elif bc.upper() == "NW7": + self._raw(BARCODE_NW7) + else: + raise BarcodeTypeError() + # Print Code + if code: + self._raw(code) + else: + raise exception.BarcodeCodeError() + + + def text(self, txt): + """ Print alpha-numeric text """ + if txt: + self._raw(txt) + else: + raise TextError() + + + def set(self, align='left', font='a', type='normal', width=1, height=1): + """ Set text properties """ + # Width + if width == 2 and height != 2: + self._raw(TXT_NORMAL) + self._raw(TXT_2WIDTH) + elif height == 2 and width != 2: + self._raw(TXT_NORMAL) + self._raw(TXT_2HEIGHT) + elif height == 2 and width == 2: + self._raw(TXT_2WIDTH) + self._raw(TXT_2HEIGHT) + else: # DEFAULT SIZE: NORMAL + self._raw(TXT_NORMAL) + # Type + if type.upper() == "B": + self._raw(TXT_BOLD_ON) + self._raw(TXT_UNDERL_OFF) + elif type.upper() == "U": + self._raw(TXT_BOLD_OFF) + self._raw(TXT_UNDERL_ON) + elif type.upper() == "U2": + self._raw(TXT_BOLD_OFF) + self._raw(TXT_UNDERL2_ON) + self._raw(TXT_ITALIC_OFF) + elif type.upper() == "BU": + self._raw(TXT_BOLD_ON) + self._raw(TXT_UNDERL_ON) + elif type.upper() == "BU2": + self._raw(TXT_BOLD_ON) + self._raw(TXT_UNDERL2_ON) + elif type.upper == "NORMAL": + self._raw(TXT_BOLD_OFF) + self._raw(TXT_UNDERL_OFF) + # Font + if font.upper() == "B": + self._raw(TXT_FONT_B) + else: # DEFAULT FONT: A + self._raw(TXT_FONT_A) + # Align + if align.upper() == "CENTER": + self._raw(TXT_ALIGN_CT) + elif align.upper() == "RIGHT": + self._raw(TXT_ALIGN_RT) + elif align.upper() == "LEFT": + self._raw(TXT_ALIGN_LT) + + + def cut(self, mode=''): + """ Cut paper """ + # Fix the size between last line and cut + # TODO: handle this with a line feed + self._raw("\n\n\n\n\n\n") + if mode.upper() == "PART": + self._raw(PAPER_PART_CUT) + else: # DEFAULT MODE: FULL CUT + self._raw(PAPER_FULL_CUT) + + + def cashdraw(self, pin): + """ Send pulse to kick the cash drawer """ + if pin == 2: + self._raw(CD_KICK_2) + elif pin == 5: + self._raw(CD_KICK_5) + else: + raise CashDrawerError() + + + def hw(self, hw): + """ Hardware operations """ + if hw.upper() == "INIT": + self._raw(HW_INIT) + elif hw.upper() == "SELECT": + self._raw(HW_SELECT) + elif hw.upper() == "RESET": + self._raw(HW_RESET) + else: # DEFAULT: DOES NOTHING + pass + + + def control(self, ctl): + """ Feed control sequences """ + if ctl.upper() == "LF": + self._raw(CTL_LF) + elif ctl.upper() == "FF": + self._raw(CTL_FF) + elif ctl.upper() == "CR": + self._raw(CTL_CR) + elif ctl.upper() == "HT": + self._raw(CTL_HT) + elif ctl.upper() == "VT": + self._raw(CTL_VT) diff --git a/escpos/exceptions.py b/escpos/exceptions.py new file mode 100644 index 0000000..adbe648 --- /dev/null +++ b/escpos/exceptions.py @@ -0,0 +1,80 @@ +""" ESC/POS Exceptions classes """ + +import os + +class Error(Exception): + """ Base class for ESC/POS errors """ + def __init__(self, msg, status=None): + Exception.__init__(self) + self.msg = msg + self.resultcode = 1 + if status is not None: + self.resultcode = status + + def __str__(self): + return self.msg + +# Result/Exit codes +# 0 = success +# 10 = No Barcode type defined +# 20 = Barcode size values are out of range +# 30 = Barcode text not supplied +# 40 = Image height is too large +# 50 = No string supplied to be printed +# 60 = Invalid pin to send Cash Drawer pulse + + +class BarcodeTypeError(Error): + def __init__(self, msg=""): + Error.__init__(self, msg) + self.msg = msg + self.resultcode = 10 + + def __str__(self): + return "No Barcode type is defined" + +class BarcodeSizeError(Error): + def __init__(self, msg=""): + Error.__init__(self, msg) + self.msg = msg + self.resultcode = 20 + + def __str__(self): + return "Barcode size is out of range" + +class BarcodeCodeError(Error): + def __init__(self, msg=""): + Error.__init__(self, msg) + self.msg = msg + self.resultcode = 30 + + def __str__(self): + return "Code was not supplied" + +class ImageSizeError(Error): + def __init__(self, msg=""): + Error.__init__(self, msg) + self.msg = msg + self.resultcode = 40 + + def __str__(self): + return "Image height is longer than 255px and can't be printed" + +class TextError(Error): + def __init__(self, msg=""): + Error.__init__(self, msg) + self.msg = msg + self.resultcode = 50 + + def __str__(self): + return "Text string must be supplied to the text() method" + + +class CashDrawerError(Error): + def __init__(self, msg=""): + Error.__init__(self, msg) + self.msg = msg + self.resultcode = 60 + + def __str__(self): + return "Valid pin must be set to send pulse" diff --git a/escpos/printer.py b/escpos/printer.py new file mode 100644 index 0000000..7cdedf3 --- /dev/null +++ b/escpos/printer.py @@ -0,0 +1,167 @@ +#!/usr/bin/python +''' +@author: Manuel F Martinez +@organization: Bashlinux +@copyright: Copyright (c) 2012 Bashlinux +@license: GPL +''' + +import usb.core +import usb.util +import serial +import socket + +from escpos import * +from constants import * +from exceptions import * + +class Usb(Escpos): + """ Define USB printer """ + + def __init__(self, idVendor, idProduct, interface=0, in_ep=0x82, out_ep=0x01): + """ + @param idVendor : Vendor ID + @param idProduct : Product ID + @param interface : USB device interface + @param in_ep : Input end point + @param out_ep : Output end point + """ + self.idVendor = idVendor + self.idProduct = idProduct + self.interface = interface + self.in_ep = in_ep + self.out_ep = out_ep + self.open() + + + def open(self): + """ Search device on USB tree and set is as escpos device """ + self.device = usb.core.find(idVendor=self.idVendor, idProduct=self.idProduct) + if self.device is None: + print "Cable isn't plugged in" + + if self.device.is_kernel_driver_active(0): + try: + self.device.detach_kernel_driver(0) + except usb.core.USBError as e: + print "Could not detatch kernel driver: %s" % str(e) + + try: + self.device.set_configuration() + self.device.reset() + except usb.core.USBError as e: + print "Could not set configuration: %s" % str(e) + + + def _raw(self, msg): + """ Print any command sent in raw format """ + self.device.write(self.out_ep, msg, self.interface) + + + def __del__(self): + """ Release USB interface """ + if self.device: + usb.util.dispose_resources(self.device) + self.device = None + + + +class Serial(Escpos): + """ Define Serial printer """ + + def __init__(self, devfile="/dev/ttyS0", baudrate=9600, bytesize=8, timeout=1): + """ + @param devfile : Device file under dev filesystem + @param baudrate : Baud rate for serial transmission + @param bytesize : Serial buffer size + @param timeout : Read/Write timeout + """ + self.devfile = devfile + self.baudrate = baudrate + self.bytesize = bytesize + self.timeout = timeout + self.open() + + + def open(self): + """ Setup serial port and set is as escpos device """ + self.device = serial.Serial(port=self.devfile, baudrate=self.baudrate, bytesize=self.bytesize, parity=serial.PARITY_NONE, stopbits=serial.STOPBITS_ONE, timeout=self.timeout, dsrdtr=True) + + if self.device is not None: + print "Serial printer enabled" + else: + print "Unable to open serial printer on: %s" % self.devfile + + + def _raw(self, msg): + """ Print any command sent in raw format """ + self.device.write(msg) + + + def __del__(self): + """ Close Serial interface """ + if self.device is not None: + self.device.close() + + + +class Network(Escpos): + """ Define Network printer """ + + def __init__(self,host,port=9100): + """ + @param host : Printer's hostname or IP address + @param port : Port to write to + """ + self.host = host + self.port = port + self.open() + + + def open(self): + """ Open TCP socket and set it as escpos device """ + self.device = socket.socket(socket.AF_INET, socket.SOCK_STREAM) + self.device.connect((self.host, self.port)) + + if self.device is None: + print "Could not open socket for %s" % self.host + + + def _raw(self, msg): + """ Print any command sent in raw format """ + self.device.send(msg) + + + def __del__(self): + """ Close TCP connection """ + self.device.close() + + + +class File(Escpos): + """ Define Generic file printer """ + + def __init__(self, devfile="/dev/usb/lp0"): + """ + @param devfile : Device file under dev filesystem + """ + self.devfile = devfile + self.open() + + + def open(self): + """ Open system file """ + self.device = open(self.devfile, "wb") + + if self.device is None: + print "Could not open the specified file %s" % self.devfile + + + def _raw(self, msg): + """ Print any command sent in raw format """ + self.device.write(msg); + + + def __del__(self): + """ Close system file """ + self.device.close() diff --git a/setup.py b/setup.py new file mode 100755 index 0000000..4388292 --- /dev/null +++ b/setup.py @@ -0,0 +1,29 @@ +#!/usr/bin/python + +from distutils.core import setup + +setup( + name='escpos', + version='2.7', + url='http://code.google.com/p/python-escpos', + download_url='http://python-escpos.googlecode.com/files/python-escpos-1.0.zip', + description='Python library to manipulate ESC/POS Printers', + license='GNU GPL v3', + long_description=open('README').read(), + author='Manuel F Martinez', + author_email='manpaz@bashlinux.com', + platforms=['linux'], + packages=[ + 'escpos', + ], + package_data={'': ['COPYING']}, + classifiers=[ + 'Development Status :: 1 - Alpha', + 'License :: OSI Approved :: GNU GPL v3', + 'Operating System :: GNU/Linux', + 'Intended Audience :: Developers', + 'Programming Language :: Python', + 'Topic :: System :: Pheripherals', + 'Topic :: Software Development :: Libraries :: Python Modules', + ], +) From f1d7afded2f042febf5a70526580b4a9d126d03a Mon Sep 17 00:00:00 2001 From: Davis Goglin Date: Thu, 22 Aug 2013 08:42:31 -0700 Subject: [PATCH 10/34] minor cleanup --- .hgignore | 10 ------- README | 89 ------------------------------------------------------- 2 files changed, 99 deletions(-) delete mode 100644 .hgignore delete mode 100644 README diff --git a/.hgignore b/.hgignore deleted file mode 100644 index aa3937a..0000000 --- a/.hgignore +++ /dev/null @@ -1,10 +0,0 @@ -# python temporary files -syntax: glob -*.pyc - -# editor autosaves -$~ - -# temporary data -syntax: regexp -temp diff --git a/README b/README deleted file mode 100644 index a60323e..0000000 --- a/README +++ /dev/null @@ -1,89 +0,0 @@ -ESCPOS -====== - -Python library to manipulate ESC/POS Printers. - ------------------------------------------------------------------- -1. Dependencies - -In order to start getting access to your printer, you must ensure -you have previously installed the following python modules: - - * pyusb (python-usb) - * PIL (Python Image Library) - ------------------------------------------------------------------- -2. Description - -Python ESC/POS is a library which lets the user have access to all -those printers handled by ESC/POS commands, as defined by Epson, -from a Python application. - -The standard usage is send raw text to the printer, but in also -helps the user to enhance the experience with those printers by -facilitating the bar code printing in many different standards, -as well as manipulating images so they can be printed as brand -logo or any other usage images migh have. - -Text can be aligned/justified and fonts can be changed by size, -type and weight. - -Also, this module handles some hardware functionalities like, cut -paper, carrier return, printer reset and others concerned to the -carriage alignment. - ------------------------------------------------------------------- -3. Define your printer - -Before start create your Python ESC/POS printer instance, you must -see at your system for the printer parameters. This is done with -the 'lsusb' command. - -First run the command to look for the "Vendor ID" and "Product ID", -then write down the values, these values are displayed just before -the name of the device with the following format: - - xxxx:xxxx - -Example: - Bus 002 Device 001: ID 1a2b:1a2b Device name - -Write down the the values in question, then issue the following -command so you can get the "Interface" number and "End Point" - - lsusb -vvv -d xxxx:xxxx | grep iInterface - lsusb -vvv -d xxxx:xxxx | grep bEndpointAddress | grep OUT - -The first command will yields the "Interface" number that must -be handy to have and the second yields the "Output Endpoint" -address. - -By default the "Interface" number is "0" and the "Output Endpoint" -address is "0x82", if you have other values then you can define -with your instance. - ------------------------------------------------------------------- -4. Define your instance - -The following example shows how to initialize the Epson TM-TI88IV -*** NOTE: Always finish the sequence with Epson.cut() otherwise - you will endup with weird chars being printed. - - from escpos import * - - """ Seiko Epson Corp. Receipt Printer M129 Definitions (EPSON TM-T88IV) """ - Epson = escpos.Escpos(0x04b8,0x0202,0) - Epson.text("Hello World") - Epson.image("logo.gif") - Epson.barcode - Epson.barcode('1324354657687','EAN13',64,2,'','') - Epson.cut() - ------------------------------------------------------------------- -5. Links - -Please visit project homepage at: -http://repo.bashlinux.com/projects/escpos.html - -Manuel F Martinez - From 5617571f310581793267117019669617851b591c Mon Sep 17 00:00:00 2001 From: freeyoung Date: Fri, 14 Mar 2014 01:46:24 +0800 Subject: [PATCH 11/34] tab -> spaces --- escpos/printer.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/escpos/printer.py b/escpos/printer.py index 4b2088b..640c3f4 100644 --- a/escpos/printer.py +++ b/escpos/printer.py @@ -31,7 +31,7 @@ class Usb(Escpos): self.interface = interface self.in_ep = in_ep self.out_ep = out_ep - self.open() + self.open() def open(self): From 442e523956f982765854c5dc8118f6872c45b011 Mon Sep 17 00:00:00 2001 From: freeyoung Date: Fri, 14 Mar 2014 01:48:12 +0800 Subject: [PATCH 12/34] fix README path --- setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index 4388292..27197d0 100755 --- a/setup.py +++ b/setup.py @@ -9,7 +9,7 @@ setup( download_url='http://python-escpos.googlecode.com/files/python-escpos-1.0.zip', description='Python library to manipulate ESC/POS Printers', license='GNU GPL v3', - long_description=open('README').read(), + long_description=open('README.md').read(), author='Manuel F Martinez', author_email='manpaz@bashlinux.com', platforms=['linux'], From b68b3dc6c0768f96de5446d795f6447f19b91f1d Mon Sep 17 00:00:00 2001 From: freeyoung Date: Fri, 14 Mar 2014 01:51:14 +0800 Subject: [PATCH 13/34] import Image from PIL, or Pillow --- escpos/escpos.py | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/escpos/escpos.py b/escpos/escpos.py index 85be2e3..3389c93 100644 --- a/escpos/escpos.py +++ b/escpos/escpos.py @@ -6,11 +6,11 @@ @license: GPL ''' -import Image import qrcode import time import os import operator +from PIL import Image from constants import * from exceptions import * @@ -37,7 +37,7 @@ class Escpos: i = 0 cont = 0 buffer = "" - + self._raw(S_RASTER_N) buffer = "%02X%02X%02X%02X" % (((size[0]/size[1])/8), 0, size[1], 0) self._raw(buffer.decode('hex')) @@ -135,7 +135,7 @@ class Escpos: break elif im_color > (255 * 3 / pattern_len * pattern_len) and im_color <= (255 * 3): pix_line += im_pattern[-1] - break + break pix_line += im_right img_size[0] += im_border[1] @@ -177,9 +177,9 @@ class Escpos: self._raw(BARCODE_TXT_BTH) elif pos.upper() == "ABOVE": self._raw(BARCODE_TXT_ABV) - else: # DEFAULT POSITION: BELOW + else: # DEFAULT POSITION: BELOW self._raw(BARCODE_TXT_BLW) - # Type + # Type if bc.upper() == "UPC-A": self._raw(BARCODE_UPC_A) elif bc.upper() == "UPC-E": @@ -202,7 +202,7 @@ class Escpos: else: raise exception.BarcodeCodeError() - + def text(self, txt): """ Print alpha-numeric text """ if txt: From 9f7e5861cd00e85556bae077eebaf8445e239b07 Mon Sep 17 00:00:00 2001 From: freeyoung Date: Fri, 14 Mar 2014 01:58:55 +0800 Subject: [PATCH 14/34] adjust import order and fix `qr` method --- escpos/escpos.py | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/escpos/escpos.py b/escpos/escpos.py index 3389c93..ed9b3d3 100644 --- a/escpos/escpos.py +++ b/escpos/escpos.py @@ -6,9 +6,9 @@ @license: GPL ''' -import qrcode -import time import os +import time +import qrcode import operator from PIL import Image @@ -141,15 +141,15 @@ class Escpos: self._print_image(pix_line, img_size) - def qr(self,text): + def qr(self, text): """ Print QR Code for the provided string """ qr_code = qrcode.QRCode(version=4, box_size=4, border=1) qr_code.add_data(text) qr_code.make(fit=True) qr_img = qr_code.make_image() - im = qr_img._img.convert("RGB") # Convert the RGB image in printable image - self._convert_image(im) + im = qr_img._img.convert("RGB") + self.image(im) def barcode(self, code, bc, width, height, pos, font): """ Print Barcode """ From 6a4fbc191fea62f07e25a58f077ec74ab3967f7e Mon Sep 17 00:00:00 2001 From: freeyoung Date: Fri, 14 Mar 2014 02:05:41 +0800 Subject: [PATCH 15/34] add Chinese support via cp936 --- escpos/escpos.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/escpos/escpos.py b/escpos/escpos.py index ed9b3d3..c5457b9 100644 --- a/escpos/escpos.py +++ b/escpos/escpos.py @@ -206,7 +206,7 @@ class Escpos: def text(self, txt): """ Print alpha-numeric text """ if txt: - self._raw(txt) + self._raw(txt.encode('cp936')) else: raise TextError() From 0590ec90a28c8072dfd413398da10c9201e4c1fe Mon Sep 17 00:00:00 2001 From: freeyoung Date: Fri, 14 Mar 2014 02:09:10 +0800 Subject: [PATCH 16/34] use my own examples --- README.md | 21 ++++++++++----------- 1 file changed, 10 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index c912612..f4367a6 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ In order to start getting access to your printer, you must ensure you have previously installed the following python modules: * pyusb (python-usb) - * PIL (Python Image Library) + * PIL (Python Image Library) or Pillow (recommended) 2. Description ------------------------------------------------------------------ @@ -69,16 +69,15 @@ The following example shows how to initialize the Epson TM-TI88IV *** NOTE: Always finish the sequence with Epson.cut() otherwise you will endup with weird chars being printed. - from escpos import * - - """ Seiko Epson Corp. Receipt Printer M129 Definitions (EPSON TM-T88IV) """ - Epson = escpos.Escpos(0x04b8,0x0202,0) - Epson.text("Hello World") - Epson.image("logo.gif") - Epson.fullimage("a.really.large.image.png") - Epson.barcode - Epson.barcode('1324354657687','EAN13',64,2,'','') - Epson.cut() + from escpos import printer + + p = printer.Usb(0x04b8, 0x0202) + p.text("Hello World") + p.image("logo.gif") + p.fullimage("a.really.large.image.png") + p.barcode('1324354657687','EAN13',64,2,'','') + p.qr('this is a piece of code') + p.cut() 5. Links ------------------------------------------------------------------ From 8c115bce27656be6dcbcd8971839878cf4ed2e38 Mon Sep 17 00:00:00 2001 From: freeyoung Date: Fri, 14 Mar 2014 02:20:57 +0800 Subject: [PATCH 17/34] use doge.jpg as the example of p.image --- README.md | 2 +- doge.jpg | Bin 0 -> 8795 bytes 2 files changed, 1 insertion(+), 1 deletion(-) create mode 100644 doge.jpg diff --git a/README.md b/README.md index f4367a6..0dc4f5c 100644 --- a/README.md +++ b/README.md @@ -73,7 +73,7 @@ The following example shows how to initialize the Epson TM-TI88IV p = printer.Usb(0x04b8, 0x0202) p.text("Hello World") - p.image("logo.gif") + p.image("doge.jpg") p.fullimage("a.really.large.image.png") p.barcode('1324354657687','EAN13',64,2,'','') p.qr('this is a piece of code') diff --git a/doge.jpg b/doge.jpg new file mode 100644 index 0000000000000000000000000000000000000000..555d7d73ec9a7cf5f295be753ca16c77c416a75a GIT binary patch literal 8795 zcmbVxcQ{<%_wE@+7hQBwMs(3j^oTNQh#Ewq1QAAw8ltx`+K3T7I?+NfTJ-2dbffp^ z1`!hB=hMFBd4Bgk_qpfnzvirS_TFpl^{#ilb2WXn1W;(ILDc{d2mnCWH*hrzr~ric z_yqWPgaiZxL_~zdq%=23Nk~W;sHn+lSQu}yvM@3;vq6No**F9^nVET{cm;$-#KpyL zam&a{i^>U!iHlyf0VIUL6>tRtQ36+8z^&_#}^mIA;5 z;o{*oNN5|4^qL>Zr2|0w~78;xjiVh$nay{dLvgRh4WF>Ch_BI28L z^bCw#x4C(E`NSn8rKDx!6O&WZGnnO- z)wT7F&2L-V*rVf<@25Y`&VOEE0Kz}qrU?A_$&(BJzYPAER;*X8Z`t-;@30yt9ewd} zt6Iw;AM5xpH&SZ#5+YLU17;t5m`6O>_R;%{dd)wUW}3A7W5n6KNz!$XM7TepGcq=E z5P7G6pm(1@S(Qfre;K~nojb+m?T@sl8Uyl2&zc@Kp?(|aL(KEd))aXK2xo|Mv=JUn z3CaztBs7OpF)!npXL`VVb~>_;yzCJ2HD$%fCbXVl$4drIAffbe@Lw}nWVNnXLTl9y ze}wJr-I3^07932m3ol35Cm(AbSz^PLhZStXnU9apT=qR+@&{d&6p|%OQJjr6vFsm? zoBMG1yQ9~u$if-Sj?ABDz*H+j+aCQsEiagN{JE-r1rXsUx=wm8(>+OuGq8Ky#Nw** zRGIw)P*MF~zC6AH!ftv~`rrOqZYMS~ry{VT%7a^CULwVbPr%Uruv<-+P@40@l(>^3 z#W(Lp)t|81rs!OMKyx!sNEsB|PQXlY!#$AX`@H6{R_ozus{qmogV$c$nD~QQ&i*#9 zyOBGCGLV6!5&1Q-@TXs0FZr>t9XqH?^245k3l+~$x&Dy*V{Fp%;z0={fP1l?48!*O zpR5d{&L@Lr-=-9?g0(0WZ`o(igZ<(Au>y$t7q^=Gp+b`DU^}Mb3Uc!hXW7*|;or4< z@?TB}RMa#T*>Q22_GGh;-jx-0$zS7bTS`0lud`D@zAQIX;V(3LAR)ps_=Ap)&fsHr zz2oZ%&Vz1Y!WY7AOTh^1rv9Z1@7!%;zk>MK3mJQ^jjF<&h>bz*{yQ&*SH6a`Seouz zy&k+*?!{vzJnNuf;p2~XJw@|VAU zT>fwzhT1&|Zh7D>vY~Sp3cEaBa zv627$pU2oekQ#RT;~A`i=@nFHvmX76*|jHgaO^|a69CHAm*L$lJ;XSXwv|O3+2Lo` z?EOP*=EmJg%)aphES~8C)C^#!)isT6fbg(qDsKroucMDIW@q-B`yQzthmiB?-M56d z^6WJUeu0c9+^d_!Dn;B&e5Wd^G28`;Gm91o=!5*I(EYVMoFdt9`(vTib|cHlQFKMR zR>RTgRyUz&cYERocR!B?w7rD(Rx9<%z)Sc*m%^>d`OGw^rxrn-LpMIHKZ-r_VK3M( zYf2EN!12g&tR*k+%;Q0$&Tx!Pu@0;m)B%EMOHpTOfqJ(P6EYVMvG`2U)_M_Nhojbw zO}~G;S5I(oqnC{Qv68|&!@xt-g~}C>`}7J({uOxm-djQFEGe*Ho-495T40}r3(g-o zv2>dk-%z1PzaF1~TiO`q`~ilD7E}&_1&QxH9VDyXPH+3?X6BL z`mM=82*zbmrf}JOz_h~LMJziZNGv{mHtmG?KTd64mXEXZdVM`g`bjiN9|S?Guha+0 z0&p{?lFq6(P0mu^JDjpo#A&=75_@RgP`j0bPcAAK<{-M*0%~qkG9bZQVGU{)iEstcTB(1sbXj0|%7K*ieUL7;DRuD9HDBZF30_q) zfdI{M%}1W`vft_tf8m`bIj@~(W9Xcno4n+jRRo%<;sPgZm;-iC+ea$ybd9Kxhqkaa z>s#gx!Ca4OwsB+w;1Yw6OKJ^muK)@+Or0DZc(MiW@cXAO0~NVPcGXa3xKU!5CL!Aq zp`11P-_EVjv%;1-{>*b|ycz3V>7*IFhDO`P@w@t3DLgy35y*juB3$z%sah*!9bqM`%KqT9N06T|CmR)^G(#zEq`e%bGWuC# zh#9rs*r+*2Q?ype+wQ?tW^4Hfxg&4!((sw%=T<{*up)~gd#BT;;uY_R#X-vR3J_m< zJV{b;(wM~NrCjZioJ`>vxn_MP>_XKGTifn09UqwKDQok*&V2?!OEAc;hL1V^QSDAe)#A@taapiDW{PakDY_tyJBFPf-mDkOC z2E^Qt8n*XeRkd9NU2~b~T=>R?mi$7F8$m?PjLY8Ur+YuVPs@VKoZHuqdwmH-a&S2} z-7d@E)1x(|EaY0~G4TP1y|TSATYYZTTZ2eG&!BuT*OSq%;f!7)C zrAT=}yON&X%1;L?@O`Z$o91A5G`u7ga0R3g@JZP^pU3#&{R^&XJ1;~d7Iw5J<)AmF zW);yA=IK%UtfIGip^Q8UsB?I@c90wTwXp0D+OkXV(~Gvqsr`z)mB?f3Nup=xTgi zvSJk~!W4YhCqhtxX~OI3%Nd~_B(fnvcikx*H@R-?y<3nBS0@m69_=jkZ>d8XY7WF zo2P-Sa@@sEH;OQ`&#U>)5ib5=lu>!c-YF^bH5?ypTvqULHsL3|_7UqO?E>!ayzce3 z2iaMdN$=BBs9O`3T)VC^;91I~yLqqIe!DthnT@Nm$%D3v^(XYU%oNhO!zMn6hmyad zyn4jSZcxeYf!~nonq+;h>g{725Ak`lyf1<>q!EDtHF3Cg+c zV9G0!1xB>io85ZP-KAyv^MuH6Ny#v?uHO$WEPzzw>hpx z!OaZ9_^dszL8R~qvZ6wSGnt??s~;KdE;n7ri?#ueVng)FnCm_WG@Q^K*%l-63^n$D*pQ|e5a(H zo7FIc!} zr?>WCFA3{w)GaNDZT3SdL>#Kz%6>od zczUk)bM#RjktiNR8~exMyCSDOzSsEp$Dn0id4^7QUW=3Ir)264pD<^pdKaSh%GQ3| zBz@*lJC=Nftl(8~KCI}>aeb_uJ$~rcmVmNvR};0<`*6#5RmM!gw>YKp^+adQ2V|p( z)xxLMnPe&OeT=|Wr$7?sGdS?h4KEwrxg1GHh2*mkj$YGiaZ1O9}KGKa8J&+$ZYVVu29Vv zNsYY~zSifYAQ2ZA%D1^eo9yoHMd<8r(QY{x5-Dxj6fZVMcMpWtYHC~G;782Q7&ydz z8)mql{ucFgm~O);X<%7=G2%usDnw9Er=i|NIO=5f`zMsj2Ki!{TMh}ON{w$NJ(;q- zl2Rq?kh|08Z~vN*AkT{?H#(^x*A=8*2ZtZu$JsVn(u06}4RMC!x$x!Y?K3_IuV5N~BZ z+qeRZ#}}a!FU#+)`~QmhUROhvtInK`xwj%iH^AzYSo>ktVmUuabgKER6e~JBXekxV zhP);5?iqYxCMX%&Uvh-K4HyfAzagTA+{9@LBzXN*#Bw1Z<@2PgncD2NQRy3PP`Jb8 zv(1h3V0lC5Zk<=Qm~sT8={ROX@}sQ@)cW^Qf~4e&S>$>&=-yft8!3_x+A_W9pdlC4 z`cf`B`%X03?moi#T)p4tMMmP$61A0fq-o61!vtG(?RNfaX**$%GOXk%`^3;BN3gl6f`16)}=_%X<0Ss5+jlj!{n3eo1gg=r=}W@ zbd9{(D@fGu5IDif&xP~HoTV06S)IM^d@$ym-`w<7LN>riAn(@{2ZuMCeB2~=P}g1? zIBo8*C;Ft7&cSv2=lx6P<_u9ZIdxp|>POP}K?)7F%)c4bmjDyb%<)qc-ITj||5ITB z1+Ct;AWa51{~eh*va!$*y=$VNl(y6LlQnrcReWX_GWp%Kyr`}rja+fJ>hh%VY^ouYHGiPy^(yg^Rh@+SYaaW*}(y9kBara*CD2#UG)J}1|nOvM0Eig_8-Pv9({q$xNL^LD3LzO=Z~hA zy%oP=ITSi>yIKzQqaF`lVuZODrnZyBszQloOmmJ)@m}5< zTJyjxaA%!PnOCv&8OAnOrjs-X>w>`1ACdiu11DCyziymZk%rEvl2R@7pT5eU1DhJj zs=e0V5Xf*F*7MIc%!Pj$U!LSTYORKqIlE za3|oRS%`2YHvFbSuYhH-Go50GM(s<_%hd8kC>Z8ZpL%l}hE#iz*)1a~MFF*gEG1b< zl2k=zBCOXqIuc_{2cIbl8>`LQr$`wo_R|(iFUXWz*1e@>^bn6j?aR$8%pD|Ng&ynR?#ZKNw8PNApJtdrtMP|#)u ztRccEq;X%B1s`ez_yzGnA+|n7PmxLowW*pbA~l&qNHS4im0Li%TO;;%J&NB9uQGY# z$rt8P;4mbAb$za^y)FdT2B|FlN7Hca{E8@)$RiA9W)E#~zm(8OgMzn*f&MX0(7W%< zHW1V6;0#|pLN5?t!7Y-bFCd@B_P;*tlKfg{J44^)O&L0piy{>Z5lN8oJR#(c*k0g| z@wG`KdLZYn)}B0$2q9bwkr{&iSu~9UGDJV6k~sfHmGcc(bvt+>VR9$#K?tNfJyh=hi8q{HXs>fP9t|(W=>`BA`^t-aKz82 z8`y5Lxlc35x=YzGrN~C!DQXyb&9S&OC6&}i_KBjkM(nN9@yhSHuZ1J!T~_vOY=;Ps zgo&OD%`^37c>`?iOl_~6l$!?+wU&q;hdq0=tXT?`l!1yzO$HUT!kv7knyJ*MLh!=z zFQzXqC)${ppiK40hF&QIFYj@-vocyLYS$$S3MTZi8;WX)*=%?bi|)IPkSpN>v{nBn z;ABfIM8i!YG+0K&RM`!BHGUO2a&i`d=W={zT*;pS-;~dP;n=rrvkiMcYJj^lf4A zq1xG;dwGa@J%mD;?V_sULKfRyo{Kq)E^NV)|J?Ddw)0&Q(ZxCwaUT#Pr9d^5sJT)^ z)*YP*&q|^lLHY2Zh4f;j4H=wudfF$NceC=`5v8PVy_HW6Tlbg(aPwJt#yA^;I4UtO z)cV|M)>G;Ctb1Vhf;`%nOj@@dmB%#{%x?SH4SGv@6SeR@%p>0*l(|k9Ff*kI&wD?Y z^1>a-J-34Gn<*pwZyW`mnHfrg+W9nw38jC~y8pd>o@@E?#n34^)ih76p!fmh;vheA0~X?aWgeS+pZ4bF=j^wx-6K zotyd)OZM@SJfAh?>lcm`to)!J<-AD0URU+9WByeo_RF{0vEfL}UR|7+v zUEwhKntkNpWz5Ns zL)>C&wCr?6w*V2i>L*zToIm?od#7%{0#5iG0?&jZuYl;%G+0Cp3*&Ny_$O+es?3Bu zsMGUA5sT0eLtI3V+b;h#_5BmuI!AIGYU8P!=zCKhs#{j`Qz-PgvHeoKp_9B|F6&ShmIDd>zs|P z+~6%hI!HK+-Y}x6B60be=+aM@patZkZ@naCe%AE2^&jt)1u%B6j2U4`$9k$|KPlf1 z+9&WMG3Dfr%N7;h92=vpx?X@37N5}NHS<{_H(cg{V+tAVxG-rI>fsmHHi}miHynJN z4ARXGD-z#Z2sp{_y^*34coI(fjXoHuD;l8l{O@k$xYG$H__?d96RhzV3VHG#jt_+# z0?ZrDkH08k1EXDpTDZSq5U9rdgDZfloNw982GtJ5;Z>0YB><}gF1kx3T0|oqx83qKNEV&To-(CSZH?UE|ubr=N z(b^fa6QHtO8F{-lX)yNX*;8&udY^H%)oe9m*0WXk_Fs-)xxCF#(X9A1M}=jEalZ&w zq{Ee$jN~y*Nsa*Z9<921bQ5t0Detm{Fq!+5@2$kqb0{VDFoqjG5C(9AfK}Rool8>l zO#No)J1A@BN|;iqySJ~2hT{60Z)6PgPh4=__YBDU@zj^&87-_HtK^)eK(ke`L^0mU zZ1^O(c|y)>;K(*U%}xF$=DpiZ#DA@cC%5XmIgHzQtoDuB8gkJyU4`cHQ-@6?n|bkU zEmBgjm$0%OLU|ovqn9mcB(~fpX)sk3LRb)H3zjvDB%V$rG*D(+!vVej@pA%|dYa@j z*27Ysx1b|6lP^-HmANQwSr9=qO}6WSFjnl0VG2;Zb`pDS{6K8Y*)vWz8DAQW&1~am z3N!z5((3mivAt`(K#tvG(>HMDG%a>`zTsGuEyl&8=jYsJc2nFrOE_&x<(Y>DRu_eF zskLF5&vE@lpUl^pV{Aa2mB$uG#6nb|*N=@4ZZS8?{+x#6-=(MEDGgfhwZ<9FBQ^4I zx8PZJ@=(HVM#`z}!0d~AZss(1|MZ;NcgagM5sHvpOJ1WA6)j2%wdA7FH}hMJ7PlfZ zKmR#g;%FVtGNQv{oWL{i;&FwVIx*3j--N6pRSWu=i=1NN7f+I|YGqG9#$h5T=Q`e- z-q#Q7g%LShO)}kU9Cr7(kx~J>%J=ys_hr?HlTkY4llVJVIuaw46Q${F?RiYkGV5av%oznif)jj~CVci_LSE27 zxAj%0fV8juxgU;Z@pTyvzg@(_``1Jn8^9Ep+0QT-jcYp=`6-{-i=Cc^&=!EMm0NbnM-@Eo#)Pd~|=3*CtF28%-!6g%6Wd)Q{>>`O$C%oISi``FI5+ z;GH%s?=9}MR@d@Uf9aWDZ1wWGnC@1<=3Ua-|JG}fxdPgIu7IcN7kpoSX8U_w0ip4i z9W{!}<_;;0il;8+z7@|8(LXx_%Pi38$1Y6CmJdS_Pt}zd(;D9S;C5uud8Vk3?6GB9 zG!C~7@KH7C&M>2JnV&Gb2k5-KhJD)XSAxx$SX4T{(kQfXr!Nin_DNLbV3D-38S72( zW)ZHU=yXd9daP`%u`y{NT$qU16sbY{K9B1y5_mua2?E_NomY9USKKDJ|E~6fP9-np zL7Gj*F8HFV5}=L{U&XAsYAh7vb9H1*4=dsG-s<_=_#_d&lRV2I>;9g+~Bwf#Wbvgz_IJ=MCEtovK3ZmDF6|IgYMdOH?vdU{_ue5k9h8xP{lj6&tdQ%1^6Bw+ z=lz-(DYzQlj~3mv)I5;L Date: Fri, 14 Mar 2014 08:33:09 -0700 Subject: [PATCH 18/34] Update README.md Make code description consistent with code. --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0dc4f5c..60f9191 100644 --- a/README.md +++ b/README.md @@ -65,8 +65,9 @@ with your instance. 4. Define your instance ------------------------------------------------------------------ -The following example shows how to initialize the Epson TM-TI88IV -*** NOTE: Always finish the sequence with Epson.cut() otherwise +The following example shows how to initialize a printer over USB. + +*** NOTE: Always finish the sequence with cut otherwise you will endup with weird chars being printed. from escpos import printer From 417476030e87ab42942262c49e7ceba3f6afaf90 Mon Sep 17 00:00:00 2001 From: Davis Goglin Date: Fri, 14 Mar 2014 09:05:47 -0700 Subject: [PATCH 19/34] we probably want to send all the data --- escpos/printer.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/escpos/printer.py b/escpos/printer.py index 640c3f4..73f624b 100644 --- a/escpos/printer.py +++ b/escpos/printer.py @@ -129,7 +129,7 @@ class Network(Escpos): def _raw(self, msg): """ Print any command sent in raw format """ - self.device.send(msg) + self.device.sendall(msg) def __del__(self): From fa8d961e6d5ae14e424a4d15cc5a7a940673ed53 Mon Sep 17 00:00:00 2001 From: Davis Goglin Date: Fri, 14 Mar 2014 09:17:32 -0700 Subject: [PATCH 20/34] google code revision ef4c58851474 (Added quad-area characters) --- escpos/constants.py | 1 + escpos/escpos.py | 16 ++++++++-------- 2 files changed, 9 insertions(+), 8 deletions(-) diff --git a/escpos/constants.py b/escpos/constants.py index c39f6ce..b5fca55 100644 --- a/escpos/constants.py +++ b/escpos/constants.py @@ -20,6 +20,7 @@ PAPER_PART_CUT = '\x1d\x56\x01' # Partial cut paper TXT_NORMAL = '\x1b\x21\x00' # Normal text TXT_2HEIGHT = '\x1b\x21\x10' # Double height text TXT_2WIDTH = '\x1b\x21\x20' # Double width text +TXT_4SQUARE = '\x1b\x21\x30' # Quad area text TXT_UNDERL_OFF = '\x1b\x2d\x00' # Underline font OFF TXT_UNDERL_ON = '\x1b\x2d\x01' # Underline font 1-dot ON TXT_UNDERL2_ON = '\x1b\x2d\x02' # Underline font 2-dot ON diff --git a/escpos/escpos.py b/escpos/escpos.py index c5457b9..c79bea4 100644 --- a/escpos/escpos.py +++ b/escpos/escpos.py @@ -214,17 +214,17 @@ class Escpos: def set(self, align='left', font='a', type='normal', width=1, height=1): """ Set text properties """ # Width - if width == 2 and height != 2: - self._raw(TXT_NORMAL) - self._raw(TXT_2WIDTH) - elif height == 2 and width != 2: + if height != 2 and width != 2: # DEFAULT SIZE: NORMAL self._raw(TXT_NORMAL) + + if height == 2: self._raw(TXT_2HEIGHT) - elif height == 2 and width == 2: + if width == 2: self._raw(TXT_2WIDTH) - self._raw(TXT_2HEIGHT) - else: # DEFAULT SIZE: NORMAL - self._raw(TXT_NORMAL) + + if height == 2 and width == 2: + self._raw(TXT_4SQUARE) + # Type if type.upper() == "B": self._raw(TXT_BOLD_ON) From 4795664cbe282476a9d1c6293eddb9989f8f332c Mon Sep 17 00:00:00 2001 From: Davis Goglin Date: Fri, 14 Mar 2014 10:01:15 -0700 Subject: [PATCH 21/34] Reformatted and added more sections --- README.md | 67 ++++++++++++++++++++++++++++++++++++++++--------------- 1 file changed, 49 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 60f9191..0b8901a 100644 --- a/README.md +++ b/README.md @@ -3,16 +3,7 @@ ESCPOS Python library to manipulate ESC/POS Printers. -1. Dependencies ------------------------------------------------------------------- - -In order to start getting access to your printer, you must ensure -you have previously installed the following python modules: - - * pyusb (python-usb) - * PIL (Python Image Library) or Pillow (recommended) - -2. Description +Description ------------------------------------------------------------------ Python ESC/POS is a library which lets the user have access to all @@ -32,11 +23,50 @@ Also, this module handles some hardware functionalities like, cut paper, carrier return, printer reset and others concerned to the carriage alignment. -3. Define your printer + +Dependencies ------------------------------------------------------------------ +In order to start getting access to your printer, you must ensure +you have previously installed the following python modules: + + * pyusb (python-usb) + * PIL (Python Image Library) or Pillow (recommended) + + +Feature List +------------------------------------------------------------------ + + * Support for the following interfaces + * USB + * Serial + * Network + * File + + * Commands include + * Text and image positioning + * Text formatting + * Opening cash drawers + * Full/Partial cuts + * Barcodes and QR Codes + * Images and image scaling + * Chinese character support + +TODO +------------------------------------------------------------------ + + * Testing + * Possibly a virtual printer in the far future + * Provide install instructions + * Provide API documentation + +USB Quickstart +------------------------------------------------------------------ + +### Find your printer ### + Before start create your Python ESC/POS printer instance, you must -see at your system for the printer parameters. This is done with +see at your system for the printer parameters. On Linux this is done with the 'lsusb' command. First run the command to look for the "Vendor ID" and "Product ID", @@ -62,13 +92,12 @@ By default the "Interface" number is "0" and the "Output Endpoint" address is "0x82", if you have other values then you can define with your instance. -4. Define your instance ------------------------------------------------------------------- +### Define a printer instance and send commands ### The following example shows how to initialize a printer over USB. *** NOTE: Always finish the sequence with cut otherwise - you will endup with weird chars being printed. + you will end up with weird chars being printed. from escpos import printer @@ -80,11 +109,13 @@ The following example shows how to initialize a printer over USB. p.qr('this is a piece of code') p.cut() -5. Links +Links ------------------------------------------------------------------ -Please visit project homepage at: +Project homepage originally at: + http://repo.bashlinux.com/projects/escpos.html -Manuel F Martinez +By Manuel F Martinez +Forked from https://code.google.com/p/python-escpos/ From 42309fedfe677a41dddeaaab2ad56e499215bfda Mon Sep 17 00:00:00 2001 From: Davis Goglin Date: Fri, 14 Mar 2014 10:32:10 -0700 Subject: [PATCH 22/34] Update README.md Clarify character support --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0b8901a..42dba0f 100644 --- a/README.md +++ b/README.md @@ -50,7 +50,7 @@ Feature List * Full/Partial cuts * Barcodes and QR Codes * Images and image scaling - * Chinese character support + * Chinese character support using CP936 TODO ------------------------------------------------------------------ From ac640785cca487bcfb0b8eff0eec00dee31a4c93 Mon Sep 17 00:00:00 2001 From: Stephan Sokolow Date: Thu, 22 May 2014 00:40:05 -0400 Subject: [PATCH 23/34] Make the structure of the ESC/POS commands less opaque (The commands are intended to be readable by people who grew up with ANSI escape codes so represent them that way in the code) --- escpos/constants.py | 142 ++++++++++++++++++++++++++++---------------- 1 file changed, 90 insertions(+), 52 deletions(-) diff --git a/escpos/constants.py b/escpos/constants.py index b5fca55..11dd3a4 100644 --- a/escpos/constants.py +++ b/escpos/constants.py @@ -1,54 +1,92 @@ """ ESC/POS Commands (Constants) """ -# Feed control sequences -CTL_LF = '\x0a' # Print and line feed -CTL_FF = '\x0c' # Form feed -CTL_CR = '\x0d' # Carriage return -CTL_HT = '\x09' # Horizontal tab -CTL_VT = '\x0b' # Vertical tab -# Printer hardware -HW_INIT = '\x1b\x40' # Clear data in buffer and reset modes -HW_SELECT = '\x1b\x3d\x01' # Printer select -HW_RESET = '\x1b\x3f\x0a\x00' # Reset printer hardware -# Cash Drawer -CD_KICK_2 = '\x1b\x70\x00' # Sends a pulse to pin 2 [] -CD_KICK_5 = '\x1b\x70\x01' # Sends a pulse to pin 5 [] -# Paper -PAPER_FULL_CUT = '\x1d\x56\x00' # Full cut paper -PAPER_PART_CUT = '\x1d\x56\x01' # Partial cut paper -# Text format -TXT_NORMAL = '\x1b\x21\x00' # Normal text -TXT_2HEIGHT = '\x1b\x21\x10' # Double height text -TXT_2WIDTH = '\x1b\x21\x20' # Double width text -TXT_4SQUARE = '\x1b\x21\x30' # Quad area text -TXT_UNDERL_OFF = '\x1b\x2d\x00' # Underline font OFF -TXT_UNDERL_ON = '\x1b\x2d\x01' # Underline font 1-dot ON -TXT_UNDERL2_ON = '\x1b\x2d\x02' # Underline font 2-dot ON -TXT_BOLD_OFF = '\x1b\x45\x00' # Bold font OFF -TXT_BOLD_ON = '\x1b\x45\x01' # Bold font ON -TXT_FONT_A = '\x1b\x4d\x00' # Font type A -TXT_FONT_B = '\x1b\x4d\x01' # Font type B -TXT_ALIGN_LT = '\x1b\x61\x00' # Left justification -TXT_ALIGN_CT = '\x1b\x61\x01' # Centering -TXT_ALIGN_RT = '\x1b\x61\x02' # Right justification -# Barcode format -BARCODE_TXT_OFF = '\x1d\x48\x00' # HRI barcode chars OFF -BARCODE_TXT_ABV = '\x1d\x48\x01' # HRI barcode chars above -BARCODE_TXT_BLW = '\x1d\x48\x02' # HRI barcode chars below -BARCODE_TXT_BTH = '\x1d\x48\x03' # HRI barcode chars both above and below -BARCODE_FONT_A = '\x1d\x66\x00' # Font type A for HRI barcode chars -BARCODE_FONT_B = '\x1d\x66\x01' # Font type B for HRI barcode chars -BARCODE_HEIGHT = '\x1d\x68\x64' # Barcode Height [1-255] -BARCODE_WIDTH = '\x1d\x77\x03' # Barcode Width [2-6] -BARCODE_UPC_A = '\x1d\x6b\x00' # Barcode type UPC-A -BARCODE_UPC_E = '\x1d\x6b\x01' # Barcode type UPC-E -BARCODE_EAN13 = '\x1d\x6b\x02' # Barcode type EAN13 -BARCODE_EAN8 = '\x1d\x6b\x03' # Barcode type EAN8 -BARCODE_CODE39 = '\x1d\x6b\x04' # Barcode type CODE39 -BARCODE_ITF = '\x1d\x6b\x05' # Barcode type ITF -BARCODE_NW7 = '\x1d\x6b\x06' # Barcode type NW7 -# Image format -S_RASTER_N = '\x1d\x76\x30\x00' # Set raster image normal size -S_RASTER_2W = '\x1d\x76\x30\x01' # Set raster image double width -S_RASTER_2H = '\x1d\x76\x30\x02' # Set raster image double height -S_RASTER_Q = '\x1d\x76\x30\x03' # Set raster image quadruple +#{ Control characters +# as labelled in http://www.novopos.ch/client/EPSON/TM-T20/TM-T20_eng_qr.pdf +NUL = '\x00' +EOT = '\x04' +ENQ = '\x05' +DLE = '\x10' +DC4 = '\x14' +CAN = '\x18' +ESC = '\x1b' +FS = '\x1c' +GS = '\x1d' + +#{ Feed control sequences +CTL_LF = '\n' # Print and line feed +CTL_FF = '\f' # Form feed +CTL_CR = '\r' # Carriage return +CTL_HT = '\t' # Horizontal tab +CTL_VT = '\v' # Vertical tab + +#{ Printer hardware +HW_INIT = ESC + '@' # Clear data in buffer and reset modes +HW_SELECT = ESC + '=\x01' # Printer select + +HW_RESET = ESC + '\x3f\x0a\x00' # Reset printer hardware + # (TODO: Where is this specified?) + +#{ Cash Drawer (ESC p ) +_CASH_DRAWER = lambda m, t1='', t2='': ESC + 'p' + m + t1 + t2 +CD_KICK_2 = _CASH_DRAWER('\x00') # Sends a pulse to pin 2 [] +CD_KICK_5 = _CASH_DRAWER('\x01') # Sends a pulse to pin 5 [] + +#{ Paper Cutter +_CUT_PAPER = lambda m: GS + 'V' + m +PAPER_FULL_CUT = _CUT_PAPER('\x00') # Full cut paper +PAPER_PART_CUT = _CUT_PAPER('\x01') # Partial cut paper + +#{ Text format +# TODO: Acquire the "ESC/POS Application Programming Guide for Paper Roll +# Printers" and tidy up this stuff too. +TXT_NORMAL = ESC + '!\x00' # Normal text +TXT_2HEIGHT = ESC + '!\x10' # Double height text +TXT_2WIDTH = ESC + '!\x20' # Double width text +TXT_4SQUARE = ESC + '!\x30' # Quad area text +TXT_UNDERL_OFF = ESC + '\x2d\x00' # Underline font OFF +TXT_UNDERL_ON = ESC + '\x2d\x01' # Underline font 1-dot ON +TXT_UNDERL2_ON = ESC + '\x2d\x02' # Underline font 2-dot ON +TXT_BOLD_OFF = ESC + '\x45\x00' # Bold font OFF +TXT_BOLD_ON = ESC + '\x45\x01' # Bold font ON +TXT_FONT_A = ESC + '\x4d\x00' # Font type A +TXT_FONT_B = ESC + '\x4d\x01' # Font type B +TXT_ALIGN_LT = ESC + '\x61\x00' # Left justification +TXT_ALIGN_CT = ESC + '\x61\x01' # Centering +TXT_ALIGN_RT = ESC + '\x61\x02' # Right justification + +#{ Barcode format +_SET_BARCODE_TXT_POS = lambda n: GS + 'H' + n +BARCODE_TXT_OFF = _SET_BARCODE_TXT_POS('\x00') # HRI barcode chars OFF +BARCODE_TXT_ABV = _SET_BARCODE_TXT_POS('\x01') # HRI barcode chars above +BARCODE_TXT_BLW = _SET_BARCODE_TXT_POS('\x02') # HRI barcode chars below +BARCODE_TXT_BTH = _SET_BARCODE_TXT_POS('\x03') # HRI both above and below + +_SET_HRI_FONT = lambda n: GS + 'f' + n +BARCODE_FONT_A = _SET_HRI_FONT('\x00') # Font type A for HRI barcode chars +BARCODE_FONT_B = _SET_HRI_FONT('\x01') # Font type B for HRI barcode chars + +BARCODE_HEIGHT = GS + 'h' + '\x64' # Barcode Height [1-255] +BARCODE_WIDTH = GS + 'w' + '\x03' # Barcode Width [2-6] + +#NOTE: This isn't actually an ESC/POS command. It's the common prefix to the +# two "print bar code" commands: +# - "GS k NUL" +# - "GS k " +# The latter command supports more barcode types +_SET_BARCODE_TYPE = lambda m: GS + 'k' + m +BARCODE_UPC_A = _SET_BARCODE_TYPE('\x00') # Barcode type UPC-A +BARCODE_UPC_E = _SET_BARCODE_TYPE('\x01') # Barcode type UPC-E +BARCODE_EAN13 = _SET_BARCODE_TYPE('\x02') # Barcode type EAN13 +BARCODE_EAN8 = _SET_BARCODE_TYPE('\x03') # Barcode type EAN8 +BARCODE_CODE39 = _SET_BARCODE_TYPE('\x04') # Barcode type CODE39 +BARCODE_ITF = _SET_BARCODE_TYPE('\x05') # Barcode type ITF +BARCODE_NW7 = _SET_BARCODE_TYPE('\x06') # Barcode type NW7 + +#{ Image format +# NOTE: _PRINT_RASTER_IMG is the obsolete ESC/POS "print raster bit image" +# command. The constants include a fragment of the data's header. +_PRINT_RASTER_IMG = lambda data: GS + 'v0' + data +S_RASTER_N = _PRINT_RASTER_IMG('\x00') # Set raster image normal size +S_RASTER_2W = _PRINT_RASTER_IMG('\x01') # Set raster image double width +S_RASTER_2H = _PRINT_RASTER_IMG('\x02') # Set raster image double height +S_RASTER_Q = _PRINT_RASTER_IMG('\x03') # Set raster image quadruple From b5f68f6895236207355efe6bc92c5b1197948dc2 Mon Sep 17 00:00:00 2001 From: Stephan Sokolow Date: Thu, 22 May 2014 00:45:57 -0400 Subject: [PATCH 24/34] Actually use the barcode height and width parameters (And reverse their order in the method signature so corrections to the range checks don't break existing code) --- escpos/constants.py | 4 ++-- escpos/escpos.py | 10 +++++----- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/escpos/constants.py b/escpos/constants.py index 11dd3a4..487befa 100644 --- a/escpos/constants.py +++ b/escpos/constants.py @@ -65,8 +65,8 @@ _SET_HRI_FONT = lambda n: GS + 'f' + n BARCODE_FONT_A = _SET_HRI_FONT('\x00') # Font type A for HRI barcode chars BARCODE_FONT_B = _SET_HRI_FONT('\x01') # Font type B for HRI barcode chars -BARCODE_HEIGHT = GS + 'h' + '\x64' # Barcode Height [1-255] -BARCODE_WIDTH = GS + 'w' + '\x03' # Barcode Width [2-6] +BARCODE_HEIGHT = GS + 'h' # Barcode Height [1-255] +BARCODE_WIDTH = GS + 'w' # Barcode Width [2-6] #NOTE: This isn't actually an ESC/POS command. It's the common prefix to the # two "print bar code" commands: diff --git a/escpos/escpos.py b/escpos/escpos.py index c79bea4..df74fea 100644 --- a/escpos/escpos.py +++ b/escpos/escpos.py @@ -151,18 +151,18 @@ class Escpos: im = qr_img._img.convert("RGB") self.image(im) - def barcode(self, code, bc, width, height, pos, font): + def barcode(self, code, bc, height, width, pos, font): """ Print Barcode """ # Align Bar Code() self._raw(TXT_ALIGN_CT) # Height - if height >=2 or height <=6: - self._raw(BARCODE_HEIGHT) + if 1 <= height <= 255: + self._raw(BARCODE_HEIGHT + chr(height)) else: raise BarcodeSizeError() # Width - if width >= 1 or width <=255: - self._raw(BARCODE_WIDTH) + if 2 <= width <= 6: + self._raw(BARCODE_WIDTH + chr(width)) else: raise BarcodeSizeError() # Font From 9885deaa5993c9219dfa39e06fd88ed8732f60ad Mon Sep 17 00:00:00 2001 From: Stephan Sokolow Date: Thu, 22 May 2014 00:47:08 -0400 Subject: [PATCH 25/34] Make BarcodeSizeError and BarcodeTypeError display the erroneous value (MUCH more helpful for debugging) --- escpos/escpos.py | 6 +++--- escpos/exceptions.py | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/escpos/escpos.py b/escpos/escpos.py index df74fea..26ec590 100644 --- a/escpos/escpos.py +++ b/escpos/escpos.py @@ -159,12 +159,12 @@ class Escpos: if 1 <= height <= 255: self._raw(BARCODE_HEIGHT + chr(height)) else: - raise BarcodeSizeError() + raise BarcodeSizeError("height = %s" % height) # Width if 2 <= width <= 6: self._raw(BARCODE_WIDTH + chr(width)) else: - raise BarcodeSizeError() + raise BarcodeSizeError("width = %s" % width) # Font if font.upper() == "B": self._raw(BARCODE_FONT_B) @@ -195,7 +195,7 @@ class Escpos: elif bc.upper() == "NW7": self._raw(BARCODE_NW7) else: - raise BarcodeTypeError() + raise BarcodeTypeError(bc) # Print Code if code: self._raw(code) diff --git a/escpos/exceptions.py b/escpos/exceptions.py index caad7a8..f9c7489 100644 --- a/escpos/exceptions.py +++ b/escpos/exceptions.py @@ -34,7 +34,7 @@ class BarcodeTypeError(Error): self.resultcode = 10 def __str__(self): - return "No Barcode type is defined" + return "No Barcode type is defined (%s)" % self.msg class BarcodeSizeError(Error): def __init__(self, msg=""): @@ -43,7 +43,7 @@ class BarcodeSizeError(Error): self.resultcode = 20 def __str__(self): - return "Barcode size is out of range" + return "Barcode size is out of range (%s)" % self.msg class BarcodeCodeError(Error): def __init__(self, msg=""): From 5b1e6348e59648f8cfffad8aa4e70098af572a17 Mon Sep 17 00:00:00 2001 From: Stephan Sokolow Date: Thu, 22 May 2014 00:48:24 -0400 Subject: [PATCH 26/34] Accept "CODABAR" as an alias for "NW7" in barcode() --- escpos/escpos.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/escpos/escpos.py b/escpos/escpos.py index 26ec590..424c31d 100644 --- a/escpos/escpos.py +++ b/escpos/escpos.py @@ -192,7 +192,7 @@ class Escpos: self._raw(BARCODE_CODE39) elif bc.upper() == "ITF": self._raw(BARCODE_ITF) - elif bc.upper() == "NW7": + elif bc.upper() in ("NW7", "CODABAR"): self._raw(BARCODE_NW7) else: raise BarcodeTypeError(bc) From a8ff44622912a054af33dfd730376e1d428049cc Mon Sep 17 00:00:00 2001 From: Stephan Sokolow Date: Thu, 22 May 2014 00:48:59 -0400 Subject: [PATCH 27/34] Add the setup.py-produced "build" folder to .gitignore --- .gitignore | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index 05ea79d..05228da 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ *.py[cod] -.DS_Store \ No newline at end of file +.DS_Store +build From 6e72d2778ddc92f0fc7b3c6beb686be7d7d924a9 Mon Sep 17 00:00:00 2001 From: Stephan Sokolow Date: Thu, 22 May 2014 01:08:58 -0400 Subject: [PATCH 28/34] Allow bypassing the resizing and height-cropping steps in fullimage() --- escpos/escpos.py | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/escpos/escpos.py b/escpos/escpos.py index 424c31d..ed83493 100644 --- a/escpos/escpos.py +++ b/escpos/escpos.py @@ -74,19 +74,22 @@ class Escpos: n = n + h[i+b] im = im.point(lut) - ratio = float(width) / im.size[0] - newheight = int(ratio * im.size[1]) + if width: + ratio = float(width) / im.size[0] + newheight = int(ratio * im.size[1]) - # Resize the image - im = im.resize((width, newheight), Image.ANTIALIAS) - if im.size[1] > max_height: + # Resize the image + im = im.resize((width, newheight), Image.ANTIALIAS) + + if max_height and im.size[1] > max_height: im = im.crop((0, 0, im.size[0], max_height)) # Divide into bands bandsize = 255 current = 0 while current < im.size[1]: - self.image(im.crop((0, current, width, min(im.size[1], current + bandsize)))) + self.image(im.crop((0, current, width or im.size[0], + min(im.size[1], current + bandsize)))) current += bandsize From b6216403c45b25e7b172d5822aaac134eb3fc709 Mon Sep 17 00:00:00 2001 From: Stephan Sokolow Date: Thu, 22 May 2014 01:11:27 -0400 Subject: [PATCH 29/34] Apply the cash drawer fix detailed in Issue 10 on the Google Code repo. https://code.google.com/p/python-escpos/issues/detail?id=10 --- escpos/constants.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/escpos/constants.py b/escpos/constants.py index 487befa..da13f98 100644 --- a/escpos/constants.py +++ b/escpos/constants.py @@ -27,9 +27,9 @@ HW_RESET = ESC + '\x3f\x0a\x00' # Reset printer hardware # (TODO: Where is this specified?) #{ Cash Drawer (ESC p ) -_CASH_DRAWER = lambda m, t1='', t2='': ESC + 'p' + m + t1 + t2 -CD_KICK_2 = _CASH_DRAWER('\x00') # Sends a pulse to pin 2 [] -CD_KICK_5 = _CASH_DRAWER('\x01') # Sends a pulse to pin 5 [] +_CASH_DRAWER = lambda m, t1='', t2='': ESC + 'p' + m + chr(t1) + chr(t2) +CD_KICK_2 = _CASH_DRAWER('\x00', 50, 50) # Sends a pulse to pin 2 [] +CD_KICK_5 = _CASH_DRAWER('\x01', 50, 50) # Sends a pulse to pin 5 [] #{ Paper Cutter _CUT_PAPER = lambda m: GS + 'V' + m From 2a8f852c689bc29869b6a763748f9a06f6f5154a Mon Sep 17 00:00:00 2001 From: Stephan Sokolow Date: Thu, 22 May 2014 01:41:02 -0400 Subject: [PATCH 30/34] Ensure QR codes have a border large enough for successful scan (The QR code spec requires a border at least 4*box_size thick but we can't just set border=16 because that results in a QR code more than 255px tall and I'm not yet ready to use fullimage() as a backend for it) --- escpos/escpos.py | 3 +++ 1 file changed, 3 insertions(+) diff --git a/escpos/escpos.py b/escpos/escpos.py index ed83493..661baeb 100644 --- a/escpos/escpos.py +++ b/escpos/escpos.py @@ -152,7 +152,10 @@ class Escpos: qr_img = qr_code.make_image() # Convert the RGB image in printable image im = qr_img._img.convert("RGB") + self.text('\n') + self.set(align='center') self.image(im) + self.text('\n') def barcode(self, code, bc, height, width, pos, font): """ Print Barcode """ From 64c36a74edf9fbb1a273213807496705f20f4570 Mon Sep 17 00:00:00 2001 From: Stephan Sokolow Date: Fri, 15 Aug 2014 20:17:35 -0400 Subject: [PATCH 31/34] Allow bandsize to be varied in fullimage() --- escpos/escpos.py | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/escpos/escpos.py b/escpos/escpos.py index 661baeb..d9a00f9 100644 --- a/escpos/escpos.py +++ b/escpos/escpos.py @@ -53,7 +53,7 @@ class Escpos: buffer = "" cont = 0 - def fullimage(self, img, max_height=860, width=512, histeq=True): + def fullimage(self, img, max_height=860, width=512, histeq=True, bandsize=255): """ Resizes and prints an arbitrarily sized image """ if isinstance(img, Image.Image): im = img.convert("RGB") @@ -85,7 +85,6 @@ class Escpos: im = im.crop((0, 0, im.size[0], max_height)) # Divide into bands - bandsize = 255 current = 0 while current < im.size[1]: self.image(im.crop((0, current, width or im.size[0], From 5a99c73e7a782f9e0a688f13550a869c6913b2b7 Mon Sep 17 00:00:00 2001 From: Stephan Sokolow Date: Fri, 15 Aug 2014 20:20:02 -0400 Subject: [PATCH 32/34] Start on a command-line interface to the library (still hard-codes USB ID) (...and still needs better documentation) --- escpos/cli.py | 200 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 200 insertions(+) create mode 100755 escpos/cli.py diff --git a/escpos/cli.py b/escpos/cli.py new file mode 100755 index 0000000..6f1df41 --- /dev/null +++ b/escpos/cli.py @@ -0,0 +1,200 @@ +#!/usr/bin/env python2 +# -*- coding: utf-8 -*- +"""A simple command-line interface for common python-escpos functionality + +Usage: python -m escpos.cli --help + +Dependencies: +- DavisGoglin/python-escpos or better +- A file named weather.png (for the 'test' subcommand) + +Reasons for using the DavisGoglin/python-escpos fork: +- image() accepts a PIL.Image object rather than requiring me to choose + between writing a temporary file to disk or calling a "private" method. +- fullimage() allows me to print images of arbitrary length using slicing. + +How to print unsupported barcodes: + barcode -b 'BARCODE' -e 'code39' -E | convert -density 200% eps:- code.png + python test_escpos.py --images code.png + +Copyright (C) 2014 Stephan Sokolow (deitarion/SSokolow) + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the "Software"), +to deal in the Software without restriction, including without limitation +the rights to use, copy, modify, merge, publish, distribute, sublicense, +and/or sell copies of the Software, and to permit persons to whom the +Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included +in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES +OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. +IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, +DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, +TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE +OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. +""" + +from __future__ import absolute_import + +__author__ = "Stephan Sokolow (deitarion/SSokolow)" +__license__ = "MIT" + +import re + +from escpos import printer +epson = printer.Usb(0x0416, 0x5011) +# TODO: Un-hardcode this + +def _print_text_file(path): + """Print the given text file""" + epson.set(align='left') + with open(path, 'rU') as fobj: + for line in fobj: + epson.text(line) + +def _print_image_file(path): + """Print the given image file.""" + epson.fullimage(path, histeq=False, width=384) + +def print_files(args): + """The 'print' subcommand""" + for path in args.paths: + if args.images: + _print_image_file(path) + else: + _print_text_file(path) + epson.cut() + +# {{{ 'echo' Subcommand + +KNOWN_BARCODE_TYPES = ['UPC-A', 'UPC-E', 'EAN13', 'ITF'] +re_barcode_escape = re.compile(r'^%(?P\S+)\s(?P[0-9X]+)$') + +def echo(args): # pylint: disable=unused-argument + """TTY-like line-by-line keyboard-to-printer echo loop.""" + try: + while True: + line = raw_input() + match = re_barcode_escape.match(line) + if match and match.group('type') in KNOWN_BARCODE_TYPES: + bctype, data = match.groups() + epson.barcode(data, bctype, 48, 2, '', '') + epson.set(align='left') + else: + epson.text('%s\n' % line) + except KeyboardInterrupt: + epson.cut() + +# }}} +# {{{ 'test' Subcommand + +from PIL import Image, ImageDraw + +def _stall_test(width, height): + """Generate a pattern to detect print glitches due to vertical stalling.""" + img = Image.new('1', (width, height)) + for pos in [(x, y) for y in range(0, height) for x in range(0, width)]: + img.putpixel(pos, not sum(pos) % 10) + return img + +def _test_basic(): + """The original test code from python-escpos's Usage wiki page""" + epson.set(align='left') + # Print text + epson.text("TODO:\n") # pylint: disable=fixme + epson.text("[ ] Task 1\n") + epson.text("[ ] Task 2\n") + # Print image + # TODO: Bundle an image so this can be used + # epson.image("weather.png") + # Print QR Code (must have a white border to be scanned) + epson.set(align='center') + epson.text("Scan to recall TODO list") # pylint: disable=fixme + epson.qr("http://www.example.com/") + # Print barcode + epson.barcode('1234567890128', 'EAN13', 32, 2, '', '') + # Cut paper + epson.cut() + +def _test_barcodes(): + """Print test barcodes for all ESCPOS-specified formats.""" + for name, data in ( + # pylint: disable=bad-continuation + ('UPC-A', '123456789012\x00'), + ('UPC-E', '02345036\x00'), + ('EAN13', '1234567890128\x00'), + ('EAN8', '12345670\x00'), + ('CODE39', 'BARCODE12345678\x00'), + ('ITF', '123456\x00'), + ('CODABAR', 'A40156B'), + # TODO: CODE93 and CODE128 + ): + # TODO: Fix the library to restore old alignment somehow + epson.set(align='center') + epson.text('\n%s\n' % name) + epson.barcode(data, name, 64, 2, '', '') + +def _test_patterns(width=384, height=255): + """Print a set of test patterns for raster image output.""" + # Test our guess of the paper width + img = Image.new('1', (width, height), color=1) + draw = ImageDraw.Draw(img) + draw.polygon(((0, 0), img.size, (0, img.size[1])), fill=0) + epson.image(img) + del draw, img + + # Test the consistency of printing large data and whether stall rate is + # affected by data rate + epson.image(_stall_test(width, height)) + epson.image(_stall_test(width / 2, height)) + +def test(args): + """The 'test' subcommand""" + if args.barcodes: + _test_barcodes() + elif args.patterns: + _test_patterns() + else: + _test_basic() + +# }}} + +def main(): + """Wrapped in a function for import and entry point compatibility""" + # pylint: disable=bad-continuation + + import argparse + parser = argparse.ArgumentParser( + description="Command-line interface to python-escpos") + subparsers = parser.add_subparsers(title='subcommands') + + echo_parser = subparsers.add_parser('echo', help='Echo the keyboard to ' + 'the printer line-by-line (Exit with Ctrl+C)') + echo_parser.set_defaults(func=echo) + + print_parser = subparsers.add_parser('print', help='Print the given files') + print_parser.add_argument('--images', action='store_true', + help="Provided files are images rather than text files.") + print_parser.add_argument('paths', metavar='path', nargs='+') + print_parser.set_defaults(func=print_files) + + test_parser = subparsers.add_parser('test', help='Print test patterns') + test_modes = test_parser.add_mutually_exclusive_group() + test_modes.add_argument('--barcodes', action='store_true', + help="Test supported barcode types (Warning: Some printers must be " + "reset after attempting an unsupported barcode type.)") + test_modes.add_argument('--patterns', action='store_true', + help="Print test patterns") + test_parser.set_defaults(func=test) + + args = parser.parse_args() + args.func(args) + +if __name__ == '__main__': + main() + +# vim: set sw=4 sts=4 : From 6fdea1234d21ba796e234a4961c7effed6bbe465 Mon Sep 17 00:00:00 2001 From: Nathan Bookham Date: Sat, 16 Aug 2014 14:28:20 +0100 Subject: [PATCH 33/34] Adjusted QR error correction Maxed out the error correction on QR code generation for vastly improved recognition. The trade-off is that the amount of bytes that can be stored are reduced. --- escpos/escpos.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/escpos/escpos.py b/escpos/escpos.py index d9a00f9..9f06bc8 100644 --- a/escpos/escpos.py +++ b/escpos/escpos.py @@ -145,7 +145,7 @@ class Escpos: def qr(self, text): """ Print QR Code for the provided string """ - qr_code = qrcode.QRCode(version=4, box_size=4, border=1) + qr_code = qrcode.QRCode(version=4, box_size=4, border=1, error_correction=qrcode.constants.ERROR_CORRECT_H) qr_code.add_data(text) qr_code.make(fit=True) qr_img = qr_code.make_image() From debac0a5321fac6e20002d3fabecd6b1bd5a89b8 Mon Sep 17 00:00:00 2001 From: Davis Goglin Date: Fri, 22 Aug 2014 20:33:40 -0700 Subject: [PATCH 34/34] keep track of google code differences --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 42dba0f..e01626f 100644 --- a/README.md +++ b/README.md @@ -60,6 +60,10 @@ TODO * Provide install instructions * Provide API documentation + * Google Code revisions (Updated 2014.8.22) + * 205d489cdf8d - Density Support + * 386c544dd163 - Charcode Tables, Tab positions + USB Quickstart ------------------------------------------------------------------