Skip to content

Commit

Permalink
[BOT] post-merge updates
Browse files Browse the repository at this point in the history
  • Loading branch information
github-grap-bot committed Oct 15, 2024
1 parent 1a4aced commit e1c6bb9
Show file tree
Hide file tree
Showing 2 changed files with 119 additions and 0 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ Available addons
addon | version | maintainers | summary
--- | --- | --- | ---
[pos_odoo_driver_device_list](pos_odoo_driver_device_list/) | 16.0.1.0.0 | | Get devices information from odoo-pos-driver library
[pos_odoo_driver_display](pos_odoo_driver_display/) | 16.0.1.0.0 | | Communicate with LEC Customer Display via odoo-pos-driver library

[//]: # (end addons)

Expand Down
118 changes: 118 additions & 0 deletions pos_odoo_driver_display/README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,118 @@
======================================================
Point of Sale - LED Customer Display (odoo-pos-driver)
======================================================

..
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:7ae87e7c95b70e053ce40b11aeba6f9434118ee6056466d8e019eba525ed99c2
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
:target: https://odoo-community.org/page/development-status
:alt: Beta
.. |badge2| image:: https://img.shields.io/badge/licence-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-grap%2Fodoo--addons--pos-lightgray.png?logo=github
:target: https://github.com/grap/odoo-addons-pos/tree/16.0/pos_odoo_driver_display
:alt: grap/odoo-addons-pos

|badge1| |badge2| |badge3|

This module extends the Point of Sale odoo module, to add compatibility with the ``odoo-pos-driver``
python library, when using LED Customer display.

More information: https://pypi.org/project/odoo-pos-driver/

**Table of contents**

.. contents::
:local:

Configuration
=============

To configure this module,
* go to the menu Point of Sale > Configuration > Point of Sale
* edit the point of sale for which you want to enable the LED:

* In the IotBox section, activate the option *LED Customer Display*,
* configure the format of your LED screen. (2 lines of 20 characters, by default)

* optionaly, you can customize the *Next customer* message and the *POS closed* message

.. figure:: https://raw.githubusercontent.com/grap/odoo-addons-pos/16.0/pos_odoo_driver_display/static/img/pos_config_form.png

Usage
=====

Once everything is configured, just start the POS as usual.
You will see the following messages on the device, depending
on the events.

'Welcome' message
~~~~~~~~~~~~~~~~~

* when cashier starts the PoS
* when cashier creates a new empty PoS Order

'Close' message
~~~~~~~~~~~~~~~

* when cashier Closes the PoS

'Order Line' message
~~~~~~~~~~~~~~~~~~~~

* when cashier adds a product
* when cashier changes the Unit Price, the discount or the quantity

'Product Removal' message
~~~~~~~~~~~~~~~~~~~~~~~~~

* when cashier removes an order line

'Payment' message
~~~~~~~~~~~~~~~~~

* when the payment screen is displayed. (The device will display the total amount)
* each time a payment is created, removed, or updated. (The device will display the amount of the change to give back)

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

Bugs are tracked on `GitHub Issues <https://github.com/grap/odoo-addons-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/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**>`_.

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

Credits
=======

Authors
~~~~~~~

* GRAP

Contributors
~~~~~~~~~~~~

This module is a full refactor of the OCA V12 module ``pos_customer_display``.
Original authors and ideas are:

* Aurélien Dumaine
* Alexis de Lattre <[email protected]>
* Father Odilon (`Barroux Abbey <http://www.barroux.org/>`_)
* Daniel Kraft

Maintainers
~~~~~~~~~~~

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.

You are welcome to contribute.

0 comments on commit e1c6bb9

Please sign in to comment.