odoo-driver 0.10.0

Python library to communicates with devices used by Odoo.(Mainly Point of Sale application)Alternative to Iot Box Odoo solution or Pywebdriver community solution.

Odoo Drivers

This tools is intented to be used with the Odoo Point of sale application. It replaces the Odoo IoT Box or the Community pywebdriver library.

Once installed locally in the cashier computer, devices will be discovered by the tool, once plugged, and communication can be done with the Odoo Point of Sale module.

Table of contents

1. Run
2. Usage
3. Installation
4. Related Odoo Modules
5. Compatible Devices
6. How to Contribute
7. Development
8. Roadmap and Known Issues
9. Credits

Run

odoo-driver\
  --address 0.0.0.0\
  --port 8069\
  --secure\
  --refresh-devices-delay 1\
  --log-level INFO\
  --log-folder false\
  --options EXTRA_OPTIONS

(The values displayed above are the default values.

• -a / --address: address where the web service will be available

• -p / --port: port where the web service will be available

• --secure/--unsecure: expose webservice with https (or http, if --unsecure is selected).

• -r / --refresh-devices-delay: interval in seconds between two checks of devices connected to usb ports.

• -l / --log-level: Possible values: TRACE / DEBUG / INFO / SUCCESS / WARNING / ERROR / CRITICAL.

Note: TRACE will log all the http call. DEBUG will log all the data received, including images received by the printer device. Use INFO level or higher in production outside a debugging situation.

• -f / --log-folder: Optional directory that will contains logs. If defined, it should exist and be writable.

• --options: Json formatted data to pass to devices. Ex: '{"scale": {"polynomial": 123456}}' That will pass the polynomial value to the scale device. Note: don't forget the simple quote at the beginning and the end of the dictionnary.

Usage

Go the home page of the tool, via https://localhost:8069.

If you choose https deployment, you should accept the first time a security exception in your browser.

Pages are available to test connections, see errors, etc.

Installation

Run it manually

• install the latest released version:

pipx install odoo-driver

• or Install the latest version:

pipx install git+https://gitlab.com/grap-rhone-alpes/odoo-driver.git

Note: use --python python3.9 (or higher) option, if your default python environment is under python 3.9 version.

Run it as a service

This will create a service (via systemd) that will execute odoo-driver in the background and launches at startup.

wget https://gitlab.com/grap-rhone-alpes/odoo-driver/-/raw/main/debian_install.sh
# (OPTIONAL) adapt the installation script before execution
# adding specific argument in the call of odoo-driver in the .service file
sudo sh debian_install.sh

Once installed, you can run the following system command.

# Get status of the service
sudo systemctl status odoo-driver.service

# Follow the logs of the service
sudo journalctl -fu odoo-driver.service

Related Odoo Modules

Compatibility of the library with Odoo Modules, depending on the version.

V16

• Printer (+ Cashbox): point_of_sale (Odoo CE)

• Display: pos_odoo_driver_display

• Payment: pos_odoo_driver_payment

• Scale: point_of_sale (Odoo CE)

Compatible Devices

Printers
Epson - TM-T20II Epson - TM-T20III Epson - TM-T88V
Display
Aures - OCD 300
Payment Terminal
Ingenico - Move/5000
Scale
Mettler Toledo - Ariva S

How to Contribute

Welcome contributions

• If the project is not translated into your language, you can propose a translation.

• If you've encountered a problem or bug that you've solved, the patch will be very welcome !

Unwelcome contributions

Please do not propose a Merge Request before opening first an issue on gitlab, if you want to add new feature, new devices, etc.

Maintaining a driver library is an impossible task if you don't own the device. If the device or the feature you propose is not in the Roadmap of the GRAP company, it will be refused, to avoid rising technical debt.

In that case, do not hesitate to fork the project, to implement your change in a dedicated branch.

Development

See the dedicated section in this document.

Roadmap and Known Issues

See the dedicated section in this document.

Credits

Authors

• GRAP https://www.grap.coop

Contributors

• Sylvain LE GAL https://www.grap.coop/

Extra authorship

Part of the code in this project comes from the following projects, including:

• Pywebdriver (AGPL-3.0), by GRAP. Main contributors are:

  • Sylvain LE GAL https://www.grap.coop/
  • Sylvain CALADOR https://akretion.com/
  • Sébastien BEAU https://akretion.com/
  • Carmen BIANCA BAKKER https://coopiteasy.be/
  • Alexis DE LATTRE https://akretion.com/
  • Quentin DUPONT https://www.grap.coop/
  • Pierrick BRUN https://akretion.com/
  • Hugues DE KEYZER https://coopiteasy.be/

• hw_dialog06_scale (AGPL-3.0), by Coop It Easy. Main contributors are:

  • Vincent Van Rossem https://camptocamp.com/

• pyposdisplay (AGPL-3.0), by Akretion. Main contributors are:

  • Alexis DE LATTRE https://akretion.com/
  • Sébastien BEAU https://akretion.com/

The following projects were also useful and were studied to realize this library.

• Odoo (AGPL-3.0 up to version 8.0, and then LGPL-3.0 from version 9.0 onwards), by Odoo SA, specially "hw_" modules.

Images

• Main Application icon, by AbtoCreative (Flaticon).

• Credit Card Payment Terminal Icon, created by ToZ Icon (Flaticon).

• LCD Customer Display Icon, created by Iconic Panda (Flaticon).

• Thermal Receipt Printer Icon, created by Icongeek26 (Flaticon).

• Scale Icon, created by itim2101 (Flaticon).