Initial commit: OCA Technical packages (595 packages)

odoo-bringout-oca-pos-pos_payment_terminal/pos_payment_terminal/README.rst

@@ -0,0 +1,109 @@
+====================
+POS Payment Terminal
+====================
+
+.. 
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! This file is generated by oca-gen-addon-readme !!
+   !! changes will be overwritten.                   !!
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! source digest: sha256:90c98f4f7f6b65736ec4de9619ac22856ba9e32c5c63cb5444c4b63c381bab13
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+.. |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/16.0/pos_payment_terminal
+    :alt: OCA/pos
+.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
+    :target: https://translation.odoo-community.org/projects/pos-16-0/pos-16-0-pos_payment_terminal
+    :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=16.0
+    :alt: Try me on Runboat
+
+|badge1| |badge2| |badge3| |badge4| |badge5|
+
+This module adds support for credit card reader and checks printer
+in the Point of Sale.
+
+**Table of contents**
+
+.. contents::
+   :local:
+
+Installation
+============
+
+This module is designed to be installed on the
+*main Odoo server*. On the *POSbox/IoTbox*, you should install the module
+*hw_x* depending on the protocol implemented in your device. Remember that the POSbox/IoTbox runs Odoo v12 (even if your Odoo server runs v13 or v14), so you should look in the 12.0 branch of the `OCA POS project <https://github.com/OCA/pos>`_ to find the *hw_x* modules.
+
+`Ingenico <http://en.wikipedia.org/wiki/Ingenico>`
+card readers for France support the Telium protocol implemented in the
+*hw_telium_payment_terminal* module for the POSbox/IoTBox.
+
+You can also consider `pywebdriver project <https://github.com/akretion/pywebdriver>`_ as an alternative to the POSbox/IoTbox.
+
+Configuration
+=============
+
+* Go to *Point of Sale > Configuration > Payment Methods*, edit the
+  payment method corresponding to the card reader and set
+  the field *Use a payment terminal* to *OCA Payment Terminal*. A new field *Payment Mode* will appear, that has *Card* as defaut value. If the payment method is for Checks and you have a check printer, select *Check* instead.
+
+.. figure:: https://raw.githubusercontent.com/OCA/pos/16.0/pos_payment_terminal/static/description/pos_payment_method_form.png
+
+Usage
+=====
+
+In the frontend of the POS, when you select a payment method that has a payment mode with *Use a Payment Terminal* set to *OCA Payment Terminal*, you will have an additionnal *Send* button: if you click on that button, the amount, the currency and the payment mode will be sent to the POSbox/IoTBox/pywebdriver.
+
+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_payment_terminal%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
+~~~~~~~
+
+* Aurélien DUMAINE
+* GRAP
+* Akretion
+* ACSONE SA/NV
+
+Contributors
+~~~~~~~~~~~~
+
+* Aurelien Dumaine
+* Alexis de Lattre <alexis.delattre@akretion.com>
+* 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 <https://github.com/OCA/pos/tree/16.0/pos_payment_terminal>`_ project on GitHub.
+
+You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.