odoo-driver 2.3.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. Compatible Plugins
5. How to Contribute
6. Credits
7. Develop

Run

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

(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: DEBUG / INFO / SUCCESS / WARNING / ERROR / CRITICAL.

Note: 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.

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.10 (or higher) option, if your default python environment is under python 3.10 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
# - specific argument in the call of odoo-driver in the .service file
# - enable or disable plugins
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

Compatible Plugins

Function	Protocol	URL
Printers	ESC/POS	odoo-driver-plugin-printer-escpos
Payment Terminals	Telium	odoo-driver-plugin-payment-telium
LCD Displays	ESC/POS	odoo-driver-plugin-display-escpos
Scale	Toledo	odoo-driver-plugin-scale-toledo

How to Contribute

Welcome contributions

• If the project is not translated into your language, you can propose a translation. (Refer to the update_translation.sh helper script.)

• If you tested a plugin with a driver that is not referenced in the usb_devices.py file, and if all works correctly, please feel free to make an Merge Request, to mark this device as compatible. (add an image, make a change in usb_devices.py and in the README.md files)

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

• If you face an issue and you have a budget, you can ask for a quotation to try to solve the problem.

Unwelcome contributions

• Please do not use AI to propose Merge Requests and / or write issues. Such 'contributions' will be closed. (If you don't have time to contribute, don't ask time for review.)

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

Separate contributions

• If you want to develop a plugin that is not developped, feel free to create a new project, named odoo-driver-plugin-FUNCTION-PROTOCOL. you can take example on the existing projects.

Credits

Authors

• GRAP https://www.grap.coop

Contributors

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

Extra authorship

The following projects were useful and studied to realize this library:

• Pywebdriver (AGPL-3.0). 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/

• 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).

• Unknown device icon, by Freepik (Flaticon).

Develop

Local Installation

To install the odoo-driver library and some plugins, you can refer to this documentation:

https://gitlab.com/grap-rhone-alpes/odoo-driver-env

Documentation

Ressources used to develop this tools:

USB

List of USB devices by code:

• https://linux-hardware.org/?id=usb:30c9-000f
• http://www.linux-usb.org/usb.ids

Python Plugins

• https://packaging.python.org/en/latest/guides/creating-and-discovering-plugins/

poetry

• https://python-poetry.org/docs/basic-usage/

gevent

• https://medium.com/@aniruddhasalve/secure-deployment-of-your-flask-app-with-https-using-gevent-wsgi-server-ef8c445ba6a6
• "Gevent - Permission Denied": https://stackoverflow.com/questions/24001147/python-bind-socket-error-errno-13-permission-denied
• "Gevent - Logging": https://stackoverflow.com/questions/7574813/how-to-use-logging-inside-gevent

flask

• https://flask.palletsprojects.com/en/2.3.x/patterns/favicon/

Flask & Systemd

• https://blog.miguelgrinberg.com/post/running-a-flask-application-as-a-service-with-systemd

Hashing files in folder

• https://stackoverflow.com/questions/24937495/how-can-i-calculate-a-hash-for-a-filesystem-directory-using-python