|
| 1 | +====================================================== |
| 2 | +Point of Sale - LED Customer Display (odoo-pos-driver) |
| 3 | +====================================================== |
| 4 | + |
| 5 | +.. |
| 6 | + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
| 7 | + !! This file is generated by oca-gen-addon-readme !! |
| 8 | + !! changes will be overwritten. !! |
| 9 | + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
| 10 | + !! source digest: sha256:7ae87e7c95b70e053ce40b11aeba6f9434118ee6056466d8e019eba525ed99c2 |
| 11 | + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
| 12 | +
|
| 13 | +.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png |
| 14 | + :target: https://odoo-community.org/page/development-status |
| 15 | + :alt: Beta |
| 16 | +.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png |
| 17 | + :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html |
| 18 | + :alt: License: AGPL-3 |
| 19 | +.. |badge3| image:: https://img.shields.io/badge/github-grap%2Fodoo--addons--pos-lightgray.png?logo=github |
| 20 | + :target: https://github.com/grap/odoo-addons-pos/tree/16.0/pos_odoo_driver_display |
| 21 | + :alt: grap/odoo-addons-pos |
| 22 | + |
| 23 | +|badge1| |badge2| |badge3| |
| 24 | + |
| 25 | +This module extends the Point of Sale odoo module, to add compatibility with the ``odoo-pos-driver`` |
| 26 | +python library, when using LED Customer display. |
| 27 | + |
| 28 | +More information: https://pypi.org/project/odoo-pos-driver/ |
| 29 | + |
| 30 | +**Table of contents** |
| 31 | + |
| 32 | +.. contents:: |
| 33 | + :local: |
| 34 | + |
| 35 | +Configuration |
| 36 | +============= |
| 37 | + |
| 38 | +To configure this module, |
| 39 | +* go to the menu Point of Sale > Configuration > Point of Sale |
| 40 | +* edit the point of sale for which you want to enable the LED: |
| 41 | + |
| 42 | +* In the IotBox section, activate the option *LED Customer Display*, |
| 43 | +* configure the format of your LED screen. (2 lines of 20 characters, by default) |
| 44 | + |
| 45 | +* optionaly, you can customize the *Next customer* message and the *POS closed* message |
| 46 | + |
| 47 | +.. figure:: https://raw.githubusercontent.com/grap/odoo-addons-pos/16.0/pos_odoo_driver_display/static/img/pos_config_form.png |
| 48 | + |
| 49 | +Usage |
| 50 | +===== |
| 51 | + |
| 52 | +Once everything is configured, just start the POS as usual. |
| 53 | +You will see the following messages on the device, depending |
| 54 | +on the events. |
| 55 | + |
| 56 | +'Welcome' message |
| 57 | +~~~~~~~~~~~~~~~~~ |
| 58 | + |
| 59 | +* when cashier starts the PoS |
| 60 | +* when cashier creates a new empty PoS Order |
| 61 | + |
| 62 | +'Close' message |
| 63 | +~~~~~~~~~~~~~~~ |
| 64 | + |
| 65 | +* when cashier Closes the PoS |
| 66 | + |
| 67 | +'Order Line' message |
| 68 | +~~~~~~~~~~~~~~~~~~~~ |
| 69 | + |
| 70 | +* when cashier adds a product |
| 71 | +* when cashier changes the Unit Price, the discount or the quantity |
| 72 | + |
| 73 | +'Product Removal' message |
| 74 | +~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 75 | + |
| 76 | +* when cashier removes an order line |
| 77 | + |
| 78 | +'Payment' message |
| 79 | +~~~~~~~~~~~~~~~~~ |
| 80 | + |
| 81 | +* when the payment screen is displayed. (The device will display the total amount) |
| 82 | +* each time a payment is created, removed, or updated. (The device will display the amount of the change to give back) |
| 83 | + |
| 84 | +Bug Tracker |
| 85 | +=========== |
| 86 | + |
| 87 | +Bugs are tracked on `GitHub Issues <https://github.com/grap/odoo-addons-pos/issues>`_. |
| 88 | +In case of trouble, please check there if your issue has already been reported. |
| 89 | +If you spotted it first, help us to smash it by providing a detailed and welcomed |
| 90 | +`feedback <https://github.com/grap/odoo-addons-pos/issues/new?body=module:%20pos_odoo_driver_display%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_. |
| 91 | + |
| 92 | +Do not contact contributors directly about support or help with technical issues. |
| 93 | + |
| 94 | +Credits |
| 95 | +======= |
| 96 | + |
| 97 | +Authors |
| 98 | +~~~~~~~ |
| 99 | + |
| 100 | +* GRAP |
| 101 | + |
| 102 | +Contributors |
| 103 | +~~~~~~~~~~~~ |
| 104 | + |
| 105 | +This module is a full refactor of the OCA V12 module ``pos_customer_display``. |
| 106 | +Original authors and ideas are: |
| 107 | + |
| 108 | +* Aurélien Dumaine |
| 109 | +* Alexis de Lattre <alexis.delattre@akretion.com> |
| 110 | +* Father Odilon (`Barroux Abbey <http://www.barroux.org/>`_) |
| 111 | +* Daniel Kraft |
| 112 | + |
| 113 | +Maintainers |
| 114 | +~~~~~~~~~~~ |
| 115 | + |
| 116 | +This module is part of the `grap/odoo-addons-pos <https://github.com/grap/odoo-addons-pos/tree/16.0/pos_odoo_driver_display>`_ project on GitHub. |
| 117 | + |
| 118 | +You are welcome to contribute. |
0 commit comments