POS receipt printing via QZ Tray
Project description
POS Printing QZ
This module provides a pure-software alternative to the Odoo IoT Box for thermal receipt printing in the Point of Sale, using [QZ Tray](https://qz.io/) as the print driver.
It extends base_report_to_printer_qz — which adds QZ Tray backend support to printing.printer — and brings that functionality into the POS, allowing users to select a printer with backend = qztray directly from the POS configuration.
Key features:
Cash drawer support: the cash drawer open command (ESC p) is sent automatically after each receipt print.
No IoT Box required: designed as a software-only alternative for setups where deploying IoT infrastructure is not desirable.
Table of contents
Installation
This module requires the following non-Python dependency:
[QZ Tray](https://qz.io/) must be installed and running on the client machine that operates the POS.
Odoo module dependency (must be installed first):
base_report_to_printer_qz — provides the QZ Tray printer backend and the printing.printer model with backend = qztray support.
Python dependencies (installed automatically via external_dependencies):
python-escpos
Configuration
To configure this module, you need to:
Install and launch the [QZ Tray](https://qz.io/) desktop application on the machine where the thermal printer is connected.
In Odoo, go to Point of Sale > Configuration > Settings.
Select your POS configuration and enable QZ Tray Printing.
Optionally select a QZ Tray Printer from the list — only printers with backend = qztray (managed by base_report_to_printer_qz) are shown. If left empty, QZ Tray will use the system default printer.
Save the settings and open the POS session.
To extend or customise the receipt template, inherit PosEscposController in your own module and override the relevant _get_* methods (e.g. _get_header, _get_order_lines). No frontend changes are required.
Usage
To use this module, you need to:
Open a POS session that has QZ Tray Printing enabled.
Make sure the QZ Tray desktop application is running on the POS machine.
Process a sale and click Payment to print the receipt.
The receipt is sent directly to the thermal printer via QZ Tray. Receipt HTML is rendered to PNG and converted to ESC/POS format server-side before sending following native Odoo logic. The cash drawer is opened automatically after each print if enabled.
No IoT Box or network printer configuration is required.
Known issues / Roadmap
Bug Tracker
Bugs are tracked on GitHub Issues. In case of trouble, please check there if your issue has already been reported. If you spotted it first, help us to smash it by providing a detailed and welcomed feedback.
Do not contact contributors directly about support or help with technical issues.
Credits
Contributors
Miquel Alzanillas <miquel.alzanillas@nagarro.com>
Maintainers
This module is maintained by the OCA.
OCA, or the Odoo Community Association, is a nonprofit organization whose mission is to support the collaborative development of Odoo features and promote its widespread use.
Current maintainer:
This module is part of the OCA/pos project on GitHub.
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file odoo_addon_pos_printing_qztray-19.0.1.0.0.2-py3-none-any.whl.
File metadata
- Download URL: odoo_addon_pos_printing_qztray-19.0.1.0.0.2-py3-none-any.whl
- Upload date:
- Size: 42.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b170a6d9fd96ef89d088fc096dbb0831cef425cf18e8da3c574ed91e7cbc453f
|
|
| MD5 |
63b9da1f1b6ed6be7dc66961918f0ecc
|
|
| BLAKE2b-256 |
596ab7a7032f38818ccc6fa351af0e4f8c493f7072a7d1a138da9dde65785781
|