[ADD] pos_odoo_driver_display

pos_odoo_driver_display/__init__.py

@@ -0,0 +1 @@
+from . import models

pos_odoo_driver_display/__manifest__.py

@@ -0,0 +1,25 @@
+# Copyright (C) 2024 - Today: GRAP (http://www.grap.coop)
+# @author: Sylvain LE GAL (https://twitter.com/legalsylvain)
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html).
+
+{
+    "name": "Point of Sale - LED Customer Display (odoo-pos-driver)",
+    "version": "16.0.1.0.0",
+    "category": "Point Of Sale",
+    "summary": "Communicate with LEC Customer Display via odoo-pos-driver library",
+    "author": "GRAP",
+    "website": "https://github.com/grap/odoo-addons-pos",
+    "license": "AGPL-3",
+    "depends": ["point_of_sale"],
+    "assets": {
+        "point_of_sale.assets": [
+            "pos_odoo_driver_display/static/src/js/devices.esm.js",
+            "pos_odoo_driver_display/static/src/js/ProxyStatus.esm.js",
+            "pos_odoo_driver_display/static/src/js/models.esm.js",
+            "pos_odoo_driver_display/static/src/js/Chrome.esm.js",
+            "pos_odoo_driver_display/static/src/js/PaymentScreen.esm.js",
+        ],
+    },
+    "data": ["views/view_pos_config.xml"],
+    "installable": True,
+}

pos_odoo_driver_display/models/__init__.py

@@ -0,0 +1,3 @@
+from . import pos_config
+from . import res_config_settings
+from . import pos_session

pos_odoo_driver_display/models/pos_config.py

@@ -0,0 +1,101 @@
+# © 2014-2016 Aurélien DUMAINE
+# © 2015-2016 Akretion (Alexis de Lattre <[email protected]>)
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+
+from odoo import _, api, fields, models
+from odoo.exceptions import ValidationError
+
+
+class PosConfig(models.Model):
+    _inherit = "pos.config"
+
+    _CUSTOMER_DISPLAY_FORMAT_SELECTION = [
+        ("2_20", "2 Lines of 20 Characters"),
+    ]
+
+    iface_customer_display = fields.Boolean(
+        string="LED Customer Display", help="Display data on the customer display"
+    )
+
+    customer_display_format = fields.Selection(
+        selection=_CUSTOMER_DISPLAY_FORMAT_SELECTION,
+        default="2_20",
+        required=True,
+    )
+
+    customer_display_line_length = fields.Integer(
+        string="Line Length",
+        compute="_compute_customer_display_line_length",
+        store=True,
+        help="Length of the LEDs lines of the customer display",
+    )
+    customer_display_msg_next_l1 = fields.Char(
+        string="Next Customer (Line 1)",
+        default=lambda x: x._default_customer_display_msg("next_l1"),
+        help="First line of the message on the customer display which is "
+        "displayed after starting POS and also after validation of an order",
+    )
+    customer_display_msg_next_l2 = fields.Char(
+        string="Next Customer (Line 2)",
+        default=lambda x: x._default_customer_display_msg("next_l2"),
+        help="Second line of the message on the customer display which is "
+        "displayed after starting POS and also after validation of an order",
+    )
+    customer_display_msg_closed_l1 = fields.Char(
+        string="PoS Closed (Line 1)",
+        default=lambda x: x._default_customer_display_msg("closed_l1"),
+        help="First line of the message on the customer display which "
+        "is displayed when POS is closed",
+    )
+    customer_display_msg_closed_l2 = fields.Char(
+        string="PoS Closed (Line 2)",
+        default=lambda x: x._default_customer_display_msg("closed_l2"),
+        help="Second line of the message on the customer display which "
+        "is displayed when POS is closed",
+    )
+
+    @api.model
+    def _default_customer_display_msg(self, line):
+        if line == "next_l1":
+            return _("Point of Sale Open")
+        elif line == "next_l2":
+            return _("Welcome!")
+        elif line == "closed_l1":
+            return _("Point of Sale Closed")
+        elif line == "closed_l2":
+            return _("See you soon!")
+
+    @api.depends("customer_display_format")
+    def _compute_customer_display_line_length(self):
+        for config in self:
+            config.customer_display_line_length = int(
+                config.customer_display_format.split("_")[1]
+            )
+
+    @api.constrains(
+        "iface_customer_display",
+        "customer_display_format",
+        "customer_display_msg_next_l1",
+        "customer_display_msg_next_l2",
+        "customer_display_msg_closed_l1",
+        "customer_display_msg_closed_l2",
+    )
+    def _check_customer_display_length(self):
+        for config in self.filtered(lambda x: x.customer_display_line_length):
+            maxsize = config.customer_display_line_length
+            fields_to_check = [
+                x for x in self._fields.keys() if "customer_display_msg_" in x
+            ]
+            for field_name in fields_to_check:
+                value = getattr(config, field_name)
+                if value and len(value) > maxsize:
+                    raise ValidationError(
+                        _(
+                            "The message for customer display '%(field_name)s' is too "
+                            "long: it has %(current_size)d chars whereas the maximum "
+                            "is %(maxsize)d chars.",
+                            field_name=self._fields[field_name].string,
+                            current_size=len(value),
+                            maxsize=maxsize,
+                        )
+                    )

