setop
/
python-escpos
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge branch 'merge/fau-fablab/refac_and_fixes'

This commit is contained in:
Christoph Heuel 2015-12-13 14:11:27 +01:00
parent 50b0691e68 06f2e1e731
commit 05ea0e929e
8 changed files with 240 additions and 171 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
.hgignore → .gitignore vendored
View File

@ -1,10 +1,9 @@
# python temporary files # python temporary files
syntax: glob
*.pyc *.pyc
# editor autosaves # editor autosaves
$~ $~
.idea/
# temporary data # temporary data
syntax: regexp
temp temp

2
escpos/__init__.py
View File

@ -1 +1 @@
__all__ = ["constants","escpos","exceptions","printer"] __all__ = ["constants", "escpos", "exceptions", "printer"]

150
escpos/constants.py
View File

@ -1,86 +1,86 @@
""" ESC/POS Commands (Constants) """ """ ESC/POS Commands (Constants) """
# Feed control sequences # Feed control sequences
CTL_LF = '\x0a' # Print and line feed CTL_LF = '\x0a' # Print and line feed
CTL_FF = '\x0c' # Form feed CTL_FF = '\x0c' # Form feed
CTL_CR = '\x0d' # Carriage return CTL_CR = '\x0d' # Carriage return
CTL_HT = '\x09' # Horizontal tab CTL_HT = '\x09' # Horizontal tab
CTL_SET_HT = '\x1b\x44' # Set horizontal tab positions CTL_SET_HT = '\x1b\x44' # Set horizontal tab positions
CTL_VT = '\x1b\x64\x04' # Vertical tab CTL_VT = '\x1b\x64\x04' # Vertical tab
# Printer hardware # Printer hardware
HW_INIT = '\x1b\x40' # Clear data in buffer and reset modes HW_INIT = '\x1b\x40' # Clear data in buffer and reset modes
HW_SELECT = '\x1b\x3d\x01' # Printer select HW_SELECT = '\x1b\x3d\x01' # Printer select
HW_RESET = '\x1b\x3f\x0a\x00' # Reset printer hardware HW_RESET = '\x1b\x3f\x0a\x00' # Reset printer hardware
# Cash Drawer # Cash Drawer
CD_KICK_2 = '\x1b\x70\x00' # Sends a pulse to pin 2 [] CD_KICK_2 = '\x1b\x70\x00' # Sends a pulse to pin 2 []
CD_KICK_5 = '\x1b\x70\x01' # Sends a pulse to pin 5 [] CD_KICK_5 = '\x1b\x70\x01' # Sends a pulse to pin 5 []
# Paper # Paper
PAPER_FULL_CUT = '\x1d\x56\x00' # Full cut paper PAPER_FULL_CUT = '\x1d\x56\x00' # Full cut paper
PAPER_PART_CUT = '\x1d\x56\x01' # Partial cut paper PAPER_PART_CUT = '\x1d\x56\x01' # Partial cut paper
# Text format # Text format
TXT_NORMAL = '\x1b\x21\x00' # Normal text TXT_NORMAL = '\x1b\x21\x00' # Normal text
TXT_2HEIGHT = '\x1b\x21\x10' # Double height text TXT_2HEIGHT = '\x1b\x21\x10' # Double height text
TXT_2WIDTH = '\x1b\x21\x20' # Double width text TXT_2WIDTH = '\x1b\x21\x20' # Double width text
TXT_4SQUARE = '\x1b\x21\x30' # Quad area text TXT_4SQUARE = '\x1b\x21\x30' # Quad area text
TXT_UNDERL_OFF = '\x1b\x2d\x00' # Underline font OFF TXT_UNDERL_OFF = '\x1b\x2d\x00' # Underline font OFF
TXT_UNDERL_ON = '\x1b\x2d\x01' # Underline font 1-dot ON TXT_UNDERL_ON = '\x1b\x2d\x01' # Underline font 1-dot ON
TXT_UNDERL2_ON = '\x1b\x2d\x02' # Underline font 2-dot ON TXT_UNDERL2_ON = '\x1b\x2d\x02' # Underline font 2-dot ON
TXT_BOLD_OFF = '\x1b\x45\x00' # Bold font OFF TXT_BOLD_OFF = '\x1b\x45\x00' # Bold font OFF
TXT_BOLD_ON = '\x1b\x45\x01' # Bold font ON TXT_BOLD_ON = '\x1b\x45\x01' # Bold font ON
TXT_FONT_A = '\x1b\x4d\x00' # Font type A TXT_FONT_A = '\x1b\x4d\x00' # Font type A
TXT_FONT_B = '\x1b\x4d\x01' # Font type B TXT_FONT_B = '\x1b\x4d\x01' # Font type B
TXT_ALIGN_LT = '\x1b\x61\x00' # Left justification TXT_ALIGN_LT = '\x1b\x61\x00' # Left justification
TXT_ALIGN_CT = '\x1b\x61\x01' # Centering TXT_ALIGN_CT = '\x1b\x61\x01' # Centering
TXT_ALIGN_RT = '\x1b\x61\x02' # Right justification TXT_ALIGN_RT = '\x1b\x61\x02' # Right justification
# Char code table # Char code table
CHARCODE_PC437 = '\x1b\x74\x00' # USA: Standard Europe CHARCODE_PC437 = '\x1b\x74\x00' # USA: Standard Europe
CHARCODE_JIS = '\x1b\x74\x01' # Japanese Katakana CHARCODE_JIS = '\x1b\x74\x01' # Japanese Katakana
CHARCODE_PC850 = '\x1b\x74\x02' # Multilingual CHARCODE_PC850 = '\x1b\x74\x02' # Multilingual
CHARCODE_PC860 = '\x1b\x74\x03' # Portuguese CHARCODE_PC860 = '\x1b\x74\x03' # Portuguese
CHARCODE_PC863 = '\x1b\x74\x04' # Canadian-French CHARCODE_PC863 = '\x1b\x74\x04' # Canadian-French
CHARCODE_PC865 = '\x1b\x74\x05' # Nordic CHARCODE_PC865 = '\x1b\x74\x05' # Nordic
CHARCODE_WEU = '\x1b\x74\x06' # Simplified Kanji, Hirakana CHARCODE_WEU = '\x1b\x74\x06' # Simplified Kanji, Hirakana
CHARCODE_GREEK = '\x1b\x74\x07' # Simplified Kanji CHARCODE_GREEK = '\x1b\x74\x07' # Simplified Kanji
CHARCODE_HEBREW = '\x1b\x74\x08' # Simplified Kanji CHARCODE_HEBREW = '\x1b\x74\x08' # Simplified Kanji
CHARCODE_PC1252 = '\x1b\x74\x11' # Western European Windows Code Set CHARCODE_PC1252 = '\x1b\x74\x11' # Western European Windows Code Set
CHARCODE_PC866 = '\x1b\x74\x12' # Cirillic #2 CHARCODE_PC866 = '\x1b\x74\x12' # Cirillic #2
CHARCODE_PC852 = '\x1b\x74\x13' # Latin 2 CHARCODE_PC852 = '\x1b\x74\x13' # Latin 2
CHARCODE_PC858 = '\x1b\x74\x14' # Euro CHARCODE_PC858 = '\x1b\x74\x14' # Euro
CHARCODE_THAI42 = '\x1b\x74\x15' # Thai character code 42 CHARCODE_THAI42 = '\x1b\x74\x15' # Thai character code 42
CHARCODE_THAI11 = '\x1b\x74\x16' # Thai character code 11 CHARCODE_THAI11 = '\x1b\x74\x16' # Thai character code 11
CHARCODE_THAI13 = '\x1b\x74\x17' # Thai character code 13 CHARCODE_THAI13 = '\x1b\x74\x17' # Thai character code 13
CHARCODE_THAI14 = '\x1b\x74\x18' # Thai character code 14 CHARCODE_THAI14 = '\x1b\x74\x18' # Thai character code 14
CHARCODE_THAI16 = '\x1b\x74\x19' # Thai character code 16 CHARCODE_THAI16 = '\x1b\x74\x19' # Thai character code 16
CHARCODE_THAI17 = '\x1b\x74\x1a' # Thai character code 17 CHARCODE_THAI17 = '\x1b\x74\x1a' # Thai character code 17
CHARCODE_THAI18 = '\x1b\x74\x1b' # Thai character code 18 CHARCODE_THAI18 = '\x1b\x74\x1b' # Thai character code 18
# Barcode format # Barcode format
BARCODE_TXT_OFF = '\x1d\x48\x00' # HRI barcode chars OFF BARCODE_TXT_OFF = '\x1d\x48\x00' # HRI barcode chars OFF
BARCODE_TXT_ABV = '\x1d\x48\x01' # HRI barcode chars above BARCODE_TXT_ABV = '\x1d\x48\x01' # HRI barcode chars above
BARCODE_TXT_BLW = '\x1d\x48\x02' # HRI barcode chars below BARCODE_TXT_BLW = '\x1d\x48\x02' # HRI barcode chars below
BARCODE_TXT_BTH = '\x1d\x48\x03' # HRI barcode chars both above and 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_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_FONT_B = '\x1d\x66\x01' # Font type B for HRI barcode chars
BARCODE_HEIGHT = '\x1d\x68\x64' # Barcode Height [1-255] BARCODE_HEIGHT = '\x1d\x68\x64' # Barcode Height [1-255]
BARCODE_WIDTH = '\x1d\x77\x03' # Barcode Width [2-6] BARCODE_WIDTH = '\x1d\x77\x03' # Barcode Width [2-6]
BARCODE_UPC_A = '\x1d\x6b\x00' # Barcode type UPC-A BARCODE_UPC_A = '\x1d\x6b\x00' # Barcode type UPC-A
BARCODE_UPC_E = '\x1d\x6b\x01' # Barcode type UPC-E BARCODE_UPC_E = '\x1d\x6b\x01' # Barcode type UPC-E
BARCODE_EAN13 = '\x1d\x6b\x02' # Barcode type EAN13 BARCODE_EAN13 = '\x1d\x6b\x02' # Barcode type EAN13
BARCODE_EAN8 = '\x1d\x6b\x03' # Barcode type EAN8 BARCODE_EAN8 = '\x1d\x6b\x03' # Barcode type EAN8
BARCODE_CODE39 = '\x1d\x6b\x04' # Barcode type CODE39 BARCODE_CODE39 = '\x1d\x6b\x04' # Barcode type CODE39
BARCODE_ITF = '\x1d\x6b\x05' # Barcode type ITF BARCODE_ITF = '\x1d\x6b\x05' # Barcode type ITF
BARCODE_NW7 = '\x1d\x6b\x06' # Barcode type NW7 BARCODE_NW7 = '\x1d\x6b\x06' # Barcode type NW7
# Image format # Image format
S_RASTER_N = '\x1d\x76\x30\x00' # Set raster image normal size 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_2W = '\x1d\x76\x30\x01' # Set raster image double width
S_RASTER_2H = '\x1d\x76\x30\x02' # Set raster image double height S_RASTER_2H = '\x1d\x76\x30\x02' # Set raster image double height
S_RASTER_Q = '\x1d\x76\x30\x03' # Set raster image quadruple S_RASTER_Q = '\x1d\x76\x30\x03' # Set raster image quadruple
# Printing Density # Printing Density
PD_N50 = '\x1d\x7c\x00' # Printing Density -50% PD_N50 = '\x1d\x7c\x00' # Printing Density -50%
PD_N37 = '\x1d\x7c\x01' # Printing Density -37.5% PD_N37 = '\x1d\x7c\x01' # Printing Density -37.5%
PD_N25 = '\x1d\x7c\x02' # Printing Density -25% PD_N25 = '\x1d\x7c\x02' # Printing Density -25%
PD_N12 = '\x1d\x7c\x03' # Printing Density -12.5% PD_N12 = '\x1d\x7c\x03' # Printing Density -12.5%
PD_0 = '\x1d\x7c\x04' # Printing Density 0% PD_0 = '\x1d\x7c\x04' # Printing Density 0%
PD_P50 = '\x1d\x7c\x08' # Printing Density +50% PD_P50 = '\x1d\x7c\x08' # Printing Density +50%
PD_P37 = '\x1d\x7c\x07' # Printing Density +37.5% PD_P37 = '\x1d\x7c\x07' # Printing Density +37.5%
PD_P25 = '\x1d\x7c\x06' # Printing Density +25% PD_P25 = '\x1d\x7c\x06' # Printing Density +25%
PD_P12 = '\x1d\x7c\x05' # Printing Density +12.5% PD_P12 = '\x1d\x7c\x05' # Printing Density +12.5%

