mirror of
https://github.com/OCA/report-print-send.git
synced 2025-02-16 07:11:31 +02:00
[ADD] Add printer_zpl2 module (#66)
* [FIX] printer_tray: Allow to call print_option with no report * [ADD] Add printer_zpl2 module
This commit is contained in:
Sylvain Garancher
committed by
Florent de Labarre
Florent de Labarre
parent
720fece886
commit
08de98fea9
6
printer_zpl2/models/__init__.py
Normal file
6
printer_zpl2/models/__init__.py
Normal file
@@ -0,0 +1,6 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright (C) 2016 SYLEAM (<http://www.syleam.fr>)
|
||||
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
|
||||
|
||||
from . import printing_label_zpl2_component
|
||||
from . import printing_label_zpl2
|
||||
188
printer_zpl2/models/printing_label_zpl2.py
Normal file
188
printer_zpl2/models/printing_label_zpl2.py
Normal file
@@ -0,0 +1,188 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright (C) 2016 SYLEAM (<http://www.syleam.fr>)
|
||||
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
|
||||
|
||||
import time
|
||||
import datetime
|
||||
import logging
|
||||
from openerp import api, exceptions, fields, models
|
||||
from openerp.tools.translate import _
|
||||
from openerp.tools.safe_eval import safe_eval
|
||||
|
||||
_logger = logging.getLogger(__name__)
|
||||
|
||||
try:
|
||||
import zpl2
|
||||
except ImportError:
|
||||
_logger.debug('Cannot `import zpl2`.')
|
||||
|
||||
|
||||
class PrintingLabelZpl2(models.Model):
|
||||
_name = 'printing.label.zpl2'
|
||||
_description = 'ZPL II Label'
|
||||
|
||||
name = fields.Char(required=True, help='Label Name.')
|
||||
description = fields.Char(help='Long description for this label.')
|
||||
model_id = fields.Many2one(
|
||||
comodel_name='ir.model', string='Model', required=True,
|
||||
help='Model used to print this label.')
|
||||
origin_x = fields.Integer(
|
||||
required=True, default=10,
|
||||
help='Origin point of the contents in the label, X coordinate.')
|
||||
origin_y = fields.Integer(
|
||||
required=True, default=10,
|
||||
help='Origin point of the contents in the label, Y coordinate.')
|
||||
width = fields.Integer(
|
||||
required=True, default=480,
|
||||
help='With of the label, will be set on the printer before printing.')
|
||||
component_ids = fields.One2many(
|
||||
comodel_name='printing.label.zpl2.component', inverse_name='label_id',
|
||||
string='Label Components',
|
||||
help='Components which will be printed on the label.')
|
||||
|
||||
@api.multi
|
||||
def _generate_zpl2_components_data(
|
||||
self, label_data, record, page_number=1, page_count=1,
|
||||
label_offset_x=0, label_offset_y=0, **extra):
|
||||
self.ensure_one()
|
||||
|
||||
# Add all elements to print in a list of tuples :
|
||||
# [(component, data, offset_x, offset_y)]
|
||||
to_print = []
|
||||
for component in self.component_ids:
|
||||
eval_args = extra
|
||||
eval_args.update({
|
||||
'object': record,
|
||||
'page_number': str(page_number + 1),
|
||||
'page_count': str(page_count),
|
||||
'time': time,
|
||||
'datetime': datetime,
|
||||
})
|
||||
data = safe_eval(component.data, eval_args) or ''
|
||||
|
||||
# Generate a list of elements if the component is repeatable
|
||||
for idx in range(
|
||||
component.repeat_offset,
|
||||
component.repeat_offset + component.repeat_count):
|
||||
printed_data = data
|
||||
# Pick the right value if data is a collection
|
||||
if isinstance(data, (list, tuple, set, models.BaseModel)):
|
||||
# If we reached the end of data, quit the loop
|
||||
if idx >= len(data):
|
||||
break
|
||||
|
||||
# Set the real data to display
|
||||
printed_data = data[idx]
|
||||
|
||||
position = idx - component.repeat_offset
|
||||
to_print.append((
|
||||
component, printed_data,
|
||||
label_offset_x + component.repeat_offset_x * position,
|
||||
label_offset_y + component.repeat_offset_y * position,
|
||||
))
|
||||
|
||||
for (component, data, offset_x, offset_y) in to_print:
|
||||
component_offset_x = component.origin_x + offset_x
|
||||
component_offset_y = component.origin_y + offset_y
|
||||
if component.component_type == 'text':
|
||||
barcode_arguments = dict([
|
||||
(field_name, component[field_name])
|
||||
for field_name in [
|
||||
zpl2.ARG_FONT,
|
||||
zpl2.ARG_ORIENTATION,
|
||||
zpl2.ARG_HEIGHT,
|
||||
zpl2.ARG_WIDTH,
|
||||
zpl2.ARG_REVERSE_PRINT,
|
||||
zpl2.ARG_IN_BLOCK,
|
||||
zpl2.ARG_BLOCK_WIDTH,
|
||||
zpl2.ARG_BLOCK_LINES,
|
||||
zpl2.ARG_BLOCK_SPACES,
|
||||
zpl2.ARG_BLOCK_JUSTIFY,
|
||||
zpl2.ARG_BLOCK_LEFT_MARGIN,
|
||||
]
|
||||
])
|
||||
label_data.font_data(
|
||||
component_offset_x, component_offset_y,
|
||||
barcode_arguments, data)
|
||||
elif component.component_type == 'rectangle':
|
||||
label_data.graphic_box(
|
||||
component_offset_x, component_offset_y, {
|
||||
zpl2.ARG_WIDTH: component.width,
|
||||
zpl2.ARG_HEIGHT: component.height,
|
||||
zpl2.ARG_THICKNESS: component.thickness,
|
||||
zpl2.ARG_COLOR: component.color,
|
||||
zpl2.ARG_ROUNDING: component.rounding,
|
||||
})
|
||||
elif component.component_type == 'circle':
|
||||
label_data.graphic_circle(
|
||||
component_offset_x, component_offset_y, {
|
||||
zpl2.ARG_DIAMETER: component.width,
|
||||
zpl2.ARG_THICKNESS: component.thickness,
|
||||
zpl2.ARG_COLOR: component.color,
|
||||
})
|
||||
elif component.component_type == 'sublabel':
|
||||
component_offset_x += component.sublabel_id.origin_x
|
||||
component_offset_y += component.sublabel_id.origin_y
|
||||
component.sublabel_id._generate_zpl2_components_data(
|
||||
label_data, data,
|
||||
label_offset_x=component_offset_x,
|
||||
label_offset_y=component_offset_y)
|
||||
else:
|
||||
barcode_arguments = dict([
|
||||
(field_name, component[field_name])
|
||||
for field_name in [
|
||||
zpl2.ARG_ORIENTATION,
|
||||
zpl2.ARG_CHECK_DIGITS,
|
||||
zpl2.ARG_HEIGHT,
|
||||
zpl2.ARG_INTERPRETATION_LINE,
|
||||
zpl2.ARG_INTERPRETATION_LINE_ABOVE,
|
||||
zpl2.ARG_SECURITY_LEVEL,
|
||||
zpl2.ARG_COLUMNS_COUNT,
|
||||
zpl2.ARG_ROWS_COUNT,
|
||||
zpl2.ARG_TRUNCATE,
|
||||
zpl2.ARG_MODULE_WIDTH,
|
||||
zpl2.ARG_BAR_WIDTH_RATIO,
|
||||
]
|
||||
])
|
||||
label_data.barcode_data(
|
||||
component.origin_x + offset_x,
|
||||
component.origin_y + offset_y,
|
||||
component.component_type, barcode_arguments, data)
|
||||
|
||||
@api.multi
|
||||
def _generate_zpl2_data(self, record, page_count=1, **extra):
|
||||
self.ensure_one()
|
||||
label_data = zpl2.Zpl2()
|
||||
|
||||
for page_number in range(page_count):
|
||||
# Initialize printer's configuration
|
||||
label_data.label_start()
|
||||
label_data.print_width(self.width)
|
||||
label_data.label_encoding()
|
||||
|
||||
label_data.label_home(self.origin_x, self.origin_y)
|
||||
|
||||
self._generate_zpl2_components_data(
|
||||
label_data, record, page_number=page_number,
|
||||
page_count=page_count)
|
||||
|
||||
# Restore printer's configuration and end the label
|
||||
label_data.configuration_update(zpl2.CONF_RECALL_LAST_SAVED)
|
||||
label_data.label_end()
|
||||
|
||||
return label_data.output()
|
||||
|
||||
@api.multi
|
||||
def print_label(self, printer, record, page_count=1, **extra):
|
||||
for label in self:
|
||||
if record._name != label.model_id.model:
|
||||
raise exceptions.UserError(
|
||||
_('This label cannot be used on {model}').format(
|
||||
model=record._name))
|
||||
|
||||
# Send the label to printer
|
||||
label_contents = label._generate_zpl2_data(
|
||||
record, page_count=page_count, **extra)
|
||||
printer.print_document(None, label_contents, 'raw')
|
||||
|
||||
return True
|
||||
144
printer_zpl2/models/printing_label_zpl2_component.py
Normal file
144
printer_zpl2/models/printing_label_zpl2_component.py
Normal file
@@ -0,0 +1,144 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright (C) 2016 SYLEAM (<http://www.syleam.fr>)
|
||||
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
|
||||
|
||||
import logging
|
||||
from openerp import fields, models
|
||||
|
||||
_logger = logging.getLogger(__name__)
|
||||
|
||||
try:
|
||||
import zpl2
|
||||
except ImportError:
|
||||
_logger.debug('Cannot `import zpl2`.')
|
||||
|
||||
|
||||
class PrintingLabelZpl2Component(models.Model):
|
||||
_name = 'printing.label.zpl2.component'
|
||||
_description = 'ZPL II Label Component'
|
||||
_order = 'sequence'
|
||||
|
||||
label_id = fields.Many2one(
|
||||
comodel_name='printing.label.zpl2', string='Label',
|
||||
required=True, ondelete='cascade', help='Label using this component.')
|
||||
sequence = fields.Integer(help='Order used to print the elements.')
|
||||
name = fields.Char(required=True, help='Name of the component.')
|
||||
origin_x = fields.Integer(
|
||||
required=True, default=10,
|
||||
help='Origin point of the component in the label, X coordinate.')
|
||||
origin_y = fields.Integer(
|
||||
required=True, default=10,
|
||||
help='Origin point of the component in the label, Y coordinate.')
|
||||
component_type = fields.Selection(
|
||||
selection=[
|
||||
('text', 'Text'),
|
||||
('rectangle', 'Rectangle / Line'),
|
||||
('circle', 'Circle'),
|
||||
(zpl2.BARCODE_CODE_11, 'Code 11'),
|
||||
(zpl2.BARCODE_INTERLEAVED_2_OF_5, 'Interleaved 2 of 5'),
|
||||
(zpl2.BARCODE_CODE_39, 'Code 39'),
|
||||
(zpl2.BARCODE_CODE_49, 'Code 49'),
|
||||
(zpl2.BARCODE_PDF417, 'PDF417'),
|
||||
(zpl2.BARCODE_EAN_8, 'EAN-8'),
|
||||
(zpl2.BARCODE_UPC_E, 'UPC-E'),
|
||||
(zpl2.BARCODE_CODE_128, 'Code 128'),
|
||||
(zpl2.BARCODE_EAN_13, 'EAN-13'),
|
||||
('sublabel', 'Sublabel'),
|
||||
], string='Type', required=True, default='text', oldname='type',
|
||||
help='Type of content, simple text or barcode.')
|
||||
font = fields.Selection(
|
||||
selection=[
|
||||
(zpl2.FONT_DEFAULT, 'Default'),
|
||||
(zpl2.FONT_9X5, '9x5'),
|
||||
(zpl2.FONT_11X7, '11x7'),
|
||||
(zpl2.FONT_18X10, '18x10'),
|
||||
(zpl2.FONT_28X15, '28x15'),
|
||||
(zpl2.FONT_26X13, '26x13'),
|
||||
(zpl2.FONT_60X40, '60x40'),
|
||||
(zpl2.FONT_21X13, '21x13'),
|
||||
], required=True, default=zpl2.FONT_DEFAULT,
|
||||
help='Font to use, for text only.')
|
||||
thickness = fields.Integer(help='Thickness of the line to draw.')
|
||||
color = fields.Selection(
|
||||
selection=[
|
||||
(zpl2.COLOR_BLACK, 'Black'),
|
||||
(zpl2.COLOR_WHITE, 'White'),
|
||||
], default=zpl2.COLOR_BLACK,
|
||||
help='Color of the line to draw.')
|
||||
orientation = fields.Selection(
|
||||
selection=[
|
||||
(zpl2.ORIENTATION_NORMAL, 'Normal'),
|
||||
(zpl2.ORIENTATION_ROTATED, 'Rotated'),
|
||||
(zpl2.ORIENTATION_INVERTED, 'Inverted'),
|
||||
(zpl2.ORIENTATION_BOTTOM_UP, 'Read from Bottom up'),
|
||||
], required=True, default=zpl2.ORIENTATION_NORMAL,
|
||||
help='Orientation of the barcode.')
|
||||
check_digits = fields.Boolean(
|
||||
help='Check if you want to compute and print the check digit.')
|
||||
height = fields.Integer(
|
||||
help='Height of the printed component. For a text component, height '
|
||||
'of a single character.')
|
||||
width = fields.Integer(
|
||||
help='Width of the printed component. For a text component, width of '
|
||||
'a single character.')
|
||||
rounding = fields.Integer(
|
||||
help='Rounding of the printed rectangle corners.')
|
||||
interpretation_line = fields.Boolean(
|
||||
help='Check if you want the interpretation line to be printed.')
|
||||
interpretation_line_above = fields.Boolean(
|
||||
help='Check if you want the interpretation line to be printed above '
|
||||
'the barcode.')
|
||||
module_width = fields.Integer(
|
||||
default=2, help='Module width for the barcode.')
|
||||
bar_width_ratio = fields.Float(
|
||||
default=3.0, help='Ratio between wide bar and narrow bar.')
|
||||
security_level = fields.Integer(help='Security level for error detection.')
|
||||
columns_count = fields.Integer(help='Number of data columns to encode.')
|
||||
rows_count = fields.Integer(help='Number of rows to encode.')
|
||||
truncate = fields.Boolean(
|
||||
help='Check if you want to truncate the barcode.')
|
||||
data = fields.Char(
|
||||
size=256, default='""', required=True,
|
||||
help='Data to print on this component. Resource values can be '
|
||||
'inserted with %(object.field_name)s.')
|
||||
sublabel_id = fields.Many2one(
|
||||
comodel_name='printing.label.zpl2', string='Sublabel',
|
||||
help='Another label to include into this one as a component. '
|
||||
'This allows to define reusable labels parts.')
|
||||
repeat = fields.Boolean(
|
||||
string='Repeatable',
|
||||
help='Check this box to repeat this component on the label.')
|
||||
repeat_offset = fields.Integer(
|
||||
default=0,
|
||||
help='Number of elements to skip when reading a list of elements.')
|
||||
repeat_count = fields.Integer(
|
||||
default=1,
|
||||
help='Maximum count of repeats of the component.')
|
||||
repeat_offset_x = fields.Integer(
|
||||
help='X coordinate offset between each occurence of this component on '
|
||||
'the label.')
|
||||
repeat_offset_y = fields.Integer(
|
||||
help='Y coordinate offset between each occurence of this component on '
|
||||
'the label.')
|
||||
reverse_print = fields.Boolean(
|
||||
help='If checked, the data will be printed in the inverse color of '
|
||||
'the background.')
|
||||
in_block = fields.Boolean(
|
||||
help='If checked, the data will be restrected in a '
|
||||
'defined block on the label.')
|
||||
block_width = fields.Integer(help='Width of the block.')
|
||||
block_lines = fields.Integer(
|
||||
default=1, help='Maximum number of lines to print in the block.')
|
||||
block_spaces = fields.Integer(
|
||||
help='Number of spaces added between lines in the block.')
|
||||
block_justify = fields.Selection(
|
||||
selection=[
|
||||
(zpl2.JUSTIFY_LEFT, 'Left'),
|
||||
(zpl2.JUSTIFY_CENTER, 'Center'),
|
||||
(zpl2.JUSTIFY_JUSTIFIED, 'Justified'),
|
||||
(zpl2.JUSTIFY_RIGHT, 'Right'),
|
||||
], string='Justify', required=True, default='L',
|
||||
help='Choose how the text will be justified in the block.')
|
||||
block_left_margin = fields.Integer(
|
||||
string='Left Margin',
|
||||
help='Left margin for the second and other lines in the block.')
|
||||
Reference in New Issue
Block a user