Odoo Community Association

POS Printing QZ

Alpha License: AGPL-3 OCA/pos Translate me on Weblate Try me on Runboat

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:

Important

This is an alpha version, the data model and design can change at any time without warning. Only for development or testing purpose, do not use in production. More details on development status

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:

  1. Install and launch the [QZ Tray](https://qz.io/) desktop application on the machine where the thermal printer is connected.
  2. In Odoo, go to Point of Sale > Configuration > Settings.
  3. Select your POS configuration and enable QZ Tray Printing.
  4. 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.
  5. 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:

  1. Open a POS session that has QZ Tray Printing enabled.
  2. Make sure the QZ Tray desktop application is running on the POS machine.
  3. 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.

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

Authors

  • APSL Nagarro

Maintainers

This module is maintained by the OCA.

Odoo Community Association

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:

miquelalzanillas

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.