193
escpos/escpos.py
View File

@ -19,17 +19,39 @@ import binascii
from .constants import * from .constants import *
from .exceptions import * from .exceptions import *
class Escpos: from abc import ABCMeta, abstractmethod # abstract base class support
class Escpos(object):
""" ESC/POS Printer object """ """ ESC/POS Printer object """
device = None __metaclass__ = ABCMeta
device = None
def __init__(self, columns=32): def __init__(self, columns=32):
""" Initialize ESCPOS Printer
:param columns: Text columns used by the printer. Defaults to 32."""
self.columns = columns self.columns = columns
def _check_image_size(self, size): @abstractmethod
""" Check and fix the size of the image to 32 bits """ def _raw(self, msg):
""" Sends raw data to the printer
This function has to be individually implemented by the implementations.
:param msg: message string to be sent to the printer
"""
pass
@staticmethod
def _check_image_size(size):
""" Check and fix the size of the image to 32 bits
:param size: size of the image
:returns: tuple of image borders
:rtype: (int, int)
"""
if size % 32 == 0: if size % 32 == 0:
return (0, 0) return 0, 0
else: else:
image_border = 32 - (size % 32) image_border = 32 - (size % 32)
if (image_border % 2) == 0: if (image_border % 2) == 0:
@ -37,41 +59,46 @@ class Escpos:
else: else:
return (round(image_border / 2), round((image_border / 2) + 1)) return (round(image_border / 2), round((image_border / 2) + 1))
def _print_image(self, line, size): def _print_image(self, line, size):
""" Print formatted image """ """ Print formatted image
:param line:
:param size:
"""
i = 0 i = 0
cont = 0 cont = 0
buffer = "" pbuffer = ""
self._raw(S_RASTER_N) self._raw(S_RASTER_N)
buffer = "%02X%02X%02X%02X" % (((size[0]/size[1])/8), 0, size[1]&0xff, size[1]>>8) pbuffer = "%02X%02X%02X%02X" % (((size[0]/size[1])/8), 0, size[1] & 0xff, size[1] >> 8)
self._raw(binascii.unhexlify(buffer)) self._raw(binascii.unhexlify(pbuffer))
buffer = "" pbuffer = ""
while i < len(line): while i < len(line):
hex_string = int(line[i:i+8],2) hex_string = int(line[i:i+8], 2)
buffer += "%02X" % hex_string pbuffer += "%02X" % hex_string
i += 8 i += 8
cont += 1 cont += 1
if cont % 4 == 0: if cont % 4 == 0:
self._raw(binascii.unhexlify(buffer)) self._raw(binascii.unhexlify(pbuffer))
buffer = "" pbuffer = ""
cont = 0 cont = 0
def _convert_image(self, im): def _convert_image(self, im):
""" Parse image and prepare it to a printable format """ """ Parse image and prepare it to a printable format
pixels = []
pix_line = ""
im_left = ""
im_right = ""
switch = 0
img_size = [ 0, 0 ]
:param im: image data
:raises: ImageSizeError
"""
pixels = []
pix_line = ""
im_left = ""
im_right = ""
switch = 0
img_size = [0, 0]
if im.size[0] > 512: if im.size[0] > 512:
print ("WARNING: Image is wider than 512 and could be truncated at print time ") print ("WARNING: Image is wider than 512 and could be truncated at print time ")
if im.size[1] > 0xffff: if im.size[1] > 0xffff:
raise ImageSizeError() raise ImageSizeError()
@ -91,7 +118,7 @@ class Escpos:
im_color = (RGB[0] + RGB[1] + RGB[2]) im_color = (RGB[0] + RGB[1] + RGB[2])
im_pattern = "1X0" im_pattern = "1X0"
pattern_len = len(im_pattern) pattern_len = len(im_pattern)
switch = (switch - 1 ) * (-1) switch = (switch - 1) * (-1)
for x in range(pattern_len): for x in range(pattern_len):
if im_color <= (255 * 3 / pattern_len * (x+1)): if im_color <= (255 * 3 / pattern_len * (x+1)):
if im_pattern[x] == "X": if im_pattern[x] == "X":
@ -99,7 +126,7 @@ class Escpos:
else: else:
pix_line += im_pattern[x] pix_line += im_pattern[x]
break break
elif im_color > (255 * 3 / pattern_len * pattern_len) and im_color <= (255 * 3): elif (255 * 3 / pattern_len * pattern_len) < im_color <= (255 * 3):
pix_line += im_pattern[-1] pix_line += im_pattern[-1]
break break
pix_line += im_right pix_line += im_right
@ -107,9 +134,11 @@ class Escpos:
self._print_image(pix_line, img_size) self._print_image(pix_line, img_size)
def image(self, path_img):
""" Open image file
def image(self,path_img): :param path_img: path to image
""" Open image file """ """
im_open = Image.open(path_img) im_open = Image.open(path_img)
# Remove the alpha channel on transparent images # Remove the alpha channel on transparent images
@ -155,9 +184,11 @@ class Escpos:
temp = 0 temp = 0
self._raw(binascii.unhexlify(bytes(buf, "ascii"))) self._raw(binascii.unhexlify(bytes(buf, "ascii")))
def qr(self, text):
""" Print QR Code for the provided string
def qr(self,text): :param text: text to generate a QR-Code from
""" 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)
qr_code.add_data(text) qr_code.add_data(text)
qr_code.make(fit=True) qr_code.make(fit=True)
@ -167,9 +198,14 @@ class Escpos:
# Convert the RGB image in printable image # Convert the RGB image in printable image
self._convert_image(im) self._convert_image(im)
def charcode(self, code):
""" Set Character Code Table
def charcode(self,code): Sends the control sequence from constants.py to the printer with :py:meth:`escpos.printer._raw()`.
""" Set Character Code Table """
:param code: Name of CharCode
:raises: CharCodeError
"""
if code.upper() == "USA": if code.upper() == "USA":
self._raw(CHARCODE_PC437) self._raw(CHARCODE_PC437)
elif code.upper() == "JIS": elif code.upper() == "JIS":
@ -188,8 +224,8 @@ class Escpos:
self._raw(CHARCODE_GREEK) self._raw(CHARCODE_GREEK)
elif code.upper() == "HEBREW": elif code.upper() == "HEBREW":
self._raw(CHARCODE_HEBREW) self._raw(CHARCODE_HEBREW)
elif code.upper() == "LATVIAN": # elif code.upper() == "LATVIAN": # this is not listed in the constants
self._raw(CHARCODE_PC755) # self._raw(CHARCODE_PC755)
elif code.upper() == "WPC1252": elif code.upper() == "WPC1252":
self._raw(CHARCODE_PC1252) self._raw(CHARCODE_PC1252)
elif code.upper() == "CIRILLIC2": elif code.upper() == "CIRILLIC2":
@ -216,23 +252,32 @@ class Escpos:
raise CharCodeError() raise CharCodeError()
def barcode(self, code, bc, width, height, pos, font): def barcode(self, code, bc, width, height, pos, font):
""" Print Barcode """ """ Print Barcode
:param code: data for barcode
:param bc: barcode format, see constants.py
:param width: barcode width, has to be between 1 and 255
:param height: barcode height, has to be between 2 and 6
:param pos: position of text in barcode, default when nothing supplied is below
:param font: select font, default is font A
:raises: BarcodeSizeError, BarcodeTypeError, BarcodeCodeError
"""
# Align Bar Code() # Align Bar Code()
self._raw(TXT_ALIGN_CT) self._raw(TXT_ALIGN_CT)
# Height # Height
if height >=2 or height <=6: if height >= 2 or height <= 6:
self._raw(BARCODE_HEIGHT) self._raw(BARCODE_HEIGHT)
else: else:
raise BarcodeSizeError() raise BarcodeSizeError()
# Width # Width
if width >= 1 or width <=255: if width >= 1 or width <= 255:
self._raw(BARCODE_WIDTH) self._raw(BARCODE_WIDTH)
else: else:
raise BarcodeSizeError() raise BarcodeSizeError()
# Font # Font
if font.upper() == "B": if font.upper() == "B":
self._raw(BARCODE_FONT_B) self._raw(BARCODE_FONT_B)
else: # DEFAULT FONT: A else: # DEFAULT FONT: A
self._raw(BARCODE_FONT_A) self._raw(BARCODE_FONT_A)
# Position # Position
if pos.upper() == "OFF": if pos.upper() == "OFF":
@ -264,11 +309,15 @@ class Escpos:
if code: if code:
self._raw(code) self._raw(code)
else: else:
raise exception.BarcodeCodeError() raise BarcodeCodeError()
def text(self, txt): def text(self, txt):
""" Print alpha-numeric text """ """ Print alpha-numeric text
The text has to be encoded in the currently selected codepage.
:param txt: text to be printed
:raises: TextError
"""
if txt: if txt:
self._raw(txt) self._raw(txt)
else: else:
@ -279,8 +328,16 @@ class Escpos:
colCount = self.columns if columns == None else columns colCount = self.columns if columns == None else columns
self.text(textwrap.fill(txt, colCount)) self.text(textwrap.fill(txt, colCount))
def set(self, align='left', font='a', type='normal', width=1, height=1, density=9): def set(self, align='left', font='a', text_type='normal', width=1, height=1, density=9):
""" Set text properties """ """ Set text properties by sending them to the printer
:param align: alignment of text
:param font: font A or B
:param text_type: add bold or underlined
:param width: text width, normal or double width
:param height: text height, normal or double height
:param density: print density
"""
# Width # Width
if height == 2 and width == 2: if height == 2 and width == 2:
self._raw(TXT_NORMAL) self._raw(TXT_NORMAL)
@ -291,25 +348,25 @@ class Escpos:
elif width == 2 and height != 2: elif width == 2 and height != 2:
self._raw(TXT_NORMAL) self._raw(TXT_NORMAL)
self._raw(TXT_2WIDTH) self._raw(TXT_2WIDTH)
else: # DEFAULT SIZE: NORMAL else: # DEFAULT SIZE: NORMAL
self._raw(TXT_NORMAL) self._raw(TXT_NORMAL)
# Type # Type
if type.upper() == "B": if text_type.upper() == "B":
self._raw(TXT_BOLD_ON) self._raw(TXT_BOLD_ON)
self._raw(TXT_UNDERL_OFF) self._raw(TXT_UNDERL_OFF)
elif type.upper() == "U": elif text_type.upper() == "U":
self._raw(TXT_BOLD_OFF) self._raw(TXT_BOLD_OFF)
self._raw(TXT_UNDERL_ON) self._raw(TXT_UNDERL_ON)
elif type.upper() == "U2": elif text_type.upper() == "U2":
self._raw(TXT_BOLD_OFF) self._raw(TXT_BOLD_OFF)
self._raw(TXT_UNDERL2_ON) self._raw(TXT_UNDERL2_ON)
elif type.upper() == "BU": elif text_type.upper() == "BU":
self._raw(TXT_BOLD_ON) self._raw(TXT_BOLD_ON)
self._raw(TXT_UNDERL_ON) self._raw(TXT_UNDERL_ON)
elif type.upper() == "BU2": elif text_type.upper() == "BU2":
self._raw(TXT_BOLD_ON) self._raw(TXT_BOLD_ON)
self._raw(TXT_UNDERL2_ON) self._raw(TXT_UNDERL2_ON)
elif type.upper == "NORMAL": elif text_type.upper == "NORMAL":
self._raw(TXT_BOLD_OFF) self._raw(TXT_BOLD_OFF)
self._raw(TXT_UNDERL_OFF) self._raw(TXT_UNDERL_OFF)
# Font # Font
@ -343,23 +400,29 @@ class Escpos:
self._raw(PD_P37) self._raw(PD_P37)
elif density == 8: elif density == 8:
self._raw(PD_P50) self._raw(PD_P50)
else:# DEFAULT: DOES NOTHING else: # DEFAULT: DOES NOTHING
pass pass
def cut(self, mode=''): def cut(self, mode=''):
""" Cut paper """ """ Cut paper
:param mode: set to 'PART' for a partial cut
"""
# Fix the size between last line and cut # Fix the size between last line and cut
# TODO: handle this with a line feed # TODO: handle this with a line feed
self._raw("\n\n\n\n\n\n") self._raw("\n\n\n\n\n\n")
if mode.upper() == "PART": if mode.upper() == "PART":
self._raw(PAPER_PART_CUT) self._raw(PAPER_PART_CUT)
else: # DEFAULT MODE: FULL CUT else: # DEFAULT MODE: FULL CUT
self._raw(PAPER_FULL_CUT) self._raw(PAPER_FULL_CUT)
def cashdraw(self, pin): def cashdraw(self, pin):
""" Send pulse to kick the cash drawer """ """ Send pulse to kick the cash drawer
Kick cash drawer on pin 2 or pin 5.
:param pin: pin number
:raises: CashDrawerError
"""
if pin == 2: if pin == 2:
self._raw(CD_KICK_2) self._raw(CD_KICK_2)
elif pin == 5: elif pin == 5:
@ -367,26 +430,30 @@ class Escpos:
else: else:
raise CashDrawerError() raise CashDrawerError()
def hw(self, hw): def hw(self, hw):
""" Hardware operations """ """ Hardware operations
:param hw: hardware action
"""
if hw.upper() == "INIT": if hw.upper() == "INIT":
self._raw(HW_INIT) self._raw(HW_INIT)
elif hw.upper() == "SELECT": elif hw.upper() == "SELECT":
self._raw(HW_SELECT) self._raw(HW_SELECT)
elif hw.upper() == "RESET": elif hw.upper() == "RESET":
self._raw(HW_RESET) self._raw(HW_RESET)
else: # DEFAULT: DOES NOTHING else: # DEFAULT: DOES NOTHING
pass pass
def control(self, ctl, pos=4): def control(self, ctl, pos=4):
""" Feed control sequences """ """ Feed control sequences
:raises: TabPosError
"""
# Set tab positions # Set tab positions
if pos < 1 or pos > 16: if pos < 1 or pos > 16:
raise TabError() raise TabPosError()
else: else:
self._raw("".join([CTL_SET_HT,hex(pos)])) self._raw("".join([CTL_SET_HT, hex(pos)]))
# Set position # Set position
if ctl.upper() == "LF": if ctl.upper() == "LF":
self._raw(CTL_LF) self._raw(CTL_LF)

