annotate zebra.py @ 25:fc1a7cf3f92c

Added licence to code
author Ben Croston <ben@croston.org>
date Wed, 31 Aug 2011 16:46:48 +0100
parents 117c2aac83e5
children 20f6df6d3f42
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
5bd9ee5c0cae Initial version
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents:
diff changeset
1 #!/usr/bin/env python
25
fc1a7cf3f92c Added licence to code
Ben Croston <ben@croston.org>
parents: 22
diff changeset
2
fc1a7cf3f92c Added licence to code
Ben Croston <ben@croston.org>
parents: 22
diff changeset
3 # Copyright (c) 2011 Ben Croston
fc1a7cf3f92c Added licence to code
Ben Croston <ben@croston.org>
parents: 22
diff changeset
4 #
fc1a7cf3f92c Added licence to code
Ben Croston <ben@croston.org>
parents: 22
diff changeset
5 # Permission is hereby granted, free of charge, to any person obtaining a copy of
fc1a7cf3f92c Added licence to code
Ben Croston <ben@croston.org>
parents: 22
diff changeset
6 # this software and associated documentation files (the "Software"), to deal in
fc1a7cf3f92c Added licence to code
Ben Croston <ben@croston.org>
parents: 22
diff changeset
7 # the Software without restriction, including without limitation the rights to
fc1a7cf3f92c Added licence to code
Ben Croston <ben@croston.org>
parents: 22
diff changeset
8 # use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
fc1a7cf3f92c Added licence to code
Ben Croston <ben@croston.org>
parents: 22
diff changeset
9 # of the Software, and to permit persons to whom the Software is furnished to do
fc1a7cf3f92c Added licence to code
Ben Croston <ben@croston.org>
parents: 22
diff changeset
10 # so, subject to the following conditions:
fc1a7cf3f92c Added licence to code
Ben Croston <ben@croston.org>
parents: 22
diff changeset
11 #
fc1a7cf3f92c Added licence to code
Ben Croston <ben@croston.org>
parents: 22
diff changeset
12 # The above copyright notice and this permission notice shall be included in all
fc1a7cf3f92c Added licence to code
Ben Croston <ben@croston.org>
parents: 22
diff changeset
13 # copies or substantial portions of the Software.
fc1a7cf3f92c Added licence to code
Ben Croston <ben@croston.org>
parents: 22
diff changeset
14 #
fc1a7cf3f92c Added licence to code
Ben Croston <ben@croston.org>
parents: 22
diff changeset
15 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
fc1a7cf3f92c Added licence to code
Ben Croston <ben@croston.org>
parents: 22
diff changeset
16 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
fc1a7cf3f92c Added licence to code
Ben Croston <ben@croston.org>
parents: 22
diff changeset
17 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
fc1a7cf3f92c Added licence to code
Ben Croston <ben@croston.org>
parents: 22
diff changeset
18 # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
fc1a7cf3f92c Added licence to code
Ben Croston <ben@croston.org>
parents: 22
diff changeset
19 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
fc1a7cf3f92c Added licence to code
Ben Croston <ben@croston.org>
parents: 22
diff changeset
20 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
fc1a7cf3f92c Added licence to code
Ben Croston <ben@croston.org>
parents: 22
diff changeset
21 # SOFTWARE.
fc1a7cf3f92c Added licence to code
Ben Croston <ben@croston.org>
parents: 22
diff changeset
22
0
5bd9ee5c0cae Initial version
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents:
diff changeset
23 import os.path
5bd9ee5c0cae Initial version
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents:
diff changeset
24 import sys
10
6a1963ee4aff Added docstrings
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents: 8
diff changeset
25
0
5bd9ee5c0cae Initial version
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents:
diff changeset
26 if sys.platform.lower().startswith('win'):
10
6a1963ee4aff Added docstrings
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents: 8
diff changeset
27 IS_WINDOWS = True
0
5bd9ee5c0cae Initial version
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents:
diff changeset
28 import win32print
10
6a1963ee4aff Added docstrings
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents: 8
diff changeset
29 else:
6a1963ee4aff Added docstrings
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents: 8
diff changeset
30 IS_WINDOWS = False
22
Ben Croston
parents: 17
diff changeset
31 import subprocess
0
5bd9ee5c0cae Initial version
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents:
diff changeset
32
5bd9ee5c0cae Initial version
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents:
diff changeset
33 class zebra(object):
10
6a1963ee4aff Added docstrings
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents: 8
diff changeset
34 """A class to communicate with (Zebra) label printers using EPL2"""
6a1963ee4aff Added docstrings
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents: 8
diff changeset
35
0
5bd9ee5c0cae Initial version
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents:
diff changeset
36 def __init__(self, queue=None):
10
6a1963ee4aff Added docstrings
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents: 8
diff changeset
37 """queue - name of the printer queue (optional)"""
0
5bd9ee5c0cae Initial version
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents:
diff changeset
38 self.queue = queue
5bd9ee5c0cae Initial version
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents:
diff changeset
39
5bd9ee5c0cae Initial version
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents:
diff changeset
40 def _output_unix(self, commands):
5bd9ee5c0cae Initial version
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents:
diff changeset
41 if self.queue == 'zebra_python_unittest':
5bd9ee5c0cae Initial version
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents:
diff changeset
42 p = subprocess.Popen(['cat','-'], stdin=subprocess.PIPE)
5bd9ee5c0cae Initial version
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents:
diff changeset
43 else:
5bd9ee5c0cae Initial version
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents:
diff changeset
44 p = subprocess.Popen(['lpr','-P%s'%self.queue], stdin=subprocess.PIPE)
17
a9dacd180597 Does not work in python 2.6 after all
Ben Croston <ben@croston.org>
parents: 14
diff changeset
45 p.communicate(commands)
0
5bd9ee5c0cae Initial version
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents:
diff changeset
46 p.stdin.close()
5bd9ee5c0cae Initial version
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents:
diff changeset
47
5bd9ee5c0cae Initial version
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents:
diff changeset
48 def _output_win(self, commands):
8
19fd067db7ca Added Windows support
Ben Croston
parents: 7
diff changeset
49 if self.queue == 'zebra_python_unittest':
19fd067db7ca Added Windows support
Ben Croston
parents: 7
diff changeset
50 print commands
19fd067db7ca Added Windows support
Ben Croston
parents: 7
diff changeset
51 return
19fd067db7ca Added Windows support
Ben Croston
parents: 7
diff changeset
52 hPrinter = win32print.OpenPrinter(self.queue)
19fd067db7ca Added Windows support
Ben Croston
parents: 7
diff changeset
53 try:
19fd067db7ca Added Windows support
Ben Croston
parents: 7
diff changeset
54 hJob = win32print.StartDocPrinter(hPrinter, 1, ('Label',None,'RAW'))
19fd067db7ca Added Windows support
Ben Croston
parents: 7
diff changeset
55 try:
19fd067db7ca Added Windows support
Ben Croston
parents: 7
diff changeset
56 win32print.StartPagePrinter(hPrinter)
19fd067db7ca Added Windows support
Ben Croston
parents: 7
diff changeset
57 win32print.WritePrinter(hPrinter, commands)
19fd067db7ca Added Windows support
Ben Croston
parents: 7
diff changeset
58 win32print.EndPagePrinter(hPrinter)
19fd067db7ca Added Windows support
Ben Croston
parents: 7
diff changeset
59 finally:
19fd067db7ca Added Windows support
Ben Croston
parents: 7
diff changeset
60 win32print.EndDocPrinter(hPrinter)
19fd067db7ca Added Windows support
Ben Croston
parents: 7
diff changeset
61 finally:
19fd067db7ca Added Windows support
Ben Croston
parents: 7
diff changeset
62 win32print.ClosePrinter(hPrinter)
0
5bd9ee5c0cae Initial version
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents:
diff changeset
63
5bd9ee5c0cae Initial version
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents:
diff changeset
64 def output(self, commands):
10
6a1963ee4aff Added docstrings
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents: 8
diff changeset
65 """Output EPL2 commands to the label printer
6a1963ee4aff Added docstrings
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents: 8
diff changeset
66
6a1963ee4aff Added docstrings
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents: 8
diff changeset
67 commands - EPL2 commands to send to the printer
6a1963ee4aff Added docstrings
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents: 8
diff changeset
68 """
0
5bd9ee5c0cae Initial version
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents:
diff changeset
69 assert self.queue is not None
17
a9dacd180597 Does not work in python 2.6 after all
Ben Croston <ben@croston.org>
parents: 14
diff changeset
70 if sys.version_info[0] == 3:
a9dacd180597 Does not work in python 2.6 after all
Ben Croston <ben@croston.org>
parents: 14
diff changeset
71 if type(commands) != bytes:
a9dacd180597 Does not work in python 2.6 after all
Ben Croston <ben@croston.org>
parents: 14
diff changeset
72 commands = str(commands).encode()
a9dacd180597 Does not work in python 2.6 after all
Ben Croston <ben@croston.org>
parents: 14
diff changeset
73 else:
a9dacd180597 Does not work in python 2.6 after all
Ben Croston <ben@croston.org>
parents: 14
diff changeset
74 commands = str(commands).encode()
10
6a1963ee4aff Added docstrings
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents: 8
diff changeset
75 if IS_WINDOWS:
0
5bd9ee5c0cae Initial version
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents:
diff changeset
76 self._output_win(commands)
5bd9ee5c0cae Initial version
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents:
diff changeset
77 else:
14
e6ea86e3d0e1 Fixed typo
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents: 10
diff changeset
78 self._output_unix(commands)
0
5bd9ee5c0cae Initial version
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents:
diff changeset
79
5bd9ee5c0cae Initial version
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents:
diff changeset
80 def _getqueues_unix(self):
5bd9ee5c0cae Initial version
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents:
diff changeset
81 queues = []
5bd9ee5c0cae Initial version
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents:
diff changeset
82 output = subprocess.check_output(['lpstat','-p'], universal_newlines=True)
5bd9ee5c0cae Initial version
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents:
diff changeset
83 for line in output.split('\n'):
5bd9ee5c0cae Initial version
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents:
diff changeset
84 if line.startswith('printer'):
5bd9ee5c0cae Initial version
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents:
diff changeset
85 queues.append(line.split(' ')[1])
5bd9ee5c0cae Initial version
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents:
diff changeset
86 return queues
5bd9ee5c0cae Initial version
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents:
diff changeset
87
5bd9ee5c0cae Initial version
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents:
diff changeset
88 def _getqueues_win(self):
8
19fd067db7ca Added Windows support
Ben Croston
parents: 7
diff changeset
89 printers = []
19fd067db7ca Added Windows support
Ben Croston
parents: 7
diff changeset
90 for (a,b,name,d) in win32print.EnumPrinters(win32print.PRINTER_ENUM_LOCAL):
19fd067db7ca Added Windows support
Ben Croston
parents: 7
diff changeset
91 printers.append(name)
19fd067db7ca Added Windows support
Ben Croston
parents: 7
diff changeset
92 return printers
0
5bd9ee5c0cae Initial version
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents:
diff changeset
93
5bd9ee5c0cae Initial version
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents:
diff changeset
94 def getqueues(self):
10
6a1963ee4aff Added docstrings
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents: 8
diff changeset
95 """Returns a list of printer queues on local machine"""
6a1963ee4aff Added docstrings
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents: 8
diff changeset
96 if IS_WINDOWS:
0
5bd9ee5c0cae Initial version
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents:
diff changeset
97 return self._getqueues_win()
5bd9ee5c0cae Initial version
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents:
diff changeset
98 else:
5bd9ee5c0cae Initial version
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents:
diff changeset
99 return self._getqueues_unix()
5bd9ee5c0cae Initial version
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents:
diff changeset
100
1
21c3229ed401 Tidy up
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents: 0
diff changeset
101 def setqueue(self, queue):
10
6a1963ee4aff Added docstrings
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents: 8
diff changeset
102 """Set the printer queue"""
0
5bd9ee5c0cae Initial version
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents:
diff changeset
103 self.queue = queue
5bd9ee5c0cae Initial version
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents:
diff changeset
104
2
ad9d9bf61243 Change direct transfer to direct thermal
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents: 1
diff changeset
105 def setup(self, direct_thermal=None, label_height=None, label_width=None):
10
6a1963ee4aff Added docstrings
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents: 8
diff changeset
106 """Set up the label printer. Parameters are not set if they are None.
6a1963ee4aff Added docstrings
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents: 8
diff changeset
107
6a1963ee4aff Added docstrings
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents: 8
diff changeset
108 direct_thermal - True if using direct thermal labels
6a1963ee4aff Added docstrings
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents: 8
diff changeset
109 label_height - tuple (label height, label gap) in dots
6a1963ee4aff Added docstrings
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents: 8
diff changeset
110 label_width - in dots
6a1963ee4aff Added docstrings
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents: 8
diff changeset
111 """
0
5bd9ee5c0cae Initial version
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents:
diff changeset
112 commands = '\n'
2
ad9d9bf61243 Change direct transfer to direct thermal
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents: 1
diff changeset
113 if direct_thermal:
0
5bd9ee5c0cae Initial version
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents:
diff changeset
114 commands += ('OD\n')
5bd9ee5c0cae Initial version
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents:
diff changeset
115 if label_height:
5bd9ee5c0cae Initial version
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents:
diff changeset
116 commands += ('Q%s,%s\n'%(label_height[0],label_height[1]))
5bd9ee5c0cae Initial version
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents:
diff changeset
117 if label_width:
5bd9ee5c0cae Initial version
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents:
diff changeset
118 commands += ('q%s\n'%label_width)
5bd9ee5c0cae Initial version
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents:
diff changeset
119 self.output(commands)
5bd9ee5c0cae Initial version
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents:
diff changeset
120
5bd9ee5c0cae Initial version
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents:
diff changeset
121 def store_graphic(self, name, filename):
10
6a1963ee4aff Added docstrings
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents: 8
diff changeset
122 """Store a .PCX file on the label printer
6a1963ee4aff Added docstrings
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents: 8
diff changeset
123
6a1963ee4aff Added docstrings
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents: 8
diff changeset
124 name - name to be used on printer
6a1963ee4aff Added docstrings
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents: 8
diff changeset
125 filename - local filename
6a1963ee4aff Added docstrings
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents: 8
diff changeset
126 """
6a1963ee4aff Added docstrings
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents: 8
diff changeset
127 assert filename.lower().endswith('.pcx')
0
5bd9ee5c0cae Initial version
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents:
diff changeset
128 commands = '\nGK"%s"\n'%name
5bd9ee5c0cae Initial version
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents:
diff changeset
129 commands += 'GK"%s"\n'%name
5bd9ee5c0cae Initial version
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents:
diff changeset
130 size = os.path.getsize(filename)
5bd9ee5c0cae Initial version
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents:
diff changeset
131 commands += 'GM"%s"%s\n'%(name,size)
5bd9ee5c0cae Initial version
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents:
diff changeset
132 self.output(commands)
5bd9ee5c0cae Initial version
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents:
diff changeset
133 self.output(open(filename,'rb').read())
5bd9ee5c0cae Initial version
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents:
diff changeset
134
5bd9ee5c0cae Initial version
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents:
diff changeset
135 if __name__ == '__main__':
5bd9ee5c0cae Initial version
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents:
diff changeset
136 z = zebra()
5bd9ee5c0cae Initial version
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents:
diff changeset
137 print 'Printer queues found:',z.getqueues()
5bd9ee5c0cae Initial version
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents:
diff changeset
138 z.setqueue('zebra_python_unittest')
2
ad9d9bf61243 Change direct transfer to direct thermal
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents: 1
diff changeset
139 z.setup(direct_thermal=True, label_height=(406,32), label_width=609) # 3" x 2" direct thermal label
1
21c3229ed401 Tidy up
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents: 0
diff changeset
140 z.store_graphic('logo','logo.pcx')
0
5bd9ee5c0cae Initial version
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents:
diff changeset
141 label = """
5bd9ee5c0cae Initial version
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents:
diff changeset
142 N
5bd9ee5c0cae Initial version
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents:
diff changeset
143 GG419,40,"logo"
5bd9ee5c0cae Initial version
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents:
diff changeset
144 A40,80,0,4,1,1,N,"Tangerine Duck 4.4%"
5bd9ee5c0cae Initial version
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents:
diff changeset
145 A40,198,0,3,1,1,N,"Duty paid on 39.9l"
1
21c3229ed401 Tidy up
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents: 0
diff changeset
146 A40,240,0,3,1,1,N,"Gyle: 127 Best Before: 16/09/2011"
0
5bd9ee5c0cae Initial version
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents:
diff changeset
147 A40,320,0,4,1,1,N,"Pump & Truncheon"
5bd9ee5c0cae Initial version
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents:
diff changeset
148 P1
5bd9ee5c0cae Initial version
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents:
diff changeset
149 """
5bd9ee5c0cae Initial version
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents:
diff changeset
150 z.output(label)
5bd9ee5c0cae Initial version
Ben Croston <ben@fuzzyduckbrewery.co.uk>
parents:
diff changeset
151