Initial check-in of the module hw_customer_display.

hw_customer_display/__init__.py

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+##############################################################################
+#
+#    Hardware Customer Display module for OpenERP
+#    Copyright (C) 2014 Akretion (http://www.akretion.com)
+#    @author Alexis de Lattre <alexis.delattre@akretion.com>
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU Affero General Public License as
+#    published by the Free Software Foundation, either version 3 of the
+#    License, or (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU Affero General Public License for more details.
+#
+#    You should have received a copy of the GNU Affero General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+##############################################################################
+
+
+from . import controllers

hw_customer_display/__openerp__.py

@@ -0,0 +1,56 @@
+# -*- encoding: utf-8 -*-
+##############################################################################
+#
+#    Hardware Customer Display module for OpenERP
+#    Copyright (C) 2014 Akretion (http://www.akretion.com)
+#    @author Alexis de Lattre <alexis.delattre@akretion.com>
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU Affero General Public License as
+#    published by the Free Software Foundation, either version 3 of the
+#    License, or (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU Affero General Public License for more details.
+#
+#    You should have received a copy of the GNU Affero General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+##############################################################################
+
+
+{
+    'name': 'Hardware Customer Display',
+    'version': '0.1',
+    'category': 'Hardware Drivers',
+    'license': 'AGPL-3',
+    'summary': 'Adds a support for Customer LCD in Point of Sale',
+    'description': """
+Hardware Customer Display
+=========================
+
+This module adds support for Customer Display in the Point of Sale. It has been tested with a Bixolon BCD-1100 (http://www.bixolon.com/html/en/product/product_detail.xhtml?prod_id=61), but should support most serial and USB-serial LCD displays out-of-the-box or with inheritance of a few functions. This module is designed to be installed on the *POSbox* (i.e. the proxy on which the USB devices are connected) and not on the Odoo server.
+
+The configuration of the hardware is done in the configuration file of the Odoo server of the POSbox. You should add the following entries in the configuration file:
+
+* customer_display_device_name (default = /dev/ttyUSB0)
+* customer_display_device_rate (default = 9600)
+* customer_display_device_timeout (default = 2 seconds)
+* customer_display_device_rows (default = 2)
+* customer_display_device_cols (default = 20)
+
+This module has been developped during a POS code sprint at Akretion France from July 7th to July 10th 2014.
+
+Please contact Alexis de Lattre from Akretion <alexis.delattre@akretion.com> for any help or question about this module.
+    """,
+    'author': 'Akretion',
+    'website': 'http://www.akretion.com',
+    'depends': ['hw_proxy'],
+    'external_dependencies': {
+        'python' : ['serial', 'unidecode'],
+    },
+    'data': [],
+    'active': False,
+}

hw_customer_display/controllers/__init__.py

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+##############################################################################
+#
+#    Hardware Customer Display module for OpenERP
+#    Copyright (C) 2014 Akretion (http://www.akretion.com)
+#    @author Alexis de Lattre <alexis.delattre@akretion.com>
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU Affero General Public License as
+#    published by the Free Software Foundation, either version 3 of the
+#    License, or (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU Affero General Public License for more details.
+#
+#    You should have received a copy of the GNU Affero General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+##############################################################################
+
+
+from . import main

hw_customer_display/controllers/main.py