17
escpos/exceptions.py
View File

@ -1,6 +1,5 @@
""" ESC/POS Exceptions classes """ """ ESC/POS Exceptions classes """
import os
class Error(Exception): class Error(Exception):
""" Base class for ESC/POS errors """ """ Base class for ESC/POS errors """
@ -27,6 +26,7 @@ class Error(Exception):
class BarcodeTypeError(Error): class BarcodeTypeError(Error):
"""No Barcode type defined """
def __init__(self, msg=""): def __init__(self, msg=""):
Error.__init__(self, msg) Error.__init__(self, msg)
self.msg = msg self.msg = msg
@ -35,7 +35,9 @@ class BarcodeTypeError(Error):
def __str__(self): def __str__(self):
return "No Barcode type is defined" return "No Barcode type is defined"
class BarcodeSizeError(Error): class BarcodeSizeError(Error):
""" Barcode size is out of range """
def __init__(self, msg=""): def __init__(self, msg=""):
Error.__init__(self, msg) Error.__init__(self, msg)
self.msg = msg self.msg = msg
@ -44,16 +46,20 @@ class BarcodeSizeError(Error):
def __str__(self): def __str__(self):
return "Barcode size is out of range" return "Barcode size is out of range"
class BarcodeCodeError(Error): class BarcodeCodeError(Error):
""" No Barcode code was supplied """
def __init__(self, msg=""): def __init__(self, msg=""):
Error.__init__(self, msg) Error.__init__(self, msg)
self.msg = msg self.msg = msg
self.resultcode = 30 self.resultcode = 30
def __str__(self): def __str__(self):
return "Code was not supplied" return "No Barcode code was supplied"
class ImageSizeError(Error): class ImageSizeError(Error):
""" Image height is longer than 255px and can't be printed """
def __init__(self, msg=""): def __init__(self, msg=""):
Error.__init__(self, msg) Error.__init__(self, msg)
self.msg = msg self.msg = msg
@ -62,7 +68,9 @@ class ImageSizeError(Error):
def __str__(self): def __str__(self):
return "Image height is longer than 255px and can't be printed" return "Image height is longer than 255px and can't be printed"
class TextError(Error): class TextError(Error):
""" Test sting must be supplied to the text() method """
def __init__(self, msg=""): def __init__(self, msg=""):
Error.__init__(self, msg) Error.__init__(self, msg)
self.msg = msg self.msg = msg
@ -73,6 +81,7 @@ class TextError(Error):
class CashDrawerError(Error): class CashDrawerError(Error):
""" Valid pin must be set to send pulse """
def __init__(self, msg=""): def __init__(self, msg=""):
Error.__init__(self, msg) Error.__init__(self, msg)
self.msg = msg self.msg = msg
@ -82,7 +91,8 @@ class CashDrawerError(Error):
return "Valid pin must be set to send pulse" return "Valid pin must be set to send pulse"
class TabError(Error): class TabPosError(Error):
""" Valid tab positions must be in the range 0 to 16 """
def __init__(self, msg=""): def __init__(self, msg=""):
Error.__init__(self, msg) Error.__init__(self, msg)
self.msg = msg self.msg = msg
@ -93,6 +103,7 @@ class TabError(Error):
class CharCodeError(Error): class CharCodeError(Error):
""" Valid char code must be set """
def __init__(self, msg=""): def __init__(self, msg=""):
Error.__init__(self, msg) Error.__init__(self, msg)
self.msg = msg self.msg = msg