pos_odoo_driver_display/models/pos_session.py

@@ -0,0 +1,16 @@
+# Copyright (C) 2024 - Today: GRAP (http://www.grap.coop)
+# @author: Sylvain LE GAL (https://twitter.com/legalsylvain)
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html).
+
+from odoo import models
+
+
+class PosSession(models.Model):
+    _inherit = "pos.session"
+
+    def _get_pos_ui_pos_config(self, params):
+        config = super()._get_pos_ui_pos_config(params)
+        config["use_proxy"] = config["use_proxy"] or (
+            config["is_posbox"] and config["iface_customer_display"]
+        )
+        return config

pos_odoo_driver_display/models/res_config_settings.py

@@ -0,0 +1,30 @@
+# Copyright (C) 2024 - Today: GRAP (http://www.grap.coop)
+# @author: Sylvain LE GAL (https://twitter.com/legalsylvain)
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html).
+
+from odoo import fields, models
+
+
+class ResConfigSettings(models.TransientModel):
+    _inherit = "res.config.settings"
+
+    pos_iface_customer_display = fields.Boolean(
+        related="pos_config_id.iface_customer_display", readonly=False
+    )
+    pos_customer_display_format = fields.Selection(
+        related="pos_config_id.customer_display_format",
+        readonly=False,
+        required=True,
+    )
+    pos_customer_display_msg_next_l1 = fields.Char(
+        related="pos_config_id.customer_display_msg_next_l1", readonly=False
+    )
+    pos_customer_display_msg_next_l2 = fields.Char(
+        related="pos_config_id.customer_display_msg_next_l2", readonly=False
+    )
+    pos_customer_display_msg_closed_l1 = fields.Char(
+        related="pos_config_id.customer_display_msg_closed_l1", readonly=False
+    )
+    pos_customer_display_msg_closed_l2 = fields.Char(
+        related="pos_config_id.customer_display_msg_closed_l2", readonly=False
+    )

pos_odoo_driver_display/readme/CONFIGURE.rst

@@ -0,0 +1,10 @@
+To configure this module,
+* go to the menu Point of Sale > Configuration > Point of Sale
+* edit the point of sale for which you want to enable the LED:
+
+* In the IotBox section, activate the option *LED Customer Display*,
+* configure the format of your LED screen. (2 lines of 20 characters, by default)
+
+* optionaly, you can customize the *Next customer* message and the *POS closed* message
+
+.. figure:: ../static/img/pos_config_form.png

pos_odoo_driver_display/readme/CONTRIBUTORS.rst

@@ -0,0 +1,7 @@
+This module is a full refactor of the OCA V12 module ``pos_customer_display``.
+Original authors and ideas are:
+
+* Aurélien Dumaine
+* Alexis de Lattre <[email protected]>
+* Father Odilon (`Barroux Abbey <http://www.barroux.org/>`_)
+* Daniel Kraft

pos_odoo_driver_display/readme/USAGE.rst

@@ -0,0 +1,30 @@
+Once everything is configured, just start the POS as usual.
+You will see the following messages on the device, depending
+on the events.
+
+'Welcome' message
+~~~~~~~~~~~~~~~~~
+
+* when cashier starts the PoS
+* when cashier creates a new empty PoS Order
+
+'Close' message
+~~~~~~~~~~~~~~~
+
+* when cashier Closes the PoS
+
+'Order Line' message
+~~~~~~~~~~~~~~~~~~~~
+
+* when cashier adds a product
+* when cashier changes the Unit Price, the discount or the quantity
+
+'Product Removal' message
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* when cashier removes an order line
+
+
+* you press the Payment button: the device will display the total amount,
+* you enter the amount of cash you receive: the device will display the amount of the change to give back,
+* you close the POS.

pos_odoo_driver_display/static/src/js/Chrome.esm.js

