[FIX] hw_drivers: support for TM-U escpos printer models #126689

lse-odoo · 2023-06-28T12:43:58Z

Before this commit:
When printing a receipt with an epson printers models TM-U2X0 (like TM-U220), random characters will be printed instead of the receipt.

This happened as a picture of the receipt is sent to the IoT box, but the TM-U2X0 models does not support all "Bit Image commands". We currently use the GS v 0 one which is not supported by this printer models. See:
https://reference.epson-biz.com/modules/ref_escpos/index.php?content_id=94

In addition, of that, the command itself is obsolete.

After this commit:
The support for another command "ESC *" is added which is not obsolete and supported by TM-U2X0 models.

Notes:

Compared to "GS v 0", the receipt printed with "ESC *" is worst:
- It take longer to print (5 seconds vs 1 second)
- There is consistently some thin "empty white lines"
Most of the code is inspired from python-escpos. Using the library to print the receipt have the same drawback: https://github.com/python-escpos/python-escpos/blob/master/src/escpos/escpos.py

Due to the drawbacks, making it the default way to print would be a bad idea. As such, we can configure the mode (with other parameters) using particular name for the printer (which can be done by adding it manually with cups).

The options are:

IMC = Image Mode Column
LDV = Low Density Vertical
LDH = Low Density Horizontal
SCALE<XX> = Image Scale in percentage (for instance SCALE50 is half the size of the receipt printer)
In the case of the TM-U220 on which the fix was tested the name could be set as TM-U220_IMC_LDV_LDH which would give:

(the picture goes off of the receipt horizontally)

or TM-U220_IMC_LDH which would give:

( fully fit on the receipt but text is hard to read)

opw-3351084,3341907

robodoo · 2023-06-28T12:44:05Z

lse-odoo · 2023-06-28T12:48:50Z

@qle-odoo
Could you review it please ?

Also, I was willing to have a way for the user to control if they would prefer to use ESC or GV. I thought maybe a particular suffix at the end of the printer name (like "-force-raster") in case new model of printer that does not support GV are used. I tried to modify the name of the printer using IoT cups, but on odoo service restart, the printer name lose the modified name to get back it's previous name.
What do you think ?
Little reminder: GV is obsolete so will likely not be featured in new printers of the brand, see:
https://reference.epson-biz.com/modules/ref_escpos/index.php?content_id=94

qle-odoo · 2023-06-29T08:51:27Z

addons/hw_drivers/iot_handlers/drivers/PrinterDriver.py

+    def format_escpos_bit_image_column(self, im):
+        """ prints with the `ESC *`-command """
+
+        def extract_columns_from_picture(im):


why a function into another one ?

qle-odoo · 2023-06-29T08:53:57Z

addons/hw_drivers/iot_handlers/drivers/PrinterDriver.py

+    def format_escpos(self, im):
+        # GS v 0 incompatible with TM-U2x0 models according to:
+        # https://reference.epson-biz.com/modules/ref_escpos/index.php?content_id=94
+        must_use_column = "TM-U2" in self.device_name


True if device_name is correctly setted.
Another way to know if a printer need to use column to print ?

indeed, please re-read my message above:

Also, I was willing to have a way for the user to control if they would prefer to use ESC or GV. I thought maybe a particular suffix at the end of the printer name (like "-force-raster") in case new model of printer that does not support GV are used. I tried to modify the name of the printer using IoT cups, but on odoo service restart, the printer name lose the modified name to get back it's previous name.
What do you think ?
Little reminder: GV is obsolete so will likely not be featured in new printers of the brand, see:
https://reference.epson-biz.com/modules/ref_escpos/index.php?content_id=94

Another way to know if a printer need to use column to print ?

In theory they can all used it, but as it is slower and the quality is bad, the questions is rather do we have a way to know if GS v 0 is not supported. On this i don't think there is a way to know except checking the table of compatibility.
This was the reason why I was willing to make it "an option" so that the client have a way to force the column printing if necessary (see previous paragraph)

Ysoroko · 2023-08-01T08:25:21Z

addons/hw_drivers/iot_handlers/drivers/PrinterDriver.py

+        width_pixels, height_pixels = im.size
+        TOP = 0
+        for left in range(0, width_pixels, line_height):
+            box = (left, TOP, left + line_height, TOP + height_pixels)


Can we replace "TOP" by 0?

Ysoroko · 2023-08-01T08:35:08Z

addons/hw_drivers/iot_handlers/drivers/PrinterDriver.py

+
+        # Parse the printer name to get the needed parameters
+        # The separator need to not be filtered by `get_identifier`
+        separator = '_'


unnecessary extra variable "separator" only used once

lse-odoo · 2023-08-01T13:40:56Z

@Ysoroko thanks for the feedback, should be good to go now :)

lse-odoo · 2023-08-07T16:43:41Z