@@ -0,0 +1,182 @@
+# -*- encoding: utf-8 -*-
+##############################################################################
+#
+#    Hardware Customer Display module for OpenERP
+#    Copyright (C) 2014 Akretion (http://www.akretion.com)
+#    @author Alexis de Lattre <alexis.delattre@akretion.com>
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU Affero General Public License as
+#    published by the Free Software Foundation, either version 3 of the
+#    License, or (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU Affero General Public License for more details.
+#
+#    You should have received a copy of the GNU Affero General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+##############################################################################
+
+
+import logging
+import simplejson
+import time
+from threading import Thread, Lock
+from Queue import Queue
+from unidecode import unidecode
+from serial import Serial
+import openerp.addons.hw_proxy.controllers.main as hw_proxy
+from openerp import http
+from openerp.tools.config import config
+
+
+logger = logging.getLogger(__name__)
+
+
+class CustomerDisplayDriver(Thread):
+    def __init__(self):
+        Thread.__init__(self)
+        self.queue = Queue()
+        self.lock = Lock()
+        self.status = {'status': 'connecting', 'messages': []}
+        self.device_name = config.get(
+            'customer_display_device_name', '/dev/ttyUSB0')
+        self.device_rate = int(config.get(
+            'customer_display_device_rate', 9600))
+        self.device_timeout = int(config.get(
+            'customer_display_device_timeout', 2))
+        self.device_rows = int(config.get(
+            'customer_display_device_rows', 2))
+        self.device_cols = int(config.get(
+            'customer_display_device_cols', 20))
+        self.serial = False
+
+    def get_status(self):
+        self.push_task('status')
+        return self.status
+
+    def set_status(self, status, message=None):
+        if status == self.status['status']:
+            if message is not None and message != self.status['messages'][-1]:
+                self.status['messages'].append(message)
+        else:
+            self.status['status'] = status
+            if message:
+                self.status['messages'] = [message]
+            else:
+                self.status['messages'] = []
+
+        if status == 'error' and message:
+            logger.error('Display Error: '+message)
+        elif status == 'disconnected' and message:
+            logger.warning('Disconnected Display: '+message)
+
+    def lockedstart(self):
+        with self.lock:
+            if not self.isAlive():
+                self.daemon = True
+                self.start()
+
+    def push_task(self, task, data=None):
+        self.lockedstart()
+        self.queue.put((time.time(), task, data))
+
+    def move_cursor(self, col, row):
+        # Bixolon spec : 11. "Move Cursor to Specified Position"
+        self.cmd_serial_write('\x1B\x6C' + chr(col) + chr(row))
+
+    def display_text(self, lines):
+        logger.debug(
+            "Preparing to send the following lines to LCD: %s" % lines)
+        if len(lines) > self.device_rows:
+            logger.error(
+                'Odoo POS sends %d rows but LCD only has %d rows'
+                % (len(lines), self.device_rows))
+            return
+        assert len(lines) <= self.device_rows, 'Too many lines'
+        lines_ascii = []
+        for line in lines:
+            lines_ascii.append(unidecode(line))
+        row = 0
+        for dline in lines_ascii:
+            row += 1
+            self.move_cursor(1, row)
+            if len(line) > self.device_cols:
+                logger.error(
+                    'Odoo POS sends %d characters but LCD only has %d cols'
+                    % (len(line), self.device_cols))
+                return
+            self.serial_write(dline)
+
+    def setup_customer_display(self):
+        '''Set LCD cursor to off
+        If your LCD has different setup instruction(s), you should
+        inherit this function'''
+        # Bixolon spec : 35. "Set Cursor On/Off"
+        self.cmd_serial_write('\x1F\x43\x00')
+        logger.debug('LCD cursor set to off')
+
+    def clear_customer_display(self):
+        '''If your LCD has different clearing instruction, you should inherit
+        this function'''
+        # Bixolon spec : 12. "Clear Display Screen and Clear String Mode"
+        self.cmd_serial_write('\x0C')
+        logger.debug('Customer display cleared')
+
+    def cmd_serial_write(self, command):
+        '''If your LCD requires a prefix and/or suffix on all commands,
+        you should inherit this function'''
+        assert isinstance(command, str), 'command must be a string'
+        self.serial_write(command)
+
+    def serial_write(self, text):
+        assert isinstance(text, str), 'text must be a string'
+        self.serial.write(text)
+
+    def send_text_customer_display(self, text_to_display):
+        lines = simplejson.loads(text_to_display)
+        assert isinstance(lines, list), 'lines_list should be a list'
+        try:
+            logger.debug(
+                'Opening serial port %s for customer display with baudrate %d'
+                % (self.device_name, self.device_rate))
+            self.serial = Serial(
+                self.device_name, self.device_rate,
+                timeout=self.device_timeout)
+            logger.debug('serial.is_open = %s' % self.serial.isOpen())
+            self.setup_customer_display()
+            self.clear_customer_display()
+            self.display_text(lines)
+        except Exception, e:
+            logger.error('Exception in serial connection: %s' % str(e))
+        finally:
+            if self.serial:
+                logger.debug('Closing serial port for customer display')
+                self.serial.close()
+
+    def run(self):
+        while True:
+            try:
+                timestamp, task, data = self.queue.get(True)
+                if task == 'display':
+                    self.send_text_customer_display(data)
+                elif task == 'status':
+                    pass
+            except Exception as e:
+                self.set_status('error', str(e))
+
+driver = CustomerDisplayDriver()
+
+hw_proxy.drivers['customer_display'] = driver
+
+
+class CustomerDisplayProxy(hw_proxy.Proxy):
+    @http.route(
+        '/hw_proxy/send_text_customer_display', type='json', auth='none',
+        cors='*')
+    def send_text_customer_display(self, text_to_display):
+        logger.debug('LCD: Call send_text_customer_display')
+        driver.push_task('display', text_to_display)