33
escpos/printer.py
View File

@ -15,28 +15,28 @@ from .escpos import *
from .constants import * from .constants import *
from .exceptions import * from .exceptions import *
class Usb(Escpos): class Usb(Escpos):
""" Define USB printer """ """ Define USB printer """
def __init__(self, idVendor, idProduct, interface=0, in_ep=0x82, out_ep=0x01, *args, **kwargs): def __init__(self, idVendor, idProduct, interface=0, in_ep=0x82, out_ep=0x01, *args, **kwargs):
""" """
@param idVendor : Vendor ID :param idVendor: Vendor ID
@param idProduct : Product ID :param idProduct: Product ID
@param interface : USB device interface :param interface: USB device interface
@param in_ep : Input end point :param in_ep: Input end point
@param out_ep : Output end point :param out_ep: Output end point
""" """
Escpos.__init__(self, *args, **kwargs) Escpos.__init__(self, *args, **kwargs)
self.idVendor = idVendor self.idVendor = idVendor
self.idProduct = idProduct self.idProduct = idProduct
self.interface = interface self.interface = interface
self.in_ep = in_ep self.in_ep = in_ep
self.out_ep = out_ep self.out_ep = out_ep
self.open() self.open()
def open(self): def open(self):
""" Search device on USB tree and set is as escpos device """ """ Search device on USB tree and set it as escpos device """
self.device = usb.core.find(idVendor=self.idVendor, idProduct=self.idProduct) self.device = usb.core.find(idVendor=self.idVendor, idProduct=self.idProduct)
if self.device is None: if self.device is None:
print("Cable isn't plugged in") print("Cable isn't plugged in")
@ -61,12 +61,10 @@ class Usb(Escpos):
except usb.core.USBError as e: except usb.core.USBError as e:
print("Could not set configuration: %s" % str(e)) print("Could not set configuration: %s" % str(e))
def _raw(self, msg): def _raw(self, msg):
""" Print any command sent in raw format """ """ Print any command sent in raw format """
self.device.write(self.out_ep, msg, self.interface) self.device.write(self.out_ep, msg, self.interface)
def __del__(self): def __del__(self):
""" Release USB interface """ """ Release USB interface """
if self.device: if self.device:
@ -74,7 +72,6 @@ class Usb(Escpos):
self.device = None self.device = None
class Serial(Escpos): class Serial(Escpos):
""" Define Serial printer """ """ Define Serial printer """
@ -97,7 +94,6 @@ class Serial(Escpos):
self.baudrate = baudrate self.baudrate = baudrate
self.bytesize = bytesize self.bytesize = bytesize
self.timeout = timeout self.timeout = timeout
self.parity = parity self.parity = parity
self.stopbits = stopbits self.stopbits = stopbits
self.xonxoff = xonxoff self.xonxoff = xonxoff
@ -105,7 +101,6 @@ class Serial(Escpos):
self.open() self.open()
def open(self): def open(self):
""" Setup serial port and set is as escpos device """ """ Setup serial port and set is as escpos device """
self.device = serial.Serial(port=self.devfile, baudrate=self.baudrate, self.device = serial.Serial(port=self.devfile, baudrate=self.baudrate,
@ -118,19 +113,16 @@ class Serial(Escpos):
else: else:
print("Unable to open serial printer on: %s" % self.devfile) print("Unable to open serial printer on: %s" % self.devfile)
def _raw(self, msg): def _raw(self, msg):
""" Print any command sent in raw format """ """ Print any command sent in raw format """
self.device.write(msg) self.device.write(msg)
def __del__(self): def __del__(self):
""" Close Serial interface """ """ Close Serial interface """
if self.device is not None: if self.device is not None:
self.device.close() self.device.close()
class Network(Escpos): class Network(Escpos):
""" Define Network printer """ """ Define Network printer """
@ -144,7 +136,6 @@ class Network(Escpos):
self.port = port self.port = port
self.open() self.open()
def open(self): def open(self):
""" Open TCP socket and set it as escpos device """ """ Open TCP socket and set it as escpos device """
self.device = socket.socket(socket.AF_INET, socket.SOCK_STREAM) self.device = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
@ -153,18 +144,15 @@ class Network(Escpos):
if self.device is None: if self.device is None:
print("Could not open socket for %s" % self.host) print("Could not open socket for %s" % self.host)
def _raw(self, msg): def _raw(self, msg):
""" Print any command sent in raw format """ """ Print any command sent in raw format """
self.device.send(msg) self.device.send(msg)
def __del__(self): def __del__(self):
""" Close TCP connection """ """ Close TCP connection """
self.device.close() self.device.close()
class File(Escpos): class File(Escpos):
""" Define Generic file printer """ """ Define Generic file printer """
@ -176,7 +164,6 @@ class File(Escpos):
self.devfile = devfile self.devfile = devfile
self.open() self.open()
def open(self): def open(self):
""" Open system file """ """ Open system file """
self.device = open(self.devfile, "wb") self.device = open(self.devfile, "wb")
@ -188,7 +175,6 @@ class File(Escpos):
"""Flush printing content""" """Flush printing content"""
self.device.flush() self.device.flush()
def _raw(self, msg): def _raw(self, msg):
""" Print any command sent in raw format """ """ Print any command sent in raw format """
if type(msg) is str: if type(msg) is str:
@ -196,7 +182,6 @@ class File(Escpos):
else: else:
self.device.write(msg); self.device.write(msg);
def __del__(self): def __del__(self):
""" Close system file """ """ Close system file """
self.device.close() self.device.close()

1
requirements.txt Normal file
View File

@ -0,0 +1 @@
-e .

8
setup.py
View File

@ -23,7 +23,13 @@ setup(
'Operating System :: GNU/Linux', 'Operating System :: GNU/Linux',
'Intended Audience :: Developers', 'Intended Audience :: Developers',
'Programming Language :: Python', 'Programming Language :: Python',
'Topic :: System :: Pheripherals', 'Topic :: System :: Peripherals',
'Topic :: Software Development :: Libraries :: Python Modules', 'Topic :: Software Development :: Libraries :: Python Modules',
], ],
install_requires=[
'pyusb',
'Pillow>=2.0',
'qrcode>=4.0',
'pyserial',
],
) )