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

199 lines
8.3 KiB
Python
Raw Normal View History

DOC improve the documentation * make API-doc more legible * improve comments in methods
2016-01-05 16:30:40 +00:00
""" Set of ESC/POS Commands (Constants)
This module contains constants that are described in the esc/pos-documentation.
Since there is no definitive and unified specification for all esc/pos-like printers the constants could later be
moved to `capabilities` as in `escpos-php by @mike42 <https://github.com/mike42/escpos-php>`_.
:author: `Manuel F Martinez <manpaz@bashlinux.com>`_ and others
:organization: Bashlinux and `python-escpos <https://github.com/python-escpos>`_
:copyright: Copyright (c) 2012 Bashlinux
:license: GNU GPL v3
"""
Initial files
2010-02-26 08:54:46 +00:00
semiFIX image-printing (still broken)
2016-03-02 23:47:30 +00:00
from __future__ import absolute_import
from __future__ import division
from __future__ import print_function
#from __future__ import unicode_literals
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)
2014-05-22 04:40:05 +00:00
# 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'
Initial files
2010-02-26 08:54:46 +00:00
# Feed control sequences
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)
2014-05-22 04:40:05 +00:00
CTL_LF = '\n' # Print and line feed
CTL_FF = '\f' # Form feed
CTL_CR = '\r' # Carriage return
CTL_HT = '\t' # Horizontal tab
CTL_SET_HT = ESC + '\x44' # Set horizontal tab positions
CTL_VT = '\v' # Vertical tab
Initial files
2010-02-26 08:54:46 +00:00
# Printer hardware
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)
2014-05-22 04:40:05 +00:00
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?)
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 fixes #10
2014-05-22 05:11:27 +00:00
#{ Cash Drawer (ESC p <pin> <on time: 2*ms> <off time: 2*ms>)
_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 []
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)
2014-05-22 04:40:05 +00:00
# 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
Merge remote-tracking branch 'faulab/refactoring-and-documentation'
2015-12-12 16:19:30 +00:00
# Text format
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)
2014-05-22 04:40:05 +00:00
# TODO: Acquire the "ESC/POS Application Programming Guide for Paper Roll
# Printers" and tidy up this stuff too.
Add width/height multiplier support, upsidedown text and text smoothing
2016-03-01 18:05:52 +00:00
TXT_FLIP_ON = ESC + '\x7b\x01'
TXT_FLIP_OFF = ESC + '\x7b\x00'
TXT_SMOOTH_ON = GS + '\x62\x01'
TXT_SMOOTH_OFF = GS + '\x62\x00'
TXT_SIZE = GS + '!'
TXT_WIDTH = {1: 0x00,
2: 0x10,
3: 0x20,
4: 0x30,
5: 0x40,
6: 0x50,
7: 0x60,
8: 0x70}
TXT_HEIGHT = {1: 0x00,
2: 0x01,
3: 0x02,
4: 0x03,
5: 0x04,
6: 0x05,
7: 0x06,
8: 0x07}
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)
2014-05-22 04:40:05 +00:00
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
ADD inverted printing to set method
2016-02-29 18:04:00 +00:00
TXT_INVERT_ON = GS + '\x42\x01' # Inverse Printing ON
TXT_INVERT_OFF = GS + '\x42\x00' # Inverse Printing OFF
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)
2014-05-22 04:40:05 +00:00
Fixed tabs and added charcode tables
2014-05-21 05:15:54 +00:00
# Char code table
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)
2014-05-22 04:40:05 +00:00
CHARCODE_PC437 = ESC + '\x74\x00' # USA: Standard Europe
CHARCODE_JIS = ESC + '\x74\x01' # Japanese Katakana
CHARCODE_PC850 = ESC + '\x74\x02' # Multilingual
CHARCODE_PC860 = ESC + '\x74\x03' # Portuguese
CHARCODE_PC863 = ESC + '\x74\x04' # Canadian-French
CHARCODE_PC865 = ESC + '\x74\x05' # Nordic
CHARCODE_WEU = ESC + '\x74\x06' # Simplified Kanji, Hirakana
CHARCODE_GREEK = ESC + '\x74\x07' # Simplified Kanji
CHARCODE_HEBREW = ESC + '\x74\x08' # Simplified Kanji
CHARCODE_PC1252 = ESC + '\x74\x11' # Western European Windows Code Set
CHARCODE_PC866 = ESC + '\x74\x12' # Cirillic #2
CHARCODE_PC852 = ESC + '\x74\x13' # Latin 2
CHARCODE_PC858 = ESC + '\x74\x14' # Euro
CHARCODE_THAI42 = ESC + '\x74\x15' # Thai character code 42
CHARCODE_THAI11 = ESC + '\x74\x16' # Thai character code 11
CHARCODE_THAI13 = ESC + '\x74\x17' # Thai character code 13
CHARCODE_THAI14 = ESC + '\x74\x18' # Thai character code 14
CHARCODE_THAI16 = ESC + '\x74\x19' # Thai character code 16
CHARCODE_THAI17 = ESC + '\x74\x1a' # Thai character code 17
CHARCODE_THAI18 = ESC + '\x74\x1b' # Thai character code 18
Initial files
2010-02-26 08:54:46 +00:00
# Barcode format
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)
2014-05-22 04:40:05 +00:00
_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
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) check whether this is the solution for #26
2014-05-22 04:45:57 +00:00
BARCODE_HEIGHT = GS + 'h' # Barcode Height [1-255]
BARCODE_WIDTH = GS + 'w' # Barcode Width [2-6]
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)
2014-05-22 04:40:05 +00:00
#NOTE: This isn't actually an ESC/POS command. It's the common prefix to the
# two "print bar code" commands:
Add barcode types for function type B, reorganize existing types
2016-03-07 04:04:58 +00:00
# - Type A: "GS k <type as integer> <data> NUL"
# - TYPE B: "GS k <type as letter> <data length> <data>"
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)
2014-05-22 04:40:05 +00:00
# The latter command supports more barcode types
_SET_BARCODE_TYPE = lambda m: GS + 'k' + m
Add barcode types for function type B, reorganize existing types
2016-03-07 04:04:58 +00:00
Format barcode types
2016-03-08 17:16:35 +00:00
# Barcodes for printing function type A
Add barcode types for function type B, reorganize existing types
2016-03-07 04:04:58 +00:00
BARCODE_TYPE_A = {
Format barcode types
2016-03-08 17:16:35 +00:00
'UPC-A': _SET_BARCODE_TYPE(chr(0)),
'UPC-E': _SET_BARCODE_TYPE(chr(1)),
'EAN13': _SET_BARCODE_TYPE(chr(2)),
'EAN8': _SET_BARCODE_TYPE(chr(3)),
'CODE39': _SET_BARCODE_TYPE(chr(4)),
'ITF': _SET_BARCODE_TYPE(chr(5)),
'NW7': _SET_BARCODE_TYPE(chr(6)),
'CODABAR': _SET_BARCODE_TYPE(chr(6)), # Same as NW7
Add barcode types for function type B, reorganize existing types
2016-03-07 04:04:58 +00:00
}
Format barcode types
2016-03-08 17:16:35 +00:00
# Barcodes for printing function type B
# The first 8 are the same barcodes as type A
Add barcode types for function type B, reorganize existing types
2016-03-07 04:04:58 +00:00
BARCODE_TYPE_B = {
Format barcode types
2016-03-08 17:16:35 +00:00
'UPC-A': _SET_BARCODE_TYPE(chr(65)),
'UPC-E': _SET_BARCODE_TYPE(chr(66)),
'EAN13': _SET_BARCODE_TYPE(chr(67)),
'EAN8': _SET_BARCODE_TYPE(chr(68)),
'CODE39': _SET_BARCODE_TYPE(chr(69)),
'ITF': _SET_BARCODE_TYPE(chr(70)),
'NW7': _SET_BARCODE_TYPE(chr(71)),
'CODABAR': _SET_BARCODE_TYPE(chr(71)), # Same as NW7
'CODE93': _SET_BARCODE_TYPE(chr(72)),
# These are all the same barcode, but using different charcter sets
'CODE128A': _SET_BARCODE_TYPE(chr(73) + '{A'), # CODE128 character set A
'CODE128B': _SET_BARCODE_TYPE(chr(73) + '{B'), # CODE128 character set B
'CODE128C': _SET_BARCODE_TYPE(chr(73) + '{C'), # CODE128 character set C
'GS1-128': _SET_BARCODE_TYPE(chr(74)),
'GS1 DATABAR OMNIDIRECTIONAL': _SET_BARCODE_TYPE(chr(75)),
'GS1 DATABAR TRUNCATED': _SET_BARCODE_TYPE(chr(76)),
'GS1 DATABAR LIMITED': _SET_BARCODE_TYPE(chr(77)),
'GS1 DATABAR EXPANDED': _SET_BARCODE_TYPE(chr(78)),
Add barcode types for function type B, reorganize existing types
2016-03-07 04:04:58 +00:00
}
BARCODE_TYPES = {
'A': BARCODE_TYPE_A,
'B': BARCODE_TYPE_B,
}
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)
2014-05-22 04:40:05 +00:00
Merge remote-tracking branch 'faulab/refactoring-and-documentation'
2015-12-12 16:19:30 +00:00
# Image format
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)
2014-05-22 04:40:05 +00:00
# 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
Added density support
2014-05-21 05:31:49 +00:00
# Printing Density
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)
2014-05-22 04:40:05 +00:00
PD_N50 = GS + '\x7c\x00' # Printing Density -50%
PD_N37 = GS + '\x7c\x01' # Printing Density -37.5%
PD_N25 = GS + '\x7c\x02' # Printing Density -25%
PD_N12 = GS + '\x7c\x03' # Printing Density -12.5%
PD_0 = GS + '\x7c\x04' # Printing Density 0%
PD_P50 = GS + '\x7c\x08' # Printing Density +50%
PD_P37 = GS + '\x7c\x07' # Printing Density +37.5%
PD_P25 = GS + '\x7c\x06' # Printing Density +25%
PD_P12 = GS + '\x7c\x05' # Printing Density +12.5%