09a598883c
* bug/doc: Fix invalid EAN-13 barcode in examples
In the various examples and python-escpos CLI there are a number of uses
of `13243546557687` as an EAN-13 example. This EAN barcode is invalid
as the checksum should be `0` and not `7`.
```
$ python test_print.py
Traceback (most recent call last):
File "test_print.py", line 5, in <module>
p.barcode('13243546557687', 'EAN13', 64, 2, '', '')
File "/home/pi/fatt-display/lib/python3.7/site-packages/escpos/escpos.py", line 433, in barcode
bc=bc,
escpos.exceptions.BarcodeCodeError: No Barcode code was supplied (Barcode '13243546557687' not in a valid format for type 'EAN13')
```
This patch set removes `13243546557687` and replaces it with the valid
number `40063813339310`.
In researching the list of [assigned prefixes issued by
G1][g1-prefixes] there seemed to be no "officially" defined test prefix, so
this change was made to be minimally invasive using the number from the
existing test cases.
Resolves #350
Affects #176
[g1-prefixes]: https://www.gs1.org/standards/id-keys/company-prefix
[test-code]: https://www.barcodelookup.com/4006381333931
---------
Co-authored-by: Brian 'Redbeard' Harrington <redbeard@dead-city.org>
105 lines
3.2 KiB
ReStructuredText
105 lines
3.2 KiB
ReStructuredText
#############################################################
|
|
python-escpos - Python library to manipulate ESC/POS Printers
|
|
#############################################################
|
|
|
|
.. image:: https://readthedocs.org/projects/python-escpos/badge/?version=latest
|
|
:target: https://python-escpos.readthedocs.io/en/latest/?badge=latest
|
|
:alt: Documentation Status
|
|
|
|
|
|
Description
|
|
-----------
|
|
|
|
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-commandset 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 <https://github.com/receipt-print-hq/escpos-printer-db>`_ which is also used in
|
|
`escpos-php <https://github.com/mike42/escpos-php>`_.
|
|
|
|
Dependencies
|
|
------------
|
|
|
|
This library makes use of:
|
|
|
|
* `pyusb <https://github.com/walac/pyusb>`_ for USB-printers
|
|
* `Pillow <https://github.com/python-pillow/Pillow>`_ for image printing
|
|
* `qrcode <https://github.com/lincolnloop/python-qrcode>`_ for the generation of QR-codes
|
|
* `pyserial <https://github.com/pyserial/pyserial>`_ for serial printers
|
|
* `python-barcode <https://github.com/WhyNotHugo/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 <https://python-escpos.readthedocs.io>`_.
|
|
|
|
Contributing
|
|
------------
|
|
|
|
This project is open for any contribution! Please see
|
|
`CONTRIBUTING.rst <https://python-escpos.readthedocs.io/en/latest/dev/contributing.html>`_
|
|
for more information.
|
|
|
|
|
|
Disclaimer
|
|
----------
|
|
|
|
None of the vendors cited in this project agree or endorse any of the
|
|
patterns or implementations.
|
|
Its names are used only to maintain context.
|