the "name convention" might need documentation change. But where ?

https://www.odoo.com/app/point-of-sale-hardware#:~:text=IoT%20Box%20Required%0AThermal%20printers%20using%20ESC/POS%20or%20Star%20protocol%20such%20as%20the%20EPSON%20TM%2DT20II.
or maybe
https://www.odoo.com/documentation/16.0/applications/sales/point_of_sale/configuration/epos_ssc.html
( but it's ePoS direct device, not IoT related)
or maybe
https://www.odoo.com/documentation/16.0/applications/productivity/iot/devices/printer.html

caburj

I'm asking for minor changes. Make sure to test high vertical density with other printers, because as you said, you made some recent refactoring.

Don't forget to properly document the configuration based on the name of the printer.

addons/hw_drivers/iot_handlers/drivers/PrinterDriver.py

caburj · 2023-08-08T09:59:51Z

addons/hw_drivers/iot_handlers/drivers/PrinterDriver.py

+        options = self.device_name.split('_')
+        for option in options:
+            option = option.upper()
+            if option == 'IMC':


Can we think of more "complex"-looking name for these configuration strings? The current choices feel like they can be easily part of existing (default) printer names.

Proposal: <PrinterName>__IMC_LDV_LDH_SCALE70__

The idea is to isolate the options from the name of the printer.

<printername>__<options>__

Before this commit: When printing a receipt with an epson printers models TM-U2X0 (like TM-U220), random characters will be printed instead of the receipt. This happened as a picture of the receipt is sent to the IoT box, but the TM-U2X0 models does not support all "Bit Image commands". We currently use the GS v 0 one which is not supported by this printer models. See: https://reference.epson-biz.com/modules/ref_escpos/index.php?content_id=94 In addition, of that, the command itself is obsolete. After this commit: The support for another command "ESC *" is added which is not obsolete and supported by TM-U2X0 models. Notes: - Compared to "GS v 0", the receipt printed with "ESC *" is worst: - It take longer to print (5 seconds vs 1 second) - There is consistently some thin "empty white lines" - Most of the code is inspired from `python-escpos`: https://github.com/python-escpos/python-escpos/blob/master/src/escpos/escpos.py Due to the drawbacks, making it the default way to print would be a bad idea. As such, we can configure the mode (with other parameters) using particular name for the printer (which can be done by adding it manually with cups) opw-3351084,3341907

caburj

robodoo r+

Before this commit: When printing a receipt with an epson printers models TM-U2X0 (like TM-U220), random characters will be printed instead of the receipt. This happened as a picture of the receipt is sent to the IoT box, but the TM-U2X0 models does not support all "Bit Image commands". We currently use the GS v 0 one which is not supported by this printer models. See: https://reference.epson-biz.com/modules/ref_escpos/index.php?content_id=94 In addition, of that, the command itself is obsolete. After this commit: The support for another command "ESC *" is added which is not obsolete and supported by TM-U2X0 models. Notes: - Compared to "GS v 0", the receipt printed with "ESC *" is worst: - It take longer to print (5 seconds vs 1 second) - There is consistently some thin "empty white lines" - Most of the code is inspired from `python-escpos`: https://github.com/python-escpos/python-escpos/blob/master/src/escpos/escpos.py Due to the drawbacks, making it the default way to print would be a bad idea. As such, we can configure the mode (with other parameters) using particular name for the printer (which can be done by adding it manually with cups) opw-3351084,3341907 closes #126689 Signed-off-by: Joseph Caburnay (jcb) <jcb@odoo.com>

Documentation regarding the fix: odoo/odoo#126689 opw-3351084,3341907 Signed-off-by: Loan (LSE) <lse@odoo.com>

fw-bot · 2023-09-13T05:54:12Z

@lse-odoo @caburj this pull request has forward-port PRs awaiting action (not merged or closed):

qle-odoo · 2023-09-13T07:26:12Z

@lse-odoo can we merge please ??

Documentation regarding the fix: odoo/odoo#126689 opw-3351084,3341907 Authored by: lse-odoo <lse@odoo.com> Co-authored by: tiku-odoo <tiku@odoo.com> Co-authored by: Felicious <feku@odoo.com> Co-authored by: jero-odoo <jero@odoo.com> Signed-off-by: StraubCreative <zst@odoo.com>

Documentation regarding the fix: odoo/odoo#126689 opw-3351084,3341907 Authored by: lse-odoo <lse@odoo.com> Co-authored by: tiku-odoo <tiku@odoo.com> Co-authored by: Felicious <feku@odoo.com> Co-authored by: jero-odoo <jero@odoo.com> closes #5367 Signed-off-by: StraubCreative <zst@odoo.com> Signed-off-by: Zachary Straub (zst) <zst@odoo.com>

Documentation regarding the fix: odoo/odoo#126689 opw-3351084,3341907 Authored by: lse-odoo <lse@odoo.com> Co-authored by: tiku-odoo <tiku@odoo.com> Co-authored by: Felicious <feku@odoo.com> Co-authored by: jero-odoo <jero@odoo.com> Signed-off-by: StraubCreative <zst@odoo.com> X-original-commit: 974c59f

Documentation regarding the fix: odoo/odoo#126689 opw-3351084,3341907 Authored by: lse-odoo <lse@odoo.com> Co-authored by: tiku-odoo <tiku@odoo.com> Co-authored by: Felicious <feku@odoo.com> Co-authored by: jero-odoo <jero@odoo.com> closes #6065 X-original-commit: 974c59f Signed-off-by: StraubCreative <zst@odoo.com> Signed-off-by: Zachary Straub (zst) <zst@odoo.com>

Documentation regarding the fix: odoo/odoo#126689 opw-3351084,3341907 Authored by: lse-odoo <lse@odoo.com> Co-authored by: tiku-odoo <tiku@odoo.com> Co-authored by: Felicious <feku@odoo.com> Co-authored by: jero-odoo <jero@odoo.com> closes #6064 X-original-commit: 974c59f Signed-off-by: StraubCreative <zst@odoo.com> Signed-off-by: Zachary Straub (zst) <zst@odoo.com>

Documentation regarding the fix: odoo/odoo#126689 opw-3351084,3341907 Authored by: lse-odoo <lse@odoo.com> Co-authored by: tiku-odoo <tiku@odoo.com> Co-authored by: Felicious <feku@odoo.com> Co-authored by: jero-odoo <jero@odoo.com> closes #6062 X-original-commit: 974c59f Signed-off-by: StraubCreative <zst@odoo.com> Signed-off-by: Zachary Straub (zst) <zst@odoo.com>

Documentation regarding the fix: odoo/odoo#126689 opw-3351084,3341907 Authored by: lse-odoo <lse@odoo.com> Co-authored by: tiku-odoo <tiku@odoo.com> Co-authored by: Felicious <feku@odoo.com> Co-authored by: jero-odoo <jero@odoo.com> closes #6061 X-original-commit: 974c59f Signed-off-by: StraubCreative <zst@odoo.com> Signed-off-by: Zachary Straub (zst) <zst@odoo.com>

Documentation regarding the fix: odoo/odoo#126689 opw-3351084,3341907 Authored by: lse-odoo <lse@odoo.com> Co-authored by: tiku-odoo <tiku@odoo.com> Co-authored by: Felicious <feku@odoo.com> Co-authored by: jero-odoo <jero@odoo.com> closes #6060 X-original-commit: 974c59f Signed-off-by: StraubCreative <zst@odoo.com> Signed-off-by: Zachary Straub (zst) <zst@odoo.com>

Documentation regarding the fix: odoo/odoo#126689 opw-3351084,3341907 Authored by: lse-odoo <lse@odoo.com> Co-authored by: tiku-odoo <tiku@odoo.com> Co-authored by: Felicious <feku@odoo.com> Co-authored by: jero-odoo <jero@odoo.com> closes #6059 X-original-commit: 974c59f Signed-off-by: StraubCreative <zst@odoo.com> Signed-off-by: Zachary Straub (zst) <zst@odoo.com>

Documentation regarding the fix: odoo/odoo#126689 opw-3351084,3341907 Authored by: lse-odoo <lse@odoo.com> Co-authored by: tiku-odoo <tiku@odoo.com> Co-authored by: Felicious <feku@odoo.com> Co-authored by: jero-odoo <jero@odoo.com> closes #6063 X-original-commit: 974c59f Signed-off-by: StraubCreative <zst@odoo.com> Signed-off-by: Zachary Straub (zst) <zst@odoo.com>

Documentation regarding the fix: odoo/odoo#126689 opw-3351084,3341907 Authored by: lse-odoo <lse@odoo.com> Co-authored by: tiku-odoo <tiku@odoo.com> Co-authored by: Felicious <feku@odoo.com> Co-authored by: jero-odoo <jero@odoo.com> closes #6065 X-original-commit: 974c59f Signed-off-by: StraubCreative <zst@odoo.com> Signed-off-by: Zachary Straub (zst) <zst@odoo.com>

lse-odoo requested a review from qle-odoo June 28, 2023 12:44

C3POdoo requested a review from a team June 28, 2023 12:59

C3POdoo added the OE the report is linked to a support ticket (opw-...) label Jun 28, 2023

qle-odoo reviewed Jun 29, 2023

View reviewed changes

lse-odoo force-pushed the 15.0-iot-escpos-support-tm-u2x0-models-lse branch 2 times, most recently from 6eb9853 to 1f4bb06 Compare July 18, 2023 15:08

lse-odoo force-pushed the 15.0-iot-escpos-support-tm-u2x0-models-lse branch 4 times, most recently from 8e6a662 to 15a9c79 Compare July 27, 2023 08:43

Ysoroko reviewed Aug 1, 2023

View reviewed changes

lse-odoo force-pushed the 15.0-iot-escpos-support-tm-u2x0-models-lse branch from 15a9c79 to d6ce160 Compare August 1, 2023 13:40

caburj reviewed Aug 8, 2023

View reviewed changes

lse-odoo force-pushed the 15.0-iot-escpos-support-tm-u2x0-models-lse branch 3 times, most recently from c4d50d6 to c2be1f0 Compare August 8, 2023 11:38

lse-odoo force-pushed the 15.0-iot-escpos-support-tm-u2x0-models-lse branch from c2be1f0 to d6b9aa7 Compare August 8, 2023 11:59

caburj approved these changes Aug 8, 2023

View reviewed changes

lse-odoo added a commit to odoo/documentation that referenced this pull request Aug 8, 2023

[IMP] iot: esc-pos ESC * support documentation

afcb6b4

Documentation regarding the fix: odoo/odoo#126689 opw-3351084,3341907 Signed-off-by: Loan (LSE) <lse@odoo.com>

lse-odoo mentioned this pull request Aug 8, 2023

[IMP] iot: esc-pos ESC * support documentation odoo/documentation#5367

Closed

robodoo temporarily deployed to merge August 8, 2023 16:15 Inactive

robodoo closed this Aug 8, 2023

fw-bot mentioned this pull request Aug 8, 2023

[FW][FIX] hw_drivers: support for TM-U escpos printer models #131292

Closed

fw-bot mentioned this pull request Oct 7, 2023

[FW][IMP] iot: esc-pos ESC * support documentation odoo/documentation#6059

Closed

fw-bot mentioned this pull request Oct 7, 2023

[FW][IMP] iot: esc-pos ESC * support documentation odoo/documentation#6060

Closed

fw-bot mentioned this pull request Oct 7, 2023

[FW][IMP] iot: esc-pos ESC * support documentation odoo/documentation#6061

Closed

fw-bot mentioned this pull request Oct 7, 2023

[FW][IMP] iot: esc-pos ESC * support documentation odoo/documentation#6062

Closed

fw-bot mentioned this pull request Oct 7, 2023

[FW][IMP] iot: esc-pos ESC * support documentation odoo/documentation#6063

Closed

fw-bot mentioned this pull request Oct 7, 2023

[FW][IMP] iot: esc-pos ESC * support documentation odoo/documentation#6064

Closed

fw-bot mentioned this pull request Oct 7, 2023

[FW][IMP] iot: esc-pos ESC * support documentation odoo/documentation#6065

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[FIX] hw_drivers: support for TM-U escpos printer models #126689

[FIX] hw_drivers: support for TM-U escpos printer models #126689

lse-odoo commented Jun 28, 2023 •

edited

robodoo commented Jun 28, 2023 •

edited

lse-odoo commented Jun 28, 2023

qle-odoo Jun 29, 2023

qle-odoo Jun 29, 2023

lse-odoo Jun 29, 2023

Ysoroko Aug 1, 2023

Ysoroko Aug 1, 2023

lse-odoo commented Aug 1, 2023

lse-odoo commented Aug 7, 2023

caburj left a comment

caburj Aug 8, 2023

caburj Aug 8, 2023 •

edited

caburj left a comment

fw-bot commented Sep 13, 2023

qle-odoo commented Sep 13, 2023

[FIX] hw_drivers: support for TM-U escpos printer models #126689

[FIX] hw_drivers: support for TM-U escpos printer models #126689

Conversation

lse-odoo commented Jun 28, 2023 • edited

robodoo commented Jun 28, 2023 • edited

lse-odoo commented Jun 28, 2023

qle-odoo Jun 29, 2023

Choose a reason for hiding this comment

qle-odoo Jun 29, 2023

Choose a reason for hiding this comment

lse-odoo Jun 29, 2023

Choose a reason for hiding this comment

Ysoroko Aug 1, 2023

Choose a reason for hiding this comment

Ysoroko Aug 1, 2023

Choose a reason for hiding this comment

lse-odoo commented Aug 1, 2023

lse-odoo commented Aug 7, 2023

caburj left a comment

Choose a reason for hiding this comment

caburj Aug 8, 2023

Choose a reason for hiding this comment

caburj Aug 8, 2023 • edited

Choose a reason for hiding this comment

caburj left a comment

Choose a reason for hiding this comment

fw-bot commented Sep 13, 2023

qle-odoo commented Sep 13, 2023

lse-odoo commented Jun 28, 2023 •

edited

robodoo commented Jun 28, 2023 •

edited

caburj Aug 8, 2023 •

edited