@@ -0,0 +1,25 @@
+// Copyright (C) 2024 - Today: GRAP (http://www.grap.coop)
+// @author: Sylvain LE GAL (https://twitter.com/legalsylvain)
+// License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html).
+
+odoo.define("pos_odoo_driver_display.Chrome", function (require) {
+    const Chrome = require("point_of_sale.Chrome");
+    const Registries = require("point_of_sale.Registries");
+
+    const OverloadChrome = (OriginalChrome) =>
+        class extends OriginalChrome {
+            async start() {
+                await super.start();
+                this.env.proxy.customer_display_send_welcome_message();
+            }
+
+            async _closePos() {
+                await super._closePos();
+                this.env.proxy.customer_display_send_close_message();
+            }
+        };
+
+    Registries.Component.extend(Chrome, OverloadChrome);
+
+    return Chrome;
+});

pos_odoo_driver_display/static/src/js/PaymentScreen.esm.js

@@ -0,0 +1,26 @@
+// Copyright (C) 2024 - Today: GRAP (http://www.grap.coop)
+// @author: Sylvain LE GAL (https://twitter.com/legalsylvain)
+// License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html).
+
+odoo.define("pos_odoo_driver_display.PaymentScreen", function (require) {
+    const {onRendered} = owl;
+    const PaymentScreen = require("point_of_sale.PaymentScreen");
+    const Registries = require("point_of_sale.Registries");
+
+    const OverloadPaymentScreen = (OriginalPaymentScreen) =>
+        class extends OriginalPaymentScreen {
+
+            setup() {
+                var self = this;
+                super.setup();
+
+                onRendered(() => {
+                    self.env.proxy.customer_display_send_payment(self.currentOrder);
+                });
+            }
+
+        };
+
+    Registries.Component.extend(PaymentScreen, OverloadPaymentScreen);
+    return PaymentScreen;
+});

pos_odoo_driver_display/static/src/js/ProxyStatus.esm.js

@@ -0,0 +1,37 @@
+// Copyright (C) 2024 - Today: GRAP (http://www.grap.coop)
+// @author: Sylvain LE GAL (https://twitter.com/legalsylvain)
+// License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html).
+
+odoo.define("pos_odoo_driver_display.ProxyStatus", function (require) {
+    var Registries = require("point_of_sale.Registries");
+    var ProxyStatus = require("point_of_sale.ProxyStatus");
+
+    const OverloadProxyStatus = (OriginalProxyStatus) =>
+        class extends OriginalProxyStatus {
+            _setStatus(newStatus) {
+                super._setStatus(newStatus);
+                if (
+                    newStatus.status === "connected" &&
+                    this.env.pos.config.iface_customer_display
+                ) {
+                    var displayStatus = newStatus.drivers.display
+                        ? newStatus.drivers.display.status
+                        : false;
+                    if (
+                        displayStatus !== "connected" &&
+                        displayStatus !== "connecting"
+                    ) {
+                        if (this.state.msg) {
+                            this.state.msg =
+                                this.env._t("Display") + " & " + this.state.msg;
+                        } else {
+                            this.state.msg = this.env._t("Display Offline");
+                            this.state.status = "warning";
+                        }
+                    }
+                }
+            }
+        };
+
+    Registries.Component.extend(ProxyStatus, OverloadProxyStatus);
+});

pos_odoo_driver_display/static/src/js/devices.esm.js

@@ -0,0 +1,53 @@
+// Copyright (C) 2024 - Today: GRAP (http://www.grap.coop)
+// @author: Sylvain LE GAL (https://twitter.com/legalsylvain)
+// License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html).
+
+odoo.define("pos_odoo_driver_display.devices", function (require) {
+    var ProxyDevice = require("point_of_sale.devices").ProxyDevice;
+
+    ProxyDevice.include({
+        customer_display_send_welcome_message() {
+            this._customer_display_send_text([
+                this.pos.config.customer_display_msg_next_l1,
+                this.pos.config.customer_display_msg_next_l2,
+            ]);
+        },
+
+        customer_display_send_close_message() {
+            this._customer_display_send_text([
+                this.pos.config.customer_display_msg_closed_l1,
+                this.pos.config.customer_display_msg_closed_l2,
+            ]);
+        },
+
+        _customer_display_send_text: function (text_lines) {
+            var data = {
+                text_lines: text_lines,
+                action: "display_lines",
+            };
+            this.message("display_show", {data: JSON.stringify(data)});
+        },
+
+        customer_display_send_payment: function (order) {
+            var data = {
+                total: order.get_total_with_tax(),
+                total_paid: order.get_total_paid(),
+                total_due: order.get_due(),
+                action: "payment_balance",
+            };
+            this.message("display_show", {data: JSON.stringify(data)});
+        },
+
+        customer_display_send_order_line: function (orderline, action) {
+            var data = {
+                product_name: orderline.product.display_name,
+                quantity: orderline.quantity,
+                discount: orderline.discount,
+                unit_price: orderline.get_unit_price(),
+                total: orderline.get_display_price(),
+                action: action,
+            };
+            this.message("display_show", {data: JSON.stringify(data)});
+        },
+    });
+});