You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

129 lines
5.0 KiB

  1. ====================================
  2. Point of Sale - LED Customer Display
  3. ====================================
  4. .. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  5. !! This file is generated by oca-gen-addon-readme !!
  6. !! changes will be overwritten. !!
  7. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  8. .. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
  9. :target: https://odoo-community.org/page/development-status
  10. :alt: Beta
  11. .. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
  12. :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
  13. :alt: License: AGPL-3
  14. .. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fpos-lightgray.png?logo=github
  15. :target: https://github.com/OCA/pos/tree/12.0/pos_customer_display
  16. :alt: OCA/pos
  17. .. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
  18. :target: https://translation.odoo-community.org/projects/pos-12-0/pos-12-0-pos_customer_display
  19. :alt: Translate me on Weblate
  20. .. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
  21. :target: https://runbot.odoo-community.org/runbot/184/12.0
  22. :alt: Try me on Runbot
  23. |badge1| |badge2| |badge3| |badge4| |badge5|
  24. This module adds support for LED Customer Display in the Point of Sale.
  25. It has been tested with
  26. * Bixolon BCD-1100 (http://www.bixolon.com/html/en/product/product_detail.xhtml?prod_id=61),
  27. * Aures OCD 300 (https://www.aures.com/point-de-vente-equipment-solutions-systemes/ecrans-tactiles-afficheurs/ocd-300-350-afficheur-client-graphique)
  28. But it should support most serial and USB-serial LED displays out-of-the-box or with minor adaptations in the source code
  29. * of the module *hw_customer_display* if you use the POSbox,
  30. * or of the Python lib `pyposdisplay <https://github.com/akretion/pyposdisplay>`__ if you use `pywebdriver <https://github.com/akretion/pywebdriver>`__.
  31. **Table of contents**
  32. .. contents::
  33. :local:
  34. Installation
  35. ============
  36. This module is designed to be installed on the *main Odoo server*. On the
  37. *POSbox*, you should install the module *hw_customer_display*. But you will certainly prefer to use `pywebdriver <https://github.com/akretion/pywebdriver>`__ instead of the POSbox. Compared to the POSbox, Pywebdriver has several advantages:
  38. * 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),
  39. * availability of an Ubuntu package, for easier deployment,
  40. * native support for the customer display, payment terminal, etc.
  41. * nice test/diagnosis Web interface.
  42. Configuration
  43. =============
  44. To configure this module,
  45. * go to the menu Point of Sale > Configuration > Point of Sale
  46. * edit the point of sale for which you want to enable the LED:
  47. * In the IotBox section, activate the option *LED Customer Display*,
  48. * configure the format of your LED screen. (2 lines of 20 characters, by default)
  49. * optionaly, you can customize the *Next customer* message and the *POS closed* message
  50. Usage
  51. =====
  52. Once everything is configured, just start the POS as usual. You will see messages on the device when:
  53. * you start the POS,
  54. * you add or remove a product,
  55. * you select or deselect a customer,
  56. * you press the Payment button: the device will display the total amount,
  57. * you enter the amount of cash you receive: the device will display the amount of the change to give back,
  58. * you validate an order and go to the next customer,
  59. * you close the POS.
  60. Known issues / Roadmap
  61. ======================
  62. * Support other format, for exemple, 4 lines of 30 characters, for the Bixolon BDC-2000.
  63. Bug Tracker
  64. ===========
  65. Bugs are tracked on `GitHub Issues <https://github.com/OCA/pos/issues>`_.
  66. In case of trouble, please check there if your issue has already been reported.
  67. If you spotted it first, help us smashing it by providing a detailed and welcomed
  68. `feedback <https://github.com/OCA/pos/issues/new?body=module:%20pos_customer_display%0Aversion:%2012.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
  69. Do not contact contributors directly about support or help with technical issues.
  70. Credits
  71. =======
  72. Authors
  73. ~~~~~~~
  74. * Aurélien DUMAINE
  75. * GRAP
  76. * Akretion
  77. Contributors
  78. ~~~~~~~~~~~~
  79. * Aurélien Dumaine
  80. * Alexis de Lattre <alexis.delattre@akretion.com>
  81. * Father Odilon (`Barroux Abbey <http://www.barroux.org/>`_)
  82. * Daniel Kraft
  83. * Sylvain LE GAL ((https://twitter.com/legalsylvain))
  84. Maintainers
  85. ~~~~~~~~~~~
  86. This module is maintained by the OCA.
  87. .. image:: https://odoo-community.org/logo.png
  88. :alt: Odoo Community Association
  89. :target: https://odoo-community.org
  90. OCA, or the Odoo Community Association, is a nonprofit organization whose
  91. mission is to support the collaborative development of Odoo features and
  92. promote its widespread use.
  93. This module is part of the `OCA/pos <https://github.com/OCA/pos/tree/12.0/pos_customer_display>`_ project on GitHub.
  94. You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.