https://github.com/python-escpos/python-escpos

Python library to manipulate ESC/POS printers
https://github.com/python-escpos/python-escpos

escpos hacktoberfest pos-printer-driver pos-printers printer python python-escpos

Last synced: 2 months ago
JSON representation

Python library to manipulate ESC/POS printers

• Host: GitHub
• URL: https://github.com/python-escpos/python-escpos
• Owner: python-escpos
• License: mit
• Created: 2015-03-17T01:20:10.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2024-08-30T12:52:12.000Z (4 months ago)
• Last Synced: 2024-09-26T07:24:55.907Z (4 months ago)
• Topics: escpos, hacktoberfest, pos-printer-driver, pos-printers, printer, python, python-escpos
• Language: Python
• Homepage: https://python-escpos.readthedocs.io
• Size: 1.1 MB
• Stars: 1,011
• Watchers: 44
• Forks: 289
• Open Issues: 48
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE
  • Authors: AUTHORS

Awesome Lists containing this project

README

        
#############################################################

python-escpos - Python library to manipulate ESC/POS Printers

#############################################################

Description

===========

.. image:: https://readthedocs.org/projects/python-escpos/badge/?version=latest

    :target: https://python-escpos.readthedocs.io/en/latest/?badge=latest

    :alt: Documentation Status

Python ESC/POS is a library which lets the user have access to all those printers handled

by ESC/POS commands, as defined by Epson, from a Python application.

The library tries to implement the functions provided by the ESC/POS-command-set and supports sending text, images,

barcodes and qr-codes to the printer.

Text can be aligned/justified and fonts can be changed by size, type and weight.

Also, this module handles some hardware functionalities like cutting paper, control characters, printer reset

and similar functions.

Since supported commands differ from printer to printer the software tries to automatically apply the right

settings for the printer that you set. These settings are handled by

`escpos-printer-db `_ which is also used in

`escpos-php `_.

Dependencies

------------

This library makes use of:

* `pyusb `_ for USB-printers

* `Pillow `_ for image printing

* `qrcode `_ for the generation of QR-codes

* `pyserial `_ for serial printers

* `python-barcode `_ for the generation of barcodes

Documentation and Usage

-----------------------

The basic usage is:

.. code:: python

    from escpos.printer import Usb

    """ Seiko Epson Corp. Receipt Printer (EPSON TM-T88III) """

    p = Usb(0x04b8, 0x0202, 0, profile="TM-T88III")

    p.text("Hello World\n")

    p.image("logo.gif")

    p.barcode('4006381333931', 'EAN13', 64, 2, '', '')

    p.cut()

Another example based on the Network printer class:

.. code:: python

    from escpos.printer import Network

    kitchen = Network("192.168.1.100") #Printer IP Address

    kitchen.text("Hello World\n")

    kitchen.barcode('4006381333931', 'EAN13', 64, 2, '', '')

    kitchen.cut()

Another example based on the Serial printer class:

.. code:: python

    from escpos.printer import Serial

    """ 9600 Baud, 8N1, Flow Control Enabled """

    p = Serial(devfile='/dev/tty.usbserial',

               baudrate=9600,

               bytesize=8,

               parity='N',

               stopbits=1,

               timeout=1.00,

               dsrdtr=True)

    p.text("Hello World\n")

    p.qr("You can readme from your smartphone")

    p.cut()

The full project-documentation is available on

`Read the Docs `_.

Contributing

------------

This project is open for any contribution! Please see

`CONTRIBUTING.rst `_

for more information.

Disclaimer

----------

None of the vendors cited in this project agree or endorse any of the

patterns or implementations.

Their names are used only to maintain context.