Metadata-Version: 2.1
Name: odoo-addon-pos_printing_qztray
Version: 19.0.1.0.0.2
Requires-Dist: odoo-addon-base_report_to_printer_qztray==19.0.*
Requires-Dist: odoo==19.0.*
Requires-Dist: python-escpos
Summary: POS receipt printing via QZ Tray
Home-page: https://github.com/OCA/pos
License: AGPL-3
Author: APSL Nagarro, Odoo Community Association (OCA)
Author-email: support@odoo-community.org
Classifier: Programming Language :: Python
Classifier: Framework :: Odoo
Classifier: Framework :: Odoo :: 19.0
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Classifier: Development Status :: 3 - Alpha
Description-Content-Type: text/x-rst

.. image:: https://odoo-community.org/readme-banner-image
   :target: https://odoo-community.org/get-involved?utm_source=readme
   :alt: Odoo Community Association

===============
POS Printing QZ
===============

.. 
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
   !! This file is generated by oca-gen-addon-readme !!
   !! changes will be overwritten.                   !!
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
   !! source digest: sha256:7a277f359b6482de0ea78cdef95a03e8baeee84f3b3eb1c3549005b8d5882529
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

.. |badge1| image:: https://img.shields.io/badge/maturity-Alpha-red.png
    :target: https://odoo-community.org/page/development-status
    :alt: Alpha
.. |badge2| image:: https://img.shields.io/badge/license-AGPL--3-blue.png
    :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
    :alt: License: AGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fpos-lightgray.png?logo=github
    :target: https://github.com/OCA/pos/tree/19.0/pos_printing_qztray
    :alt: OCA/pos
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
    :target: https://translation.odoo-community.org/projects/pos-19-0/pos-19-0-pos_printing_qztray
    :alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
    :target: https://runboat.odoo-community.org/builds?repo=OCA/pos&target_branch=19.0
    :alt: Try me on Runboat

|badge1| |badge2| |badge3| |badge4| |badge5|

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.

.. 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 <https://odoo-community.org/page/development-status>`_

**Table of contents**

.. contents::
   :local:

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.

Known issues / Roadmap
======================



Bug Tracker
===========

Bugs are tracked on `GitHub Issues <https://github.com/OCA/pos/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 <https://github.com/OCA/pos/issues/new?body=module:%20pos_printing_qztray%0Aversion:%2019.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.

Do not contact contributors directly about support or help with technical issues.

Credits
=======

Authors
-------

* APSL Nagarro

Contributors
------------

- Miquel Alzanillas <miquel.alzanillas@nagarro.com>

Maintainers
-----------

This module is maintained by the OCA.

.. image:: https://odoo-community.org/logo.png
   :alt: Odoo Community Association
   :target: https://odoo-community.org

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.

.. |maintainer-miquelalzanillas| image:: https://github.com/miquelalzanillas.png?size=40px
    :target: https://github.com/miquelalzanillas
    :alt: miquelalzanillas

Current `maintainer <https://odoo-community.org/page/maintainer-role>`__:

|maintainer-miquelalzanillas| 

This module is part of the `OCA/pos <https://github.com/OCA/pos/tree/19.0/pos_printing_qztray>`_ project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
