From fcb739fe154d281adbfa13ae8680d54cc985ac47 Mon Sep 17 00:00:00 2001 From: OCA-git-bot Date: Tue, 19 May 2020 20:11:57 +0000 Subject: [PATCH] [UPD] README.rst --- pos_customer_display/README.rst | 123 ++++- .../static/description/index.html | 478 ++++++++++++++++++ 2 files changed, 600 insertions(+), 1 deletion(-) create mode 100644 pos_customer_display/static/description/index.html diff --git a/pos_customer_display/README.rst b/pos_customer_display/README.rst index 91b56cb8..17a2e3d3 100644 --- a/pos_customer_display/README.rst +++ b/pos_customer_display/README.rst @@ -1,8 +1,129 @@ ==================================== -Point of Sale - LCD Customer Display +Point of Sale - LED Customer Display ==================================== .. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! !! This file is generated by oca-gen-addon-readme !! !! changes will be overwritten. !! !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |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-OCA%2Fpos-lightgray.png?logo=github + :target: https://github.com/OCA/pos/tree/12.0/pos_customer_display + :alt: OCA/pos +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png + :target: https://translation.odoo-community.org/projects/pos-12-0/pos-12-0-pos_customer_display + :alt: Translate me on Weblate +.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png + :target: https://runbot.odoo-community.org/runbot/184/12.0 + :alt: Try me on Runbot + +|badge1| |badge2| |badge3| |badge4| |badge5| + +This module adds support for LED Customer Display in the Point of Sale. + +It has been tested with + +* Bixolon BCD-1100 (http://www.bixolon.com/html/en/product/product_detail.xhtml?prod_id=61), +* Aures OCD 300 (https://www.aures.com/point-de-vente-equipment-solutions-systemes/ecrans-tactiles-afficheurs/ocd-300-350-afficheur-client-graphique) + +But it should support most serial and USB-serial LED displays out-of-the-box or with minor adaptations in the source code +* of the module *hw_customer_display* if you use the POSbox, +* or of the Python lib `pyposdisplay `__ if you use `pywebdriver `__. + +**Table of contents** + +.. contents:: + :local: + +Installation +============ + +This module is designed to be installed on the *main Odoo server*. On the +*POSbox*, you should install the module *hw_customer_display*. But you will certainly prefer to use `pywebdriver `__ instead of the POSbox. Compared to the POSbox, Pywebdriver has several advantages: + +* smaller footprint: no need to have a full-blown Odoo with PostgreSQL on the computer of the cashier (or his small Linux-based PC connected to the hardware, like the RaspberryPi for the POSbox), +* availability of an Ubuntu package, for easier deployment, +* native support for the customer display, payment terminal, etc. +* nice test/diagnosis Web interface. + +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 + +Usage +===== + +Once everything is configured, just start the POS as usual. You will see messages on the device when: + +* you start the POS, +* you add or remove a product, +* you select or deselect a customer, +* you press the Payment button: the device will display the total amount, +* you enter the amount of cash you receive: the device will display the amount of the change to give back, +* you validate an order and go to the next customer, +* you close the POS. + +Known issues / Roadmap +====================== + +* Support other format, for exemple, 4 lines of 30 characters, for the Bixolon BDC-2000. + +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 smashing it by providing a detailed and welcomed +`feedback `_. + +Do not contact contributors directly about support or help with technical issues. + +Credits +======= + +Authors +~~~~~~~ + +* Aurélien DUMAINE +* GRAP +* Akretion + +Contributors +~~~~~~~~~~~~ + +* Aurélien Dumaine +* Alexis de Lattre +* Father Odilon (`Barroux Abbey `_) +* Daniel Kraft +* Sylvain LE GAL ((https://twitter.com/legalsylvain)) + +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. + +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. diff --git a/pos_customer_display/static/description/index.html b/pos_customer_display/static/description/index.html new file mode 100644 index 00000000..ed74bf26 --- /dev/null +++ b/pos_customer_display/static/description/index.html @@ -0,0 +1,478 @@ + + + + + + +Point of Sale - LED Customer Display + + + +
+

Point of Sale - LED Customer Display

+ + +

Beta License: AGPL-3 OCA/pos Translate me on Weblate Try me on Runbot

+

This module adds support for LED Customer Display in the Point of Sale.

+

It has been tested with

+ +

But it should support most serial and USB-serial LED displays out-of-the-box or with minor adaptations in the source code +* of the module hw_customer_display if you use the POSbox, +* or of the Python lib pyposdisplay if you use pywebdriver.

+

Table of contents

+ +
+

Installation

+

This module is designed to be installed on the main Odoo server. On the +POSbox, you should install the module hw_customer_display. But you will certainly prefer to use pywebdriver instead of the POSbox. Compared to the POSbox, Pywebdriver has several advantages:

+
    +
  • smaller footprint: no need to have a full-blown Odoo with PostgreSQL on the computer of the cashier (or his small Linux-based PC connected to the hardware, like the RaspberryPi for the POSbox),
    • +
  • availability of an Ubuntu package, for easier deployment,
    • +
  • native support for the customer display, payment terminal, etc.
    • +
  • nice test/diagnosis Web interface.
    • +
+
+
+

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
    • +
+
+
+

Usage

+

Once everything is configured, just start the POS as usual. You will see messages on the device when:

+
    +
  • you start the POS,
    • +
  • you add or remove a product,
    • +
  • you select or deselect a customer,
    • +
  • you press the Payment button: the device will display the total amount,
    • +
  • you enter the amount of cash you receive: the device will display the amount of the change to give back,
    • +
  • you validate an order and go to the next customer,
    • +
  • you close the POS.
    • +
+
+
+

Known issues / Roadmap

+
    +
  • Support other format, for exemple, 4 lines of 30 characters, for the Bixolon BDC-2000.
    • +
+
+
+

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 smashing it by providing a detailed and welcomed +feedback.

+

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

+
+
+

Credits

+
+

Authors

+
    +
  • Aurélien DUMAINE
    • +
  • GRAP
    • +
  • Akretion
    • +
+
+
+

Contributors

+ +
+
+

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.

+

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.

+
+
+
+ +