Python Web Services to communicate with Devices.

The aim of this project is to ease the communication between application and Devices, providing light WebServices based on Python-Flask libraries. The software can be installed on a computer or a Raspberry-like device. It is compatible with Linux and Windows distributions.

• Features
  • Web Page
  • Specific WebServices for Odoo
• End-Users / Customers Section
• Contributors
• Developers Section
  • Installation on Ubuntu
  • Installation on Mac OS X
  • Installation on Windows 10
  • Compilation on Windows 11
  • Browser settings
  • Specific configuration
  • Development
  • Contribute
  • Localization
  • Other Projects

This apps provides a light flask app to:

• know the state of the devices;
• know informations about system;
• test communication with some devices (e.g. send a test message to the customer display, print a test ticket, etc...).

The aim of this sub project is to provide WebServices and Web Page to simulate the behaviour of Odoo Apps (hw_proxy applications & co) to allow Odoo users to use Odoo Point of Sale with PyWebDriver as a Proxy.

• Odoo8 - Odoo12:
  • Printers :
    • Epson TM-T20 II and Epson TM-T20 III
    • Epson TM-T70
    • Epson TM-P20
    • Netchip POS Printer Aures ODP 333
  • Credit Card Reader:
    • Ingenico and Sagem credit card readers with Telium Manager version 37783600 or superior
    • Ingenico i2200 check reader and writer
    • Adyen terminals (compatible with Adyen Terminal API 3.0 - https://docs.adyen.com/point-of-sale/terminal-api-fundamentals)
  • Customer Display:
    • Bixolon BCD-1100
    • Bixolon BCD-1000
    • Epson OCD300
    • SAGA SGDP240
    • Labau LD240 (non-optimal)
  • Scale:
    • Toledo protocol
      • 8217: Mettler Toledo Ariva-S
      • 8213: Mettler Toledo Ariva-S
      • No decimals: Mettler Toledo BC, Baxtran TW/VW
  • Barcode Reader:
    • They are usually recognized as keyboards and do not need pywebdriver to function
  • Cash Box :
    • The communication is usually handled by the receipt printer via Esc/Pos

If you're interested by a feature that is not currently supported, please contact our team for a quotation.

Otherwise, if you like this project, feel free to make a donation.

The main contributors of this project are :

• Sylvain Le Gal https://twitter/legalsylvain
• Sébastien Beau [email protected]
• Arthur Vuillard [email protected]
• Sylvain Calador [email protected]

A lot of the code come from other projects. Licences and copyright are mentionned in each file or in a readme file of the folder. The main other contributors are:

• Odoo Part: Odoo S.A. http://odoo.com
• Cros Decorator for Flask: Armin Ronacher http://flask.pocoo.org/snippets/56/
• ESCPOS driver: Manuel F Martinez [email protected]

wget https://raw.githubusercontent.com/pywebdriver/pywebdriver/master/debian/install.sh
sudo chmod +x install.sh
sudo ./install.sh

If you update from an OLD version, you will need to uninstall nginx after upgrading or you could face port reservation problems. Also it is not required anymore so there is no reason to have it.

If your Firefox has a master password, there will be an extra step. The terminal will ask Enter Password or Pin for "NSS Certificate DB" and you have to write your Firefox master password.

Pywebdriver can be installed on Mac OS X and is successfully used in production on a Mac OS X computer with Bixolon customer display, Ingenico credit card reader and check printer. TODO: write installation instructions.

In Windows 10, pywebdriver works as a Windows service that communicates with printers. It doesn't work on Windows 7.

• Go there : https://epson.com/Support/Point-of-Sale/Thermal-Printers/Epson-TM-T20III-Series/s/SPT_C31CH51001
• Download and install :
  • OPOS ADK v3.00ER6 (might be useless, to be tested)
  • Advanced Printer Driver v6.01

Launch "Advanced Printer Driver v6.01", select your Port Type (e.g USB), save Settings and click Test Print : it should print something !

• In this repo, get the latest build in releases : https://github.com/pywebdriver/pywebdriver/releases
• Unzip it
• Run generate_certificates.bat to make https work
• It will create two files in C:\pywebdriver
• Move the files you unzipped in this folder (some paths are absolute and would not accept that the folder could be move later on)

• Open config/config.ini with your favorite editor
• (optional) Add or remove drivers according to your needs (connection to display_driver, bank terminal)
• (optional) Change host or port number
• Add two lines in flask option for certificates (under cors_origins=*)

sslcert=c:/pywebdriver/localhost+2.pem
sslkey=c:/pywebdriver/localhost+2-key.pem

• You have to fit Windows printer's name (1) and config.ini printer_name(2) in escpos category. Either you change (1)to fit (2) or otherwise. By default, config.ini variable is escpos so you can change (1) in Windows printers configuration.

• Go to your pywebdriver folder
• Right click on install.bat file and execute it as administrator (beware, with normal display, file is just named install)
• It will create a Windows service : at Windows start, pywebdriver will be launched
• Open your browser et go to the host and port you choose. By default https://localhost:8069
• Try to print and succeed !

• Go to your pywebdriver folder
• Execute (as an admin) install.bat file and it will restart the service.

If you need to compile pywebdriver from scratch in Windows 11, it is a prerequisite to install these:

You can help yourself by using Chocolatey to install these softwares more easily

• Git
• Python 3.9
  • Click on add to PATH variable while installing, or remember where it is installed to specify later the full path to the binary.
• Microsoft Visual C++ Build Tools
  • It's enough to select Desktop development with C++, suboptions MSVC build tools and Windows 11 SDK
• InnoSetup
  • Remember where you install it. You will later need to specify the full path to the iscc.exe binary (C:\Program Files....).

Open a command window and clone the git repository. Change directory into the cloned one. Then, you can follow the installation steps outlined for windows-latest in the GitHub workflow file. If you use the CMD native terminal instead of Git-Bash, you will need to change / by \. If python.exe or iscc.exe commands are not recognized, try specifying the full path.

You need to confirmed security exception on your browers for the following paths https://localhost:8069, click on 'Advanced' and 'confirm security exception'. See here

Copy the config.ini.tmpl file to config.ini and make modifications as wished.

It is possible to load selectively drivers you need as some are incompatible.

Add a line in config.ini file like :

[application]
drivers=odoo8,cups_driver

If not, default drivers will be loaded:

• cups_driver
• display_driver
• escpos_driver
• serial_driver
• signature_driver
• telium_driver
• opcua_driver
• odoo8

It is possible to enable SSL on Flask level to avoid mixed content on browsers.

Generate private and public key (e.g.: self-signed with openssl https://www.openssl.org/docs/manmaster/man1/openssl.html) and place them at the root.

Add entries in config file like:

[flask]
sslcert=cert.pem
sslkey=privkey.pem

To test this module, do the following steps:

• download it from git;

git clone https://github.com/pywebdriver/pywebdriver.git

• Install dependency by running this two command

sudo apt-get install cups python-cups python-pip python-netifaces
sudo pip install -r requirement.txt

• set correct parameters in the config/config.ini file;
• call this command:

   python pywebdriver.py

• Call the url : http://localhost:8069 (by default, but depending of your config.ini file) in a browser to see devices state;

If you want to inspect the log file, you can specify the following snippet in config.ini. The log file name python.log will be stored in the pywebdriver installation folder unless a path is prepended to its name.

[loggers]
keys=root

[logger_root]
level=DEBUG
handlers=hand01

[handlers]
keys=hand01

[handler_hand01]
class=FileHandler
level=DEBUG
formatter=form01
args=('python.log', 'w')

[formatters]
keys=form01

[formatter_form01]
format=%(asctime)s %(levelname)8s %(message)s
datefmt=
class=logging.Formatter

If you find a bug, feel free to report it and submit a bugfix.

If you want to propose extra features not yet covered, please contact us or submit a Pull Request.

For the moment, localization is managed for english and french languages. If you want to manage extra lozalisation, do the following:

• call this command to generate '.pot' file:

pybabel extract -F translations/settings_babel.cfg -o translations/i18n.pot .

• call one of the two commands to generate '.po' file:

pybabel init -i translations/i18n.pot -d translations -l <code>  # (First time)
pybabel update -i translations/i18n.pot -d translations          # (Next times)

• Edit your '.po' file and write correct translation;
• call this command to generate '.mo' file:

pybabel compile -d translations

• Change your config.ini file to test the result;
• Do a Pull Request to share your work;

If you're interested by this project, you could perhaps take a look at these other projects:

• Odoo
• OCA pos
• OpenERP-ledDisplay
• ProxyPoS