python-escpos/escpos/cli.py

366 lines
9.2 KiB
Python
Executable File

#!/usr/bin/env python
from __future__ import absolute_import
import argparse
import sys
import serial
from escpos import printer
from escpos import constants
parser = argparse.ArgumentParser(
description='CLI for python-escpos',
epilog='To see help for escpos commands, run with a destination defined.',
usage='python -m escpos.cli destination_type [--args] command [--args]'
)
dest_subparsers = parser.add_subparsers(
title='Destination',
)
parser_dest_file = dest_subparsers.add_parser('file', help='Print to a file')
parser_dest_file.set_defaults(func=printer.File)
parser_dest_file.add_argument(
'--devfile',
help='Destination file',
required=True
)
parser_dest_network = dest_subparsers.add_parser('network', help='Print to a network device')
parser_dest_network.set_defaults(func=printer.Network)
parser_dest_network.add_argument(
'--host',
help='Destination host',
required=True
)
parser_dest_network.add_argument(
'--port',
help='Destination port',
type=int
)
parser_dest_network.add_argument(
'--timeout',
help='Timeout in seconds',
type=int
)
parser_dest_usb = dest_subparsers.add_parser('usb', help='Print to a usb device')
parser_dest_usb.set_defaults(func=printer.Usb)
parser_dest_usb.add_argument(
'--idVendor',
help='USB Vendor ID',
required=True
)
parser_dest_usb.add_argument(
'--idProduct',
help='USB Device ID',
required=True
)
parser_dest_usb.add_argument(
'--interface',
help='USB device interface',
type=int
)
parser_dest_usb.add_argument(
'--in_ep',
help='Input end point',
type=int
)
parser_dest_usb.add_argument(
'--out_ep',
help='Output end point',
type=int
)
parser_dest_serial = dest_subparsers.add_parser(
'serial',
help='Print to a serial device'
)
parser_dest_serial.set_defaults(func=printer.Serial)
parser_dest_serial.add_argument(
'--devfile',
help='Device file'
)
parser_dest_serial.add_argument(
'--baudrate',
help='Baudrate for serial transmission',
type=int
)
parser_dest_serial.add_argument(
'--bytesize',
help='Serial byte size',
type=int
)
parser_dest_serial.add_argument(
'--timeout',
help='Read/Write timeout in seconds',
type=int
)
parser_dest_serial.add_argument(
'--parity',
help='Parity checking',
choices=[serial.PARITY_NONE, serial.PARITY_EVEN, serial.PARITY_ODD, serial.PARITY_MARK, serial.PARITY_SPACE]
)
parser_dest_serial.add_argument(
'--stopbits',
help='Number of stopbits',
choices=[serial.STOPBITS_ONE, serial.STOPBITS_ONE_POINT_FIVE, serial.STOPBITS_TWO]
)
parser_dest_serial.add_argument(
'--xonxoff',
help='Software flow control',
type=bool
)
parser_dest_serial.add_argument(
'--dsrdtr',
help='Hardware flow control (False to enable RTS,CTS)',
type=bool
)
cmd_parser = argparse.ArgumentParser(
description='Parser for escpos commands',
usage='{previous command parts} {espos command} ...'
)
command_subparsers = cmd_parser.add_subparsers(
title='ESCPOS Command',
)
# From here on func needs to be a string, since we don't have a printer to work on yet
parser_command_qr = command_subparsers.add_parser('qr', help='Print a QR code')
parser_command_qr.set_defaults(func='qr')
parser_command_qr.add_argument(
'--text',
help='Text to print as a qr code',
required=True
)
parser_command_barcode = command_subparsers.add_parser('barcode', help='Print a barcode')
parser_command_barcode.set_defaults(func='barcode')
parser_command_barcode.add_argument(
'--code',
help='Barcode data to print',
required=True
)
parser_command_barcode.add_argument(
'--bc',
help='Barcode format',
required=True
)
parser_command_barcode.add_argument(
'--height',
help='Barcode height in px',
type=int
)
parser_command_barcode.add_argument(
'--width',
help='Barcode width',
type=int
)
parser_command_barcode.add_argument(
'--pos',
help='Label position',
choices=['BELOW', 'ABOVE', 'BOTH', 'OFF']
)
parser_command_barcode.add_argument(
'--font',
help='Label font',
choices=['A', 'B']
)
parser_command_barcode.add_argument(
'--align_ct',
help='Align barcode center',
type=bool
)
parser_command_barcode.add_argument(
'--function_type',
help='ESCPOS function type',
choices=['A', 'B']
)
parser_command_text = command_subparsers.add_parser('text', help='Print plain text')
parser_command_text.set_defaults(func='text')
parser_command_text.add_argument(
'--txt',
help='Text to print',
required=True
)
parser_command_block_text = command_subparsers.add_parser('block_text', help='Print wrapped text')
parser_command_block_text.set_defaults(func='block_text')
parser_command_block_text.add_argument(
'--txt',
help='block_text to print',
required=True
)
parser_command_block_text.add_argument(
'--columns',
help='Number of columns',
type=int
)
parser_command_cut = command_subparsers.add_parser('cut', help='Cut the paper')
parser_command_cut.set_defaults(func='cut')
parser_command_cut.add_argument(
'--mode',
help='Type of cut',
choices=['FULL', 'PART']
)
parser_command_cashdraw = command_subparsers.add_parser('cashdraw', help='Kick the cash drawer')
parser_command_cashdraw.set_defaults(func='cashdraw')
parser_command_cashdraw.add_argument(
'--pin',
help='Which PIN to kick',
choices=[2, 5]
)
parser_command_image = command_subparsers.add_parser('image', help='Print an image')
parser_command_image.set_defaults(func='image')
parser_command_image.add_argument(
'--path_img',
help='Path to image',
required=True
)
parser_command_fullimage = command_subparsers.add_parser('fullimage', help='Print an fullimage')
parser_command_fullimage.set_defaults(func='fullimage')
parser_command_fullimage.add_argument(
'--img',
help='Path to img',
required=True
)
parser_command_fullimage.add_argument(
'--max_height',
help='Max height of image in px',
type=int
)
parser_command_fullimage.add_argument(
'--width',
help='Max width of image in px',
type=int
)
parser_command_fullimage.add_argument(
'--histeq',
help='Equalize the histrogram',
type=bool
)
parser_command_fullimage.add_argument(
'--bandsize',
help='Size of bands to divide into when printing',
type=int
)
# Not supported
# parser_command_direct_image = command_subparsers.add_parser('direct_direct_image', help='Print an direct_image')
# parser_command_direct_image.set_defaults(func='direct_image')
parser_command_charcode = command_subparsers.add_parser('charcode', help='Set character code table')
parser_command_charcode.set_defaults(func='charcode')
parser_command_charcode.add_argument(
'--code',
help='Character code',
required=True
)
parser_command_set = command_subparsers.add_parser('set', help='Set text properties')
parser_command_set.set_defaults(func='set')
parser_command_set.add_argument(
'--align',
help='Horizontal alignment',
choices=['left', 'center', 'right']
)
parser_command_set.add_argument(
'--font',
help='Font choice',
choices=['left', 'center', 'right']
)
parser_command_set.add_argument(
'--text_type',
help='Text properties',
choices=['B', 'U', 'U2', 'BU', 'BU2', 'NORMAL']
)
parser_command_set.add_argument(
'--width',
help='Width multiplier',
type=int
)
parser_command_set.add_argument(
'--height',
help='Height multiplier',
type=int
)
parser_command_set.add_argument(
'--density',
help='Print density',
type=int
)
parser_command_set.add_argument(
'--invert',
help='White on black printing',
type=bool
)
parser_command_set.add_argument(
'--smooth',
help='Text smoothing. Effective on >= 4x4 text',
type=bool
)
parser_command_set.add_argument(
'--flip',
help='Text smoothing. Effective on >= 4x4 text',
type=bool
)
parser_command_hw = command_subparsers.add_parser('hw', help='Hardware operations')
parser_command_hw.set_defaults(func='hw')
parser_command_hw.add_argument(
'--hw',
help='Operation',
choices=['INIT', 'SELECT', 'RESET'],
required=True
)
parser_command_control = command_subparsers.add_parser('control', help='Control sequences')
parser_command_control.set_defaults(func='control')
parser_command_control.add_argument(
'--ctl',
help='Control sequence',
choices=['LF', 'FF', 'CR', 'HT', 'VT'],
required=True
)
parser_command_control.add_argument(
'--pos',
help='Horizontal tab position (1-4)',
type=int
)
parser_command_panel_buttons = command_subparsers.add_parser('panel_buttons', help='Disables panel buttons')
parser_command_panel_buttons.set_defaults(func='panel_buttons')
parser_command_panel_buttons.add_argument(
'--enable',
help='Feed button enabled',
type=bool,
required=True
)
# Get arguments along with function to pass them to
args, rest = parser.parse_known_args()
# filter out function name and non passed arguments
func_args = dict((k, v) for k, v in vars(args).iteritems() if v and k != 'func')
# define a printer
p = args.func(**func_args)
if not rest:
cmd_parser.print_help()
sys.exit(1)
cmd_args = cmd_parser.parse_args(rest)
# filter out function name and non passed arguments
func_args = dict((k, v) for k, v in vars(cmd_args).iteritems() if v and k != 'func')
# print command with args
getattr(p, cmd_args.func)(**func_args)