What kind of hardware is supported by the Point of Sale ?

I want to set up a Point of Sale at my shop, and I wonder what kind of hardware is supported. Is there a list somewhere ? Where do I get started ?

Standard Hardware

  • Barcode scanners :
    • any kind of EAN13 usb barcode scanner should be supported. Make sure you configure it to always emit 13 characters (sometimes they ignore the zero at the start, and then it doesn't work) and that it doesn't end with a special control character. Newline should work Ok.
  • Touchscreens :
    • Any kind of resistive or multitouch screen should work. In those cases you may want to activate the on screen keyboard in the Point of Sale settings.
  • Printers :
    • In the default settings, the Point of sale will use the browser to print. In this case any laser or inkjet printer supported by your operating system will work. But those kinds of printers are not ideally suited for printing receipts. There is a 'Print by Proxy' settings that enables you to bypass the browser and directly use your printer, but in this case you'll need to develop a driver for your printer or find one provided by the community.

Custom Hardware

Because the Point of Sale runs in your browser, it is sandboxed and cannot access your hardware directly. To solve that problem, we developed a custom proxy server that must be run on the client machine while running the point of sale. The Proxy server can access your hardware and forward commands to and from the Point of Sale.

The proxy server is part of a standard Odoo install. All you have to do is install Odoo on the client machine and run it with a default setup. What you'll need to do, however, is to customize the proxy to talk to your hardware.

The proxy is located in addons/point_of_sale/controllers/main.py In that file there are several stub rpc methods that will be called by the point of sale to control the hardware. You will need to implement these methods to use your hardware. There is more documentation available for these methods in the addons/point_of_sale/static/src/js/devices.js file. Some of there stubs are for functionality that couldn't be finished and fully tested before release, I'll mark them below as WIP.

Here is a list of the methods available :

scan_item_success(self,request, ean) scan_item_error_unrecognized(self,request,ean) help_needed(self, request) help_canceled(self,request) weighting_start(self,request) weighting_read_kg(self,request) weighting_end(self,request) #WIP payment_request(self,request,price) #WIP payment_status(self,request) #WIP payment_cancel(self,request) transaction_start(self, request) transaction_end(self,request) cashier_mode_activated(self,request) cashier_mode_deactivated(self,request) open_cashbox(self,request) print_receipt(self,request,receipt) #WIP print_pdf_invoice(self,request, pdfinvoice)

Need more info?

This documentation page has been extracted from the Q&A section where you can discuss it and get feedback.
Related question